Class printable. More...

Inheritance diagram for tool_brickfield\local\tool\printable:

Public Member Functions
	can_access (filter $filter, context $context=null)
	Verify that accessibility tools can be accessed in the provided context.

	data_error ()
	Implementing class should set an error string if data is invalidated in 'get_data';.

	data_is_valid ()
	Implementing class should set the 'valid' property when get_data is called.

	get_data ()
	Return the data needed for the renderer.

	get_error_message ()
	Return any defined error message.

	get_filter ()
	Getter for filter property.

	get_output ()
	Get the HTML output for display.

	get_output_target ()
	Returns the output target for this tool's filter.

	get_toolname ()
	Return the defined toolname.

	get_toolshortname ()
	Return the defined toolshortname.

	perpage_limits (int $perpage)
	Override this to return any tool specific perpage limits.

	pluginname ()
	Provide a lowercase name identifying this plugin.

	set_filter (filter $filter)
	Setter for filter property.

Static Public Member Functions
static	base64_img_array ()
	Return array of base64 image formats.

static	base64_img_detected (string $htmlcode)
	Detects if htmlcode contains base64 img data, for HTML display, such as errors page.

static	build_all_accessibilitytools ()
	Return an array with one of each tool instance.

static	get_check_description (string $check)
	Return the correct language string for the provided check.

static	get_instance_name (string $component, string $table, ?int $cmid, ?int $courseid, ?int $categoryid)
	Get instance name for display.

static	get_module_label (string $modulename)
	Get module label for display.

static	get_tool_names ()
	Get a list of formal tool names for each tool.

static	toolname ()
	Provide a name for this tool, suitable for display on pages.

static	toolshortname ()
	Provide a short name for this tool, suitable for menus and selectors.

static	toplevel_arguments (filter $filter=null)
	Provide arguments required for the toplevel page, using any provided filter.

static	truncate_base64 (string $htmlcode)
	Truncate base64-containing htmlcode for HTML display, such as errors page.

Public Attributes
string const	BASE64_BMP = 'data:image/bmp;base64'
	base64 bitmap image type

string const	BASE64_GIF = 'data:image/gif;base64'
	base64 gif image type

string const	BASE64_ICO = 'data:image/x-icon;base64'
	base64 ico image type

string const	BASE64_JPG = 'data:image/jpeg;base64'
	base64 jpg image type

string const	BASE64_PNG = 'data:image/png;base64'
	base64 png image type

string const	BASE64_SVG = 'data:image/svg+xml;base64'
	base64 svg image type

string const	BASE64_WEBP = 'data:image/webp;base64'
	base64 webp image type

string[] const	TOOLNAMES = ['errors', 'activityresults', 'checktyperesults', 'printable', 'advanced']
	All of the tools provided.

Protected Member Functions
	fetch_data ()
	Return the data for renderer / template display.

Static Protected Member Functions
static	get_tool_classnames ()
	Get a mapping of tool shortname => class name.

Detailed Description

Class printable.

Copyright: 2020 onward: Brickfield Education Labs, www.brickfield.ie

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

Member Function Documentation

◆ base64_img_array()

static tool_brickfield\local\tool\tool::base64_img_array ( )

staticinherited

Return array of base64 image formats.

Return values

array

◆ base64_img_detected()

static tool_brickfield\local\tool\tool::base64_img_detected ( string $htmlcode )

staticinherited

Detects if htmlcode contains base64 img data, for HTML display, such as errors page.

Parameters

string $htmlcode

Return values

boolean

◆ build_all_accessibilitytools()

static tool_brickfield\local\tool\tool::build_all_accessibilitytools ( )

staticinherited

Return an array with one of each tool instance.

Return values

tool[]

◆ can_access()

tool_brickfield\local\tool\tool::can_access	(	filter	$filter,
		context	$context = null )

inherited

Verify that accessibility tools can be accessed in the provided context.

Parameters

filter	$filter
context	$context

Return values

bool

Exceptions

coding_exception
dml_exception

◆ data_error()

tool_brickfield\local\tool\tool::data_error ( )

inherited

Implementing class should set an error string if data is invalidated in 'get_data';.

Return values

string

◆ data_is_valid()

tool_brickfield\local\tool\tool::data_is_valid ( )

inherited

Implementing class should set the 'valid' property when get_data is called.

Return values

bool

◆ fetch_data()

tool_brickfield\local\tool\printable::fetch_data ( )

protected

Return the data for renderer / template display.

Return values

stdClass

Exceptions

coding_exception
dml_exception

Reimplemented from tool_brickfield\local\tool\tool.

◆ get_check_description()

