[Summary view]

   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\common;
  18  
  19  /**
  20   * Special base test class that deals with tests concerning the logical heirarchy of headers.
  21   *
  22   * @package    tool_brickfield
  23   * @copyright  2020 onward: Brickfield Education Labs, www.brickfield.ie
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  class brickfield_accessibility_header_test extends brickfield_accessibility_test {
  27      /** @var string The header tag this test applies to. */
  28      public $tag = '';
  29  
  30      /** @var array An array of all the header tags */
  31      public $headers = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
  32  
  33      /**
  34       * The check method gathers all the headers together and walks through them, making sure that
  35       * the logical display of headers makes sense.
  36       */
  37      public function check() {
  38          $firstheader = $this->dom->getElementsByTagName($this->tag);
  39          if ($firstheader->item(0)) {
  40              $current = $firstheader->item(0);
  41              $previousnumber = intval(substr($current->tagName, -1, 1));
  42              while ($current) {
  43                  if (property_exists($current, 'tagName') && in_array($current->tagName, $this->headers)) {
  44                      $currentnumber = intval(substr($current->tagName, -1, 1));
  45                      if ($currentnumber > ($previousnumber + 1)) {
  46                          $this->add_report($current);
  47                      }
  48                      $previousnumber = intval(substr($current->tagName, -1, 1));
  49                  }
  50                  $current = $current->nextSibling;
  51              }
  52          }
  53      }
  54  }