core_role_capability_table_with_risks Class Reference

This subclass is the bases for both the define roles and override roles pages. More...

Inheritance diagram for core_role_capability_table_with_risks:

Public Member Functions
	__construct ($context, $id, $roleid)
	add_classes ($classnames)
	Use this to add class="" attributes to the table.
	display ()
	Display the table.
	get_risk_icon ($type)
	Print a risk icon, as a link to the Risks page on Moodle Docs.
	read_submitted_permissions ()
	Update $this->permissions based on submitted data, while making a list of changed capabilities in $this->changed.
	save_changes ()
	Save the new values of any permissions that have been changed.

Public Attributes
const	NUM_CAPS_FOR_SEARCH = 12
	Default number of capabilities in the table for the search UI to be shown.

Protected Member Functions
	add_header_cells ()
	For subclasses to override, output header cells, after the initial capability one.
	add_permission_cells ($capability)
	add_row_cells ($capability)
	For subclasses to override.
	get_row_attributes ($capability)
	For subclasses to override.
	get_row_classes ($capability)
	For subclasses to override.
	load_current_permissions ()
	load_parent_permissions ()
	num_extra_columns ()
	For subclasses to override, return the number of cells that add_header_cells/add_row_cells output.
	print_heading_row ($capability)
	Used to output a heading rows when the context level or component changes.
	skip_row ($capability)
	For subclasses to override.

Protected Attributes
	$allpermissions
	$allrisks
	$capabilities = array()
	The capabilities to display.
	$changed
	$classes = array('rolecap table-hover')
	Added to the class="" attribute on output.
	$context
	The context this table relates to.
	$displaypermissions
	$id
	Added as an id="" attribute to the table on output.
array	$parentpermissions
	The capabilities to highlight as default/inherited.
	$permissions
	$risksurl
	$roleid
	$strperms

Detailed Description

This subclass is the bases for both the define roles and override roles pages.

As well as adding the risks columns, this also provides generic facilities for showing a certain number of permissions columns, and recording the current and submitted permissions for each capability.

Constructor & Destructor Documentation

__construct()

core_role_capability_table_with_risks::__construct	(		$context,
			$id,
			$roleid )

Reimplemented in core_role_override_permissions_table_advanced.

Member Function Documentation

add_classes()

core_role_capability_table_base::add_classes ( $classnames )

inherited

Use this to add class="" attributes to the table.

You get the rolecap by default.

Parameters

array

$classnames

of class names.

add_header_cells()

core_role_capability_table_with_risks::add_header_cells ( )

protected

For subclasses to override, output header cells, after the initial capability one.

Reimplemented from core_role_capability_table_base.

add_row_cells()

core_role_capability_table_with_risks::add_row_cells ( $capability )

protected

For subclasses to override.

Output the data cells for this capability. The capability name cell will already have been output.

You can rely on get_row_classes always being called before add_row_cells.

Parameters

stdClass

$capability

the capability this row relates to.

Return values

string

html of row cells

Reimplemented from core_role_capability_table_base.

display()

core_role_capability_table_with_risks::display

(

)

Display the table.

Reimplemented from core_role_capability_table_base.

Reimplemented in core_role_define_role_table_advanced.

get_risk_icon()

core_role_capability_table_with_risks::get_risk_icon

(

$type

)

Print a risk icon, as a link to the Risks page on Moodle Docs.

Parameters

string

$type

the type of risk, will be one of the keys from the get_all_risks array. Must start with 'risk'.

get_row_attributes()

core_role_capability_table_base::get_row_attributes ( $capability )

protectedinherited

For subclasses to override.

Additional attributes to be added to each table row for the capability

Parameters

stdClass

$capability

the capability this row relates to.

Return values

array

attribute names and their values.

Reimplemented in core_role_override_permissions_table_advanced, and core_role_permissions_table.

get_row_classes()

core_role_capability_table_with_risks::get_row_classes ( $capability )

protected

For subclasses to override.

A change to reaturn class names that are added to the class="" attribute on the <tr> for this capability.

Parameters

stdClass

$capability

the capability this row relates to.

Return values

array

of class name strings.

Reimplemented from core_role_capability_table_base.

num_extra_columns()

core_role_capability_table_with_risks::num_extra_columns ( )

protected

For subclasses to override, return the number of cells that add_header_cells/add_row_cells output.

Reimplemented from core_role_capability_table_base.

print_heading_row()

core_role_capability_table_base::print_heading_row ( $capability )

protectedinherited

Used to output a heading rows when the context level or component changes.

Parameters

stdClass

$capability

gives the new component and contextlevel.

read_submitted_permissions()

core_role_capability_table_with_risks::read_submitted_permissions

(

)

Update $this->permissions based on submitted data, while making a list of changed capabilities in $this->changed.

Reimplemented in core_role_define_role_table_advanced.

save_changes()

core_role_capability_table_with_risks::save_changes

(

)

Save the new values of any permissions that have been changed.

Reimplemented in core_role_define_role_table_advanced, and core_role_view_role_definition_table.

skip_row()

core_role_capability_table_base::skip_row ( $capability )

protectedinherited

For subclasses to override.

Allows certain capabilties to be left out of the table.

Parameters

object

$capability

the capability this row relates to.

Return values

boolean.

If true, this row is omitted from the table.

Reimplemented in core_role_view_role_definition_table.

Member Data Documentation

$capabilities

core_role_capability_table_base::$capabilities = array()

protectedinherited

The capabilities to display.

Initialised as $context->get_capabilities().

---

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

• admin/roles/classes/capability_table_with_risks.php