[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   * All embed elements have an associated noembed element that contains a text equivalent to the embed element.
  25   * Provide a text equivalent for the embed element.
  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 embed_has_associated_no_embed 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_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          foreach ($this->get_all_elements('embed') as $embed) {
  41              // If one of the child nodes is a 'noembed', then content is fine.
  42              foreach ($embed->childNodes as $child) {
  43                  if ($child->nodeName == 'noembed') {
  44                      return;
  45                  }
  46              }
  47              // There were no 'noembed' child nodes. If the next sibling isn't, then the content is flawed.
  48              if (!$this->property_is_equal($embed->nextSibling, 'tagName', 'noembed')) {
  49                  $this->add_report($embed);
  50              }
  51          }
  52      }
  53  }