[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   * Each source anchor contains text.
  25   * a (anchor) element must contain text. The text may occur in the anchor text or in the title attribute of the anchor
  26   * or in the Alt text of an image used within the anchor.
  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 a_must_contain_text extends brickfield_accessibility_test {
  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('a') as $a) {
  41              if (!$this->element_contains_readable_text($a) && ($a->hasAttribute('href'))) {
  42                  $this->add_report($a);
  43              }
  44          }
  45      }
  46  
  47      /**
  48       * Returns if a link is not a candidate to be an anchor (which does
  49       * not need text).
  50       * @param \DOMElement $a
  51       * @return bool Whether is is a link (TRUE) or an anchor (FALSE)
  52       */
  53      public function is_not_anchor(\DOMElement $a): bool {
  54          return (!($a->hasAttribute('name') && !$a->hasAttribute('href')));
  55      }
  56  }