Search moodle.org's
Developer Documentation
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.
/admin/tool/brickfield/classes/ -> accessibility.php (source)
Differences Between: [Versions 311 and 401] [Versions 400 and 401]
(no description)
| File Size: | 571 lines (21 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
accessibility:: (19 methods):
is_accessibility_enabled()
require_accessibility_enabled()
get_plugin_url()
get_file_path()
get_capability_name()
get_title()
bulk_process_courses_cron()
bulk_processing()
bulk_process_caches_cron()
run_check()
run_one_check()
checkids()
get_translations()
get_category_courseids()
get_summary_data()
get_contenttyperesults()
get_percheckerrors()
get_contenttypeerrors()
get_summary_data_storage()
Class: accessibility - X-Ref
Provides the Brickfield Accessibility toolkit API.| is_accessibility_enabled() X-Ref |
| Return the state of the site enable condition. return: bool |
| require_accessibility_enabled() X-Ref |
| Throw an error if the toolkit is not enabled. return: bool |
| get_plugin_url(string $url = '') X-Ref |
| Get a URL for a page within the plugin. This takes into account the value of the admin config value. param: string $url The URL within the plugin return: moodle_url |
| get_file_path(string $path) X-Ref |
| Get a file path for a file within the plugin. This takes into account the value of the admin config value. param: string $path The path within the plugin return: string |
| get_capability_name(string $capability) X-Ref |
| Get the canonicalised name of a capability. param: string $capability return: string |
| get_title(filter $filter, int $countdata) X-Ref |
| Get the relevant title. param: filter $filter param: int $countdata return: string |
| bulk_process_courses_cron(int $batch = 0) X-Ref |
| Function to be run periodically according to the scheduled task. Return true if a process was completed. False if no process executed. Finds all unprocessed courses for bulk batch processing and completes them. param: int $batch return: bool |
| bulk_processing(int $batch = 0) X-Ref |
| Bulk processing. param: int $batch return: bool |
| bulk_process_caches_cron() X-Ref |
| Function to be run periodically according to the scheduled task. Finds all unprocessed courses for cache processing and completes them. |
| run_check(string $html, int $contentid, int &$processingtime, int &$resultstime) X-Ref |
| This function runs the checks on the html item param: string $html The html string to be analysed; might be NULL. param: int $contentid The content area ID param: int $processingtime param: int $resultstime |
| run_one_check(?string $html,int $contentid,int $errid,string $check,int &$processingtime,int &$resultstime) X-Ref |
| This function runs one specified check on the html item param: string|null $html The html string to be analysed; might be NULL. param: int $contentid The content area ID param: int $errid The error ID param: string $check The check name to run param: int $processingtime param: int $resultstime |
| checkids(int $status = 1) X-Ref |
| Returns all of the id's and shortnames of all of the checks. param: int $status return: array |
| get_translations() X-Ref |
| Returns an array of translations from htmlchecker of all of the checks, and their descriptions. return: array |
| get_category_courseids(int $categoryid) X-Ref |
| Returns an array of all of the course id's for a given category. param: int $categoryid return: array|null |
| get_summary_data(int $id) X-Ref |
| Get summary data for this site. param: int $id return: \stdClass |
| get_contenttyperesults(int $id) X-Ref |
| Get content type results. param: int $id return: \stdClass |
| get_percheckerrors() X-Ref |
| Get per check errors. return: stdClass |
| get_contenttypeerrors() X-Ref |
| Get content type errors. return: stdClass |
| get_summary_data_storage() X-Ref |
| Get summary data storage. return: array |
