auth_plugin_webservice Class Reference

Inheritance diagram for auth_plugin_webservice:

Collaboration diagram for auth_plugin_webservice:

Public Member Functions
	auth_plugin_webservice ()
	user_login ($username, $password)
	user_login_webservice ($username, $password)
	user_update_password ($user, $newpassword)
	is_internal ()
	can_change_password ()
	change_password_url ()
	can_reset_password ()
	config_form ($config, $err, $user_fields)
	process_config ($config)
	user_confirm ($username, $confirmsecret=null)

---

Detailed Description

Web service auth plugin.

Definition at line 37 of file auth.php.

---

Member Function Documentation

auth_plugin_webservice

(

)

Constructor.

Definition at line 42 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 106 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 125 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 116 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 137 of file auth.php.

is_internal

(

)

Returns true if this authentication plugin is 'internal'.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 96 of file auth.php.

process_config

(

$

config

)

Processes and stores configuration data for this authentication plugin.

Reimplemented from auth_plugin_base.

Definition at line 143 of file auth.php.

user_confirm	(	$	username,
		$	confirmsecret = null
	)

Confirm the new user as registered. This should normally not be used, but it may be necessary if the user auth_method is changed to manual before the user is confirmed.

Reimplemented from auth_plugin_base.

Definition at line 152 of file auth.php.

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 (with system magic quotes)
string	$password	The password (with system magic quotes)

Returns:

bool Authentication success or failure.

Reimplemented from auth_plugin_base.

Definition at line 56 of file auth.php.

user_login_webservice	(	$	username,
		$	password
	)

Custom auth hook for web services.

Parameters:

string	$username
string	$password

Returns:

bool success

Definition at line 67 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 86 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/webservice/auth.php