PHP Class Neos\Flow\I18n\Cldr\Reader\DatesReader

This is not full implementation of features from CLDR. These are missing: - support for other calendars than Gregorian - some data from "dates" tag is not used (fields, timeZoneNames)
See also: http://www.unicode.org/reports/tr35/#Date_Elements
See also: http://www.unicode.org/reports/tr35/#Date_Format_Patterns
Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$cache Neos\Cache\Frontend\VariableFrontend
$cldrRepository Neos\Flow\I18n\Cldr\CldrRepository
$localizedLiterals array Locale tags are keys for this array. Values are arrays of literals, i.e. names defined in months, days, quarters etc tags.
$maxLengthOfSubformats array For example, era (G) can be defined in three formats, abbreviated (G, GG, GGG), wide (GGGG), or narrow (GGGGG), so maximal length is set to 5. When length is set to zero, it means that corresponding format has no maximal length.
$parsedFormats array Example of data stored in this array: 'HH:mm:ss zzz' => array( 'HH', array(':'), 'mm', array(':'), 'ss', array(' '), 'zzz', ); Please note that subformats are stored as array elements, and literals are stored as one-element arrays in the same array. Order of elements in array is important.
$parsedFormatsIndices array As for one locale there can be defined many formats (at most 2 format types supported by this class - date, time - multiplied by at most 4 format lengths - full, long, medium, short), references are organized in arrays. Example of data stored in this array: 'pl' => array( 'date' => array( 'full' => 'EEEE, d MMMM y', ... ), ... );

Public Methods

Method Description
getLocalizedLiteralsForLocale ( Locale $locale ) : array Returns literals array for locale provided.
initializeObject ( ) : void Constructs the reader, loading parsed data from cache if available.
injectCache ( Neos\Cache\Frontend\VariableFrontend $cache ) : void Injects the Flow_I18n_Cldr_Reader_DatesReader cache
injectCldrRepository ( CldrRepository $repository ) : void
parseCustomFormat ( string $format ) : array Returns parsed date or time format string provided as parameter.
parseFormatFromCldr ( Locale $locale, string $formatType, string $formatLength ) : array Returns parsed date or time format basing on locale and desired format length.
shutdownObject ( ) : void Shutdowns the object, saving parsed format strings to the cache.
validateFormatLength ( string $formatLength ) : void Validates provided format length and throws exception if value is not allowed.
validateFormatType ( string $formatType ) : void Validates provided format type and throws exception if value is not allowed.

Protected Methods

Method Description
parseFormat ( string $format ) : array Parses a date / time format (with syntax defined in CLDR).
parseLocalizedEras ( CldrModel $model ) : array Parses "eras" child of "dates" node and returns it's array representation.
parseLocalizedLiterals ( CldrModel $model, string $literalType ) : array Parses one CLDR child of "dates" node and returns it's array representation.
prepareDateAndTimeFormat ( string $format, Locale $locale, string $formatLength ) : array Creates one parsed datetime format from date and time formats merged together.

Method Details

getLocalizedLiteralsForLocale() public method

If array was not generated earlier, it will be generated and cached.
public getLocalizedLiteralsForLocale ( Locale $locale ) : array
$locale Neos\Flow\I18n\Locale
return array An array with localized literals

initializeObject() public method

Constructs the reader, loading parsed data from cache if available.
public initializeObject ( ) : void
return void

injectCache() public method

Injects the Flow_I18n_Cldr_Reader_DatesReader cache
public injectCache ( Neos\Cache\Frontend\VariableFrontend $cache ) : void
$cache Neos\Cache\Frontend\VariableFrontend
return void

injectCldrRepository() public method

public injectCldrRepository ( CldrRepository $repository ) : void
$repository Neos\Flow\I18n\Cldr\CldrRepository
return void

parseCustomFormat() public method

Returns parsed date or time format string provided as parameter.
public parseCustomFormat ( string $format ) : array
$format string Format string to parse
return array An array representing parsed format

parseFormat() protected method

Not all features from CLDR specification are implemented. Please see the documentation for this class for details what is missing.
See also: DatesReader::$parsedFormats
protected parseFormat ( string $format ) : array
$format string
return array Parsed format

parseFormatFromCldr() public method

When third parameter ($formatLength) equals 'default', default format for a locale will be used.
public parseFormatFromCldr ( Locale $locale, string $formatType, string $formatLength ) : array
$locale Neos\Flow\I18n\Locale
$formatType string A type of format (one of constant values)
$formatLength string A length of format (one of constant values)
return array An array representing parsed format

parseLocalizedEras() protected method

Parses "eras" child of "dates" node and returns it's array representation.
protected parseLocalizedEras ( CldrModel $model ) : array
$model Neos\Flow\I18n\Cldr\CldrModel CldrModel to read data from
return array An array with localized literals for "eras" node

parseLocalizedLiterals() protected method

Many children of "dates" node have common structure, so one method can be used to parse them all.
protected parseLocalizedLiterals ( CldrModel $model, string $literalType ) : array
$model Neos\Flow\I18n\Cldr\CldrModel CldrModel to read data from
$literalType string One of: month, day, quarter, dayPeriod
return array An array with localized literals for given type

prepareDateAndTimeFormat() protected method

The dateTime format from CLDR looks like "{0} {1}" and denotes where to place time and date, and what literals should be placed before, between and / or after them.
protected prepareDateAndTimeFormat ( string $format, Locale $locale, string $formatLength ) : array
$format string DateTime format
$locale Neos\Flow\I18n\Locale Locale to use
$formatLength string A length of format (full, long, medium, short) or 'default' to use default one from CLDR
return array Merged formats of date and time

shutdownObject() public method

Shutdowns the object, saving parsed format strings to the cache.
public shutdownObject ( ) : void
return void

validateFormatLength() public static method

Validates provided format length and throws exception if value is not allowed.
public static validateFormatLength ( string $formatLength ) : void
$formatLength string
return void

validateFormatType() public static method

Validates provided format type and throws exception if value is not allowed.
public static validateFormatType ( string $formatType ) : void
$formatType string
return void

Property Details

$cache protected_oe property

protected VariableFrontend,Neos\Cache\Frontend $cache
return Neos\Cache\Frontend\VariableFrontend

$cldrRepository protected_oe property

protected CldrRepository,Neos\Flow\I18n\Cldr $cldrRepository
return Neos\Flow\I18n\Cldr\CldrRepository

$localizedLiterals protected_oe property

Locale tags are keys for this array. Values are arrays of literals, i.e. names defined in months, days, quarters etc tags.
protected array $localizedLiterals
return array

$maxLengthOfSubformats protected_oe static_oe property

For example, era (G) can be defined in three formats, abbreviated (G, GG, GGG), wide (GGGG), or narrow (GGGGG), so maximal length is set to 5. When length is set to zero, it means that corresponding format has no maximal length.
protected static array $maxLengthOfSubformats
return array

$parsedFormats protected_oe property

Example of data stored in this array: 'HH:mm:ss zzz' => array( 'HH', array(':'), 'mm', array(':'), 'ss', array(' '), 'zzz', ); Please note that subformats are stored as array elements, and literals are stored as one-element arrays in the same array. Order of elements in array is important.
protected array $parsedFormats
return array

$parsedFormatsIndices protected_oe property

As for one locale there can be defined many formats (at most 2 format types supported by this class - date, time - multiplied by at most 4 format lengths - full, long, medium, short), references are organized in arrays. Example of data stored in this array: 'pl' => array( 'date' => array( 'full' => 'EEEE, d MMMM y', ... ), ... );
protected array $parsedFormatsIndices
return array