Classes List

Symfony\Component\Intl\DateFormatter\IntlDateFormatter

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
 294 
 295 
 296 
 297 
 298 
 299 
 300 
 301 
 302 
 303 
 304 
 305 
 306 
 307 
 308 
 309 
 310 
 311 
 312 
 313 
 314 
 315 
 316 
 317 
 318 
 319 
 320 
 321 
 322 
 323 
 324 
 325 
 326 
 327 
 328 
 329 
 330 
 331 
 332 
 333 
 334 
 335 
 336 
 337 
 338 
 339 
 340 
 341 
 342 
 343 
 344 
 345 
 346 
 347 
 348 
 349 
 350 
 351 
 352 
 353 
 354 
 355 
 356 
 357 
 358 
 359 
 360 
 361 
 362 
 363 
 364 
 365 
 366 
 367 
 368 
 369 
 370 
 371 
 372 
 373 
 374 
 375 
 376 
 377 
 378 
 379 
 380 
 381 
 382 
 383 
 384 
 385 
 386 
 387 
 388 
 389 
 390 
 391 
 392 
 393 
 394 
 395 
 396 
 397 
 398 
 399 
 400 
 401 
 402 
 403 
 404 
 405 
 406 
 407 
 408 
 409 
 410 
 411 
 412 
 413 
 414 
 415 
 416 
 417 
 418 
 419 
 420 
 421 
 422 
 423 
 424 
 425 
 426 
 427 
 428 
 429 
 430 
 431 
 432 
 433 
 434 
 435 
 436 
 437 
 438 
 439 
 440 
 441 
 442 
 443 
 444 
 445 
 446 
 447 
 448 
 449 
 450 
 451 
 452 
 453 
 454 
 455 
 456 
 457 
 458 
 459 
 460 
 461 
 462 
 463 
 464 
 465 
 466 
 467 
 468 
 469 
 470 
 471 
 472 
 473 
 474 
 475 
 476 
 477 
 478 
 479 
 480 
 481 
 482 
 483 
 484 
 485 
 486 
 487 
 488 
 489 
 490 
 491 
 492 
 493 
 494 
 495 
 496 
 497 
 498 
 499 
 500 
 501 
 502 
 503 
 504 
 505 
 506 
 507 
 508 
 509 
 510 
 511 
 512 
 513 
 514 
 515 
 516 
 517 
 518 
 519 
 520 
 521 
 522 
 523 
 524 
 525 
 526 
 527 
 528 
 529 
 530 
 531 
 532 
 533 
 534 
 535 
 536 
 537 
 538 
 539 
 540 
 541 
 542 
 543 
 544 
 545 
 546 
 547 
 548 
 549 
 550 
 551 
 552 
 553 
 554 
 555 
 556 
 557 
 558 
 559 
 560 
 561 
 562 
 563 
 564 
 565 
 566 
 567 
 568 
 569 
 570 
 571 
 572 
 573 
 574 
 575 
 576 
 577 
 578 
 579 
 580 
 581 
 582 
 583 
 584 
 585 
 586 
 587 
 588 
 589 
 590 
 591 
 592 
 593 
 594 
 595 
 596 
 597 
 598 
 599 
 600 
 601 
 602 
 603 
 604 
 605 
 606 
 607 
 608 
 609 
 610 
 611 
 612 
 613 
 614 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Intl\DateFormatter;

use Symfony\Component\Intl\Globals\IntlGlobals;
use Symfony\Component\Intl\DateFormatter\DateFormat\FullTransformer;
use Symfony\Component\Intl\Exception\MethodNotImplementedException;
use Symfony\Component\Intl\Exception\MethodArgumentNotImplementedException;
use Symfony\Component\Intl\Exception\MethodArgumentValueNotImplementedException;
use Symfony\Component\Intl\Locale\Locale;

