Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pass menu label attributes to translation #6092

Closed
wants to merge 12 commits into from
Closed

Pass menu label attributes to translation #6092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
cec3866
Pass menu label attributes to translation
pavol-tuka May 15, 2020
fc82781
Pass translation_params to label translations
pavol-tuka May 17, 2020
a8b28ec
Use label_translation_parameters of menu item extra's
May 17, 2020
a0a823d
Use second parameter of extra to set default value
pavol-tuka May 17, 2020
36256ea
Reformat label block to multiple lines with apply spaceless
May 17, 2020
296b10b
Add variable translation_domain to label block
May 17, 2020
41b9a63
Mark option label_catalogue as deprecated in twig templates
May 17, 2020
b7fdb4e
Update src/Resources/views/Menu/sonata_menu.html.twig
pavol-tuka May 18, 2020
95e2d12
Remove NEXT_MAJOR deprecation comment
May 18, 2020
ac7eb35
Add dashes to twig markdown to avoid space rendering
May 18, 2020
6863cd8
Rename translation_domain to label_catalogue in doc/advanced configur…
May 18, 2020
79cccbd
Rename translation_domain to label_catalogue in doc/advanced configur…
May 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/reference/advanced_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,19 +306,19 @@ If you want to use the Tab Menu in a different way, you can replace the Menu Tem
Translations
^^^^^^^^^^^^

The translation parameters and domain can be customised by using the
``translation_domain`` and ``translation_parameters`` keys of the extra array
The label translation parameters and domain can be customised by using the
``label_translation_parameters`` and ``label_catalogue`` keys of the extra array
of data associated with the item, respectively::

$menuItem->setExtras([
'translation_parameters' => ['myparam' => 'myvalue'],
'translation_domain' => 'My domain',
'label_translation_parameters' => ['myparam' => 'myvalue'],
'label_catalogue' => 'My domain',
]);

You can also set the translation domain on the menu root, and children will
inherit it::

$menu->setExtra('translation_domain', 'My domain');
$menu->setExtra('label_catalogue', 'My domain');

Filter parameters
^^^^^^^^^^^^^^^^^
Expand Down
52 changes: 32 additions & 20 deletions src/Resources/views/Menu/sonata_menu.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
{% extends 'knp_menu.html.twig' %}

{% block root %}
{%- set listAttributes = item.childrenAttributes|merge({'class': 'sidebar-menu', 'data-widget': 'tree'}) %}
{%- set request = item.extra('request') ?: app.request %}
{%- set listAttributes = item.childrenAttributes|merge({'class': 'sidebar-menu', 'data-widget': 'tree'}) -%}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure of the impact of adding - in all the tag of block root, block item, etc.

Maybe it's better to limit the change to block label in order to avoid regression.
But I let the choice to other reviewers.

{%- set request = item.extra('request') ?: app.request -%}
{{ block('list') -}}
{% endblock %}

{% block item %}
{%- if item.displayed %}
{%- if item.displayed -%}
{#- check role of the group #}
{%- set display = item.extra('roles') is empty or is_granted(sonata_admin.adminPool.getOption('role_super_admin')) or item.extra('roles')|filter(role => is_granted(role))|length > 0 %}
{%- endif %}
{%- set display = item.extra('roles') is empty or is_granted(sonata_admin.adminPool.getOption('role_super_admin')) or item.extra('roles')|filter(role => is_granted(role))|length > 0 -%}
{%- endif -%}

{%- if item.displayed and display|default %}
{% set options = options|merge({branch_class: 'treeview', currentClass: "active", ancestorClass: "active"}) %}
{%- do item.setChildrenAttribute('class', (item.childrenAttribute('class')~' active')|trim) %}
{%- do item.setChildrenAttribute('class', (item.childrenAttribute('class')~' treeview-menu')|trim) %}
{%- if item.displayed and display|default -%}
{%- set options = options|merge({branch_class: 'treeview', currentClass: "active", ancestorClass: "active"}) -%}
{%- do item.setChildrenAttribute('class', (item.childrenAttribute('class')~' active')|trim) -%}
{%- do item.setChildrenAttribute('class', (item.childrenAttribute('class')~' treeview-menu')|trim) -%}
{{ parent() }}
{% endif %}
{%- endif -%}
{% endblock %}

{% block linkElement %}
{% apply spaceless %}
{% set translation_domain = item.extra('label_catalogue', 'messages') %}
{% if item.extra('on_top') is defined and not item.extra('on_top') %}
{% set icon = item.extra('icon')|default(item.level > 1 ? '<i class="fa fa-angle-double-right" aria-hidden="true"></i>' : '') %}
{% else %}
{% set icon = item.extra('icon') %}
{% endif %}
{% set is_link = true %}
{%- set translation_domain = item.extra('label_catalogue', 'messages') -%}
{%- if item.extra('on_top') is defined and not item.extra('on_top') -%}
{%- set icon = item.extra('icon')|default(item.level > 1 ? '<i class="fa fa-angle-double-right" aria-hidden="true"></i>' : '') -%}
{%- else -%}
{%- set icon = item.extra('icon') -%}
{%- endif -%}
{%- set is_link = true -%}
{{ parent() }}
{% endapply %}
{% endblock %}

{% block spanElement %}
{% apply spaceless %}
<a href="#">
{% set translation_domain = item.extra('label_catalogue') %}
{% set icon = item.extra('icon')|default('') %}
{%- set translation_domain = item.extra('label_catalogue', 'messages') -%}
{%- set icon = item.extra('icon')|default('') -%}
{{ icon|raw }}
{{ parent() }}
{%- if item.extra('keep_open') is not defined or not item.extra('keep_open') -%}
Expand All @@ -47,4 +47,16 @@
{% endapply %}
{% endblock %}

{% block label %}{% if is_link is defined and is_link %}{{ icon|default|raw }}{% endif %}{% if options.allow_safe_labels and item.extra('safe_label', false) %}{{ item.label|raw }}{% else %}{{ item.label|trans({}, translation_domain|default('messages')) }}{% endif %}{% endblock %}
{% block label %}
{% apply spaceless %}
{%- if is_link is defined and is_link -%}
{{ icon|default|raw }}
{%- endif -%}
{%- if options.allow_safe_labels and item.extra('safe_label', false) -%}
{{ item.label|raw }}
{%- else -%}
{%- set translation_domain = item.extra('label_catalogue', 'messages') -%}
{{ item.label|trans(item.extra('label_translation_parameters', {}), translation_domain) }}
{%- endif -%}
{% endapply %}
{% endblock %}