Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Protected Member Functions | Static Protected Member Functions
ZurmoSecurableItemApiController Class Reference
Inheritance diagram for ZurmoSecurableItemApiController:
ZurmoModuleApiController ZurmoBaseController Controller AccountsAccountApiController ApiTestModelItem2ApiController ApiTestModelItemApiController ContactsContactApiController EmailMessagesEmailMessageApiController LeadsContactApiController MeetingsMeetingApiController NotesNoteApiController OpportunitiesOpportunityApiController TasksTaskApiController

Protected Member Functions

 preAttemptToSaveModelFromDataHook (RedBeanModel $model, array &$data)
 
- Protected Member Functions inherited from ZurmoModuleApiController
 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 ()
 
- Protected Member Functions inherited from ZurmoBaseController
 makeActionBarSearchAndListView ($searchModel, $dataProvider, $actionBarViewClassName= 'SecuredActionBarForSearchAndListView', $viewPrefixName=null, $activeActionElementType=null, IntroView $introView=null)
 
 makeActionBarAndListView ($listModel, $dataProvider, $actionBarViewClassName= 'ActionBarForSearchAndListView', $viewPrefixName=null, $activeActionElementType=null)
 
 makeListView (SearchForm $searchForm, $dataProvider, $listViewClassName=null)
 
 resolveSearchDataProvider ($searchModel, $pageSize, $stateMetadataAdapterClassName=null, $stickySearchKey=null, $setSticky=true)
 
 resolveToTriggerOnSearchEvents ($listModelClassName)
 
 getDataProviderByResolvingSelectAllFromGet ($searchModel, $pageSize, $userId, $stateMetadataAdapterClassName=null, $stickySearchKey=null)
 
 processMassEdit ($pageSize, $activeAttributes, $selectedRecordCount, $pageViewClassName, $listModel, $title, $dataProvider=null)
 
 processMassEditProgressSave ($modelClassName, $pageSize, $title, $dataProvider=null)
 
 makeMassEditProgressView ($model, $page, $selectedRecordCount, $start, $pageSize, $title, $skipCount)
 
 saveMassEdit ($modelClassName, $postVariableName, $selectedRecordCount, $dataProvider, $page, $pageSize)
 
 processMassDelete ($pageSize, $activeAttributes, $selectedRecordCount, $pageViewClassName, $listModel, $title, $dataProvider=null, $redirectUrl=null)
 
 processMassDeleteProgress ($modelClassName, $pageSize, $title, $dataProvider=null)
 
 makeMassDeleteProgressView ($model, $page, $selectedRecordCount, $start, $pageSize, $title, $skipCount)
 
 doMassDelete ($modelClassName, $postVariableName, $selectedRecordCount, $dataProvider, $page, $pageSize)
 
 resolveReturnUrlForMassAction ()
 
 attemptToSaveModelFromPost ($model, $redirectUrlParams=null, $redirect=true, $returnOnValidate=false)
 
 actionAfterSuccessfulModelSave ($model, $modelToStringValue, $redirectUrlParams=null)
 
 redirectAfterSaveModel ($modelId, $urlParams=null)
 
 triggerMassAction ($modelClassName, $searchForm, $pageView, $title, $searchView=null, $stateMetadataAdapterClassName=null, $useModuleClassNameForItemLabel=true)
 
 massActionProgress ($model, $pageSize, $title, $actionId, $dataProvider)
 
 massAction ($model, $pageSize, $title, $pageView, $actionId, $dataProvider, $useModuleClassNameForItemLabel=true)
 
 processMassAction ($pageSize, $selectedRecordCount, $pageViewClassName, $listModel, $title, $actionId, $dataProvider=null)
 
 makeMassActionView ($model, $activeAttributes, $selectedRecordCount, $title, $actionId, $useModuleClassNameForItemLabel=true)
 
 processMassActionProgress ($listModel, $pageSize, $title, $actionId, $dataProvider=null)
 
 makeMassActionProgressView ($model, $page, $selectedRecordCount, $start, $pageSize, $title, $skipCount, $actionId)
 
 resolveParamsForMassProgressView ()
 
 resolveActiveElementTypeForKanbanBoard (SearchForm $searchForm)
 
 resolveActiveElementTypeForKanbanBoardInDetailView ($detailsAndRelationsView)
 
 resolveKanbanBoardIsActiveByGetForDetailsView ($detailsAndRelationsView)
 
 beforeRedirect ($model)
 
 makeSearchAndListView ($searchModel, $moduleName, $dataProvider)
 
