Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_moodlenet\external Class Reference

This is the external API for this component. More...

Inheritance diagram for tool_moodlenet\external:

Static Public Member Functions

static search_courses (string $searchvalue)
 For some given input find and return any course that matches it.
 
static search_courses_parameters ()
 search_courses_parameters
 
static search_courses_returns ()
 search_courses_returns.
 
static verify_webfinger (string $profileurl, int $course, int $section)
 Figure out if the passed content resolves with a WebFinger account.
 
static verify_webfinger_parameters ()
 verify_webfinger parameters
 
static verify_webfinger_returns ()
 verify_webfinger return.
 

Detailed Description

This is the external API for this component.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ search_courses()

static tool_moodlenet\external::search_courses ( string $searchvalue)
static

For some given input find and return any course that matches it.

Parameters
string$searchvalueThe profile url that the user states exists
Return values
arrayContains the result set of courses for the value

◆ search_courses_parameters()

static tool_moodlenet\external::search_courses_parameters ( )
static

search_courses_parameters

Return values
external_function_parameters

◆ search_courses_returns()

static tool_moodlenet\external::search_courses_returns ( )
static

search_courses_returns.

Return values
external_description

◆ verify_webfinger()

static tool_moodlenet\external::verify_webfinger ( string $profileurl,
int $course,
int $section )
static

Figure out if the passed content resolves with a WebFinger account.

Parameters
string$profileurlThe profile url that the user states exists
int$courseThe course we are adding to
int$sectionThe section within the course we are adding to
Return values
arrayContains the result and domain if any
Exceptions
invalid_parameter_exception

◆ verify_webfinger_parameters()

static tool_moodlenet\external::verify_webfinger_parameters ( )
static

verify_webfinger parameters

Return values
external_function_parameters

◆ verify_webfinger_returns()

static tool_moodlenet\external::verify_webfinger_returns ( )
static

verify_webfinger return.

Return values
external_description

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