tool_brickfield\accessibility Class Reference

Provides the Brickfield Accessibility toolkit API. More...

Static Public Member Functions
static	bulk_process_caches_cron ()
	Function to be run periodically according to the scheduled task.
static	bulk_process_courses_cron (int $batch=0)
	Function to be run periodically according to the scheduled task.
static	checkids (int $status=1)
	Returns all of the id's and shortnames of all of the checks.
static	get_capability_name (string $capability)
	Get the canonicalised name of a capability.
static	get_category_courseids (int $categoryid)
	Returns an array of all of the course id's for a given category.
static	get_file_path (string $path)
	Get a file path for a file within the plugin.
static	get_plugin_url (string $url='')
	Get a URL for a page within the plugin.
static	get_summary_data (int $id)
	Get summary data for this site.
static	get_title (filter $filter, int $countdata)
	Get the relevant title.
static	get_translations ()
	Returns an array of translations from htmlchecker of all of the checks, and their descriptions.
static	is_accessibility_enabled ()
	Return the state of the site enable condition.
static	require_accessibility_enabled ()
	Throw an error if the toolkit is not enabled.
static	run_check (string $html, int $contentid, int &$processingtime, int &$resultstime)
	This function runs the checks on the html item.
static	run_one_check (?string $html, int $contentid, int $errid, string $check, int &$processingtime, int &$resultstime)
	This function runs one specified check on the html item.

Public Attributes
string const	TOOL_BRICKFIELD_FORMAT_TOPIC = 'topics'
	Supported format of topics.
string const	TOOL_BRICKFIELD_FORMAT_WEEKLY = 'weeks'
	Supported format of weeks.

Static Protected Member Functions
static	bulk_processing (int $batch=0)
	Bulk processing.

Detailed Description

Provides the Brickfield Accessibility toolkit API.

Copyright

2020 onward Brickfield Education Labs Ltd, https://www.brickfield.ie

Author

Mike Churchward (mike@.nosp@m.bric.nosp@m.kfiel.nosp@m.dlab.nosp@m.s.ie)

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

bulk_process_caches_cron()

static tool_brickfield\accessibility::bulk_process_caches_cron ( )

static

Function to be run periodically according to the scheduled task.

Finds all unprocessed courses for cache processing and completes them.

bulk_process_courses_cron()

static tool_brickfield\accessibility::bulk_process_courses_cron ( int $batch = 0 )

static

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.

Parameters

int

$batch

Return values

bool

Exceptions

ReflectionException
coding_exception
ddl_exception
ddl_table_missing_exception
dml_exception

bulk_processing()

static tool_brickfield\accessibility::bulk_processing ( int $batch = 0 )

staticprotected

Bulk processing.

Parameters

int

$batch

Return values

bool

checkids()

static tool_brickfield\accessibility::checkids ( int $status = 1 )

static

Returns all of the id's and shortnames of all of the checks.

Parameters

int

$status

Return values

array

Exceptions

dml_exception

get_capability_name()

static tool_brickfield\accessibility::get_capability_name ( string $capability )

static

Get the canonicalised name of a capability.

Parameters

string

$capability

Return values

string

get_category_courseids()

static tool_brickfield\accessibility::get_category_courseids ( int $categoryid )

static

Returns an array of all of the course id's for a given category.

Parameters

int

$categoryid

Return values

array|null

Exceptions

dml_exception

get_file_path()

static tool_brickfield\accessibility::get_file_path ( string $path )

static

Get a file path for a file within the plugin.

This takes into account the value of the admin config value.

Parameters

string

$path

The path within the plugin

Return values

string

get_plugin_url()

static tool_brickfield\accessibility::get_plugin_url ( string $url = '' )

static

Get a URL for a page within the plugin.

This takes into account the value of the admin config value.

Parameters

string

$url

The URL within the plugin

Return values

moodle_url

get_summary_data()

static tool_brickfield\accessibility::get_summary_data ( int $id )

static

Get summary data for this site.

Parameters

int

$id

Return values

stdClass

Exceptions

dml_exception

get_title()

static tool_brickfield\accessibility::get_title ( filter $filter, int $countdata )

static

Get the relevant title.

Parameters

filter	$filter
int	$countdata

Return values

string

Exceptions

coding_exception
dml_exception
moodle_exception

get_translations()

static tool_brickfield\accessibility::get_translations ( )

static

Returns an array of translations from htmlchecker of all of the checks, and their descriptions.

Return values

array

Exceptions

dml_exception

is_accessibility_enabled()

static tool_brickfield\accessibility::is_accessibility_enabled ( )

static

Return the state of the site enable condition.

Return values

bool

require_accessibility_enabled()

static tool_brickfield\accessibility::require_accessibility_enabled ( )

static

Throw an error if the toolkit is not enabled.

Return values

bool

Exceptions

moodle_exception

run_check()

static tool_brickfield\accessibility::run_check ( string $html, int $contentid, int & $processingtime, int & $resultstime )

static

This function runs the checks on the html item.

Parameters

string	$html	The html string to be analysed; might be NULL.
int	$contentid	The content area ID
int	$processingtime
int	$resultstime

run_one_check()

static tool_brickfield\accessibility::run_one_check ( ?string $html, int $contentid, int $errid, string $check, int & $processingtime, int & $resultstime )

static

This function runs one specified check on the html item.

Parameters

string | null	$html	The html string to be analysed; might be NULL.
int	$contentid	The content area ID
int	$errid	The error ID
string	$check	The check name to run
int	$processingtime
int	$resultstime

Exceptions

coding_exception
dml_exception

---

The documentation for this class was generated from the following file:

• admin/tool/brickfield/classes/accessibility.php