|
package
|
HttpSource
|
|
subpackage
|
Config
|
Methods
Constructor
__construct(\HttpSourceConfigFactory $ConfigFactory)
inherited
Buils query parameters
_buildQuery(\Model $model, array $usedConditions, array $queryData)
Arguments
$usedConditions
arrayList of conditions that must present in query
$queryData
arrayQuery data: conditions, limit, etc
If true conditions by default will be sent in query, otherwize in body
_mustSendInQuery(\Model $model) : boolean
Arguments
Response
boolean
Apply renaming and callbacks to items
_process(array $items, array $storage, \Model $model) : array
Process conditions mappings as set by condition->map() method
_processConditions(\Model $model, array &$conditions)
Process read parameters. Eq: map limit parameter to some condition
_processReadParams(\Model $model, array &$params)
Add new conditions
addCondition(\HttpSourceCondition $Condition) : \HttpSourceEndpoint
Add new field
addField(\HttpSourceField $Field) : \HttpSourceEndpoint
Build request and store it in model->request
buildRequest(\Model $model, array $queryData)
Set or get endpoint cache name
cacheName(string $name = null) : \HttpSourceEndpoint
Get condition by name, if condition not exists
create, add and return new
condition(string $name) : \HttpSourceCondition
Returns associative list of default condition names
and values
conditionsDefaults() : array
Get field by name, if field not exists
create, add and return new
field(string $name) : \HttpSourceCondition
Retunrn config factory
getConfigFactory() : \HttpSourceConfigFactory
inherited
Set or get endpoint id
id(integer $id = null) : \HttpSourceEndpoint
Get endpoint method
method() : \HttpSourceEndpoint
Set endpoint method to 'check'
methodCheck() : \HttpSourceEndpoint
Set endpoint method to 'create'
methodCreate() : \HttpSourceEndpoint
Set endpoint method to 'delete'
methodDelete() : \HttpSourceEndpoint
Set endpoint method to 'read'
methodRead() : \HttpSourceEndpoint
Set endpoint method to 'update'
methodUpdate() : \HttpSourceEndpoint
Returns list of optional condition names
optionalConditions() : array
Set or get endpoint path
path(string $name = null) : \HttpSourceEndpoint
Process field mappings as set by field->map() method
processFields(\Model $model, array &$results)
Process results with result handler
processResult(\Model $model, array &$result)
Set or get endpoint query builder instead of _buildQuery
queryBuilder(callable $queryBuilder = null) : \HttpSourceEndpoint
Set or get endpoint mapped read param
readParams(array $params = null) : \HttpSourceEndpoint
Set or get endpoint request splitter
requestSplitter(callable $requestSplitter = null) : \HttpSourceEndpoint
Returns list of required condition names
requiredConditions() : array
Set or get endpoint response joiner
responseJoiner(callable $responseJoiner = null) : \HttpSourceEndpoint
Set or get endpoint result handler
result(\HttpSourceResult $Result = null) : \HttpSourceEndpoint
Build schema array to describe endpoint
schema() : array
Set or get endpoint table
table(string $name = null) : \HttpSourceEndpoint
Constants
CRUD constants
METHOD_READ
METHOD_CREATE
METHOD_CREATE
METHOD_UPDATE
METHOD_UPDATE
METHOD_DELETE
METHOD_DELETE
METHOD_CHECK
METHOD_CHECK
Properties
Endpoint CRUD method
_method : string
Table name
_table : string
Endpoint path
_path : string
Endpoint fields
_fields : array
Endpoint conditions
_conditions : array
Endpoint result handler
_result : \HttpSourceResult
Mapped read params (limit, offset, etc)
_readParams : array
Endpoint id
_id : integer
Function for splitting request
_requestSplitter : callable
Function to join results of splitted requests
_responseJoiner : callable
Function to build query instead of _buildQuery
_queryBuilder : callable
Cache name for store requests. If null cache not used.
_cacheName : string
Cache works only for read method
This setting will override global cache from config
Type(s)
string
Config factory instance
_ConfigFactory : \HttpSourceConfigFactory
inherited