Civil Date PHP Package

Persian extends Locale
in package

Persian calendar localization.

Table of Contents

Constants

LANGUAGE_TAG  : string = 'fa'
Language tag for base Persian localization.

Properties

$languageTag  : string
Locale language tag containing a language and optional region.

Methods

__construct()  : mixed
Creates a Persian locale.
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 Persian abbreviated era name.
abbreviatedEraName()  : string
Formats an abbreviated era name in Persian.
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 Persian day-of-week name.
dayOfWeekName()  : string
Formats a day-of-week name in Persian.
eraFromName()  : Calendar|null
Parses a Persian era name.
eraName()  : string
Formats an era name in Persian.
isRightToLeft()  : bool
Returns whether Persian text is written right to left.
languageTag()  : string
Returns the locale language tag.
localize()  : string
Returns application-specific localized text for a custom key.
monthFromName()  : int|null
Parses a Persian month name.
monthName()  : string
Formats a month name in Persian.
numberLocalizer()  : NumberLocalizer
Returns the Persian number localizer.
seasonFromName()  : Season|null
Parses a Persian season name.
seasonName()  : string
Formats a season name in Persian.
textNormalizer()  : TextNormalizer
Returns the Persian text normalizer.

Constants

LANGUAGE_TAG

Language tag for base Persian localization.

public string LANGUAGE_TAG = 'fa'

Properties

$languageTag read-only

Locale language tag containing a language and optional region.

protected string $languageTag

Methods

__construct()

Creates a Persian locale.

public __construct([string $languageTag = self::LANGUAGE_TAG ]) : mixed
Parameters
$languageTag : string = self::LANGUAGE_TAG

Locale language tag.

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
see
Locale::abbreviatedMonthName()
Locale::monthFromName()
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
see
Locale::abbreviatedMonthFromName()
Locale::monthName()
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
see
LocaleBuilder::build()
CustomLocale
Return values
LocaleBuilder —

Locale builder initialized from this locale.

dayOfWeekFromName()

Parses a Persian day-of-week name.

public dayOfWeekFromName(string $name) : DayOfWeek|null
Parameters
$name : string

Day-of-week name.

Tags
see
Persian::dayOfWeekName()
Return values
DayOfWeek|null —

Matching day of week, or null when unrecognized.

eraFromName()

Parses a Persian era name.

public eraFromName(string $name) : Calendar|null
Parameters
$name : string

Era name.

Tags
see
Persian::eraName()
Return values
Calendar|null —

Matching calendar, or null when unrecognized.

isRightToLeft()

Returns whether Persian text is written right to left.

public isRightToLeft() : bool
Return values
bool —

Always true.

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 Persian month name.

public monthFromName(Calendar $calendar, string $name) : int|null

This method recognizes both Iranian and Afghan month names for a given calendar.

Parameters
$calendar : Calendar

Calendar identifier.

$name : string

Month name.

Tags
see
Persian::monthName()
Return values
int|null —

Matching month number, or null when unrecognized.

monthName()

Formats a month name in Persian.

public monthName(Calendar $calendar, int $month) : string
Parameters
$calendar : Calendar

Calendar identifier.

$month : int

Month number.

Tags
throws
InvalidArgumentException

If the month number is invalid for the calendar.

see
Persian::monthFromName()
Return values
string —

Persian month name.

seasonFromName()

Parses a Persian season name.

public seasonFromName(string $name) : Season|null
Parameters
$name : string

Season name.

Tags
see
Persian::seasonName()
Return values
Season|null —

Matching season, or null when unrecognized.

On this page

Search results