Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
core_role_check_capability_table Class Reference

Subclass of core_role_capability_table_base for use on the Check permissions page. More...

Inheritance diagram for core_role_check_capability_table:
core_role_capability_table_base

Public Member Functions

 __construct ($context, $user, $contextname)
 Constructor. More...
 
 add_classes ($classnames)
 Use this to add class="" attributes to the table. More...
 
 display ()
 Display the table. More...
 

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. More...
 
 add_row_cells ($capability)
 For subclasses to override. More...
 
 get_row_attributes ($capability)
 For subclasses to override. More...
 
 get_row_classes ($capability)
 For subclasses to override. More...
 
 num_extra_columns ()
 For subclasses to override, return the number of cells that add_header_cells/add_row_cells output. More...
 
 print_heading_row ($capability)
 Used to output a heading rows when the context level or component changes. More...
 
 skip_row ($capability)
 For subclasses to override. More...
 

Protected Attributes

 $capabilities = array()
 The capabilities to display. More...
 
 $classes = array('rolecap table-hover')
 Added to the class="" attribute on output.
 
 $context
 The context this table relates to.
 
 $contextname
 
 $fullname
 
 $id
 Added as an id="" attribute to the table on output.
 
 $strno
 
 $stryes
 
 $user
 

Detailed Description

Subclass of core_role_capability_table_base for use on the Check permissions page.

We have one additional column, Allowed, which contains yes/no.

Constructor & Destructor Documentation

◆ __construct()

core_role_check_capability_table::__construct (   $context,
  $user,
  $contextname 
)

Constructor.

Parameters
object$contextthe context this table relates to.
object$userthe user we are generating the results for.
string$contextname$context->get_context_name() - to save recomputing.

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$classnamesof class names.

◆ add_header_cells()

core_role_check_capability_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_check_capability_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$capabilitythe capability this row relates to.
Return values
stringhtml of row cells

Reimplemented from core_role_capability_table_base.

◆ display()

core_role_capability_table_base::display ( )
inherited

◆ 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$capabilitythe capability this row relates to.
Return values
arrayattribute names and their values.

Reimplemented in core_role_override_permissions_table_advanced, and core_role_permissions_table.

◆ get_row_classes()

core_role_check_capability_table::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$capabilitythe capability this row relates to.
Return values
arrayof class name strings.

Reimplemented from core_role_capability_table_base.

◆ num_extra_columns()

core_role_check_capability_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$capabilitygives 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$capabilitythe 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: