LangListService.php

<?php

namespace LangImportExport;

use Illuminate\Support\Arr;
use Lang;
use File;

class LangListService
{

    protected $dotFiles = ['routes'];

    /**
     * Load localization file or files for specified locale.
     *
     * @param string $locale
     * @param string $group
     * @param string $excludeGroups
     * @return array
     */
    public function loadLangList($locale, $group, $excludeGroups = '')
    {
        $exclude = explode(',', $excludeGroups);
        $result = [];
        if ($this->isGroupList($group)) {
            $groups = explode(',', $group);
        } else {
            $path = lang_path($locale . '/');
            $files = $this->getAllFiles($path);
            $groups = [];
            foreach ($files as $file) {
                $groups[] = substr($file->getRealPath(), strlen($path), -4);
            }
        }
        foreach ($groups as $group) {
            if (!in_array($group, $exclude)) {
                $result[$group] = $this->getGroup($locale, $group);
            }
        }
        return $result;
    }

    /**
     * Check if $group is one file only.
     *
     * @param string $group
     * @return bool
     */
    private function isGroupList($group)
    {
        return $group != '*' && $group != '';
    }

    /**
     * Fetch localization from file.
     *
     * @param string $locale
     * @param string $group
     * @return array
     */
    private function getGroup($locale, $group)
    {
        $translations = Lang::getLoader()->load($locale, $group);
        return Arr::dot($translations);
    }

    /**
     * Get list of all files from $path.
     *
     * @param string $path
     * @return array
     */
    private function getAllFiles($path)
    {
        return File::allFiles($path);
    }

    /**
     * Write translated content to localization file or files.
     *
     * @param string $locale
     * @param string $group
     * @param array $new_translations
     * @return void
     */
    public function writeLangList($locale, $group, $new_translations)
    {
        if ($this->isGroupList($group)) {
            $groups = explode(',', $group);
            $new_translations = array_intersect_key($new_translations, array_flip($groups));
        }

        foreach ($new_translations as $group => $translations) {
            $this->writeLangFile($locale, $group, $translations);
        }
    }

    /**
     * Write translated content to one file.
     *
     * @param string $locale
     * @param string $group
     * @param array $new_translations
     * @return void
     * @throws \Exception
     */
    private function writeLangFile($locale, $group, $new_translations)
    {
        $translations = $this->getTranslations($locale, $group, $new_translations);

        $header = "<?php\n\nreturn ";

        $language_file = lang_path("{$locale}/{$group}.php");

        if (!file_exists(dirname($language_file))) {
            mkdir(dirname($language_file), 0777, true);
        }

        if (($fp = fopen($language_file, 'w')) !== false && is_writable($language_file)) {
            fputs($fp, $header . var_export($translations, true) . ";\n");
            fclose($fp);
        } else {
            throw new \Exception("Cannot open language file at {$language_file} for writing. Check the file permissions.");
        }
    }

    /**
     * Fetch existing translations and merge with new ones.
     *
     * @param string $locale
     * @param string $group
     * @param array $new_translations
     * @return array
     */
    private function getTranslations($locale, $group, $new_translations)
    {
        $translations = Lang::getLoader()->load($locale, $group);
        foreach ($new_translations as $key => $value) {
            Arr::set($translations, $key, $value);
        }

        if (in_array($group, $this->dotFiles)) {
            $translations = Arr::dot($translations);
        }

        return $translations;
    }

    public function validatePlaceholders($targetTranslations, $baseTranslations)
    {
        foreach ($targetTranslations as $group => $translations) {
            foreach ($translations as $key => $translation) {
                if (isset($baseTranslations[$group][$key]) && is_string($baseTranslations[$group][$key])) {
                    $baseTranslation = $baseTranslations[$group][$key];
                    $placeholders = $this->matchPlaceholders($baseTranslation);
                    foreach ($placeholders as $placeholder) {
                        if (strpos($translation, $placeholder) === false) {
                            yield compact('group', 'key', 'placeholder', 'translation', 'baseTranslation');
                        }
                    }
                }
            }
        }
    }

    public function validateHTML($targetTranslations, $baseTranslations)
    {
        foreach ($targetTranslations as $group => $translations) {
            foreach ($translations as $key => $translation) {
                if (isset($baseTranslations[$group][$key]) && is_string($baseTranslations[$group][$key])) {
                    $baseTranslation = $baseTranslations[$group][$key];
                    preg_match_all('~(</?[a-z]+[^>]*?>)~i', $baseTranslation, $m);
                    $tags = $m[1];
                    foreach ($tags as $tag) {
                        if (strpos($translation, $tag) === false) {
                            yield compact('group', 'key', 'translation', 'baseTranslation', 'tag');
                        }
                    }
                }
            }
        }
    }

    private function matchPlaceholders($translation)
    {
        preg_match_all('~(:[a-zA-Z0-9_]+)~', $translation, $m);
        return $m[1] ?? [];
    }
}