Locale
in package
Represents a regional locale and its localization services.
A locale controls localized era names, month names, weekday names, seasons, number words, numeral parsing, text direction, and the first day of the week.
Tags
Table of Contents
Properties
- $languageTag : string
- Locale language tag containing a language and optional region.
Methods
- abbreviatedDayOfWeekFromName() : DayOfWeek|null
- Parses a localized abbreviated day-of-week name.
- abbreviatedDayOfWeekName() : string
- Formats an abbreviated day-of-week name.
- abbreviatedEraFromName() : Calendar|null
- Parses a localized abbreviated era display name.
- abbreviatedEraName() : string
- Formats an abbreviated era display name.
- abbreviatedMonthFromName() : int|null
- Parses a localized abbreviated month name.
- abbreviatedMonthName() : string
- Formats an abbreviated month name.
- customizeFor() : LocaleBuilder
- Creates a locale builder for another language tag using this locale's behavior.
- dayOfWeekFromName() : DayOfWeek|null
- Parses a localized day-of-week name.
- dayOfWeekName() : string
- Formats a day-of-week name.
- eraFromName() : Calendar|null
- Parses a localized era display name.
- eraName() : string
- Formats an era display name.
- isRightToLeft() : bool
- Returns whether formatted output uses right-to-left text direction.
- languageTag() : string
- Returns the locale language tag.
- localize() : string
- Returns application-specific localized text for a custom key.
- monthFromName() : int|null
- Parses a localized month name.
- monthName() : string
- Formats a month name.
- numberLocalizer() : NumberLocalizer
- Returns the number localizer used by this locale.
- seasonFromName() : Season|null
- Parses a localized season name.
- seasonName() : string
- Formats a season name.
- textNormalizer() : TextNormalizer
- Returns the text normalizer used by this locale.
- __construct() : mixed
- Creates a locale definition.
Properties
$languageTag read-only
Locale language tag containing a language and optional region.
protected
string
$languageTag
Methods
abbreviatedDayOfWeekFromName()
Parses a localized abbreviated day-of-week name.
public
abbreviatedDayOfWeekFromName(string $name) : DayOfWeek|null
Parameters
- $name : string
-
Localized abbreviated day-of-week name.
Tags
Return values
DayOfWeek|null —Matching day of week, or null when unrecognized.
abbreviatedDayOfWeekName()
Formats an abbreviated day-of-week name.
public
abbreviatedDayOfWeekName(DayOfWeek $dayOfWeek) : string
Parameters
- $dayOfWeek : DayOfWeek
-
Day of week.
Tags
Return values
string —Localized abbreviated day-of-week name, or the full name when abbreviations are unsupported.
abbreviatedEraFromName()
Parses a localized abbreviated era display name.
public
abbreviatedEraFromName(string $name) : Calendar|null
Parameters
- $name : string
-
Localized abbreviated era name.
Tags
Return values
Calendar|null —Matching calendar, or null when unrecognized.
abbreviatedEraName()
Formats an abbreviated era display name.
public
abbreviatedEraName(Calendar $calendar) : string
Parameters
- $calendar : Calendar
-
Calendar identifier.
Tags
Return values
string —Localized abbreviated era name, or the full era name when abbreviations are unsupported.
abbreviatedMonthFromName()
Parses a localized abbreviated month name.
public
abbreviatedMonthFromName(Calendar $calendar, string $name) : int|null
Parameters
- $calendar : Calendar
-
Calendar identifier.
- $name : string
-
Localized abbreviated month name.
Tags
Return values
int|null —Matching month number, or null when unrecognized.
abbreviatedMonthName()
Formats an abbreviated month name.
public
abbreviatedMonthName(Calendar $calendar, int $month) : string
Parameters
- $calendar : Calendar
-
Calendar identifier.
- $month : int
-
Month number.
Tags
Return values
string —Localized abbreviated month name, or the full month name when abbreviations are unsupported.
customizeFor()
Creates a locale builder for another language tag using this locale's behavior.
public
customizeFor(string $languageTag) : LocaleBuilder
The custom locale inherits all behavior from this locale unless the builder overrides a specific value.
Parameters
- $languageTag : string
-
Language tag for the customized locale.
Tags
Return values
LocaleBuilder —Locale builder initialized from this locale.
dayOfWeekFromName()
Parses a localized day-of-week name.
public
abstract dayOfWeekFromName(string $name) : DayOfWeek|null
Parameters
- $name : string
-
Localized day-of-week name.
Tags
Return values
DayOfWeek|null —Matching day of week, or null when unrecognized.
dayOfWeekName()
Formats a day-of-week name.
public
abstract dayOfWeekName(DayOfWeek $dayOfWeek) : string
Parameters
- $dayOfWeek : DayOfWeek
-
Day of week.
Tags
Return values
string —Localized day-of-week name.
eraFromName()
Parses a localized era display name.
public
abstract eraFromName(string $name) : Calendar|null
Parameters
- $name : string
-
Localized era name.
Tags
Return values
Calendar|null —Matching calendar, or null when unrecognized.
eraName()
Formats an era display name.
public
abstract eraName(Calendar $calendar) : string
Parameters
- $calendar : Calendar
-
Calendar identifier.
Tags
Return values
string —Localized era name.
isRightToLeft()
Returns whether formatted output uses right-to-left text direction.
public
abstract isRightToLeft() : bool
Return values
bool —True for right-to-left output; false for left-to-right output.
languageTag()
Returns the locale language tag.
public
languageTag() : string
Return values
string —Locale language tag.
localize()
Returns application-specific localized text for a custom key.
public
localize(string $key) : string
Parameters
- $key : string
-
Custom localization key.
Return values
string —Localized text, or the key when no localization is defined.
monthFromName()
Parses a localized month name.
public
abstract monthFromName(Calendar $calendar, string $name) : int|null
Parameters
- $calendar : Calendar
-
Calendar identifier.
- $name : string
-
Localized month name.
Tags
Return values
int|null —Matching month number, or null when unrecognized.
monthName()
Formats a month name.
public
abstract monthName(Calendar $calendar, int $month) : string
Parameters
- $calendar : Calendar
-
Calendar identifier.
- $month : int
-
Month number.
Tags
Return values
string —Localized month name.
numberLocalizer()
Returns the number localizer used by this locale.
public
abstract numberLocalizer() : NumberLocalizer
Return values
NumberLocalizer —Locale number localizer.
seasonFromName()
Parses a localized season name.
public
abstract seasonFromName(string $name) : Season|null
Parameters
- $name : string
-
Localized season name.
Tags
Return values
Season|null —Matching season, or null when unrecognized.
seasonName()
Formats a season name.
public
abstract seasonName(Season $season) : string
Parameters
- $season : Season
-
Season.
Tags
Return values
string —Localized season name.
textNormalizer()
Returns the text normalizer used by this locale.
public
abstract textNormalizer() : TextNormalizer
Return values
TextNormalizer —Locale text normalizer.
__construct()
Creates a locale definition.
protected
__construct(string $languageTag) : mixed
Parameters
- $languageTag : string
-
Locale language tag containing a language and optional region.