PHP Class Webiny\Component\Security\Authentication\Providers\Login

Show file Open project: Webiny/Framework Class Usage Examples

Protected Properties

Property Type Description
$authProviderName Name of the auth provider.

Public Methods

Method Description
__construct ( string $username, string $password, boolean $rememberMe = false ) Base constructor.
getAttribute ( string $name ) : null | mixed Returns the stored attribute for the defined $name.
getAuthProviderName ( ) : string Returns the name of auth provider.
getPassword ( ) : string Returns the password.
getRememberMe ( ) : boolean Return the status of remember me.
getTimeZoneOffset ( ) : string Returns the time zone offset.
getUsername ( ) : string Returns the username.
setAttribute ( string $name, mixed $value ) Sets an optional attribute into the current instance.
setAuthProviderName ( $authProviderName ) Set the name of auth provider.
setTimeZoneOffset ( integer $offset ) Set the time zone offset in hours.

Method Details

__construct() public method

Base constructor.
public __construct ( string $username, string $password, boolean $rememberMe = false )
$username string Username.
$password string Password.
$rememberMe boolean Is rememberMe set or not.

getAttribute() public method

Returns the stored attribute for the defined $name.
public getAttribute ( string $name ) : null | mixed
$name string Name of the attribute that you wish to return.
return null | mixed Null is returned if attribute doesn't exist, otherwise attribute value is returned.

getAuthProviderName() public method

Returns the name of auth provider.
public getAuthProviderName ( ) : string
return string

getPassword() public method

Returns the password.
public getPassword ( ) : string
return string

getRememberMe() public method

Return the status of remember me.
public getRememberMe ( ) : boolean
return boolean

getTimeZoneOffset() public method

Returns the time zone offset.
public getTimeZoneOffset ( ) : string
return string

getUsername() public method

Returns the username.
public getUsername ( ) : string
return string

setAttribute() public method

Sets an optional attribute into the current instance.
public setAttribute ( string $name, mixed $value )
$name string Attribute name.
$value mixed Attribute value.

setAuthProviderName() public method

Set the name of auth provider.
public setAuthProviderName ( $authProviderName )
$authProviderName

setTimeZoneOffset() public method

Set the time zone offset in hours.
public setTimeZoneOffset ( integer $offset )
$offset integer Offset in hours.

Property Details

$authProviderName protected property

Name of the auth provider.
protected $authProviderName