GetFields

Basic Get constructor.

Strictly enforce api parameters

Magic function to provide addFoo, getFoo and setFoo for params.

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.

To implement getFields for your own entity:

1. From your entity class add a static getFields method.
2. That method should construct and return this class.
3. The 3rd argument passed to this constructor should be a function that returns an array of fields for your entity's CRUD actions.
4. For non-crud actions that need a different set of fields, you can override the list from step 3 on a per-action basis by defining a fields() method in that action. See for example BasicGetFieldsAction::fields() or GetActions::fields().

Serialize this object's params into an array

Get documentation for one or all params

Is this api call permitted?

This function is called if checkPermissions is set to true.

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.

Validates required fields for actions which create a new object.

This function is used internally for evaluating field annotations.

It should never be passed raw user input.

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.

Note: it will skip adding field defaults when fetching records by id, or if that field has already been added to the where clause.

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.

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.

Walk through the where clause and check if a field is in use.

This Basic Get class is a general-purpose api for non-DAO-based entities.

Useful for fetching records from files or other places. You can specify any php function to retrieve the records, and this class will automatically filter, sort, select & limit the raw data from your callback.

You can implement this action in one of two ways: 1. Use this class directly by passing a callable ($getter) to the constructor. 2. Extend this class and override this function.

Either way, this function should return an array of arrays, each representing one retrieved object.

The simplest thing for your getter function to do is return every full record and allow this class to automatically do the sorting and filtering.

Sometimes however that may not be practical for performance reasons. To optimize your getter, it can use the following helpers from $this:

Use this->_itemsToGet() to match records to field values in the WHERE clause. Note the WHERE clause can potentially be very complex and it is not recommended to parse $this->where yourself.

Use $this->_isFieldSelected() to check if a field value is called for - useful if loading the field involves expensive calculations.

Be careful not to make assumptions, e.g. if LIMIT 100 is specified and your getter "helpfully" truncates the list at 100 without accounting for WHERE, ORDER BY and LIMIT clauses, the final filtered result may be very incorrect.

Ensure every result contains, at minimum, the array keys as defined in $this->fields.

Attempt to set some sensible defaults for some fields.

In most cases it's not necessary to override this function, even if your entity is really weird. Instead just override $this->fields and thes function will respect that.