[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   * Clientside filter base.
  19   *
  20   * @package    tool_usertours
  21   * @copyright  2020 The Open University
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace tool_usertours\local\clientside_filter;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use stdClass;
  30  use tool_usertours\local\filter\base;
  31  use tool_usertours\tour;
  32  
  33  /**
  34   * Clientside filter base.
  35   *
  36   * @copyright  2020 The Open University
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  abstract class clientside_filter extends base {
  40      /**
  41       * Returns the filter values needed for client side filtering.
  42       *
  43       * @param   tour            $tour       The tour to find the filter values for
  44       * @return  stdClass
  45       */
  46      public static function get_client_side_values(tour $tour): stdClass {
  47          $data = (object) [];
  48  
  49          if (is_a(static::class, clientside_filter::class, true)) {
  50              $data->filterdata = $tour->get_filter_values(static::get_filter_name());
  51          }
  52  
  53          return $data;
  54      }
  55  }