PHP Интерфейс Cartalyst\Sentinel\Persistences\PersistenceRepositoryInterface

Показать файл Открыть проект Примеры использования интерфейса

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

Метод Описание
check ( ) : string Checks for a persistence code in the current session.
findByPersistenceCode ( string $code ) : Cartalyst\Sentinel\Persistences\PersistenceInterface | false Finds a persistence by persistence code.
findUserByPersistenceCode ( string $code ) : Cartalyst\Sentinel\Users\UserInterface | false Finds a user by persistence code.
flush ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable, boolean $forget = true ) : void Flushes persistences for the given user.
forget ( ) : boolean | null Removes the persistence bound to the current session.
persist ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable, boolean $remember = false ) : boolean Adds a new user persistence to the current session and attaches the user.
persistAndRemember ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable ) : boolean Adds a new user persistence, to remember.
remove ( string $code ) : boolean | null Removes the given persistence code.

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

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

Checks for a persistence code in the current session.
public check ( ) : string
Результат string

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

Finds a persistence by persistence code.
public findByPersistenceCode ( string $code ) : Cartalyst\Sentinel\Persistences\PersistenceInterface | false
$code string
Результат Cartalyst\Sentinel\Persistences\PersistenceInterface | false

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

Finds a user by persistence code.
public findUserByPersistenceCode ( string $code ) : Cartalyst\Sentinel\Users\UserInterface | false
$code string
Результат Cartalyst\Sentinel\Users\UserInterface | false

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

Flushes persistences for the given user.
public flush ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable, boolean $forget = true ) : void
$persistable Cartalyst\Sentinel\Persistences\PersistableInterface
$forget boolean
Результат void

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

Removes the persistence bound to the current session.
public forget ( ) : boolean | null
Результат boolean | null

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

Adds a new user persistence to the current session and attaches the user.
public persist ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable, boolean $remember = false ) : boolean
$persistable Cartalyst\Sentinel\Persistences\PersistableInterface
$remember boolean
Результат boolean

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

Adds a new user persistence, to remember.
public persistAndRemember ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable ) : boolean
$persistable Cartalyst\Sentinel\Persistences\PersistableInterface
Результат boolean

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

Removes the given persistence code.
public remove ( string $code ) : boolean | null
$code string
Результат boolean | null