Upgrade

It is recommended to rebuild all indexes after an upgrade:

emsco:environment:rebuild --all

7.4

`ems:admin:backup` exports assets

The ems:admin:backup command now exports assets in addition to configurations and documents. To keep the previous behavior and exclude assets from the backup, combine the --configs and --documents options.

`ems:admin:restore` imports assets

The ems:admin:restore command now imports assets in addition to configurations and documents. To keep the previous behavior and exclude assets from the restore, combine the --configs and --documents options.

Translated choice fields

The choices and labels configured directly on a content type with ChoiceFieldType cannot be translated. For translated choices, migrate the field to ChoiceListFieldType and select a ChoiceList entity. The ChoiceList contains the choice values, fallback labels, optional groups and their locale-specific translations.

`emsco_cant_be_finalized` parameters

The $code and $previous parameters of emsco_cant_be_finalized have been removed. They were normally unused. The new $translations parameter accepts an associative array of locale codes and translated error messages, for example {fr: 'Mon texte d\'erreur en français'} in Twig.

Legacy routes name removed

job.start -> emsco_job_start
job.add -> emsco_admin_job_add
job.index -> emsco_admin_job_index
job.delete -> emsco_admin_job_delete

Security headers

Security headers: Starting with 7.4, EMS defines security headers by default. Review your Twig templates and use the new response-header functions when a template must add, override, or remove a header. See the ResponseHeaderExtension documentation for ems_http_header, ems_remove_http_header, ems_clear_http_headers, ems_csp_source, and ems_nonce. Important: Adding a source to a CSP directive replaces its default value. If the self source is required, declare it explicitly, for example: {%- do ems_csp_source('style-src', "'self'") -%} and {%- do ems_csp_source('script-src', "'self'") -%}.
Before upgrading, disable any equivalent security headers configured in the web server or reverse proxy. Defining the same headers at both levels can produce conflicting values, especially for Content-Security-Policy.

Legacy Search

The legacy search (/search) has been removed, along with the Search, SortOption, SearchFieldOption, and AggregateOption entities.

If needed, for PostgreSQL databases, a Doctrine migration script creates an advanced_search dashboard based on the existing Search, SortOption, SearchFieldOption, and AggregateOption entities. However, the migration script cannot migrate the templates of the AggregateOption entities. You must review these templates. Here is an example (compatible with eMS Bootstrap theme 3 and 5) of a template for a user aggregation facet:

twig

{% set fieldName = '_finalized_by' %}

{% if aggregation.buckets|default([])|length > 0 %}
    <div class="d-grid gap-2 text-start">
        {% if aggregation.buckets|length == 1 and search.filters|filter(p => p.operator == 'term' and p.booleanClause == 'must' and p.field == fieldName)|length == 1 %}
            <div class="d-grid gap-2 text-start">
                {% for key, filter in search.filters|filter(p => p.operator == 'term' and p.booleanClause == 'must' and p.field == fieldName) %}
                    <a href="{{ path(paginationPath, currentFilters|merge({ removeFilter: key })) }}" class="btn btn-block btn-social btn-default d-flex align-items-center">
                        <i class="fa fa-remove me-2"></i>
                        Remove facet "{{ aggregation.buckets[0].key|emsco_display_name }}"
                    </a>
                {% endfor %}
        {% else %}
            {% for index in aggregation.buckets %}
                <a href="{{ path(paginationPath, currentFilters|merge({ operator: 'term', clause: 'must', field: fieldName, pattern: index.key, boost: 0.5 })) }}" class="btn btn-block btn-social btn-default d-flex align-items-center">
                    <i class="fa fa-user me-2"></i>
                    {{ index.key|emsco_display_name }}
                    <span class="badge bg-secondary ms-auto pull-right">{{ index.doc_count }}</span>
                </a>
            {% endfor %}
        {% endif %}
    </div>
{% endif %}

Search entities have been removed. For each search entity defined as the default search for a content type, the PostgreSQL migration adds a redirect view to the advanced_search dashboard to the content type. You can add a redirect view to the advanced_search dashboard using the following template:

