moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 00:46:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-57503 calendar: add api function for action events by courses

Browse source 
Add get_action_events_by_courses to calendar api.

Part of MDL-55611 epic.
This commit is contained in:
Ryan Wyllie 2017-02-28 03:16:34 +00:00 • committed by Damyon Wiese
parent 39e7bbaec4
commit 8a082024e7
2 changed files with 69 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

34
calendar/classes/api.php
View file

@ -2375,4 +2375,38 @@ class api {
return $mapper->from_event_to_legacy_event($event);
}, $events);
}
/**
* Get a list of action events for the logged in user by the given
* courses and timesort values.
*
* The limit number applies per course, not for the result set as a whole.
* E.g. Requesting 3 courses with a limit of 10 will result in up to 30
* events being returned (up to 10 per course).
*
* @param array $courses The courses the events must belong to
* @param int|null $timesortfrom The start timesort value (inclusive)
* @param int|null $timesortto The end timesort value (inclusive)
* @param int $limitnum Limit results per course to this amount (between 1 and 50)
* @return array A list of event objects indexed by course id
*/
public static function get_action_events_by_courses(
$courses = [],
$timesortfrom = null,
$timesortto = null,
$limitnum = 20
) {
$return = [];
$mapper = \core_calendar\local\event\core_container::get_event_mapper();
$eventsbycourses = local_api::get_action_events_by_courses(
$courses, $timesortfrom, $timesortto, $limitnum);
foreach (array_keys($eventsbycourses) as $courseid) {
$return[$courseid] = array_map(function($event) use ($mapper) {
return $mapper->from_event_to_legacy_event($event);
}, $eventsbycourses[$courseid]);
}
return $return;
}
}

35
calendar/classes/local/api.php
View file

@ -108,4 +108,39 @@ class api {
return $vault->get_action_events_by_course(
$USER, $course, $timesortfrom, $timesortto, $afterevent, $limitnum);
}
/**
* Get a list of action events for the logged in user by the given
* courses and timesort values.
*
* The limit number applies per course, not for the result set as a whole.
* E.g. Requesting 3 courses with a limit of 10 will result in up to 30
* events being returned (up to 10 per course).
*
* @param array $courses The courses the events must belong to
* @param int|null $timesortfrom The start timesort value (inclusive)
* @param int|null $timesortto The end timesort value (inclusive)
* @param int $limitnum Limit results per course to this amount (between 1 and 50)
* @return array A list of action_event_interface objects indexed by course id
*/
public static function get_action_events_by_courses(
$courses = [],
$timesortfrom = null,
$timesortto = null,
$limitnum = 20
) {
$return = [];
foreach ($courses as $course) {
$return[$course->id] = self::get_action_events_by_course(
$course,
$timesortfrom,
$timesortto,
null,
$limitnum
);
}
return $return;
}
}