PHP Class Webiny\Component\Security\Token\Token

Inheritance: use trait Webiny\Component\StdLib\FactoryLoaderTrait
Mostrar archivo Open project: Webiny/Framework

Public Methods

Method Description
__construct ( string $tokenName, boolean $rememberMe = false, string $securityKey, Webiny\Component\Security\Token\CryptDrivers\CryptDriverInterface $cryptDriver, null | string $storageClass = null ) Base constructor.
deleteUserToken ( ) : boolean Deletes current token.
getTokenString ( ) : string Get string representation of token
getUserFromToken ( ) : boolean | TokenData Tries to load current user from token and if succeeds, an instance of TokenData is returned.
saveUser ( AbstractUser $user ) : boolean Creates a token for the given $user.
setRememberMe ( boolean $rememberMe ) Should token be remembered or not
setTokenString ( string $token ) Save the provided token string into the token storage.

Private Methods

Method Description
getStorageName ( ) : string Returns the correct storage name. If 'rememberMe' is true, Cookie storage is returned, otherwise Session storage is returned.

Method Details

__construct() public method

Base constructor.
public __construct ( string $tokenName, boolean $rememberMe = false, string $securityKey, Webiny\Component\Security\Token\CryptDrivers\CryptDriverInterface $cryptDriver, null | string $storageClass = null )
$tokenName string Name of the token.
$rememberMe boolean Do you want to store the token into cookie, or not. If you don't store it into cookie, the token is only valid for current session.
$securityKey string Security key that will be used for encryption of token data
$cryptDriver Webiny\Component\Security\Token\CryptDrivers\CryptDriverInterface
$storageClass null | string

deleteUserToken() public method

Deletes current token.
public deleteUserToken ( ) : boolean
return boolean

getTokenString() public method

Get string representation of token
public getTokenString ( ) : string
return string

getUserFromToken() public method

Tries to load current user from token and if succeeds, an instance of TokenData is returned.
public getUserFromToken ( ) : boolean | TokenData
return boolean | TokenData Instance of TokenData is returned is the token exists, otherwise false is returned.

saveUser() public method

Creates a token for the given $user.
public saveUser ( AbstractUser $user ) : boolean
$user Webiny\Component\Security\User\AbstractUser Instance of AbstractUser class that holds the pre-filled object from user provider.
return boolean

setRememberMe() public method

Should token be remembered or not
public setRememberMe ( boolean $rememberMe )
$rememberMe boolean

setTokenString() public method

Save the provided token string into the token storage.
public setTokenString ( string $token )
$token string Token string to save.