Moodle 4.2 XRef and Diffs

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

events_cleanup() X-Ref

events_dequeue() X-Ref

report_insights_context_insights(\context $context) X-Ref

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

calendar_process_subscription_row($subscriptionid, $pollinterval, $action) X-Ref

Update a subscription from the form data in one of the rows in the existing subscriptions table.

param: int $subscriptionid The ID of the subscription we are acting upon.
param: int $pollinterval The poll interval to use.
param: int $action The action to be performed. One of update or remove.
return: string A log of the import progress, including errors

calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) X-Ref

Import events from an iCalendar object into a course calendar.

param: iCalendar $ical The iCalendar object.
param: int $unused Deprecated
param: int $subscriptionid The subscription ID.
return: string A log of the import progress, including errors.

grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) X-Ref

Print grading plugin selection tab-based navigation.

param: string  $active_type type of plugin on current page - import, export, report or edit
param: string  $active_plugin active plugin type - grader, user, cvs, ...
param: array   $plugin_info Array of plugins
param: boolean $return return as string
return: nothing or string if $return true

print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) X-Ref

Print grading plugin selection popup form.

param: array $plugin_info An array of plugins containing information for the selector
param: boolean $return return as string
return: nothing or string if $return true

course_purge_section_cache(object $sectioninfo) X-Ref

Purge the cache of a course section.

$sectioninfo must have following attributes:
- course: course id
- section: section number

param: object $sectioninfo section info
return: void

Purge the cache of a course module.

$cm must have following attributes:
- id: cmid
- course: course id

param: cm_info|stdClass $cm course module
return: void

get_array_of_activities(int $courseid, bool $usecache = false) X-Ref

For a given course, returns an array of course activity objects
Each item in the array contains he following properties:

param: int $courseid course id
param: bool $usecache get activities from cache if modinfo exists when $usecache is true
return: array list of activities

print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) X-Ref

Abort execution by throwing of a general exception,
default exception handler displays the error message in most cases.

param: string $errorcode The name of the language string containing the error message.
param: string $module The language file to get the error message from.
param: string $link The url where the user will be prompted to continue.
param: object $a Extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information
return: void, always throws exception!

cron_run(?int $keepalive = null) X-Ref

Execute cron tasks

param: int|null $keepalive The keepalive time for this cron run.

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

param: int $timenow The time this process started.

cron_run_adhoc_tasks(int $timenow, $keepalive = 0, $checklimits = true) X-Ref

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

param: int     $timenow The time this process started.
param: int     $keepalive Keep this function alive for N seconds and poll for new adhoc tasks.
param: bool    $checklimits Should we check limits?

cron_run_inner_scheduled_task(\core\task\task_base $task) X-Ref

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

param: \core\task\task_base $task

cron_run_inner_adhoc_task(\core\task\adhoc_task $task) X-Ref

Shared code that handles running of a single adhoc task within the cron.

param: \core\task\adhoc_task $task

cron_set_process_title(string $title) X-Ref

Sets the process title

This makes it very easy for a sysadmin to immediately see what task
a cron process is running at any given moment.

param: string $title process status title

Output some standard information during cron runs. Specifically current time
and memory usage. This method also does gc_collect_cycles() (before displaying
memory usage) to try to help PHP manage memory better.

cron_prepare_core_renderer($restore = false) X-Ref

Prepare the output renderer for the cron run.

This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing
any other.

param: bool $restore Whether to restore the original PAGE and OUTPUT

cron_setup_user($user = null, $course = null, $leavepagealone = false) X-Ref

Sets up current user and course environment (lang, etc.) in cron.
Do not use outside of cron script!

param: stdClass $user full user object, null means default cron user (admin),
param: stdClass $course full course record, null means $SITE
param: bool $leavepagealone If specified, stops it messing with global page object
return: void

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

events_cleanup() X-Ref

events_dequeue() X-Ref

report_insights_context_insights(\context $context) X-Ref

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

calendar_process_subscription_row($subscriptionid, $pollinterval, $action) X-Ref

Update a subscription from the form data in one of the rows in the existing subscriptions table.

param: int $subscriptionid The ID of the subscription we are acting upon.
param: int $pollinterval The poll interval to use.
param: int $action The action to be performed. One of update or remove.
return: string A log of the import progress, including errors

calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) X-Ref

Import events from an iCalendar object into a course calendar.

