Auth e-mail external functions.
More...
|
static | get_signup_settings () |
| Get the signup required settings and profile fields.
|
|
static | get_signup_settings_parameters () |
| Describes the parameters for get_signup_settings.
|
|
static | get_signup_settings_returns () |
| Describes the get_signup_settings return value.
|
|
static | signup_user ($username, $password, $firstname, $lastname, $email, $city='', $country='', $recaptchachallengehash='', $recaptcharesponse='', $customprofilefields=array(), $redirect='') |
| Get the signup required settings and profile fields.
|
|
static | signup_user_parameters () |
| Describes the parameters for signup_user.
|
|
static | signup_user_returns () |
| Describes the signup_user return value.
|
|
Auth e-mail 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
◆ check_signup_enabled()
static auth_email_external::check_signup_enabled |
( |
| ) |
|
|
staticprotected |
Check if registration is enabled in this site.
- Exceptions
-
- Since
- Moodle 3.2
◆ get_signup_settings()
static auth_email_external::get_signup_settings |
( |
| ) |
|
|
static |
Get the signup required settings and profile fields.
- Return values
-
array | settings and possible warnings |
- Since
- Moodle 3.2
- Exceptions
-
◆ get_signup_settings_parameters()
static auth_email_external::get_signup_settings_parameters |
( |
| ) |
|
|
static |
Describes the parameters for get_signup_settings.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.2
◆ get_signup_settings_returns()
static auth_email_external::get_signup_settings_returns |
( |
| ) |
|
|
static |
Describes the get_signup_settings return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.2
◆ signup_user()
static auth_email_external::signup_user |
( |
| $username, |
|
|
| $password, |
|
|
| $firstname, |
|
|
| $lastname, |
|
|
| $email, |
|
|
| $city = '', |
|
|
| $country = '', |
|
|
| $recaptchachallengehash = '', |
|
|
| $recaptcharesponse = '', |
|
|
| $customprofilefields = array(), |
|
|
| $redirect = '' ) |
|
static |
Get the signup required settings and profile fields.
- Parameters
-
string | $username | username |
string | $password | plain text password |
string | $firstname | the first name(s) of the user |
string | $lastname | the family name of the user |
string | $email | a valid and unique email address |
string | $city | home city of the user |
string | $country | home country code |
string | $recaptchachallengehash | recaptcha challenge hash |
string | $recaptcharesponse | recaptcha response |
array | $customprofilefields | user custom fields (also known as user profile fields) |
string | $redirect | Site url to redirect the user after confirmation |
- Return values
-
array | settings and possible warnings |
- Since
- Moodle 3.2
- Exceptions
-
◆ signup_user_parameters()
static auth_email_external::signup_user_parameters |
( |
| ) |
|
|
static |
Describes the parameters for signup_user.
- Return values
-
external_function_parameters | |
- Since
- Moodle 3.2
◆ signup_user_returns()
static auth_email_external::signup_user_returns |
( |
| ) |
|
|
static |
Describes the signup_user return value.
- Return values
-
external_single_structure | |
- Since
- Moodle 3.2
The documentation for this class was generated from the following file:
- auth/email/classes/external.php