Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_brickfield

Namespaces

namespace  tool_brickfield
  
 
namespace  tool_brickfield\event
  
 
namespace  tool_brickfield\form
  
 
namespace  tool_brickfield\local\areas
  
 
namespace  tool_brickfield\local\areas\core_course
  
 
namespace  tool_brickfield\local\areas\core_question
  
 
namespace  tool_brickfield\local\areas\mod_assign
  
 
namespace  tool_brickfield\local\areas\mod_book
  
 
namespace  tool_brickfield\local\areas\mod_chat
  
 
namespace  tool_brickfield\local\areas\mod_choice
  
 
namespace  tool_brickfield\local\areas\mod_data
  
 
namespace  tool_brickfield\local\areas\mod_feedback
 
namespace  tool_brickfield\local\areas\mod_folder
  
 
namespace  tool_brickfield\local\areas\mod_forum
  
 
namespace  tool_brickfield\local\areas\mod_glossary
  
 
namespace  tool_brickfield\local\areas\mod_imscp
  
 
namespace  tool_brickfield\local\areas\mod_label
  
 
namespace  tool_brickfield\local\areas\mod_lesson
  
 
namespace  tool_brickfield\local\areas\mod_lti
  
 
namespace  tool_brickfield\local\areas\mod_page
  
 
namespace  tool_brickfield\local\areas\mod_quiz
  
 
namespace  tool_brickfield\local\areas\mod_resource
  
 
namespace  tool_brickfield\local\areas\mod_scorm
  
 
namespace  tool_brickfield\local\areas\mod_survey
  
 
namespace  tool_brickfield\local\areas\mod_url
  
 
namespace  tool_brickfield\local\areas\mod_wiki
  
 
namespace  tool_brickfield\local\areas\mod_workshop
  
 
namespace  tool_brickfield\local\htmlchecker
  
 
namespace  tool_brickfield\local\htmlchecker\common
  
 
namespace  tool_brickfield\local\htmlchecker\common\checks
  
 
namespace  tool_brickfield\local\htmlchecker\guidelines
  
 
namespace  tool_brickfield\local\htmlchecker\reporters
  
 
namespace  tool_brickfield\local\tool
  
 
namespace  tool_brickfield\output
  
 
namespace  tool_brickfield\output\activityresults
  
 
namespace  tool_brickfield\output\advanced
  
 
namespace  tool_brickfield\output\checktyperesults
  
 
namespace  tool_brickfield\output\errors
  
 
namespace  tool_brickfield\output\printable
  
 
namespace  tool_brickfield\privacy
  
 
namespace  tool_brickfield\task
  
 

Classes

class  tool_brickfield\accessibility
 
class  tool_brickfield\analysis
 
class  tool_brickfield\area_base
 
class  tool_brickfield\area_test_base
 
class  tool_brickfield\brickfieldconnect
 
class  tool_brickfield\event\analysis_requested
 
class  tool_brickfield\event\report_downloaded
 
class  tool_brickfield\event\report_viewed
 
class  tool_brickfield\eventobservers
 
class  tool_brickfield\form\registration_form
 Class registration_form. More...
 
class  tool_brickfield\local\areas\core_course\base
 
class  tool_brickfield\local\areas\core_course\category_base
 
class  tool_brickfield\local\areas\core_course\category_description
 
class  tool_brickfield\local\areas\core_course\category_name
 
class  tool_brickfield\local\areas\core_course\fullname
 
class  tool_brickfield\local\areas\core_course\sectionname
 
class  tool_brickfield\local\areas\core_course\sectionsummary
 
class  tool_brickfield\local\areas\core_course\shortname
 
class  tool_brickfield\local\areas\core_course\summary
 
class  tool_brickfield\local\areas\core_question\answerbase
 
class  tool_brickfield\local\areas\core_question\base
 
class  tool_brickfield\local\areas\core_question\generalfeedback
 
class  tool_brickfield\local\areas\core_question\questionanswers
 
class  tool_brickfield\local\areas\core_question\questionfeedback
 
class  tool_brickfield\local\areas\core_question\questionname
 
