Auth external functions.
More...
Auth external functions.
- Copyright
- 2016 Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- Since
- Moodle 3.2
◆ confirm_user()
static core_auth_external::confirm_user |
( |
| $username, |
|
|
| $secret ) |
|
static |
Confirm a user account.
- Parameters
-
string | $username | user name |
string | $secret | confirmation secret (random string) used for validating the confirm request |
- Return values
-
array | warnings and success status (true if the user was confirmed, false if he was already confirmed) |
- Since
- Moodle 3.2
- Exceptions
-
◆ confirm_user_parameters()
static core_auth_external::confirm_user_parameters |
( |
| ) |
|
|
static |
Describes the parameters for confirm_user.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.2
◆ confirm_user_returns()
static core_auth_external::confirm_user_returns |
( |
| ) |
|
|
static |
Describes the confirm_user return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.2
◆ is_age_digital_consent_verification_enabled()
static core_auth_external::is_age_digital_consent_verification_enabled |
( |
| ) |
|
|
static |
Checks if age digital consent verification is enabled.
- Return values
-
array | status (true if digital consent verification is enabled, false otherwise.) |
- Since
- Moodle 3.3
- Exceptions
-
◆ is_age_digital_consent_verification_enabled_parameters()
static core_auth_external::is_age_digital_consent_verification_enabled_parameters |
( |
| ) |
|
|
static |
Describes the parameters for is_age_digital_consent_verification_enabled.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.3
◆ is_age_digital_consent_verification_enabled_returns()
static core_auth_external::is_age_digital_consent_verification_enabled_returns |
( |
| ) |
|
|
static |
Describes the is_age_digital_consent_verification_enabled return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.3
◆ is_minor()
static core_auth_external::is_minor |
( |
| $age, |
|
|
| $country ) |
|
static |
Requests a check if a user is digital minor.
- Parameters
-
int | $age | User age |
string | $country | Country of residence |
- Return values
-
array | status (true if the user is a minor, false otherwise) |
- Since
- Moodle 3.4
- Exceptions
-
◆ is_minor_parameters()
static core_auth_external::is_minor_parameters |
( |
| ) |
|
|
static |
Describes the parameters for the digital minor check.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.4
◆ is_minor_returns()
static core_auth_external::is_minor_returns |
( |
| ) |
|
|
static |
Describes the is_minor return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.4
◆ request_password_reset()
static core_auth_external::request_password_reset |
( |
| $username = '', |
|
|
| $email = '' ) |
|
static |
Requests a password reset.
- Parameters
-
string | $username | user name |
string | $email | user email |
- Return values
-
array | warnings and success status (including notices and errors while processing) |
- Since
- Moodle 3.4
- Exceptions
-
◆ request_password_reset_parameters()
static core_auth_external::request_password_reset_parameters |
( |
| ) |
|
|
static |
Describes the parameters for request_password_reset.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.4
◆ request_password_reset_returns()
static core_auth_external::request_password_reset_returns |
( |
| ) |
|
|
static |
Describes the request_password_reset return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.4
◆ resend_confirmation_email()
static core_auth_external::resend_confirmation_email |
( |
| $username, |
|
|
| $password, |
|
|
| $redirect = '' ) |
|
static |
Requests resend the confirmation email.
- Parameters
-
string | $username | user name |
string | $password | plain text password |
string | $redirect | redirect the user to this site url after confirmation |
- Return values
-
array | warnings and success status |
- Since
- Moodle 3.6
- Exceptions
-
◆ resend_confirmation_email_parameters()
static core_auth_external::resend_confirmation_email_parameters |
( |
| ) |
|
|
static |
Describes the parameters for resend_confirmation_email.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.6
◆ resend_confirmation_email_returns()
static core_auth_external::resend_confirmation_email_returns |
( |
| ) |
|
|
static |
Describes the resend_confirmation_email return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.6
The documentation for this class was generated from the following file:
- auth/classes/external.php