Moving to a new LocalizationService API in EPiServer 7
This is a short note about replacing the LanguageManager with a new LocalizationService API when upgrading from EPiServer 6 to EPiServer 7. Actually such replacement is not mandatory, since LanguageManager is still there, but it is marked as obsolete and delegates all calls to the LocalizationService.
Replacements
The LocalizationService class is located in EPiServer.Framework assembly in EPiServer.Framework.Localization namespace, so you might need to add a reference to your project.
Here is a summary of what needs to be replaced in order to use the new API.
Simple translation:
| EPiServer 6 | LanguageManager.Instance.Translate(key) |
|---|---|
| EPiServer 7 | General usage:
LocalizationService.Current.GetString(key) this.Translate(key)
Html.Translate(key) |
Translate with fallback value:
| EPiServer 6 |
LanguageManager.Instance.TranslateFallback(key, fallback) |
|---|---|
| EPiServer 7 | General usage:
LocalizationService.Current.GetString(key, fallback) this.TranslateFallback(key, fallback)
Html.TranslateFallback(key, fallback) |
Translate and adapt value for use in a client script:
| EPiServer 6 |
LanguageManager.Instance.TranslateForScript(key) |
|---|---|
| EPiServer 7 | General usage:
ScriptResourceHelper.PrepareResourceForScript( this.TranslateForScript(key)
Html.TranslateForScript(key) |
* There is also a protected helper property named LocalizationService that can be used in page templates and user controls that inherit from one of these base classes:
EPiServer.PageBase
EPiServer.ContentBaseWebForm
EPiServer.UserControlBase
EPiServer.ContentBaseUserControl
How to mock the LocalizationService
As a general recommendation, mainly because of testability, it is better to use a constructor dependency injection instead of static LocalizationService.Current.
If order to mock the LocalizationService in a unit test you need to setup GetStringByCulture method:
var localizationServiceMock = new Mock<LocalizationService>(null);
localizationServiceMock.Setup(s => s.GetStringByCulture(It.IsAny<String>(),
It.IsAny<FallbackBehaviors>(), It.IsAny<CultureInfo>())).Returns(String.Empty);
More details about the new localization API can be found in “Using the Localization Service” chapter in SDK Documentation EPiServer 7 – Framework.
Comments