ApiClientInterface
in
Interface for api client.
Tags
Table of Contents
Methods
- createQueryBuilder() : QueryBuilderInterface
- creates a query object
- execute() : Result
- executes a query and return the Result model
- getConfiguration() : array<string|int, mixed>
- get the current Api client configuration
Methods
createQueryBuilder()
creates a query object
public
createQueryBuilder([string $type = 'list' ][, array<string|int, mixed> $queryConfiguration = [] ]) : QueryBuilderInterface
APIYes
Parameters
- $type : string = 'list'
- $queryConfiguration : array<string|int, mixed> = []
Return values
QueryBuilderInterfaceexecute()
executes a query and return the Result model
public
execute(QueryBuilderInterface $query, ModelFactoryInterface|null $modelFactory) : Result
APIYes
Parameters
- $query : QueryBuilderInterface
- $modelFactory : ModelFactoryInterface|null
Return values
ResultgetConfiguration()
get the current Api client configuration
public
getConfiguration() : array<string|int, mixed>
APIYes