Класс Locale

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

Введение

Locale — идентификатор, через который из API получают информацию о языке, культуре или региональном поведении. Локали PHP организованы и обозначены так же, как и локали проекта CLDR, которыми пользуется проект ICU и многие производители систем Unix, Linux и Mac, Java и т. д. Локали обозначаются согласно языковым меткам стандарта RFC 4646 (который использует тире, а не подчёркивание) в дополнение к традиционным обозначением с символом подчёркивания. Функции класса понимают оба написания, если явно не указали иное.

Примеры идентификаторов:

en-US (Английский, США)
zh-Hant-TW (Китайский, Традиционное начертание, Тайвань)
fr-CA, fr-FR (Французский для Канады и Франции)

Класс Locale (и соответствующие процедурные функции) используется для взаимодействия с идентификаторами локалей, для проверки правильного составления идентификатора, его корректности и т. д. Модули используются CLDR в UAX #35 (и наследуется ICU), являются корректными и используются везде они были бы в ICU.

Данный класс нельзя инстанциировать как объект. Все методы/функции объявлены статическими.

null или пустая строка будут считаться за «базовую» локаль. «Базовая» локаль — «en_US_POSIX» в проекте CLDR. Языковые метки (и идентификаторы локали) регистронезависимы. В классе присутствует метод, который преобразует их к каноничному виду.

Обзор класса

class Locale {

/* Константы */

public const int ACTUAL_LOCALE;

public const int VALID_LOCALE;

public const null DEFAULT_LOCALE = null;

public const string LANG_TAG;

public const string EXTLANG_TAG;

public const string SCRIPT_TAG;

public const string REGION_TAG;

public const string VARIANT_TAG;

public const string GRANDFATHERED_LANG_TAG;

public const string PRIVATE_TAG;

/* Методы */

public static function acceptFromHttp(string $header): string|false

public static function canonicalize(string $locale): ?string

public static function composeLocale(array $subtags): string|false

public static function filterMatches(string $languageTag, string $locale, bool $canonicalize = false): ?bool

public static function getAllVariants(string $locale): ?array

public static function getDefault(): string

public static function getDisplayLanguage(string $locale, ?string $displayLocale = null): string|false

public static function getDisplayName(string $locale, ?string $displayLocale = null): string|false

public static function getDisplayRegion(string $locale, ?string $displayLocale = null): string|false

public static function getDisplayScript(string $locale, ?string $displayLocale = null): string|false

public static function getDisplayVariant(string $locale, ?string $displayLocale = null): string|false

public static function getKeywords(string $locale): array|false|null

public static function getPrimaryLanguage(string $locale): ?string

public static function getRegion(string $locale): ?string

public static function getScript(string $locale): ?string

public static function isRightToLeft( string $locale = "" ): bool

public static function lookup(
    array $languageTag,
    string $locale,
    bool $canonicalize = false,
    ?string $defaultLocale = null
): ?string

public static function parseLocale(string $locale): ?array

public static function setDefault(string $locale): true

}

Предопределённые константы

Locale::DEFAULT_LOCALE null: Используется в качестве параметра, задающего локаль в функциях где это необходимо, таких как NumberFormatter. Эта константа вынуждает использовать локаль по умолчанию.

Эти константы описывают выбор локали для метода getLocale различных классов.

Locale::ACTUAL_LOCALE int: Описывает текущую локаль.
Locale::VALID_LOCALE int: Это самая специфичная локаль, поддерживаемая ICU.

Подтеги локали

Эти константы определяют, как анализируются или составляются локали. Их следует задавать как ключи массива аргументов для функции locale_compose() и возвращать как ключи возвращаемого ассоциативного массива (array) функции locale_parse().

Locale::LANG_TAG int: Подтег языка
Locale::EXTLANG_TAG int: Расширенный подтег языка
Locale::SCRIPT_TAG int: Подтег начертания
Locale::REGION_TAG int: Подтег региона
Locale::VARIANT_TAG int: Подтег варианта
Locale::GRANDFATHERED_LANG_TAG int: Подтег языка в старом синтаксисе (grandfathered)
Locale::PRIVATE_TAG int: Частный подтег

Смотрите также

Список изменений

Версия	Описание
8.4.0	Константы класса стали типизированными.

Содержание

Locale::acceptFromHttp — Попытаться определить наилучшую локаль основываясь на заголовке HTTP "Accept-Language"
Locale::canonicalize — Канонизировать строку локали
Locale::composeLocale — Возвращает правильно упорядоченный и разделенный идентификатор локали
Locale::filterMatches — Проверить, соответствует ли тег фильтра языка локали
Locale::getAllVariants — Получение вариантов из переданной локали
Locale::getDefault — Получение значения локали INTL по умолчанию из опции 'default_locale'
Locale::getDisplayLanguage — Возвращает соответствующим образом локализованное имя языка для заданной локали
Locale::getDisplayName — Возвращает соответствующим образом локализованное имя локали
Locale::getDisplayRegion — Возвращает соответствующим образом локализованное название региона для заданной локали
Locale::getDisplayScript — Возвращает соответствующим образом локализованное название алфавита для заданной локали
Locale::getDisplayVariant — Возвращает соответствующим образом локализованное название варианта для заданной локали
Locale::getKeywords — Получить ключевые слова для локали
Locale::getPrimaryLanguage — Получить первичный язык для локали
Locale::getRegion — Получить регион для локали
Locale::getScript — Получить алфавит для локали
Locale::isRightToLeft — Проверяет, характерно ли для языка направление письма справа налево
Locale::lookup — Поиск языковых меток наиболее подходящих заданной локали
Locale::parseLocale — Получить ассоциативный массив всех подтегов локали
Locale::setDefault — Устанавливает локаль по умолчанию во время исполнения

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы