TokenRegistry
in package
Stores date-pattern token rules by symbol.
The registry provides these default tokens:
Y: year number, signed, minimum width 4.V: year number words.y: two-digit year.n: month number.m: month number, minimum width 2.F: name of month.M: abbreviated name of month.j: day of month.d: day of month, minimum width 2.J: day of month ordinal.l: name of day of week.D: abbreviated name of day of week.k: day of week occurrence in month.K: day of week occurrence in year.R: day of year ordinal.q: quarter ordinal.Q: season name.C: era name.E: abbreviated era name.
Tags
Table of Contents
Methods
- __construct() : mixed
- Creates a token registry.
- find() : TokenRule|null
- Returns the rule registered for a symbol.
- register() : self
- Registers a token rule.
- remove() : self
- Removes a token rule.
- replace() : self
- Replaces a token rule.
- revision() : int
- Returns the current registry revision.
- rules() : array<string, TokenRule>
- Returns the registered token rules.
- shared() : self
- Returns the shared token registry.
Methods
__construct()
Creates a token registry.
public
__construct([array<string, TokenRule>|null $rules = null ]) : mixed
Parameters
- $rules : array<string, TokenRule>|null = null
-
Token rules indexed by symbol, or null to use the built-in rules.
Tags
find()
Returns the rule registered for a symbol.
public
find(string $symbol) : TokenRule|null
Parameters
- $symbol : string
-
Pattern symbol.
Tags
Return values
TokenRule|null —Token rule, or null when no token is registered for the symbol.
register()
Registers a token rule.
public
register(string $symbol, TokenRule $rule) : self
Parameters
- $symbol : string
-
Pattern symbol.
- $rule : TokenRule
-
Token rule.
Tags
Return values
self —This registry.
remove()
Removes a token rule.
public
remove(string $symbol) : self
Parameters
- $symbol : string
-
Pattern symbol.
Tags
Return values
self —This registry.
replace()
Replaces a token rule.
public
replace(string $symbol, TokenRule $rule) : self
Parameters
- $symbol : string
-
Pattern symbol.
- $rule : TokenRule
-
Token rule.
Tags
Return values
self —This registry.
revision()
Returns the current registry revision.
public
revision() : int
Return values
int —Registry revision.
rules()
Returns the registered token rules.
public
rules() : array<string, TokenRule>
Return values
array<string, TokenRule> —Token rules indexed by symbol.
shared()
Returns the shared token registry.
public
static shared() : self
Changing the shared registry will affect all date formatting and parsing
operations of classes derived from CalendarDate.
Tags
Return values
self —Shared token registry.