molajo/render

Molajo Rendering for PHP Applications

0.1.0 2013-11-24 23:48 UTC

Requires

• php: >=5.3.10
• commonapi/render: dev-master

Suggests

• mustache/mustache: Mustache Rendering
• twig/twig: Twig Rendering

MIT

• Amy Stephen

• render
• Molajo
• CommonApi

README

======= Render Package

Render Services supporting translations for the User Interface for PHP applications using Adapters for different implementation types (ex., Database, *.ini files, etc.).

System Requirements

• PHP 5.3.3, or above
• PSR-0 compliant Autoloader
• PHP Framework independent
• [optional] PHPUnit 3.5+ to execute the test suite (phpunit --version)

How to specify Render

Render 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 Render
5. Application Configuration
6. Defaults to en-GB

Instantiation

To instantiate the Render Class:

   $language = new Render($language);

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

Render Properties

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

   $language->get('language');

Retrieve Render Strings

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

   $language->get('strings');

Retrieve List of all installed Renders

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

   $language->get('installed');

Retrieve Render Attribute

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

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

Retrieve all Render 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 RenderPlugin 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