LayoutMetadataAdapter Class Reference

Public Member Functions

 __construct ($viewClassName, $moduleClassName, $existingMetadata, DesignerRules $designerRules, $placeableLayoutAttributes, $requiredDerivedLayoutAttributeTypes)
 setMetadataFromLayout ($layout, $savableMetadata)
 resolveMetadataFromSelectedListAttributes ($viewClassName, $selectedListAttributes)
 getMessage ()

Protected Member Functions

 makeMergedSaveableMetadata ($viewClassName, $savableMetadata)
 getExistingMetadataToMerge ($viewClassName)
 adaptCellElementToMetadata ($elementName, $cellMetadata)
 adaptPanelSettingsToMetadata ($panel, $panelMetadata)
 adaptCellSettingsToMetadata ($cell, $cellMetadata)
 getDerivedAttributesFromMetadata ()
 areAllRequiredAttributesPlaced ()
 areAllPlacedAttributesUnique ()

Protected Attributes

 $viewClassName
 $moduleClassName
 $existingMtadata
 $designerRules
 $placeableLayoutAttributes
 $requiredDerivedLayoutAttributeTypes
 $message

Detailed Description

LayoutMetadataAdapter adapts the saved layout data from the designer tool into view metadata that can be saved.

Definition at line 41 of file LayoutMetadataAdapter.php.


Constructor & Destructor Documentation

__construct ( viewClassName,
moduleClassName,
existingMetadata,
DesignerRules designerRules,
placeableLayoutAttributes,
requiredDerivedLayoutAttributeTypes 
)
Parameters:
string $viewClassName
string $moduleClassName
array $existingMetadata
DesignerRules $designerRules
array $placeableLayoutAttributes
array $requiredDerivedLayoutAttributeTypes

Definition at line 69 of file LayoutMetadataAdapter.php.


Member Function Documentation

setMetadataFromLayout ( layout,
savableMetadata 
)

Given layout which most likely is coming from a POST, process the layout into savable metadata and save the metadata against the view.

Returns:
Boolean true on success, false on error
See also:
getMessage()

Definition at line 96 of file LayoutMetadataAdapter.php.

resolveMetadataFromSelectedListAttributes ( viewClassName,
selectedListAttributes 
)

Given an array of selected attributes, returns a well-formed metadata array with those as the placed attributes.

Parameters:
string $viewClassName
array $selectedListAttributes
Returns:
resolved metadata array

Definition at line 166 of file LayoutMetadataAdapter.php.

getMessage (  ) 

Get a message if populated commmunicating information regarding the adaption of layout data to metadata.

Definition at line 222 of file LayoutMetadataAdapter.php.


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