abstract public
string
|
#
friendlyName( )
Return a friendly name for the proxy to be displayed in the ui.
Return a friendly name for the proxy to be displayed in the ui.
Something like 'integrated', 'active directory', 'generic ldap', 'auth0'.
Returns
string
Friendly name.
|
public
boolean
|
#
canModifyEmailAddress( )
Return whether the proxy allows changing the e-mail address.
Return whether the proxy allows changing the e-mail address.
Returns
boolean
True if the e-mail address can be changed, false otherwise.
|
public
boolean
|
#
canModifyGroup( )
Return whether the proxy allows changing the group.
Return whether the proxy allows changing the group.
Returns
boolean
True if the group can be changed, false otherwise.
|
public
boolean
|
#
canModifyPassword( )
Return whether the proxy allows changing the password.
Return whether the proxy allows changing the password.
Returns
boolean
True if the password can be changed, false otherwise.
|
abstract public
boolean
|
#
authenticate( string $username, string $password )
Authenticates the User with given username and password.
Authenticates the User with given username and password.
Parameters
- $username
- Username for authentication.
- $password
- Password for authentication.
Returns
boolean
True if authentication succeeded, false otherwise.
|
abstract public
string|null
|
#
getEmailAddress( string $username )
Returns the email address of user with given username.
Returns the email address of user with given username.
Parameters
- $username
- Username for which to query the email address.
Returns
string|null
Email address or null.
|
abstract public
string
|
#
getGroup( string $username )
Returns the group the user with given username belongs to.
Returns the group the user with given username belongs to.
Parameters
- $username
- Username for which to query the group.
Returns
string
Group or "" if not found.
|
public
boolean
|
#
isActive( string $username )
Checks whether a request from the user with given name was accepted by
the administrator and his active.
Checks whether a request from the user with given name was accepted by
the administrator and his active.
Parameters
- $username
- Username for which to query the active status.
Returns
boolean
True if the user is active, false otherwise.
Override
|
public
boolean
|
#
isDisabled( string $username )
Checks whether the user with given name was disabled by the administrator.
Checks whether the user with given name was disabled by the administrator.
Parameters
- $username
- String Username for which to query the status.
Returns
boolean
True if the user was disabled, false otherwise.
|
public
boolean
|
#
isOutdated( string $username = "ignored" )
Checks whether the user with given name must be updated before use (e.g.
in need of a password rehash).
Checks whether the user with given name must be updated before use (e.g.
in need of a password rehash).
Inheriting classes might need to re-implement this.
Parameters
Returns
boolean
True if the User must be updated, false otherwise.
|
public
|
#
setActive( string $username )
Set the User status to active.
Set the User status to active.
Parameters
|
public
|
#
setDisabled( string $username )
Set the User status to disabled.
Set the User status to disabled.
Parameters
|
public
void.
|
#
setOutdated( string $username = "ignored" )
Set the User status to outdated (e.g. in need of a password update).
Set the User status to outdated (e.g. in need of a password update).
Inheriting classes might need to reimplement this.
Parameters
Returns
void.
|
public
string
|
#
markPasswordReset( string $username = "ignored" )
Mark password reset.
This method must be overridden by classes for which canModifyPassword()
returns true!
Parameters
- $username
- Name of the user to mark for password update.
Returns
string
string
Throws
Exception
The base implementation of this method throws an exception.
|