eZPublishCommunityProject  2013.9
eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page Class Reference
+ Inheritance diagram for eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page:
+ Collaboration diagram for eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page:

Public Member Functions

 generateXmlString ($page)
 Generates XML string from $page object to be stored in storage engine. More...
 
 getIndexColumn ()
 Returns the name of the index column in the attribute table. More...
 
 restoreValueFromXmlString ($xmlString)
 Restores value from XML string. More...
 
 toFieldDefinition (StorageFieldDefinition $storageDef, FieldDefinition $fieldDef)
 Converts field definition data in $storageDef into $fieldDef. More...
 
 toFieldValue (StorageFieldValue $value, FieldValue $fieldValue)
 Converts data from $value to $fieldValue. More...
 
 toStorageFieldDefinition (FieldDefinition $fieldDef, StorageFieldDefinition $storageDef)
 Converts field definition data in $fieldDef into $storageFieldDef. More...
 
 toStorageValue (FieldValue $value, StorageFieldValue $storageFieldValue)
 Converts data from $value to $storageFieldValue. More...
 

Protected Member Functions

 generateBlockXmlString ($block, DOMDocument $dom)
 Generates XML string for a given $block object. More...
 
 generateItemXmlString ($item, DOMDocument $dom)
 Generates XML string for a given $item object. More...
 
 generateZoneXmlString ($zone, DOMDocument $dom)
 Generates XML string for a given $zone object. More...
 
 restoreBlockFromXml (DOMElement $node)
 Restores value for a given Block $node. More...
 
 restoreItemFromXml (DOMElement $node)
 Restores value for a given Item $node. More...
 
 restoreZoneFromXml (DOMElement $node)
 Restores value for a given Zone $node. More...
 

Member Function Documentation

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::generateBlockXmlString (   $block,
DOMDocument  $dom 
)
protected

Generates XML string for a given $block object.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Block$block
\DOMDocument$dom
Returns
eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::generateItemXmlString (   $item,
DOMDocument  $dom 
)
protected

Generates XML string for a given $item object.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Item$item
\DOMDocument$dom
Returns
boolean|
eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::generateXmlString (   $page)

Generates XML string from $page object to be stored in storage engine.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Page$page
Returns
string

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page\toStorageValue().

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::generateZoneXmlString (   $zone,
DOMDocument  $dom 
)
protected

Generates XML string for a given $zone object.

Parameters
\eZ\Publish\Core\FieldType\Page\Parts\Zone$zone
\DOMDocument$dom
Returns

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page\generateXmlString().

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::getIndexColumn ( )

Returns the name of the index column in the attribute table.

Returns the name of the index column the datatype uses, which is either "sort_key_int" or "sort_key_string". This column is then used for filtering and sorting for this type.

Returns
string

Implements eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter.

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::restoreBlockFromXml ( DOMElement  $node)
protected

Restores value for a given Block $node.

Parameters
\DOMElement$node
Returns
eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::restoreItemFromXml ( DOMElement  $node)
protected

Restores value for a given Item $node.

Parameters
\DOMElement$node
Returns
eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::restoreValueFromXmlString (   $xmlString)

Restores value from XML string.

Parameters
string$xmlString
Returns

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page\toFieldValue().

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::restoreZoneFromXml ( DOMElement  $node)
protected

Restores value for a given Zone $node.

Parameters
\DOMElement$node
Returns
eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::toFieldDefinition ( StorageFieldDefinition  $storageDef,
FieldDefinition  $fieldDef 
)

Converts field definition data in $storageDef into $fieldDef.

Parameters
\eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldDefinition$storageDef
\eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition$fieldDef

Implements eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter.

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::toFieldValue ( StorageFieldValue  $value,
FieldValue  $fieldValue 
)

Converts data from $value to $fieldValue.

Parameters
\eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue$value
\eZ\Publish\SPI\Persistence\Content\FieldValue$fieldValue

Implements eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter.

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::toStorageFieldDefinition ( FieldDefinition  $fieldDef,
StorageFieldDefinition  $storageDef 
)

Converts field definition data in $fieldDef into $storageFieldDef.

Parameters
\eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition$fieldDef
\eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldDefinition$storageDef

Implements eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter.

eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter\Page::toStorageValue ( FieldValue  $value,
StorageFieldValue  $storageFieldValue 
)

Converts data from $value to $storageFieldValue.

Parameters
\eZ\Publish\SPI\Persistence\Content\FieldValue$value
\eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue$storageFieldValue

Implements eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter.


The documentation for this class was generated from the following file: