UIZE JavaScript Framework

MODULES Uize.Loc.Strings.Util

1. Introduction

The Uize.Loc.Strings.Util module provides utility methods for working with resource strings.

DEVELOPERS: Chris van Rensburg

1.1. Examples

There are no dedicated showcase example pages for the Uize.Loc.Strings.Util module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Loc.Strings.Util module...

SEARCH

1.2. Implementation Info

The Uize.Loc.Strings.Util module defines the Uize.Loc.Strings.Util package under the Uize.Loc.Strings namespace.

1.2.1. Features Introduced in This Module

1.2.2. Features Overridden in This Module

No features have been overridden in this module.

1.2.3. Features Inherited From Other Modules

This module has no inherited features.

1.2.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.2.5. Unit Tests

The Uize.Loc.Strings.Util module is unit tested by the Uize.Test.Uize.Loc.Strings.Util test module.

2. Static Methods

2.1. Uize.Loc.Strings.Util.diffResources

Returns a strings diff array, containing string diff objects for every string for which there are differences between the two specified project resource strings objects.

SYNTAX

stringsDiffARRAY = Uize.Loc.Strings.Util.diffResources (stringsAOBJ,stringsBOBJ);

IMPLEMENTATION INFO

this feature was introduced in this module

2.2. Uize.Loc.Strings.Util.initNonTranslatable

Lets you initialize the non-translatable strings in a project resource strings object.

SYNTAX

initializedStringsOBJ = Uize.Loc.Strings.Util.initNonTranslatable (
  translatableLanguageStringsOBJ,
  primaryLanguageStringsOBJ,
  initModeSTR,
  isTranslatableStringFUNC
);

The Uize.Loc.Strings.Util.initNonTranslatable method is essentially a specialized usage of the more versatile Uize.Loc.Strings.Util.initValues static method.

NOTES

compare to the related Uize.Loc.Strings.Util.initValues static method

IMPLEMENTATION INFO

this feature was introduced in this module

2.3. Uize.Loc.Strings.Util.initValues

Lets you initialize strings in a project resource strings object, with versatile options that make it possible to achieve a variety of different initialization behaviors.

SYNTAX

initializedStringsOBJ = Uize.Loc.Strings.Util.initValues (
  translatableLanguageStringsOBJ,
  primaryLanguageStringsOBJ,
  initWhatSTR,
  initWhenSTR,
  initToSTR,
  isTranslatableStringFUNC
);

NOTES

compare to the related Uize.Loc.Strings.Util.initNonTranslatable static method

IMPLEMENTATION INFO

this feature was introduced in this module

2.4. Uize.Loc.Strings.Util.pseudoLocalizeResources

Returns a new project resource strings object, being the specified project resource strings object with all translatable strings pseudo-localized.

SYNTAX

pseudoLocalizedStringsOBJ = Uize.Loc.Strings.Util.pseudoLocalizeResources (
  stringsOBJ,
  isTranslatableStringFUNC,
  pseudoLocalizeStringFUNC
);

IMPLEMENTATION INFO

this feature was introduced in this module

2.5. Uize.Loc.Strings.Util.removeEmptyStrings

Returns a new project resource strings object, being the specified project resource strings object with all empty strings removed.

SYNTAX

prunedStringsOBJ = Uize.Loc.Strings.Util.removeEmptyStrings (stringsOBJ);

IMPLEMENTATION INFO

this feature was introduced in this module

2.6. Uize.Loc.Strings.Util.resourcesDiffAsCsv

Returns a strings, being the specified strings diff array serialized to CSV format.

SYNTAX

stringsDiffAsCsvSTR = Uize.Loc.Strings.Util.resourcesDiffAsCsv (stringsDiffARRAY);

IMPLEMENTATION INFO

this feature was introduced in this module

3. Static Properties

3.1. Uize.Loc.Strings.Util.moduleName

IMPLEMENTATION INFO

this feature was introduced in this module

3.2. Uize.Loc.Strings.Util.pathToResources

IMPLEMENTATION INFO

this feature was introduced in this module