auth_plugin_fc Class Reference

Inheritance diagram for auth_plugin_fc:

Collaboration diagram for auth_plugin_fc:

Public Member Functions
	auth_plugin_fc ()
	user_login ($username, $password)
	get_userinfo ($username)
	iscreator ($username)
	prevent_local_passwords ()
	is_internal ()
	can_change_password ()
	sync_roles ($user)
	config_form ($config, $err, $user_fields)
	process_config ($config)

---

Detailed Description

FirstClass authentication plugin.

Definition at line 25 of file auth.php.

---

Member Function Documentation

auth_plugin_fc

(

)

Constructor.

Definition at line 30 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 166 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 202 of file auth.php.

get_userinfo

(

$

username

)

Get user information from FirstCLass server and return it in an array. Localize this routine to fit your needs.

Reimplemented from auth_plugin_base.

Definition at line 67 of file auth.php.

is_internal

(

)

Returns true if this authentication plugin is 'internal'.

Returns:

bool

Reimplemented from auth_plugin_base.

Definition at line 156 of file auth.php.

iscreator

(

$

username

)

Get users group membership from the FirstClass server user and check if user is member of one of the groups of creators.

Definition at line 117 of file auth.php.

Here is the caller graph for this function:

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 147 of file auth.php.

process_config

(

$

config

)

Processes and stores configuration data for this authentication plugin.

Reimplemented from auth_plugin_base.

Definition at line 209 of file auth.php.

Here is the call graph for this function:

sync_roles

(

$

user

)

Sync roles for this user

Parameters:

$user

object user object (without system magic quotes)

Reimplemented from auth_plugin_base.

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

---

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

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