param: iCalendar $ical The iCalendar object.
param: int $unused Deprecated
param: int $subscriptionid The subscription ID.
return: string A log of the import progress, including errors.

grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) X-Ref

Print grading plugin selection tab-based navigation.

param: string  $active_type type of plugin on current page - import, export, report or edit
param: string  $active_plugin active plugin type - grader, user, cvs, ...
param: array   $plugin_info Array of plugins
param: boolean $return return as string
return: nothing or string if $return true

print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) X-Ref

Print grading plugin selection popup form.

param: array $plugin_info An array of plugins containing information for the selector
param: boolean $return return as string
return: nothing or string if $return true

course_purge_section_cache(object $sectioninfo) X-Ref

Purge the cache of a course section.

$sectioninfo must have following attributes:
- course: course id
- section: section number

param: object $sectioninfo section info
return: void

Purge the cache of a course module.

$cm must have following attributes:
- id: cmid
- course: course id

param: cm_info|stdClass $cm course module
return: void

get_array_of_activities(int $courseid, bool $usecache = false) X-Ref

For a given course, returns an array of course activity objects
Each item in the array contains he following properties:

param: int $courseid course id
param: bool $usecache get activities from cache if modinfo exists when $usecache is true
return: array list of activities

print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) X-Ref

Abort execution by throwing of a general exception,
default exception handler displays the error message in most cases.

param: string $errorcode The name of the language string containing the error message.
param: string $module The language file to get the error message from.
param: string $link The url where the user will be prompted to continue.
param: object $a Extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information
return: void, always throws exception!

cron_run(?int $keepalive = null) X-Ref

Execute cron tasks

param: int|null $keepalive The keepalive time for this cron run.

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

param: int $timenow The time this process started.

cron_run_adhoc_tasks(int $timenow, $keepalive = 0, $checklimits = true) X-Ref

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

param: int     $timenow The time this process started.
param: int     $keepalive Keep this function alive for N seconds and poll for new adhoc tasks.
param: bool    $checklimits Should we check limits?

cron_run_inner_scheduled_task(\core\task\task_base $task) X-Ref

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

param: \core\task\task_base $task

cron_run_inner_adhoc_task(\core\task\adhoc_task $task) X-Ref

Shared code that handles running of a single adhoc task within the cron.

param: \core\task\adhoc_task $task

cron_set_process_title(string $title) X-Ref

Sets the process title

This makes it very easy for a sysadmin to immediately see what task
a cron process is running at any given moment.

param: string $title process status title

Output some standard information during cron runs. Specifically current time
and memory usage. This method also does gc_collect_cycles() (before displaying
memory usage) to try to help PHP manage memory better.

cron_prepare_core_renderer($restore = false) X-Ref

Prepare the output renderer for the cron run.

This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing
any other.

param: bool $restore Whether to restore the original PAGE and OUTPUT

cron_setup_user($user = null, $course = null, $leavepagealone = false) X-Ref

Sets up current user and course environment (lang, etc.) in cron.
Do not use outside of cron script!

param: stdClass $user full user object, null means default cron user (admin),
param: stdClass $course full course record, null means $SITE
param: bool $leavepagealone If specified, stops it messing with global page object
return: void

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

events_cleanup() X-Ref

events_dequeue() X-Ref

report_insights_context_insights(\context $context) X-Ref

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

calendar_process_subscription_row($subscriptionid, $pollinterval, $action) X-Ref

Update a subscription from the form data in one of the rows in the existing subscriptions table.

param: int $subscriptionid The ID of the subscription we are acting upon.
param: int $pollinterval The poll interval to use.
param: int $action The action to be performed. One of update or remove.
return: string A log of the import progress, including errors

calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) X-Ref

Import events from an iCalendar object into a course calendar.

param: iCalendar $ical The iCalendar object.
param: int $unused Deprecated
param: int $subscriptionid The subscription ID.
return: string A log of the import progress, including errors.

grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) X-Ref

Print grading plugin selection tab-based navigation.

param: string  $active_type type of plugin on current page - import, export, report or edit
param: string  $active_plugin active plugin type - grader, user, cvs, ...
param: array   $plugin_info Array of plugins
param: boolean $return return as string
return: nothing or string if $return true

print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) X-Ref

Print grading plugin selection popup form.

param: array $plugin_info An array of plugins containing information for the selector
param: boolean $return return as string
return: nothing or string if $return true

course_purge_section_cache(object $sectioninfo) X-Ref

