[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   * Test counts words for all text elements on page and suggests content chunking for pages longer than 3000 words.
  25   *
  26   * @package    tool_brickfield
  27   * @copyright  2020 onward: Brickfield Education Labs, www.brickfield.ie
  28   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  class content_too_long extends brickfield_accessibility_test {
  31  
  32      /** @var int The default severity code for this test. */
  33      public $defaultseverity = \tool_brickfield\local\htmlchecker\brickfield_accessibility::BA_TEST_SUGGESTION;
  34  
  35      /**
  36       * The main check function. This is called by the parent class to actually check content.
  37       */
  38      public function check(): void {
  39          global $contentlengthlimit;
  40  
  41          $contentlengthlimit = 500;
  42          $pagetext = '';
  43          // There will be only one, but array is returned anyway.
  44          foreach ($this->get_all_elements('body') as $element) {
  45              $text = $element->textContent;
  46              if ($text != null) {
  47                  $pagetext = $pagetext . $text;
  48              }
  49          }
  50  
  51          $wordcount = count_words($pagetext);
  52          if ($wordcount > $contentlengthlimit) {
  53              $this->add_report(null, "<p id='wc'>Word Count: " . $wordcount . "</p>", false);
  54          }
  55      }
  56  }