General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

The documentation is moving!

We're moving our developer docs to Github and a new site.
The migration is still in progress, so please contact us in #documentation-contrib on eZ Community Slack if you have any questions or feedback.

This space will not be updated from now on except for critical fixes.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: layout change
Warning

The XmlText Field Type isn't officially supported by eZ Platform. It can be installed by requiring ezsystems/ezplatform-xmltext-fieldtype. PlatformUI does not support wysiwyg editing of this type of Field.


This Field Type validates and stores formatted text using the eZ Publish legacy format, ezxml. 

NameInternal nameExpected input
XmlTextezxmltextmixed

Table of Contents
minLevel2

Input expectations

TypeDescriptionExample
stringXML document in the Field Type internal format as a string.

See the example below.

eZ\Publish\Core\FieldType\XmlText\Input
An instance of the class implementing Field Type abstract Input class.See the example below.
eZ\Publish\Core\FieldType\XmlText\Value
An instance of the Field Type Value object.See the example below.

Example of the Field Type's internal format

Code Block
languagexml
linenumberstrue
<?xml version="1.0" encoding="utf-8"?>
<section
	xmlns:custom="http://ez.no/namespaces/ezpublish3/custom/"
	xmlns:image="http://ez.no/namespaces/ezpublish3/image/"
	xmlns:xhtml="http://ez.no/namespaces/ezpublish3/xhtml/">
    <paragraph>This is a paragraph.</paragraph>
</section>

For XHTML Input

The eZ XML output uses <strong> and <em> by default, respecting the semantic XHTML notation.

Info
iconfalse
titleLearn more about <strong>, <b>, <em>, <i>


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 Field Type's internal format.

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

MethodDescription
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.

Code Block
languagephp
titleExample of using the Input object
linenumberstrue
...
 
use eZ\Publish\Core\FieldType\XmlText\Input\EzXml as EzXmlInput;

...

$contentService = $repository->getContentService();
$contentTypeService = $repository->getContentTypeService();
 
$contentType = $contentTypeService->loadContentTypeByIdentifier( "article" );
$contentCreateStruct = $contentService->newContentCreateStruct( $contentType, "eng-GB" );

$inputString = <<<EZXML
<?xml version="1.0" encoding="utf-8"?>
<section
	xmlns:custom="http://ez.no/namespaces/ezpublish3/custom/"
	xmlns:image="http://ez.no/namespaces/ezpublish3/image/"
	xmlns:xhtml="http://ez.no/namespaces/ezpublish3/xhtml/">
    <paragraph>This is a paragraph.</paragraph>
</section>
EZXML;
 
$ezxmlInput = new EzXmlInput( $inputString );

$contentCreateStruct->setField( "description", $ezxmlInput );
 
...

Value object API

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

PropertyTypeDescription
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:

NameTypeDefault valueDescription

numRows

int10Defines the number of rows for the online editor in the administration interface.

tagPreset

mixedType::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:

ConstantDescription
TAG_PRESET_DEFAULT
Default tag preset.
TAG_PRESET_SIMPLE_FORMATTING

Preset of tags for online editor intended for simple formatting options.

Code Block
languagephp
titleExample of using settings in PHP
linenumberstrue
...
 
use eZ\Publish\Core\FieldType\XmlText\Type;

...

$contentTypeService = $repository->getContentTypeService();
$xmltextFieldCreateStruct = $contentTypeService->newFieldDefinitionCreateStruct( "description", "ezxmltext" );

$xmltextFieldCreateStruct->fieldSettings = array(
	"numRows" => 25,
	"tagPreset" => Type::TAG_PRESET_SIMPLE_FORMATTING
);
 
...