The XmlText FieldType

Written by Petar Spanja Updated 05/26/2014 by Sarah Haïm-Lubczanski

This FieldType validates and stores formatted text.

Name	Internal name	Expected input
XmlText	ezxmltext	mixed

Input expectations

Type	Description	Example
string	XML document in the FieldType internal format as a string.	See the example below.
eZ\Publish\Core\FieldType\XmlText\Input	An instance of the class implementing FieldType abstract Input class.	See the example below.
eZ\Publish\Core\FieldType\XmlText\Value	An instance of the FieldType Value object.	See the example below.

Example of the FieldType's internal format

For XHTML Input

The eZ XML output use and by default, respecting the semantic XHTML notation.

Learn more about , , ,

Input object API

Input object is intended as a vector for different input formats. It should accept input value in a foreign format and convert it to the FieldType's internal format.

It should implement abstract eZ\Publish\Core\FieldType\XmlText\Input class, which defines only one method:

Method	Description
getInternalRepresentation	The method should return the input value in the internal format.

At the moment there is only one implementation of the Input class, eZ\Publish\Core\FieldType\XmlText\Input\EzXml, which accepts input value in the internal format, and therefore only performs validation of the input value.

Example of using the Input object

Value object API

eZ\Publish\Core\FieldType\XmlText\Value offers following properties:

Property	Type	Description
xml	DOMDocument	Internal format value as an instance of DOMDocument.

Validation

Validation of the internal format is performed in the eZ\Publish\Core\FieldType\XmlText\Input\EzXml class.

Settings

Following settings are available:

Name	Type	Default value	Description
numRows	int	10	Defines the number of rows for the online editor in the administration interface.
tagPreset	mixed	Type::TAG_PRESET_DEFAULT	Preset of tags for the online editor in the administration interface.

Tag presets

Following tag presets are available as constants in the eZ\Publish\Core\FieldType\XmlText class:

Constant	Description
TAG_PRESET_DEFAULT	Default tag preset.
TAG_PRESET_SIMPLE_FORMATTING	Preset of tags for online editor intended for simple formatting options.