core_role_permissions_table Class Reference

Subclass of core_role_capability_table_base for use on the Permissions page. More...

Inheritance diagram for core_role_permissions_table:

Public Member Functions
	__construct ($context, $contextname, $allowoverrides, $allowsafeoverrides, $overridableroles)
	Constructor.
	add_classes ($classnames)
	Use this to add class="" attributes to the table.
	display ()
	Display the table.

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_row_cells ($capability)
	For subclasses to override.
	get_risks ($capability)
	get_row_attributes ($capability)
	Add additional attributes to row.
	get_row_classes ($capability)
	For subclasses to override.
	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
	$allowoverrides
	$allowsafeoverrides
	$capabilities = array()
	The capabilities to display.
	$classes = array('rolecap table-hover')
	Added to the class="" attribute on output.
	$context
	The context this table relates to.
	$contextname
	$icons = array()
	$id
	Added as an id="" attribute to the table on output.
	$overridableroles
	$roles

Detailed Description

Subclass of core_role_capability_table_base for use on the Permissions page.

Constructor & Destructor Documentation

__construct()

core_role_permissions_table::__construct	(		$context,
			$contextname,
			$allowoverrides,
			$allowsafeoverrides,
			$overridableroles )

Constructor.

Parameters

context	$context	the context this table relates to.
string	$contextname	$context->get_context_name() - to save recomputing.
array	$allowoverrides
array	$allowsafeoverrides
array	$overridableroles

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_permissions_table::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_permissions_table::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_base::display ( )

inherited

Display the table.

Reimplemented in core_role_capability_table_with_risks, and core_role_define_role_table_advanced.

get_row_attributes()

core_role_permissions_table::get_row_attributes ( $capability )

protected

Add additional attributes to row.

Parameters

stdClass

$capability

capability that this table row relates to.

Return values

array

key value pairs of attribute names and values.

Reimplemented from core_role_capability_table_base.

get_row_classes()

core_role_capability_table_base::get_row_classes ( $capability )

protectedinherited

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 in core_role_capability_table_with_risks, and core_role_check_capability_table.

num_extra_columns()

core_role_permissions_table::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.

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/permissions_table.php