All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
MetadataView Class Reference
Inheritance diagram for MetadataView:
View AccountSelectView AnyContactSelectForEmailMatchingView AttributesCollectionView ComponentForWizardModelView ConfigurableMetadataView ConfigureModulesMenuView CurrenciesCollectionView DesignerMenuView InstallSettingsView JobsCollectionView LanguagesCollectionView LeadConvertAccountSkipView LeadConvertOpportunitySkipView MarketingListsManageSubscriptionsListView ModuleEditableMetadataCollectionView PortletFrameView SecurityTreeListView StepsAndProgressBarForWizardView UserGroupMembershipView WizardTypeView WorkflowManageOrderListView WorkflowManageOrderView

Public Member Functions

 resolveEvaluateSubString (&$element, $key)
 
- Public Member Functions inherited from View
 isUniqueToAPage ()
 
 render ()
 
 setCssClasses (array $classes)
 
 getCssClasses ()
 
 getTitle ()
 
 getPostTruncatedTitleContent ()
 

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')
 
- Protected Member Functions inherited from View
 resolveDefaultClasses ()
 
 renderContainerWrapperId ()
 
 getContainerWrapperTag ()
 
 getId ()
 
 renderContent ()
 
 getViewStyle ()
 
 renderTitleContent ()
 
 resolveCustomViewTemplateFileName ($theme, $view)
 

Static Protected Member Functions

static getOptionsMenuCssClass ()
 

Protected Attributes

 $editableDesignerMetadata = false
 
 $disableFloatOnToolbar = false
 
 $modelId
 
- Protected Attributes inherited from View
 $cssClasses = array()
 
 $title
 
 $makeDefaultClassesFromClassHeirarchy = true
 

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()

Definition at line 53 of file MetadataView.php.

static getDefaultMetadata ( )
static

Returns default metadata for use in automatically generating the view.

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

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.

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 202 of file MetadataView.php.

resolveActionElementInformationDuringRender ( $elementInformation)
protected

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

Parameters
array$elementInformation

Definition at line 257 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 267 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;

Definition at line 288 of file MetadataView.php.

static getModelForMetadataClassName ( )
static

Override in each sub-class if you have a different model form to use than the primary model for the module for this view

Returns
null or a ModelForm class name

Definition at line 299 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 334 of file MetadataView.php.

static getOptionsMenuCssClass ( )
staticprotected

Gets the options menu class

Returns
string

Definition at line 379 of file MetadataView.php.


The documentation for this class was generated from the following file:
Generated on Thu Jan 23 2020 07:10:37