Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Raw event strategy retrieval interface.

Copyright: 2017 Cameron Ball <cameron@cameron1729.xyz>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 63 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

raw_event_retrieval_strategy_interface:: (1 method):
  get_raw_events()


Interface: raw_event_retrieval_strategy_interface  - X-Ref

Interface for an raw event retrival strategy class.

get_raw_events(array $usersfilter = null,array $groupsfilter = null,array $coursesfilter = null,array $categoriesfilter = null,array $whereconditions = null,array $whereparams = null,$ordersql = null,$offset = null,$limitnum = 40,$ignorehidden = true)   X-Ref
Retrieve raw calendar event records from the DB.

param: array|null    $usersfilter     Array of users to retrieve events for.
param: array|null    $groupsfilter    Array of groups to retrieve events for.
param: array|null    $coursesfilter   Array of courses to retrieve events for.
param: array|null    $categoriesfilter Array of categories to retrieve events for.
param: array|null    $whereconditions Array of where conditions to restrict results.
param: array|null    $whereparams     Array of parameters for $whereconditions.
param: string|null   $ordersql        SQL to order results.
param: int|null      $offset          Amount to offset results by.
param: int           $limitnum        Return at most this many results.
param: bool          $ignorehidden    True to ignore hidden events. False to include them.
return: \stdClass[] Array of event records.