\RESTfulAPI_DefaultQueryHandler
Default RESTfulAPI Query handler handles models request etc...
- Author: Thierry Francois @colymba thierry@colymba.com
- Copyright: Copyright (c) 2013, Thierry Francois
- License: http://opensource.org/licenses/BSD-3-Clause BSD Simplified
Synopsis
class RESTfulAPI_DefaultQueryHandler
implements
RESTfulAPI_QueryHandler
{
- // members
- public RESTfulAPI_DeSerializer $deSerializer;
- private static array $dependencies = ;
- private static string $searchFilterModifiersSeparator = '__';
- private static array $skipedQueryParameters = ;
- private static integer $max_records_limit = 100;
- public array $requestedData = ;
- // methods
- public RESTfulAPI_DeSerializer getdeSerializer()
- public DataObjec|DataList handleQuery()
- public array parseQueryParameters()
- public DataObject|DataList findModel()
- public DataObject createModel()
- public DataObject updateModel()
- public NULL|array deleteModel()
Hierarchy
Implements
Tasks
Line | Task |
---|---|
466+ | Respond with a 204 status message on success? |
Members
private
- $dependencies
—
array
Injector dependencies Override in configuration to use your custom classes - $max_records_limit
—
integer
Set a maximum numbers of records returned by the API. - $searchFilterModifiersSeparator
—
string
Search Filter Modifiers Separator used in the query var i.e. ?column__EndsWith=value - $skipedQueryParameters
—
array
Query vars to skip (uppercased)
public
- $deSerializer
—
RESTfulAPI_DeSerializer
Current deSerializer instance - $requestedData
—
array
Stores the currently requested data
Methods
public
- createModel() — Create object of class $model
- deleteModel() — Delete object of Class $model and ID $id
- findModel() — Finds 1 or more objects of class $model
- getdeSerializer() — Return current RESTfulAPI DeSerializer instance
- handleQuery() — All requests pass through here and are redirected depending on HTTP verb and params
- parseQueryParameters() — Parse the query parameters to appropriate Column, Value, Search Filter Modifiers array( array( 'Column' => ColumnName, 'Value' => ColumnValue, 'Modifier' => ModifierType ) )
- updateModel() — Update databse record or $model