AuthPlugin Class Reference
[Plugins]

Abstract class for authentication plugins. More...

Inheritance diagram for AuthPlugin:

List of all members.

Public Member Functions
	authenticate ($username, $password)
	AuthPlugin ($settings=array(), $authId=null)
	createUser (&$user)
	deleteUser ($username)
	doCreateUser (&$user)
	doGetUserInfo (&$user)
	doSetUserInfo (&$user)
	doSetUserPassword ($username, $password)
	getDescription ()
	getDisplayName ()
&	getInstance ($settings, $authId)
	getManagementVerbs ()
	getName ()
	getSettingsTemplate ()
	getUserInfo (&$user)
	isSitePlugin ()
	manage ($verb, $args)
	setUserInfo (&$user)
	setUserPassword ($username, $password)
	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 OJS.

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

Reimplemented in LDAPAuthPlugin.

Definition at line 158 of file AuthPlugin.inc.php.

AuthPlugin.AuthPlugin	(	$	settings = array(),
		$	authId = null
	)

Constructor.

Parameters:

$settings

array

Definition at line 35 of file AuthPlugin.inc.php.

AuthPlugin.createUser

(

&$

user

)

Create a user on the remote source.

Parameters:

$user

User to create

Returns:

boolean true if successful

Reimplemented in LDAPAuthPlugin.

Definition at line 211 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, but is reserved for future use.

Parameters:

$username

string user to delete

Returns:

boolean true if successful

Reimplemented in LDAPAuthPlugin.

Definition at line 222 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 128 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 91 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 103 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 116 of file AuthPlugin.inc.php.

References setUserPassword().

AuthPlugin.getDescription

(

)

Return the localized description of this plugin. Should be overridden by subclass.

Returns:

string

Reimplemented from Plugin.

Reimplemented in LDAPAuthPlugin.

Definition at line 68 of file AuthPlugin.inc.php.

AuthPlugin.getDisplayName

(

)

Return the localized name of this plugin. Should be overridden by subclass.

Returns:

string

Reimplemented from Plugin.

Reimplemented in LDAPAuthPlugin.

Definition at line 59 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

Reimplemented in LDAPAuthPlugin.

Definition at line 147 of file AuthPlugin.inc.php.

AuthPlugin.getManagementVerbs

(

)

Return the management verbs for this plugin.

Reimplemented from Plugin.

Definition at line 236 of file AuthPlugin.inc.php.

References Locale.translate().

AuthPlugin.getName

(

)

Return the name of this plugin. Should be overridden by subclass.

Returns:

string

Reimplemented from Plugin.

Reimplemented in LDAPAuthPlugin.

Definition at line 50 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 77 of file AuthPlugin.inc.php.

AuthPlugin.getUserInfo

(

&$

user

)

Retrieve user profile information from the remote source. Any unsupported fields (e.g., OJS-specific ones) should not be modified.

Parameters:

$user

User to update

Returns:

boolean true if successful

Reimplemented in LDAPAuthPlugin.

Definition at line 183 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 229 of file AuthPlugin.inc.php.

AuthPlugin.manage	(	$	verb,
		$	args
	)

Perform a management function.

Reimplemented from Plugin.

Definition at line 245 of file AuthPlugin.inc.php.

References Request.redirect().

AuthPlugin.setUserInfo

(

&$

user

)

Store user profile information on the remote source.

Parameters:

$user

User to store

Returns:

boolean true if successful

Reimplemented in LDAPAuthPlugin.

Definition at line 192 of file AuthPlugin.inc.php.

Referenced by doSetUserInfo().

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

Reimplemented in LDAPAuthPlugin.

Definition at line 202 of file AuthPlugin.inc.php.

Referenced by doSetUserPassword().

AuthPlugin.userExists

(

$

username

)

Check if a username exists.

Parameters:

$username

string

Returns:

boolean

Reimplemented in LDAPAuthPlugin.

Definition at line 173 of file AuthPlugin.inc.php.

---

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

• classes/plugins/AuthPlugin.inc.php