AbstractGetAction
abstract class AbstractGetAction extends AbstractQueryAction
Base class for all "Get" api actions.
Properties
| protected int | $version | Api version number; cannot be changed. | from AbstractAction |
| protected array | $chain | Additional api requests - will be called once per result. | from AbstractAction |
| protected bool | $checkPermissions | Whether to enforce acl permissions based on the current user. | from AbstractAction |
| protected string | $_entityName | from AbstractAction | |
| protected string | $_actionName | from AbstractAction | |
| protected array | $where | Criteria for selecting items. | from AbstractQueryAction |
| protected array | $orderBy | Array of field(s) to use in ordering the results | from AbstractQueryAction |
| protected int | $limit | Maximum number of results to return. | from AbstractQueryAction |
| protected int | $offset | Zero-based index of first result to return. | from AbstractQueryAction |
| protected array | $select | Fields to return. Defaults to all fields. |
Methods
Magic function to provide addFoo, getFoo and setFoo for params.
Get documentation for one or all params
Validates required fields for actions which create a new object.
This function is used internally for evaluating field annotations.
No description
Adds one or more AND/OR/NOT clause groups
A human-readable where clause, for the reading enjoyment of you humans.
Only return the number of found items.
Adds field defaults to the where clause.
Helper to parse the WHERE param for getRecords to perform simple pre-filtering.
Helper to see if a field should be selected by the getRecords function.
Walk through the where clause and check if a field is in use.
No description
Details
in AbstractAction at line 133
__construct(string $entityName, string $actionName)
Action constructor.
in AbstractAction at line 149
__set($name, $value)
Strictly enforce api parameters
in AbstractAction at line 158
$this
setVersion(int $val)
in AbstractAction at line 174
$this
addChain(string $name, AbstractAction $apiRequest, string|int $index = NULL)
in AbstractAction at line 187
AbstractAction|mixed
__call($name, $arguments)
Magic function to provide addFoo, getFoo and setFoo for params.
in AbstractAction at line 231
Result
execute()
Invoke api call.
At this point all the params have been sent in and we initiate the api call & return the result. This is basically the outer wrapper for api v4.
in AbstractAction at line 241
abstract
_run(Result $result)
in AbstractAction at line 247
array
getParams()
Serialize this object's params into an array
in AbstractAction at line 265
array
getParamInfo(string $param = NULL)
Get documentation for one or all params
in AbstractAction at line 282
string
getEntityName()
in AbstractAction at line 290
string
getActionName()
in AbstractAction at line 298
bool
paramExists(string $param)
in AbstractAction at line 305
protected array
getParamDefaults()
in AbstractAction at line 312
offsetExists($offset)
in AbstractAction at line 319
offsetGet($offset)
in AbstractAction at line 344
offsetSet($offset, $value)
in AbstractAction at line 359
offsetUnset($offset)
in AbstractAction at line 373
bool
isAuthorized()
Is this api call permitted?
This function is called if checkPermissions is set to true.
in AbstractAction at line 381
array
getPermissions()
in AbstractAction at line 410
array
entityFields()
Returns schema fields for this entity & action.
Here we bypass the api wrapper and execute the getFields action directly. This is because we DON'T want the wrapper to check permissions as this is an internal op, but we DO want permissions to be checked inside the getFields request so e.g. the api_key field can be conditionally included.
in AbstractAction at line 429
ReflectionClass
reflect()
in AbstractAction at line 443
protected array
checkRequiredFields($values)
Validates required fields for actions which create a new object.
in AbstractAction at line 473
protected bool
evaluateCondition(string $expr, array $vars)
This function is used internally for evaluating field annotations.
It should never be passed raw user input.
in AbstractAction at line 50
bool
getCheckPermissions()
in AbstractAction at line 50
array
getChain()
in AbstractQueryAction at line 104
$this
addWhere(string $field, string $op, mixed $value = NULL)
in AbstractQueryAction at line 122
$this
addClause(string $operator, mixed $condition1)
Adds one or more AND/OR/NOT clause groups
in AbstractQueryAction at line 135
$this
addOrderBy(string $field, string $direction = 'ASC')
in AbstractQueryAction at line 147
protected string
whereClauseToString(array $whereClause = NULL, string $op = 'AND')
A human-readable where clause, for the reading enjoyment of you humans.
in AbstractQueryAction at line 54
array
getWhere()
in AbstractQueryAction at line 54
array
getOrderBy()
in AbstractQueryAction at line 54
int
getLimit()
in AbstractQueryAction at line 54
int
getOffset()
at line 65
$this
selectRowCount()
Only return the number of found items.
at line 78
protected
setDefaultWhereClause()
Adds field defaults to the where clause.
Note: it will skip adding field defaults when fetching records by id, or if that field has already been added to the where clause.
at line 102
protected array|null
_itemsToGet(string $field)
Helper to parse the WHERE param for getRecords to perform simple pre-filtering.
This is intended to optimize some common use-cases e.g. calling the api to get one or more records by name or id.
Ex: If getRecords fetches a long list of items each with a unique name, but the user has specified a single record to retrieve, you can optimize the call by checking $this->_itemsToGet('name') and only fetching the item(s) with that name.
at line 123
protected bool
_isFieldSelected(string $field)
Helper to see if a field should be selected by the getRecords function.
Checks the SELECT, WHERE and ORDER BY params to see what fields are needed.
Note that if no SELECT clause has been set then all fields should be selected and this function will always return TRUE.
at line 137
protected bool
_whereContains(string $field, array $clauses = NULL)
Walk through the where clause and check if a field is in use.