twig

{%- set data = {contentTypes:[view.contentType.name],environments:[view.contentType.environment.name],filters:[{booleanClause:"must",field:"",operator:"query_and",pattern:""}],minimumShouldMatch:"1",sortBy:"_finalization_datetime",sortOrder:"asc"} -%}
{%- set uid = emsco_save_contents(data|json_encode, 'search_page.json', 'application/json', 1).sha1 -%}

{{- path('emsco_dashboard', {uid:uid, name:'advanced_search'}) -}}

Note: the search in my circles feature is removed and not automatically migrated to a redirection view.

For PostgreSQL databases, a query search has been created for each search entity to replace it. However:

The migration script does not support filters on nested fields. You must review the query search manually.
The migration script does not update DataLinkFieldType entities. You must review content types containing data links for which the displayOptions.type or displayOptions.searchId option is defined.

7.3

BC: media library template no longer relies on Bootstrap classes or Font Awesome icons by default, make sure to update the template. The file link now is not required to have the json attribute.
BC: CKEditor is deprecated and will be removed in 8.*, you should use tiptap.
BC: dashboard type media_lib_browse_object is deprecated, not needed anymore with tiptap.
BC: removed EMSCH_ASSET_CONFIG_TYPE was not used anymore
Feature: _authenticated attribute on routes can be replaced by a EMSCH_SECURITY_FIREWALL (see demo)
BC: Merged the following translation domains into emsco-core: emsco-component, emsco-contenttype, emsco-environment, emsco-forms, emsco-twigs, emsco-user.
BC: Renamed the emsco-mimetypes domain to ems-mimetypes, making mimetypes translatable on the front-end as well.

7.2

The command option --user is deprecated, use --username instead for the following commands
- emsco:contenttype:transform
- emsco:revision:lock
- emsco:environment:align
- emsco:environment:unpublish
Redo a make init is required in order to initialize a docker/sandbox.env file. Also, a DOCKER_USER variable has been introduced in the docker/.env file.

7.x

Symfony upgraded 6.4 → 7.4
PHP minimum requirement increased from 8.4 → 8.5
Support for Elasticsearch 7 has been dropped
OpenTelemetry is now required see install

Dependency Upgrades

phpunit/phpunit: 11.5 → 12.5
doctrine/doctrine-bundle : 2.18.2 → 3.2.2
doctrine/doctrine-migrations-bundle : 3.7.0 → 4.0.0
elasticsearch/elasticsearch: 7.17.3 → 8.19.0
ruflin/elastica: 7.3.2 → 8.2.0
giggsey/libphonenumber-for-php: 8.13.55 → 9.0.22
sensiolabs/ansi-to-html: 1.3.0 → 2.0.0
symplify/monorepo-builder: 11.2.23 → 12.4.5
phpoffice/phpspreadsheet: 3.10.3 → 5.4.0
kevinrob/guzzle-cache-middleware: 6.0 → 7.0

Breaking Changes

emsch_assets_version now only accepts the hash argument; saveDir removed and no longer returns a value.
Web search: removed facets (use filters), removed nested_path (use parent_field), sizes and sorts now only accept predefined values.
Admin media library: removed nested_path (use parent_field).
Removed saveDir option from WysiwygStyleSet.
Removed $sourceExclude argument from Twig function emsch_search.
Removed EMS\ClientHelperBundle\Controller\AssetController (use EMS\CommonBundle\Controller\FileController instead).
Removed FileController::download and FileController::view (use ems_asset Twig filter).
Removed EMS_WEBALIZE_DASHABLE_REGEX and EMS_WEBALIZE_REMOVABLE_REGEX (use ems_slug instead of ems_webalize).
Removed EMSCH_BACKEND_URL use EMS_BACKEND_URL
Removed EMSCH_ELASTICSEARCH_CLUSTER use EMS_ELASTICSEARCH_HOSTS
Removed support for %locale% in skeleton routes and search config (use %_locale%).
Removed form field SendConfirmation (use NumberType or HiddenType with VerificationCode validator).
Removed admin field JsonFieldType (use CodeFieldType).
Removed route ems_core_asset_proxy.
Removed Core API methods hashFile, initUpload, addChunk (use file endpoint).
Removed _type fallback for EMSLink and document (use _contenttype).

