ApiV4Service
in package
implements
ServiceInterface
Class ApiV4Service
Tags
Table of Contents
Interfaces
- ServiceInterface
- Interface ServiceInterface
Properties
- $config : array<string|int, mixed>
- $endpointResolver : EndpointResolver
- $logger : LoggerInterface
Methods
- __construct() : mixed
- executeQuery() : Result
- executes a query and return the Result model
- getQueryBuilder() : QueryBuilderInterface
- creates a query object
- buildQueryParams() : array<string|int, mixed>
- build query params from args
- buildRequest() : array<string|int, mixed>
- build request
Properties
$config
protected
array<string|int, mixed>
$config
dataCycle configuration
$endpointResolver
protected
EndpointResolver
$endpointResolver
endpointResolver
$logger
protected
LoggerInterface
$logger
logger
Methods
__construct()
public
__construct(array<string|int, mixed> $args[, LoggerInterface|null $logger = null ][, EndpointResolver|null $endpointResolver = null ]) : mixed
Parameters
- $args : array<string|int, mixed>
- $logger : LoggerInterface|null = null
- $endpointResolver : EndpointResolver|null = null
executeQuery()
executes a query and return the Result model
public
executeQuery(QueryBuilderInterface $query[, ModelFactoryInterface|null $modelFactory = null ]) : Result
APIYes
Parameters
- $query : QueryBuilderInterface
- $modelFactory : ModelFactoryInterface|null = null
Tags
Return values
ResultgetQueryBuilder()
creates a query object
public
getQueryBuilder(string $type, array<string|int, mixed> $queryConfiguration) : QueryBuilderInterface
APIYes
Parameters
- $type : string
- $queryConfiguration : array<string|int, mixed>
Return values
QueryBuilderInterfacebuildQueryParams()
build query params from args
private
buildQueryParams([array<string|int, mixed>|null $args = [] ]) : array<string|int, mixed>
Parameters
- $args : array<string|int, mixed>|null = []
Return values
array<string|int, mixed>buildRequest()
build request
private
buildRequest(QueryBuilderInterface $query) : array<string|int, mixed>
Parameters
- $query : QueryBuilderInterface
Return values
array<string|int, mixed> —requestParams