Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Data Fields | Protected Member Functions | Static Protected Member Functions
ZurmoModuleController Class Reference
Inheritance diagram for ZurmoModuleController:
ZurmoBaseController Controller AccountAccountAffiliationsDefaultController AccountContactAffiliationsDefaultController AccountsDefaultController ActivitiesModuleController AutorespondersDefaultController CalendarsDefaultController ContactsDefaultController ContactsExternalController ContactWebFormsDefaultController ConversationsDefaultController EmailTemplatesDefaultDataController EmailTemplatesOrCampaignsBaseController ExportDefaultController GameRewardsDefaultController GamificationDefaultController InstallDefaultController InstallUpgradeController JobsManagerDefaultController LeadsDefaultController MapsDefaultController MarketingListsDefaultController MarketingListsExternalController MarketingListsMemberController MashableInboxDefaultController MissionsDefaultController OpportunitiesDefaultController ProductsDefaultController ProductTemplatesCategoryController ProductTemplatesDefaultController ProjectsDefaultController SendGridDefaultController SendGridExternalController TasksTaskCheckItemsController TrackingDefaultController UsersDefaultController ZurmoAuthenticationController ZurmoCurrencyController ZurmoDevelopmentController ZurmoFileModelController ZurmoGroupController ZurmoImageModelController ZurmoLanguageController ZurmoLdapController ZurmoPluginsController ZurmoRoleController ZurmoShortUrlController

Public Member Functions

 filters ()
 
 actionIndex ()
 
 actionUpdateAttributeValue ($id, $attribute, $value)
 
 actionLoadSavedSearch ($id, $redirectAction= 'list')
 
 actionSelectFromRelatedList ($portletId, $uniqueLayoutId, $relationAttributeName, $relationModelId, $relationModuleId, $stateMetadataAdapterClassName=null)
 
 actionAutoComplete ($term, $autoCompleteOptions=null)
 
 actionCreateFromRelation ($relationAttributeName, $relationModelId, $relationModuleId, $redirectUrl)
 
 actionCopy ($id)
 
 actionAuditEventsModalList ($id)
 
 actionRenderStickyListBreadCrumbContent ($stickyOffset, $stickyKey, $stickyModelId)
 
 actionUnlink ($id)
 
 actionSearchForDuplicateModels ($attribute, $value)
 
 processListViewMerge ($modelClassName, $mergedModelFormClassName, $viewPrefix, $pageView, $redirectUrl)
 
 actionPushLayout ($id)
 
- 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)
 

Data Fields

const ZERO_MODELS_CHECK_FILTER_PATH = 'application.modules.zurmo.controllers.filters.ZeroModelsCheckControllerFilter'
 
- 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'
 

Protected Member Functions

 renderAutoCompleteResults ($modelClassName, $term, $autoCompleteOptions=null)
 
 resolveNewModelByRelationInformation ($model, $relationAttributeName, $relationModelId, $relationModuleId)
 
 addRelatedModelAccountToModel (RedBeanModel $model, RedBeanModel $relatedModel)
 
 resolveModelForAuditEventsModalList ($id)
 
 getModelName ()
 
 export ($stickySearchKey=null, $modelClassName=null, $exportFileName=null)
 
 resolveStateMetadataAdapterClassNameForExport ()
 
 beforeRedirect ($model)
 
- 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 getSearchFormClassName ()
 
static getModelAndCatchNotFoundAndDisplayError ($modelClassName, $id)
 
- 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

- Static Public Member Functions inherited from ZurmoBaseController
static getRightsFilterPath ()
 

Detailed Description

Zurmo Modules such as Accounts, Contacts, and Opportunities should extend this class to provide generic functionality that is applicable to all standard modules.

Definition at line 42 of file ZurmoModuleController.php.

Member Function Documentation

actionUpdateAttributeValue (   $id,
  $attribute,
  $value 
)

Currently supports an attribute that is a CustomField

Parameters
string$id
string$attribute
string$value
Exceptions
NotSupportedException
FailedToSaveModelException

Definition at line 72 of file ZurmoModuleController.php.

actionSelectFromRelatedList (   $portletId,
  $uniqueLayoutId,
  $relationAttributeName,
  $relationModelId,
  $relationModuleId,
  $stateMetadataAdapterClassName = null 
)

In a detailview, if you click the 'select' link from a sub view, this action is called. It will bring a modal search/list view to select a model from.

Parameters
string$portletId
string$uniqueLayoutId
string$relationAttributeName
string$relationModelId
string$relationModuleId
string$pageTitle

Definition at line 110 of file ZurmoModuleController.php.

actionCreateFromRelation (   $relationAttributeName,
  $relationModelId,
  $relationModuleId,
  $redirectUrl 
)

Override to implement.

Definition at line 154 of file ZurmoModuleController.php.

resolveNewModelByRelationInformation (   $model,
  $relationAttributeName,
  $relationModelId,
  $relationModuleId 
)
protected
See Also
actionCreateFromRelation. When a new model is instantiated, this method attaches a relation based on the relation information specified.
Parameters
$model
$relationAttributeName
$relationModelId
$relationModuleId
Returns
$model;

Definition at line 168 of file ZurmoModuleController.php.

addRelatedModelAccountToModel ( RedBeanModel  $model,
RedBeanModel  $relatedModel 
)
protected

Copy the account from a related model to a model

Parameters
RedBeanModel$model
RedBeanModel$relatedModel

Definition at line 197 of file ZurmoModuleController.php.

actionCopy (   $id)

Override to implement

Parameters
$id
Exceptions
NotImplementedException

Definition at line 211 of file ZurmoModuleController.php.

actionSearchForDuplicateModels (   $attribute,
  $value 
)

Override to implement, it should return a json object with content and message to be used by

See Also
DedupeRules::registerScriptForEditAndDetailsView
Parameters
string$attributeThe attribute used to trigger the dedupe action
string$valueThe value of the attribute for the new model
Exceptions
NotImplementedException

Definition at line 530 of file ZurmoModuleController.php.

processListViewMerge (   $modelClassName,
  $mergedModelFormClassName,
  $viewPrefix,
  $pageView,
  $redirectUrl 
)

Process list view merge for models

Definition at line 538 of file ZurmoModuleController.php.

beforeRedirect (   $model)
protected

Processing before redirecting

Parameters
RedBeanModel$model

Definition at line 578 of file ZurmoModuleController.php.


The documentation for this class was generated from the following file:
Generated on Sat Oct 24 2020 07:11:16
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.