Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/admin/tool/recyclebin/classes/ -> course_bin.php (source)
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403]
The main interface for recycle bin methods.
| Copyright: | 2015 University of Kent |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 386 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
course_bin:: (10 methods):
__construct()
is_enabled()
get_item()
get_items()
store_item()
restore_item()
delete_item()
can_view()
can_restore()
can_delete()
Class: course_bin - X-Ref
Represents a course's recyclebin.| __construct($courseid) X-Ref |
| Constructor. param: int $courseid Course ID. |
| is_enabled() X-Ref |
| Is this recyclebin enabled? return: bool true if enabled, false if not. |
| get_item($itemid) X-Ref |
| Returns an item from the recycle bin. param: int $itemid Item ID to retrieve. return: \stdClass the item. |
| get_items() X-Ref |
| Returns a list of items in the recycle bin for this course. return: array the list of items. |
| store_item($cm) X-Ref |
| Store a course module in the recycle bin. param: \stdClass $cm Course module |
| restore_item($item) X-Ref |
| Restore an item from the recycle bin. param: \stdClass $item The item database record |
| delete_item($item) X-Ref |
| Delete an item from the recycle bin. param: \stdClass $item The item database record |
| can_view() X-Ref |
| Can we view items in this recycle bin? return: bool returns true if they can view, false if not |
| can_restore() X-Ref |
| Can we restore items in this recycle bin? return: bool returns true if they can restore, false if not |
| can_delete() X-Ref |
| Can we delete this? return: bool returns true if they can delete, false if not |
