Skip to content

GitLab

D
drupal
Commit 45d25684 authored by alexpott's avatar alexpott
Browse files
Options

Issue #2830079 by mpdonadio, jhedstrom: Change DateTimePlus to throw more specific exceptions

parent fa4c50a8
Hide whitespace changes
Inline Side-by-side
Showing with 29 additions and 24 deletions
core/lib/Drupal/Component/Datetime/DateTimePlus.php
View file @ 45d25684
......@@ -130,7 +130,7 @@ public static function createFromDateTime(\DateTime $datetime, $settings = array
* @return static
* A new DateTimePlus object.
*
* @throws \Exception
* @throws \InvalidArgumentException
* If the array date values or value combination is not correct.
*/
public static function createFromArray(array $date_parts, $timezone = NULL, $settings = array()) {
......@@ -144,7 +144,7 @@ public static function createFromArray(array $date_parts, $timezone = NULL, $set
return new static($iso_date, $timezone, $settings);
}
else {
throw new \Exception('The array contains invalid values.');
throw new \InvalidArgumentException('The array contains invalid values.');
}
}
......@@ -164,12 +164,12 @@ public static function createFromArray(array $date_parts, $timezone = NULL, $set
* @return static
* A new DateTimePlus object.
*
* @throws \Exception
* @throws \InvalidArgumentException
* If the timestamp is not numeric.
*/
public static function createFromTimestamp($timestamp, $timezone = NULL, $settings = array()) {
if (!is_numeric($timestamp)) {
throw new \Exception('The timestamp must be numeric.');
throw new \InvalidArgumentException('The timestamp must be numeric.');
}
$datetime = new static('', $timezone, $settings);
$datetime->setTimestamp($timestamp);
......@@ -202,9 +202,10 @@ public static function createFromTimestamp($timestamp, $timezone = NULL, $settin
* @return 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.
* @throws \InvalidArgumentException
* If the a date cannot be created from the given format.
* @throws \UnexpectedValueException
* If the created date does not match the input value.
*/
public static function createFromFormat($format, $time, $timezone = NULL, $settings = array()) {
if (!isset($settings['validate_format'])) {
......@@ -218,7 +219,7 @@ public static function createFromFormat($format, $time, $timezone = NULL, $setti
$date = \DateTime::createFromFormat($format, $time, $datetimeplus->getTimezone());
if (!$date instanceof \DateTime) {
throw new \Exception('The date cannot be created from a format.');
throw new \InvalidArgumentException('The date cannot be created from a format.');
}
else {
// Functions that parse date is forgiving, it might create a date that
......@@ -236,7 +237,7 @@ public static function createFromFormat($format, $time, $timezone = NULL, $setti
$datetimeplus->setTimezone($date->getTimezone());
if ($settings['validate_format'] && $test_time != $time) {
throw new \Exception('The created date does not match the input value.');
throw new \UnexpectedValueException('The created date does not match the input value.');
}
}
return $datetimeplus;
......
core/tests/Drupal/Tests/Component/Datetime/DateTimePlusTest.php
View file @ 45d25684
......@@ -98,11 +98,13 @@ public function testInvalidDateDiff($input1, $input2, $absolute) {
* Input argument for DateTimePlus.
* @param string $timezone
* Timezone argument for DateTimePlus.
* @param string $class
* The Exception subclass to expect to be thrown.
*
* @dataProvider providerTestInvalidDateArrays
* @expectedException \Exception
*/
public function testInvalidDateArrays($input, $timezone) {
public function testInvalidDateArrays($input, $timezone, $class) {
$this->setExpectedException($class);
$this->assertInstanceOf(
'\Drupal\Component\DateTimePlus',
DateTimePlus::createFromArray($input, $timezone)
......@@ -234,11 +236,13 @@ public function testDateFormat($input, $timezone, $format, $format_date, $expect
* Format argument for DateTimePlus.
* @param string $message
* Message to print if no errors are thrown by the invalid dates.
* @param string $class
* The Exception subclass to expect to be thrown.
*
* @dataProvider providerTestInvalidDates
* @expectedException \Exception
*/
public function testInvalidDates($input, $timezone, $format, $message) {
public function testInvalidDates($input, $timezone, $format, $message, $class) {
$this->setExpectedException($class);
DateTimePlus::createFromFormat($format, $input, $timezone);
}
......@@ -371,15 +375,15 @@ public function providerTestInvalidDates() {
return array(
// Test for invalid month names when we are using a short version
// of the month.
array('23 abc 2012', NULL, 'd M Y', "23 abc 2012 contains an invalid month name and did not produce errors."),
array('23 abc 2012', NULL, 'd M Y', "23 abc 2012 contains an invalid month name and did not produce errors.", \InvalidArgumentException::class),
// Test for invalid hour.
array('0000-00-00T45:30:00', NULL, 'Y-m-d\TH:i:s', "0000-00-00T45:30:00 contains an invalid hour and did not produce errors."),
array('0000-00-00T45:30:00', NULL, 'Y-m-d\TH:i:s', "0000-00-00T45:30:00 contains an invalid hour and did not produce errors.", \UnexpectedValueException::class),
// Test for invalid day.
array('0000-00-99T05:30:00', NULL, 'Y-m-d\TH:i:s', "0000-00-99T05:30:00 contains an invalid day and did not produce errors."),
array('0000-00-99T05:30:00', NULL, 'Y-m-d\TH:i:s', "0000-00-99T05:30:00 contains an invalid day and did not produce errors.", \UnexpectedValueException::class),
// Test for invalid month.
array('0000-75-00T15:30:00', NULL, 'Y-m-d\TH:i:s', "0000-75-00T15:30:00 contains an invalid month and did not produce errors."),
array('0000-75-00T15:30:00', NULL, 'Y-m-d\TH:i:s', "0000-75-00T15:30:00 contains an invalid month and did not produce errors.", \UnexpectedValueException::class),
// Test for invalid year.
array('11-08-01T15:30:00', NULL, 'Y-m-d\TH:i:s', "11-08-01T15:30:00 contains an invalid year and did not produce errors."),
array('11-08-01T15:30:00', NULL, 'Y-m-d\TH:i:s', "11-08-01T15:30:00 contains an invalid year and did not produce errors.", \UnexpectedValueException::class),
);
}
......@@ -397,17 +401,17 @@ public function providerTestInvalidDates() {
public function providerTestInvalidDateArrays() {
return array(
// One year larger than the documented upper limit of checkdate().
array(array('year' => 32768, 'month' => 1, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0), 'America/Chicago'),
array(array('year' => 32768, 'month' => 1, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0), 'America/Chicago', \InvalidArgumentException::class),
// One year smaller than the documented lower limit of checkdate().
array(array('year' => 0, 'month' => 1, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0), 'America/Chicago'),
array(array('year' => 0, 'month' => 1, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0), 'America/Chicago', \InvalidArgumentException::class),
// Test for invalid month from date array.
array(array('year' => 2010, 'month' => 27, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0), 'America/Chicago'),
array(array('year' => 2010, 'month' => 27, 'day' => 8, 'hour' => 8, 'minute' => 0, 'second' => 0), 'America/Chicago', \InvalidArgumentException::class),
// Test for invalid hour from date array.
array(array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 80, 'minute' => 0, 'second' => 0), 'America/Chicago'),
array(array('year' => 2010, 'month' => 2, 'day' => 28, 'hour' => 80, 'minute' => 0, 'second' => 0), 'America/Chicago', \InvalidArgumentException::class),
// Test for invalid minute from date array.
array(array('year' => 2010, 'month' => 7, 'day' => 8, 'hour' => 8, 'minute' => 88, 'second' => 0), 'America/Chicago'),
array(array('year' => 2010, 'month' => 7, 'day' => 8, 'hour' => 8, 'minute' => 88, 'second' => 0), 'America/Chicago', \InvalidArgumentException::class),
// Regression test for https://www.drupal.org/node/2084455.
array(array('hour' => 59, 'minute' => 1, 'second' => 1), 'America/Chicago'),
array(array('hour' => 59, 'minute' => 1, 'second' => 1), 'America/Chicago', \InvalidArgumentException::class),
);
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment