Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Public Member Functions | |
find_course_areas (int $courseid) | |
Find recordset of the course areas. | |
find_relevant_areas (\core\event\base $event) | |
Find recordset of the relevant areas. | |
find_system_areas () | |
Return an array of area objects that contain content at the site and system levels only. | |
get_component () | |
Return the component from the full class name. | |
get_courseid_filtering () | |
Processes any sql filtering data. | |
get_fieldname () | |
Get field name. | |
get_ref_tablename () | |
Return the name of the reference data table name. | |
get_reftable_field_sql () | |
The standard Moodle parameter DML parameter substitution doesn't work on all versions of MySQL or Postgres, so we need to use inline function substitution to ensure that the left side is a string. | |
get_standard_area_fields_sql () | |
The standard Moodle parameter DML parameter substitution doesn't work on all versions of MySQL or Postgres, so we need to use inline function substitution to ensure that the left side is a string. | |
get_tablename () | |
Get table name. | |
is_available () | |
Check if the system plugin is avaliable. | |
Static Public Member Functions | |
static | checkgroup_name (int $checkgroupvalue) |
Return the name for the specified checkgroup value, or 'unknown' if no valid name for the value. | |
static | checkgroup_value (string $checkgroupname) |
Return the value for the specified checkgroup name, or the unknown value if no valid value for the name. | |
static | get_edit_url (\stdClass $componentinfo) |
Returns the moodle_url of the page to edit the error. | |
Public Attributes | |
const | CHECKGROUP_FORM = 1 |
Defines the form for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | CHECKGROUP_IMAGE = 2 |
Defines the image for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | CHECKGROUP_LAYOUT = 3 |
Defines the layout for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | CHECKGROUP_LINK = 4 |
Defines the link for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | CHECKGROUP_MEDIA = 5 |
Defines the media for the 'checkgroup' field in the tool_brickfield_checks table. | |
string[] const | CHECKGROUP_NAMES |
Array for quick access of string names for 'checkgroups'. | |
const | CHECKGROUP_TABLE = 6 |
Defines the table for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | CHECKGROUP_TEXT = 7 |
Defines the text for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | CHECKGROUP_UNKNOWN = 0 |
Defines the unknown for the 'checkgroup' field in the tool_brickfield_checks table. | |
const | TYPE_FIELD = 0 |
Defines field value. | |
const | TYPE_FILE = 1 |
Defines file value. | |
Protected Member Functions | |
find_fields_in_module_table (array $params=[]) | |
Helper method that can be used by the classes that define a field in the respective module table. | |
get_type () | |
Return the defined content type. | |
Protected Attributes | |
string string | $filter = '' |
To store the filter. | |
string | $filterfieldname |
To store the filter field name. | |
array array | $filterparams = [] |
To store the filter parameters. | |
|
staticfinalinherited |
Return the name for the specified checkgroup value, or 'unknown' if no valid name for the value.
Preferably, use this rather than direct access to CHECKGROUP_NAMES, since it checks value boundaries.
int | $checkgroupvalue |
string |
|
staticfinalinherited |
Return the value for the specified checkgroup name, or the unknown value if no valid value for the name.
string | $checkgroupname |
int |
|
inherited |
Find recordset of the course areas.
int | $courseid |
moodle_recordset |
coding_exception | |
dml_exception |
Reimplemented from tool_brickfield\area_base.
|
protectedinherited |
Helper method that can be used by the classes that define a field in the respective module table.
array | $params |
moodle_recordset |
coding_exception | |
dml_exception |
|
inherited |
Find recordset of the relevant areas.
core\event\base | $event |
moodle_recordset|null |
coding_exception | |
dml_exception |
Reimplemented from tool_brickfield\area_base.
|
inherited |
Return an array of area objects that contain content at the site and system levels only.
Override this where necessary.
moodle_recordset|null |
Reimplemented in tool_brickfield\local\areas\core_course\base, tool_brickfield\local\areas\core_course\category_base, tool_brickfield\local\areas\core_question\answerbase, and tool_brickfield\local\areas\core_question\base.
|
inherited |
Return the component from the full class name.
mixed|string |
|
inherited |
Processes any sql filtering data.
Implement in extensions.
null |
coding_exception | |
dml_exception |
|
staticinherited |
Returns the moodle_url of the page to edit the error.
stdClass | $componentinfo |
moodle_url |
Reimplemented in tool_brickfield\local\areas\mod_book\base, and tool_brickfield\local\areas\mod_lesson\base.
tool_brickfield\local\areas\mod_survey\name::get_fieldname | ( | ) |
|
inherited |
Return the name of the reference data table name.
string |
Reimplemented in tool_brickfield\local\areas\core_course\sectionname, tool_brickfield\local\areas\core_course\sectionsummary, tool_brickfield\local\areas\core_question\answerbase, tool_brickfield\local\areas\mod_book\chaptercontent, tool_brickfield\local\areas\mod_book\chaptertitle, tool_brickfield\local\areas\mod_choice\option, tool_brickfield\local\areas\mod_lesson\answer_base, and tool_brickfield\local\areas\mod_lesson\page_base.
|
inherited |
|
inherited |
tool_brickfield\local\areas\mod_survey\name::get_tablename | ( | ) |
|
protectedinherited |
Return the defined content type.
int |
|
inherited |
Check if the system plugin is avaliable.
bool |
|
inherited |
Array for quick access of string names for 'checkgroups'.