ZurmoModuleApiController Class Reference

Inheritance diagram for ZurmoModuleApiController:
ZurmoBaseController Controller AccountAccountAffiliationsAccountAccountAffiliationApiController AccountContactAffiliationsAccountContactAffiliationApiController ContactsContactStateApiController UsersUserApiController ZurmoApiController ZurmoCurrencyApiController ZurmoCustomFieldApiController ZurmoGroupApiController ZurmoPermissionApiController ZurmoRoleApiController ZurmoSecurableItemApiController

Public Member Functions

 filters ()
 filterApiRequest ($filterChain)
 actionRead ()
 actionList ()
 actionListAttributes ()
 actionSearch ()
 actionCreate ()
 actionUpdate ()
 actionDelete ()
 actionAddRelation ()
 actionRemoveRelation ()
 processGetModifiedItems ($params)
 processGetManyManyRelationshipModels ($params)

Data Fields

const RIGHTS_FILTER_PATH = 'application.modules.api.utils.ApiRightsControllerFilter'

Protected Member Functions

 getModelName ()
 processRead ($id)
 processList ($params)
 processListAttributes ($params)
 processSearch ($params)
 getOffsetFromCurrentPageAndPageSize ($currentPage, $pageSize)
 processAddRelation ($params)
 processRemoveRelation ($params)
 processCreate ($data)
 processUpdate ($id, $data)
 resolveModelScenario (array &$data)
 setModelScenarioFromData (RedBeanModel $model, array &$data)
 manageModelRelations ($model, $modelRelations)
 processDelete ($id)
 attemptToSaveModelFromData ($model, $data, $redirectUrlParams=null, $redirect=true)
 preAttemptToSaveModelFromDataHook (RedBeanModel $model, array &$data)
 resolveStateMetadataAdapterClassName ()
 processGetDeletedItems ($params)
 processGetCreatedItems ($params)
 checkPostSizeExceeded ()

Static Protected Member Functions

static getSearchFormClassName ()
static getModelToApiDataUtil ()
static getModelToApiDataUtilData (RedBeanModel $model)
static resolveIncludingAdditionalData (Array &$data)

Detailed Description

Zurmo Modules api controllers should extend this class to provide generic functionality that is applicable to all standard api modules.

Definition at line 42 of file ZurmoModuleApiController.php.


Member Function Documentation

actionRead (  ) 

Get model and send response

Exceptions:
ApiException 

Reimplemented in EmailMessagesEmailMessageApiController, and ZurmoCustomFieldApiController.

Definition at line 72 of file ZurmoModuleApiController.php.

actionList (  ) 

Get array or models and send response

Reimplemented in EmailMessagesEmailMessageApiController.

Definition at line 87 of file ZurmoModuleApiController.php.

actionListAttributes (  ) 

Get array or models and send response

Definition at line 97 of file ZurmoModuleApiController.php.

actionSearch (  ) 

Get array or models and send response

Reimplemented in EmailMessagesEmailMessageApiController.

Definition at line 107 of file ZurmoModuleApiController.php.

actionCreate (  ) 
processRead ( id  )  [protected]

Get model by id

Parameters:
int $id
Exceptions:
ApiException 
Returns:
ApiResult

Reimplemented in ZurmoCustomFieldApiController.

Definition at line 217 of file ZurmoModuleApiController.php.

processList ( params  )  [protected]

List all models that satisfy provided criteria

Parameters:
array $params
Exceptions:
ApiException 
Returns:
ApiResult

Reimplemented in ZurmoCustomFieldApiController.

Definition at line 267 of file ZurmoModuleApiController.php.

processListAttributes ( params  )  [protected]

List all model attributes

Parameters:
$params 
Returns:
ApiResult
Exceptions:
ApiException 

Definition at line 377 of file ZurmoModuleApiController.php.

processSearch ( params  )  [protected]

Search and list all models that satisfy provided criteria

Parameters:
array $params
Exceptions:
ApiException 
Returns:
ApiResult

Definition at line 405 of file ZurmoModuleApiController.php.

getOffsetFromCurrentPageAndPageSize ( currentPage,
pageSize 
) [protected]
Parameters:
$currentPage 
$pageSize 
Returns:
integer || null