/** * Replacement for PHP's native {@link \IntlDateFormatter} class. * * The only methods currently supported in this class are: * * - {@link __construct} * - {@link create} * - {@link format} * - {@link getCalendar} * - {@link getDateType} * - {@link getErrorCode} * - {@link getErrorMessage} * - {@link getLocale} * - {@link getPattern} * - {@link getTimeType} * - {@link getTimeZoneId} * - {@link isLenient} * - {@link parse} * - {@link setLenient} * - {@link setPattern} * - {@link setTimeZoneId} * - {@link setTimeZone} * * @author Igor Wiedler <igor@wiedler.ch> * @author Bernhard Schussek <bschussek@gmail.com> * * @internal */
class IntlDateFormatter
{
    /** * The error code from the last operation. * * @var int */
    protected $errorCode = IntlGlobals::U_ZERO_ERROR;

    /** * The error message from the last operation. * * @var string */
    protected $errorMessage = 'U_ZERO_ERROR';

    /* date/time format types */

    const NONE = -1;
    const FULL = 0;
    const LONG = 1;
    const MEDIUM = 2;
    const SHORT = 3;

    /* calendar formats */

    const TRADITIONAL = 0;
    const GREGORIAN = 1;

    /** * Patterns used to format the date when no pattern is provided. */
    private $defaultDateFormats = array(
        self::NONE => '',
        self::FULL => 'EEEE, LLLL d, y',
        self::LONG => 'LLLL d, y',
        self::MEDIUM => 'LLL d, y',
        self::SHORT => 'M/d/yy',
    );

    /** * Patterns used to format the time when no pattern is provided. */
    private $defaultTimeFormats = array(
        self::FULL => 'h:mm:ss a zzzz',
        self::LONG => 'h:mm:ss a z',
        self::MEDIUM => 'h:mm:ss a',
        self::SHORT => 'h:mm a',
    );

    private $datetype;
    private $timetype;

    /** * @var string */
    private $pattern;

    /** * @var \DateTimeZone */
    private $dateTimeZone;

    /** * @var bool */
    private $uninitializedTimeZoneId = false;

    /** * @var string */
    private $timeZoneId;

    /** * @param string $locale The locale code. The only currently supported locale is "en" (or null using the default locale, i.e. "en") * @param int $datetype Type of date formatting, one of the format type constants * @param int $timetype Type of time formatting, one of the format type constants * @param mixed $timezone Timezone identifier * @param int $calendar Calendar to use for formatting or parsing. The only currently * supported value is IntlDateFormatter::GREGORIAN (or null using the default calendar, i.e. "GREGORIAN") * @param string $pattern Optional pattern to use when formatting * * @see http://www.php.net/manual/en/intldateformatter.create.php * @see http://userguide.icu-project.org/formatparse/datetime * * @throws MethodArgumentValueNotImplementedException When $locale different than "en" or null is passed * @throws MethodArgumentValueNotImplementedException When $calendar different than GREGORIAN is passed */
    public function __construct($locale$datetype$timetype$timezone = null$calendar = self::GREGORIAN$pattern = null)
    {
        if ('en' !== $locale && null !== $locale) {
            throw new MethodArgumentValueNotImplementedException(__METHOD__'locale'$locale'Only the locale "en" is supported');
        }

        if (self::GREGORIAN !== $calendar && null !== $calendar) {
            throw new MethodArgumentValueNotImplementedException(__METHOD__'calendar'$calendar'Only the GREGORIAN calendar is supported');
        }

        $this->datetype = $datetype;
        $this->timetype = $timetype;

        $this->setPattern($pattern);
        $this->setTimeZone($timezone);
    }

    /** * Static constructor. * * @param string $locale The locale code. The only currently supported locale is "en" (or null using the default locale, i.e. "en") * @param int $datetype Type of date formatting, one of the format type constants * @param int $timetype Type of time formatting, one of the format type constants * @param string $timezone Timezone identifier * @param int $calendar Calendar to use for formatting or parsing; default is Gregorian * One of the calendar constants * @param string $pattern Optional pattern to use when formatting * * @return self * * @see http://www.php.net/manual/en/intldateformatter.create.php * @see http://userguide.icu-project.org/formatparse/datetime * * @throws MethodArgumentValueNotImplementedException When $locale different than "en" or null is passed * @throws MethodArgumentValueNotImplementedException When $calendar different than GREGORIAN is passed */
    public static function create($locale$datetype$timetype$timezone = null$calendar = self::GREGORIAN$pattern = null)
    {
        return new self($locale$datetype$timetype$timezone$calendar$pattern);
    }

