Interface for an raw event retrival strategy class. More...

Inheritance diagram for core_calendar\local\event\strategies\raw_event_retrieval_strategy_interface:

Public Member Functions
	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)
	Retrieve raw calendar event records from the DB. More...

Detailed Description

Interface for an raw event retrival strategy class.

Copyright: 2017 Cameron Ball camer.nosp@m.on@c.nosp@m.amero.nosp@m.n172.nosp@m.9.xyz

Member Function Documentation

core_calendar\local\event\strategies\raw_event_retrieval_strategy_interface::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`
	)

Retrieve raw calendar event records from the DB.

Parameters

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

Return values

stdClass[] Array of event records.

The documentation for this interface was generated from the following file: