engelsystem/src/Helpers/Translator.php

<?php

namespace Engelsystem\Helpers;

class Translator
{
    /** @var string[] */
    protected $locales;

    /** @var string */
    protected $locale;

    /** @var callable */
    protected $localeChangeCallback;

    /**
     * Translator constructor.
     *
     * @param string   $locale
     * @param string[] $locales
     * @param callable $localeChangeCallback
     */
    public function __construct(string $locale, array $locales = [], callable $localeChangeCallback = null)
    {
        $this->localeChangeCallback = $localeChangeCallback;

        $this->setLocale($locale);
        $this->setLocales($locales);
    }

    /**
     * Get the translation for a given key
     *
     * @param string $key
     * @param array  $replace
     * @return string
     */
    public function translate(string $key, array $replace = []): string
    {
        $translated = $this->translateGettext($key);

        return $this->replaceText($translated, $replace);
    }

    /**
     * Get the translation for a given key
     *
     * @param string $key
     * @param string $pluralKey
     * @param int    $number
     * @param array  $replace
     * @return string
     */
    public function translatePlural(string $key, string $pluralKey, int $number, array $replace = []): string
    {
        $translated = $this->translateGettextPlural($key, $pluralKey, $number);

        return $this->replaceText($translated, $replace);
    }

    /**
     * Replace placeholders
     *
     * @param string $key
     * @param array  $replace
     * @return mixed|string
     */
    protected function replaceText(string $key, array $replace = [])
    {
        if (empty($replace)) {
            return $key;
        }

        return call_user_func_array('sprintf', array_merge([$key], $replace));
    }

    /**
     * Translate the key via gettext
     *
     * @param string $key
     * @return string
     * @codeCoverageIgnore
     */
    protected function translateGettext(string $key): string
    {
        return gettext($key);
    }

    /**
     * Translate the key via gettext
     *
     * @param string $key
     * @param string $keyPlural
     * @param int    $number
     * @return string
     * @codeCoverageIgnore
     */
    protected function translateGettextPlural(string $key, string $keyPlural, int $number): string
    {
        return ngettext($key, $keyPlural, $number);
    }

    /**
     * @return string
     */
    public function getLocale(): string
    {
        return $this->locale;
    }

    /**
     * @param string $locale
     */
    public function setLocale(string $locale)
    {
        $this->locale = $locale;

        if (is_callable($this->localeChangeCallback)) {
            call_user_func_array($this->localeChangeCallback, [$locale]);
        }
    }

    /**
     * @return string[]
     */
    public function getLocales(): array
    {
        return $this->locales;
    }

    /**
     * @param string $locale
     * @return bool
     */
    public function hasLocale(string $locale): bool
    {
        return isset($this->locales[$locale]);
    }

    /**
     * @param string[] $locales
     */
    public function setLocales(array $locales)
    {
        $this->locales = $locales;
    }
}