ParsableTokenRule
extends
TokenRule
in
Defines parsing behavior for a date-pattern token.
Tags
Table of Contents
Methods
- captureRegex() : string
- Returns the regular-expression fragment for capturing this token.
- format() : string
- Formats the token for a date.
- parse() : int
- Parses a captured value.
- property() : string
- Returns the semantic calendar-date property represented by this rule.
Methods
captureRegex()
Returns the regular-expression fragment for capturing this token.
public
captureRegex() : string
Return values
string —Capturing regular-expression fragment.
format()
Formats the token for a date.
public
format(CalendarDate $date, Locale $locale) : string
Parameters
- $date : CalendarDate
-
Date providing the token value.
- $locale : Locale
-
Locale definition.
Tags
Return values
string —Formatted token value.
parse()
Parses a captured value.
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 semantic value.
property()
Returns the semantic calendar-date property represented by this rule.
public
property() : string
Return values
string —Calendar-date property name.