IUserRepository
extends
IRepository
in
Table of Contents
- all() : array<string|int, Model>
- reads all results of query
- byId() : Model
- Reads specific object by provided id
- delete() : void
- Deletes provided object
- one() : Model
- gets one item from collection
- orderBy() : IRepository
- Enables ordering on results
- register() : int
- Creates new User account
- registerActivity() : void
- Register activity for user with specified userId
- save() : void
- saves state of the user
- search() : IUserRepository
- search for a users with given phrase by name, surname, and email
- setDefaultImage() : void
- sets default image for user
- setPagination() : IRepository
- Sets pagination feature enabled
- where() : IRepository
- Builds WHERE clause of query with provided data of array
- withAccess() : IUserRepository
- enables loading of user access properties
Methods
all()
reads all results of query
public
all() : array<string|int, Model>
Return values
array<string|int, Model> —byId()
Reads specific object by provided id
public
byId(int $id) : Model
Parameters
- $id : int
Tags
Return values
Model —delete()
Deletes provided object
public
delete(Model $object) : void
Parameters
- $object : Model
Return values
void —one()
gets one item from collection
public
one() : Model
Tags
Return values
Model —orderBy()
Enables ordering on results
public
orderBy(string $name[, string $direction = 'DESC' ]) : IRepository
Parameters
- $name : string
- $direction : string = 'DESC'
Return values
IRepository —register()
Creates new User account
public
register(string $name, string $surname, string $email, string $password) : int
Parameters
- $name : string
- $surname : string
- $email : string
- $password : string
Tags
Return values
int —registerActivity()
Register activity for user with specified userId
public
registerActivity(int $userId) : void
Parameters
- $userId : int
Return values
void —save()
saves state of the user
public
save(User $user) : void
Parameters
- $user : User
Tags
Return values
void —search()
search for a users with given phrase by name, surname, and email
public
search(string $phrase) : IUserRepository
Parameters
- $phrase : string
Return values
IUserRepository —setDefaultImage()
sets default image for user
public
setDefaultImage(User $user) : void
Parameters
- $user : User
Return values
void —setPagination()
Sets pagination feature enabled
public
setPagination(Pagination &$pagination) : IRepository
Parameters
- $pagination : Pagination
Return values
IRepository —where()
Builds WHERE clause of query with provided data of array
public
where(array<string|int, mixed> $searchParams) : IRepository
Parameters
- $searchParams : array<string|int, mixed>
Return values
IRepository —withAccess()
enables loading of user access properties
public
withAccess() : IUserRepository