Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_recyclebin\base_bin Class Reference

Represents a recyclebin. More...

Inheritance diagram for tool_recyclebin\base_bin:
tool_recyclebin\category_bin tool_recyclebin\course_bin

Public Member Functions

 can_delete ()
 Can we delete this?
 
 can_restore ()
 Can we restore items in this recycle bin?
 
 can_view ()
 Can we view items in this recycle bin?
 
 delete_all_items ()
 Empty the recycle bin.
 
 delete_item ($item)
 Delete an item from the recycle bin.
 
 get_item ($itemid)
 Returns an item from the recycle bin.
 
 get_items ()
 Returns a list of items in the recycle bin.
 
 restore_item ($item)
 Restore an item from the recycle bin.
 
 store_item ($item)
 Store an item in this recycle bin.
 

Static Public Member Functions

static is_enabled ()
 Is this recyclebin enabled?
 

Detailed Description

Represents a recyclebin.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ can_delete()

tool_recyclebin\base_bin::can_delete ( )
abstract

Can we delete this?

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ can_restore()

tool_recyclebin\base_bin::can_restore ( )
abstract

Can we restore items in this recycle bin?

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ can_view()

tool_recyclebin\base_bin::can_view ( )
abstract

Can we view items in this recycle bin?

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ delete_item()

tool_recyclebin\base_bin::delete_item ( $item)
abstract

Delete an item from the recycle bin.

Parameters
stdClass$itemThe item database record

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ get_item()

tool_recyclebin\base_bin::get_item ( $itemid)
abstract

Returns an item from the recycle bin.

Parameters
int$itemidItem ID to retrieve.

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ get_items()

tool_recyclebin\base_bin::get_items ( )
abstract

Returns a list of items in the recycle bin.

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ is_enabled()

static tool_recyclebin\base_bin::is_enabled ( )
static

Is this recyclebin enabled?

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ restore_item()

tool_recyclebin\base_bin::restore_item ( $item)
abstract

Restore an item from the recycle bin.

Parameters
stdClass$itemThe item database record

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.

◆ store_item()

tool_recyclebin\base_bin::store_item ( $item)
abstract

Store an item in this recycle bin.

Parameters
stdClass$itemItem to store.

Reimplemented in tool_recyclebin\category_bin, and tool_recyclebin\course_bin.


The documentation for this class was generated from the following file: