[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 is not placeholder text unless author has confirmed it is correct.
  25   * 'img' element cannot have alt attribute value of "nbsp" or "spacer".
  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 img_alt_not_place_holder extends brickfield_accessibility_test {
  32      /** @var int The default severity code for this test. */
  33      public $defaultseverity = \tool_brickfield\local\htmlchecker\brickfield_accessibility::BA_TEST_SEVERE;
  34  
  35      /** @var \string[][] An array of strings, broken up by language domain. */
  36      public $strings =
  37          [
  38              'en' => array('nbsp', '&nbsp;', 'spacer', 'image', 'img', 'photo'),
  39              'es' => array('nbsp', '&nbsp;', 'spacer', 'espacio', 'imagen', 'img', 'foto'),
  40          ];
  41  
  42      /**
  43       * The main check function. This is called by the parent class to actually check content.
  44       */
  45      public function check(): void {
  46          foreach ($this->get_all_elements('img') as $img) {
  47              if ($img->hasAttribute('alt')) {
  48                  if (strlen($img->getAttribute('alt')) > 0) {
  49                      if (in_array($img->getAttribute('alt'), $this->translation())
  50                          || ord($img->getAttribute('alt')) == 194) {
  51                          $this->add_report($img);
  52                      } else if (preg_match("/^([0-9]*)(k|kb|mb|k bytes|k byte)?$/",
  53                          strtolower($img->getAttribute('alt')))) {
  54                          $this->add_report($img);
  55                      }
  56                  }
  57              }
  58          }
  59      }
  60  }