| Status | ||||
|---|---|---|---|---|
|
IO URL decoration
By default, images and binary files referenced by content will be served from the same server than as the application, like /var/ezdemo_site/storage/images/3/6/4/6/6463-1-eng-GB/kidding.png. This is the default semantic configuration:
...
$var_dir$ and $storage_dir$ are dynamic, siteaccess-aware settings, and will be replaced by those settings value in the execution context.
...
| Warning |
|---|
URL decorators are an eZ Publish 5 Platform features. If an image field is displayed via a legacy callback or legacy template, no decoration will be applied. |
...
One common use-case is to use an optimized nginx to serve images in an optimized way. The example image above could be made available as http://static.example.com/images/3/6/4/6/6463-1-eng-GB/kidding.png, by setting up a server that uses ezpublish/ezpublish_legacy/var/ezdemo_site/storage. The eZ Publish Platform configuration would be as follows:
...
| Info |
|---|
Legacy compatiblityLegacy still requires non-absolute path to store images (var/site/storage/images/etc...). In order to work around this, an a |
...
Those settings are siteaccess-aware.
io.url_prefix
Default value: $var_dir$/$storage_dir$
Example: /var/ezdemo_site/storage
...
Used by the legacy storage engine to convert images public URI to a format it understands. Unlike io.url_prefix, it is not an absolute link. Can not Cannot be overridden using semantic configuration. Changing this value will break compatibility for the legacy backoffice.
...
Physical path where binary files are stored on disk. Can not Cannot be overridden using semantic configuration. Changing this value will break compatibility for the legacy backoffice.
Services
...
URL decorators
An UrlDecorator decorates and undecorates a given string (url) in some way. It has two mirror methods: decorate and undecorate.
Two implementations are provided: Prefix, and AbsolutePrefix. They both add a prefix to an a URL, but AbsolutePrefix will ensure that unless the prefix is an external URL, the result will be prepended with /.
...
ezpublish.core.io.prefix_url_decoratorUsed used by the binarydata handlers to decorate all uris sent out by the API. Uses AbsolutePrefix.ezpublish.core.io.image_fieldtype.legacy_url_decoratorUsed used via the UrlRedecorator (see below) by various legacy elements (Converter, Storage Gateway, etc...) to generate its internal storage format for uris. Uses a Prefix, not an AbsolutePrefix, meaning that no leading / is added.
In addition, an a UrlRedecorator service, ezpublish.core.io.image_fieldtype.legacy_url_redecorator, uses both decorators abive above to convert URIs between what is used on the new stack, and what format legacy expects (relative urls from the ezpublish root).