DetailsView Class Reference

Inheritance diagram for DetailsView:
ModelView ConfigurableMetadataView MetadataView View EditAndDetailsView EditView JobLogDetailsView ProductCategoryDetailsView ReportDetailsView SecuredDetailsView UserDetailsView WorkflowDetailsView

Public Member Functions

 __construct ($controllerId, $moduleId, $model, $title=null)
 getTitle ()

Static Public Member Functions

static assertModelIsValid ($model)
static getDefaultMetadata ()
static getDesignerRulesType ()

Protected Member Functions

 renderContent ()
 resolveLeftContentForSlidingPanels ($content)
 resolveAndRenderActionElementMenu ()
 renderRightSideContent ($form=null)
 renderBeforeFormLayoutForDetailsContent ()
 renderAfterFormLayoutForDetailsContent ()
 renderAfterRightSideContent ()
 renderAfterDetailsTable ()
 renderFormLayout ($form=null)
 resolveMetadataWithRenderedElements ($metadata, $maxCellsPerRow, $form)
 resolveMaxCellsPresentInAnyRow ($metadata)
 doesLabelHaveOwnCell ()
 afterResolveMetadataWithRenderedElements (&$metadataWithRenderedElements, $form)
 getMaxCellsPerRow ()
 getModel ()
 shouldDisplayCell ($detailViewOnly)
 shouldDisplayPanel ($detailViewOnly)
 resolveElementInformationDuringFormLayoutRender (&$elementInformation)
 resolveElementDuringFormLayoutRender (&$element)
 getFormLayoutMetadata ()
 getMorePanelsLinkLabel ()
 getLessPanelsLinkLabel ()
 alwaysShowErrorSummary ()
 getFormLayoutUniqueId ()
 getDetailsViewFormLayoutClass ()

Static Protected Member Functions

static assertMetadataIsValid (array $metadata)

Protected Attributes

 $controllerId
 $moduleId
 $model
 $title

Detailed Description

The base View for a module's details view.

Definition at line 40 of file DetailsView.php.

Constructor & Destructor Documentation

__construct ( $  controllerId,
$  moduleId,
$  model,
$  title = null 
)

Constructs a detail view specifying the controller as well as the model that will have its details displayed.

Reimplemented in EditAndDetailsView, AccountConvertToView, and ModelsToMergeListAndChartView.

Definition at line 54 of file DetailsView.php.

Member Function Documentation

renderContent (  )  [protected]

Renders content for a view including a layout title, form toolbar, and form layout.

Returns:
A string containing the element's content.

Reimplemented from View.

Reimplemented in EditAndDetailsView, EditView, InlineEditView, MassActionView, ModalConfigEditView, CampaignDetailsOverlayView, CampaignDetailsView, CampaignEditView, ContactEditAndDetailsView, ConversationDetailsView, MarketingListDetailsOverlayView, MarketingListDetailsView, ReportDetailsView, AccountDetailsOverlayView, ContactDetailsOverlayView, OpportunityDetailsOverlayView, ProjectDetailsOverlayView, TaskRelatedDetailsOverlayView, TaskModalDetailsView, and ModelsToMergeListAndChartView.

Definition at line 76 of file DetailsView.php.

resolveLeftContentForSlidingPanels ( $  content  )  [protected]

Override to adding sliding panel support.

See also:
ContactDetailsPortletView for an example.
Parameters:
$content 
Returns:
mixed

Reimplemented in ContactDetailsPortletView, LeadDetailsPortletView, and UserDetailsView.

Definition at line 98 of file DetailsView.php.

renderFormLayout ( $  form = null  )  [protected]

Render a form layout.

Parameters:
$form If the layout is editable, then pass a $form otherwise it can be null.
Returns:
A string containing the element's content.

Reimplemented in MassEditView, ConversationDetailsView, ImportWizardCreateUpdateModelsCompleteView, ImportWizardDataAnalysisCompleteView, ImportWizardImportRulesView, ImportWizardMappingView, ImportWizardSetModelPermissionsView, ImportWizardUploadFileView, MissionDetailsView, TaskCheckItemInlineEditView, GroupUserMembershipEditView, and ModulePermissionsEditAndDetailsView.

Definition at line 134 of file DetailsView.php.