Routes

Removed deprecated route names

Deprecated route aliases have been removed. Use the emsco_* route instead.

Removed route (6.x)	Replacement (7.x)	Remark
`ems_data_default_search`	`emsco_data_default_search`
`data.root`	`emsco_data_default_search`
`ems_search_in_my_circles`	`emsco_data_search_in_my_circles`
`data.view`	`emsco_data_view`
`data.revision_in_environment`	`emsco_data_revision_in_environment`
`ems_content_revisions_view`	`emsco_view_revisions`
`data.revisions`	`emsco_view_revisions`
`revision.copy`	`emsco_data_copy`
`revision.new-draft`	`emsco_data_new_draft`
`object.delete`	`emsco_data_delete`
`revision.discard`	`emsco_discard_draft`
`revision.cancel`	`emsco_data_cancel_modifications`
`revision.reindex`	`emsco_data_reindex`
`data.customindexview`	`emsco_data_private_view`
`ems_custom_view_protected`	`emsco_data_private_view`
`data.customview`	`emsco_data_private_action`	Path changed: `/data/custom-view/…` → `/data/action/…`
`ems_data_custom_template_protected`	`emsco_data_private_action`	Path changed: `/data/template/…` → `/data/action/…`
`ems_job_custom_view`	`emsco_job_custom_view`
`revision.ajaxupdate`	`emsco_data_ajax_update`
`revision.finalize`	`emsco_data_finalize`
`data.add`	`emsco_data_add`
`revision.revert`	`emsco_data_revert`
`data.link`	`emsco_data_link`
`ems_custom_view_public`	`emsco_data_public_view`
`ems_data_custom_template_public`	`emsco_data_public_action`	Path changed: `/public/template/…` → `/public/action/…`
`ems_core_dashboard`	`emsco_dashboard_home`
`ems_data_trash`	`emsco_data_trash`
`ems_data_put_back`	`emsco_data_put_back`
`ems_data_empty_trash`	`emsco_data_empty_trash`
`ems_revision_edit`	`emsco_edit_revision`
`revision.edit`	`emsco_edit_revision`
`data.draft_in_progress`	`emsco_draft_in_progress`
`job.status`	`emsco_job_status`
`ems.user.index`	`emsco_user_index`
`user.add`	`emsco_user_add`
`user.edit`	`emsco_user_edit`	Parameter `id` → `user`
`user.delete`	`emsco_user_delete`	Parameter `id` → `user`
`user.enabling`	`emsco_user_enabling`	Parameter `id` → `user`
`EMS_user_apikey`	`emsco_user_api_key`
`api.test`	`emsco_interface_test`
`file.init-upload`	`emsco_file_data_init_upload`	No `sha1`/`size` path parameters anymore
`file.uploadchunk`	`emsco_file_data_chunk_upload`	Parameter `sha1` → `hash`
`file.api.init-upload`	`emsco_file_api_init_upload`	No `sha1`/`size` path parameters anymore
`file.api.uploadchunk`	`emsco_file_api_chunk_upload`	Parameter `sha1` → `hash`

Twig

Removed functions in favor of the following replacements:

emsch_assets → emsch_assets_version
emsch_unzip → ems_file_from_archive
ems_unzip → ems_file_from_archive
get_default_environments → emsco_get_default_environment_names
emsco_uuid → ems_uuid
cant_be_finalized → emsco_cant_be_finalized
get_content_types → emsco_get_content_types
sequence → emsco_sequence
is_super → emsco_is_super
call_user_func → emsco_call_user_func
diff_text → emsco_diff_text
diff → emsco_diff
diff_html → emsco_diff_html
diff_icon → emsco_diff_icon
diff_raw → emsco_diff_raw
diff_color → emsco_diff_color
diff_boolean → emsco_diff_boolean
diff_choice → emsco_diff_choice
diff_data_link → emsco_diff_data_link
diff_date → emsco_diff_date
diff_time → emsco_diff_time