static tool_brickfield\local\tool\tool::get_check_description ( string $check )

staticinherited

Return the correct language string for the provided check.

Parameters

string $check

Return values

string

◆ get_data()

tool_brickfield\local\tool\tool::get_data ( )

inherited

Return the data needed for the renderer.

Return values

stdClass

Exceptions

coding_exception

◆ get_error_message()

tool_brickfield\local\tool\tool::get_error_message ( )

inherited

Return any defined error message.

Return values

string

◆ get_filter()

tool_brickfield\local\tool\tool::get_filter ( )

inherited

Getter for filter property.

Return values

filter|null

◆ get_instance_name()

static tool_brickfield\local\tool\tool::get_instance_name	(	string	$component,
		string	$table,
		?int	$cmid,
		?int	$courseid,
		?int	$categoryid )

staticinherited

Get instance name for display.

Parameters

string	$component
string	$table
int	$cmid
int	$courseid
int	$categoryid

Return values

string

◆ get_module_label()

static tool_brickfield\local\tool\tool::get_module_label ( string $modulename )

staticinherited

Get module label for display.

Parameters

string $modulename

Return values

string

Exceptions

coding_exception

◆ get_output()

tool_brickfield\local\tool\printable::get_output ( )

Get the HTML output for display.

Return values

mixed

Reimplemented from tool_brickfield\local\tool\tool.

◆ get_output_target()

tool_brickfield\local\tool\tool::get_output_target ( )

inherited

Returns the output target for this tool's filter.

Return values

string

Exceptions

coding_exception

◆ get_tool_classnames()

static tool_brickfield\local\tool\tool::get_tool_classnames ( )

staticprotectedinherited

Get a mapping of tool shortname => class name.

Return values

string[]

◆ get_tool_names()

static tool_brickfield\local\tool\tool::get_tool_names ( )

staticinherited

Get a list of formal tool names for each tool.

Return values

string[]

◆ get_toolname()

tool_brickfield\local\tool\tool::get_toolname ( )

inherited

Return the defined toolname.

Return values

mixed

◆ get_toolshortname()

tool_brickfield\local\tool\tool::get_toolshortname ( )

inherited

Return the defined toolshortname.

Return values

mixed

◆ perpage_limits()

tool_brickfield\local\tool\tool::perpage_limits ( int $perpage )

inherited

Override this to return any tool specific perpage limits.

Parameters

int $perpage

Return values

int

Reimplemented in tool_brickfield\local\tool\errors.

◆ pluginname()

tool_brickfield\local\tool\printable::pluginname ( )

Provide a lowercase name identifying this plugin.

Should really be the same as the directory name.

Return values

string

Reimplemented from tool_brickfield\local\tool\tool.

◆ set_filter()

tool_brickfield\local\tool\tool::set_filter ( filter $filter )

inherited

Setter for filter property.

Parameters

filter $filter

Exceptions

coding_exception

◆ toolname()

static tool_brickfield\local\tool\printable::toolname ( )

static

Provide a name for this tool, suitable for display on pages.

Return values

mixed|string

Exceptions

coding_exception

Reimplemented from tool_brickfield\local\tool\tool.

◆ toolshortname()

static tool_brickfield\local\tool\printable::toolshortname ( )

static

Provide a short name for this tool, suitable for menus and selectors.

Return values

mixed|string

Exceptions

coding_exception

Reimplemented from tool_brickfield\local\tool\tool.

◆ toplevel_arguments()

static tool_brickfield\local\tool\tool::toplevel_arguments ( filter $filter = null )

staticinherited

Provide arguments required for the toplevel page, using any provided filter.

Parameters

filter | null $filter

Return values

array

◆ truncate_base64()

static tool_brickfield\local\tool\tool::truncate_base64 ( string $htmlcode )

staticinherited

Truncate base64-containing htmlcode for HTML display, such as errors page.

Parameters

string $htmlcode

Return values

string

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

admin/tool/brickfield/classes/local/tool/printable.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ base64_img_array()

◆ base64_img_detected()

◆ build_all_accessibilitytools()

◆ can_access()

◆ data_error()

◆ data_is_valid()

◆ fetch_data()

◆ get_check_description()

◆ get_data()

◆ get_error_message()

◆ get_filter()

◆ get_instance_name()

◆ get_module_label()

◆ get_output()

◆ get_output_target()

◆ get_tool_classnames()

◆ get_tool_names()

◆ get_toolname()

◆ get_toolshortname()

◆ perpage_limits()

◆ pluginname()

◆ set_filter()

◆ toolname()

◆ toolshortname()

◆ toplevel_arguments()

◆ truncate_base64()