[Summary view]

Differences Between: [Versions 311 and 401] [Versions 400 and 401]

   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   *  Area should not open new window without warning.
  25   *  Area element, target attribute values must contain any one of (case insensitive) _self, _top, _parent.
  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 area_dont_open_new_window 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[]  A list of targets which are allowed. */
  36      public $allowedtargets = array('_self', '_parent', '_top');
  37  
  38      /**
  39       *   The main check function. This is called by the parent class to actually check content
  40       */
  41      public function check(): void {
  42          // Need to process all enabled lang versions of newwindowphrases.
  43          $text = brickfield_accessibility_test::get_all_newwindowphrases();
  44  
  45          foreach ($this->get_all_elements('area') as $area) {
  46              if ($area->hasAttribute('target') && !in_array($area->getAttribute('target'), $this->allowedtargets)) {
  47                  $phrasefound = false;
  48                  foreach ($text as $phrase) {
  49                      // Sanity check for readable text.
  50                      if (!brickfield_accessibility_test::is_text_readable($phrase)) {
  51                          break;
  52                      }
  53                      $pos = stripos($area->getAttribute('alt'), $phrase);
  54                      if ($pos !== false) {
  55                          $phrasefound = true;
  56                          break;
  57                      }
  58                  }
  59                  if (!$phrasefound) {
  60                      $this->add_report($area);
  61                  }
  62              }
  63          }
  64      }
  65  }