Removed filters in favor of the following replacements:

emsch_data → emsch_get
ems_webalize → ems_slug
array_key → ems_array_key
format_bytes → ems_format_bytes
locale_attr → ems_locale_attr
emsch_ouuid → ems_ouuid
array_intersect → ems_array_intersect
merge_recursive → ems_array_merge_recursive
inArray → ems_in_array
md5 → ems_md5
luma → ems_luma
contrastratio → ems_contrast_ratio
firstInArray → ems_first_in_array
url_generator → ems_slug
emsco_webalize → ems_slug
get_environment → emsco_get_environment
get_content_type → emsco_get_content_type
data_label → emsco_display
data → emsco_get
json_decode → ems_json_decode
search → emsco_search_query
convertJavaDateFormat → emsco_convert_java_date_format
convertJavascriptDateFormat → emsco_convert_javascript_date_format
convertJavascriptDateRangeFormat → emsco_convert_javascript_date_range_format
getTimeFieldTimeFormat → emsco_time_field_time_format
soapRequest → emsco_soap_request
all_granted → emsco_all_granted
one_granted → emsco_one_granted
in_my_circles → emsco_in_my_circles
data_link → emsco_data_link
is_super → emsco_is_super
generate_from_template → emsco_generate_from_template
objectChoiceLoader → emsco_object_choice_loader
groupedObjectLoader → emsco_grouped_object_loader
propertyPath → emsco_property_path
i18n → emsco_i18n
internal_links → emsco_internal_links
src_path → emsco_src_path
get_user → emsco_get_user
displayname → emsco_display_name
date_difference → emsco_date_difference
debug → emsco_debug
call_user_func → emsco_call_user_func
get_string → emsco_get_string
get_file → emsco_get_file
get_field_by_path → emsco_get_field_by_path
get_revision_id → emsco_get_revision_id

6.9.13

If the media_lib_file block of the media_library component has been overridden and a file browser dashboard is defined, a data-json attribute must be added to the file selection link, as illustrated below:

twig

        <a class="btn-file-view" href="{{- mediaFile.urlView -}}" data-id="{{- mediaFile.id -}}" data-json="{{ mediaFile.getDataJson()|e('html_attr') }}">

6.9.2

Media library: the "nested_path" option for sorting is deprecated, use "parent_field" instead.
Skeleton search config: filters "nested_path" option is deprecated, use "parent_field" instead.
If you use "nested_path" inside es queries it should be replaced by { "nested": { "path": "..." } }, this is why elasticms is not using nested_path as option key anymore.

6.9.0

The option --strict will throw an exception in the command emsco:revision:unlock use -n instead.
The alias emsco:revisions:unlock command is deprecated use emsco:revision:unlock instead.
The alias emsco:contenttype:lock command is deprecated use emsco:revision:lock instead.

6.5.0

Attention: The following step is no need if you use 6.9.0 or later version.

If your project use a medialibrary, you need to modify your Wysiwyg config and add "oldFileHandling": true :

json

{
    "ems": {
        "oldFileHandling": true
    }
}

6.4.1

Add a new twig global emschLocales which contains the EMSCH_LOCALES Because it is added by the clientHelperBundle it is available in admin and website templates Replace app.request.server.get('EMSCH_LOCALES')|json_decode by emschLocales

6.4.0

Add mercure (open solution for real-time communications)
- make sure the environment variables are defined.
- more information
Symfony messenger component more information

6.1.1

We added a new cli command emscli:import:database. Good practice to replace emscli:file-reader:import now alias for emscli:import:file

6.0.x

Postgres 17

The demo/docker-compose.yml and the docker/docker-compose.yml files have been upgraded to use Postgres 17 insterad of Postgres 12. Unfortunately, you will have to dump your schemas, delete the Postgres's docker volume with the command docker volume rm ems-mono_postgres. And finally, recreate Postgres schemas and reload you dumps.

Symfony request inputBag

Since symfony 6 the inputBag becomes stricter.