resolveMetadataWithRenderedElements ( $  metadata,
$  maxCellsPerRow,
$  form 
) [protected]

Given metadata, resolve the element information into the rendered element content and return the metadata with rendered element content instead of element information.

Parameters:
array $metadata
integer $maxCellsPerRow
object $form ZurmoActiveForm or null

Definition at line 166 of file DetailsView.php.

resolveMaxCellsPresentInAnyRow ( $  metadata  )  [protected]

Given an array of metadata, resolve what the maximum amount of cells present are in any given row.

Parameters:
array $metadata

Definition at line 222 of file DetailsView.php.

doesLabelHaveOwnCell (  )  [protected]
Returns:
true if the label has its own TD next to the TD of the input. Override if the label is on top of the input, in which case it does not need its own cell.

Reimplemented in CommentInlineEditView, ContactInlineCreateForArchivedEmailCreateView, CreateEmailMessageModalEditView, NoteInlineEditView, SocialItemInlineEditView, TaskCheckItemInlineEditView, and TaskModalDetailsView.

Definition at line 252 of file DetailsView.php.

afterResolveMetadataWithRenderedElements ( &$  metadataWithRenderedElements,
$  form 
) [protected]

Override if you need to do any special processing of the metadata array prior to it being rendered.

Parameters:
array $metadataWithRenderedElements

Reimplemented in MyListConfigView.

Definition at line 261 of file DetailsView.php.

static getDefaultMetadata (  )  [static]

Returns meta data for use in automatically generating the view. The meta data is comprised of panels, rows, and then cells. Each cell can have 1 or more elements.

The element takes 3 parameters. The first parameter is 'attributeName'. The second parameter is 'type' and refers to the element type. Using a type of 'Text' would utilize the TextElement class. The third parameter is 'wide' and refers to how many cells the field should span. An example of the 'wide' => true usage would be for a text description field. Here is an example meta data that defines a 2 row x 2 cell layout.

            <?php
                $metadata = array(
                    'panels' => array(
                        array(
                            'rows' => array(
                                array('cells' =>
                                    array(
                                        array(
                                            'elements' => array(
                                                array('field' => 'name', 'type' => 'Text'),
                                            ),
                                        ),
                                        array(
                                            'elements' => array(
                                                array('field' => 'officePhone', 'type' => 'Text'),
                                            ),
                                        ),
                                    )
                                ),
                                array('cells' =>
                                    array(
                                        array(
                                            'elements' => array(
                                                array('field' => 'industry', 'type' => 'DropDown'),
                                            ),
                                        ),
                                        array(
                                            'elements' => array(
                                                array('field' => 'officeFax', 'type' => 'Text'),
                                            ),
                                        ),
                                    )
                                ),
                            ),
                        ),
                    ),
                );
            ?>

Reimplemented from MetadataView.

