Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core_role_allow_view_page Class Reference

Subclass of role_allow_role_page for the Allow views tab. More...

Inheritance diagram for core_role_allow_view_page:
core_role_allow_role_page

Public Member Functions

 __construct ()
 core_role_allow_view_page constructor.
 
 get_intro_text ()
 Get intro text for role allow view page.
 
 get_table ()
 Returns structure that can be passed to print_table, containing one cell for each checkbox.
 
 load_current_settings ()
 Load the current allows from the database.
 
 process_submission ()
 Update the data with the new settings submitted by the user.
 

Protected Member Functions

 get_cell_tooltip ($fromrole, $targetrole)
 Get tool tip for cell.
 
 get_eventclass ()
 Returns the allow class respective event class name.
 
 is_allowed_target ($targetroleid)
 Is target allowed?
 
 load_required_roles ()
 Load information about all the roles we will need information about.
 
 set_allow ($fromroleid, $targetroleid)
 Allow from role to view target role.
 

Protected Attributes

 $allowed = null
 
array $allowedtargetroles
 
 $roles
 
 $tablename
 
 $targetcolname
 

Detailed Description

Subclass of role_allow_role_page for the Allow views tab.

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

Member Function Documentation

◆ get_cell_tooltip()

core_role_allow_view_page::get_cell_tooltip ( $fromrole,
$targetrole )
protected

Get tool tip for cell.

Parameters
stdClass$fromrole
stdClass$targetrole
Return values
string

◆ get_eventclass()

core_role_allow_view_page::get_eventclass ( )
protected

Returns the allow class respective event class name.

Return values
string

Reimplemented from core_role_allow_role_page.

◆ get_intro_text()

core_role_allow_view_page::get_intro_text ( )

Get intro text for role allow view page.

Return values
string
Exceptions
coding_exception

Reimplemented from core_role_allow_role_page.

◆ get_table()

core_role_allow_role_page::get_table ( )
inherited

Returns structure that can be passed to print_table, containing one cell for each checkbox.

Return values
html_tablea table

◆ is_allowed_target()

core_role_allow_role_page::is_allowed_target ( $targetroleid)
protectedinherited

Is target allowed?

Parameters
integer$targetroleida role id.
Return values
booleanwhether the user should be allowed to select this role as a target role.

Reimplemented in core_role_allow_switch_page.

◆ load_required_roles()

core_role_allow_role_page::load_required_roles ( )
protectedinherited

Load information about all the roles we will need information about.

Reimplemented in core_role_allow_switch_page.

◆ set_allow()

core_role_allow_view_page::set_allow ( $fromroleid,
$targetroleid )
protected

Allow from role to view target role.

Parameters
int$fromroleid
int$targetroleid

Reimplemented from core_role_allow_role_page.


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