Open Journal Systems
3.3.0
|
Data Fields | |
$authId | |
$settings | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
Additional Inherited Members | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
Abstract class for authentication plugins.
TODO: Error reporting when updating remote source fails. TODO: Support importing user accounts from the authentication source into OJS/OMP.
Definition at line 22 of file AuthPlugin.inc.php.
AuthPlugin::__construct | ( | $settings = array() , |
|
$authId = null |
|||
) |
Constructor.
$settings | array |
$authId | int ID for this instance |
Definition at line 41 of file AuthPlugin.inc.php.
|
abstract |
Authenticate a username and password.
$username | string |
$password | string |
Reimplemented in LDAPAuthPlugin.
AuthPlugin::createUser | ( | $user | ) |
Create a user on the remote source.
$user | User to create |
Reimplemented in LDAPAuthPlugin.
Definition at line 182 of file AuthPlugin.inc.php.
Referenced by doCreateUser().
AuthPlugin::deleteUser | ( | $username | ) |
Delete a user from the remote source. This function is currently not used within OJS or OMP, but is reserved for future use.
$username | string user to delete |
Reimplemented in LDAPAuthPlugin.
Definition at line 193 of file AuthPlugin.inc.php.
AuthPlugin::doCreateUser | ( | $user | ) |
Create remote user account, if enabled.
$user | User to create |
Definition at line 106 of file AuthPlugin.inc.php.
References createUser().
AuthPlugin::doGetUserInfo | ( | $user | ) |
Update local user profile from the remote source, if enabled.
$user | User |
Definition at line 69 of file AuthPlugin.inc.php.
References getUserInfo().
AuthPlugin::doSetUserInfo | ( | $user | ) |
Update remote user profile, if enabled.
$user | User |
Definition at line 81 of file AuthPlugin.inc.php.
References setUserInfo().
AuthPlugin::doSetUserPassword | ( | $username, | |
$password | |||
) |
Update remote user password, if enabled.
$username | string |
$password | string |
Definition at line 94 of file AuthPlugin.inc.php.
References setUserPassword().
|
abstract |
Returns an instance of the authentication plugin
$settings | array settings specific to this instance |
$authId | int identifier for this instance |
Reimplemented in LDAPAuthPlugin.
AuthPlugin::getSettingsTemplate | ( | ) |
Return the path to a template for plugin settings. Can return null if there are no plugin-specific settings.
Definition at line 56 of file AuthPlugin.inc.php.
References Plugin\getTemplateResource().
AuthPlugin::getUserInfo | ( | $user | ) |
Retrieve user profile information from the remote source. Any unsupported fields (e.g., OJS- or OMP-specific ones) should not be modified.
$user | User to update |
Reimplemented in LDAPAuthPlugin.
Definition at line 154 of file AuthPlugin.inc.php.
Referenced by doGetUserInfo().
AuthPlugin::isSitePlugin | ( | ) |
Return true iff this is a site-wide plugin.
Reimplemented from Plugin.
Definition at line 200 of file AuthPlugin.inc.php.
AuthPlugin::setUserInfo | ( | $user | ) |
Store user profile information on the remote source.
$user | User to store |
Reimplemented in LDAPAuthPlugin.
Definition at line 163 of file AuthPlugin.inc.php.
Referenced by doSetUserInfo().
AuthPlugin::setUserPassword | ( | $username, | |
$password | |||
) |
Change a user's password on the remote source.
$username | string user to update |
$password | string the new password |
Reimplemented in LDAPAuthPlugin.
Definition at line 173 of file AuthPlugin.inc.php.
Referenced by doSetUserPassword().
AuthPlugin::userExists | ( | $username | ) |
Check if a username exists.
$username | string |
Reimplemented in LDAPAuthPlugin.
Definition at line 144 of file AuthPlugin.inc.php.
$authId AuthPlugin::$authId |
int auth source ID for this plugin instance
Definition at line 34 of file AuthPlugin.inc.php.
Referenced by __construct(), and LDAPAuthPlugin\getInstance().
$settings AuthPlugin::$settings |
array settings for this plugin instance
Definition at line 28 of file AuthPlugin.inc.php.
Referenced by __construct(), and LDAPAuthPlugin\getInstance().