tool_monitor\output\managesubs\rules Class Reference

Renderable class to display a set of rules in the manage subscriptions page. More...

Inheritance diagram for tool_monitor\output\managesubs\rules:

Public Member Functions
	__construct ($uniqueid, moodle_url $url, $courseid=0, $perpage=100)
	Sets up the table_log parameters.
	col_course (\tool_monitor\rule $rule)
	Generate content for course column.
	col_description (\tool_monitor\rule $rule)
	Generate content for description column.
	col_eventname (\tool_monitor\rule $rule)
	Generate content for eventname column.
	col_filters (\tool_monitor\rule $rule)
	Generate content for filters column.
	col_name (\tool_monitor\rule $rule)
	Generate content for name column.
	col_plugin (\tool_monitor\rule $rule)
	Generate content for plugin column.
	col_select (\tool_monitor\rule $rule)
	Generate content for select column.
	get_user_courses_select ($choose=false)
	Gets a list of courses where the current user can subscribe to rules as a dropdown.
	query_db ($pagesize, $useinitialsbar=true)
	Query the reader.

Public Attributes
int	$courseid
	course id.
int	$totalcount = 0
	total rules present.

Protected Attributes
context_course context_system	$context
	context of the page to be rendered.

Detailed Description

Renderable class to display a set of rules in the manage subscriptions page.

Since

Moodle 2.8

Copyright

2014 onwards Ankit Agarwal ankit.nosp@m..agr.nosp@m.r@gma.nosp@m.il.c.nosp@m.om

License

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

Constructor & Destructor Documentation

__construct()

tool_monitor\output\managesubs\rules::__construct	(		$uniqueid,
		moodle_url	$url,
			$courseid = 0,
			$perpage = 100 )

Sets up the table_log parameters.

Parameters

string	$uniqueid	unique id of form.
moodle_url	$url	url where this table is displayed.
int	$courseid	course id.
int	$perpage	Number of rules to display per page.

Member Function Documentation

col_course()

tool_monitor\output\managesubs\rules::col_course

(

\tool_monitor\rule

$rule

)

Generate content for course column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the course name.

col_description()

tool_monitor\output\managesubs\rules::col_description

(

\tool_monitor\rule

$rule

)

Generate content for description column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the description.

col_eventname()

tool_monitor\output\managesubs\rules::col_eventname

(

\tool_monitor\rule

$rule

)

Generate content for eventname column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the event name.

col_filters()

tool_monitor\output\managesubs\rules::col_filters

(

\tool_monitor\rule

$rule

)

Generate content for filters column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the filters.

col_name()

tool_monitor\output\managesubs\rules::col_name

(

\tool_monitor\rule

$rule

)

Generate content for name column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the rule name.

col_plugin()

tool_monitor\output\managesubs\rules::col_plugin

(

\tool_monitor\rule

$rule

)

Generate content for plugin column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the plugin name.

col_select()

tool_monitor\output\managesubs\rules::col_select

(

\tool_monitor\rule

$rule

)

Generate content for select column.

Parameters

tool_monitor\rule

$rule

rule object

Return values

string

html used to display the select field.

get_user_courses_select()

tool_monitor\output\managesubs\rules::get_user_courses_select

(

$choose = false

)

Gets a list of courses where the current user can subscribe to rules as a dropdown.

Parameters

bool

$choose

A flag for whether to show the 'choose...' option in the select box.

Return values

single_select|bool

returns the list of courses, or false if the select box should not be displayed.

query_db()

tool_monitor\output\managesubs\rules::query_db	(		$pagesize,
			$useinitialsbar = true )

Query the reader.

Store results in the object for use by build_table.

Parameters

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

---

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

• admin/tool/monitor/classes/output/managesubs/rules.php