PHP Class Pantheon\Terminus\Session\Session

Inheritance: implements League\Container\ContainerAwareInterface, implements Robo\Contract\ConfigAwareInterface, implements Pantheon\Terminus\DataStore\DataStoreAwareInterface, use trait Robo\Common\ConfigAwareTrait, use trait League\Container\ContainerAwareTrait, use trait Pantheon\Terminus\DataStore\DataStoreAwareTrait
Afficher le fichier Open project: pantheon-systems/terminus Class Usage Examples

Méthodes publiques

Свойство Type Description
$tokens Pantheon\Terminus\Collections\SavedTokens

Protected Properties

Свойство Type Description
$data object

Méthodes publiques

Méthode Description
__construct ( Pantheon\Terminus\DataStore\DataStoreInterface $data_store ) Instantiates object, sets session data, instantiates a SavedTokens instance
destroy ( ) Removes the session from the cache
get ( string $key ) : mixed Returns given data property or default if DNE.
getTokens ( ) : SavedTokens
getUser ( ) : User Returns a user with the current session user id
isActive ( ) : boolean Responds with the status of this session (i.e. whether the client is logged in)
setData ( array $data ) Saves session data to cache
setDataStore ( Pantheon\Terminus\DataStore\DataStoreInterface $data_store )

Method Details

__construct() public méthode

Instantiates object, sets session data, instantiates a SavedTokens instance
public __construct ( Pantheon\Terminus\DataStore\DataStoreInterface $data_store )
$data_store Pantheon\Terminus\DataStore\DataStoreInterface An object to persist the session data.

destroy() public méthode

Removes the session from the cache
public destroy ( )

get() public méthode

Returns given data property or default if DNE.
public get ( string $key ) : mixed
$key string Name of property to return
Résultat mixed

getTokens() public méthode

public getTokens ( ) : SavedTokens
Résultat Pantheon\Terminus\Collections\SavedTokens

getUser() public méthode

Returns a user with the current session user id
public getUser ( ) : User
Résultat Pantheon\Terminus\Models\User [user] $session user

isActive() public méthode

Responds with the status of this session (i.e. whether the client is logged in)
public isActive ( ) : boolean
Résultat boolean

setData() public méthode

Saves session data to cache
public setData ( array $data )
$data array Session data to save

setDataStore() public méthode

public setDataStore ( Pantheon\Terminus\DataStore\DataStoreInterface $data_store )
$data_store Pantheon\Terminus\DataStore\DataStoreInterface

Property Details

$data protected_oe property

protected object $data
Résultat object

$tokens public_oe property

public SavedTokens,Pantheon\Terminus\Collections $tokens
Résultat Pantheon\Terminus\Collections\SavedTokens