Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 219 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: area_base  - X-Ref

Area base class.

checkgroup_name(int $checkgroupvalue)   X-Ref
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.

param: int $checkgroupvalue
return: string

checkgroup_value(string $checkgroupname)   X-Ref
Return the value for the specified checkgroup name, or the unknown value if no valid value for the name.

param: string $checkgroupname
return: int

get_type()   X-Ref
Return the defined content type.

return: int

get_component()   X-Ref
Return the component from the full class name.

return: mixed|string

is_available()   X-Ref
Check if the system plugin is avaliable.

return: bool

get_ref_tablename()   X-Ref
Return the name of the reference data table name.

return: string

find_system_areas()   X-Ref
Return an array of area objects that contain content at the site and system levels only. Override this where necessary.

return: \moodle_recordset|null

get_standard_area_fields_sql()   X-Ref
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.

return: string

get_reftable_field_sql()   X-Ref
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.

return: string

get_courseid_filtering()   X-Ref
Processes any sql filtering data. Implement in extensions.

return: null