molajo/language

Molajo Language Services for PHP Applications

=======, _(*1)

Language Package

, _(*2)

Language Services supporting translations for the User Interface for PHP applications using Adapters for different implementation types., _(*3)

How to specify Language

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

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:, _(*5)

php $language = new Language($language);, _(*6)

Once instantiated, all calls to the class can be made using the $language instance., _(*7)

Language Properties

To retrieve the key value (ex. 'en-GB') for the language which is loaded: php $language->get('language');, _(*8)

Retrieve Language Strings

To retrieve all language strings and translations for the loaded language: php $language->get('strings');, _(*9)

Retrieve List of all installed Languages

To retrieve a list of all languages installed in this application: php $language->get('installed');, _(*10)

Retrieve Language Attribute

To retrieve a registry attribute value (id, name, rtl, local, first_day) for the loaded language: php $language->get('name-of-attribute');, _(*11)

Retrieve all Language Attributes

To retrieve all registry attribute values as an array for the loaded language:, _(*12)

php $language->get('registry');, _(*13)

Translate

To translate the string $xyz: php $language->translate($xyz);, _(*14)

To retrieve a list of language strings and translations matching a wildcard value: php $language->translate($xyz, 1);, _(*15)

Identify Untranslated Strings

To insert strings found in code but are not already in database:, _(*16)

• 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:, _(*17)

• 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