\ApiDataObject
Synopsis
class ApiDataObject
extends DataExtension
{
- // methods
- public static String to_underscore()
- public static void to_camelcase()
- public static void to_nested_array()
- public array inheritedApiFields()
- public static string real_field_name()
- public array forApi()
- public void populateWithData()
- public void populateWithArrayData()
Hierarchy
Extends
- DataExtension
Methods
public
- forApi() — This method is used by `ApiController` to get an array of data for the default output.
- inheritedApiFields() — Array of inherited static desriptions of `api_fields` Copied from @DataOject->inheritedDatabaseFields()
- populateWithArrayData()
- populateWithData() — This method will populate a DataObject with data from a given array (recommend) or DataObject Use this method to apply data from request(s) (body or other parameters)
- real_field_name() — Matches the CamelCase field name of a underscore named field e.g. `user_id` => `UserID`
- to_camelcase()
- to_nested_array() — Convert recursive a mixed array (including DataLists and DataObject) to a pure associative array
- to_underscore() — Transforms a (CamelCase) string to a underscore string