IReservationRepository
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 reservation object
- delete() : void
- Deletes provided object
- deleteAllFutureUserReservations() : void
- forRoom() : void
- Read reservations for specific room
- forUser() : void
- Read reservation for specific user
- fromDate() : void
- Read reservation from given date
- one() : Model
- gets one item from collection
- orderBy() : IRepository
- Enables ordering on results
- save() : void
- Saves reservation object state
- search() : void
- Search given phrase in title and description of reservations
- setPagination() : IRepository
- Sets pagination feature enabled
- where() : IRepository
- Builds WHERE clause of query with provided data of array
- whereAddressAndBuilding() : void
- Read reservations from specific address and building
- whereAddressId() : void
- Read reservations from specific address
- whereBuildingId() : void
- Read reservations from specific building
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 reservation object
public
create(string $title, string $description, int $room, int $user, JsonDateTime $planned_start, JsonDateTime $planned_end) : int
Parameters
- $title : string
- $description : string
- $room : int
- $user : int
- $planned_start : JsonDateTime
- $planned_end : JsonDateTime
Return values
int —delete()
Deletes provided object
public
delete(Model $object) : void
Parameters
- $object : Model
Return values
void —deleteAllFutureUserReservations()
public
deleteAllFutureUserReservations(int $deletedUserId) : void
Parameters
- $deletedUserId : int
Return values
void —forRoom()
Read reservations for specific room
public
forRoom(int $roomId) : void
Parameters
- $roomId : int
Return values
void —forUser()
Read reservation for specific user
public
forUser(int $userId) : void
Parameters
- $userId : int
Return values
void —fromDate()
Read reservation from given date
public
fromDate(JsonDateTime $date) : void
Parameters
- $date : JsonDateTime
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 reservation object state
public
save(Reservation $reservation) : void
Parameters
- $reservation : Reservation
Return values
void —search()
Search given phrase in title and description of reservations
public
search(string $stringToSearch) : void
Parameters
- $stringToSearch : string
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 —whereAddressAndBuilding()
Read reservations from specific address and building
public
whereAddressAndBuilding(int $addressId, int $buildingId) : void
Parameters
- $addressId : int
- $buildingId : int
Return values
void —whereAddressId()
Read reservations from specific address
public
whereAddressId(int $addressId) : void
Parameters
- $addressId : int
Return values
void —whereBuildingId()
Read reservations from specific building
public
whereBuildingId(int $buildingId) : void
Parameters
- $buildingId : int