XmlText field type implementation for eZ Platform

Installs: 213 757

Dependents: 4

Suggesters: 0

Security: 0

Stars: 16

Watchers: 25

Forks: 28

Open Issues: 4



Build Status Downloads Latest release License

This is the XmlText field type for eZ Platform. It was extracted from the eZ Publish / Platform 5.x as it has been suceeded by docbook based RichText field type.

Support limitations

  • 2.x: For eZ Platform v3, this bundle is only supported for the purpose of migrating content from XmlText to RichText field type
  • 1.x: For eZ Platform v1 & v2, this bundle is supported for two use cases: Migration to Richtext, & rendering via Platform frontend*.

* While it does support editing via Platform Admin UI it is only editable as raw xmltext in a textbox, so supported use as of this field type is for temprary upgrde scenarios where legacy admin interface is used, and frontend code is being developed/migrated to eZ Platform stack (including to Symfony).


NOTE: This package comes already bundled with Legacy Bridge. However if you would rather like to 1. migrate your content directly to eZ Platform to take full advantage of it, or 2. otherwise don't want to use legacy but need this field type for some legacy content usage within pure eZ Platform setup, then run the following:

composer require --update-with-all-dependencies "ezsystems/ezplatform-xmltext-fieldtype"

And lastly enable the bundle by adding new EzSystems\EzPlatformXmlTextFieldTypeBundle\EzSystemsEzPlatformXmlTextFieldTypeBundle(), to app/AppKernel.php list of bundles.

Once you have migrated your content you can remove the bundle from both app/AppKernel.php and composer.json.

Migrating from XmlText to RichText

Warning: As of 1.6 this is now fully supported, but regardless of that always make a backup before using the migration tools.

This package provides tools to migration existing XmlText fields to RichText, the enriched text format eZ Platform uses. The tool comes as a Symfony command, ezxmltext:convert-to-richtext.

It will do two things:

  • convert ezxmltext field definitions to ezrichtext field definitions
  • convert ezxmltext fields (content) to ezrichtext

We recommend that you do a test run first using something like:

php bin/console ezxmltext:convert-to-richtext -v --concurrency=2 --dry-run

The -v flag will output logs to the console, making it easy to track the conversion work that is being done. This is an example of a successful conversion log entry for one field:

[2016-02-03 15:25:52] app.INFO: Converted ezxmltext field #745 to richtext {"original":"<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<section xmlns:image=\"http://ez.no/namespaces/ezpublish3/image/\" xmlns:xhtml=\"http://ez.no/namespaces/ezpublish3/xhtml/\" xmlns:custom=\"http://ez.no/namespaces/ezpublish3/custom/\"/>\n","converted":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:ezxhtml=\"http://ez.no/xmlns/ezpublish/docbook/xhtml\" xmlns:ezcustom=\"http://ez.no/xmlns/ezpublish/docbook/custom\" version=\"5.0-variant ezpublish-1.0\"/>\n"}

It contains, in a JSON structure, the original (ezxmltext) value, and the converted (ezrichtext) value that has been written to the database.

Once you are ready to convert, drop -v and --dry-run.