[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   * 'object' must have a valid title.
  25   * 'object' element must not have a title attribute with value of null or whitespace.
  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 object_must_have_valid_title 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      /** @var \string[][] An array of strings, broken up by language domain. */
  37      public $strings =
  38          [
  39              'en' => ['nbsp', '&nbsp;', 'object', 'an object', 'spacer', 'image', 'img', 'photo', ' '],
  40              'es' => ['nbsp', '&nbsp;', 'objeto', 'un objeto', 'espacio', 'imagen', 'img', 'foto', ' '],
  41          ];
  42  
  43      /**
  44       * The main check function. This is called by the parent class to actually check content
  45       */
  46      public function check(): void {
  47          foreach ($this->get_all_elements('object') as $object) {
  48              if ($object->hasAttribute('title')) {
  49                  if (trim($object->getAttribute('title')) == '') {
  50                      $this->add_report($object);
  51                  } else if (!in_array(trim(strtolower($object->getAttribute('title'))), $this->translation())) {
  52                      $this->add_report($object);
  53                  }
  54              }
  55          }
  56      }
  57  }