| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
namespace tool_brickfield\local\htmlchecker\reporters;
|
|
|
18 |
|
|
|
19 |
use tool_brickfield\local\htmlchecker\brickfield_accessibility;
|
|
|
20 |
|
|
|
21 |
/**
|
|
|
22 |
* Returns a formatted HTML view of the problems
|
|
|
23 |
*
|
|
|
24 |
* @package tool_brickfield
|
|
|
25 |
* @copyright 2020 onward: Brickfield Education Labs, www.brickfield.ie
|
|
|
26 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
27 |
*/
|
|
|
28 |
class report_codehighlight extends \tool_brickfield\local\htmlchecker\brickfield_accessibility_reporter {
|
|
|
29 |
|
|
|
30 |
/**
|
|
|
31 |
* @var array An array of the classnames to be associated with items
|
|
|
32 |
*/
|
|
|
33 |
public $classnames = [brickfield_accessibility::BA_TEST_SEVERE => 'testlevel_severe',
|
|
|
34 |
brickfield_accessibility::BA_TEST_MODERATE => 'testlevel_moderate',
|
|
|
35 |
brickfield_accessibility::BA_TEST_SUGGESTION => 'testlevel_suggestion',
|
|
|
36 |
];
|
|
|
37 |
|
|
|
38 |
/**
|
|
|
39 |
* The getReport method - we iterate through every test item and
|
|
|
40 |
* add additional attributes to build the report UI.
|
|
|
41 |
* @return string A fully-formed HTML document.
|
|
|
42 |
*/
|
|
|
43 |
public function get_report(): string {
|
|
|
44 |
$problems = $this->guideline->get_report();
|
|
|
45 |
if (is_array($problems)) {
|
|
|
46 |
foreach ($problems as $testname => $test) {
|
|
|
47 |
if (!isset($this->options->display_level) ||
|
|
|
48 |
($this->options->display_level >= $test['severity'] && is_array($test))) {
|
|
|
49 |
foreach ($test as $problem) {
|
|
|
50 |
if (is_object($problem)
|
|
|
51 |
&& property_exists($problem, 'element')
|
|
|
52 |
&& is_object($problem->element)) {
|
|
|
53 |
// Wrap each error with a "wrapper" node who's tag name is the severity
|
|
|
54 |
// level class. We'll fix this later and change them back to 'span' elements
|
|
|
55 |
// after we have converted the HTML code to entities.
|
|
|
56 |
$severitywrapper = $this->dom->createElement($this->classnames[$test['severity']]);
|
|
|
57 |
$severitywrapper->setAttribute('class', $this->classnames[$test['severity']] .' '. $testname);
|
|
|
58 |
$severitywrapper->setAttribute('test', $testname);
|
|
|
59 |
$severitywrapper->appendChild($problem->element->cloneNode(true));
|
|
|
60 |
$parent = $problem->element->parentNode;
|
|
|
61 |
if (is_object($parent)) {
|
|
|
62 |
$parent->replaceChild($severitywrapper, $problem->element);
|
|
|
63 |
}
|
|
|
64 |
}
|
|
|
65 |
}
|
|
|
66 |
}
|
|
|
67 |
}
|
|
|
68 |
}
|
|
|
69 |
$this->dom->formatOutput = true;
|
|
|
70 |
$html = htmlspecialchars($this->dom->saveHTML(), ENT_COMPAT);
|
|
|
71 |
$html = str_replace('"', '"', $html);
|
|
|
72 |
foreach ($this->classnames as $name) {
|
|
|
73 |
$html = preg_replace('/<'. $name .'([^&]+)+\>/', '<span \\1>', $html);
|
|
|
74 |
$html = str_replace('</'. $name .'>', '</span>', $html);
|
|
|
75 |
}
|
|
|
76 |
return $html;
|
|
|
77 |
}
|
|
|
78 |
}
|