README

A package to allow your class to support verbose localization.

Installation

You can install the package via composer:

composer require chinleung/verbose-localization

Usage

Add the ChinLeung\VerboseLocalization\HasVerboseLocalization trait to your class and create a method getTranslationIn(string $locale) to handle the translation of your class and get access to all the verbose methods instantly like the following example.

Suppose you have files with the translation of the text equivalent of numbers:

<?php

class NumberClass
{
    use ChinLeung\VerboseLocalization\HasVerboseLocalization;

    /**
     * Constructor of the class.
     *
     * @param  int  $value
     */
    public function __construct(int $value)
    {
        $this->value = $value;
    }

    /**
     * Retrieve the translation in a specific locale.
     *
     * @param  string  $locale
     * @return string
     */
    public function getTranslationIn(string $locale) : string
    {
        $translations = require __DIR__."/resources/lang/$locale/numbers.php";

        return $translations[$this->value];
    }
}

Then you can retrieve the translations like this:

$number = new NumberClass(1);

$number->inFrench(); // 'un'
$number->inEnglish(); // 'one'
$number->inSimplifiedChinese(); // '一'

Methods

The methods are seperated by language families which are located in src/Concerns.

Afro-Asiatic

Austronesian

Dravidian

French Creole

Hmong-Mien

Indo-European

Isolate

Japonic

Kartvelian

Koreanic

Kra-Dai

Monogolic

Niger-Congo

Sino-Tibetan

Turkic

Uralic

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email hello@chinleung.com instead of using the issue tracker.

Credits

• Chin Leung
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

PHP Package Boilerplate

This package was generated using the PHP Package Boilerplate.