molajo/language

Molajo Language Services for PHP Applications

v0.4 2014-04-07 15:44 UTC

Requires

• php: >=5.4
• commonapi/language: dev-master

MIT

• Amy Stephen

• language
• Molajo
• CommonApi

README

======= Language Package

Language Services supporting translations for the User Interface for PHP applications using Adapters for different implementation types.

How to specify Language

Language strings are loaded in startup for language determined in this order (and installed):

1. Injected value during class instantiation
2. Session
3. User Data
4. Client Language
5. Application Configuration
6. Defaults to en-GB

Instantiation

To instantiate the Language Class:

   $language = new Language($language);

Once instantiated, all calls to the class can be made using the $language instance.

Language Properties

To retrieve the key value (ex. 'en-GB') for the language which is loaded:

   $language->get('language');

Retrieve Language Strings

To retrieve all language strings and translations for the loaded language:

   $language->get('strings');

Retrieve List of all installed Languages

To retrieve a list of all languages installed in this application:

   $language->get('installed');

Retrieve Language Attribute

To retrieve a registry attribute value (id, name, rtl, local, first_day) for the loaded language:

   $language->get('name-of-attribute');

Retrieve all Language Attributes

To retrieve all registry attribute values as an array for the loaded language:

   $language->get('registry');

Translate

To translate the string $xyz:

   $language->translate($xyz);

To retrieve a list of language strings and translations matching a wildcard value:

   $language->translate($xyz, 1);

Identify Untranslated Strings

To insert strings found in code but are not already in database:

• If an administrator is logged on, the primary language services automatically insert untranslated strings
• To avoid doing so, override the LanguagePlugin and set insert_missing_strings to 0
• For instances you define, set the insert_missing_strings, as needed.

To log strings found in code, but are not already in database:

• Set the Application configuration option profile_missing_strings to 1 and turn on profiling

Requirements and Compliance

• PHP framework independent, no dependencies
• Requires PHP 5.4, or above
• Semantic Versioning
• Compliant with:
  • PSR-1 Basic Coding Standards
  • PSR-2 Coding Style
  • PSR-4 Namespacing
• [phpDocumentor2] (https://github.com/phpDocumentor/phpDocumentor2)
• [phpUnit Testing] (https://github.com/sebastianbergmann/phpunit)
• Author AmyStephen
• [Travis Continuous Improvement] (https://travis-ci.org/profile/Molajo)
• Listed on [Packagist] (http://packagist.org) and installed using [Composer] (http://getcomposer.org/)
• Use github to submit pull requests and features
• Licensed under the MIT License - see the LICENSE file for details