Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
   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;
  18  
  19  /**
  20   * Helper function to support checking the varous color attributes of the <body> tag against WCAG standards
  21   *
  22   * @package    tool_brickfield
  23   * @copyright  2020 onward: Brickfield Education Labs, www.brickfield.ie
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  class body_color_contrast extends brickfield_accessibility_color_test {
  27      /** @var string The attribute to check for the background color of the <body> tag */
  28      public $background = 'bgcolor';
  29  
  30      /** @var string The attribute to check for the foreground color of the <body> tag */
  31      public $foreground = 'text';
  32  
  33      /**
  34       * Compares the WCAG contrast on the given color attributes of the <body> tag
  35       */
  36      public function check() {
  37          $body = $this->get_all_elements('body');
  38          if (!$body) {
  39              return false;
  40          }
  41          $body = $body[0];
  42          if ($body->hasAttribute($this->foreground) && $body->hasAttribute($this->background)) {
  43              if ($this->get_luminosity($body->getAttribute($this->foreground), $body->getAttribute($this->background)) < 5) {
  44                  $this->add_report(null, null, false);
  45              }
  46          }
  47      }
  48  }