PHP Интерфейс Stevemo\Cpanel\User\Repo\CpanelUserInterface

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

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

Метод Описание
activate ( $id ) : boolean Activate a user
authenticate ( array $credentials, boolean $remember = false ) : Cartalyst\Sentry\Users\UserInterface Attempts to authenticate the given user according to the passed credentials.
check ( ) : boolean Check to see if the user is logged in and activated, and hasn't been banned or suspended.
create ( array $credentials, boolean $activate = false ) : Cartalyst\Sentry\Users\UserInterface Create a new user
deactivate ( $id ) : boolean De activate a user
delete ( integer $id ) : void Delete the user
findAll ( ) : array Returns an all users.
findById ( $id ) : Cartalyst\Sentry\Users\UserInterface Finds a user by the given user ID.
findByLogin ( $login ) : Cartalyst\Sentry\Users\UserInterface Find a given user by the login attribute
getEmptyUser ( ) : StdClass Returns an empty user object.
getUser ( ) : mixed | Cartalyst\Sentry\Users\UserInterface Returns the current user being used by Sentry, if any.
getUserThrottle ( $id ) : Cartalyst\Sentry\Throttling\ThrottleInterface Get the throttle provider for a given user
logout ( ) : void Logs the current user out.
register ( array $credentials, boolean $activate = false ) : Cartalyst\Sentry\Users\UserInterface Registers a user by giving the required credentials and an optional flag for whether to activate the user.
resetPassword ( $code, $password ) : Cartalyst\Sentry\Users\UserInterface Reset a given user password
update ( $id, array $attributes ) : Cartalyst\Sentry\Users\UserInterface Update user information
updatePermissions ( integer $id, array $permissions ) : Cartalyst\Sentry\Users\UserInterface Update permissions for a given user
updateThrottleStatus ( $id, $status ) : void

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

activate() публичный метод

Activate a user
Автор: Steve Montambeault
public activate ( $id ) : boolean
$id
Результат boolean

authenticate() публичный метод

Attempts to authenticate the given user according to the passed credentials.
Автор: Steve Montambeault
public authenticate ( array $credentials, boolean $remember = false ) : Cartalyst\Sentry\Users\UserInterface
$credentials array
$remember boolean
Результат Cartalyst\Sentry\Users\UserInterface

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

Check to see if the user is logged in and activated, and hasn't been banned or suspended.
Автор: Steve Montambeault
public check ( ) : boolean
Результат boolean

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

Create a new user
Автор: Steve Montambeault
public create ( array $credentials, boolean $activate = false ) : Cartalyst\Sentry\Users\UserInterface
$credentials array
$activate boolean
Результат Cartalyst\Sentry\Users\UserInterface

deactivate() публичный метод

De activate a user
Автор: Steve Montambeault
public deactivate ( $id ) : boolean
$id
Результат boolean

delete() публичный метод

Delete the user
Автор: Steve Montambeault
public delete ( integer $id ) : void
$id integer
Результат void

findAll() публичный метод

Returns an all users.
Автор: Steve Montambeault
public findAll ( ) : array
Результат array

findById() публичный метод

Finds a user by the given user ID.
Автор: Steve Montambeault
public findById ( $id ) : Cartalyst\Sentry\Users\UserInterface
$id
Результат Cartalyst\Sentry\Users\UserInterface

findByLogin() публичный метод

Find a given user by the login attribute
Автор: Steve Montambeault
public findByLogin ( $login ) : Cartalyst\Sentry\Users\UserInterface
$login
Результат Cartalyst\Sentry\Users\UserInterface

getEmptyUser() публичный метод

Returns an empty user object.
Автор: Steve Montambeault
public getEmptyUser ( ) : StdClass
Результат StdClass

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

Returns the current user being used by Sentry, if any.
Автор: Steve Montambeault
public getUser ( ) : mixed | Cartalyst\Sentry\Users\UserInterface
Результат mixed | Cartalyst\Sentry\Users\UserInterface

getUserThrottle() публичный метод

Get the throttle provider for a given user
Автор: Steve Montambeault
public getUserThrottle ( $id ) : Cartalyst\Sentry\Throttling\ThrottleInterface
$id
Результат Cartalyst\Sentry\Throttling\ThrottleInterface

logout() публичный метод

Logs the current user out.
Автор: Steve Montambeault
public logout ( ) : void
Результат void

register() публичный метод

Registers a user by giving the required credentials and an optional flag for whether to activate the user.
Автор: Steve Montambeault
public register ( array $credentials, boolean $activate = false ) : Cartalyst\Sentry\Users\UserInterface
$credentials array
$activate boolean
Результат Cartalyst\Sentry\Users\UserInterface

resetPassword() публичный метод

Reset a given user password
Автор: Steve Montambeault
public resetPassword ( $code, $password ) : Cartalyst\Sentry\Users\UserInterface
$code
$password
Результат Cartalyst\Sentry\Users\UserInterface

update() публичный метод

Update user information
Автор: Steve Montambeault
public update ( $id, array $attributes ) : Cartalyst\Sentry\Users\UserInterface
$id
$attributes array
Результат Cartalyst\Sentry\Users\UserInterface

updatePermissions() публичный метод

Update permissions for a given user
Автор: Steve Montambeault
public updatePermissions ( integer $id, array $permissions ) : Cartalyst\Sentry\Users\UserInterface
$id integer
$permissions array
Результат Cartalyst\Sentry\Users\UserInterface

updateThrottleStatus() публичный метод

Автор: Steve Montambeault
public updateThrottleStatus ( $id, $status ) : void
$id
$status
Результат void