Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Public Attributes | List of all members
user_filter_courserole Class Reference

User filter based on roles in a course identified by its shortname. More...

Inheritance diagram for user_filter_courserole:
user_filter_type

Public Member Functions

 __construct ($name, $label, $advanced)
 Constructor. More...
 
 check_data ($formdata)
 Retrieves data from the form data. More...
 
 get_course_categories ()
 Returns an array of course categories. More...
 
 get_label ($data)
 Returns a human friendly description of the filter used as label. More...
 
 get_roles ()
 Returns an array of available roles. More...
 
 get_sql_filter ($data)
 Returns the condition to be used with SQL where. More...
 
 setupForm (&$mform)
 Adds controls specific to this filter in the form. More...
 
 user_filter_courserole ($name, $label, $advanced)
 Old syntax of class constructor. More...
 
 user_filter_type ($name, $label, $advanced)
 Old syntax of class constructor. More...
 

Public Attributes

bool $_advanced
 Advanced form element flag.
 
string $_label
 The label of this filter instance.
 
string $_name
 The name of this filter instance.
 

Detailed Description

User filter based on roles in a course identified by its shortname.

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

Constructor & Destructor Documentation

◆ __construct()

user_filter_courserole::__construct (   $name,
  $label,
  $advanced 
)

Constructor.

Parameters
string$namethe name of the filter instance
string$labelthe label of the filter instance
boolean$advancedadvanced form element flag

Reimplemented from user_filter_type.

Member Function Documentation

◆ check_data()

user_filter_courserole::check_data (   $formdata)

Retrieves data from the form data.

Parameters
stdClass$formdatadata submited with the form
Return values
mixedarray filter data or false when filter not set

Reimplemented from user_filter_type.

◆ get_course_categories()

user_filter_courserole::get_course_categories ( )

Returns an array of course categories.

Return values
arrayof course categories

◆ get_label()

user_filter_courserole::get_label (   $data)

Returns a human friendly description of the filter used as label.

Parameters
array$datafilter settings
Return values
stringactive filter label

Reimplemented from user_filter_type.

◆ get_roles()

user_filter_courserole::get_roles ( )

Returns an array of available roles.

Return values
arrayof availble roles

◆ get_sql_filter()

user_filter_courserole::get_sql_filter (   $data)

Returns the condition to be used with SQL where.

Parameters
array$datafilter settings
Return values
arraysql string and $params

Reimplemented from user_filter_type.

◆ setupForm()

user_filter_courserole::setupForm ( $mform)

Adds controls specific to this filter in the form.

Parameters
moodleform$mforma MoodleForm object to setup

Reimplemented from user_filter_type.

◆ user_filter_courserole()

user_filter_courserole::user_filter_courserole (   $name,
  $label,
  $advanced 
)

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:
since Moodle 3.1

◆ user_filter_type()

user_filter_type::user_filter_type (   $name,
  $label,
  $advanced 
)
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated:
since Moodle 3.1

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