cosninix/sin

Simple internationalization for Laravel

v2.0.04 2023-08-08 08:53 UTC

Requires

• php: ^7|^8
• illuminate/support: ^8.0|^9.0|^10.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• orchestra/testbench: *
• phpmd/phpmd: ^2.8
• phpunit/phpunit: ^9.6

MIT

• Ronald van Woensel

• i18n
• library
• internationalization

README

Sin takes a whole new approach to internationalization (i18n) that is useful for simple projects or when the developer can make fast translations on the fly. The way it works is very simple: Just define a string in a special format containg all the languages, as follows:

"en::What is your name?|nl::Wat je is naam?|de::Wie heisst du?|fr::Comment t'appelles-tu?"

Because Sin uses strings only, it can be used in code, but also in databases, yaml or json files or anywhere where a string is presented to the user.

Sin integrates seemless with Laravel and uses the old and new laravel internationalization styles so it can be seen as an add-on to this mechanism.

Sin is most useful for bi-lingual applications (like dutch/english) where the developer includes immediate translations while coding.

Installation

    composer install cosninix/sin

The sin package creates the Sin facade alias, a serviceprovider and a helper function

Basic usage

    echo app('Sin')->lang("nl::via de serviceprovider|en::via the serviceprovider");

    echo Sin::lang("nl::via de Sin facade deze keer|en::through the Sin facade this time");
    
    // three underscores
    echo ___("nl::via de helper function|en::works with the helper function");

and also in blade using the @slang directive

    <h1>@slang('nl::blade constructie|en::blade construct')</h1>

If the sin syntax is not found, Sin passes the string as is. The syntax is triggered on all strings beginning wih the XX:: format.

    Sin::lang('passed without alterations %f'); --> 'passed without alterations %f'

Sin runs every result (where syntax is triggered!) through sprintf:

    Sin::lang("en::We have %d smartphones in stock|nl::nu %d smartphones op voorraad",20); 

Of course, Sin is not limited to php code. You can use Sin in yaml or json files as long as you pass it through Sin before presenting it.

    list: { options: [ 1, 3 ], text: [ "nl::kies 1|en::choose 1", "nl::Neem er 3|en::Take 3" ] }

For instance this could be done with database values in blade:

    <h1>@slang( $stock->article_name )</h1>

Laravel integration

Sin takes the app.locale config as the default language and app.fallback_locale as fallback. If you change the app language using

    App::setLocale('nl');

If the current language is not found, the fallback locale is used.

You can prepare for Laravel translations by giving an additional laravel key that can be used with the traditional @lang construct:

    Sin::lang('nl::Nederlands|en::English|@@::language_key);

If the language_key exists in the laravel translations, this takes priority, otherwise the Sin translations are used. So you can add traditional translations later on.