kodedphp / i18n

I18n.php

<?php declare(strict_types=1);

namespace Koded\I18n;

use Koded\Stdlib\Config;
use Throwable;
use function error_log;
use function ini_set;
use function strtr;
use function substr_count;
use function vsprintf;

interface I18nFormatter
{
    /**
     * Message formatter for argument replacement in the message.
     *
     * @param string $string
     * @param array $arguments
     * @return string The message with applied arguments (if any)
     */
    public function format(string $string, array $arguments): string;
}

final class StrtrFormatter implements I18nFormatter
{
    public function format(string $string, array $arguments): string
    {
        return $arguments ? strtr($string, $arguments) : $string;
    }
}

final class DefaultFormatter implements I18nFormatter
{
    public function format(string $string, array $arguments): string
    {
        return $arguments ? vsprintf($string, $arguments) : $string;
    }
}

class I18n
{
    public const DEFAULT_LOCALE = 'en_US';

    /*
     * Default configuration parameters for all catalogs.
     * Values are taken by the explicitly set default locale,
     * or the first loaded catalog instance.
     */
    private static ?string $catalog = null;
    private static ?string $formatter = null;
    private static ?string $directory = null;
    private static ?string $locale = null;

    /** @var array<string, I18nCatalog> */
    private static array $catalogs = [];

    // @codeCoverageIgnoreStart
    private function __construct() {}
    // @codeCoverageIgnoreEnd

    public static function translate(
        string $string,
        array  $arguments = [],
        string $locale = null): string
    {
        try {
            return static::$catalogs[$locale]->translate('messages', $string, $arguments);

Since $catalogs is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalogs to at least protected.

        } catch (Throwable) {
            static::registerCatalog($locale ??= static::locale());
            return static::$catalogs[$locale]->translate('messages', $string, $arguments);
        }
    }

    public static function locale(): string
    {
        return static::$locale ??= static::normalizeLocale(\Locale::getDefault());

Since $locale is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $locale to at least protected.

    }

    /**
     * @return array{string, I18nCatalog}

The doc comment array{string, I18nCatalog} at position 2 could not be parsed: Expected ':' at position 2, but found 'string'.

     */
    public static function catalogs(): array
    {
        return static::$catalogs;

Since $catalogs is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalogs to at least protected.

    }

    /**
     * @return array{locale:string, catalogs:<string, array{class: string, formatter:string, dir:string, locale:string}>}

The doc comment array{locale:string, catalogs:<string, array{class: string, formatter:string, dir:string, locale:string}>} at position 8 could not be parsed: Unknown type name '<' at position 8 in array{locale:string, catalogs:<string, array{class: string, formatter:string, dir:string, locale:string}>}.

     */
    public static function info(): array
    {
        $catalogs = [];
        foreach (static::$catalogs as $locale => $instance) {

Since $catalogs is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalogs to at least protected.

            $catalogs[$locale] = [
                'class' => $instance::class,
                'formatter' => $instance->formatter()::class,
                'dir' => $instance->directory(),
                'locale' => $instance->locale(),
            ];
        }
        return [
            'locale' => static::$locale,

Since $locale is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $locale to at least protected.

            'catalogs' => $catalogs,
        ];
    }

    public static function register(
        I18nCatalog $catalog,
        bool        $asDefault = false): void
    {
        $locale = $catalog->locale();
        if ($asDefault || empty(static::$catalogs)) {

Since $catalogs is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalogs to at least protected.

            static::setDefaultLocale($locale);
            static::$directory = $catalog->directory();

Since $directory is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $directory to at least protected.

            static::$formatter = $catalog->formatter()::class;

Since $formatter is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $formatter to at least protected.

            static::$catalog = $catalog::class;

Since $catalog is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalog to at least protected.

        }
        static::$catalogs[$locale] = $catalog;
    }

    public static function flush(): void
    {
        static::$catalogs = [];

Since $catalogs is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalogs to at least protected.

        static::$directory = null;

Since $directory is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $directory to at least protected.

        static::$formatter = null;

Since $formatter is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $formatter to at least protected.

        static::$catalog = null;

Since $catalog is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalog to at least protected.

        static::$locale = null;

Since $locale is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $locale to at least protected.

        ini_set('intl.default_locale', '');
        \Locale::setDefault('');
    }

    private static function registerCatalog(string $locale): void
    {
        if (isset(static::$catalogs[$locale])) {

Since $catalogs is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalogs to at least protected.

            return;
        }
        static::$catalogs[$locale] = I18nCatalog::new((new Config)
            ->set('translation.locale', $locale)
            ->set('translation.dir', static::$directory)

Since $directory is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $directory to at least protected.

            ->set('translation.formatter', static::$formatter)

Since $formatter is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $formatter to at least protected.

            ->set('translation.catalog', static::$catalog)

Since $catalog is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $catalog to at least protected.

        );
    }

    private static function setDefaultLocale(string $locale): void
    {
        static::$locale = $locale;

Since $locale is declared private, accessing it with static will lead to errors in possible sub-classes; you can either use self, or increase the visibility of $locale to at least protected.

        ini_set('intl.default_locale', $locale);
        \Locale::setDefault($locale);
    }

    private static function normalizeLocale(string $locale): string
    {
        if (substr_count($locale, '_') > 1) {
            $locale = explode('_', $locale);
            $locale = "$locale[0]_$locale[1]";
        }
        return $locale;
    }
}