Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 311 and 402] [Versions 400 and 402] [Versions 401 and 402]

(no description)

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

Defines 1 class


Class: manager  - X-Ref

Class manager

registration_url()   X-Ref
Returns the URL used for registration.

return: \moodle_url

registration_message()   X-Ref
Returns an appropriate message about the current registration state.

return: string

get_helpurl()   X-Ref
Get the help page URL.

return: string

get_checks()   X-Ref
Return an array of system checks available, and store them statically.

return: array

get_all_areas()   X-Ref
Find all available areas.

return: area_base[]

get_contenthash(?string $content = null)   X-Ref
No description

content_needs_scheduling(int $areaid, string $contenthash)   X-Ref
Does the current area content need to be scheduled for check?

It does not need to be scheduled if:
- it is the current content
OR
- there is already schedule

param: int $areaid
param: string $contenthash
return: bool

schedule_area_if_necessary(\stdClass $arearecord)   X-Ref
Schedule an area for analysis if there has been changes.

param: \stdClass $arearecord record with the fields from the {tool_brickfield_areas} table

find_new_or_updated_areas(\core\event\base $event)   X-Ref
Asks all area providers if they have any areas that might have changed as a result of an event and schedules them

param: \core\event\base $event

get_area_content(\stdClass $arearecord)   X-Ref
Returns the current content of the area.

param: \stdClass $arearecord record from the tool_brickfield_areas table
return: array|null array where the first element is the value of the field and the second element

find_new_or_updated_areas_per_course(int $courseid)   X-Ref
Asks all area providers if they have any areas that might have changed per courseid and schedules them.

param: int $courseid

check_scheduled_areas(int $batch = 0)   X-Ref
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

param: int $batch
return: bool

is_okay_to_cache()   X-Ref
Return true if analysis hasn't been disabled.

return: bool

check_scheduled_deletions(int $batch = 0)   X-Ref
Finds all areas that are waiting to be deleted, performs deletions.

param: int $batch limit, can be called from runcli.php

check_course_updates(int $batch = 0)   X-Ref
Checks all queued course updates, and finds all relevant areas.

param: int $batch limit

delete_area_tree(\stdClass $area)   X-Ref
Finds all records for a given content area and performs deletions.

To be called from scheduled task
param: \stdClass $area

delete_historical_data()   X-Ref
Finds all records which are no longer current and performs deletions.

To be called from scheduled task.

delete_summary_data(int $courseid)   X-Ref
Finds all summary cache records for a given courseid and performs deletions.
To be called from scheduled task.

param: int $courseid

store_result_summary(int $courseid = null)   X-Ref
Finds all results required to display accessibility report and stores them in the database.

To be called from scheduled task.
param: int|null $courseid

get_cm_summary_for_course(int $courseid)   X-Ref
Get course module summary information for a course.

param: int $courseid
return: \stdClass[]

get_section_summary_for_course(int $courseid)   X-Ref
Get section summary information for a course.

param: int $courseid
return: stdClass[]