MetadataView Class Reference

Inheritance diagram for MetadataView:
View AccountSelectView AnyContactSelectForEmailMatchingView AttributesCollectionView ComponentForWizardModelView ConfigurableMetadataView ConfigureModulesMenuView CurrenciesCollectionView DesignerMenuView InstallSettingsView JobsCollectionView LanguagesCollectionView LeadConvertAccountSkipView MarketingListsManageSubscriptionsListView ModuleEditableMetadataCollectionView PortletFrameView SecurityTreeListView StepsAndProgressBarForWizardView UserGroupMembershipView WizardTypeView WorkflowManageOrderListView WorkflowManageOrderView

Public Member Functions

 resolveEvaluateSubString (&$element, $key)

Static Public Member Functions

static getMetadata ()
static getDefaultMetadata ()
static getDesignerRulesType ()
static getModelForMetadataClassName ()

Protected Member Functions

 resolveAndWrapDockableViewToolbarContent ($content)
 renderViewToolBar ($renderInForm=true)
 renderActionElementBar ($renderedInForm)
 renderSecondActionElementBar ($renderedInForm)
 renderElementBar ($renderedInForm, $barType)
 resolveMassActionLinkActionElementDuringRender ($elementClassName, &$element, &$dropDownItems, &$dropDownItemHtmlOptions)
 resolveActionElementInformationDuringRender (&$elementInformation)
 shouldRenderToolBarElement ($element, $elementInformation)
 renderWrapperAndActionElementMenu ($title=null, $toolbar= 'toolbar')
 renderActionElementMenu ($title=null, $toolbar= 'toolbar')

Static Protected Member Functions

static getOptionsMenuCssClass ()

Protected Attributes

 $editableDesignerMetadata = false
 $disableFloatOnToolbar = false
 $modelId

Detailed Description

The base View for any view that requires metadata in order to render itself.

Definition at line 41 of file MetadataView.php.


Member Function Documentation

static getMetadata (  )  [static]

Returns metadata for use in automatically generating the view.

See also:
getDefaultMetadata()

Reimplemented in DesignerMenuView.

Definition at line 53 of file MetadataView.php.

static getDefaultMetadata (  )  [static]

Returns default metadata for use in automatically generating the view.