- Protected Member Functions inherited from Controller
 resolveKanbanBoardMetadataBeforeMakingDataProvider ($searchForm, &$metadata)
 
 resolveFilteredByMetadataBeforeMakingDataProvider ($searchForm, &$metadata)
 
 resolveMetadataBeforeMakingDataProvider (&$metadata)
 
 makeDetailsAndRelationsView ($model, $moduleClassName, $viewClassName, $redirectUrl, $breadCrumbView=null)
 
 resolveAdditionalParametersForDetailsAndRelationsView ($viewClassName)
 
 makeTitleBarAndEditAndDetailsView ($model, $renderType, $titleBarAndEditViewClassName= 'TitleBarAndEditAndDetailsView')
 
 makeEditAndDetailsView ($model, $renderType)
 
 makeTitleBarAndEditView ($model, $titleBarAndEditViewClassName)
 
 makeTitleBarAndDetailsView ($model, $titleBarAndDetailsViewClassName= 'TitleBarAndDetailsView')
 
 resolveActiveAttributesFromMassEditPost ()
 
 resolveActiveAttributesFromMassDeletePost ()
 
 makeMassEditView ($model, $activeAttributes, $selectedRecordCount, $title)
 
 makeMassDeleteView ($model, $activeAttributes, $selectedRecordCount, $title, $massDeleteViewClassName= 'MassDeleteView', $useModuleClassNameForItemLabel=true)
 
 getMassEditProgressStartFromGet ($getVariableName, $pageSize)
 
 getMassDeleteProgressStartFromGet ($getVariableName, $pageSize)
 
 attemptToValidateAjaxFromPost ($model, $postVariableName)
 
 getModelsToSave ($modelClassName, $dataProvider, $selectedRecordCount, $page, $pageSize)
 
 getModelsToDelete ($modelClassName, $dataProvider, $selectedRecordCount, $page, $pageSize)
 
 makeListMergeView ($model, $viewPrefix, $selectedList=array())
 

Static Protected Member Functions

static getModelToApiDataUtil ()
 
- Static Protected Member Functions inherited from ZurmoModuleApiController
static getSearchFormClassName ()
 
static getModelToApiDataUtil ()
 
static getModelToApiDataUtilData (RedBeanModel $model)
 
static resolveIncludingAdditionalData (Array &$data)
 
- Static Protected Member Functions inherited from ZurmoBaseController
static resolvePageValueForMassAction ($modelClassName)
 
static resolveViewIdByMassActionId ($actionId, $returnProgressViewName, $moduleName=null)
 
static applyGenericViewIdGenerationRules ($actionId)
 
static resolveTitleByMassActionId ($actionId)
 
static getZurmoControllerUtil ()
 
static getModelAndCatchNotFoundAndDisplayError ($modelClassName, $id)
 
static processModelsForMassAction ($model, $modelClassName, $selectedRecordCount, $dataProvider, $page, $pageSize, $insufficientPermissionSkipSavingUtil, $postModelClassName, $actionId)
 
static processModelsForMassActionWithoutScoring ($modelClassName, $selectedRecordCount, $dataProvider, $page, $pageSize, $insufficientPermissionSkipSavingUtil, $actionId)
 
static processModelsForMassEditAction ($postModelClassName, $model, $modelClassName, $selectedRecordCount, $dataProvider, $page, $pageSize, $insufficientPermissionSkipSavingUtil, $actionId)
 
static resolvePostDataByMassActionId ($actionId, $modelClassName=null)
 
static resolveSelectedRecordCountByMassActionId ($actionId, $dataProvider=null, $postData=array())
 
