Inheritance diagram for core_course\external\get_enrolled_courses_with_action_events_by_timeline_classification:

Static Public Member Functions
static	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)
	Get courses matching the given timeline classification which have action event(s).

static	execute_parameters ()
	Returns the description of method parameters.

static	execute_returns ()
	Returns description of method result value.

Member Function Documentation

◆ execute()

static core_course\external\get_enrolled_courses_with_action_events_by_timeline_classification::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 )

static

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.

Parameters

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

Return values

array list of courses and any warnings

static core_course\external\get_enrolled_courses_with_action_events_by_timeline_classification::execute_parameters ( )

static

Returns the description of method parameters.

Return values

external_function_parameters

static core_course\external\get_enrolled_courses_with_action_events_by_timeline_classification::execute_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

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

course/classes/external/get_enrolled_courses_with_action_events_by_timeline_classification.php