    /** * Format the date/time value (timestamp) as a string. * * @param int|\DateTime $timestamp The timestamp to format * * @return string|bool The formatted value or false if formatting failed * * @see http://www.php.net/manual/en/intldateformatter.format.php * * @throws MethodArgumentValueNotImplementedException If one of the formatting characters is not implemented */
    public function format($timestamp)
    {
        // intl allows timestamps to be passed as arrays - we don't
        if (is_array($timestamp)) {
            $message = 'Only integer Unix timestamps and DateTime objects are supported';

            throw new MethodArgumentValueNotImplementedException(__METHOD__'timestamp'$timestamp$message);
        }

        // behave like the intl extension
        $argumentError = null;
        if (!is_int($timestamp&& !$timestamp instanceof \DateTime) {
            $argumentError = sprintf('datefmt_format: string \'%s\' is not numeric, which would be required for it to be a valid date'$timestamp);
        }

        if (null !== $argumentError) {
            IntlGlobals::setError(IntlGlobals::U_ILLEGAL_ARGUMENT_ERROR$argumentError);
            $this->errorCode = IntlGlobals::getErrorCode();
            $this->errorMessage = IntlGlobals::getErrorMessage();

            return false;
        }

        if ($timestamp instanceof \DateTime) {
            $timestamp = $timestamp->getTimestamp();
        }

        $transformer = new FullTransformer($this->getPattern(), $this->getTimeZoneId());
        $formatted = $transformer->format($this->createDateTime($timestamp));

        // behave like the intl extension
        IntlGlobals::setError(IntlGlobals::U_ZERO_ERROR);
        $this->errorCode = IntlGlobals::getErrorCode();
        $this->errorMessage = IntlGlobals::getErrorMessage();

        return $formatted;
    }

    /** * Not supported. Formats an object. * * @param object $object * @param mixed $format * @param string $locale * * @return string The formatted value * * @see http://www.php.net/manual/en/intldateformatter.formatobject.php * * @throws MethodNotImplementedException */
    public function formatObject($object$format = null$locale = null)
    {
        throw new MethodNotImplementedException(__METHOD__);
    }

    /** * Returns the formatter's calendar. * * @return int The calendar being used by the formatter. Currently always returns * IntlDateFormatter::GREGORIAN. * * @see http://www.php.net/manual/en/intldateformatter.getcalendar.php */
    public function getCalendar()
    {
        return self::GREGORIAN;
    }

    /** * Not supported. Returns the formatter's calendar object. * * @return object The calendar's object being used by the formatter * * @see http://www.php.net/manual/en/intldateformatter.getcalendarobject.php * * @throws MethodNotImplementedException */
    public function getCalendarObject()
    {
        throw new MethodNotImplementedException(__METHOD__);
    }

    /** * Returns the formatter's datetype. * * @return int The current value of the formatter * * @see http://www.php.net/manual/en/intldateformatter.getdatetype.php */
    public function getDateType()
    {
        return $this->datetype;
    }

    /** * Returns formatter's last error code. Always returns the U_ZERO_ERROR class constant value. * * @return int The error code from last formatter call * * @see http://www.php.net/manual/en/intldateformatter.geterrorcode.php */
    public function getErrorCode()
    {
        return $this->errorCode;
    }

    /** * Returns formatter's last error message. Always returns the U_ZERO_ERROR_MESSAGE class constant value. * * @return string The error message from last formatter call * * @see http://www.php.net/manual/en/intldateformatter.geterrormessage.php */
    public function getErrorMessage()
    {
        return $this->errorMessage;
    }

    /** * Returns the formatter's locale. * * @param int $type Not supported. The locale name type to return (Locale::VALID_LOCALE or Locale::ACTUAL_LOCALE) * * @return string The locale used to create the formatter. Currently always * returns "en". * * @see http://www.php.net/manual/en/intldateformatter.getlocale.php */
    public function getLocale($type = Locale::ACTUAL_LOCALE)
    {
        return 'en';
    }

    /** * Returns the formatter's pattern. * * @return string The pattern string used by the formatter * * @see http://www.php.net/manual/en/intldateformatter.getpattern.php */
    public function getPattern()
    {
        return $this->pattern;
    }

    /** * Returns the formatter's time type. * * @return int The time type used by the formatter * * @see http://www.php.net/manual/en/intldateformatter.gettimetype.php */
    public function getTimeType()
    {
        return $this->timetype;
    }

    /** * Returns the formatter's timezone identifier. * * @return string The timezone identifier used by the formatter * * @see http://www.php.net/manual/en/intldateformatter.gettimezoneid.php */
    public function getTimeZoneId()
    {
        if (!$this->uninitializedTimeZoneId) {
            return $this->timeZoneId;
        }

        return date_default_timezone_get();
    }

    /** * Not supported. Returns the formatter's timezone. * * @return mixed The timezone used by the formatter * * @see http://www.php.net/manual/en/intldateformatter.gettimezone.php * * @throws MethodNotImplementedException */
    public function getTimeZone()
    {
        throw new MethodNotImplementedException(__METHOD__);
    }

    /** * Returns whether the formatter is lenient. * * @return bool Currently always returns false * * @see http://www.php.net/manual/en/intldateformatter.islenient.php * * @throws MethodNotImplementedException */
    public function isLenient()
    {
        return false;
    }

    /** * Not supported. Parse string to a field-based time value. * * @param string $value String to convert to a time value * @param int $position Position at which to start the parsing in $value (zero-based) * If no error occurs before $value is consumed, $parse_pos will * contain -1 otherwise it will contain the position at which parsing * ended. If $parse_pos > strlen($value), the parse fails immediately. * * @return string Localtime compatible array of integers: contains 24 hour clock value in tm_hour field * * @see http://www.php.net/manual/en/intldateformatter.localtime.php * * @throws MethodNotImplementedException */
    public function localtime($value, &$position = 0)
    {
        throw new MethodNotImplementedException(__METHOD__);
    }

    /** * Parse string to a timestamp value. * * @param string $value String to convert to a time value * @param int $position Not supported. Position at which to start the parsing in $value (zero-based) * If no error occurs before $value is consumed, $parse_pos will * contain -1 otherwise it will contain the position at which parsing * ended. If $parse_pos > strlen($value), the parse fails immediately. * * @return int Parsed value as a timestamp * * @see http://www.php.net/manual/en/intldateformatter.parse.php * * @throws MethodArgumentNotImplementedException When $position different than null, behavior not implemented */
    public function parse($value, &$position = null)
    {
        // We don't calculate the position when parsing the value
        if (null !== $position) {
            throw new MethodArgumentNotImplementedException(__METHOD__'position');
        }

        $dateTime = $this->createDateTime(0);
        $transformer = new FullTransformer($this->getPattern(), $this->getTimeZoneId());

        $timestamp = $transformer->parse($dateTime$value);

        // behave like the intl extension. FullTransformer::parse() set the proper error
        $this->errorCode = IntlGlobals::getErrorCode();
        $this->errorMessage = IntlGlobals::getErrorMessage();

        return $timestamp;
    }

    /** * Not supported. Set the formatter's calendar. * * @param string $calendar The calendar to use. Default is IntlDateFormatter::GREGORIAN * * @return bool true on success or false on failure * * @see http://www.php.net/manual/en/intldateformatter.setcalendar.php * * @throws MethodNotImplementedException */
    public function setCalendar($calendar)
    {
        throw new MethodNotImplementedException(__METHOD__);
    }

    /** * Set the leniency of the parser. * * Define if the parser is strict or lenient in interpreting inputs that do not match the pattern * exactly. Enabling lenient parsing allows the parser to accept otherwise flawed date or time * patterns, parsing as much as possible to obtain a value. Extra space, unrecognized tokens, or * invalid values ("February 30th") are not accepted. * * @param bool $lenient Sets whether the parser is lenient or not. Currently * only false (strict) is supported. * * @return bool true on success or false on failure * * @see http://www.php.net/manual/en/intldateformatter.setlenient.php * * @throws MethodArgumentValueNotImplementedException When $lenient is true */
    public function setLenient($lenient)
    {
        if ($lenient) {
            throw new MethodArgumentValueNotImplementedException(__METHOD__'lenient'$lenient'Only the strict parser is supported');
        }

        return true;
    }

    /** * Set the formatter's pattern. * * @param string $pattern A pattern string in conformance with the ICU IntlDateFormatter documentation * * @return bool true on success or false on failure * * @see http://www.php.net/manual/en/intldateformatter.setpattern.php * @see http://userguide.icu-project.org/formatparse/datetime */
    public function setPattern($pattern)
    {
        if (null === $pattern) {
            $pattern = $this->getDefaultPattern();
        }

        $this->pattern = $pattern;

        return true;
    }

    /** * Set the formatter's timezone identifier. * * @param string $timeZoneId The time zone ID string of the time zone to use. * If NULL or the empty string, the default time zone for the * runtime is used. * * @return bool true on success or false on failure * * @see http://www.php.net/manual/en/intldateformatter.settimezoneid.php */
    public function setTimeZoneId($timeZoneId)
    {
        if (null === $timeZoneId) {
            $timeZoneId = date_default_timezone_get();

            $this->uninitializedTimeZoneId = true;
        }

        // Backup original passed time zone
        $timeZone = $timeZoneId;

        // Get an Etc/GMT time zone that is accepted for \DateTimeZone
        if ('GMT' !== $timeZoneId && 0 === strpos($timeZoneId'GMT')) {
            try {
                $timeZoneId = DateFormat\TimezoneTransformer::getEtcTimeZoneId($timeZoneId);
            } catch (\InvalidArgumentException $e) {
                // Does nothing, will fallback to UTC
            }
        }

        try {
            $this->dateTimeZone = new \DateTimeZone($timeZoneId);
            if ('GMT' !== $timeZoneId && $this->dateTimeZone->getName() !== $timeZoneId) {
                $timeZone = $this->getTimeZoneId();
            }
        } catch (\Exception $e) {
            $timeZoneId = $timeZone = $this->getTimeZoneId();
            $this->dateTimeZone = new \DateTimeZone($timeZoneId);
        }

        $this->timeZoneId = $timeZone;

        return true;
    }

    /** * This method was added in PHP 5.5 as replacement for `setTimeZoneId()`. * * @param mixed $timeZone * * @return bool true on success or false on failure * * @see http://www.php.net/manual/en/intldateformatter.settimezone.php */
    public function setTimeZone($timeZone)
    {
        if ($timeZone instanceof \IntlTimeZone) {
            $timeZone = $timeZone->getID();
        }

        if ($timeZone instanceof \DateTimeZone) {
            $timeZone = $timeZone->getName();

            // DateTimeZone returns the GMT offset timezones without the leading GMT, while our parsing requires it.
            if (!empty($timeZone&& ('+' === $timeZone[0|| '-' === $timeZone[0])) {
                $timeZone = 'GMT'.$timeZone;
            }
        }

        return $this->setTimeZoneId($timeZone);
    }

    /** * Create and returns a DateTime object with the specified timestamp and with the * current time zone. * * @param int $timestamp * * @return \DateTime */
    protected function createDateTime($timestamp)
    {
        $dateTime = new \DateTime();
        $dateTime->setTimestamp($timestamp);
        $dateTime->setTimezone($this->dateTimeZone);

        return $dateTime;
    }

    /** * Returns a pattern string based in the datetype and timetype values. * * @return string */
    protected function getDefaultPattern()
    {
        $patternParts = array();
        if (self::NONE !== $this->datetype) {
            $patternParts[] = $this->defaultDateFormats[$this->datetype];
        }
        if (self::NONE !== $this->timetype) {
            $patternParts[] = $this->defaultTimeFormats[$this->timetype];
        }

        return implode(', '$patternParts);
    }
}