Reimplemented in AListView, ActionBarForSearchAndListView, DetailsView, ListView, MassActionRequiringConfirmationView, MassDeleteView, SearchView, AccountAccountAffiliationEditAndDetailsView, AccountAccountAffiliationsRelatedListView, AccountContactAffiliationEditAndDetailsView, AccountAffiliationsForContactRelatedListView, ContactAffiliationsForAccountRelatedListView, AccountConvertToView, AccountDetailsAndRelationsView, AccountEditAndDetailsView, AccountModalCreateView, AccountsForMixedModelsSearchListView, AccountsListView, AccountsMassEditView, AccountsMergedEditAndDetailsView, AccountsModalListView, AccountsModalSearchView, AccountsModuleEditView, AccountsMyListConfigView, AccountsMyListView, AccountsSearchView, AccountsRelatedListView, SecuredActionBarForAccountsSearchAndListView, LatestActivitiesForPortletView, LatestActivitiesListView, AccountLatestActivitiesForPortletView, ContactLatestActivitiesForPortletView, OpportunityLatestActivitiesForPortletView, AutoresponderEditAndDetailsView, AutorespondersListView, AutorespondersPortletView, BounceConfigurationEditAndDetailsView, CalendarItemsListView, CombinedCalendarView, SavedCalendarEditAndDetailsView, SharedCalendarsModalListView, SharedCalendarsModalSearchView, CampaignDetailsAndRelationsView, CampaignDetailsView, CampaignEditView, CampaignItemsRelatedListView, CampaignsListView, CampaignsSearchView, CampaignsRelatedListView, CommentForSocialItemInlineEditView, CommentInlineEditView, ContactStateAttributeEditView, ContactDetailsAndRelationsView, ContactEditAndDetailsView, ContactExternalEditAndDetailsView, ContactInlineCreateForArchivedEmailCreateView, ContactsForMixedModelsSearchListView, ContactsListView, ContactsMassEditView, ContactsMergedEditAndDetailsView, ContactsModalListView, ContactsModalSearchView, ContactsModuleEditView, ContactsMyListConfigView, ContactsMyListView, ContactsSearchView, ContactsForOpportunityRelatedListView, ContactsRelatedListView, SecuredActionBarForContactsSearchAndListView, ContactWebFormEditAndDetailsView, ContactWebFormEntryListView, ContactWebFormEntrySearchView, ContactWebFormsListView, ContactWebFormsSearchView, SecuredActionBarForContactWebFormEntrySearchAndListView, SecuredActionBarForContactWebFormsSearchAndListView, ConversationDetailsView, ConversationEditView, ConversationsActionBarForListView, ConversationsListView, ActionBarForDesignerModuleView, AccountAttributeEditView, CalculatedNumberAttributeEditView, CheckBoxAttributeEditView, ContactAttributeEditView, CurrencyValueAttributeEditView, DateAttributeEditView, DateTimeAttributeEditView, DecimalAttributeEditView, DropDownAttributeEditView, DropDownDependencyAttributeEditView, MaxLengthAttributeEditView, MinMaxValueAttributeEditView, ProjectAttributeEditView, TextAreaAttributeEditView, UserAttributeEditView, GlobalSearchEnabledModuleEditView, ModuleEditView, ArchivedEmailMatchingListView, ContactRequiresPrimaryEmailFirstModalView, CreateEmailMessageModalEditView, EmailMessageEditAndDetailsView, EmailSmtpConfigurationEditAndDetailsView, ImapConfigurationEditAndDetailsView, EmailTemplateDetailsView, EmailTemplatesActionBarForListView, EmailTemplatesListView, EmailTemplatesModalListView, EmailTemplatesModalSearchView, EmailTemplatesSearchView, GameRewardDetailsAndRelationsView, GameRewardEditAndDetailsView, GameRewardsListView, GameRewardsMassEditView, GameRewardsModalListView, GameRewardsModalSearchView, GameRewardsRedeemListView, GameRewardsSearchView, GameRewardTransactionsRelatedListView, SecuredActionBarForGameRewardsSearchAndListView, LeaderboardActionBarForListView, LeaderboardListView, UserBadgesForPortletView, UserGamificationStatisticsForPortletView, UserLeaderboardRankingForPortletView, DashboardEditView, HomeDashboardView, IframePortletConfigView, IframePortletView, ImportErrorsListView, InstallSettingsView, JobLogDetailsView, JobLogsModalListView, JobsCollectionView, LeadDetailsAndRelationsView, LeadEditAndDetailsView, LeadInlineCreateForArchivedEmailCreateView, LeadsForMixedModelsSearchListView, LeadsListView, LeadsMassEditView, LeadsMergedEditAndDetailsView, LeadsModalListView, LeadsModalSearchView, LeadsModuleEditView, LeadsMyListConfigView, LeadsMyListView, LeadsSearchView, SecuredActionBarForLeadsSearchAndListView, MapConfigurationView, MarketingConfigurationEditAndDetailsView, MarketingDashboardView, MarketingMetricsView, MarketingOverallMetricsConfigView, SecuredActionBarForMarketingSearchAndListView, MarketingListDetailsAndRelationsView, MarketingListDetailsView, MarketingListEditView, MarketingListMembersListView, MarketingListMembersMassSubscribeView, MarketingListMembersMassUnsubscribeView, MarketingListMembersPortletView, MarketingListMembersSearchView, MarketingListsListView, MarketingListsModalListView, MarketingListsModalSearchView, MarketingListsSearchView, MassSubscribeView, MarketingListsForContactRelatedListView, MarketingListsRelatedListView, SecuredActionBarForMarketingListsSearchAndListView, MashableInboxActionBarForViews, MashableInboxListView, DaysMeetingsFromCalendarModalListView, MeetingEditAndDetailsView, MeetingForCalendarItemDetailsView, MeetingsMyListConfigView, MeetingsMyListView, MyUpcomingMeetingsCalendarView, UpcomingMeetingsRelatedCalendarView, UpcomingMeetingsRelatedListView, MissionDetailsView, MissionEditView, MissionsActionBarForListView, MissionsListView, MyMissionsForPortletView, NoteEditAndDetailsView, NoteInlineEditForPortletView, NoteInlineEditView, NotificationsForUserListView, OpportunityAttributeEditView, OpportunitiesBySourceChartView, OpportunitiesByStageChartView, OpportunitiesForMixedModelsSearchListView, OpportunitiesListView, OpportunitiesMassEditView, OpportunitiesModalListView, OpportunitiesModalSearchView, OpportunitiesModuleEditView, OpportunitiesMyListConfigView, OpportunitiesMyListView, OpportunitiesSearchView, OpportunitiesSecuredActionBarForSearchAndListView, OpportunityDetailsAndRelationsView, OpportunityEditAndDetailsView, OpportunitiesForContactRelatedListView, OpportunitiesRelatedListView, ProductEditAndDetailsView, ProductForCalendarItemDetailsView, ProductsListView, ProductsMassEditView, ProductsModalListView, ProductsModalSearchView, ProductsMyListConfigView, ProductsMyListView, ProductsSearchView, ProductsForAccountRelatedListView, ProductsForContactRelatedListView, ProductsForOpportunityRelatedListView, ProductsRelatedListView, SecuredActionBarForProductsSearchAndListView, SecuredActionBarForProductsZeroModelView, ActionBarForProductCategoriesTreeListView, ProductTemplatePriceFrequencyDropDownAttributeEditView, ProductTemplateStatusDropDownAttributeEditView, ProductTemplateTypeDropDownAttributeEditView, SellPriceFormulaInformationAttributeEditView, ProductCategoryDetailsView, ProductCategoryEditAndDetailsView, ProductTemplateEditAndDetailsView, ProductTemplatesListView, ProductTemplatesMassEditView, ProductTemplatesModalListView, ProductTemplatesModalSearchView, ProductTemplatesSearchView, ActiveProjectsListView, ActiveProjectsPortletView, ProjectStatusDropDownAttributeEditView, ProjectEditAndDetailsView, ProjectsActivityFeedPortletView, ProjectsDashboardView, ProjectsFeedListView, ProjectsListView, ProjectsMassEditView, ProjectsModalListView, ProjectsModalSearchView, ProjectsSearchView, ProjectsRelatedListView, SecuredActionBarForProjectsDashboardView, SecuredActionBarForProjectsSearchAndListView, DashboardReportChartConfigView, DashboardReportChartForPortletView, MatrixReportDetailsAndResultsView, ReportDetailsView, ReportsListView, ReportsModalListView, ReportsModalSearchView, ReportsSearchView, RowsAndColumnsReportDetailsAndResultsView, SecuredActionBarForReportsSearchAndListView, SummationReportDetailsAndResultsView, RssReaderConfigView, RssReaderView, SocialItemInlineEditView, SocialItemsForPortletView, SocialItemsListView, TaskStatusDropDownAttributeEditView, OpenTasksRelatedListView, TaskCheckItemInlineEditView, TasksForProjectKanbanView, TasksForRelatedKanbanView, SecuredActionBarForTasksSearchAndListView, TaskForCalendarItemDetailsView, TaskModalDetailsView, TaskModalEditView, TasksListView, TasksMassEditView, TasksMyListConfigView, TasksMyListView, TasksSearchView, ActionBarForUserEditAndDetailsView, UserChangeAvatarView, UserChangePasswordView, UserConfigurationEditView, UserCreateView, UserDetailsAndRelationsView, UserDetailsView, UserEditView, UserEmailConfigurationEditView, UsersActionBarForSearchAndListView, UsersByModelModalListView, UsersListView, UsersMassEditView, UsersModalListView, UsersModalSearchView, UsersSearchView, UserTimeZoneConfirmationView, ByTimeWorkflowInQueuesListView, ByTimeWorkflowInQueuesSearchView, SecuredActionBarForWorkflowsSearchAndListView, WorkflowDetailsView, WorkflowMessageInQueuesListView, WorkflowMessageInQueuesSearchView, WorkflowsListView, WorkflowsSearchView, AuditEventsModalListView, ChartConfigView, CurrenciesCollectionView, CurrencyCreateView, InlineEditForPortletView, LdapConfigurationEditAndDetailsView, ActionBarForGroupEditAndDetailsView, ActionBarForSecurityTreeListView, GroupEditAndDetailsView, GroupUserMembershipEditView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, RightsEditAndDetailsView, RoleEditAndDetailsView, SecurityTreeListView, ZurmoConfigurationEditAndDetailsView, and ZurmoUserInterfaceConfigurationEditAndDetailsView.

