auth_plugin_shibboleth Class Reference

Inheritance diagram for auth_plugin_shibboleth:

Collaboration diagram for auth_plugin_shibboleth:

Public Member Functions
	auth_plugin_shibboleth ()
	user_login ($username, $password)
	get_userinfo ($username)
	get_attributes ()
	prevent_local_passwords ()
	is_internal ()
	can_change_password ()
	loginpage_hook ()
	logoutpage_hook ()
	config_form ($config, $err, $user_fields)
	process_config ($config)
	get_first_string ($string)

---

Detailed Description

Shibboleth authentication plugin.

Definition at line 35 of file auth.php.

---

Member Function Documentation

auth_plugin_shibboleth

(

)

Constructor.

Definition at line 40 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 174 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 225 of file auth.php.

get_attributes

(

)

Returns array containg attribute mappings between Moodle and Shibboleth.

Returns:

array

Definition at line 141 of file auth.php.

Here is the caller graph for this function:

get_first_string

(

$

string

)

Cleans and returns first of potential many values (multi-valued attributes)

Parameters:

string

$string

Possibly multi-valued attribute from Shibboleth

Definition at line 316 of file auth.php.

Here is the caller graph for this function:

get_userinfo

(

$

username

)

Returns the user information for 'external' users. In this case the attributes provided by Shibboleth

Returns:

array $result Associative array of user data

Reimplemented from auth_plugin_base.

Definition at line 91 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 164 of file auth.php.

loginpage_hook

(

)

Hook for login page

Reimplemented from auth_plugin_base.

Definition at line 182 of file auth.php.

logoutpage_hook

(

)

Hook for logout page

Reimplemented from auth_plugin_base.

Definition at line 195 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 155 of file auth.php.

process_config

(

$

config

)

Processes and stores configuration data for this authentication plugin.

Parameters:

object

$config

Configuration object

Reimplemented from auth_plugin_base.

Definition at line 235 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 (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 53 of file auth.php.

---

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

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