RavSystem API docs

IAccessRepository extends IRepository

Table of Contents

all()  : array<string|int, Model>
reads all results of query
byId()  : Model
Reads specific object by provided id
create()  : int
{@inheritDoc}
delete()  : void
Deletes provided object
one()  : Model
gets one item from collection
orderBy()  : IRepository
Enables ordering on results
save()  : void
Saves access calss state
setPagination()  : IRepository
Sets pagination feature enabled
where()  : IRepository
Builds WHERE clause of query with provided data of array

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
throws
DomainRecordNotFoundException
Return values
Model

create()

{@inheritDoc}

public create(string $name, bool $owner, bool $accessAdmin, bool $premisesAdmin, bool $keysAdmin, bool $reservationsAdmin, bool $reservationsAbility, bool $logsAdmin, bool $statsViewer) : int
Parameters
$name : string
$owner : bool
$accessAdmin : bool
$premisesAdmin : bool
$keysAdmin : bool
$reservationsAdmin : bool
$reservationsAbility : bool
$logsAdmin : bool
$statsViewer : bool
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
throws
DomainRecordNotFoundException
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

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

Search results