[Summary view]

Differences Between: [Versions 310 and 311] [Versions 39 and 311]

   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   * Participants table filterset.
  19   *
  20   * @package    core
  21   * @category   table
  22   * @copyright  2020 Andrew Nicols <andrew@nicols.co.uk>
  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_user\table;
  29  
  30  use core_table\local\filter\filterset;
  31  use core_table\local\filter\integer_filter;
  32  use core_table\local\filter\string_filter;
  33  
  34  /**
  35   * Participants table filterset.
  36   *
  37   * @package    core
  38   * @copyright  2020 Andrew Nicols <andrew@nicols.co.uk>
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class participants_filterset extends filterset {
  42      /**
  43       * Get the required filters.
  44       *
  45       * The only required filter is the courseid filter.
  46       *
  47       * @return array.
  48       */
  49      public function get_required_filters(): array {
  50          return [
  51              'courseid' => integer_filter::class,
  52          ];
  53      }
  54  
  55      /**
  56       * Get the optional filters.
  57       *
  58       * These are:
  59       * - accesssince;
  60       * - enrolments;
  61       * - groups;
  62       * - keywords;
  63       * - country;
  64       * - roles; and
  65       * - status.
  66       *
  67       * @return array
  68       */
  69      public function get_optional_filters(): array {
  70          return [
  71              'accesssince' => integer_filter::class,
  72              'enrolments' => integer_filter::class,
  73              'groups' => integer_filter::class,
  74              'keywords' => string_filter::class,
  75              'country' => string_filter::class,
  76              'roles' => integer_filter::class,
  77              'status' => integer_filter::class,
  78          ];
  79      }
  80  }