PHP Интерфейс Cartalyst\Sentinel\Activations\ActivationRepositoryInterface

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

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

Метод Описание
complete ( Cartalyst\Sentinel\Users\UserInterface $user, string $code ) : boolean Completes the activation for the given user.
completed ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean Checks if a valid activation has been completed.
create ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface Create a new activation record and code.
exists ( Cartalyst\Sentinel\Users\UserInterface $user, string $code = null ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean Checks if a valid activation for the given user exists.
remove ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean | null Remove an existing activation (deactivate).
removeExpired ( ) : integer Remove expired activation codes.

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

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

Completes the activation for the given user.
public complete ( Cartalyst\Sentinel\Users\UserInterface $user, string $code ) : boolean
$user Cartalyst\Sentinel\Users\UserInterface
$code string
Результат boolean

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

Checks if a valid activation has been completed.
public completed ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean
$user Cartalyst\Sentinel\Users\UserInterface
Результат Cartalyst\Sentinel\Activations\ActivationInterface | boolean

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

Create a new activation record and code.
public create ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface
$user Cartalyst\Sentinel\Users\UserInterface
Результат Cartalyst\Sentinel\Activations\ActivationInterface

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

Checks if a valid activation for the given user exists.
public exists ( Cartalyst\Sentinel\Users\UserInterface $user, string $code = null ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean
$user Cartalyst\Sentinel\Users\UserInterface
$code string
Результат Cartalyst\Sentinel\Activations\ActivationInterface | boolean

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

Remove an existing activation (deactivate).
public remove ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean | null
$user Cartalyst\Sentinel\Users\UserInterface
Результат boolean | null

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

Remove expired activation codes.
public removeExpired ( ) : integer
Результат integer