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.
/grade/classes/external/ -> get_enrolled_users_for_search_widget.php (source)

[Source view]

Differences Between: [Versions 401 and 402]

(no description)

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

Defines 1 class

get_enrolled_users_for_search_widget:: (5 methods):
  execute_parameters()
  execute()
  execute_returns()
  user_description()
  execute_is_deprecated()


Class: get_enrolled_users_for_search_widget  - X-Ref

Get the enrolled users within and map some fields to the returned array of user objects.

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

return: external_function_parameters

execute(int $courseid, string $actionbaseurl, ?int $groupid = 0)   X-Ref
Given a course ID find the enrolled users within and map some fields to the returned array of user objects.

param: int $courseid
param: string $actionbaseurl The base URL for the user option.
param: int|null $groupid
return: array Users and warnings to pass back to the calling widget.

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

return: external_single_structure

user_description()   X-Ref
Create user return value description.

return: external_description

execute_is_deprecated()   X-Ref
Mark the function as deprecated.

return: bool