DesignerRules Class Reference

Inheritance diagram for DesignerRules:
AccountConvertToViewDesignerRules DetailsPortletViewDesignerRules DetailsViewDesignerRules EditAndDetailsViewDesignerRules EditViewDesignerRules ForMixedModelsSearchListViewDesignerRules ListViewDesignerRules MassEditViewDesignerRules ProductCategoryEditAndDetailViewDesignerRules SearchViewDesignerRules UserChangePasswordViewDesignerRules UserCreateViewDesignerRules UserEditAndDetailsViewDesignerRules

Public Member Functions

 allowEditInLayoutTool ()
 canAddPanels ()
 canAddRows ()
 canMergeAndSplitCells ()
 canModifyCellSettings ()
 canModifyPanelSettings ()
 canMovePanels ()
 canMoveRows ()
 canRemovePanels ()
 canRemoveRows ()
 canConfigureLayoutPanelsType ()
 formatSavableMetadataFromLayout ($metadata, $viewClassName)
 formatSavableElement ($element, $viewClassName)
 getCellSettingsAttributes ()
 getDerivedAttributeTypes ()
 getDisplayName ()
 resolveDisplayNameByView ($viewClassName)
 getMetadataViewClassNames ($viewClassName, $moduleClassName)
 getPanelSettingsAttributes ()
 getSavableMetadataRules ()
 mergeRowAndAttributePlacement ()
 requireAllRequiredFieldsInLayout ()
 requireOnlyUniqueFieldsInLayout ()
 getNonPlaceableLayoutAttributeNames ()
 getNonPlaceableLayoutAttributeTypes ()
 formatEditableMetadataForLayoutParsing ($metadata)
 maxCellsPerRow ()
 shouldPlaceNullElement ()

Static Protected Member Functions

static doesRuleApplyToElement ($rule, $elementInformation, $viewClassName)

Detailed Description

Class to help the designer module editing understand how to parse and handle the views it is editing.

Definition at line 41 of file DesignerRules.php.


Member Function Documentation

formatSavableMetadataFromLayout ( metadata,
viewClassName 
)

Override to add special formatting to the savableMetadata

Definition at line 101 of file DesignerRules.php.

formatSavableElement ( element,
viewClassName 
)
See also:
formatSavableMetadataFromLayout. This method is if you just want to format a single element and return it.
Returns:
formatted element

Definition at line 138 of file DesignerRules.php.

static doesRuleApplyToElement ( rule,
elementInformation,
viewClassName 
) [static, protected]

Override if special handling is required to ignore certain rules from applying to the element before the metadata is saved.

See also:
formatSavableMetadataFromLayout()
Parameters:
string $rule
array $elementInformation
string $viewClassName

Reimplemented in EditAndDetailsViewDesignerRules, and SearchViewDesignerRules.

Definition at line 164 of file DesignerRules.php.

getDerivedAttributeTypes (  ) 

Override if a rule requires that certain derived attributes types be made not available for placement using the layout tool

Returns:
array

Definition at line 179 of file DesignerRules.php.

resolveDisplayNameByView ( viewClassName  ) 

Override if you need to return a different display name than what designer rules provides.

Reimplemented in InlineEditViewDesignerRules, MyListConfigViewDesignerRules, MyListViewDesignerRules, and RelatedListViewDesignerRules.

Definition at line 191 of file DesignerRules.php.

getNonPlaceableLayoutAttributeNames (  ) 
getNonPlaceableLayoutAttributeTypes (  ) 

Override if a rule requires that certain attributes types be made not available for placement using the layout tool

Reimplemented in ListViewDesignerRules, MassEditViewDesignerRules, and SearchViewDesignerRules.

Definition at line 238 of file DesignerRules.php.

formatEditableMetadataForLayoutParsing ( metadata  ) 

Adds an extra formatting to ensure uniformity for layout parsing. Adds 'wide' => true if the cell should span.

Definition at line 248 of file DesignerRules.php.

shouldPlaceNullElement (  ) 

If an element is null, should we place it in the metadata.

Reimplemented in ListViewDesignerRules.

Definition at line 281 of file DesignerRules.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Apr 30 07:10:24 2017