ApiClientService
extends ApiService
in package
Admin service that delegates reads to the mapper.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- create() : Result
- delete() : Result
- deleteAll() : Result
- deleteKey() : Result
- find() : T|null
- Finds one entity by id.
- findAll() : T>, 1: int}
- Finds all entities matching the criteria.
- findBy() : T|null
- Finds one entity by filters.
- getClient() : array<string, mixed>|null
-
getOverview()
: array{clients: list
- getRoleOptions() : array<int, array<string, mixed>>
- getTotalCount() : int|null
- issueKey() : Result
- revoke() : Result
- revokeKey() : Result
- save() : Result
- setEnabled() : Result
- update() : Result
- updateColumns() : Result
- updateKey() : Result
Properties
$mapper read-only
protected
ApiClientMapper
$mapper
Methods
__construct()
public
__construct(ApiClientMapper $mapper) : mixed
Parameters
- $mapper : ApiClientMapper
create()
public
create(array<string, mixed> $values) : Result
Parameters
- $values : array<string, mixed>
Return values
Resultdelete()
public
delete(int|array<string|int, mixed> $id) : Result
Parameters
- $id : int|array<string|int, mixed>
Return values
ResultdeleteAll()
public
deleteAll([array<string|int, mixed> $filters = [] ]) : Result
Parameters
- $filters : array<string|int, mixed> = []
Return values
ResultdeleteKey()
public
deleteKey(int $id, int $keyId) : Result
Parameters
- $id : int
- $keyId : int
Return values
Resultfind()
Finds one entity by id.
public
find(int $id[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
- $id : int
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
T|nullfindAll()
Finds all entities matching the criteria.
public
findAll([array<string|int, mixed>|null $filters = [] ][, array<string|int, mixed>|null $orderBys = null ][, int|null $offset = null ][, int|null $limit = null ][, array<string|int, mixed>|null $columns = null ][, bool $computeTotalCount = false ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T>, 1: int}
Parameters
- $filters : array<string|int, mixed>|null = []
- $orderBys : array<string|int, mixed>|null = null
- $offset : int|null = null
- $limit : int|null = null
- $columns : array<string|int, mixed>|null = null
- $computeTotalCount : bool = false
- $includes : string|array<string|int, mixed> = []
- $useCache : bool|null = null
Return values
T>, 1: int}findBy()
Finds one entity by filters.
public
findBy([array<string|int, mixed>|null $filters = [] ][, string|array<string|int, mixed>|null $includes = [] ][, bool|null $useCache = null ]) : T|null
Parameters
- $filters : array<string|int, mixed>|null = []
- $includes : string|array<string|int, mixed>|null = []
- $useCache : bool|null = null
Return values
T|nullgetClient()
public
getClient(int $id) : array<string, mixed>|null
Parameters
- $id : int
Return values
array<string, mixed>|nullgetOverview()
public
getOverview() : array{clients: list>, defaultLimits: array}|null
Return values
array{clients: listgetRoleOptions()
public
getRoleOptions() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>getTotalCount()
public
getTotalCount() : int|null
Return values
int|nullissueKey()
public
issueKey(int $id, string|null $label, string|null $expiresAt) : Result
Parameters
- $id : int
- $label : string|null
- $expiresAt : string|null
Return values
Resultrevoke()
public
revoke(int $id) : Result
Parameters
- $id : int
Return values
ResultrevokeKey()
public
revokeKey(int $id, int $keyId) : Result
Parameters
- $id : int
- $keyId : int
Return values
Resultsave()
public
save(BaseEntity $entity[, array<string, mixed> $meta = [] ][, array<int, string> $skipFields = [] ]) : Result
Parameters
- $entity : BaseEntity
- $meta : array<string, mixed> = []
- $skipFields : array<int, string> = []
Return values
ResultsetEnabled()
public
setEnabled(int $id, bool $enabled) : Result
Parameters
- $id : int
- $enabled : bool
Return values
Resultupdate()
public
update(int $id, array<string, mixed> $values) : Result
Parameters
- $id : int
- $values : array<string, mixed>
Return values
ResultupdateColumns()
public
updateColumns(array<string|int, mixed> $ids, array<string, mixed> $values) : Result
Parameters
- $ids : array<string|int, mixed>
-
ids or composite-id arrays
- $values : array<string, mixed>
-
property name => new value
Return values
ResultupdateKey()
public
updateKey(int $id, int $keyId, string|null $label, string|null $expiresAt) : Result
Parameters
- $id : int
- $keyId : int
- $label : string|null
- $expiresAt : string|null