Purge the cache of a course section.

$sectioninfo must have following attributes:
- course: course id
- section: section number

param: object $sectioninfo section info
return: void

Purge the cache of a course module.

$cm must have following attributes:
- id: cmid
- course: course id

param: cm_info|stdClass $cm course module
return: void

get_array_of_activities(int $courseid, bool $usecache = false) X-Ref

For a given course, returns an array of course activity objects
Each item in the array contains he following properties:

param: int $courseid course id
param: bool $usecache get activities from cache if modinfo exists when $usecache is true
return: array list of activities

print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) X-Ref

Abort execution by throwing of a general exception,
default exception handler displays the error message in most cases.

param: string $errorcode The name of the language string containing the error message.
param: string $module The language file to get the error message from.
param: string $link The url where the user will be prompted to continue.
param: object $a Extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information
return: void, always throws exception!

cron_run(?int $keepalive = null) X-Ref

Execute cron tasks

param: int|null $keepalive The keepalive time for this cron run.

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

param: int $timenow The time this process started.

cron_run_adhoc_tasks(int $timenow, $keepalive = 0, $checklimits = true) X-Ref

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

param: int     $timenow The time this process started.
param: int     $keepalive Keep this function alive for N seconds and poll for new adhoc tasks.
param: bool    $checklimits Should we check limits?

cron_run_inner_scheduled_task(\core\task\task_base $task) X-Ref

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

param: \core\task\task_base $task

cron_run_inner_adhoc_task(\core\task\adhoc_task $task) X-Ref

Shared code that handles running of a single adhoc task within the cron.

param: \core\task\adhoc_task $task

cron_set_process_title(string $title) X-Ref

Sets the process title

This makes it very easy for a sysadmin to immediately see what task
a cron process is running at any given moment.

param: string $title process status title

Output some standard information during cron runs. Specifically current time
and memory usage. This method also does gc_collect_cycles() (before displaying
memory usage) to try to help PHP manage memory better.

cron_prepare_core_renderer($restore = false) X-Ref

Prepare the output renderer for the cron run.

This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing
any other.

param: bool $restore Whether to restore the original PAGE and OUTPUT

cron_setup_user($user = null, $course = null, $leavepagealone = false) X-Ref

Sets up current user and course environment (lang, etc.) in cron.
Do not use outside of cron script!

param: stdClass $user full user object, null means default cron user (admin),
param: stdClass $course full course record, null means $SITE
param: bool $leavepagealone If specified, stops it messing with global page object
return: void

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

events_cleanup() X-Ref

events_dequeue() X-Ref

report_insights_context_insights(\context $context) X-Ref

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

calendar_process_subscription_row($subscriptionid, $pollinterval, $action) X-Ref

Update a subscription from the form data in one of the rows in the existing subscriptions table.

param: int $subscriptionid The ID of the subscription we are acting upon.
param: int $pollinterval The poll interval to use.
param: int $action The action to be performed. One of update or remove.
return: string A log of the import progress, including errors

calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) X-Ref

Import events from an iCalendar object into a course calendar.

param: iCalendar $ical The iCalendar object.
param: int $unused Deprecated
param: int $subscriptionid The subscription ID.
return: string A log of the import progress, including errors.

grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) X-Ref

Print grading plugin selection tab-based navigation.

param: string  $active_type type of plugin on current page - import, export, report or edit
param: string  $active_plugin active plugin type - grader, user, cvs, ...
param: array   $plugin_info Array of plugins
param: boolean $return return as string
return: nothing or string if $return true

print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) X-Ref

Print grading plugin selection popup form.

param: array $plugin_info An array of plugins containing information for the selector
param: boolean $return return as string
return: nothing or string if $return true

course_purge_section_cache(object $sectioninfo) X-Ref

Purge the cache of a course section.

$sectioninfo must have following attributes:
- course: course id
- section: section number

param: object $sectioninfo section info
return: void

Purge the cache of a course module.

$cm must have following attributes:
- id: cmid
- course: course id

param: cm_info|stdClass $cm course module
return: void

get_array_of_activities(int $courseid, bool $usecache = false) X-Ref

For a given course, returns an array of course activity objects
Each item in the array contains he following properties:

param: int $courseid course id
param: bool $usecache get activities from cache if modinfo exists when $usecache is true
return: array list of activities

print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) X-Ref

Abort execution by throwing of a general exception,
default exception handler displays the error message in most cases.

