MODULES Uize.Services.Loc
- Contents
- 1. Introduction
-
2. Instance Methods
- 2.1. about
- 2.2. auditTranslations
- 2.3. diffLanguages
- 2.4. export
- 2.5. exportJobs
- 2.6. extract
- 2.7. fire
- 2.8. get
- 2.9. import
- 2.10. importJobs
- 2.11. init
- 2.12. is
- 2.13. isMet
- 2.14. kill
- 2.15. met
- 2.16. metrics
- 2.17. onChange
- 2.18. once
- 2.19. preview
- 2.20. pseudoLocalize
- 2.21. set
- 2.22. toggle
- 2.23. unmet
- 2.24. unwire
- 2.25. usage
- 2.26. valueOf
- 2.27. whenever
- 2.28. wire
- 3. State Properties
-
4. Static Methods
- 4.1. Uize.Services.Loc.alphastructor
- 4.2. Uize.Services.Loc.declare
- 4.3. Uize.Services.Loc.doMy
- 4.4. Uize.Services.Loc.dualContextMethods
- 4.5. Uize.Services.Loc.dualContextProperties
- 4.6. Uize.Services.Loc.fire
- 4.7. Uize.Services.Loc.get
- 4.8. Uize.Services.Loc.instanceMethods
- 4.9. Uize.Services.Loc.instanceProperties
- 4.10. Uize.Services.Loc.mixins
- 4.11. Uize.Services.Loc.omegastructor
- 4.12. Uize.Services.Loc.serviceMethods
- 4.13. Uize.Services.Loc.set
- 4.14. Uize.Services.Loc.singleton
- 4.15. Uize.Services.Loc.stateProperties
- 4.16. Uize.Services.Loc.staticMethods
- 4.17. Uize.Services.Loc.staticProperties
- 4.18. Uize.Services.Loc.subclass
- 4.19. Uize.Services.Loc.toggle
- 4.20. Uize.Services.Loc.unwire
- 4.21. Uize.Services.Loc.wire
- 5. Static Properties
1. Introduction
The Uize.Services.Loc module defines a class for a project localization service.
DEVELOPERS: Chris van Rensburg
1.1. Examples
There are no dedicated showcase example pages for the Uize.Services.Loc module.
SEARCH FOR EXAMPLES
Use the link below to search for example pages on the UIZE Web site that reference the Uize.Services.Loc module...
SEARCH
1.2. Implementation Info
The Uize.Services.Loc module defines the Uize.Services.Loc class, which is a subclass of Uize.Service.
INHERITANCE CHAIN
Uize.Class −> Uize.Service −> Uize.Services.Loc
1.2.1. Features Introduced in This Module
The features listed in this section have been introduced in this module.
INSTANCE METHODS
about | auditTranslations | diffLanguages | export | exportJobs | extract | import | importJobs | init | metrics | preview | pseudoLocalize | usage
1.2.2. Features Overridden in This Module
The features listed in this section have been overridden in this module.
The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.
INSTANCE METHODS
STATIC PROPERTIES
Uize.Services.Loc.moduleName | Uize.Services.Loc.nonInheritableStatics
1.2.3. Features Inherited From Other Modules
The features listed in this section have been inherited from other modules.
The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.
INSTANCE METHODS
fire | get | is | isMet | kill | met | onChange | once | set | toggle | unmet | unwire | whenever | wire
STATE PROPERTIES
STATIC METHODS
Uize.Services.Loc.alphastructor | Uize.Services.Loc.declare | Uize.Services.Loc.doMy | Uize.Services.Loc.dualContextMethods | Uize.Services.Loc.dualContextProperties | Uize.Services.Loc.fire | Uize.Services.Loc.get | Uize.Services.Loc.instanceMethods | Uize.Services.Loc.instanceProperties | Uize.Services.Loc.mixins | Uize.Services.Loc.omegastructor | Uize.Services.Loc.serviceMethods | Uize.Services.Loc.set | Uize.Services.Loc.singleton | Uize.Services.Loc.stateProperties | Uize.Services.Loc.staticMethods | Uize.Services.Loc.staticProperties | Uize.Services.Loc.subclass | Uize.Services.Loc.toggle | Uize.Services.Loc.unwire | Uize.Services.Loc.wire
STATIC PROPERTIES
1.2.4. Modules Directly Under This Namespace
There are no modules directly under this namespace.
1.2.5. Unit Tests
There is no dedicated unit tests module for the Uize.Services.Loc module.
2. Instance Methods
2.1. about
Displays the configuration information for the project.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.2. auditTranslations
Performs an audit of the resource strings for the translatable languages of the project, to find issues like inconsistent translations within a translatable language of the same primary language text.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.3. diffLanguages
Performs a diff between the resource strings of the two specified languages.
2.3.1. Parameters
2.3.1.1. languageA
A locale code string, specifying the first of the two languages whose resource strings should be diffed.
2.3.1.2. languageB
A locale code string, specifying the second of the two languages whose resource strings should be diffed.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.4. export
Exports resource strings from the project, gathering resource strings from resource files located through the project's codebase.
This method also performs pseudo-localization for all of a project's resource strings, generating strings for a pseudo-locale that can then be imported into the project using the import method.
NOTES
see the companion import service method |
|
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.5. exportJobs
Exports a translation job from the centralized resources of a project.
NOTES
see the companion importJobs service method |
|
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.6. extract
Extracts resource strings from a project's source code files so that they can be organized into resource files for the project.
Depending on the type of project, this service method may have no implementation and may, therefore, not perform any action. It may not be feasible for all types of projects to support scripted extraction of strings from the source code and it may, therefore, be the developers' responsibility to manually enter resource strings into resource files for the project.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.7. fire
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.8. get
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.9. import
Imports language specific resource strings into the project, creating language specific resource files in the appropriate places, as needed.
NOTES
see the companion export service method |
|
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.10. importJobs
Imports a completed translation job into the centralized resources of a project.
NOTES
see the companion exportJobs service method |
|
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.11. init
Initializes the localization service.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.12. is
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.13. isMet
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.14. kill
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.15. met
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.16. metrics
Produces a report containing key metrics about a project's resource strings, such as number of individual resource files, estimated word count, estimated character count.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.17. onChange
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.18. once
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.19. preview
Generates previews that can be used for linguistic QA for the project.
This method may be optionally implemented for a project, and the nature of any previews generated by this method will be entirely dependent on the nature of the project.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.20. pseudoLocalize
Performs pseudo-localization on the primary language resource files of the project, modifying the resource files for the primary language.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.21. set
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.22. toggle
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.23. unmet
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.24. unwire
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.25. usage
Produces a usage report for a project's resource strings, containing detailed information on where each resource string is referenced in the project's code, along with a summary of the unreferenced resource strings.
NOTES
| this service method is asynchronous |
IMPLEMENTATION INFO
| this feature was introduced in this module |
2.26. valueOf
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class) |
IMPLEMENTATION INFO
2.27. whenever
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
2.28. wire
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
3. State Properties
3.1. adapter
Inherited from Uize.Service.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service) |
3.2. initialized
Inherited from Uize.Service.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service) |
4. Static Methods
4.1. Uize.Services.Loc.alphastructor
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.2. Uize.Services.Loc.declare
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.3. Uize.Services.Loc.doMy
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.4. Uize.Services.Loc.dualContextMethods
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.5. Uize.Services.Loc.dualContextProperties
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.6. Uize.Services.Loc.fire
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.7. Uize.Services.Loc.get
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.8. Uize.Services.Loc.instanceMethods
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.9. Uize.Services.Loc.instanceProperties
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.10. Uize.Services.Loc.mixins
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.11. Uize.Services.Loc.omegastructor
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.12. Uize.Services.Loc.serviceMethods
Inherited from Uize.Service.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Service, first introduced in Uize.Service) |
|
| this static feature is inherited by subclasses |
4.13. Uize.Services.Loc.set
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.14. Uize.Services.Loc.singleton
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.15. Uize.Services.Loc.stateProperties
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.16. Uize.Services.Loc.staticMethods
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.17. Uize.Services.Loc.staticProperties
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.18. Uize.Services.Loc.subclass
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.19. Uize.Services.Loc.toggle
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.20. Uize.Services.Loc.unwire
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
4.21. Uize.Services.Loc.wire
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
5. Static Properties
5.1. Uize.Services.Loc.moduleName
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |
5.2. Uize.Services.Loc.nonInheritableStatics
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class) |
|
| this static feature is not inherited by subclasses |
5.3. Uize.Services.Loc.pathToResources
Inherited from Uize.Class.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class) |
|
| this static feature is inherited by subclasses |