Definition at line 62 of file MetadataView.php.

resolveAndWrapDockableViewToolbarContent ( content  )  [protected]
Returns:
string content of $content passed in wrapped in the view-toolbar-container and view-toolbar. Also accommodates for ignoring the dock if necessary

Reimplemented in AccountConvertToView.

Definition at line 71 of file MetadataView.php.

renderViewToolBar ( renderInForm = true  )  [protected]

Renders a toolbar.

Returns:
A string containing the toolbar content

Definition at line 93 of file MetadataView.php.

renderActionElementBar ( renderedInForm  )  [protected]

Render a toolbar above the form layout. This includes buttons and/or links to go to different views or process actions such as save or delete

Parameters:
boolean $renderedInForm
Returns:
A string containing the element's content.

Reimplemented in GameRewardDetailsAndRelationsView, DashboardView, ImportWizardView, TasksForRelatedKanbanView, ComponentForWizardModelView, and ConfigurableDetailsAndRelationsView.

Definition at line 116 of file MetadataView.php.

renderSecondActionElementBar ( renderedInForm  )  [protected]

Render a second toolbar to the right of the first toolbar.

See also:
$this->renderActionElementBar
Parameters:
boolean $renderedInForm
Returns:
A string containing the element's content.

Definition at line 128 of file MetadataView.php.