class  tool_brickfield\local\areas\core_question\questiontext
 
class  tool_brickfield\local\areas\mod_assign\intro
 
class  tool_brickfield\local\areas\mod_assign\name
 
class  tool_brickfield\local\areas\mod_book\base
 
class  tool_brickfield\local\areas\mod_book\chaptercontent
 
class  tool_brickfield\local\areas\mod_book\chaptertitle
 
class  tool_brickfield\local\areas\mod_book\intro
 
class  tool_brickfield\local\areas\mod_book\name
 
class  tool_brickfield\local\areas\mod_chat\intro
 
class  tool_brickfield\local\areas\mod_chat\name
 
class  tool_brickfield\local\areas\mod_choice\intro
 
class  tool_brickfield\local\areas\mod_choice\name
 
class  tool_brickfield\local\areas\mod_choice\option
 
class  tool_brickfield\local\areas\mod_data\intro
 
class  tool_brickfield\local\areas\mod_data\name
 
class  tool_brickfield\local\areas\mod_feedback\intro
 
class  tool_brickfield\local\areas\mod_feedback\name
 
class  tool_brickfield\local\areas\mod_folder\intro
 
class  tool_brickfield\local\areas\mod_folder\name
 
class  tool_brickfield\local\areas\mod_forum\intro
 
class  tool_brickfield\local\areas\mod_forum\name
 
class  tool_brickfield\local\areas\mod_glossary\intro
 
class  tool_brickfield\local\areas\mod_glossary\name
 
class  tool_brickfield\local\areas\mod_imscp\intro
 
class  tool_brickfield\local\areas\mod_imscp\name
 
class  tool_brickfield\local\areas\mod_label\intro
 
class  tool_brickfield\local\areas\mod_lesson\answer_answer
 
class  tool_brickfield\local\areas\mod_lesson\answer_base
 
class  tool_brickfield\local\areas\mod_lesson\answer_response
 
class  tool_brickfield\local\areas\mod_lesson\base
 
class  tool_brickfield\local\areas\mod_lesson\intro
 
class  tool_brickfield\local\areas\mod_lesson\name
 
class  tool_brickfield\local\areas\mod_lesson\page_base
 
class  tool_brickfield\local\areas\mod_lesson\pagecontent
 
class  tool_brickfield\local\areas\mod_lesson\pagetitle
 
class  tool_brickfield\local\areas\mod_lti\intro
 
class  tool_brickfield\local\areas\mod_lti\name
 
class  tool_brickfield\local\areas\mod_page\content
 
class  tool_brickfield\local\areas\mod_page\intro
 
class  tool_brickfield\local\areas\mod_page\name
 
class  tool_brickfield\local\areas\mod_quiz\intro
 
class  tool_brickfield\local\areas\mod_quiz\name
 
class  tool_brickfield\local\areas\mod_resource\intro
 
class  tool_brickfield\local\areas\mod_resource\name
 
class  tool_brickfield\local\areas\mod_scorm\intro
 
class  tool_brickfield\local\areas\mod_scorm\name
 
class  tool_brickfield\local\areas\mod_survey\intro
 
class  tool_brickfield\local\areas\mod_survey\name
 
class  tool_brickfield\local\areas\mod_url\intro
 
class  tool_brickfield\local\areas\mod_url\name
 
class  tool_brickfield\local\areas\mod_wiki\intro
 
class  tool_brickfield\local\areas\mod_wiki\name
 
class  tool_brickfield\local\areas\mod_workshop\intro
 
class  tool_brickfield\local\areas\mod_workshop\name
 
class  tool_brickfield\local\areas\module_area_base
 
class  tool_brickfield\local\htmlchecker\brickfield_accessibility
 
class  tool_brickfield\local\htmlchecker\brickfield_accessibility_guideline
 
class  tool_brickfield\local\htmlchecker\brickfield_accessibility_report_item
 
class  tool_brickfield\local\htmlchecker\brickfield_accessibility_reporter
 
class  tool_brickfield\local\htmlchecker\common\body_color_contrast
 