Reimplemented in MassActionRequiringConfirmationView, MassDeleteView, AccountAccountAffiliationEditAndDetailsView, AccountContactAffiliationEditAndDetailsView, AccountConvertToView, AccountEditAndDetailsView, AccountModalCreateView, AccountsMassEditView, AccountsMergedEditAndDetailsView, AccountsModuleEditView, AccountsMyListConfigView, AutoresponderEditAndDetailsView, BounceConfigurationEditAndDetailsView, SavedCalendarEditAndDetailsView, CampaignDetailsView, CampaignEditView, CommentForSocialItemInlineEditView, CommentInlineEditView, ContactStateAttributeEditView, ContactEditAndDetailsView, ContactExternalEditAndDetailsView, ContactInlineCreateForArchivedEmailCreateView, ContactsMassEditView, ContactsMergedEditAndDetailsView, ContactsModuleEditView, ContactsMyListConfigView, ContactWebFormEditAndDetailsView, ConversationDetailsView, ConversationEditView, AccountAttributeEditView, CalculatedNumberAttributeEditView, CheckBoxAttributeEditView, ContactAttributeEditView, CurrencyValueAttributeEditView, DateAttributeEditView, DateTimeAttributeEditView, DecimalAttributeEditView, DropDownAttributeEditView, DropDownDependencyAttributeEditView, MaxLengthAttributeEditView, MinMaxValueAttributeEditView, ProjectAttributeEditView, TextAreaAttributeEditView, UserAttributeEditView, GlobalSearchEnabledModuleEditView, ModuleEditView, ContactRequiresPrimaryEmailFirstModalView, CreateEmailMessageModalEditView, EmailMessageEditAndDetailsView, EmailSmtpConfigurationEditAndDetailsView, ImapConfigurationEditAndDetailsView, EmailTemplateDetailsView, GameRewardEditAndDetailsView, GameRewardsMassEditView, DashboardEditView, IframePortletConfigView, JobLogDetailsView, LeadEditAndDetailsView, LeadInlineCreateForArchivedEmailCreateView, LeadsMassEditView, LeadsMergedEditAndDetailsView, LeadsModuleEditView, LeadsMyListConfigView, MapConfigurationView, MarketingConfigurationEditAndDetailsView, MarketingOverallMetricsConfigView, MarketingListDetailsView, MarketingListEditView, MarketingListMembersMassSubscribeView, MarketingListMembersMassUnsubscribeView, MassSubscribeView, MeetingEditAndDetailsView, MeetingForCalendarItemDetailsView, MeetingsMyListConfigView, MissionDetailsView, MissionEditView, NoteEditAndDetailsView, NoteInlineEditView, OpportunityAttributeEditView, OpportunitiesMassEditView, OpportunitiesModuleEditView, OpportunitiesMyListConfigView, OpportunityEditAndDetailsView, ProductEditAndDetailsView, ProductForCalendarItemDetailsView, ProductsMassEditView, ProductsMyListConfigView, ProductTemplatePriceFrequencyDropDownAttributeEditView, ProductTemplateStatusDropDownAttributeEditView, ProductTemplateTypeDropDownAttributeEditView, SellPriceFormulaInformationAttributeEditView, ProductCategoryDetailsView, ProductCategoryEditAndDetailsView, ProductTemplateEditAndDetailsView, ProductTemplatesMassEditView, ProjectStatusDropDownAttributeEditView, ProjectEditAndDetailsView, ProjectsMassEditView, DashboardReportChartConfigView, ReportDetailsView, RssReaderConfigView, SocialItemInlineEditView, TaskStatusDropDownAttributeEditView, TaskCheckItemInlineEditView, TaskForCalendarItemDetailsView, TaskModalDetailsView, TaskModalEditView, TasksMassEditView, TasksMyListConfigView, UserChangeAvatarView, UserChangePasswordView, UserConfigurationEditView, UserCreateView, UserDetailsView, UserEditView, UserEmailConfigurationEditView, UsersMassEditView, UserTimeZoneConfirmationView, WorkflowDetailsView, ChartConfigView, CurrencyCreateView, LdapConfigurationEditAndDetailsView, GroupEditAndDetailsView, GroupUserMembershipEditView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, RightsEditAndDetailsView, RoleEditAndDetailsView, ZurmoConfigurationEditAndDetailsView, and ZurmoUserInterfaceConfigurationEditAndDetailsView.

Definition at line 333 of file DetailsView.php.

getModel (  )  [protected]

Return the model that will have its details displayed.

Reimplemented in MyListConfigView.

Definition at line 341 of file DetailsView.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 from MetadataView.

Reimplemented in EditAndDetailsView, EditView, InlineEditView, MassDeleteView, MassEditView, AccountConvertToView, AccountDetailsPortletView, AccountModalCreateView, AccountsMergedEditAndDetailsView, ContactDetailsPortletView, ContactExternalEditAndDetailsView, ContactsMergedEditAndDetailsView, GameRewardDetailsPortletView, LeadDetailsPortletView, LeadsMergedEditAndDetailsView, MarketingListMembersMassEditActionView, MeetingForCalendarItemDetailsView, OpportunityDetailsPortletView, ProductForCalendarItemDetailsView, ProductsMassEditView, ProductCategoryEditAndDetailsView, ProductTemplatesMassDeleteView, ProductTemplatesMassEditView, TaskCheckItemInlineEditView, TaskForCalendarItemDetailsView, TaskModalDetailsView, TaskModalEditView, UserChangePasswordView, UserCreateView, UserEditView, MyListConfigView, GroupUserMembershipEditView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, and RightsEditAndDetailsView.

