PHP Class Owl\Services\UserService

Inheritance: extends Service
Afficher le fichier Open project: owl/owl Class Usage Examples

Protected Properties

Свойство Type Description
$loginTokenRepo Owl\Repositories\LoginTokenRepositoryInterface
$mailNotifyRepo Owl\Repositories\UserMailNotificationRepositoryInterface
$userRepo Owl\Repositories\UserRepositoryInterface

Méthodes publiques

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

Method Details

__construct() public méthode

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() public méthode

Create a new user.
public create ( array $credentials = [] ) : stdclass
$credentials array (email, username, password)
Résultat stdclass

getAll() public méthode

public getAll ( ) : array
Résultat array

getByEmail() public méthode

Get a user by email.
public getByEmail ( string $email ) : stdclass
$email string
Résultat stdclass

getById() public méthode

Get a user by user id.
public getById ( integer $id ) : stdclass
$id integer
Résultat stdclass

getByToken() public méthode

Get a user by login token.
public getByToken ( string $token ) : stdclass
$token string
Résultat stdclass | bool

getByUsername() public méthode

Get a user by username.
public getByUsername ( string $username ) : stdclass
$username string
Résultat stdclass

getCurrentUser() public méthode

public getCurrentUser ( ) : stdclass
Résultat stdclass | bool

getLikeUsername() public méthode

Get users by username like search.
public getLikeUsername ( string $username ) : stdclass
$username string
Résultat stdclass

getOwners() public méthode

public getOwners ( ) : array
Résultat array

getUser() public méthode

Get a user by specified keys.
public getUser ( array $wkey ) : stdClass
$wkey array
Résultat stdClass | null

getUsersToArray() public méthode

get users array
public getUsersToArray ( $users ) : array
Résultat array

isOwner() public méthode

public isOwner ( ) : boolean
Résultat boolean

update() public méthode

Update a user information(username, email).
public update ( integer $id, string $username, string $email, $role ) : stdclass
$id integer
$username string
$email string
Résultat stdclass

updateToken() public méthode

Update the "remember me" token by user ID.
public updateToken ( integer $userId, string $token ) : boolean
$userId integer
$token string
Résultat boolean

Property Details

$loginTokenRepo protected_oe property

protected LoginTokenRepositoryInterface,Owl\Repositories $loginTokenRepo
Résultat Owl\Repositories\LoginTokenRepositoryInterface

$mailNotifyRepo protected_oe property

protected UserMailNotificationRepositoryInterface,Owl\Repositories $mailNotifyRepo
Résultat Owl\Repositories\UserMailNotificationRepositoryInterface

$userRepo protected_oe property

protected UserRepositoryInterface,Owl\Repositories $userRepo
Résultat Owl\Repositories\UserRepositoryInterface