class  tool_brickfield\local\htmlchecker\common\body_wai_ert_color_contrast
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_color_test
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_css
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_dom_element
 An older attempt at using dom element extensions to introducefinding the styling of an element. More...
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_header_test
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_table_test
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_tag_test
 
class  tool_brickfield\local\htmlchecker\common\brickfield_accessibility_test
 
class  tool_brickfield\local\htmlchecker\common\checks\a_links_dont_open_new_window
 
class  tool_brickfield\local\htmlchecker\common\checks\a_must_contain_text
 
class  tool_brickfield\local\htmlchecker\common\checks\a_suspicious_link_text
 
class  tool_brickfield\local\htmlchecker\common\checks\all_checks
 
class  tool_brickfield\local\htmlchecker\common\checks\area_dont_open_new_window
 
class  tool_brickfield\local\htmlchecker\common\checks\area_has_alt_value
 
class  tool_brickfield\local\htmlchecker\common\checks\basefont_is_not_used
 
class  tool_brickfield\local\htmlchecker\common\checks\blink_is_not_used
 
class  tool_brickfield\local\htmlchecker\common\checks\bold_is_not_used
 
class  tool_brickfield\local\htmlchecker\common\checks\content_too_long
 
class  tool_brickfield\local\htmlchecker\common\checks\css_text_has_contrast
 
class  tool_brickfield\local\htmlchecker\common\checks\embed_has_associated_no_embed
 
class  tool_brickfield\local\htmlchecker\common\checks\header_h3
 
class  tool_brickfield\local\htmlchecker\common\checks\headers_have_text
 
class  tool_brickfield\local\htmlchecker\common\checks\i_is_not_used
 
class  tool_brickfield\local\htmlchecker\common\checks\img_alt_is_different
 
class  tool_brickfield\local\htmlchecker\common\checks\img_alt_is_too_long
 
class  tool_brickfield\local\htmlchecker\common\checks\img_alt_not_empty_in_anchor
 
class  tool_brickfield\local\htmlchecker\common\checks\img_alt_not_place_holder
 
class  tool_brickfield\local\htmlchecker\common\checks\img_has_alt
 
class  tool_brickfield\local\htmlchecker\common\checks\img_with_map_has_use_map
 
class  tool_brickfield\local\htmlchecker\common\checks\legend_text_not_empty
 
class  tool_brickfield\local\htmlchecker\common\checks\marquee_is_not_used
 
class  tool_brickfield\local\htmlchecker\common\checks\marquee_is_not_used_test
 Class marquee_is_not_used_test. More...
 
class  tool_brickfield\local\htmlchecker\common\checks\no_headings
 
class  tool_brickfield\local\htmlchecker\common\checks\object_must_have_embed
 
class  tool_brickfield\local\htmlchecker\common\checks\object_must_have_title
 
class  tool_brickfield\local\htmlchecker\common\checks\object_must_have_valid_title
 
class  tool_brickfield\local\htmlchecker\common\checks\strike_is_not_used
 
class  tool_brickfield\local\htmlchecker\common\checks\table_data_should_have_th
 
class  tool_brickfield\local\htmlchecker\common\checks\table_summary_does_not_duplicate_caption
 
class  tool_brickfield\local\htmlchecker\common\checks\table_td_should_not_merge
 
class  tool_brickfield\local\htmlchecker\common\checks\table_th_should_have_scope
 
class  tool_brickfield\local\htmlchecker\common\html_elements
 
class  tool_brickfield\local\htmlchecker\common\input_has_label
 
class  tool_brickfield\local\htmlchecker\common\input_tab_index
 
class  tool_brickfield\local\htmlchecker\guidelines\brickfield_guideline
 
class  tool_brickfield\local\htmlchecker\guidelines\brickfield_textonly_guideline
 
class  tool_brickfield\local\htmlchecker\reporters\report_array
 
class  tool_brickfield\local\htmlchecker\reporters\report_codehighlight
 
class  tool_brickfield\local\htmlchecker\reporters\report_demo
 
class  tool_brickfield\local\htmlchecker\reporters\report_static
 
