[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   * Raw event strategy retrieval interface.
  19   *
  20   * @package    core_calendar
  21   * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_calendar\local\event\strategies;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Interface for an raw event retrival strategy class.
  31   *
  32   * @copyright  2017 Cameron Ball <cameron@cameron1729.xyz>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  interface raw_event_retrieval_strategy_interface {
  36      /**
  37       * Retrieve raw calendar event records from the DB.
  38       *
  39       * @param array|null    $usersfilter     Array of users to retrieve events for.
  40       * @param array|null    $groupsfilter    Array of groups to retrieve events for.
  41       * @param array|null    $coursesfilter   Array of courses to retrieve events for.
  42       * @param array|null    $categoriesfilter Array of categories to retrieve events for.
  43       * @param array|null    $whereconditions Array of where conditions to restrict results.
  44       * @param array|null    $whereparams     Array of parameters for $whereconditions.
  45       * @param string|null   $ordersql        SQL to order results.
  46       * @param int|null      $offset          Amount to offset results by.
  47       * @param int           $limitnum        Return at most this many results.
  48       * @param bool          $ignorehidden    True to ignore hidden events. False to include them.
  49       * @return \stdClass[] Array of event records.
  50       */
  51      public function get_raw_events(
  52          array $usersfilter = null,
  53          array $groupsfilter = null,
  54          array $coursesfilter = null,
  55          array $categoriesfilter = null,
  56          array $whereconditions = null,
  57          array $whereparams = null,
  58          $ordersql = null,
  59          $offset = null,
  60          $limitnum = 40,
  61          $ignorehidden = true
  62      );
  63  }