param: string $errorcode The name of the language string containing the error message.
param: string $module The language file to get the error message from.
param: string $link The url where the user will be prompted to continue.
param: object $a Extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information
return: void, always throws exception!

cron_run(?int $keepalive = null) X-Ref

Execute cron tasks

param: int|null $keepalive The keepalive time for this cron run.

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

param: int $timenow The time this process started.

cron_run_adhoc_tasks(int $timenow, $keepalive = 0, $checklimits = true) X-Ref

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

param: int     $timenow The time this process started.
param: int     $keepalive Keep this function alive for N seconds and poll for new adhoc tasks.
param: bool    $checklimits Should we check limits?

cron_run_inner_scheduled_task(\core\task\task_base $task) X-Ref

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

param: \core\task\task_base $task

cron_run_inner_adhoc_task(\core\task\adhoc_task $task) X-Ref

Shared code that handles running of a single adhoc task within the cron.

param: \core\task\adhoc_task $task

cron_set_process_title(string $title) X-Ref

Sets the process title

This makes it very easy for a sysadmin to immediately see what task
a cron process is running at any given moment.

param: string $title process status title

Output some standard information during cron runs. Specifically current time
and memory usage. This method also does gc_collect_cycles() (before displaying
memory usage) to try to help PHP manage memory better.

cron_prepare_core_renderer($restore = false) X-Ref

Prepare the output renderer for the cron run.

This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing
any other.

param: bool $restore Whether to restore the original PAGE and OUTPUT

cron_setup_user($user = null, $course = null, $leavepagealone = false) X-Ref

Sets up current user and course environment (lang, etc.) in cron.
Do not use outside of cron script!

param: stdClass $user full user object, null means default cron user (admin),
param: stdClass $course full course record, null means $SITE
param: bool $leavepagealone If specified, stops it messing with global page object
return: void

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

events_cleanup() X-Ref

events_dequeue() X-Ref

report_insights_context_insights(\context $context) X-Ref

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

calendar_process_subscription_row($subscriptionid, $pollinterval, $action) X-Ref

Update a subscription from the form data in one of the rows in the existing subscriptions table.

param: int $subscriptionid The ID of the subscription we are acting upon.
param: int $pollinterval The poll interval to use.
param: int $action The action to be performed. One of update or remove.
return: string A log of the import progress, including errors

calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) X-Ref

Import events from an iCalendar object into a course calendar.

param: iCalendar $ical The iCalendar object.
param: int $unused Deprecated
param: int $subscriptionid The subscription ID.
return: string A log of the import progress, including errors.

grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) X-Ref

Print grading plugin selection tab-based navigation.

param: string  $active_type type of plugin on current page - import, export, report or edit
param: string  $active_plugin active plugin type - grader, user, cvs, ...
param: array   $plugin_info Array of plugins
param: boolean $return return as string
return: nothing or string if $return true

print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) X-Ref

Print grading plugin selection popup form.

param: array $plugin_info An array of plugins containing information for the selector
param: boolean $return return as string
return: nothing or string if $return true

course_purge_section_cache(object $sectioninfo) X-Ref

Purge the cache of a course section.

$sectioninfo must have following attributes:
- course: course id
- section: section number

param: object $sectioninfo section info
return: void

Purge the cache of a course module.

$cm must have following attributes:
- id: cmid
- course: course id

param: cm_info|stdClass $cm course module
return: void

get_array_of_activities(int $courseid, bool $usecache = false) X-Ref

For a given course, returns an array of course activity objects
Each item in the array contains he following properties:

param: int $courseid course id
param: bool $usecache get activities from cache if modinfo exists when $usecache is true
return: array list of activities

print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) X-Ref

Abort execution by throwing of a general exception,
default exception handler displays the error message in most cases.

param: string $errorcode The name of the language string containing the error message.
param: string $module The language file to get the error message from.
param: string $link The url where the user will be prompted to continue.
param: object $a Extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information
return: void, always throws exception!

cron_run(?int $keepalive = null) X-Ref

Execute cron tasks

param: int|null $keepalive The keepalive time for this cron run.

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

param: int $timenow The time this process started.

cron_run_adhoc_tasks(int $timenow, $keepalive = 0, $checklimits = true) X-Ref

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

param: int     $timenow The time this process started.
param: int     $keepalive Keep this function alive for N seconds and poll for new adhoc tasks.
param: bool    $checklimits Should we check limits?

