MonthName
in package
implements
ParsableTokenRule
Formats and parses localized month-name token values.
Table of Contents
Interfaces
- ParsableTokenRule
- Defines parsing behavior for a date-pattern token.
Methods
- __construct() : mixed
- Creates a month-name token rule.
- captureRegex() : string
- Returns the regular-expression fragment for capturing this token.
- format() : string
- Formats the month name.
- parse() : int
- Parses the month name.
- property() : string
- Returns the semantic calendar-date property represented by this rule.
Methods
__construct()
Creates a month-name token rule.
public
__construct(bool $abbreviated) : mixed
Parameters
- $abbreviated : bool
-
Whether abbreviated names are used.
captureRegex()
Returns the regular-expression fragment for capturing this token.
public
captureRegex() : string
Return values
string —Capturing regular-expression fragment.
format()
Formats the month name.
public
format(CalendarDate $date, Locale $locale) : string
Parameters
- $date : CalendarDate
-
Date providing the month.
- $locale : Locale
-
Locale definition.
Return values
string —Localized month name.
parse()
Parses the month name.
public
parse(string $value, Calendar $calendar, Locale $locale) : int
Parameters
- $value : string
-
Captured input value.
- $calendar : Calendar
-
Calendar associated with the token scope.
- $locale : Locale
-
Locale definition.
Tags
Return values
int —Parsed month.
property()
Returns the semantic calendar-date property represented by this rule.
public
property() : string
Return values
string —Calendar-date property name.