All Data Structures Functions Variables Pages
Public Member Functions | Data Fields | Protected Member Functions | Static Protected Member Functions
UsersDefaultController Class Reference
Inheritance diagram for UsersDefaultController:
ZurmoModuleController ZurmoBaseController Controller

Public Member Functions

 filters ()
 
 actionList ()
 
 actionChangeAvatar ($id)
 
 actionDetails ($id)
 
 actionAuditEventsModalList ($id)
 
 actionCreate ()
 
 actionEdit ($id)
 
 actionChangePassword ($id)
 
 actionConfirmTimeZone ()
 
 actionMassEdit ()
 
 actionMassEditProgressSave ()
 
 actionProfile ()
 
 actionModalList ()
 
 actionSecurityDetails ($id)
 
 actionConfigurationEdit ($id)
 
 actionEmailConfiguration ($id, $redirectUrl=null)
 
 actionExport ()
 
 actionAutoCompleteForMultiSelectAutoComplete ($term, $autoCompleteOptions=null)
 
 actionGetUsersByPartialStringWithReadPermissionsForSecurableItem ($term, $relatedModelClassName=null, $relatedModelId=null)
 
 actionGameDashboard ($id)
 
 actionSwitchTo ($username)
 
 actionNotificationConfiguration ($id, $redirectUrl=null)
 
- Public Member Functions inherited from ZurmoModuleController
 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 EMAIL_CONFIGURATION_FILTER_PATH
 
const USER_SWITCHER_RIGHTS_FILTER_PATH
 
- Data Fields inherited from ZurmoModuleController
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

 resolveModelForAuditEventsModalList ($id)
 
 attemptToSaveModelFromPost ($model, $redirectUrlParams=null, $redirect=true, $returnOnValidate=false)
 
 resolveZurmoDefaultOrAdminView (View $containedView, $breadCrumbLinks, $breadcrumbViewClassName)
 
 attemptToValidateAjaxFromPost ($model, $postVariableName)
 
 resolveStateMetadataAdapterClassNameForExport ()
 
 processSendGridPostConfiguration ($id, $redirectUrl=null)
 
- Protected Member Functions inherited from ZurmoModuleController
 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 Protected Member Functions inherited from ZurmoModuleController
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

Definition at line 37 of file DefaultController.php.

Member Function Documentation

filters ( )

Override to exclude modalSearchList and autoComplete since these are available to all users regardless of the access right on the users module. Excludes details, edit, changePassword, and securityDetails because these actions are checked using the resolveCanCurrentUserAccessAction method.

Definition at line 53 of file DefaultController.php.

attemptToSaveModelFromPost (   $model,
  $redirectUrlParams = null,
  $redirect = true,
  $returnOnValidate = false 
)
protected

Override to handle UserStatus processing.

See Also
ZurmoBaseController::attemptToSaveModelFromPost()

Definition at line 300 of file DefaultController.php.

actionMassEdit ( )

Action for displaying a mass edit form and also action when that form is first submitted. When the form is submitted, in the event that the quantity of models to update is greater than the pageSize, then once the pageSize quantity has been reached, the user will be redirected to the makeMassEditProgressView. In the mass edit progress view, a javascript refresh will take place that will call a refresh action, usually massEditProgressSave. If there is no need for a progress view, then a flash message will be added and the user will be redirected to the list view for the model. A flash message will appear providing information on the updated records.

See Also
Controler->makeMassEditProgressView
Controller->processMassEdit

Definition at line 368 of file DefaultController.php.

actionMassEditProgressSave ( )

Action called in the event that the mass edit quantity is larger than the pageSize. This action is called after the pageSize quantity has been updated and continues to be called until the mass edit action is complete. For example, if there are 20 records to update and the pageSize is 5, then this action will be called 3 times. The first 5 are updated when the actionMassEdit is called upon the initial form submission.

Definition at line 408 of file DefaultController.php.

actionAutoCompleteForMultiSelectAutoComplete (   $term,
  $autoCompleteOptions = null 
)

Given a partial name search for all users unless the current user has security restrictions. JSON encode the resulting array of users.

Definition at line 604 of file DefaultController.php.

actionGetUsersByPartialStringWithReadPermissionsForSecurableItem (   $term,
  $relatedModelClassName = null,
  $relatedModelId = null 
)

Given a partial name search for all users. If related model details are not empty, return only users that have access to read model JSON encode the resulting array of results in requested format.

Parameters
$term
null$relatedModelClassName
null$relatedModelId

Definition at line 628 of file DefaultController.php.

resolveZurmoDefaultOrAdminView ( View  $containedView,
  $breadCrumbLinks,
  $breadcrumbViewClassName 
)
protected

Depending on the user interface, the user views should utilize the admin or regular view. This especially important for mobile, since for mobile there are no admin views available yet.

Parameters
$containedView
$breadCrumbLinks
$breadcrumbViewClassName
Returns
GridView

Definition at line 701 of file DefaultController.php.

attemptToValidateAjaxFromPost (   $model,
  $postVariableName 
)
protected

Override to handle userStatus validation

Parameters
User  |  ModelForm$model
string$postVariableName

Definition at line 721 of file DefaultController.php.

processSendGridPostConfiguration (   $id,
  $redirectUrl = null 
)
protected

Configure sendgrid options.

Parameters
int$id
string$redirectUrl
Returns
void

Definition at line 826 of file DefaultController.php.

Field Documentation

const EMAIL_CONFIGURATION_FILTER_PATH
Initial value:
=
'application.modules.emailMessages.controllers.filters.EmailConfigurationCheckControllerFilter'

Definition at line 39 of file DefaultController.php.

const USER_SWITCHER_RIGHTS_FILTER_PATH
Initial value:
=
'application.modules.zurmo.controllers.filters.UserSwitcherRightsControllerFilter'

Definition at line 42 of file DefaultController.php.


The documentation for this class was generated from the following file:
Generated on Sat Jun 6 2020 07:11:10