| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Authentication Plugin: Email Authentication
| Author: | Martin Dougiamas |
| License: | http://www.gnu.org/copyleft/gpl.html GNU Public License |
| File Size: | 257 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 1 file auth/email/config.html |
auth_plugin_email:: (17 methods):
__construct()
auth_plugin_email()
user_login()
user_update_password()
can_signup()
user_signup()
can_confirm()
user_confirm()
prevent_local_passwords()
is_internal()
can_change_password()
change_password_url()
can_reset_password()
can_be_manually_set()
config_form()
process_config()
is_captcha_enabled()
Class: auth_plugin_email - X-Ref
Email authentication plugin.| __construct() X-Ref |
| Constructor. |
| auth_plugin_email() X-Ref |
| Old syntax of class constructor. Deprecated in PHP7. |
| user_login($username, $password) X-Ref |
| Returns true if the username and password work and false if they are wrong or don't exist. param: string $username The username param: string $password The password return: bool Authentication success or failure. |
| user_update_password($user, $newpassword) X-Ref |
| Updates the user's password. called when the user password is updated. param: object $user User table object (with system magic quotes) param: string $newpassword Plaintext password (with system magic quotes) return: boolean result |
| can_signup() X-Ref |
| No description |
| user_signup($user, $notify=true) X-Ref |
| Sign up a new user ready for confirmation. Password is passed in plaintext. param: object $user new user object param: boolean $notify print notice with link and terminate |
| can_confirm() X-Ref |
| Returns true if plugin allows confirming of new users. return: bool |
| user_confirm($username, $confirmsecret) X-Ref |
| Confirm the new user as registered. param: string $username param: string $confirmsecret |
| prevent_local_passwords() X-Ref |
| No description |
| is_internal() X-Ref |
| Returns true if this authentication plugin is 'internal'. return: bool |
| can_change_password() X-Ref |
| Returns true if this authentication plugin can change the user's password. return: bool |
| change_password_url() X-Ref |
| Returns the URL for changing the user's pw, or empty if the default can be used. return: moodle_url |
| can_reset_password() X-Ref |
| Returns true if plugin allows resetting of internal password. return: bool |
| can_be_manually_set() X-Ref |
| Returns true if plugin can be manually set. return: bool |
| config_form($config, $err, $user_fields) X-Ref |
| Prints a form for configuring this authentication plugin. This function is called from admin/auth.php, and outputs a full page with a form for configuring this plugin. param: array $page An object containing all the data for this page. |
| process_config($config) X-Ref |
| Processes and stores configuration data for this authentication plugin. |
| is_captcha_enabled() X-Ref |
| Returns whether or not the captcha element is enabled. return: bool |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |