[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\checks;
  18  
  19  use tool_brickfield\local\htmlchecker\common\brickfield_accessibility_test;
  20  
  21  /**
  22   * Brickfield accessibility HTML checker library.
  23   *
  24   * Custom test.
  25   * Checks if content uses heading elements (h1 - h6) at all.
  26   *
  27   * @package    tool_brickfield
  28   * @copyright  2020 onward: Brickfield Education Labs, www.brickfield.ie
  29   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class no_headings extends brickfield_accessibility_test {
  32  
  33      /** @var int The default severity code for this test. */
  34      public $defaultseverity = \tool_brickfield\local\htmlchecker\brickfield_accessibility::BA_TEST_SUGGESTION;
  35  
  36      /**
  37       * The main check function. This is called by the parent class to actually check content
  38       */
  39      public function check(): void {
  40          global $doclength;
  41  
  42          $doclength = '1800';
  43          $elements = $this->get_all_elements('p');
  44          $documentstring = "";
  45  
  46          foreach ($elements as $element) {
  47              $documentstring .= $element->textContent;
  48          }
  49  
  50          if (strlen($documentstring) > $doclength) {
  51              if (!$this->get_all_elements('h1')
  52                  && !$this->get_all_elements('h2')
  53                  && !$this->get_all_elements('h3')
  54                  && !$this->get_all_elements('h4')
  55                  && !$this->get_all_elements('h5')
  56                  && !$this->get_all_elements('h6')) {
  57                  $noheadings = true;
  58              } else {
  59                  $noheadings = false;
  60              }
  61  
  62              if ($noheadings) {
  63                  $this->add_report(null, null, false);
  64              }
  65          }
  66      }
  67  }