Definition at line 356 of file DetailsView.php.

resolveElementInformationDuringFormLayoutRender ( &$  elementInformation  )  [protected]

Override sub-class if you need to add anything to the ElementInformation as you are parsing the form layout

Reimplemented in AccountContactAffiliationEditAndDetailsView, AutoresponderEditAndDetailsView, CampaignEditView, CommentForSocialItemInlineEditView, ContactInlineCreateForArchivedEmailCreateView, AttributeEditView, EmailTemplateDetailsView, LeadInlineCreateForArchivedEmailCreateView, OpportunityEditAndDetailsView, ProductTemplateEditAndDetailsView, TaskModalEditView, UserEditView, SecuredDetailsView, SecuredEditAndDetailsView, SecuredEditView, and GroupEditAndDetailsView.

Definition at line 365 of file DetailsView.php.

resolveElementDuringFormLayoutRender ( &$  element  )  [protected]

Override sub-class if you need to set anything into the element object.

Reimplemented in EditAndDetailsView, AccountsMergedEditAndDetailsView, AutoresponderEditAndDetailsView, CalendarItemDetailsView, CampaignEditView, CommentInlineEditView, ContactsMergedEditAndDetailsView, ConversationEditView, CreateEmailMessageModalEditView, ImapConfigurationEditAndDetailsView, LeadsMergedEditAndDetailsView, MarketingListEditView, MissionEditView, NoteInlineEditView, SocialItemInlineEditView, TaskCheckItemInlineEditView, TaskModalDetailsView, and ZurmoConfigurationEditAndDetailsView.

Definition at line 372 of file DetailsView.php.

getFormLayoutMetadata (  )  [protected]

Gets the metadata for this view. Override if you need to make the metadata dynamically or change the way the metadata is retreived

Returns:
array view metadata

Reimplemented in AccountsMergedEditAndDetailsView, ContactExternalEditAndDetailsView, ContactsMergedEditAndDetailsView, LeadsMergedEditAndDetailsView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, and RightsEditAndDetailsView.

Definition at line 383 of file DetailsView.php.

getMorePanelsLinkLabel (  )  [protected]

For the given view, return the label used when a link is displayed to show additional panels in the view.

Returns:
string label.

Reimplemented in InlineEditView.

Definition at line 400 of file DetailsView.php.

getLessPanelsLinkLabel (  )  [protected]

For the given view, return the label used when a link is displayed to show less panels in the view.

Returns:
string label.

Reimplemented in InlineEditView.

Definition at line 409 of file DetailsView.php.

getTitle (  ) 

TODO

Reimplemented from ConfigurableMetadataView.

Reimplemented in EditAndDetailsView, AccountDetailsPortletView, AccountsMergedEditAndDetailsView, BounceConfigurationEditAndDetailsView, CalendarItemDetailsView, CampaignDetailsView, ContactDetailsPortletView, ContactsMergedEditAndDetailsView, ConversationDetailsView, EmailArchivingConfigurationEditAndDetailsView, EmailSmtpConfigurationEditAndDetailsView, ImapConfigurationEditAndDetailsView, LeadDetailsPortletView, LeadsMergedEditAndDetailsView, MapConfigurationView, MarketingConfigurationEditAndDetailsView, MarketingListDetailsView, MissionDetailsView, OpportunityDetailsPortletView, ProductCategoryDetailsView, ReportDetailsView, TaskModalDetailsView, UserCreateView, UserDetailsView, UserEditView, WorkflowDetailsView, CurrencyCreateView, LdapConfigurationEditAndDetailsView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, RightsEditAndDetailsView, ZurmoConfigurationEditAndDetailsView, and ZurmoUserInterfaceConfigurationEditAndDetailsView.

Definition at line 414 of file DetailsView.php.

getFormLayoutUniqueId (  )  [protected]

Gets form layout unique id

Returns:
null

Reimplemented in AccountModalCreateView, TaskModalDetailsView, and TaskModalEditView.

Definition at line 428 of file DetailsView.php.

getDetailsViewFormLayoutClass (  )  [protected]

Gets details view form layout class name.

Returns:
string

Reimplemented in CalendarItemDetailsView.

Definition at line 437 of file DetailsView.php.

The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Aug 23 07:10:24 2017