twig

{# request example http://localhost?filters[]=value1&filters[]=value2&filters[]=value3 #}

{%- set selectedFilters = app.request.query.get('filters') -%} {# can only work with scalar values #}
Expected a scalar value as a 2nd argument to "Symfony\Component\HttpFoundation\InputBag::get()", "array" given."

{%- set selectedFilters = app.request.query.all('filters') -%} {# correct #}

Renamed embed methods in web/skeleton templates

All controller methods have lost any trailing Action

emsch.controller.embed::renderBlockAction must be replaced by emsch.controller.embed::renderEmbed
emsch.controller.embed::renderHierarchyAction must be replaced by emsch.controller.embed::renderHierarchy

E.g.:

twig

{{ render(controller('emsch.controller.embed::renderHierarchy', {
    'template': '@EMSCH/template/menu.html.twig',
    'parent': 'emsLink',
    'field': 'children',
    'depth': 5,
    'sourceFields': [],
    'args': {'activeChild': emsLink, 'extra': 'test'}
} )) }}

Routes removed

template.index must be replaced by ems_core_action_index
template.add must be replaced by ems_core_action_add
template.edit must be replaced by ems_core_action_edit
template.remove must be replaced by ems_core_action_delete

Deprecated twig filters

array_key must be replaced by ems_array_key
format_bytes must be replaced by ems_format_bytes
locale_attr must be replaced by ems_locale_attr
data must be replaced by emsco_get.source
url_generator must be replaced by ems_webalize
get_environment must be replaced by emsco_get_environment
get_content_type must be replaced by emsco_get_contentType
data_label must be replaced by emsco_display
emsch_ouuid must be replaced by ems_ouuid
array_intersect must be replaced by ems_array_intersect
merge_recursive must be replaced by ems_array_merge_recursive
inArray must be replaced by ems_in_array
soapRequest must be replaced by emsco_soap_request
all_granted must be replaced by emsco_all_granted
one_granted must be replaced by emsco_one_granted
in_my_circles must be replaced by emsco_in_my_circles
data_link must be replaced by emsco_data_link
i18n must be replaced by emsco_i18n
internal_links must be replaced by emsco_internal_links
displayname must be replaced by emsco_display_name
get_field_by_path must be replaced by emsco_get_field_by_path
get_revision_id must be replaced by the function emsco_get_revision_id

Deprecated twig function

cant_be_finalized must be replaced by emsco_cant_be_finalized
get_default_environments must be replaced by emsco_get_default_environment_names
get_content_types must be replaced by emsco_get_content_types
sequence deprecated and must be replaced by emsco_sequence

New dynamic mapping config which change the elasticsearch indexes

Before version 6 it was not possible to define elasticsearch dynamic mapping config. In other words, before version 6, every fields present in a document, that aren't strictly defined in the content type, a mapping was automatically guessed by elasticsearch.

Since version 6 the default dynamic mapping config has changed. New fields are ignored. These fields will not be indexed or searchable, but will still appear in the _source field of returned hits. These fields will not be added to the mapping, and new fields must be added explicitly into the content type.

You can reactivate the dynamic mapping with this environment variable: EMSCO_DYNAMIC_MAPPING='true'. But it's not recommended. Check the EMSCO_DYNAMIC_MAPPING documentation

5.25.x

The emsco:environment:align will after publication also unpublish documents that are not aligned.

5.24.x

There is breaking changes in the options of the File Reader Import command. Command's options must be defined in a json format now, and that JSON can be passed to the --config option as:

a JSON string
a path to a JSON file
the hash of a JSON file in the storage services

Please update your worker's jobs.

5.23.x

From this version, the upload of web's assets via the command emsch:local:upload-assets wont upload a zip anymore but each assets independently. The hash provided at the end of the command, is the hash of a JSON containing the structure of the assets within the asset folder, we called those JSON an ElasticMS archive or EMS Archive. E.g.:

json

[
    {
        "filename": "css/index.css",
        "hash": "9408821ad2bd8f65b7cd7d3913c01218532fc6b2",
        "type": "text/css",
        "size": 244030
    },
    {
        "filename": "img/head/icon.png",
        "hash": "cf4effd785abdb6b58e560c7645cedda5c9fda16",
        "type": "image/png",
        "size": 74640
    },
    {
        "filename": "img/logos/ems-logo.svg",
        "hash": "10b8fa0d6c1e1b1a21b713341424820d379b0a6b",
        "type": "image/svg+xml",
        "size": 24638
    },
    {
        "filename": "img/logos/full-logo.svg",
        "hash": "1f59b7246eb4f6856d42128ad17c4fb59d15f038",
        "type": "image/svg+xml",
        "size": 17415
    },
    {
        "filename": "js/index.js",
        "hash": "010a2066374e5980be0b68d628acd1b624602ab5",
        "type": "text/javascript",
        "size": 190044
    }
]

Using those EMS Archive has a huge impact on the performances. Especially at the website warming up. You can use that EMS Archive's hash where ever you want instead of the old ZIP's hash. E.g. in the Twig function emsch_assets_version:

twig

{% do emsch_assets_version(include('@EMSCH/template/asset_hash.twig'), null) %}

If, for some reason you want, you can continue to use ZIP archives. Or by active the option --archive=zip int the emsch:local:upload-assets command. Or by manually uploading the ZIP file in the Admin UI. ElasticMS detects if it's a EMR archive or a zip archive.

It's not required, but warmly recommended to re-upload your assets and update the asset's hash in the website templates.

5.22.x

Updates on json menu nested template (copy/paste functionality)
Removed environment variable: EMSCO_FALLBACK_LOCALE

Add new method getLanguage on user object

preferred locale 'nl_FR' returns 'nl'

twig

{% set language = app.user.localePreferred[0:2] %} //before
{% set language = app.user.language %} //now

{# sort based on user language #}
{% set languages = ['fr', 'nl']|sort((a, b) => a == app.user.language ? -1 : b == app.user.language ? 1 : 0) %}

5.21.x

Core twig component Media library: Removed the option fieldPathOrder, use new option sort (defining all possible sorts)

5.19.x

The core command emsco:release:publish has been removed, emsco:job:run will now publish releases
All indexes must be rebuilt (as a new field _image_resized_hash as been defined in file field's mapping): emsco:environment:rebuild --all
The function emsch_unzip is deprecated and should not be used anymore. use the function ems_file_from_archive or the route EMS\CommonBundle\Controller\FileController::assetInArchive instead
- If the emsch_unzip function is used to serve assets via the web server you should use the route EMS\CommonBundle\Controller\FileController::assetInArchive
- If the emsch_unzip function is used to get local path to an asset you should use the ems_file_from_archive function
Xliff command options have been updated
- The --filename option in the emsco:xliff:extract command has been replaced by a --basename option and does not contains a path anymore, just a file basename.
  Example replace emsco:xliff:extract live '{}' nl de title --filename=/tmp/pages-nl-to-de.xlf by emsco:xliff:extract live '{}' nl de title --basename=pages-nl-to-de.xlf
- In case of warning or error in the emsco:xliff:update command the report file is no more available locally. The report is upladed in the admin's storages. The directly get a link to the report you need to specify a --base-url option.
  Example emsco:xliff:update /tmp/pages-nl-to-de.xlf --base-url=https://my-admin.my-project.tld
You should not specify a folder where to expand website assets in the emsch_assets_version twig function, in this case the function returns null.
- By default, if you specify null (e.g. {% do emsch_assets_version(include('@EMSCH/template/asset_hash.twig'), null) %}) as second arguments, the emsch assets will have a an url like /bundles/253b903b1fb3ac30975ae9844a0352a65cdcfa3d/site.css which urls will be resolved by the route EMS\CommonBundle\Controller\FileController::assetInArchive
- It's also possible the defined you own route for assets in archive, if the route is not immutable (does not contain the archive hash) you must specify the maxAge argument (by default it's set to one week):

yaml

emsch_demo_asset_in_archive:
    config:
        path: '/assets_in_archive/{path}'
        requirements: { path: .* }
        defaults: { hash: 253b903b1fb3ac30975ae9844a0352a65cdcfa3d, maxAge: 3600 }
        controller: 'EMS\CommonBundle\Controller\FileController::assetInArchive'

Check if you can refactor the use of the _file_names attribute in processor config. You should refer to file in an archive (e.g. 8ef54d1e170aede4fa78687f466f35bb6292f4ad:img/banners/banner-home.jpg) instead of file on the local file system.

5.17.x

Check routes single colon is deprecated
Example replace emsch.controller.router:redirect by emsch.controller.router::redirect

5.15.x

Form routes are available inside the elasticms-admin
- Skeleton no longer need to proxy the form routes for making form working inside channels. #848
The form debug routes are no longer 'dev' mode only
The form debug routes are available inside the elasticms-admin

5.14.x

All tasks records will be deleted after deployment
- Because we had to upgrade the database schema. #778
If you are using revision versions, you should run ems:environment:updatemetafield after deployment.

5.7.x

Added twig function ems_template_exists
Added probe routes /_readiness and /_liveness for admin and web
Added header support for Redirect controller.
Added multipart support for s3
Added infinity scrolling for MediaLibrary
Added draggable file upload for MediaLibrary

Added ems:admin:restore command

bash

ems:admin:restore --configs --force
ems:admin:restore --documents --force

Added filename option for upload assets command

bash

emsch:local:upload-assets --filename=/opt/src/local/skeleton/template/asset_hash.twig

twig

{% set assetPath = emsch_assets_version(include('@EMSCH/template/asset_hash.twig')) %}

Deprecated ~~cant_be_finalized~~ use emsco_cant_be_finalized

5.3.x

Deprecated emsch_add_environment

In dashboards/views and action, we call emsch_add_environment for rendering a template from emsch. If elasticms-admin defines EMSCH_ENV and EMSCH_ENVS, this is not needed anymore.

bash

EMSCH_ENV='preview'
EMSCH_ENVS='{"preview":{"alias":"example_preview", "router": false}}'

EMSCH_ENV will mark the preview environment as default, the following can also be done:

bash

EMSCH_ENVS='{"preview":{"alias":"example_preview", "default": true, "router": false}}'

Router false, will disable the clientHelperBundle router the default environment. Maybe the skeleton has a match all route defined.

After defining remove the following line from all contentType(s) and dashboard(s).

twig

{% do emsch_add_environment('preview'|get_environment.alias) %}

4.2.x

Content type roles in twig

Replace is_granted(contentType.createRole) → is_granted(contentType.roles.create)

createRole → roles.create
editRole → roles.edit

4.x

Deprecated twig functions

replace {% spaceless %} by {% apply spaceless %}
replace {% endspaceless %} by {% endapply %}
replace {% for key, item in array if test %} by {% for key, item in array|filter(key, item => test) %}
replace transchoice by trans
- I.e. replace {{- 'search.results'|transchoice(results.hits.total.value|default(response.total)) -}}
- by {{ 'search.results'|trans({'%count%': results.hits.total.value|default(response.total)}) -}}

Asset custom twig functions

replace {{emsch_assets(assets) }} or {%- do emsch_assets(assets) -%} by {%- set assetPath = emsch_assets_version(assets) -%}
replace {{assets('resource') }}?{{ assets_hash }} by {{assets('resource', 'emsch') }}

Email custom twig functions

twig

{%- set email = emsco_generate_email(subjectMail) -%}
{%- set email = email.setTo(toMail) -%}
{%- set email = email.setBody(bodyMail, 'text/html') -%}
{%- set email = email.setFrom(fromMail) -%}
{{- emsco_send_email(email) -}}

→

twig

{%- set email = emsco_generate_email(subjectMail) -%}
{%- set email = email.to(toMail) -%}
{%- set email = email.html(bodyMail) -%}
{%- set email = email.from(fromMail) -%}
{{- emsco_send_email(email) -}}

Misc

replace /\.hits\.total/ by {% var.hits.total.value|default(var.hits.total) %}
- replace /\[\'hits\'\][\'total\']/ by var['hits']['total']['value']|default(var['hits']['total'])
remove the template environment
- align template and preview for route, template and label
- switch default environment emsco:content:swith template preview
Do a force push to override the document
- Keep in mind that all ouuids have changed, check in your content types for datalink to template documents
- Rollback, in the routes.yaml, static templates have been replaced by their OUUID

Tips and tricks

Backward compatibility route to old school assets path

New route to redirect to the new asset's url. Route:

yaml

redirect_asset:
    config:
        path: 'bundles/emsch_assets/{slug}'
        requirements: { slug: '^.+$' }
        controller: 'emsch.controller.router::redirect'
    template_static: template/redirects/asset.json.twig

Template (template/redirects/asset.json.twig):

twig

{% extends '@EMSCH/template/variables.twig' %}

{% block request -%}
{% apply spaceless %}
    {{ { url: asset(app.request.get('slug'), 'emsch') }|json_encode|raw }}
{% endapply %}
{% endblock -%}

Create an action for the content types you want with those parameters:

Name: corresponding-revision
Label: Corresponding revision
Icon: Archive
Public: unchecked
Environment: empty
EDit with WYSIWYG: unchecked
Role: User
Render option: Raw HTML
Body:

twig

<a href="{{ path('emsco_data_revision_in_environment', {
    environment: environment.name,
    type: contentType.name,
    ouuid: object._id,
}) }}">
 <i class="fa fa-archive"></i> Corresponding revision
</a>

Twig

Upgrade ​

7.4 ​

ems:admin:backup exports assets ​

ems:admin:restore imports assets ​

Translated choice fields ​

emsco_cant_be_finalized parameters ​

Legacy routes name removed ​

Security headers ​

Legacy Search ​

7.3 ​

7.2 ​

7.x ​

Dependency Upgrades ​

Breaking Changes ​

Routes ​

Removed deprecated route names ​

Twig ​

6.9.13 ​

6.9.2 ​

6.9.0 ​

6.5.0 ​

6.4.1 ​

6.4.0 ​

6.1.1 ​

6.0.x ​

Postgres 17 ​

Symfony request inputBag ​

Renamed embed methods in web/skeleton templates ​

Routes removed ​

Deprecated twig filters ​

Deprecated twig function ​

New dynamic mapping config which change the elasticsearch indexes ​

5.25.x ​

5.24.x ​

5.23.x ​

5.22.x ​

5.21.x ​

5.19.x ​

5.17.x ​

5.15.x ​

5.14.x ​

5.7.x ​

5.3.x ​

Deprecated emsch_add_environment ​

4.2.x ​

Content type roles in twig ​

4.x ​

Deprecated twig functions ​

Asset custom twig functions ​

Email custom twig functions ​

Misc ​

Tips and tricks ​

Backward compatibility route to old school assets path ​

Create an old school "Corresponding revision" in the action menu ​

Upgrade

7.4

`ems:admin:backup` exports assets

`ems:admin:restore` imports assets

Translated choice fields

`emsco_cant_be_finalized` parameters

Legacy routes name removed

Security headers

Legacy Search

7.3

7.2

7.x

Dependency Upgrades

Breaking Changes

Routes

Removed deprecated route names

Twig

6.9.13

6.9.2

6.9.0

6.5.0

6.4.1

6.4.0

6.1.1

6.0.x

Postgres 17

Symfony request inputBag

Renamed embed methods in web/skeleton templates

Routes removed

Deprecated twig filters

Deprecated twig function

New dynamic mapping config which change the elasticsearch indexes

5.25.x

5.24.x

5.23.x

5.22.x

5.21.x

5.19.x

5.17.x

5.15.x

5.14.x

5.7.x

5.3.x

Deprecated emsch_add_environment

4.2.x

Content type roles in twig

4.x

Deprecated twig functions

Asset custom twig functions

Email custom twig functions

Misc

Tips and tricks

Backward compatibility route to old school assets path

Create an old school "Corresponding revision" in the action menu