cron_run_inner_scheduled_task(\core\task\task_base $task) X-Ref

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

param: \core\task\task_base $task

cron_run_inner_adhoc_task(\core\task\adhoc_task $task) X-Ref

Shared code that handles running of a single adhoc task within the cron.

param: \core\task\adhoc_task $task

cron_set_process_title(string $title) X-Ref

Sets the process title

This makes it very easy for a sysadmin to immediately see what task
a cron process is running at any given moment.

param: string $title process status title

Output some standard information during cron runs. Specifically current time
and memory usage. This method also does gc_collect_cycles() (before displaying
memory usage) to try to help PHP manage memory better.

cron_prepare_core_renderer($restore = false) X-Ref

Prepare the output renderer for the cron run.

This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing
any other.

param: bool $restore Whether to restore the original PAGE and OUTPUT

cron_setup_user($user = null, $course = null, $leavepagealone = false) X-Ref

Sets up current user and course environment (lang, etc.) in cron.
Do not use outside of cron script!

param: stdClass $user full user object, null means default cron user (admin),
param: stdClass $course full course record, null means $SITE
param: bool $leavepagealone If specified, stops it messing with global page object
return: void

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

events_cleanup() X-Ref

events_dequeue() X-Ref

report_insights_context_insights(\context $context) X-Ref

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid, $accesssince, $roleid, $enrolid, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

calendar_process_subscription_row($subscriptionid, $pollinterval, $action) X-Ref

Update a subscription from the form data in one of the rows in the existing subscriptions table.

param: int $subscriptionid The ID of the subscription we are acting upon.
param: int $pollinterval The poll interval to use.
param: int $action The action to be performed. One of update or remove.
return: string A log of the import progress, including errors

calendar_import_icalendar_events($ical, $unused = null, $subscriptionid = null) X-Ref

Import events from an iCalendar object into a course calendar.

param: iCalendar $ical The iCalendar object.
param: int $unused Deprecated
param: int $subscriptionid The subscription ID.
return: string A log of the import progress, including errors.

grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) X-Ref

Print grading plugin selection tab-based navigation.

param: string  $active_type type of plugin on current page - import, export, report or edit
param: string  $active_plugin active plugin type - grader, user, cvs, ...
param: array   $plugin_info Array of plugins
param: boolean $return return as string
return: nothing or string if $return true

print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) X-Ref

Print grading plugin selection popup form.

param: array $plugin_info An array of plugins containing information for the selector
param: boolean $return return as string
return: nothing or string if $return true

course_purge_section_cache(object $sectioninfo) X-Ref

Purge the cache of a course section.

$sectioninfo must have following attributes:
- course: course id
- section: section number

param: object $sectioninfo section info
return: void

Purge the cache of a course module.

$cm must have following attributes:
- id: cmid
- course: course id

param: cm_info|stdClass $cm course module
return: void

get_array_of_activities(int $courseid, bool $usecache = false) X-Ref

For a given course, returns an array of course activity objects
Each item in the array contains he following properties:

param: int $courseid course id
param: bool $usecache get activities from cache if modinfo exists when $usecache is true
return: array list of activities

print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) X-Ref

Abort execution by throwing of a general exception,
default exception handler displays the error message in most cases.

param: string $errorcode The name of the language string containing the error message.
param: string $module The language file to get the error message from.
param: string $link The url where the user will be prompted to continue.
param: object $a Extra words and phrases that might be required in the error string
param: string $debuginfo optional debugging information
return: void, always throws exception!

cron_run(?int $keepalive = null) X-Ref

Execute cron tasks

param: int|null $keepalive The keepalive time for this cron run.

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

param: int $timenow The time this process started.

cron_run_adhoc_tasks(int $timenow, $keepalive = 0, $checklimits = true) X-Ref

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

param: int     $timenow The time this process started.
param: int     $keepalive Keep this function alive for N seconds and poll for new adhoc tasks.
param: bool    $checklimits Should we check limits?

cron_run_inner_scheduled_task(\core\task\task_base $task) X-Ref

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

param: \core\task\task_base $task

cron_run_inner_adhoc_task(\core\task\adhoc_task $task) X-Ref

Shared code that handles running of a single adhoc task within the cron.

param: \core\task\adhoc_task $task

cron_set_process_title(string $title) X-Ref

Sets the process title

This makes it very easy for a sysadmin to immediately see what task
a cron process is running at any given moment.

param: string $title process status title