ElasticMS

Appearance

Twig functions ​

NameDescription
emsch_add_environmentDynamically add an client helper's environment
emsch_assetAbility to use asset's processor on website assets

emsch_add_environment ​

This function is useful to be used in elasticms admin's actions, views and dashboards in order to dynamically load a Client helper environment.

Once loaded it will be possible to load templates from a content type or use the emsch_routing and emsch_routing_config filters:

Example in an elasticms admin's view. As the environment's name is by default used as alias loading a environment might be as short as:

twig
{% do emsch_add_environment(environment.alias) %}

Or it can be fully defined. See the environment config:

twig
{% do emsch_add_environment(environment.name, {
    alias: environment.alias,
    remote_cluster: 'other_cluster',
}) %}

N.B. This function does not have output

emsch_asset ​

This function is working mostly like the regular asset twig function. Except that this one need an asset config array as second parameter.

I.e.:

twig
<img src="{{ emsch_asset('img/head/icon.png', {
        _config_type: 'image',
        _width: 310,
        _height: 150,
        _quality: 0,
        _resize: 'fill',
        _gravity: 'west',
        _background: '#2e2e2e',
    }) }}">

Instead of generating a regular website asset path it will generate a processed asset path like this:file/f14f3b6b044a4a37dcabae029746235ab3459ee9/processor/icon.png.

Useful in order to avoid managing assets in multiple sizes in your source base.

emsch_asset_redirect ​

This function is working like emsch_asset except that it returns a JSON, compatible with the emsch.controller.router::redirect method controller, to directly return an asset from a route.

E.g. it can be used to generate favicons.

The route will look like any redirect route:

yaml
favicon.ico:
    config:
        path: favicon.ico
        controller: 'emsch.controller.router::redirect'
    template_static: template/redirects/favicon.json.twig

The redirects/favicon.json.twig template:

twig
{%- do emsch_assets_version(include('@EMSCH/template/asset_hash.twig')|trim) -%}

{%- block request -%}
    {{- emsch_asset_redirect('img/head/icon.png', {
            _config_type: 'image',
            _image_format: 'png',
            _width: 48,
            _height: 48,
        })|json_encode|raw -}}
{%- endblock request -%}

emsch_webhook_event ​

This function returns an EMS\ClientHelperBundle\Helper\Webhook instance for the current request's webhook.

If the current request is not a valid webhook request, an exception will be thrown.

A webhook request is always a POST request and must return JSON.

See webhook for more information.

twig
{%- set event = emsch_webhook_event() -%}
{%- if event.name == 'clear-cache' -%}
    {%- do ems_clear_http_caches() -%}
    {%- set success = true -%}
{%- endif -%}
{{- { success: success|default(false) }|json_encode|raw -}}