class  tool_brickfield\local\htmlchecker\reporters\report_xml
 
class  tool_brickfield\local\tool\activityresults
 
class  tool_brickfield\local\tool\advanced
 
class  tool_brickfield\local\tool\bfpdf
 tool_brickfield bfpdf More...
 
class  tool_brickfield\local\tool\checktyperesults
 
class  tool_brickfield\local\tool\errors
 
class  tool_brickfield\local\tool\filter
 
class  tool_brickfield\local\tool\printable
 
class  tool_brickfield\local\tool\tool
 
class  tool_brickfield\manager
 
class  tool_brickfield\mock_brickfieldconnect
 Mock brickfield connect. More...
 
class  tool_brickfield\mock_registration
 Mock registration. More...
 
class  tool_brickfield\output\activityresults\renderer
 
class  tool_brickfield\output\advanced\renderer
 
class  tool_brickfield\output\checktyperesults\renderer
 
class  tool_brickfield\output\errors\renderer
 
class  tool_brickfield\output\printable\renderer
 
class  tool_brickfield\output\renderer
 
class  tool_brickfield\privacy\provider
 
class  tool_brickfield\registration
 
class  tool_brickfield\scheduler
 
class  tool_brickfield\sitedata
 
class  tool_brickfield\task\bulk_process_caches
 
class  tool_brickfield\task\bulk_process_courses
 
class  tool_brickfield\task\checkid_validation
 
class  tool_brickfield\task\process_analysis_requests
 
class  tool_brickfield\task\update_summarydata
 

Functions

 tool_brickfield_extend_navigation_course (\navigation_node $navigation, stdClass $course, context $context)
 This function extends the navigation with the report items.
 
 tool_brickfield_get_fontawesome_icon_map ()
 Get icon mapping for font-awesome.
 
 xmldb_tool_brickfield_install ()
 Perform the post-install procedures.
 

Variables

 $accessibilitydisabled = !accessibility::is_accessibility_enabled()
 
 $capabilities
 
global tool_brickfield::$CFG
 
global tool_brickfield\form::$CFG
 
if($hassiteconfig) $moodleurl = accessibility::get_plugin_url()
 
 $observers
 
 $plugin = 2023041800
 
if($hassiteconfig) $showreports = has_capability('moodle/site:config', context_system::instance())
 
 $tasks
 
$plugin component = 'tool_brickfield'
 
$plugin version = 2023042400
 

Detailed Description

Function Documentation

◆ tool_brickfield_extend_navigation_course()

tool_brickfield_extend_navigation_course ( \navigation_node $navigation,
stdClass $course,
context $context )

This function extends the navigation with the report items.

Parameters
navigation_node$navigationThe navigation node to extend
stdClass$courseThe course to object for the report
context$contextThe context of the course
Exceptions
coding_exception
moodle_exception

◆ tool_brickfield_get_fontawesome_icon_map()

tool_brickfield_get_fontawesome_icon_map ( )

Get icon mapping for font-awesome.

Return values
string[]

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= [
'tool/brickfield:viewcoursetools' => [
'riskbitmask' => RISK_PERSONAL,
'captype' => 'read',
'contextlevel' => CONTEXT_COURSE,
'archetypes' => [
'teacher' => CAP_ALLOW,
'editingteacher' => CAP_ALLOW,
'manager' => CAP_ALLOW,
],
'clonepermissionsfrom' => 'coursereport/participation:view',
],
'tool/brickfield:viewsystemtools' => [
'riskbitmask' => RISK_CONFIG,
'captype' => 'read',
'contextlevel' => CONTEXT_SYSTEM,
'archetypes' => [
'manager' => CAP_ALLOW,
],
],
]
const CONTEXT_SYSTEM
System context level - only one instance in every system.
Definition accesslib.php:122
const RISK_CONFIG
Capability allows changes in system configuration - see
Definition accesslib.php:141
const CONTEXT_COURSE
Course context level - one instances for each course.
Definition accesslib.php:128
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition accesslib.php:115
const RISK_PERSONAL
Capability allows access to personal user information - see
Definition accesslib.php:145