Skip to content
This repository has been archived by the owner on May 3, 2022. It is now read-only.

Commit

Permalink
EZP-26430: Provide a shortcut to Y.Translator.trans()
Browse files Browse the repository at this point in the history
  • Loading branch information
@yannickroger
yannickroger committed Nov 4, 2016
1 parent fecda8e commit 1980486
Show file tree
Hide file tree
Showing 10 changed files with 61 additions and 36 deletions.
11 changes: 11 additions & 0 deletions Resources/public/js/external/ez-translator.js
View file
Expand Up @@ -17,4 +17,15 @@ YUI.add('ez-translator', function (Y) {
* @constructor
*/
Y.eZ.Translator = Translator;

/**
* Shortcut to the Y.eZ.Translator.trans method
*
* @namespace eZ
* @method Y.eZ.trans
* @param String key message to be translated
* @param Object parameters to be applied to the message
* @param String domain where the translation can be found
*/
Y.eZ.trans = Y.bind(Translator.trans, Translator);
});
16 changes: 8 additions & 8 deletions Resources/public/js/views/ez-actionbarview.js
View file
Expand Up @@ -35,39 +35,39 @@ YUI.add('ez-actionbarview', function (Y) {
new Y.eZ.ButtonActionView({
actionId: "minimizeActionBar",
disabled: false,
label: Y.eZ.Translator.trans('actionbar.minimizeActionBar', {}, 'editorial'),
label: Y.eZ.trans('actionbar.minimizeActionBar', {}, 'editorial'),
priority: 1000
}),
new Y.eZ.ButtonActionView({
actionId: "edit",
disabled: false,
label: Y.eZ.Translator.trans('actionbar.edit', {}, 'editorial'),
label: Y.eZ.trans('actionbar.edit', {}, 'editorial'),
priority: 200,
content: this.get('content')
}),
new Y.eZ.MoveContentActionView({
actionId: "move",
label: Y.eZ.Translator.trans('actionbar.move', {}, 'editorial'),
label: Y.eZ.trans('actionbar.move', {}, 'editorial'),
priority: 190,
location: this.get('location')
}),
new Y.eZ.ButtonActionView({
actionId: "copy",
disabled: false,
label: Y.eZ.Translator.trans('actionbar.copy', {}, 'editorial'),
label: Y.eZ.trans('actionbar.copy', {}, 'editorial'),
priority: 180
}),
new Y.eZ.CreateContentActionView({
actionId: 'createContent',
label: Y.eZ.Translator.trans('actionbar.createContent', {}, 'editorial'),
label: Y.eZ.trans('actionbar.createContent', {}, 'editorial'),
priority: 210,
contentType: this.get('contentType'),
config: this.get('config'),
}),
new Y.eZ.TranslateActionView({
actionId: "translate",
disabled: false,
label: Y.eZ.Translator.trans('actionbar.translate',{}, 'editorial'),
label: Y.eZ.trans('actionbar.translate',{}, 'editorial'),
priority: 170,
location: this.get('location'),
content: this.get('content')
Expand All @@ -79,7 +79,7 @@ YUI.add('ez-actionbarview', function (Y) {
new Y.eZ.ButtonActionView({
actionId: 'sendToTrash',
disabled: this.get('location').isRootLocation(),
label: Y.eZ.Translator.trans('actionbar.sendToTrash', {}, 'editorial'),
label: Y.eZ.trans('actionbar.sendToTrash', {}, 'editorial'),
priority: 10
})
);
Expand All @@ -89,7 +89,7 @@ YUI.add('ez-actionbarview', function (Y) {
new Y.eZ.ButtonActionView({
actionId: 'deleteContent',
disabled: false,
label: Y.eZ.Translator.trans('actionbar.delete', {}, 'editorial'),
label: Y.eZ.trans('actionbar.delete', {}, 'editorial'),
priority: 10
})
);
Expand Down
8 changes: 4 additions & 4 deletions Resources/public/js/views/ez-discoverybarview.js
View file
Expand Up @@ -45,25 +45,25 @@ YUI.add('ez-discoverybarview', function (Y) {
new Y.eZ.ButtonActionView({
actionId: "minimizeDiscoveryBar",
disabled: false,
label: Y.eZ.Translator.trans('discoverybar.minimize', {}, 'editorial'),
label: Y.eZ.trans('discoverybar.minimize', {}, 'editorial'),
priority: 1000
}),
new Y.eZ.ButtonActionView({
actionId: "viewSearch",
disabled: false,
label: Y.eZ.Translator.trans('discoverybar.search', {}, 'editorial'),
label: Y.eZ.trans('discoverybar.search', {}, 'editorial'),
priority: 900
}),
new Y.eZ.TreeActionView({
actionId: "tree",
disabled: false,
label: Y.eZ.Translator.trans('discoverybar.contenttree', {}, 'editorial'),
label: Y.eZ.trans('discoverybar.contenttree', {}, 'editorial'),
priority: 800
}),
new Y.eZ.ButtonActionView({
actionId: "viewTrash",
disabled: false,
label: Y.eZ.Translator.trans('discoverybar.trash', {}, 'editorial'),
label: Y.eZ.trans('discoverybar.trash', {}, 'editorial'),
priority: 600
}),
];
Expand Down
10 changes: 5 additions & 5 deletions Resources/public/js/views/ez-navigationhubview.js
View file
Expand Up @@ -620,10 +620,10 @@ YUI.add('ez-navigationhubview', function (Y) {
*/
zones: {
value: {
'platform': Y.eZ.Translator.trans('navigationhub.zone.platform', {}, 'editorial'),
'studio': Y.eZ.Translator.trans('navigationhub.zone.studio', {}, 'editorial'),
'studioplus': Y.eZ.Translator.trans('navigationhub.zone.studioplus', {}, 'editorial'),
'admin': Y.eZ.Translator.trans('navigationhub.zone.admin', {}, 'editorial'),
'platform': Y.eZ.trans('navigationhub.zone.platform', {}, 'editorial'),
'studio': Y.eZ.trans('navigationhub.zone.studio', {}, 'editorial'),
'studioplus': Y.eZ.trans('navigationhub.zone.studioplus', {}, 'editorial'),
'admin': Y.eZ.trans('navigationhub.zone.admin', {}, 'editorial'),
},
readOnly: true,
},
Expand Down Expand Up @@ -736,7 +736,7 @@ YUI.add('ez-navigationhubview', function (Y) {
* @type {Object}
*/
matchedRoute: {},

/**
* The user profile view
*
Expand Down
18 changes: 9 additions & 9 deletions Resources/public/js/views/services/ez-navigationhubviewservice.js
View file
Expand Up @@ -450,13 +450,13 @@ YUI.add('ez-navigationhubviewservice', function (Y) {

val = [
this._getSubtreeItem(
Y.eZ.Translator.trans("navigationhub.content.structure", {}, 'editorial'),
Y.eZ.trans("navigationhub.content.structure", {}, 'editorial'),
"content-structure",
this.get('rootLocation').get('id'),
this.get('rootLocation').get('contentInfo').get('mainLanguageCode')
),
this._getSubtreeItem(
Y.eZ.Translator.trans("navigationhub.media.library",{}, 'editorial'),
Y.eZ.trans("navigationhub.media.library",{}, 'editorial'),
"media-library",
this.get('rootMediaLocation').get('id'),
this.get('rootMediaLocation').get('contentInfo').get('mainLanguageCode')
Expand Down Expand Up @@ -554,34 +554,34 @@ YUI.add('ez-navigationhubviewservice', function (Y) {

val = [
this._getParameterItem(
Y.eZ.Translator.trans('navigationhub.dashboard.title', {}, 'editorial'), "admin-dashboard",
Y.eZ.trans('navigationhub.dashboard.title', {}, 'editorial'), "admin-dashboard",
"adminGenericRoute", {uri: "pjax/dashboard"}, "uri"
),
this._getParameterItem(
Y.eZ.Translator.trans('navigationhub.system.information', {}, 'editorial'), "admin-systeminfo",
Y.eZ.trans('navigationhub.system.information', {}, 'editorial'), "admin-systeminfo",
"adminGenericRoute", {uri: "pjax/systeminfo"}, "uri"
),
this._getNavigationItem(
Y.eZ.Translator.trans('navigationhub.section.list', {}, 'editorial'), "admin-sections",
Y.eZ.trans('navigationhub.section.list', {}, 'editorial'), "admin-sections",
"adminSection", {uri: "pjax/section/list"}
),
this._getNavigationItem(
Y.eZ.Translator.trans('navigationhub.content_type.dashboard_title', {}, 'editorial'), "admin-contenttypes",
Y.eZ.trans('navigationhub.content_type.dashboard_title', {}, 'editorial'), "admin-contenttypes",
"adminContentType", {uri: "pjax/contenttype"}
),
this._getNavigationItem(
Y.eZ.Translator.trans('navigationhub.language.list', {}, 'editorial'), "admin-languages",
Y.eZ.trans('navigationhub.language.list', {}, 'editorial'), "admin-languages",
"adminLanguage", {uri: "pjax/language/list"}
),
//TODO in EZP-24860. For now link to users node is defined in a static way.
this._getSubtreeItem(
Y.eZ.Translator.trans('navigationhub.user.list', {}, 'editorial'),
Y.eZ.trans('navigationhub.user.list', {}, 'editorial'),
"admin-users",
"/api/ezp/v2/content/locations/1/5",
"eng-GB"
),
this._getNavigationItem(
Y.eZ.Translator.trans('navigationhub.role.list', {}, 'editorial'), "admin-roles",
Y.eZ.trans('navigationhub.role.list', {}, 'editorial'), "admin-roles",
"adminRole", {uri: "pjax/role"}
),
];
Expand Down
8 changes: 5 additions & 3 deletions Tests/js/assets/ez-translator.js
View file
Expand Up @@ -3,9 +3,11 @@ YUI.add('ez-translator', function (Y) {

Y.namespace('eZ');

Y.eZ.trans = function (str) {
return str;
};

Y.eZ.Translator = {
trans: function (str) {
return str;
},
trans: Y.eZ.trans,
};
});
8 changes: 8 additions & 0 deletions Tests/js/external/assets/ez-translator-tests.js
View file
Expand Up @@ -15,6 +15,14 @@ YUI.add('ez-translator-tests', function (Y) {
"The Translator object should have been imported in the sandbox"
);
},

"Should import the trans method in the right context": function () {
Assert.areSame(
window.Translator,
Y.eZ.trans(),
"The trans method should be executed in the Translator context"
);
},
});

Y.Test.Runner.setName("eZ Translator Import module tests");
Expand Down
6 changes: 5 additions & 1 deletion Tests/js/external/assets/translator.js
View file
@@ -1 +1,5 @@
window.Translator = window.Translator || {};
window.Translator = window.Translator || {
trans: function() {
return this;
}
};
8 changes: 4 additions & 4 deletions Tests/js/views/assets/ez-discoverybarview-tests.js
View file
Expand Up @@ -84,13 +84,13 @@ YUI.add('ez-discoverybarview-tests', function (Y) {
);

if (buttonActionView.get('actionId') === "minimizeDiscoveryBar") {
this._testButtonAction(buttonActionView, false, Y.eZ.Translator.trans("discoverybar.minimize"), 1000);
this._testButtonAction(buttonActionView, false, Y.eZ.trans("discoverybar.minimize"), 1000);
} else if (buttonActionView.get('actionId') === "viewSearch") {
this._testButtonAction(buttonActionView, false, Y.eZ.Translator.trans("discoverybar.search"), 900);
this._testButtonAction(buttonActionView, false, Y.eZ.trans("discoverybar.search"), 900);
} else if (buttonActionView.get('actionId') === "tree") {
this._testButtonAction(buttonActionView, false, Y.eZ.Translator.trans("discoverybar.contenttree"), 800);
this._testButtonAction(buttonActionView, false, Y.eZ.trans("discoverybar.contenttree"), 800);
} else if (buttonActionView.get('actionId') === "viewTrash") {
this._testButtonAction(buttonActionView, false, Y.eZ.Translator.trans("discoverybar.trash"), 600);
this._testButtonAction(buttonActionView, false, Y.eZ.trans("discoverybar.trash"), 600);
} else {
Assert.fail("Unknown action id: " + buttonActionView.get('actionId'));
}
Expand Down
4 changes: 2 additions & 2 deletions Tests/js/views/services/assets/ez-navigationhubviewservice-tests.js
View file
Expand Up @@ -353,10 +353,10 @@ YUI.add('ez-navigationhubviewservice-tests', function (Y) {
);

this._assertLocationNavigationItem(
value[0], Y.eZ.Translator.trans("navigationhub.content.structure") , "content-structure", "/allez/om", "fre-FR-root"
value[0], Y.eZ.trans("navigationhub.content.structure") , "content-structure", "/allez/om", "fre-FR-root"
);
this._assertLocationNavigationItem(
value[1], Y.eZ.Translator.trans("navigationhub.media.library"), "media-library", "/allez/om/media", "fre-FR-media"
value[1], Y.eZ.trans("navigationhub.media.library"), "media-library", "/allez/om/media", "fre-FR-media"
);
},

Expand Down

0 comments on commit 1980486

Please sign in to comment.