public static function DateTimePlus::createFromFormat in Drupal 9

Same name and namespace in other branches

8 core/lib/Drupal/Component/Datetime/DateTimePlus.php \Drupal\Component\Datetime\DateTimePlus::createFromFormat()

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

string $time: String representing the time.

mixed $timezone: (optional) \DateTimeZone object, time zone string or NULL. See __construct() for more details.

array $settings: (optional) A keyed array for settings, suitable for passing on to __construct(). Supports an additional key:

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.

Return value

static A new DateTimePlus object.

Throws

\InvalidArgumentException If the a date cannot be created from the given format.

\UnexpectedValueException If the created date does not match the input value.

8 calls to DateTimePlus::createFromFormat()

DateTimeFormatConstraintValidator::validate in core/modules/datetime/src/Plugin/Validation/Constraint/DateTimeFormatConstraintValidator.php
DateTimePlusTest::providerTestDateDiff in core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php: Provides data for date tests.
DateTimePlusTest::providerTestInvalidDateDiff in core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php: Provides data for date tests.
DateTimePlusTest::testDateFormat in core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php: Tests creating dates from format strings.
DateTimePlusTest::testDefaultDateTime in core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php: Tests setting the default time for date-only objects.

... See full list

File

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

Class

DateTimePlus: Wraps DateTime().

Namespace

Drupal\Component\Datetime

Code

public static function createFromFormat($format, $time, $timezone = NULL, $settings = []) {
  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 \InvalidArgumentException('The date cannot be created from a format.');
  }
  else {
    $datetimeplus
      ->setTimestamp($date
      ->getTimestamp());
    $datetimeplus
      ->setTimezone($date
      ->getTimezone());

    // 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 ($settings['validate_format'] && $date
      ->format($format) != $time) {
      throw new \UnexpectedValueException('The created date does not match the input value.');
    }
  }
  return $datetimeplus;
}

You are here