PHP Класс Owl\Services\UserService

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

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

Свойство Тип Описание
$loginTokenRepo Owl\Repositories\LoginTokenRepositoryInterface
$mailNotifyRepo Owl\Repositories\UserMailNotificationRepositoryInterface
$userRepo Owl\Repositories\UserRepositoryInterface

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

Метод Описание
__construct ( Owl\Repositories\UserRepositoryInterface $userRepo, Owl\Repositories\LoginTokenRepositoryInterface $loginTokenRepo, Owl\Repositories\UserMailNotificationRepositoryInterface $mailNotifyRepo )
create ( array $credentials = [] ) : stdclass Create a new user.
getAll ( ) : array
getByEmail ( string $email ) : stdclass Get a user by email.
getById ( integer $id ) : stdclass Get a user by user id.
getByToken ( string $token ) : stdclass Get a user by login token.
getByUsername ( string $username ) : stdclass Get a user by username.
getCurrentUser ( ) : stdclass
getLikeUsername ( string $username ) : stdclass Get users by username like search.
getOwners ( ) : array
getUser ( array $wkey ) : stdClass Get a user by specified keys.
getUsersToArray ( $users ) : array get users array
isOwner ( ) : boolean
update ( integer $id, string $username, string $email, $role ) : stdclass Update a user information(username, email).
updateToken ( integer $userId, string $token ) : boolean Update the "remember me" token by user ID.

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

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

public __construct ( Owl\Repositories\UserRepositoryInterface $userRepo, Owl\Repositories\LoginTokenRepositoryInterface $loginTokenRepo, Owl\Repositories\UserMailNotificationRepositoryInterface $mailNotifyRepo )
$userRepo Owl\Repositories\UserRepositoryInterface
$loginTokenRepo Owl\Repositories\LoginTokenRepositoryInterface
$mailNotifyRepo Owl\Repositories\UserMailNotificationRepositoryInterface

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

Create a new user.
public create ( array $credentials = [] ) : stdclass
$credentials array (email, username, password)
Результат stdclass

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

public getAll ( ) : array
Результат array

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

Get a user by email.
public getByEmail ( string $email ) : stdclass
$email string
Результат stdclass

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

Get a user by user id.
public getById ( integer $id ) : stdclass
$id integer
Результат stdclass

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

Get a user by login token.
public getByToken ( string $token ) : stdclass
$token string
Результат stdclass | bool

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

Get a user by username.
public getByUsername ( string $username ) : stdclass
$username string
Результат stdclass

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

public getCurrentUser ( ) : stdclass
Результат stdclass | bool

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

Get users by username like search.
public getLikeUsername ( string $username ) : stdclass
$username string
Результат stdclass

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

public getOwners ( ) : array
Результат array

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

Get a user by specified keys.
public getUser ( array $wkey ) : stdClass
$wkey array
Результат stdClass | null

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

get users array
public getUsersToArray ( $users ) : array
Результат array

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

public isOwner ( ) : boolean
Результат boolean

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

Update a user information(username, email).
public update ( integer $id, string $username, string $email, $role ) : stdclass
$id integer
$username string
$email string
Результат stdclass

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

Update the "remember me" token by user ID.
public updateToken ( integer $userId, string $token ) : boolean
$userId integer
$token string
Результат boolean

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

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

protected LoginTokenRepositoryInterface,Owl\Repositories $loginTokenRepo
Результат Owl\Repositories\LoginTokenRepositoryInterface

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

protected UserMailNotificationRepositoryInterface,Owl\Repositories $mailNotifyRepo
Результат Owl\Repositories\UserMailNotificationRepositoryInterface

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

protected UserRepositoryInterface,Owl\Repositories $userRepo
Результат Owl\Repositories\UserRepositoryInterface