eZ Publish 5.2 has a strong focus on backwards compatibility and thus lets you reuse code you might have written for 4.x, including templates and modules.
Read Intro for eZ Publish 4.x/3.x developers to have an overview of common concepts and terminology changes.
Legacy mode is a specific configuration mode where eZ Publish's behavior is the closest to v4.x. It might be used in some very specific use cases, such as running the admin interface.
What it does
- Still runs through the whole Symfony kernel. As such, Symfony services can still be accessed from legacy stack.
- Disables the default router (standard Symfony routes won't work in this mode)
- Disables the UrlAliasRouter. As such, the ViewController will be bypassed.
What it doesn't do
- Increase performance. Legacy mode is actually painful for performances since it won't use the HttpCache mechanism.
In a migration context, using Legacy Mode is never a good option as it prevents all the performance goodness (e.g. Http Cache) to work.
Always keep in mind that, not running in legacy mode, if a content still doesn't have a corresponding Twig template/controller, eZ Publish will always fallback to the legacy kernel, looking for a legacy template.
Allowing Symfony routes to work
As of eZ Publish 5.2, Symfony routes are also disabled in legacy mode, which implies admin interface as well.
If for some reason you need a Symfony route to work, you add it to a whitelist :
_ezpublishLegacyTreeMenu and all REST v2 (
ezpublish_rest_ prefix) routes are allowed.
Legacy Template inclusion
It is possible to include old templates (.tpl) into new ones.
Or if you want to include a legacy template by its path, relative to
Scalar and array parameters are passed to a legacy template as-is.
Objects, however, are being converted in order to comply the legacy eZ Template API. By default a generic adapter is used, exposing all public properties and getters. You can define your own converter by implementing the appropriate interface and declare it as a service with the
Location objects from the Public API are converted into
eZContentObjectTreeNode objects (re-fetched).
Running legacy code
eZ Publish 5 still relies on the legacy kernel (from 4.x) and runs it when needed inside an isolated PHP closure, making it sandboxed. This is available for your use as well making it possible to run some PHP code inside that sandbox through the
The example above is very simple and naive - in fact for accessing configuration settings from the Legacy Stack using the ConfigResolver is recommended.
Using the legacy closure, you'll be able to even run complex legacy features, like an eZ Find search:
Routing fallback & sub-requests
Any route that is not declared in eZ Publish 5 in an included
routing.yml and that is not a valid UrlAlias will automatically fallback to eZ Publish legacy (including admin interface).
This allows all your old modules to work as before, out-of-the-box (including kernel modules), and also allows you to reuse this code from your templates using sub requests:
Using eZ Publish 5 and Symfony features in Legacy
If for some reason you need to develop a legacy module and access to eZ Publish 5 / Symfony features (i.e. when developing an extension for admin interface), you'll be happy to know that you actually have access to all services registered in the whole framework, including bundles, through the service container.
The example below shows how to retrieve the content repository and the logger.
The example above works in legacy modules and CLI scripts
Running legacy scripts and cronjobs
Note: This feature has been introduced in eZ Publish 5.1.
Running legacy scripts and cronjobs through the Symfony stack is highly recommended !
Otherwise, features from the Symfony stack cannot be used (i.e. HTTP cache purge) and cache clearing. NB: Some script we know won't affect cache, are still documented to be executed the direct way.
Legacy scripts can be executed form the Symfony CLI, by using the
ezpublish:legacy:script command, specifying the path to the script as argument.
The command will need to be executed from eZ Publish's 5 root, and the path to the desired script must exist in the
Here's a usage example:
Here we made sure to specify --env=prod, this is needed for all legacy scripts that clear cache, otherwise they will will clear dev environment cache instead of prod for Symfony stack.
If you want to access the script's help please be aware that you will need to use the newly introduced
--legacy-help option, since --help is already reserved for the CLI help.
--legacy-help option should be added before the path to the script for this to work.
Here's an example:
The same logic will apply for cronjob execution.
Legacy cronjobs are triggered by the
runcronjobs.php legacy script, which expects the name of the cronjob to run as a parameter.
This is how you can run cronjobs from the Symfony CLI:
Also, if you require using additional script options, please be sure to use the long name, such as
--debug to avoid conflicts between script and CLI options.
For more details regarding legacy cronjobs execution please refer to the Running cronjobs chapter existing in doc.ez.no.