PHP Interface Cartalyst\Sentinel\Persistences\PersistenceRepositoryInterface

Afficher le fichier Open project: cartalyst/sentinel Interface Usage Examples

Méthodes publiques

Méthode Description
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.

Method Details

check() public méthode

Checks for a persistence code in the current session.
public check ( ) : string
Résultat string

findByPersistenceCode() public méthode

Finds a persistence by persistence code.
public findByPersistenceCode ( string $code ) : Cartalyst\Sentinel\Persistences\PersistenceInterface | false
$code string
Résultat Cartalyst\Sentinel\Persistences\PersistenceInterface | false

findUserByPersistenceCode() public méthode

Finds a user by persistence code.
public findUserByPersistenceCode ( string $code ) : Cartalyst\Sentinel\Users\UserInterface | false
$code string
Résultat Cartalyst\Sentinel\Users\UserInterface | false

flush() public méthode

Flushes persistences for the given user.
public flush ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable, boolean $forget = true ) : void
$persistable Cartalyst\Sentinel\Persistences\PersistableInterface
$forget boolean
Résultat void

forget() public méthode

Removes the persistence bound to the current session.
public forget ( ) : boolean | null
Résultat boolean | null

persist() public méthode

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
Résultat boolean

persistAndRemember() public méthode

Adds a new user persistence, to remember.
public persistAndRemember ( Cartalyst\Sentinel\Persistences\PersistableInterface $persistable ) : boolean
$persistable Cartalyst\Sentinel\Persistences\PersistableInterface
Résultat boolean

remove() public méthode

Removes the given persistence code.
public remove ( string $code ) : boolean | null
$code string
Résultat boolean | null