renderElementBar ( renderedInForm,
barType 
) [protected]
Parameters:
boolean $renderedInForm
string $barType
Returns:
A string containing the element's content.
Exceptions:
NotSupportedException 

Definition at line 139 of file MetadataView.php.

resolveMassActionLinkActionElementDuringRender ( elementClassName,
&$  element,
&$  dropDownItems,
&$  dropDownItemHtmlOptions 
) [protected]

Resolves how MassActionLinkElements should be rendered on Mobile Devices

Parameters:
$elementClassName 
$element 
$dropDownItems 
$dropDownItemHtmlOptions 
Returns:
bool whether or not to continue rendering this element

Definition at line 201 of file MetadataView.php.

resolveActionElementInformationDuringRender ( &$  elementInformation  )  [protected]

Override if any manipulation is needed on the $elementInformaiton prior to rendering

Parameters:
array $elementInformation

Reimplemented in ActionBarForSearchAndListView, ContactExternalEditAndDetailsView, ActionBarForDesignerModuleView, OpportunitiesSecuredActionBarForSearchAndListView, ActionBarForUserEditAndDetailsView, ActionBarForGroupEditAndDetailsView, and ActionBarForSecurityTreeListView.

Definition at line 256 of file MetadataView.php.

resolveEvaluateSubString ( &$  element,
key 
)

This method must not use the

See also:
MetadataUtil::resolveEvaluateSubString because some evaluations might be using $this, which will not work if executed from within a different method.
Parameters:
mixed $element
integer $key

Definition at line 266 of file MetadataView.php.

static getDesignerRulesType (  )  [static]

Override in each sub-class if you have applicable designer rules for handling the modification of metadata layouts

Returns:
null or a DesignerRules Class;

Reimplemented in CalendarView, DetailsView, EditAndDetailsView, EditView, InlineEditView, ListView, MassDeleteView, MassEditView, ModalListView, MyListView, RelatedListView, SearchView, AccountConvertToView, AccountDetailsPortletView, AccountModalCreateView, AccountsForMixedModelsSearchListView, AccountsMergedEditAndDetailsView, AccountsModalSearchView, CalendarItemsListView, SharedCalendarsModalSearchView, ContactDetailsPortletView, ContactExternalEditAndDetailsView, ContactsForMixedModelsSearchListView, ContactsMergedEditAndDetailsView, ContactsModalSearchView, EmailTemplatesModalSearchView, GameRewardDetailsPortletView, GameRewardsModalSearchView, LeadDetailsPortletView, LeadsForMixedModelsSearchListView, LeadsMergedEditAndDetailsView, LeadsModalSearchView, MarketingListMembersMassEditActionView, MarketingListsModalSearchView, MeetingForCalendarItemDetailsView, OpportunitiesForMixedModelsSearchListView, OpportunitiesModalSearchView, OpportunityDetailsPortletView, ProductForCalendarItemDetailsView, ProductsMassEditView, ProductsModalSearchView, ProductCategoryEditAndDetailsView, ProductTemplatesMassDeleteView, ProductTemplatesMassEditView, ProductTemplatesModalSearchView, ActiveProjectsListView, ProjectsFeedListView, ProjectsModalSearchView, ReportsModalSearchView, TaskCheckItemInlineEditView, TasksForRelatedKanbanView, TaskForCalendarItemDetailsView, TaskModalDetailsView, TaskModalEditView, UserChangePasswordView, UserCreateView, UserEditView, UsersByModelModalListView, UsersModalSearchView, MyListConfigView, DynamicSearchView, GroupUserMembershipEditView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, and RightsEditAndDetailsView.

Definition at line 287 of file MetadataView.php.

renderActionElementMenu ( title = null,
toolbar = 'toolbar' 
) [protected]

Render a menu above the form layout. This includes buttons and/or links to go to different views or process actions such as save or delete

Parameters:
null $title
string $toolbar
Returns:
mixed A string containing the element's content.
Exceptions:
NotSupportedException 

Definition at line 333 of file MetadataView.php.

static getOptionsMenuCssClass (  )  [static, protected]

Gets the options menu class

Returns:
string

Reimplemented in TaskModalDetailsView.

Definition at line 378 of file MetadataView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Jun 26 07:10:27 2017