Core

emsco_get

Get the document from an ems link Optional you can pass an search environment.

twig

{% set document = 'page:4930260c-3d40-4db3-ad94-f577c8d9c45e'|emsco_get %}
{{ document.getValue('nl.label') }}

{% set docInLive = 'page:17090dbe-5a61-4277-b691-08a867ad740e'|emsco_get('live'|emsco_get_environment)  %}

emsco_choice_list

Retrieve the choices and their translated labels from an EMS ChoiceList.

twig

{{ choiceListName|emsco_choice_list(values, locale) }}

Arguments:

choiceListName: the name of the ChoiceList configured in the administration.
values: an optional array of choice values to retrieve. If omitted, all choices are returned.
locale: an optional locale used to resolve translated labels. If omitted, the locales of the current user are used.

The filter returns an associative array indexed by the choice value. Each item contains the choice value, its resolved label and its optional group:

php

[
    'BE' => [
        'value' => 'BE',
        'label' => 'Belgium',
        'group' => [
            'name' => 'europe',
            'label' => 'Europe',
        ],
    ],
]

For example, retrieve only selected values and use the group label when it is available:

twig

{% set values = 'countries'|emsco_choice_list(['BE', 'FR'], 'en') %}

{% for choice in values %}
    {% if choice.group %}{{ choice.group.label }} &gt; {% endif %}{{ choice.label }}
{% endfor %}

If the requested ChoiceList does not exist, the filter returns the provided values with their value as label and no group:

twig

{% set values = 'unknown_list'|emsco_choice_list(['draft', 'published']) %}

emscolog[error | warning | notice]

Print flash message, usefull in post processing

twig

{{ 'Example print error flash'|emsco_log_error }}
{{ 'Example print warning flash'|emsco_log_warning }}
{{ 'Example print notice flash'|emsco_log_notice }}

emsco_generate_email

Generate an email and use emsco_send_email for sending the email.

twig

{% set mailBody %}
  <h1>Example email</h1>
  <p>example ...</p>
{% endset %}

{% set email = emsco_generate_email('test title') %}
{% do email.to('test@example.com').html(mailBody|format) %}
{% do emsco_send_email(email) %}

emsco_send_email

Send an email generated with emsco_generate_email. Default value for from is ems_core.from_email and %ems_core.name% parameter.

twig

{% set email = emsco_generate_email('example send') %}
{% do email.to('test@example.com').text('Body text') %}
{% do emsco_send_email(email) %}

emsco_skip_notification

Can be used in notification in order to not send the notification and display a warning message.

twig

{{ emsco_skip_notification() }}

The warning message can be defined:

twig

{{ emsco_skip_notification('The title field is not provided, the request for publication can not be send.') }}

emsco_form

Handle the current request with the form identified by its name. It allows to generate form in view, action or dashboard:

twig

{% set form = emsco_form('user') %}
{% set formView = form.createView %}

{{ form_start(formView) }}
    {{ form_row(attribute(formView, 'user')) }}
    <div>
        <button type="submit" class="btm btn-primary">Filter</submit>
    </div>
{{ form(formView) }}

{% if form.valid %}
    {{ form.data.user|json_encode }}
{% endif %}

emsco_display

Returns a string representation for a elasticSearch document, revision or EMS link.

Pass a symfony expression or define a default in the contentType field display.

This filter replaces the filter |data_label.

Context for the expression:

rawData: array containing the rawData from document or revision
userLocale: the preferred language of the user, default 'en'

twig

