$idParamName
$idParamName
This is the base class for all API controller classes.
Each application REST API controller class extends this class for inheriting common for API controller methods and properties.
$contentRange : array
getView(boolean $sendToEndUser, integer $recordId) : array
Function send response with record attributes or 404 error if no record found.
| boolean | $sendToEndUser | Whether the response should be sent to the end user or should be returned as an array. |
| integer | $recordId | priority record id. |
result. Null if the result sended to end user.
getList(boolean $sendToEndUser) : array
Function send response with list of record attributes or empty array if no record found.
| boolean | $sendToEndUser | Whether the response should be sent to the end user or should be returned as an array. |
result. Null if the result sended to end user.
create(boolean $sendToEndUser) : array
Function crates new record or collection of records.
| boolean | $sendToEndUser | Whether the response should be sent to the end user or should be returned as an array. |
with new record attributes. Null if the result sended to end user.
update(boolean $sendToEndUser, int $id) : array
Function updates existing record or collection of records.
| boolean | $sendToEndUser | Whether the response should be sent to the end user or should be returned as an array. |
| int | $id | record id. |
with updted record attributes. Null if the result sended to end user.
delete(boolean $sendToEndUser) : array
Function deletes record. If $id is null then delete all records.
Deleted records can be filtered by 'filter' and 'search' params.
| boolean | $sendToEndUser | Whether the response should be sent to the end user or should be returned as an array. |
result. Null if the result sended to end user.
getModel(\CActiveRecord $model, int $id, boolean $newIfNull) : \CActiveRecord
Function returns CActiveRecord model.
If param $id is not passed than return new model. If model not found by id then send response with 404 error code and terminate app if $this->sendToEndUser is true.
| \CActiveRecord | $model | Model class instance |
| int | $id | id attribute for which you want to find a record. |
| boolean | $newIfNull | create new model in $id is null. If $id is not set then return empty model |
model
getModelsForAffect(boolean $refresh, boolean $fillModels) : array
Function returns array of models which will be affected (update or delete) or array of new models on create request
| boolean | $refresh | Find models or return from cache. |
| boolean | $fillModels | Whether to fill the model attributes. |
Models that have to be affected.
validate(boolean $sendToEndUser) : boolean
Performs the validation.
This method executes the validation rules as declared in model rules. Only the rules applicable to the current scenario will be executed.
Errors found during the validation can be retrieved via {@link getModelErrors}.
| boolean | $sendToEndUser | Whether the response should be sent to the end user or should be returned as an array. |
whether the validation is successful without any error.
getParam(string $name, mixed $defaultValue) : mixed
Returns the named GET or POST parameter value.
If the GET or POST parameter does not exist, the second parameter to this method will be returned. If both GET and POST contains such a named parameter, the GET parameter takes precedence.
| string | $name | the GET parameter name |
| mixed | $defaultValue | the default parameter value if the GET parameter does not exist. |
the parameter value
getBaseCriteria(boolean $refresh) : \CDbCriteria
Function returns base criteria wich will be used for searching models.
Parameters of this criteria will be used for records when searching, updating and deleting data.
| boolean | $refresh | whether to reload cached _baseCriteria prop. |
setResponseProvider(\ApiResponseProvider $responseProvider)
| \ApiResponseProvider | $responseProvider |
sendJson(array $data, int $status, array $headers) : null
Function convert $data array to json string, sends it to client and terminates the application.
Usage example:
$this->sendJson(
array(...),
200,
array(
"Content-Range: items $offset-$limit/$total",
...
)
);
| array | $data | |
| int | $status | code. |
| array | $headers | http headers array. |
sendData(array $data, integer $status, array $headers)
Function send data to end user and terminate the application.
Format of data defined based on {@link responseProvider}
| array | $data | Data to be sent |
| integer | $status | Status code (e.g. 200 or 403) |
| array | $headers | List of additional headers to use when sending an response |
processFilter(string $data) : array
Function processes filter data from request to array.
| string | $data | json decoded data
[{"name":"admin","description":"administrator"},{"name":"guest","description":"Гость"}]
|
array(
array{
'name' => 'admin',
'description' => 'administrator'
),
array(
'name' => 'guest',
'description' => 'Гость'
)
)
getFilterCriteria(boolean $partialMatch, array $filterData) : \CDbCriteria
Function creates criteria from filter data in request GET paramseters
| boolean | $partialMatch | Whether the value should consider partial text match (using LIKE and NOT LIKE operators). Defaults to false, meaning exact comparison. |
| array | $filterData | Example:
array(
array(
'name' => 'admin',
'description' => 'administrator'
),
array(
'name' => 'guest',
'description' => 'Гость'
)
)
From this array will be created follow condition: If $partialMatch = false string '((name='admin') AND (description='administrator')) OR ((name='guest') AND (description='Гость'))' If $partialMatch = true string '((name LIKE 'admin') AND (description LIKE 'administrator')) OR ((name LIKE 'guest') AND (description LIKE 'Гость'))' |
parseFilterObject(object $filter) : array
Function convert json decoded object to array
| object | $filter | json decoded object
object(stdClass)
public 'name' => string 'guest'
public 'description' => string 'Гость'
|
array( 'name' => 'guest', 'description' => 'Гость' )
returnResult(array $result, array $headers) : array
Function returns result of operation depends on $this->sendToEndUser property.
If $this->sendToEndUser is true, then result will be sended to end user and application will be terminated.
If $this->sendToEndUser is false, then result will be returned as array.
| array | $result | |
| array | $headers | http headers array. |