IBuildingRepository
extends
IRepository
in
Table of Contents
- all() : array<string|int, Model>
- reads all results of query
- byId() : Model
- Reads specific object by provided id
- create() : int
- Creates new building
- delete() : void
- Deletes provided object
- one() : Model
- gets one item from collection
- orderBy() : IRepository
- Enables ordering on results
- save() : void
- Saves building state
- setDefaultImage() : void
- sets default image for building
- setPagination() : IRepository
- Sets pagination feature enabled
- where() : IRepository
- Builds WHERE clause of query with provided data of array
- withAddress() : IBuildingRepository
- enable address object loading
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 —create()
Creates new building
public
create(string $name, JsonDateTime $openTime, JsonDateTime $closeTime, int $addressId) : int
Parameters
- $name : string
- $openTime : JsonDateTime
- $closeTime : JsonDateTime
- $addressId : int
Return values
int —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 —save()
Saves building state
public
save(Building $building) : void
Parameters
- $building : Building
Return values
void —setDefaultImage()
sets default image for building
public
setDefaultImage(Building $building) : void
Parameters
- $building : Building
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 —withAddress()
enable address object loading
public
withAddress() : IBuildingRepository