diff --git a/docs/en/Text-Templating.md b/docs/en/Text-Templating.md index 18a360c5c8..c71787f598 100644 --- a/docs/en/Text-Templating.md +++ b/docs/en/Text-Templating.md @@ -204,13 +204,14 @@ Inline localization uses the [localization system](Localization.md) to localize Assuming you need to send an email to a user to reset her/his password. Here, the template content: ```` -{%{{{L "ResetMyPassword"}}}%} +{%{{{L "ResetMyPassword" model.name}}}%} ```` `L` function is used to localize the given key based on the current user culture. You need to define the `ResetMyPassword` key inside your localization file: ````json -"ResetMyPassword": "Click here to reset your password" +"ResetMyPasswordTitle": "Reset my password", +"ResetMyPassword": "Hi {0}, Click here to reset your password" ```` You also need to declare the localization resource to be used with this template, inside your template definition provider class: @@ -234,6 +235,7 @@ var result = await _templateRenderer.RenderAsync( "PasswordReset", //the template name new PasswordResetModel { + Name = "john", Link = "https://abp.io/example-link?userId=123&token=ABC" } ); @@ -242,7 +244,7 @@ var result = await _templateRenderer.RenderAsync( You will see the localized result: ````csharp -Click here to reset your password +Hi john, Click here to reset your password ```` > If you define the [default localization resource](Localization.md) for your application, then no need to declare the resource type for the template definition. diff --git a/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateLocalizer.cs b/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateLocalizer.cs new file mode 100644 index 0000000000..c3c67dd194 --- /dev/null +++ b/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateLocalizer.cs @@ -0,0 +1,50 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.Extensions.Localization; +using Scriban; +using Scriban.Runtime; +using Scriban.Syntax; + +namespace Volo.Abp.TextTemplating +{ + public class TemplateLocalizer : IScriptCustomFunction + { + private readonly IStringLocalizer _localizer; + + public TemplateLocalizer(IStringLocalizer localizer) + { + _localizer = localizer; + } + + public object Invoke(TemplateContext context, ScriptNode callerContext, ScriptArray arguments, + ScriptBlockStatement blockStatement) + { + return GetString(arguments); + } + + public ValueTask InvokeAsync(TemplateContext context, ScriptNode callerContext, ScriptArray arguments, + ScriptBlockStatement blockStatement) + { + return new ValueTask(GetString(arguments)); + } + + private string GetString(ScriptArray arguments) + { + if (arguments.IsNullOrEmpty()) + { + return string.Empty; + } + + var name = arguments[0]; + if (name == null || name.ToString().IsNullOrWhiteSpace()) + { + return string.Empty; + } + + var args = arguments.Skip(1).Where(x => x != null && !x.ToString().IsNullOrWhiteSpace()).ToArray(); + return args.Any() ? _localizer[name.ToString(), args] : _localizer[name.ToString()]; + } + } +} diff --git a/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateRenderer.cs b/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateRenderer.cs index 86eb684f52..c7d7b9d016 100644 --- a/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateRenderer.cs +++ b/framework/src/Volo.Abp.TextTemplating/Volo/Abp/TextTemplating/TemplateRenderer.cs @@ -140,12 +140,7 @@ namespace Volo.Abp.TextTemplating var localizer = GetLocalizerOrNull(templateDefinition); if (localizer != null) { - scriptObject.Import( - "L", - new Func( - name => localizer[name] - ) - ); + scriptObject.SetValue("L", new TemplateLocalizer(localizer), true); } context.PushGlobal(scriptObject); @@ -163,4 +158,4 @@ namespace Volo.Abp.TextTemplating return _stringLocalizerFactory.CreateDefaultOrNull(); } } -} \ No newline at end of file +} diff --git a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/en.json b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/en.json index a0dff7e930..441661716c 100644 --- a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/en.json +++ b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/en.json @@ -1,6 +1,7 @@ { "culture": "en", "texts": { - "HelloText": "Hello" - } -} \ No newline at end of file + "HelloText": "Hello {0}", + "HowAreYou": "how are you?" + } +} diff --git a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/tr.json b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/tr.json index d09f02cd8f..60e5da8fa0 100644 --- a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/tr.json +++ b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/Localization/tr.json @@ -1,6 +1,7 @@ { "culture": "tr", "texts": { - "HelloText": "Merhaba" - } -} \ No newline at end of file + "HelloText": "Merhaba {0}", + "HowAreYou": "nasılsın?" + } +} diff --git a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/SampleTemplates/ForgotPasswordEmail.tpl b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/SampleTemplates/ForgotPasswordEmail.tpl index 8bcab86d0f..6e5fcbe6e1 100644 --- a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/SampleTemplates/ForgotPasswordEmail.tpl +++ b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/SampleTemplates/ForgotPasswordEmail.tpl @@ -1 +1 @@ -{{L "HelloText"}}. Please click to the following link to get an email to reset your password! \ No newline at end of file +{{L "HelloText" model.name}}, {{L "HowAreYou" }}. Please click to the following link to get an email to reset your password! \ No newline at end of file diff --git a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/TemplateRenderer_Tests.cs b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/TemplateRenderer_Tests.cs index 14b3df3486..fef287a2b1 100644 --- a/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/TemplateRenderer_Tests.cs +++ b/framework/test/Volo.Abp.TextTemplating.Tests/Volo/Abp/TextTemplating/TemplateRenderer_Tests.cs @@ -81,13 +81,15 @@ namespace Volo.Abp.TextTemplating { (await _templateRenderer.RenderAsync( TestTemplates.ForgotPasswordEmail, + new ForgotPasswordEmailModel("John"), cultureName: "en" - )).ShouldBe("*BEGIN*Hello. Please click to the following link to get an email to reset your password!*END*"); + )).ShouldBe("*BEGIN*Hello John, how are you?. Please click to the following link to get an email to reset your password!*END*"); (await _templateRenderer.RenderAsync( TestTemplates.ForgotPasswordEmail, + model: new Dictionary() { { "name", "John" } }, cultureName: "tr" - )).ShouldBe("*BEGIN*Merhaba. Please click to the following link to get an email to reset your password!*END*"); + )).ShouldBe("*BEGIN*Merhaba John, nasılsın?. Please click to the following link to get an email to reset your password!*END*"); } private class WelcomeEmailModel @@ -104,5 +106,20 @@ namespace Volo.Abp.TextTemplating Name = name; } } + + private class ForgotPasswordEmailModel + { + public string Name { get; set; } + + public ForgotPasswordEmailModel() + { + + } + + public ForgotPasswordEmailModel(string name) + { + Name = name; + } + } } }