ZurmoModuleController Class Reference

Inheritance diagram for ZurmoModuleController:
ZurmoBaseController Controller AccountAccountAffiliationsDefaultController AccountContactAffiliationsDefaultController AccountsDefaultController ActivitiesModuleController AutorespondersDefaultController CalendarsDefaultController CampaignsDefaultController ContactsDefaultController ContactsExternalController ContactWebFormsDefaultController ConversationsDefaultController EmailTemplatesDefaultController EmailTemplatesDefaultDataController GameRewardsDefaultController GamificationDefaultController InstallDefaultController InstallUpgradeController JobsManagerDefaultController LeadsDefaultController MapsDefaultController MarketingListsDefaultController MarketingListsExternalController MarketingListsMemberController MashableInboxDefaultController MissionsDefaultController OpportunitiesDefaultController ProductsDefaultController ProductTemplatesCategoryController ProductTemplatesDefaultController ProjectsDefaultController TasksTaskCheckItemsController TrackingDefaultController UsersDefaultController ZurmoAuthenticationController ZurmoCurrencyController ZurmoDevelopmentController ZurmoFileModelController ZurmoGroupController ZurmoImageModelController ZurmoLanguageController ZurmoLdapController ZurmoPluginsController ZurmoRoleController ZurmoShortUrlController

Public Member Functions

 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)

Data Fields

const ZERO_MODELS_CHECK_FILTER_PATH = 'application.modules.zurmo.controllers.filters.ZeroModelsCheckControllerFilter'

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)

Static Protected Member Functions

static getSearchFormClassName ()
static getModelAndCatchNotFoundAndDisplayError ($modelClassName, $id)

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 

Reimplemented in TasksDefaultController.

Definition at line 59 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

Reimplemented in ContactsDefaultController, OpportunitiesDefaultController, and ProductTemplatesDefaultController.

Definition at line 97 of file ZurmoModuleController.php.

actionCreateFromRelation ( relationAttributeName,
relationModelId,
relationModuleId,
redirectUrl 
)
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;

Reimplemented in ActivitiesModuleController, and ConversationsDefaultController.

Definition at line 155 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

Reimplemented in AccountAccountAffiliationsDefaultController, and AccountContactAffiliationsDefaultController.

Definition at line 184 of file ZurmoModuleController.php.

static getModelAndCatchNotFoundAndDisplayError ( modelClassName,
id 
) [static, protected]
Parameters:
string $modelClassName
int $id
Returns:
mixed

Reimplemented from ZurmoBaseController.

Definition at line 366 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 $attribute The attribute used to trigger the dedupe action
string $value The value of the attribute for the new model
Exceptions:
NotImplementedException 

Reimplemented in AccountsDefaultController, ContactsDefaultController, and LeadsDefaultController.

Definition at line 470 of file ZurmoModuleController.php.

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

Process list view merge for models

Definition at line 478 of file ZurmoModuleController.php.

beforeRedirect ( model  )  [protected]

Processing before redirecting

Parameters:
RedBeanModel $model

Reimplemented from ZurmoBaseController.

Definition at line 518 of file ZurmoModuleController.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Jul 23 07:10:32 2017