tool_recyclebin\course_bin Class Reference

Represents a course's recyclebin. More...

Inheritance diagram for tool_recyclebin\course_bin:

Public Member Functions
	__construct ($courseid)
	Constructor.
	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 for this course.
	restore_item ($item)
	Restore an item from the recycle bin.
	store_item ($cm)
	Store a course module in the recycle bin.

Static Public Member Functions
static	is_enabled ()
	Is this recyclebin enabled?

Protected Attributes
int	$_courseid
	The course id.

Detailed Description

Represents a course's recyclebin.

Copyright

2015 University of Kent

License

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

Constructor & Destructor Documentation

__construct()

tool_recyclebin\course_bin::__construct

(

$courseid

)

Constructor.

Parameters

int

$courseid

Course ID.

Member Function Documentation

can_delete()

tool_recyclebin\course_bin::can_delete

(

)

Can we delete this?

Return values

bool	returns true if they can delete, false if not

Reimplemented from tool_recyclebin\base_bin.

can_restore()

tool_recyclebin\course_bin::can_restore

(

)

Can we restore items in this recycle bin?

Return values

bool	returns true if they can restore, false if not

Reimplemented from tool_recyclebin\base_bin.

can_view()

tool_recyclebin\course_bin::can_view

(

)

Can we view items in this recycle bin?

Return values

bool	returns true if they can view, false if not

Reimplemented from tool_recyclebin\base_bin.

delete_item()

tool_recyclebin\course_bin::delete_item

(

$item

)

Delete an item from the recycle bin.

Parameters

stdClass

$item

The item database record

Reimplemented from tool_recyclebin\base_bin.

get_item()

tool_recyclebin\course_bin::get_item

(

$itemid

)

Returns an item from the recycle bin.

Parameters

int

$itemid

Item ID to retrieve.

Return values

stdClass

the item.

Reimplemented from tool_recyclebin\base_bin.

get_items()

tool_recyclebin\course_bin::get_items

(

)

Returns a list of items in the recycle bin for this course.

Return values

array

the list of items.

Reimplemented from tool_recyclebin\base_bin.

is_enabled()

static tool_recyclebin\course_bin::is_enabled ( )

static

Is this recyclebin enabled?

Return values

bool	true if enabled, false if not.

Reimplemented from tool_recyclebin\base_bin.

restore_item()

tool_recyclebin\course_bin::restore_item

(

$item

)

Restore an item from the recycle bin.

Parameters

stdClass

$item

The item database record

Exceptions

moodle_exception

Reimplemented from tool_recyclebin\base_bin.

store_item()

tool_recyclebin\course_bin::store_item

(

$cm

)

Store a course module in the recycle bin.

Parameters

stdClass

$cm

Course module

Exceptions

moodle_exception

Reimplemented from tool_recyclebin\base_bin.

---

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

• admin/tool/recyclebin/classes/course_bin.php