Abstract class for authentication plugins. More...
Public Member Functions | |
| authenticate ($username, $password) | |
| authenticate ($username, $password) | |
| AuthPlugin ($settings=array(), $authId=null) | |
| AuthPlugin ($settings=array(), $authId=null) | |
| createUser (&$user) | |
| createUser (&$user) | |
| deleteUser ($username) | |
| deleteUser ($username) | |
| doCreateUser (&$user) | |
| doCreateUser (&$user) | |
| doGetUserInfo (&$user) | |
| doGetUserInfo (&$user) | |
| doSetUserInfo (&$user) | |
| doSetUserInfo (&$user) | |
| doSetUserPassword ($username, $password) | |
| doSetUserPassword ($username, $password) | |
| getDescription () | |
| getDescription () | |
| getDisplayName () | |
| getDisplayName () | |
| & | getInstance ($settings, $authId) |
| & | getInstance ($settings, $authId) |
| getManagementVerbs () | |
| getManagementVerbs () | |
| getName () | |
| getName () | |
| getSettingsTemplate () | |
| getSettingsTemplate () | |
| getUserInfo (&$user) | |
| getUserInfo (&$user) | |
| isSitePlugin () | |
| isSitePlugin () | |
| setUserInfo (&$user) | |
| setUserInfo (&$user) | |
| setUserPassword ($username, $password) | |
| setUserPassword ($username, $password) | |
| userExists ($username) | |
| userExists ($username) | |
Detailed Description
Abstract class for authentication plugins.
TODO: Error reporting when updating remote source fails. TODO: Support importing user accounts from the authentication source into OMP.
Definition at line 23 of file AuthPlugin.inc.php.
Member Function Documentation
| AuthPlugin.authenticate | ( | $ | username, | |
| $ | password | |||
| ) |
Authenticate a username and password.
- Parameters:
-
$username string $password string
- Returns:
- boolean true if authentication is successful
Definition at line 159 of file AuthPlugin.inc.php.
| AuthPlugin.authenticate | ( | $ | username, | |
| $ | password | |||
| ) |
Authenticate a username and password.
- Parameters:
-
$username string $password string
- Returns:
- boolean true if authentication is successful
Definition at line 159 of file AuthPlugin.inc.php.
| AuthPlugin.AuthPlugin | ( | $ | settings = array(), |
|
| $ | authId = null | |||
| ) |
Constructor.
- Parameters:
-
$settings array
Definition at line 35 of file AuthPlugin.inc.php.
References Plugin.Plugin().
| AuthPlugin.AuthPlugin | ( | $ | settings = array(), |
|
| $ | authId = null | |||
| ) |
Constructor.
- Parameters:
-
$settings array
Definition at line 35 of file AuthPlugin.inc.php.
References Plugin.Plugin().
| AuthPlugin.createUser | ( | &$ | user | ) |
Create a user on the remote source.
- Parameters:
-
$user User to create
- Returns:
- boolean true if successful
Definition at line 212 of file AuthPlugin.inc.php.
Referenced by doCreateUser().
| AuthPlugin.createUser | ( | &$ | user | ) |
Create a user on the remote source.
- Parameters:
-
$user User to create
- Returns:
- boolean true if successful
Definition at line 212 of file AuthPlugin.inc.php.
| AuthPlugin.deleteUser | ( | $ | username | ) |
Delete a user from the remote source. This function is currently not used within OMP, but is reserved for future use.
- Parameters:
-
$username string user to delete
- Returns:
- boolean true if successful
Definition at line 223 of file AuthPlugin.inc.php.
| AuthPlugin.deleteUser | ( | $ | username | ) |
Delete a user from the remote source. This function is currently not used within OMP, but is reserved for future use.
- Parameters:
-
$username string user to delete
- Returns:
- boolean true if successful
Definition at line 223 of file AuthPlugin.inc.php.
| AuthPlugin.doCreateUser | ( | &$ | user | ) |
Create remote user account, if enabled.
- Parameters:
-
$user User to create
- Returns:
- boolean true if successful
Definition at line 129 of file AuthPlugin.inc.php.
References createUser().
| AuthPlugin.doCreateUser | ( | &$ | user | ) |
Create remote user account, if enabled.
- Parameters:
-
$user User to create
- Returns:
- boolean true if successful
Definition at line 129 of file AuthPlugin.inc.php.
References createUser().
| AuthPlugin.doGetUserInfo | ( | &$ | user | ) |
Update local user profile from the remote source, if enabled.
- Parameters:
-
$user User
- Returns:
- boolean true if successful
Definition at line 92 of file AuthPlugin.inc.php.
References getUserInfo().
| AuthPlugin.doGetUserInfo | ( | &$ | user | ) |
Update local user profile from the remote source, if enabled.
- Parameters:
-
$user User
- Returns:
- boolean true if successful
Definition at line 92 of file AuthPlugin.inc.php.
References getUserInfo().
| AuthPlugin.doSetUserInfo | ( | &$ | user | ) |
Update remote user profile, if enabled.
- Parameters:
-
$user User
- Returns:
- boolean true if successful
Definition at line 104 of file AuthPlugin.inc.php.
References setUserInfo().
| AuthPlugin.doSetUserInfo | ( | &$ | user | ) |
Update remote user profile, if enabled.
- Parameters:
-
$user User
- Returns:
- boolean true if successful
Definition at line 104 of file AuthPlugin.inc.php.
References setUserInfo().
| AuthPlugin.doSetUserPassword | ( | $ | username, | |
| $ | password | |||
| ) |
Update remote user password, if enabled.
- Parameters:
-
$username string $password string
- Returns:
- boolean true if successful
Definition at line 117 of file AuthPlugin.inc.php.
References setUserPassword().
| AuthPlugin.doSetUserPassword | ( | $ | username, | |
| $ | password | |||
| ) |
Update remote user password, if enabled.
- Parameters:
-
$username string $password string
- Returns:
- boolean true if successful
Definition at line 117 of file AuthPlugin.inc.php.
References setUserPassword().
| AuthPlugin.getDescription | ( | ) |
Return the localized description of this plugin. Should be overridden by subclass.
- Returns:
- string
Definition at line 69 of file AuthPlugin.inc.php.
| AuthPlugin.getDescription | ( | ) |
Return the localized description of this plugin. Should be overridden by subclass.
- Returns:
- string
Definition at line 69 of file AuthPlugin.inc.php.
| AuthPlugin.getDisplayName | ( | ) |
Return the localized name of this plugin. Should be overridden by subclass.
- Returns:
- string
Definition at line 60 of file AuthPlugin.inc.php.
| AuthPlugin.getDisplayName | ( | ) |
Return the localized name of this plugin. Should be overridden by subclass.
- Returns:
- string
Definition at line 60 of file AuthPlugin.inc.php.
| & AuthPlugin.getInstance | ( | $ | settings, | |
| $ | authId | |||
| ) |
Returns an instance of the authentication plugin
- Parameters:
-
$settings array settings specific to this instance $authId int identifier for this instance
- Returns:
- AuthPlugin
Definition at line 148 of file AuthPlugin.inc.php.
| & AuthPlugin.getInstance | ( | $ | settings, | |
| $ | authId | |||
| ) |
Returns an instance of the authentication plugin
- Parameters:
-
$settings array settings specific to this instance $authId int identifier for this instance
- Returns:
- AuthPlugin
Definition at line 148 of file AuthPlugin.inc.php.
| AuthPlugin.getManagementVerbs | ( | ) |
Return the management verbs for this plugin.
Definition at line 237 of file AuthPlugin.inc.php.
| AuthPlugin.getManagementVerbs | ( | ) |
Return the management verbs for this plugin.
Definition at line 237 of file AuthPlugin.inc.php.
| AuthPlugin.getName | ( | ) |
Return the name of this plugin. Should be overridden by subclass.
- Returns:
- string
Definition at line 51 of file AuthPlugin.inc.php.
| AuthPlugin.getName | ( | ) |
Return the name of this plugin. Should be overridden by subclass.
- Returns:
- string
Definition at line 51 of file AuthPlugin.inc.php.
| AuthPlugin.getSettingsTemplate | ( | ) |
Return the path to a template for plugin settings. Can return null if there are no plugin-specific settings.
- Returns:
- string
Definition at line 78 of file AuthPlugin.inc.php.
| AuthPlugin.getSettingsTemplate | ( | ) |
Return the path to a template for plugin settings. Can return null if there are no plugin-specific settings.
- Returns:
- string
Definition at line 78 of file AuthPlugin.inc.php.
| AuthPlugin.getUserInfo | ( | &$ | user | ) |
Retrieve user profile information from the remote source. Any unsupported fields (e.g., OMP-specific ones) should not be modified.
- Parameters:
-
$user User to update
- Returns:
- boolean true if successful
Definition at line 184 of file AuthPlugin.inc.php.
| AuthPlugin.getUserInfo | ( | &$ | user | ) |
Retrieve user profile information from the remote source. Any unsupported fields (e.g., OMP-specific ones) should not be modified.
- Parameters:
-
$user User to update
- Returns:
- boolean true if successful
Definition at line 184 of file AuthPlugin.inc.php.
Referenced by doGetUserInfo().
| AuthPlugin.isSitePlugin | ( | ) |
Return true iff this is a site-wide plugin.
Definition at line 230 of file AuthPlugin.inc.php.
| AuthPlugin.isSitePlugin | ( | ) |
Return true iff this is a site-wide plugin.
Definition at line 230 of file AuthPlugin.inc.php.
| AuthPlugin.setUserInfo | ( | &$ | user | ) |
Store user profile information on the remote source.
- Parameters:
-
$user User to store
- Returns:
- boolean true if successful
Definition at line 193 of file AuthPlugin.inc.php.
Referenced by doSetUserInfo().
| AuthPlugin.setUserInfo | ( | &$ | user | ) |
Store user profile information on the remote source.
- Parameters:
-
$user User to store
- Returns:
- boolean true if successful
Definition at line 193 of file AuthPlugin.inc.php.
| AuthPlugin.setUserPassword | ( | $ | username, | |
| $ | password | |||
| ) |
Change a user's password on the remote source.
- Parameters:
-
$username string user to update $password string the new password
- Returns:
- boolean true if successful
Definition at line 203 of file AuthPlugin.inc.php.
| AuthPlugin.setUserPassword | ( | $ | username, | |
| $ | password | |||
| ) |
Change a user's password on the remote source.
- Parameters:
-
$username string user to update $password string the new password
- Returns:
- boolean true if successful
Definition at line 203 of file AuthPlugin.inc.php.
Referenced by doSetUserPassword().
| AuthPlugin.userExists | ( | $ | username | ) |
Check if a username exists.
- Parameters:
-
$username string
- Returns:
- boolean
Definition at line 174 of file AuthPlugin.inc.php.
| AuthPlugin.userExists | ( | $ | username | ) |
Check if a username exists.
- Parameters:
-
$username string
- Returns:
- boolean
Definition at line 174 of file AuthPlugin.inc.php.
The documentation for this class was generated from the following files:
- classes/plugins/AuthPlugin.inc.php
- omp.JipGdx/omp-1.0b/classes/plugins/AuthPlugin.inc.php
Generated on Mon Sep 17 2012 13:00:06 for Open Monograph Press by
1.7.1