Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   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  /**
  18   * Tests for base_setting_ui class.
  19   *
  20   * @package   core_backup
  21   * @copyright 2021 Université Rennes 2 {@link https://www.univ-rennes2.fr}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  global $CFG;
  28  
  29  require_once($CFG->dirroot.'/backup/util/settings/tests/settings_test.php');
  30  
  31  /**
  32   * Tests for base_setting_ui class.
  33   *
  34   * @copyright 2021 Université Rennes 2 {@link https://www.univ-rennes2.fr}
  35   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class base_setting_ui_test extends advanced_testcase {
  38      /**
  39       * Tests set_label().
  40       *
  41       * @return void
  42       */
  43      public function test_set_label() {
  44          $this->resetAfterTest();
  45  
  46          $bs = new mock_base_setting('test', base_setting::IS_BOOLEAN);
  47          $bsui = new base_setting_ui($bs);
  48  
  49          // Should keep original text string.
  50          $bsui->set_label('Section name');
  51          $this->assertEquals('Section name', $bsui->get_label());
  52  
  53          // Should keep original HTML string.
  54          $bsui->set_label('<b>Section name</b>');
  55          $this->assertEquals('<b>Section name</b>', $bsui->get_label());
  56  
  57          // Should be converted to text string.
  58          $bsui->set_label(123);
  59          $this->assertSame('123', $bsui->get_label());
  60  
  61          // Should be converted to non-breaking space (U+00A0) when label is empty.
  62          $bsui->set_label('');
  63          $this->assertSame("\u{00A0}", $bsui->get_label());
  64  
  65          // Should be converted to non-breaking space (U+00A0) when the trimmed label is empty.
  66          $bsui->set_label("  \t\t\n\n\t\t  ");
  67          $this->assertSame("\u{00A0}", $bsui->get_label());
  68  
  69          // Should clean partially the wrong bits.
  70          $bsui->set_label('<b onmouseover=alert("test")>label</b>');
  71          $this->assertSame('<b>label</b>', $bsui->get_label());
  72  
  73          // Should raise an exception when cleaning ends with 100% empty.
  74          $this->expectException(base_setting_ui_exception::class);
  75          $this->expectExceptionMessage('error/setting_invalid_ui_label');
  76          $bsui->set_label('<script>alert("test")</script>');
  77      }
  78  }