Definition at line 507 of file ZurmoModuleApiController.php.

processAddRelation ( params  )  [protected]

Add model relation

Parameters:
array $params
Exceptions:
ApiException 
Returns:
ApiResult

Definition at line 523 of file ZurmoModuleApiController.php.

processRemoveRelation ( params  )  [protected]

Remove model relation

Parameters:
array $params
Exceptions:
ApiException 
Returns:
ApiResult

Definition at line 575 of file ZurmoModuleApiController.php.

processCreate ( data  )  [protected]

Create new model

Parameters:
$data 
Returns:
ApiResult
Exceptions:
ApiException 

Reimplemented in EmailMessagesEmailMessageApiController.

Definition at line 626 of file ZurmoModuleApiController.php.

processUpdate ( id,
data 
) [protected]

Update model

Parameters:
int $id
array $data
Exceptions:
ApiException 
Returns:
ApiResult

Reimplemented in OpportunitiesOpportunityApiController.

Definition at line 683 of file ZurmoModuleApiController.php.

resolveModelScenario ( array &$  data  )  [protected]

Resolve model scenario from data

Parameters:
array $data
Returns:
null

Definition at line 762 of file ZurmoModuleApiController.php.

setModelScenarioFromData ( RedBeanModel model,
array &$  data 
) [protected]

Set model scenario

Parameters:
RedBeanModel $model
array $data

Definition at line 778 of file ZurmoModuleApiController.php.

manageModelRelations ( model,
modelRelations 
) [protected]
Parameters:
RedBeanModel $model
array $modelRelations
Returns:
bool
Exceptions:
ApiException 

Definition at line 793 of file ZurmoModuleApiController.php.

processDelete ( id  )  [protected]

Delete model

Parameters:
int $id
Exceptions:
ApiException 
Returns:
ApiResult

Definition at line 855 of file ZurmoModuleApiController.php.

attemptToSaveModelFromData ( model,
data,
redirectUrlParams = null,
redirect = true 
) [protected]

Instead of saving from post, we are saving from the API data.

See also:
attemptToSaveModelFromPost

Definition at line 897 of file ZurmoModuleApiController.php.

preAttemptToSaveModelFromDataHook ( RedBeanModel model,
array &$  data 
) [protected]

Hook to alter $model or $data before we attempt to save it.

Parameters:
RedBeanModel $model
array $data

Reimplemented in ZurmoSecurableItemApiController.

Definition at line 923 of file ZurmoModuleApiController.php.

static getModelToApiDataUtil (  )  [static, protected]

Util used to convert model to array

Returns:
string

Reimplemented in ZurmoSecurableItemApiController.

Definition at line 931 of file ZurmoModuleApiController.php.

static getModelToApiDataUtilData ( RedBeanModel model  )  [static, protected]

Returns data array for provided model using getModelToApiDataUtil

Parameters:
RedBeanModel $model
Returns:
array

Definition at line 941 of file ZurmoModuleApiController.php.

static resolveIncludingAdditionalData ( Array &$  data  )  [static, protected]

Override if you need to include additional data in API response

Parameters:
array $data
Returns:
array

Reimplemented in MeetingsMeetingApiController.

Definition at line 955 of file ZurmoModuleApiController.php.

resolveStateMetadataAdapterClassName (  )  [protected]

Resolve StateMetadataAdapterClassName

Returns:
mixed

Definition at line 963 of file ZurmoModuleApiController.php.

processGetDeletedItems ( params  )  [protected]

Get array of deleted items since beginning or since datetime in past

Parameters:
array $params
Returns:
ApiResult
Exceptions:
ApiException 

Definition at line 985 of file ZurmoModuleApiController.php.

processGetCreatedItems ( params  )  [protected]

Get array of newly created items since beginning or since datetime in past

Parameters:
$params 
Returns:
ApiResult
Exceptions:
ApiException 

Definition at line 1063 of file ZurmoModuleApiController.php.

processGetModifiedItems ( params  ) 

Get array of modified items since beginning or since datetime in past

Parameters:
$params 
Returns:
ApiResult
Exceptions:
ApiException 

Definition at line 1140 of file ZurmoModuleApiController.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Aug 25 07:11:11 2019