[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_table_test;
  20  
  21  /**
  22   * Brickfield accessibility HTML checker library.
  23   *
  24   * All data tables contain th elements.
  25   * Data tables must have th elements while layout tables can not have th elements.
  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 table_data_should_have_th extends brickfield_accessibility_table_test {
  32  
  33      /** @var int The default severity code for this test. */
  34      public $defaultseverity = \tool_brickfield\local\htmlchecker\brickfield_accessibility::BA_TEST_SEVERE;
  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          // Remember: We only need to check the first tr in a table and only if there's a single th in there.
  41          foreach ($this->get_all_elements('table') as $table) {
  42              foreach ($table->childNodes as $child) {
  43                  if ($this->property_is_equal($child, 'tagName', 'tbody') || $this->property_is_equal($child, 'tagName', 'thead')) {
  44                      foreach ($child->childNodes as $tr) {
  45                          if (!is_null($tr->childNodes)) {
  46                              foreach ($tr->childNodes as $th) {
  47                                  if ($this->property_is_equal($th, 'tagName', 'th')) {
  48                                      break 3;
  49                                  } else {
  50                                      $this->add_report($table);
  51                                      break 3;
  52                                  }
  53                              }
  54                          }
  55                      }
  56                  } else if ($this->property_is_equal($child, 'tagName', 'tr')) {
  57                      foreach ($child->childNodes as $th) {
  58                          if ($this->property_is_equal($th, 'tagName', 'th')) {
  59                              break 2;
  60                          } else {
  61                              $this->add_report($table);
  62                              break 2;
  63                          }
  64                      }
  65                  }
  66              }
  67          }
  68      }
  69  }