This Field Type validates and stores structured rich text, and exposes it in several formats.
| Name | Internal name | Expected input |
|---|---|---|
RichText | ezrichtext | mixed |
Input expectations
| Type | Description | Example |
|---|---|---|
string | XML document in one of the Field Type's input formats as a string. | See the example below. |
DOMDocument | XML document in one of the Field Type's input formats as a
| See the example below. |
eZ\Publish\Core\FieldType\RichText\Value | An instance of the Field Type's Value object. | See the example below. |
Input formats
Field Type works with XML and also expects an XML value as input, whether as a string, DOMDocument object or Field Type's Value object. When the value is given as a string or a DOMDocument object, it will be checked for conformance with one of the supported input formats, then dispatched to the appropriate converter, to be converted to the Field Type's internal format. No conversion will be performed if providing the value in Field Type's internal format or as Field Type's Value object. In the latter case it will be expected that Value object holds the value in Field Type's internal format.
Currently supported input formats are described in the table below:
| Name | Description |
|---|---|
| eZ Publish Docbook variant | FieldType's internal format |
| XHTML5 editing format | Typically used with in-browser HTML editor |
| Legacy eZXML format | Compatibility with legacy eZXML format, used by XmlText FieldType |
Example of the Field Type's internal format
Example of the Field Type's XHTML5 edit format
This format is used by eZ Platform Online Editor and will change with it's needs as we continue to evolve this part of the UI.
For more information about internal format and input formats, see Field Type's conversion test fixtures on GitHub.
Example of using XML document in internal format as a string
Value object API
eZ\Publish\Core\FieldType\RichText\Value offers following properties:
| Property | Type | Description |
|---|---|---|
xml | DOMDocument | Internal format value as an instance of 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 Field Type's Value object, it will be treated as a string. This means you can use any supported input format for input over REST API.
2 Comments
Eirik Alfstad Johansen
Now that we're approaching the release of eZ Platform, this page is perhaps due for an update?
André Rømcke
Ideally this should have been on github so you could have contributed to it, but yes in time it will