[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  /**
  18   * String filter.
  19   *
  20   * @package    core
  21   * @category   table
  22   * @copyright  2020 Simey Lameze <simey@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  declare(strict_types=1);
  27  
  28  namespace core_table\local\filter;
  29  
  30  use TypeError;
  31  
  32  /**
  33   * Class representing a string filter.
  34   *
  35   * @package    core
  36   * @copyright  2020 Simey Lameze <simey@moodle.com>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class string_filter extends filter {
  40      /**
  41       * Add a value to the filter.
  42       *
  43       * @param string $values
  44       * @return self
  45       */
  46      public function add_filter_value($value): parent {
  47          if (!is_string($value)) {
  48              $type = gettype($value);
  49              if ($type === 'object') {
  50                  $type = get_class($value);
  51              }
  52  
  53              throw new TypeError("The value supplied was of type '{$type}'. A string was expected.");
  54          }
  55  
  56          if (array_search($value, $this->filtervalues) !== false) {
  57              // Remove duplicates.
  58              return $this;
  59          }
  60  
  61          $this->filtervalues[] = $value;
  62  
  63          return $this;
  64      }
  65  }