Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/course/classes/external/ -> get_enrolled_courses_with_action_events_by_timeline_classification.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 220 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

get_enrolled_courses_with_action_events_by_timeline_classification:: (3 methods):
  execute_parameters()
  execute()
  execute_returns()


Class: get_enrolled_courses_with_action_events_by_timeline_classification  - X-Ref

Class for fetching courses which have action event(s) and match given filter parameters.

execute_parameters()   X-Ref
Returns the description of method parameters.

return: external_function_parameters

execute(string $classification,int $limit = 0,int $offset = 0,string $sort = null,string $customfieldname = null,string $customfieldvalue = null,string $searchvalue = null,int $eventsfrom = null,int $eventsto = null)   X-Ref
Get courses matching the given timeline classification which have action event(s).

Fetches courses by timeline classification which have at least one action event within the specified filtering.

param: string $classification past, inprogress, or future
param: int $limit Number of courses with events to attempt to fetch
param: int $offset Offset the full course set before timeline classification is applied
param: string $sort SQL sort string for results
param: string $customfieldname Custom field name used when when classification is customfield
param: string $customfieldvalue Custom field value used when when classification is customfield
param: string $searchvalue Text search being applied
param: int $eventsfrom The start timestamp (inclusive) to search from for action events in the course
param: int $eventsto The end timestamp (inclusive) to search to for action events in the course
return: array list of courses and any warnings

execute_returns()   X-Ref
Returns description of method result value.

return: external_description