[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   * Alt text for all img elements used as source anchors is not empty when there is no other text in the anchor.
  25   * img element cannot have alt attribute value of null or whitespace if the img element is contained by an
  26   * a element and there is no other link text.
  27   *
  28   * @package    tool_brickfield
  29   * @copyright  2020 onward: Brickfield Education Labs, www.brickfield.ie
  30   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class img_alt_not_empty_in_anchor extends brickfield_accessibility_test {
  33  
  34      /** @var int The default severity code for this test. */
  35      public $defaultseverity = \tool_brickfield\local\htmlchecker\brickfield_accessibility::BA_TEST_SEVERE;
  36  
  37      /**
  38       * The main check function. This is called by the parent class to actually check content
  39       */
  40      public function check(): void {
  41          foreach ($this->get_all_elements('a') as $a) {
  42              if (!$a->nodeValue && $a->childNodes) {
  43                  foreach ($a->childNodes as $child) {
  44                      if ($this->property_is_equal($child, 'tagName', 'img')
  45                          && trim($child->getAttribute('alt')) == '') {
  46                          $this->add_report($child);
  47                      }
  48                  }
  49              }
  50          }
  51      }
  52  }