Moodle  2.2.1
http://www.collinsharper.com
auth_plugin_cas Class Reference
Inheritance diagram for auth_plugin_cas:
Collaboration diagram for auth_plugin_cas:

Public Member Functions

 auth_plugin_cas ()
 prevent_local_passwords ()
 user_login ($username, $password)
 is_internal ()
 can_change_password ()
 loginpage_hook ()
 prelogout_hook ()
 connectCAS ()
 config_form ($config, $err, $user_fields)
 validate_form (&$form, &$err)
 change_password_url ()
 process_config ($config)
 iscreator ($username)
 get_userinfo ($username)
 sync_users ($do_updates=true)

Detailed Description

CAS authentication plugin.

Definition at line 27 of file auth.php.


Member Function Documentation

Constructor.

Definition at line 32 of file auth.php.

Here is the call graph for this function:

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

Returns:
bool

Reimplemented from auth_plugin_ldap.

Definition at line 72 of file auth.php.

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

Returns:
moodle_url

Reimplemented from auth_plugin_ldap.

Definition at line 231 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$pageAn object containing all the data for this page.

Reimplemented from auth_plugin_ldap.

Definition at line 192 of file auth.php.

Connect to the CAS (clientcas connection or proxycas connection)

Definition at line 164 of file auth.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_userinfo ( username)

Reads user information from LDAP and returns it as array()

If no LDAP servers are configured, user information has to be provided via other methods (CSV file, manually, etc.). Return an empty array so existing user info is not lost. Otherwise, calls parent class method to get user info.

Parameters:
string$usernameusername
Returns:
mixed array with no magic quotes or false on error

Reimplemented from auth_plugin_ldap.

Definition at line 420 of file auth.php.

Returns true if this authentication plugin is 'internal'.

Returns:
bool

Reimplemented from auth_plugin_ldap.

Definition at line 62 of file auth.php.

iscreator ( username)

Returns true if user should be coursecreator.

Parameters:
mixed$usernameusername (without system magic quotes)
Returns:
boolean result

Reimplemented from auth_plugin_ldap.

Definition at line 362 of file auth.php.

Here is the call graph for this function:

Authentication choice (CAS or other) Redirection to the CAS form or to login/index.php for other authentication

Reimplemented from auth_plugin_ldap.

Definition at line 81 of file auth.php.

Here is the call graph for this function:

Logout from the CAS

Reimplemented from auth_plugin_base.

Definition at line 150 of file auth.php.

Here is the call graph for this function:

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

Returns:
bool true means flag 'not_cached' stored instead of password hash

Reimplemented from auth_plugin_ldap.

Definition at line 39 of file auth.php.

process_config ( config)

Processes and stores configuration data for this authentication plugin.

Reimplemented from auth_plugin_ldap.

Definition at line 238 of file auth.php.

Here is the call graph for this function:

sync_users ( do_updates = true)

Syncronizes users from LDAP server to moodle user table.

If no LDAP servers are configured, simply return. Otherwise, call parent class method to do the work.

Parameters:
bool$do_updateswill do pull in data updates from LDAP if relevant
Returns:
nothing

Reimplemented from auth_plugin_ldap.

Definition at line 436 of file auth.php.

user_login ( username,
password 
)

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

Parameters:
string$usernameThe username (with system magic quotes)
string$passwordThe password (with system magic quotes)
Returns:
bool Authentication success or failure.

Reimplemented from auth_plugin_ldap.

Definition at line 52 of file auth.php.

Here is the call graph for this function:

validate_form ( &$  form,
&$  err 
)

A chance to validate form data, and last chance to do stuff before it is inserted in config_plugin

Parameters:
objectobject with submitted configuration settings (without system magic quotes)
array$errarray of error messages

Reimplemented from auth_plugin_base.

Definition at line 218 of file auth.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations