alexya-framework/localization

Alexya's Localization utilities

Localization

Alexya's localization components, _(*1)

Contents

• Text translation
  • Instantiating Translator objects
  • Translating texts

, _(*2)

Text translation

The class \Alexya\Localization\Translator offers a way for translating texts. Bassically you instance a Translator object with the given text translatation and the you call the translate method whenever you want to translate a text., _(*3)

, _(*4)

Instantiating Translator objects

The constructor accepts as parameter an associative array containing the language code and the translations. Optionally you can send a second parameter being the default language where the texts will be translated., _(*5)

Example:, _(*6)

<?php
$translator = new \Alexya\Localization\Translator([
    "en" => [
        "monday"    => "monday",
        "thursday"  => "thursday",
        "wednesday" => "wednesday",
        "tuesday"   => "tuesday",
        "friday"    => "friday",
        "saturday"  => "saturday",
        "sunday"    => "sunday"
    ],
    "es" => [
        "monday"    => "lunes",
        "thursday"  => "martes",
        "wednesday" => "miercoles",
        "tuesday"   => "jueves",
        "friday"    => "viernes",
        "saturday"  => "sabado",
        "sunday"    => "domingo"
    ]
], "en");

, _(*7)

Translating texts

Once the object has been instantiated you can use the method translate to translate a text. It accepts as parameter a string being the text to translate., _(*8)

Optionally you can send an array with the variables to parse or a string with the language code to translate the text, or even both., _(*9)

If the language doesn't exist, the text will be translated to the default language., _(*10)

If the text couldn't be translated, it will return the first parameter., _(*11)

Example:, _(*12)

<?php
$translator = new \Alexya\Localization\Translator([
    "en" => [
        "monday"    => "monday",
        "thursday"  => "thursday",
        "wednesday" => "wednesday",
        "tuesday"   => "tuesday",
        "friday"    => "friday",
        "saturday"  => "saturday",
        "sunday"    => "sunday",

        "Today is {day}" => "Today is {day}"
    ],
    "es" => [
        "monday"    => "lunes",
        "thursday"  => "martes",
        "wednesday" => "miercoles",
        "tuesday"   => "jueves",
        "friday"    => "viernes",
        "saturday"  => "sabado",
        "sunday"    => "domingo",

        "Today is {day}" => "Hoy es {day}"
    ]
]);

// Quick translation
$translator->translate("Today is {day}");
// Today is {day}

// Translation with context
$translator->translate("Today is {day}", [
    "day" => $translator->translate("monday")
]);
// Today is monday

// Translation in a specific language
$translator->translate("Today is {day}", "es");
// Hoy es {day}

// Translation in a specific language with context
$translator->translate("Today is {day}", [
    "day" => $translator->translate("monday", "es")
], "es");
// Hoy es lunes

// Text that can't be translated
$translator->translate("some_text");
// some_text

If the language isn't specified it will be translated to the language sent to the method setDefaultLanguage., _(*13)

For translating texts of a sub-array use a dot (.) to link the texts to translate:, _(*14)

<?php
$translator = new \Alexya\Localization\Translator([
    "en" => [
        "days" => [
            "monday"    => "monday",
            "thursday"  => "thursday",
            "wednesday" => "wednesday",
            "tuesday"   => "tuesday",
            "friday"    => "friday",
            "saturday"  => "saturday",
            "sunday"    => "sunday"
        ],
        "phrases" => [
            "today_is" => "Today is {day}"
        ]
    ]
]);

// Recursive translation
$translator->translate("phrases.today_is", [
    "day" => $translator->translate("days.monday")
]);
// Today is monday

You can also add more translations to an already specified language with the method addTranslations. It accepts as parameter the language code and an array containing the translations to add. If the language code doesn't exist, it will create it., _(*15)