tool_dataprivacy\output\expired_contexts_table Class Reference

The class for displaying the expired contexts table. More...

Inheritance diagram for tool_dataprivacy\output\expired_contexts_table:

Public Member Functions
	__construct ($contextlevel=null)
	expired_contexts_table constructor.
	col_category ($expiredctx)
	The category name column.
	col_info ($expiredctx)
	The context information column.
	col_name ($expiredctx)
	The context name column.
	col_purpose ($expiredctx)
	The purpose column.
	col_retentionperiod ($expiredctx)
	The retention period column.
	col_select ($expiredctx)
	Generate the select column.
	col_timecreated ($expiredctx)
	The timecreated a.k.a.
	col_tobedeleted ($expiredctx)
	Formatting for the 'tobedeleted' column which indicates in a friendlier fashion whose data will be removed.
	print_nothing_to_display ()
	Override default implementation to display a more meaningful information to the user.
	query_db ($pagesize, $useinitialsbar=true)
	Query the database for results to display in the table.

Protected Member Functions
	get_purpose_for_expiry (expired_context $expiredcontext)
	Get the purpose for the specified expired context.
	preload_contexts (array $contextids)
	Preload context records given a set of contextids.
	show_hide_link ($column, $index)
	Override the table's show_hide_link method to prevent the show/hide link for the select column from rendering.

Protected Attributes
int	$contextlevel = null
	The context level acting as a filter for this table.
purpose[]	$purposemap = []
	Map of context => purpose.
purpose[]	$purposes = []
	Array of purposes by their id.
array	$roles = []
	List of roles.
bool	$selectall = true
	$selectall Has the user selected all users on the page?

Detailed Description

The class for displaying the expired contexts table.

Copyright

2018 Jun Pataleta jun@m.nosp@m.oodl.nosp@m.e.com

License

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

Constructor & Destructor Documentation

__construct()

tool_dataprivacy\output\expired_contexts_table::__construct

(

$contextlevel = null

)

expired_contexts_table constructor.

Parameters

int | null

$contextlevel

Exceptions

coding_exception

Member Function Documentation

col_category()

tool_dataprivacy\output\expired_contexts_table::col_category

(

$expiredctx

)

The category name column.

Parameters

stdClass

$expiredctx

The row data.

Return values

mixed

Exceptions

coding_exception
dml_exception

col_info()

tool_dataprivacy\output\expired_contexts_table::col_info

(

$expiredctx

)

The context information column.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

Exceptions

coding_exception

col_name()

tool_dataprivacy\output\expired_contexts_table::col_name

(

$expiredctx

)

The context name column.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

Exceptions

coding_exception

col_purpose()

tool_dataprivacy\output\expired_contexts_table::col_purpose

(

$expiredctx

)

The purpose column.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

Exceptions

coding_exception

col_retentionperiod()

tool_dataprivacy\output\expired_contexts_table::col_retentionperiod

(

$expiredctx

)

The retention period column.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

col_select()

tool_dataprivacy\output\expired_contexts_table::col_select

(

$expiredctx

)

Generate the select column.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

col_timecreated()

tool_dataprivacy\output\expired_contexts_table::col_timecreated

(

$expiredctx

)

The timecreated a.k.a.

the context expiry date column.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

col_tobedeleted()

tool_dataprivacy\output\expired_contexts_table::col_tobedeleted

(

$expiredctx

)

Formatting for the 'tobedeleted' column which indicates in a friendlier fashion whose data will be removed.

Parameters

stdClass

$expiredctx

The row data.

Return values

string

get_purpose_for_expiry()

tool_dataprivacy\output\expired_contexts_table::get_purpose_for_expiry ( expired_context $expiredcontext )

protected

Get the purpose for the specified expired context.

Parameters

expired_context

$expiredcontext

Return values

purpose

preload_contexts()

tool_dataprivacy\output\expired_contexts_table::preload_contexts ( array $contextids )

protected

Preload context records given a set of contextids.

Parameters

array

$contextids

query_db()

tool_dataprivacy\output\expired_contexts_table::query_db	(		$pagesize,
			$useinitialsbar = true )

Query the database for results to display in the table.

Parameters

int	$pagesize	size of page for paginated displayed table.
bool	$useinitialsbar	do you want to use the initials bar.

Exceptions

dml_exception
coding_exception

show_hide_link()

tool_dataprivacy\output\expired_contexts_table::show_hide_link ( $column, $index )

protected

Override the table's show_hide_link method to prevent the show/hide link for the select column from rendering.

Parameters

string	$column	the column name, index into various names.
int	$index	numerical index of the column.

Return values

string

HTML fragment.

Member Data Documentation

$selectall

bool tool_dataprivacy\output\expired_contexts_table::$selectall = true

protected

$selectall Has the user selected all users on the page?

True by default.

---

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

• admin/tool/dataprivacy/classes/output/expired_contexts_table.php