Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/admin/tool/moodlenet/classes/ -> external.php (source)

[Source view]

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

This is the external API for this component.

Copyright: 2020 Mathew May {@link https://mathew.solutions}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 189 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 admin/tool/moodlenet/lib.php

Defines 1 class

external:: (6 methods):
  verify_webfinger_parameters()
  verify_webfinger()
  verify_webfinger_returns()
  search_courses_parameters()
  search_courses()
  search_courses_returns()


Class: external  - X-Ref

This is the external API for this component.

verify_webfinger_parameters()   X-Ref
verify_webfinger parameters

return: external_function_parameters

verify_webfinger(string $profileurl, int $course, int $section)   X-Ref
Figure out if the passed content resolves with a WebFinger account.

param: string $profileurl The profile url that the user states exists
param: int $course The course we are adding to
param: int $section The section within the course we are adding to
return: array Contains the result and domain if any

verify_webfinger_returns()   X-Ref
verify_webfinger return.

return: \external_description

search_courses_parameters()   X-Ref
search_courses_parameters

return: external_function_parameters

search_courses(string $searchvalue)   X-Ref
For some given input find and return any course that matches it.

param: string $searchvalue The profile url that the user states exists
return: array Contains the result set of courses for the value

search_courses_returns()   X-Ref
search_courses_returns.

return: \external_description