i18n/I18n.php at master · flextype-components/i18n · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<?php

declare(strict_types=1);

/**
 * i18n Component
 * Founded by Sergey Romanenko and maintained by Community.
 */

namespace Flextype\Component\I18n;

class I18n
{
    /**
     * Dictionary
     *
     * @var array
     */
    public static $dictionary = [];

    /**
     * Default locale
     *
     * @var string
     */
    public static $locale = 'en_US';

    /**
     * Add translation keys
     *
     * New translation keus for default locale
     * I18n::add(['auth_login' => 'Login', 'auth_password' => 'Password']);
     *
     * New translation keys for `en_US` locale
     * I18n::add(['auth_login' => 'Login', 'auth_password' => 'Password'], 'en_US');
     *
     * @param  string $translates Translation keys and values to add
     * @param  string $locale     Locale
     * @return void
     */
    public static function add(array $translates, string $locale = null) : void
    {
        $locale = ($locale === null) ? I18n::$locale : $locale;

        if (isset(I18n::$dictionary[$locale])) {
            I18n::$dictionary[$locale] += $translates;
        } else {
            I18n::$dictionary[$locale] = $translates;
        }
    }

    /**
     * Returns translation of a string. If no translation exists, the original
     * string will be returned. No parameters are replaced.
     *
     * Get translated string for `auth_login` for default locale
     * $translated_string = I18n::find('auth_login');
     *
     * @param  string $translate Translate to find
     * @param  array  $values    Values to replace in the translated text
     * @param  string $locale    Locale
     * @return string
     */
    public static function find(string $translate, array $values = [], string $locale = null) : string
    {
        $locale = ($locale === null) ? I18n::$locale : $locale;

        // Search current string to translate in the Dictionary
        if (isset(I18n::$dictionary[$locale][$translate])) {
            $translate = I18n::$dictionary[$locale][$translate];
            $translate = empty($values) ? $translate : strtr($translate, $values);
        } else {
            $translate = $translate;
        }

        // Return translation of a string
        return $translate;
    }
}

if ( ! function_exists('__')) {
    /**
     * Global Translation/Internationalization function.
     * Accepts an translation key and returns its translation for selected language.
     * If the given translation key is not available in the current dictionary the
     * translation key will be returned.
     *
     * Dislay a translated message for default locale
     * echo __('auth_login');
     *
     * // Display a translated message
     * echo __('auth_login', [], 'en_US');
     *
     * // With parameter replacement
     * echo __('auth_welcome_message', [':username' => $username], 'en_US');
     *
     * @param  string $translate Translate to find
     * @param  array  $values    Values to replace in the translated text
     * @param  string $locale    Locale
     * @return string
     */
    function __(string $translate, array $values = [], string $locale = null) : string
    {
        return I18n::find($translate, $values, $locale);
    }
}