IntlDateFormatter::parseToCalendar

Parse a string into a timestamp, updating an open calendar

Description

public intfloatfalse IntlDateFormatter::parseToCalendar(string $string, int &$offset = null)

Converts string to an incremental time value, starting at offset and consuming as much of the input value as possible.

This method behaves like IntlDateFormatter::parse, except that the time zone of the formatter is updated according to the time zone information contained in the parsed string.

Parameters

string
The string to convert to a time.
offset
Position at which to start the parsing in string (zero-based). If no error occurs before string is consumed, offset will contain -1, otherwise it will contain the position at which parsing ended (and the error occurred). This variable will contain the end position if the parse fails. If offset > strlen($string), the parse fails immediately.

Return Values

Timestamp of parsed value, or false if value cannot be parsed.

Examples

Example #1 IntlDateFormatter::parseToCalendar example

<?php
$fmt = new IntlDateFormatter(
    'en_US',
    IntlDateFormatter::FULL,
    IntlDateFormatter::FULL,
    'America/Los_Angeles',
    IntlDateFormatter::GREGORIAN
);
echo $fmt->parseToCalendar('Wednesday, December 20, 1989 at 4:00:00 PM Pacific Standard Time');
?>

The above example will output:

630201600

See Also

  • IntlDateFormatter::parse
  • IntlDateFormatter::format
  • IntlDateFormatter::getErrorCode
  • IntlDateFormatter::getErrorMessage