static resolveMassActionAlertMessage ($postVariableName, $actionId)
 
static resolvePageSizeByMassActionId ($actionId)
 
static toggleMuteScoringModelValueByMassActionId ($actionId, $mute=true)
 
static resolvePermissionOnSecurableItemByMassActionId ($actionId)
 
static processModelForMassDelete (&$model)
 
static resolveOffsetForDataProvider ($dataProvider, $actionId)
 
static processModelForMassEdit (&$model)
 
static resolveInsufficientPermissionSkipSavingUtilByMassActionId ($actionId)
 
static resolveProgressActionId ($actionId)
 
static resolveMassActionId ($actionId, $capitalizeFirst=true)
 
- Static Protected Member Functions inherited from Controller
static resolveDynamicSearchMetadata ($searchModel, $metadata, SearchAttributesDataCollection $dataCollection)
 
static resolveActiveAttributesFromPostForMassAction ($actionId)
 
static getSelectedRecordCountByResolvingSelectAllFromGet ($dataProvider, $countEmptyStringAsElement=true)
 
static getMassActionProgressStartFromGet ($pageVariableName, $pageSize)
 
static getModelsToUpdate ($modelClassName, $dataProvider, $selectedRecordCount, $page, $pageSize)
 
static getMassEditAlertMessage ($postVariableName)
 
static resolveMassEditAlertMessage ($postVariableName)
 

Additional Inherited Members

- Public Member Functions inherited from ZurmoModuleApiController
 filters ()
 
 filterApiRequest ($filterChain)
 
 actionRead ()
 
 actionList ()
 
 actionListAttributes ()
 
 actionSearch ()
 
 actionCreate ()
 
 actionUpdate ()
 
 actionDelete ()
 
 actionAddRelation ()
 
 actionRemoveRelation ()
 
 processGetModifiedItems ($params)
 
 processGetManyManyRelationshipModels ($params)
 
- Public Member Functions inherited from ZurmoBaseController
 filters ()
 
 resolveModuleClassNameForFilters ()
 
 __construct ($id, $module=null)
 
- Public Member Functions inherited from Controller
 __construct ($id, $module=null)
 
 resolveAndGetModuleId ()
 
 renderBeginWidget ($className, $properties=array())
 
 renderEndWidget ()
 
 makeRedBeanDataProviderByDataCollection ($searchModel, $pageSize, $stateMetadataAdapterClassName=null, $dataCollection=null)
 
- Static Public Member Functions inherited from ZurmoBaseController
static getRightsFilterPath ()
 
- Data Fields inherited from ZurmoModuleApiController
const RIGHTS_FILTER_PATH = 'application.modules.api.utils.ApiRightsControllerFilter'
 
- Data Fields inherited from ZurmoBaseController
const RIGHTS_FILTER_PATH = 'application.modules.zurmo.controllers.filters.RightsControllerFilter'
 
const REQUIRED_ATTRIBUTES_FILTER_PATH = 'application.modules.zurmo.controllers.filters.RequiredAttributesControllerFilter'
 
const ADMIN_VIEW_MOBILE_CHECK_FILTER_PATH = 'application.modules.zurmo.controllers.filters.AdminViewMobileCheckControllerFilter'
 
const ROOT_USER_ACCESS_FILTER_PATH = 'application.modules.zurmo.controllers.filters.RootUserAccessControllerFilter'
 

Detailed Description

Zurmo SecurableItem Api Controllers should extend this class to provide generic functionality that is applicable to all standard securable item api modules.

Definition at line 42 of file ZurmoSecurableItemApiController.php.

Member Function Documentation

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

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

Parameters
RedBeanModel$model
array$data

Definition at line 49 of file ZurmoSecurableItemApiController.php.

static getModelToApiDataUtil ( )
staticprotected

Util used to convert model to array

Returns
string

Definition at line 65 of file ZurmoSecurableItemApiController.php.


The documentation for this class was generated from the following file:
Generated on Sun Jul 12 2020 07:11:08
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.