{# Print the label in the users preferred locale, fallback to label_fr #}
{% set document = 'page:e6f73dd73a5a3f5336bd3fe52d0304b26e437f34'|emsco_get %}
{{ document|emsco_display("(rawData['label_'~userLocale] ?? rawData['label_fr'])")

{# display from emsLink and using contentTypes defined display value #}
{{ 'page:e6f73dd73a5a3f5336bd3fe52d0304b26e437f34'|emsco_display }}

emsco_soap_request

Instantiate a \SoapClient object and call the provided function

twig

{% set request = someUrl|emsco_soap_request({
  options: {
    trace: 1,
    stream_context: context
  },
  function: 'someWebServiceFunction',
  parameters: {
    firstClient: {
      name: 'someone',
      adress: 'R. 1001'
    },
    secondClient: {
      name: 'another one',
      adress: ''
    }
  }
}) %}

emsco_all_granted

Test that the current user has all the provided roles granted

twig

{% if roles|emsco_all_granted %}

emsco_one_granted

Test that the current user has at least one of the provided roles granted

twig

{% if roles|emsco_all_granted %}

emsco_in_my_circles

Test that the current user has at least one of the provided circles granted

twig

{% if not contentType.circlesField or attribute(source, contentType.circlesField) is not defined or attribute(source, contentType.circlesField)|emsco_in_my_circles %}

emsco_data_link

Generate an HTML link to the provided ElasticMS link

twig

{{ (notification.revision.contentType.name~':'~notification.revision.ouuid)|emsco_data_link}}

A link to a specific revision can be specified by adding the revision ID as second argument:

twig

{{ (notification.revision.contentType.name~':'~notification.revision.ouuid)|emsco_data_link(notification.revision.id) }}

emsco_is_super

Test if the user as super rights

twig

{% if emsco_is_super() %}

emsco_cant_be_finalized

Prevent the current revision from being finalized by throwing a validation error. The optional message argument defines the error message. If it is omitted, the default message.draft_cant_be_finalized translation is used.

The optional translations argument is an associative array of locale codes and translated error messages. The translation matching the current user's locale is selected first; when no matching translation is found, the message argument is used as the fallback.

twig

{{ emsco_cant_be_finalized('This field is invalid') }}

{{ emsco_cant_be_finalized('', {
    fr: 'Mon texte d\'erreur en français',
    nl: 'Mijn foutmelding in het Nederlands',
}) }}

The former $code and $previous parameters have been removed. They were normally unused. Use the translations parameter to provide localized error messages instead.

emsco_i18n

Retrieve the value of the I18N corresponding to the provided key and locale. If not specified locale is equal to 'en':

twig

{{ ('locale.'~locale)|emsco_i18n }}

twig

{{ ('locale.'~locale)|emsco_i18n('fr') }}

emsco_internal_links

Convert ElasticMS links in an HTML string to the corresponding revision

twig

{{ dataField.rawData|json_encode|emsco_internal_links }}

emsco_get_user

Retrieve the EMS\CoreBundle\Entity\UserInterface for the given username. It returns null if the user is not found.

twig

{% set user = username|emsco_get_user %}

emsco_display_name

Convert a given username into its corresponding display name. It returns the given username if the user is not found in the database.

twig

{{ username|emsco_display_name }}

emsco_debug

Log a debug message. An optional context can be provided as second argument.

twig

{{ username|emsco_debug }}

emsco_get_field_by_path

Retrieve the corresponding EMS\CoreBundle\Entity\FieldType for the given EMS\CoreBundle\Entity\ContentType and a field path:

twig

{% set fieldType = 'page'|emsco_get_content_type|emsco_get_field_by_path('locales.fr') %}

emsco_get_revision_id

Retrieve the corresponding revision id for the given OUUID and content type name:

twig

{% set revisionId = emsco_get_revision_id(ouuid, 'page') %}

emsco_save_contents

Allow to save a contents into storage services as an asset. Examples bellow.

In this example the contents of a forged URL is saved as an asset in storage services:

twig

{% if finalize and _source.default_image is not defined %}
    {% set response = ems_http("https://domain.tld/fr/base_url/#{_source.uuid}/original.jpg") %}
    {% if response.getStatusCode() == 200 %}
        {{ emsco_save_contents(response.getContent(), "#{_source.name}.jpg", response.getHeaders()['content-type'][0])|json_encode|raw }}
    {% endif %}
{% endif %}

In this example an array of identifiers (strings) will be converted into a multiple FileFieldType:

twig

{% if finalize and (_source.images is not defined or _source.images|length == 0) %}
    {% set images = [] %}
    {% for hash in _source.Stack|default([]) %}
        {% set response = ems_http("https://domain.tld/base-url/#{hash}/original.jpg") %}
        {% if response.getStatusCode() == 200 %}
            {% set images = images|merge([emsco_save_contents(response.getContent(), "#{_source.name}-#{loop.index}.jpg", response.getHeaders()['content-type'][0])]) %}
        {% endif %}
    {% endfor %}
    {{ images|json_encode|raw }}
{% endif %}

A forth optional argument allow to defined the file's type, in order to save the content into right storage services:

0: Cache
1: Config
2: Asset (default value)
3: Backup

emsco_notice

Function that generate a notice message to the user

twig

{% if finalize %}
  {% do emsco_notice('page.finalize.notice'|i18n(userLocale), {
    'title': _source.label,
  }) %}
{% endif %}

emsco_warning

Function that generate a warning message to the user

twig

{% if finalize %}
  {% do emsco_warning('page.finalize.warning'|i18n(userLocale), {
    'title': _source.label,
  }) %}
{% endif %}

emsco_webhook

Dispatches a custom webhook event to registered clients.
This function takes two parameters:

event name (string)
data (array)

twig

{% do emsco_webhook('custom-event', {
    'foo': 'bar',
}) %}

MCP

Client Helper

Twig

Common

Core

Twig

Form

Submission

Handlers

Helper

Core

emsco_get

emsco_choice_list

emscolog[error | warning | notice]

emsco_generate_email

emsco_send_email

emsco_skip_notification

emsco_form

emsco_display

emsco_soap_request

emsco_all_granted

emsco_one_granted

emsco_in_my_circles

emsco_data_link

emsco_is_super

emsco_cant_be_finalized

emsco_i18n

emsco_internal_links

emsco_get_user

emsco_display_name

emsco_debug

emsco_get_field_by_path

emsco_get_revision_id

emsco_save_contents

emsco_notice

emsco_warning

emsco_webhook

Twig

Core ​

emsco_get ​

emsco_choice_list ​

emscolog[error | warning | notice] ​

emsco_generate_email ​

emsco_send_email ​

emsco_skip_notification ​

emsco_form ​

emsco_display ​

emsco_soap_request ​

emsco_all_granted ​

emsco_one_granted ​

emsco_in_my_circles ​

emsco_data_link ​

emsco_is_super ​

emsco_cant_be_finalized ​

emsco_i18n ​

emsco_internal_links ​

emsco_get_user ​

emsco_display_name ​

emsco_debug ​

emsco_get_field_by_path ​

emsco_get_revision_id ​

emsco_save_contents ​

emsco_notice ​

emsco_warning ​

emsco_webhook ​

Core

emsco_get

emsco_choice_list

emscolog[error | warning | notice]

emsco_generate_email

emsco_send_email

emsco_skip_notification

emsco_form

emsco_display

emsco_soap_request

emsco_all_granted

emsco_one_granted

emsco_in_my_circles

emsco_data_link

emsco_is_super

emsco_cant_be_finalized

emsco_i18n

emsco_internal_links

emsco_get_user

emsco_display_name

emsco_debug

emsco_get_field_by_path

emsco_get_revision_id

emsco_save_contents

emsco_notice

emsco_warning

emsco_webhook