The RichText FieldType

This format is used by eZ P

This FieldType validates and stores structured richtext, and exposes it in several formats.

RichText

ezrichtext

mixed

Input expectations

string

DOMDocument

eZ\Publish\Core\FieldType\RichText\Value

Input formats

FieldType works with XML and also expects an XML value as input, wether as a string,  DOMDocument object or FieldType's  Value  object. When the value is given as a string or a DOMDocument  object, it will be checked for conformance to the one of the supported input formats, then dispatched to the appropriate converter, to be converted to the FieldType's internal format. No conversion will be performed if providing the value in FieldType's internal format, or when providing the value as FieldType's  Value  object. In the latter case it will be expected that Value  object holds the value in FieldType's internal format.

Currently supported input formats are described in the table below:

Example of the FieldType's internal format

Example of the FieldType's XHTML5 edit format

Example of using XML document in internal format as a string

Value object API

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

xml

DOMDocument

REST API specifics

Creating or updating Content

When creating RichText content with the REST API, it is possible to provide data as a string, using the "xml" fieldValue key:

When the value given over REST API is transformed into a FieldType's  Value  object, it will be treated as a string. This means you can use any supported input format for input over REST API.