Ubiquity 2.5.2
php rapid development framework
Loading...
Searching...
No Matches
RestControllerUtilitiesTrait Class Reference
+ Inheritance diagram for RestControllerUtilitiesTrait:

Public Member Functions

 _setResponseCode ($value)
 
 _validateInstance ($instance, $members, $excludedValidators=[])
 

Protected Member Functions

 getDatas ()
 
 getRequestParam ($param, $default)
 
 operate_ ($instance, $callback, $status, $exceptionMessage, $keyValues)
 
 generatePagination (&$filter, $pageNumber, $pageSize)
 
 updateOperation ($instance, $datas, $updateMany=false)
 
 addOperation ($instance, $datas, $insertMany=false)
 
 _getResponseFormatter ()
 
 getResponseFormatter ()
 To override, returns the active formatter for the response.
 
 _getRequestFormatter ()
 
 getRequestFormatter ()
 To override, returns the active formatter for the request.
 
 _getRestServer ()
 
 getRestServer ()
 To override, returns the active RestServer.
 
 _setValuesToObject ($instance, $values=[])
 Updates $instance with $values To eventually be redefined in derived classes.
 
 updateManyToOne ($manyToOneRelations, $members, $className, $instance, $values)
 
 getInclude ($include)
 
 addError ($code, $title, $detail=null, $source=null, $status=null)
 
 hasErrors ()
 
 displayErrors ()
 
 getAssociatedMemberValues_ ($ids, $getDatas, $member, $include=false, $useCache=false, $multiple=true)
 
 addViolation (ConstraintViolation $violation)
 
 getPrimaryKeysFromDatas ($datas, $model)
 
 getCondition ($condition)
 

Protected Attributes

 $errors
 

Detailed Description

Definition at line 30 of file RestControllerUtilitiesTrait.php.

Member Function Documentation

◆ _getRequestFormatter()

_getRequestFormatter ( )
protected
Returns
\Ubiquity\controllers\rest\formatters\RequestFormatter

Definition at line 113 of file RestControllerUtilitiesTrait.php.

◆ _getResponseFormatter()

_getResponseFormatter ( )
protected
Returns
\Ubiquity\controllers\rest\formatters\ResponseFormatter

Definition at line 93 of file RestControllerUtilitiesTrait.php.

◆ _getRestServer()

_getRestServer ( )
protected

Definition at line 129 of file RestControllerUtilitiesTrait.php.

◆ _setResponseCode()

_setResponseCode (   $value)
abstract

Reimplemented in RestBaseController.

◆ _setValuesToObject()

_setValuesToObject (   $instance,
  $values = [ ] 
)
protected

Updates $instance with $values To eventually be redefined in derived classes.

Parameters
object$instancethe instance to update
array$values

Definition at line 153 of file RestControllerUtilitiesTrait.php.

◆ _validateInstance()

_validateInstance (   $instance,
  $members,
  $excludedValidators = [ ] 
)

Definition at line 245 of file RestControllerUtilitiesTrait.php.

◆ addError()

addError (   $code,
  $title,
  $detail = null,
  $source = null,
  $status = null 
)
protected

Definition at line 199 of file RestControllerUtilitiesTrait.php.

◆ addOperation()

addOperation (   $instance,
  $datas,
  $insertMany = false 
)
protected

Definition at line 85 of file RestControllerUtilitiesTrait.php.

◆ addViolation()

addViolation ( ConstraintViolation  $violation)
protected

Definition at line 260 of file RestControllerUtilitiesTrait.php.

◆ displayErrors()

displayErrors ( )
protected

Definition at line 207 of file RestControllerUtilitiesTrait.php.

◆ generatePagination()

generatePagination ( $filter,
  $pageNumber,
  $pageSize 
)
protected

Definition at line 66 of file RestControllerUtilitiesTrait.php.

◆ getAssociatedMemberValues_()

getAssociatedMemberValues_ (   $ids,
  $getDatas,
  $member,
  $include = false,
  $useCache = false,
  $multiple = true 
)
protected
Parameters
string$idsThe primary key values (comma separated if pk is multiple)
callable$getDatas
string$memberThe member to load
boolean | string$includeif true, loads associate members with associations, if string, example : client.*,commands
boolean$useCache
boolean$multiple
Exceptions

Exception

Definition at line 234 of file RestControllerUtilitiesTrait.php.

◆ getCondition()

getCondition (   $condition)
protected

Definition at line 277 of file RestControllerUtilitiesTrait.php.

◆ getDatas()

getDatas ( )
protected

Definition at line 35 of file RestControllerUtilitiesTrait.php.

◆ getInclude()

getInclude (   $include)
protected
Parameters
string | boolean$include
Returns
array|boolean

Definition at line 192 of file RestControllerUtilitiesTrait.php.

◆ getPrimaryKeysFromDatas()

getPrimaryKeysFromDatas (   $datas,
  $model 
)
protected

Definition at line 264 of file RestControllerUtilitiesTrait.php.

◆ getRequestFormatter()

getRequestFormatter ( )
protected

To override, returns the active formatter for the request.

Returns
\Ubiquity\controllers\rest\formatters\RequestFormatter

Reimplemented in JsonRestController, and JsonApiRestController.

Definition at line 125 of file RestControllerUtilitiesTrait.php.

◆ getRequestParam()

getRequestParam (   $param,
  $default 
)
protected
Parameters
string$param
string | boolean$default
Returns
string|boolean

Definition at line 45 of file RestControllerUtilitiesTrait.php.

◆ getResponseFormatter()

getResponseFormatter ( )
protected

To override, returns the active formatter for the response.

Returns
\Ubiquity\controllers\rest\formatters\ResponseFormatter

Reimplemented in JsonRestController.

Definition at line 105 of file RestControllerUtilitiesTrait.php.

◆ getRestServer()

getRestServer ( )
protected

To override, returns the active RestServer.

Returns
\Ubiquity\controllers\rest\RestServer

Reimplemented in JsonApiRestController.

Definition at line 141 of file RestControllerUtilitiesTrait.php.

◆ hasErrors()

hasErrors ( )
protected

Definition at line 203 of file RestControllerUtilitiesTrait.php.

◆ operate_()

operate_ (   $instance,
  $callback,
  $status,
  $exceptionMessage,
  $keyValues 
)
protected

Definition at line 49 of file RestControllerUtilitiesTrait.php.

◆ updateManyToOne()

updateManyToOne (   $manyToOneRelations,
  $members,
  $className,
  $instance,
  $values 
)
protected

Definition at line 171 of file RestControllerUtilitiesTrait.php.

◆ updateOperation()

updateOperation (   $instance,
  $datas,
  $updateMany = false 
)
protected

Definition at line 81 of file RestControllerUtilitiesTrait.php.

Field Documentation

◆ $errors

$errors
protected

Definition at line 31 of file RestControllerUtilitiesTrait.php.


The documentation for this class was generated from the following file: