[Summary view]

Differences Between: [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403]

   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_reporter;
  20  
  21  /**
  22   * An array reporter that simply returns an unformatted and nested PHP array of tests and report objects
  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_array extends brickfield_accessibility_reporter {
  29  
  30      /**
  31       * Generates a static list of errors within a div.
  32       * @return array|null A nested array of tests and problems with Report Item objects
  33       */
  34      public function get_report() {
  35          $results = $this->guideline->get_report();
  36          if (!is_array($results)) {
  37              return null;
  38          }
  39          foreach ($results as $testname => $test) {
  40              $translation = $this->guideline->get_translation($testname);
  41              $output[$testname]['severity'] = $this->guideline->get_severity($testname);
  42              $output[$testname]['title'] = $translation['title'];
  43              $output[$testname]['body'] = $translation['description'];
  44              foreach ($test as $k => $problem) {
  45                  if (is_object($problem)) {
  46                      $output[$testname]['problems'][$k]['element'] = htmlentities($problem->get_html());
  47                      $output[$testname]['problems'][$k]['line'] = $problem->get_line();
  48                      if ($problem->message) {
  49                          $output[$testname]['problems']['message'] = $problem->message;
  50                      }
  51                      $output[$testname]['problems']['pass'] = $problem->pass;
  52                  }
  53              }
  54          }
  55          return $output;
  56      }
  57  }