public static function DateTimePlus::createFromFormat

public static DateTimePlus::createFromFormat($format, $time, $timezone = NULL, $settings = array())

Creates a date object from an input format.

Parameters

string $format: PHP date() type format for parsing the input. This is recommended to use things like negative years, which php's parser fails on, or any other specialized input with a known format. If provided the date will be created using the createFromFormat() method. @see http://php.net/manual/datetime.createfromformat.php

mixed $time: @see __construct()

mixed $timezone: @see __construct()

array $settings:

• validate_format: (optional) Boolean choice to validate the created date using the input format. The format used in createFromFormat() allows slightly different values than format(). Using an input format that works in both functions makes it possible to a validation step to confirm that the date created from a format string exactly matches the input. This option indicates the format can be used for validation. Defaults to TRUE.

@see __construct()

Return value

static A new DateTimePlus object.

Throws

\Exception If the a date cannot be created from the given format, or if the created date does not match the input value.

File

core/lib/Drupal/Component/Datetime/DateTimePlus.php, line 209

Class

DateTimePlus

Wraps DateTime().

Namespace

Drupal\Component\Datetime

Code

public static function createFromFormat($format, $time, $timezone = NULL, $settings = array()) {
  if (!isset($settings['validate_format'])) {
    $settings['validate_format'] = TRUE;
  }

  // Tries to create a date from the format and use it if possible.
  // A regular try/catch won't work right here, if the value is
  // invalid it doesn't return an exception.
  $datetimeplus = new static('', $timezone, $settings);

  $date = \DateTime::createFromFormat($format, $time, $datetimeplus->getTimezone());
  if (!$date instanceof \DateTime) {
    throw new \Exception('The date cannot be created from a format.');
  }
  else {
    // Functions that parse date is forgiving, it might create a date that
    // is not exactly a match for the provided value, so test for that by
    // re-creating the date/time formatted string and comparing it to the input. For
    // instance, an input value of '11' using a format of Y (4 digits) gets
    // created as '0011' instead of '2011'.
    if ($date instanceof DateTimePlus) {
      $test_time = $date->format($format, $settings);
    }
    elseif ($date instanceof \DateTime) {
      $test_time = $date->format($format);
    }
    $datetimeplus->setTimestamp($date->getTimestamp());
    $datetimeplus->setTimezone($date->getTimezone());

    if ($settings['validate_format'] && $test_time != $time) {
      throw new \Exception('The created date does not match the input value.');
    }
  }
  return $datetimeplus;
}