Search moodle.org's
Developer Documentation
Developer Documentation
- 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.
/search/classes/ -> external.php (source)
Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]
Handles external (web service) function calls related to search.
| Copyright: | 2017 The Open University |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 123 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
external:: (3 methods):
get_relevant_users_parameters()
get_relevant_users_returns()
get_relevant_users()
Handles external (web service) function calls related to search.
| get_relevant_users_parameters() X-Ref |
| Returns parameter types for get_relevant_users function. return: external_function_parameters Parameters |
| get_relevant_users_returns() X-Ref |
| Returns result type for get_relevant_users function. return: external_description Result type |
| get_relevant_users($query, $courseid) X-Ref |
| Searches for users given a query, taking into account the current user's permissions and possibly a course to check within. param: string $query Query text param: int $courseid Course id or 0 if no restriction return: array Defined return structure |
