auth_plugin_email Class Reference

Inheritance diagram for auth_plugin_email:

Collaboration diagram for auth_plugin_email:

Public Member Functions
	auth_plugin_email ()
	user_login ($username, $password)
	user_update_password ($user, $newpassword)
	can_signup ()
	user_signup ($user, $notify=true)
	can_confirm ()
	user_confirm ($username, $confirmsecret)
	prevent_local_passwords ()
	is_internal ()
	can_change_password ()
	change_password_url ()
	can_reset_password ()
	config_form ($config, $err, $user_fields)
	process_config ($config)
	is_captcha_enabled ()

---

Detailed Description

Email authentication plugin.

Definition at line 24 of file auth.php.

---

Member Function Documentation

auth_plugin_email

(

)

Constructor.

Definition at line 29 of file auth.php.

Here is the call graph for this function:

can_change_password

(

)

Returns true if this authentication plugin can change the user's password.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 162 of file auth.php.

can_confirm

(

)

Returns true if plugin allows confirming of new users.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 112 of file auth.php.

can_reset_password

(

)

Returns true if plugin allows resetting of internal password.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 181 of file auth.php.

can_signup

(

)

Returns true if plugin allows resetting of internal password.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 65 of file auth.php.

change_password_url

(

)

Returns the URL for changing the user's pw, or empty if the default can be used.

Returns:

moodle_url

Reimplemented from auth_plugin_base.

Definition at line 172 of file auth.php.

config_form	(	$	config,
		$	err,
		$	user_fields
	)

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.

Parameters:

array

$page

An object containing all the data for this page.

Reimplemented from auth_plugin_base.

Definition at line 193 of file auth.php.

is_captcha_enabled

(

)

Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 215 of file auth.php.

Here is the call graph for this function:

is_internal

(

)

Returns true if this authentication plugin is 'internal'.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 152 of file auth.php.

prevent_local_passwords

(

)

Indicates if password hashes should be stored in local moodle database.

Returns:

bool true means md5 password hash stored in user table, false means flag 'not_cached' stored there instead

Reimplemented from auth_plugin_base.

Definition at line 143 of file auth.php.

process_config

(

$

config

)

Processes and stores configuration data for this authentication plugin.

Reimplemented from auth_plugin_base.

Definition at line 200 of file auth.php.

Here is the call graph for this function:

user_confirm	(	$	username,
		$	confirmsecret
	)

Confirm the new user as registered.

Parameters:

string	$username
string	$confirmsecret

Reimplemented from auth_plugin_base.

Definition at line 122 of file auth.php.

Here is the call graph for this function:

user_login	(	$	username,
		$	password
	)

Returns true if the username and password work and false if they are wrong or don't exist.

Parameters:

string	$username	The username
string	$password	The password

Returns:

bool Authentication success or failure.

Reimplemented from auth_plugin_base.

Definition at line 42 of file auth.php.

Here is the call graph for this function:

user_signup	(	$	user,
		$	notify = true
	)

Sign up a new user ready for confirmation. Password is passed in plaintext.

Parameters:

object	$user	new user object
boolean	$notify	print notice with link and terminate

Save any custom profile field information

Reimplemented from auth_plugin_base.

Definition at line 76 of file auth.php.

Here is the call graph for this function:

user_update_password	(	$	user,
		$	newpassword
	)

Updates the user's password.

called when the user password is updated.

Parameters:

object	$user	User table object (with system magic quotes)
string	$newpassword	Plaintext password (with system magic quotes)

Returns:

boolean result

Reimplemented from auth_plugin_base.

Definition at line 60 of file auth.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/auth/email/auth.php