Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
This subclass is the bases for both the define roles and override roles pages. More...
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 | |
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.
core_role_capability_table_with_risks::__construct | ( | $context, | |
$id, | |||
$roleid ) |
Reimplemented in core_role_override_permissions_table_advanced.
|
inherited |
Use this to add class="" attributes to the table.
You get the rolecap by default.
array | $classnames | of class names. |
|
protected |
For subclasses to override, output header cells, after the initial capability one.
Reimplemented from core_role_capability_table_base.
|
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.
stdClass | $capability | the capability this row relates to. |
string | html of row cells |
Reimplemented from core_role_capability_table_base.
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.
core_role_capability_table_with_risks::get_risk_icon | ( | $type | ) |
Print a risk icon, as a link to the Risks page on Moodle Docs.
string | $type | the type of risk, will be one of the keys from the get_all_risks array. Must start with 'risk'. |
|
protectedinherited |
For subclasses to override.
Additional attributes to be added to each table row for the capability
stdClass | $capability | the capability this row relates to. |
array | attribute names and their values. |
Reimplemented in core_role_override_permissions_table_advanced, and core_role_permissions_table.
|
protected |
For subclasses to override.
A change to reaturn class names that are added to the class="" attribute on the <tr> for this capability.
stdClass | $capability | the capability this row relates to. |
array | of class name strings. |
Reimplemented from core_role_capability_table_base.
|
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.
|
protectedinherited |
Used to output a heading rows when the context level or component changes.
stdClass | $capability | gives the new component and contextlevel. |
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.
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.
|
protectedinherited |
For subclasses to override.
Allows certain capabilties to be left out of the table.
object | $capability | the capability this row relates to. |
boolean. | If true, this row is omitted from the table. |
Reimplemented in core_role_view_role_definition_table.
|
protectedinherited |
The capabilities to display.
Initialised as $context->get_capabilities().