PHP Класс Pantheon\Terminus\Session\Session

Наследование: 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
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$tokens Pantheon\Terminus\Collections\SavedTokens

Защищенные свойства (Protected)

Свойство Тип Описание
$data object

Открытые методы

Метод Описание
__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 )

Описание методов

__construct() публичный Метод

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() публичный Метод

Removes the session from the cache
public destroy ( )

get() публичный Метод

Returns given data property or default if DNE.
public get ( string $key ) : mixed
$key string Name of property to return
Результат mixed

getTokens() публичный Метод

public getTokens ( ) : SavedTokens
Результат Pantheon\Terminus\Collections\SavedTokens

getUser() публичный Метод

Returns a user with the current session user id
public getUser ( ) : User
Результат Pantheon\Terminus\Models\User [user] $session user

isActive() публичный Метод

Responds with the status of this session (i.e. whether the client is logged in)
public isActive ( ) : boolean
Результат boolean

setData() публичный Метод

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

setDataStore() публичный Метод

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

Описание свойств

$data защищенное свойство

protected object $data
Результат object

$tokens публичное свойство

public SavedTokens,Pantheon\Terminus\Collections $tokens
Результат Pantheon\Terminus\Collections\SavedTokens