Pager should inherits from LocalizableComponent

This commit is contained in:
Hisham Bin Ateya
2022-05-27 15:33:48 +03:00
parent c272238539
commit 583383aee1
8 changed files with 185 additions and 21 deletions

View File

@ -105,9 +105,9 @@
_iconSpan = $"<span class=\"{IconName}\"></span>&nbsp;";
}
Text = Localize(nameof(Text), Text);
Header = Localize(nameof(Header), Header);
Message = Localize(nameof(Message), Message);
Text = LocalizeResource(nameof(Text), Text);
Header = LocalizeResource(nameof(Header), Header);
Message = LocalizeResource(nameof(Message), Message);
_permissions = (string.IsNullOrEmpty(Permissions)) ? ModuleState.Permissions : Permissions;
_authorized = IsAuthorized();

View File

@ -116,7 +116,7 @@
}
_permissions = (string.IsNullOrEmpty(Permissions)) ? ModuleState.Permissions : Permissions;
_text = Localize(nameof(Text), _text);
_text = LocalizeResource(nameof(Text), _text);
_url = (ModuleId == -1) ? EditUrl(Action, _parameters) : EditUrl(ModuleId, Action, _parameters);
_authorized = IsAuthorized();
}

View File

@ -35,7 +35,7 @@ else
if (!string.IsNullOrEmpty(HelpText))
{
_helptext = Localize(nameof(HelpText), HelpText);
_helptext = LocalizeResource(nameof(HelpText), HelpText);
_labelclass = "form-label";
var spanclass = (!string.IsNullOrEmpty(Class)) ? " " + Class : "";
@ -47,7 +47,7 @@ else
_labelclass = "form-label" + labelclass;
}
var text = Localize("Text", String.Empty);
var text = LocalizeResource("Text", String.Empty);
if (!string.IsNullOrEmpty(text))
{
ChildContent =@<text>@text</text>;

View File

@ -9,6 +9,7 @@ namespace Oqtane.Modules.Controls
public class LocalizableComponent : ModuleControlBase
{
private IStringLocalizer _localizer;
private IStringLocalizer _resourceLocalizer;
[Parameter]
public string ResourceKey { get; set; }
@ -18,9 +19,27 @@ namespace Oqtane.Modules.Controls
protected bool IsLocalizable { get; private set; }
protected string Localize(string name) => _localizer?[name] ?? name;
protected string Localize(string name)
{
if (_localizer == null)
{
_localizer = CreateLocalizer();
}
protected string Localize(string propertyName, string propertyValue)
return _localizer[name];
}
protected string Localize(string name, params object[] arguments)
{
if (_localizer == null)
{
_localizer = CreateLocalizer();
}
return _localizer[name, arguments];
}
protected string LocalizeResource(string propertyName, string propertyValue)
{
if (!IsLocalizable)
{
@ -28,7 +47,7 @@ namespace Oqtane.Modules.Controls
}
var key = $"{ResourceKey}.{propertyName}";
var value = Localize(key);
var value = _resourceLocalizer?[key] ?? key;
if (value == key)
{
@ -53,12 +72,12 @@ namespace Oqtane.Modules.Controls
{
IsLocalizable = false;
if (string.IsNullOrEmpty(ResourceType))
if (String.IsNullOrEmpty(ResourceType))
{
ResourceType = ModuleState?.ModuleType;
}
if (!String.IsNullOrEmpty(ResourceKey) && !string.IsNullOrEmpty(ResourceType))
if (!String.IsNullOrEmpty(ResourceKey) && !String.IsNullOrEmpty(ResourceType))
{
var moduleType = Type.GetType(ResourceType);
if (moduleType != null)
@ -66,12 +85,34 @@ namespace Oqtane.Modules.Controls
using (var scope = ServiceActivator.GetScope())
{
var localizerFactory = scope.ServiceProvider.GetService<IStringLocalizerFactory>();
_localizer = localizerFactory.Create(moduleType);
_resourceLocalizer = localizerFactory.Create(moduleType);
IsLocalizable = true;
}
}
}
}
private IStringLocalizer CreateLocalizer()
{
using (var scope = ServiceActivator.GetScope())
{
var controlType = GetType();
var controlTypeName = controlType.Name;
// Remove `1 if the control is generic type
if (controlTypeName.EndsWith("`1"))
{
controlTypeName = controlTypeName.TrimEnd('`', '1');
}
var baseName = controlType.FullName[0..controlType.FullName.IndexOf(controlTypeName)].Substring("Oqtane.".Length);
var localizerFactory = scope.ServiceProvider.GetService<IStringLocalizerFactory>();
_localizer = localizerFactory.Create(baseName + controlTypeName, controlType.Assembly.GetName().Name);
}
return _localizer;
}
}
}

View File

@ -1,6 +1,6 @@
@namespace Oqtane.Modules.Controls
@inherits ModuleControlBase
@inject IStringLocalizer<SharedResources> Localizer
@inherits LocalizableComponent
@typeparam TableItem
@if (ItemList != null)
@ -49,7 +49,7 @@
<a class="page-link" @onclick=@(async () => UpdateList(_pages))><span class="oi oi-media-step-forward" title="end" aria-hidden="true"></span></a>
</li>
<li class="page-item disabled">
<a class="page-link" style="white-space: nowrap;">@Localizer["PageOfPages", @_page, @_pages]</a>
<a class="page-link" style="white-space: nowrap;">@Localize("PageOfPages", _page, _pages)</a>
</li>
</ul>
}
@ -157,7 +157,7 @@
<a class="page-link" @onclick=@(async () => UpdateList(_pages))><span class="oi oi-media-step-forward" title="end" aria-hidden="true"></span></a>
</li>
<li class="page-item disabled">
<a class="page-link" style="white-space: nowrap;">@Localizer["PageOfPages", @_page, @_pages]</a>
<a class="page-link" style="white-space: nowrap;">@Localize("PageOfPages", _page, _pages)</a>
</li>
</ul>
}
@ -208,7 +208,7 @@
[Parameter]
public string RowClass { get; set; } // class for row element - ie. <tr> for Table or <div> for Grid
[Parameter]
[Parameter]
public string ColumnClass { get; set; } // class for column element - only applicable to Grid format
[Parameter]

View File

@ -49,7 +49,7 @@
base.OnParametersSet();
_heading = !string.IsNullOrEmpty(Heading)
? Localize(nameof(Heading), Heading)
: Localize(nameof(Name), Name);
? LocalizeResource(nameof(Heading), Heading)
: LocalizeResource(nameof(Name), Name);
}
}

View File

@ -38,11 +38,11 @@ else
if (string.IsNullOrEmpty(Heading))
{
Heading = Localize(nameof(Name), Name);
Heading = LocalizeResource(nameof(Name), Name);
}
else
{
Heading = Localize(nameof(Heading), Heading);
Heading = LocalizeResource(nameof(Heading), Heading);
}
}

View File

@ -0,0 +1,123 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype">text/microsoft-resx</resheader>
<resheader name="version">2.0</resheader>
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="PageOfPages" xml:space="preserve">
<value>Page {0} of {1}</value>
</data>
</root>