Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/calendar/classes/external/ -> events_grouped_by_course_exporter.php (source)

[Source view]

Contains event class for displaying a list of calendar events grouped by course id.

Copyright: 2017 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 106 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

events_grouped_by_course_exporter:: (4 methods):
  __construct()
  define_other_properties()
  get_other_values()
  define_related()


Class: events_grouped_by_course_exporter  - X-Ref

Class for displaying a list of calendar events grouped by course id.

This class uses the events relateds cache in order to get the related
data for exporting an event without having to naively hit the database
for each event.

__construct(array $eventsbycourse, $related = [])   X-Ref
Constructor.

param: array $eventsbycourse An array of event_interface objects
param: array $related An array of related objects

define_other_properties()   X-Ref
Return the list of additional properties.

return: array

get_other_values(renderer_base $output)   X-Ref
Get the additional values to inject while exporting.

param: renderer_base $output The renderer.
return: array Keys are the property names, values are their values.

define_related()   X-Ref
Returns a list of objects that are related.

return: array