AttributesLayoutAdapter Class Reference

Public Member Functions

 __construct ($attributes, $metadata, $derivedAttributeTypes=array(), $nonPlaceableAttributeNames=array(), $nonPlaceableAttributeTypes=array())
 getPlaceableLayoutAttributes ()
 getRequiredDerivedLayoutAttributeTypes ()
 makeDesignerLayoutAttributes ()
 getAvailableDerivedAttributeTypes ()
 getEffectivePlacedAttributes ()

Protected Member Functions

 isDerivedLayoutAttributeTypeRequired ($attributeType)
 getAttributesInPlace ()
 getDerivedAttributesInPlace ()
 populateDerivedAttributes ()

Protected Attributes

 $attributes
 $metadata
 $designerLayoutAttributes
 $nonPlaceableAttributeNames
 $nonPlaceableAttributeTypes
 $derivedAttributeTypes

Detailed Description

Adapter for converting an attribute collection into a collection that is usuable by the designer layout editor.

Definition at line 42 of file AttributesLayoutAdapter.php.


Constructor & Destructor Documentation

__construct ( attributes,
metadata,
derivedAttributeTypes = array(),
nonPlaceableAttributeNames = array(),
nonPlaceableAttributeTypes = array() 
)
Parameters:
array $attributes
array $metadata
array $derivedAttributeTypes
array $nonPlaceableAttributeNames
array $nonPlaceableAttributeTypes

Definition at line 63 of file AttributesLayoutAdapter.php.


Member Function Documentation

getPlaceableLayoutAttributes (  ) 

Take the attributesCollection and filter out nonPlaceable attribute names and attribute types.

Returns:
returns attributesCollection

Definition at line 91 of file AttributesLayoutAdapter.php.

getRequiredDerivedLayoutAttributeTypes (  ) 

Returns array of required derived layout attribute types

Definition at line 113 of file AttributesLayoutAdapter.php.

makeDesignerLayoutAttributes (  ) 

Adapt an attribute collection into DesignerLayoutAttributes

Returns:
returns DesignerLayoutAttributes

Definition at line 145 of file AttributesLayoutAdapter.php.

getEffectivePlacedAttributes (  ) 
Returns:
array of effective placed attributes. Includes all non-derived attributes directly placed in the layout as well as real attributes that are part of a derived attribute. For example: fullName. Even though this is derived, it effectively places the lastName attribute.

Definition at line 284 of file AttributesLayoutAdapter.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Sep 20 07:10:21 2017