SiteLocaleSelector.php

<?php

namespace Concrete\Core\Form\Service\Widget;

use Concrete\Core\Entity\Site\Locale;
use Concrete\Core\Entity\Site\Site;
use Concrete\Core\Multilingual\Service\UserInterface\Flag;
use Concrete\Core\Utility\Service\Identifier;

class SiteLocaleSelector
{
    /**
     * Creates form fields and JavaScript page chooser for choosing a locale.
     *
     * @param string $fieldName
     * @param \Concrete\Core\Entity\Site\Site $site
     * @param \Concrete\Core\Entity\Site\Locale|null $selectedLocale
     * @param array $options Supported options are:
     *                       bool $allowNull Set to a non falsy value to allow users to choose "no" locale [default: false]
     *                       string $noLocaleText The string to represent "no locale" [default: t('No Locale')]
     *                       bool|string $displayLocaleCode Set to 'auto' to automatically determine it; set to a non falsy value to display the locale ID [default: 'auto']
     *
     * @return string
     */
    public function selectLocale($fieldName, Site $site, ?Locale $selectedLocale = null, array $options = [])
    {
        $siteLocales = json_encode($site->getLocales()->toArray());
        $selectedLocaleString = '';
        if ($selectedLocale) {
            $selectedLocaleString = ":selected-locale='{$selectedLocale->getLocaleID()}'";
        }
        return <<<EOL
        <div class="mb-3" data-vue="cms">
            <concrete-locale-select 
                :locales='{$siteLocales}'
                name="{$fieldName}"
                {$selectedLocaleString}
                >
            </concrete-locale-select>
        </div>
EOL;
    }

    /**
     * Creates form fields and JavaScript page chooser for choosing a locale.
     *
     * @param string $fieldName
     * @param \Concrete\Core\Entity\Site\Site $site
     * @param \Concrete\Core\Entity\Site\Locale[]|string[]|int[] $selectedLocales
     * @param array $options Supported options are:
     *                       string $noLocaleText The string to represent "no locale" [default: t('No Locale')]
     *                       bool|string $displayLocaleCode Set to 'auto' to automatically determine it; set to a non falsy value to display the locale ID [default: 'auto']
     *
     * @return string
     */
    public function selectLocaleMultiple($fieldName, Site $site, array $selectedLocales = [], array $options = [])
    {
        $siteLocales = $site->getLocales()->toArray();
        $displayLocaleCode = $this->shouldDisplayLocaleCode($options, $siteLocales);

        $actuallySelectedLocales = [];
        foreach ($selectedLocales as $selectedLocale) {
            $localeID = null;
            $localeCode = null;
            if ($selectedLocale instanceof Locale) {
                $localeID = $selectedLocale->getLocaleID();
            } elseif (is_numeric($selectedLocale)) {
                $localeID = (int) $selectedLocale;
            } else {
                $localeCode = (string) $localeCode;
            }
            foreach ($siteLocales as $siteLocale) {
                if ($localeID === $siteLocale->getLocaleID() || $localeCode === $siteLocale->getLocale()) {
                    $actuallySelectedLocales[] = $siteLocale;
                }
            }
        }
        $htmlOptions = '';
        foreach ($siteLocales as $siteLocale) {
            $optionContent = '<div>' . (string) Flag::getLocaleFlagIcon($siteLocale) . ' ' . htmlspecialchars($siteLocale->getLanguageText());
            if ($displayLocaleCode) {
                $optionContent .= ' <span class="text-muted small">' + htmlspecialchars($siteLocale->getLocale()) + '</span>';
            }
            $optionContent .= '</div>';

            $optionContent = str_replace('"', "'", $optionContent);
            $htmlOptions .= '<option';
            $htmlOptions .= ' data-content="' . $optionContent . '"';

            $searchToken = $displayLocaleCode ? htmlspecialchars($siteLocale->getLanguageText()) . ' ' . htmlspecialchars($siteLocale->getLocale()) : htmlspecialchars($siteLocale->getLanguageText());
            $htmlOptions .= ' data-tokens="' . $searchToken . '"';

            $htmlOptions .= ' value="' . $siteLocale->getLocaleID() . '"';
            if (in_array($siteLocale, $actuallySelectedLocales, true)) {
                $htmlOptions .= ' selected="selected"';
            }
            $htmlOptions .= '>' . h($siteLocale->getLanguageText()) . '</option>';
        }

        $fieldNameHtml = h($fieldName . (substr($fieldName, -2) === '[]' ? '' : '[]'));

        $identifier = 'ccm-sitelocaleselector-' . trim(preg_replace('/\W+/', '_', $fieldName), '_') . '-' . (new Identifier())->getString(32);
        $identifierHtml = h($identifier);
        $identifierJS = json_encode($identifier);

        return <<<EOL

<select id="{$identifierHtml}" name="{$fieldNameHtml}" multiple="multiple" class="form-select ccm-sitelocaleselector">
    {$htmlOptions}
</select>

EOL;
    }

    /**
     * @param array $options
     * @param \Concrete\Core\Entity\Site\Locale[] $locales
     *
     * @return bool
     */
    private function shouldDisplayLocaleCode(array $options, array $locales)
    {
        if (isset($options['displayLocaleCode']) && $options['displayLocaleCode'] !== 'auto') {
            return $options['displayLocaleCode'] ? true : false;
        }

        $names = array_map(
            function (Locale $locale) {
                return $locale->getLanguageText();
            },
            $locales
        );

        return count($names) > count(array_unique($names));
    }
}