Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Static Public Member Functions | |
static | check_course_updates (int $batch=0) |
Checks all queued course updates, and finds all relevant areas. | |
static | check_scheduled_areas (int $batch=0) |
Finds all areas that are waiting to be checked, performs checks. | |
static | check_scheduled_deletions (int $batch=0) |
Finds all areas that are waiting to be deleted, performs deletions. | |
static | delete_area_tree (\stdClass $area) |
Finds all records for a given content area and performs deletions. | |
static | delete_historical_data () |
Finds all records which are no longer current and performs deletions. | |
static | delete_summary_data (int $courseid) |
Finds all summary cache records for a given courseid and performs deletions. | |
static | find_new_or_updated_areas (\core\event\base $event) |
Asks all area providers if they have any areas that might have changed as a result of an event and schedules them. | |
static | find_new_or_updated_areas_per_course (int $courseid) |
Asks all area providers if they have any areas that might have changed per courseid and schedules them. | |
static | get_all_areas () |
Find all available areas. | |
static | get_checks () |
Return an array of system checks available, and store them statically. | |
static | get_cm_summary_for_course (int $courseid) |
Get course module summary information for a course. | |
static | get_contenthash (?string $content=null) |
Calculate contenthash of a given content string. | |
static | get_helpurl () |
Get the help page URL. | |
static | get_section_summary_for_course (int $courseid) |
Get section summary information for a course. | |
static | is_okay_to_cache () |
Return true if analysis hasn't been disabled. | |
static | registration_message () |
Returns an appropriate message about the current registration state. | |
static | registration_url () |
Returns the URL used for registration. | |
static | store_result_summary (int $courseid=null) |
Finds all results required to display accessibility report and stores them in the database. | |
Static Protected Member Functions | |
static | content_needs_scheduling (int $areaid, string $contenthash) |
Does the current area content need to be scheduled for check? | |
static | get_area_content (\stdClass $arearecord) |
Returns the current content of the area. | |
static | schedule_area_if_necessary (\stdClass $arearecord) |
Schedule an area for analysis if there has been changes. | |
Static Protected Attributes | |
static array | $checks |
Statically stores the database checks records. | |
|
static |
Checks all queued course updates, and finds all relevant areas.
int | $batch | limit To be called from scheduled task |
ReflectionException | |
dml_exception |
|
static |
Finds all areas that are waiting to be checked, performs checks.
Returns true if there were records processed, false if not. To be called from scheduled task
int | $batch |
bool |
|
static |
Finds all areas that are waiting to be deleted, performs deletions.
int | $batch | limit, can be called from runcli.php To be called from scheduled task |
coding_exception | |
dml_exception |
|
staticprotected |
Does the current area content need to be scheduled for check?
It does not need to be scheduled if:
int | $areaid | |
string | $contenthash |
bool |
dml_exception |
|
static |
Finds all records for a given content area and performs deletions.
To be called from scheduled task
stdClass | $area |
dml_exception |
|
static |
Finds all records which are no longer current and performs deletions.
To be called from scheduled task.
|
static |
Finds all summary cache records for a given courseid and performs deletions.
To be called from scheduled task.
int | $courseid |
dml_exception |
|
static |
Asks all area providers if they have any areas that might have changed as a result of an event and schedules them.
core\event\base | $event |
ReflectionException | |
dml_exception |
|
static |
Asks all area providers if they have any areas that might have changed per courseid and schedules them.
int | $courseid |
ReflectionException | |
coding_exception | |
ddl_exception | |
ddl_table_missing_exception | |
dml_exception |
|
static |
Find all available areas.
area_base[] |
ReflectionException |
|
staticprotected |
Returns the current content of the area.
stdClass | $arearecord | record from the tool_brickfield_areas table |
array|null | array where the first element is the value of the field and the second element is the 'format' for this field if it is present. If the record was not found null is returned. |
|
static |
Return an array of system checks available, and store them statically.
array |
dml_exception |
|
static |
Get course module summary information for a course.
int | $courseid |
stdClass[] |
|
static |
Calculate contenthash of a given content string.
string | null | $content |
string |
|
static |
|
static |
Get section summary information for a course.
int | $courseid |
stdClass[] |
|
static |
|
static |
Returns an appropriate message about the current registration state.
string |
coding_exception | |
dml_exception | |
moodle_exception |
|
static |
Returns the URL used for registration.
moodle_url |
|
staticprotected |
Schedule an area for analysis if there has been changes.
stdClass | $arearecord | record with the fields from the {tool_brickfield_areas} table as returned by area_base\find_relevant_areas(). It also contains the 'content' property with the current area content |
dml_exception |
|
static |
Finds all results required to display accessibility report and stores them in the database.
To be called from scheduled task.
int | null | $courseid |
coding_exception | |
dml_exception |