tool_recyclebin

Files
file	access.php
	Plugin capabilities.
file	base_bin.php
	The main interface for recycle bin methods.
file	category_bin.php
	The main interface for recycle bin methods.
file	category_bin_item_created.php
	Recycle bin events.
file	category_bin_item_deleted.php
	Recycle bin events.
file	category_bin_item_restored.php
	Recycle bin events.
file	cleanup_category_bin.php
	Recycle bin cron task.
file	cleanup_course_bin.php
	Recycle bin cron task.
file	course_bin.php
	The main interface for recycle bin methods.
file	course_bin_item_created.php
	Recycle bin events.
file	course_bin_item_deleted.php
	Recycle bin events.
file	course_bin_item_restored.php
	Recycle bin events.
file	lib.php
	Local lib code.
file	provider.php
	Privacy Subsystem implementation for tool_recyclebin.
file	settings.php
	Recycle bin settings.
file	tasks.php
	Recycle bin tasks.
file	version.php
	Defines the version.

Namespaces
	tool_recyclebin
	tool_recyclebin\event
	tool_recyclebin\privacy
	tool_recyclebin\task

Classes
class	tool_recyclebin\base_bin
	Represents a recyclebin. More...
class	tool_recyclebin\category_bin
	Represents a category's recyclebin. More...
class	tool_recyclebin\course_bin
	Represents a course's recyclebin. More...
class	tool_recyclebin\event\category_bin_item_created
	Event class. More...
class	tool_recyclebin\event\category_bin_item_deleted
	Event class. More...
class	tool_recyclebin\event\category_bin_item_restored
	Event Class. More...
class	tool_recyclebin\event\course_bin_item_created
	Event class. More...
class	tool_recyclebin\event\course_bin_item_deleted
	Event class. More...
class	tool_recyclebin\event\course_bin_item_restored
	Event class. More...
class	tool_recyclebin\privacy\provider
	Privacy Subsystem for tool_recyclebin implementing null_provider. More...
class	tool_recyclebin\task\cleanup_category_bin
	This task deletes expired category recyclebin items. More...
class	tool_recyclebin\task\cleanup_course_bin
	This task deletes expired course recyclebin items. More...

Functions
	tool_recyclebin_course_module_background_deletion_recommended ()
	Hook called to check whether async course module deletion should be performed or not. More...
	tool_recyclebin_extend_navigation_category_settings ($navigation, $context)
	Adds a recycle bin link to the course admin menu. More...
	tool_recyclebin_extend_navigation_course ($navigation, $course, $context)
	Adds a recycle bin link to the course admin menu. More...
	tool_recyclebin_get_fontawesome_icon_map ()
	Map icons for font-awesome themes.
	tool_recyclebin_pre_course_category_delete ($category)
	Hook called before we delete a category. More...
	tool_recyclebin_pre_course_delete ($course)
	Hook called before we delete a course. More...
	tool_recyclebin_pre_course_module_delete ($cm)
	Hook called before we delete a course module. More...

Variables
	$capabilities
global	$PAGE
	$tasks
$plugin	component = 'tool_recyclebin'
$plugin	requires = 2019111200
const	tool_recyclebin::TOOL_RECYCLEBIN_COURSE_BIN_FILEAREA 'recyclebin_course'
const	tool_recyclebin::TOOL_RECYCLEBIN_COURSECAT_BIN_FILEAREA 'recyclebin_coursecat'
$plugin	version = 2019111800

Detailed Description

Function Documentation

tool_recyclebin_course_module_background_deletion_recommended()

tool_recyclebin_course_module_background_deletion_recommended

(

)

Hook called to check whether async course module deletion should be performed or not.

Return values

true	if background deletion is required (is the recyclebin is enabled), false otherwise.

tool_recyclebin_extend_navigation_category_settings()

tool_recyclebin_extend_navigation_category_settings	(		$navigation,
			$context
	)

Adds a recycle bin link to the course admin menu.

Parameters

navigation_node	$navigation	The navigation node to extend
context	$context	The context of the course

Return values

void|null

return null if we don't want to display the node.

tool_recyclebin_extend_navigation_course()

tool_recyclebin_extend_navigation_course	(		$navigation,
			$course,
			$context
	)

Adds a recycle bin link to the course admin menu.

Parameters

navigation_node	$navigation	The navigation node to extend
stdClass	$course	The course to object for the tool
context	$context	The context of the course

Return values

void|null

return null if we don't want to display the node.

tool_recyclebin_pre_course_category_delete()

tool_recyclebin_pre_course_category_delete

(

$category

)

Hook called before we delete a category.

Parameters

stdClass

$category

The category record.

tool_recyclebin_pre_course_delete()

tool_recyclebin_pre_course_delete

(

$course

)

Hook called before we delete a course.

Parameters

stdClass

$course

The course record.

tool_recyclebin_pre_course_module_delete()

tool_recyclebin_pre_course_module_delete

(

$cm

)

Hook called before we delete a course module.

Parameters

stdClass

$cm

The course module record.

Variable Documentation

$tasks

$tasks

Initial value:

= array(
    array(
        'classname' => 'tool_recyclebin\task\cleanup_course_bin',
        'blocking' => 0,
        'minute' => '*/30',
        'hour' => '*',
        'day' => '*',
        'dayofweek' => '*',
        'month' => '*'
    ),
    array(
        'classname' => 'tool_recyclebin\task\cleanup_category_bin',
        'blocking' => 0,
        'minute' => '*/30',
        'hour' => '*',
        'day' => '*',
        'dayofweek' => '*',
        'month' => '*'
    )
)