date_parse

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

date_parse指定した日付/時刻の詳細な情報を連想配列で返す

説明

date_parse(string $datetime): array

date_parse() は、 strtotime()DateTimeImmutable::__construct() と同じルールに従って datetime をパースします。 Unixタイムスタンプ (strtotime() の場合) や DateTimeImmutable (DateTimeImmutable::__construct() の場合) を返す代わりに、指定した datetime から検知できた情報を連想配列として返します。

あるグループの要素に関する情報が見つからなかった場合、 そうした情報は false に設定されたり、存在しない状態になります。 datetime に指定する文字列から、 同等のタイムスタンプや DateTimeImmutable オブジェクトを構築する必要がある場合、 より多くのフィールドを false でない値に設定できます。 そうしたことが起こる場合については、 以下に示す例を参照ください。

パラメータ

datetime

DateTimeImmutable::__construct() が理解できる書式の日付/時刻。

戻り値

成功した場合に日付/時刻情報を含む配列、失敗した場合に false を返します。

エラー / 例外

日付/時刻フォーマットにエラーがある場合は、 'errors' 要素にエラーメッセージが格納されます。

変更履歴

バージョン 説明
7.2.0 返される配列の zone 要素が、 分ではなく秒を表すようになり、 符号が逆になりました。 たとえば、 -1207200 を表すようになります。

例1 datetime に包括的な情報を指定した date_parse() の例

<?php
var_dump
(date_parse("2006-12-12 10:00:00.5"));
?>

上の例の出力は以下となります。

array(12) {
  'year' => int(2006)
  'month' => int(12)
  'day' => int(12)
  'hour' => int(10)
  'minute' => int(0)
  'second' => int(0)
  'fraction' => double(0.5)
  'warning_count' => int(0)
  'warnings' => array(0) {
  }
  'error_count' => int(0)
  'errors' => array(0) {
  }
  'is_localtime' => bool(false)
}

指定された datetime にタイムゾーン情報が含まれた場合にのみ、 タイムゾーンの要素が現れるようになります。 この場合、zone_type 要素が常に存在し、 値によっては少し多くの要素が含まれます。

例2 タイムゾーンの省略形を与えた場合の date_parse() の例

<?php
var_dump
(date_parse("June 2nd, 2022, 10:28:17 BST"));
?>

上の例の出力は以下となります。

array(16) {
  'year' => int(2022)
  'month' => int(6)
  'day' => int(2)
  'hour' => int(10)
  'minute' => int(28)
  'second' => int(17)
  'fraction' => double(0)
  'warning_count' => int(0)
  'warnings' => array(0) {
  }
  'error_count' => int(0)
  'errors' => array(0) {
  }
  'is_localtime' => bool(true)
  'zone_type' => int(2)
  'zone' => int(0)
  'is_dst' => bool(true)
  'tz_abbr' => string(3) "BST"
}

例3 タイムゾーン情報を与えた date_parse() の例

<?php
var_dump
(date_parse("June 2nd, 2022, 10:28:17 Europe/London"));
?>

上の例の出力は以下となります。

array(14) {
  'year' => int(2022)
  'month' => int(6)
  'day' => int(2)
  'hour' => int(10)
  'minute' => int(28)
  'second' => int(17)
  'fraction' => double(0)
  'warning_count' => int(0)
  'warnings' => array(0) {
  }
  'error_count' => int(0)
  'errors' => array(0) {
  }
  'is_localtime' => bool(true)
  'zone_type' => int(3)
  'tz_id' => string(13) "Europe/London"
}

さらに最低限の文字列を datetime に与えてパースさせた場合、 情報量はさらに少なくなります。以下の例では、 全ての時刻に関する情報が false になります。

例4 最低限の文字列だけを与えた date_parse() の例

<?php
var_dump
(date_parse("June 2nd, 2022"));
?>

上の例の出力は以下となります。

array(12) {
  'year' => int(2022)
  'month' => int(6)
  'day' => int(2)
  'hour' => bool(false)
  'minute' => bool(false)
  'second' => bool(false)
  'fraction' => bool(false)
  'warning_count' => int(0)
  'warnings' => array(0) {
  }
  'error_count' => int(0)
  'errors' => array(0) {
  }
  'is_localtime' => bool(false)
}

相対的な書式 は 絶対的な書式のパース結果に影響を及ぼさず、別途 "relative" 要素にまとめられます。

例5 "relative" フォーマットを使った date_parse() の例

<?php
var_dump
(date_parse("2006-12-12 10:00:00.5 +1 week +1 hour"));
?>

上の例の出力は以下となります。

array(13) {
  'year' => int(2006)
  'month' => int(12)
  'day' => int(12)
  'hour' => int(10)
  'minute' => int(0)
  'second' => int(0)
  'fraction' => double(0.5)
  'warning_count' => int(0)
  'warnings' => array(0) {
  }
  'error_count' => int(0)
  'errors' => array(0) {
  }
  'is_localtime' => bool(false)
  'relative' =>
  array(6) {
    'year' => int(0)
    'month' => int(0)
    'day' => int(7)
    'hour' => int(1)
    'minute' => int(0)
    'second' => int(0)
  }
}

Thursday のように、 語句によっては、文字列の時刻の部分に 0 を設定するものがあります。 ThursdayDateTimeImmutable::__construct() に与えた場合、hour, minute, second は 0 に設定されます。 以下の例では、year の要素は false に設定されます。

例6 date_parse() の副作用

<?php
var_dump
(date_parse("Thursday, June 2nd"));
?>

上の例の出力は以下となります。

array(13) {
  'year' => bool(false)
  'month' => int(6)
  'day' => int(2)
  'hour' => int(0)
  'minute' => int(0)
  'second' => int(0)
  'fraction' => double(0)
  'warning_count' => int(0)
  'warnings' => array(0) {
  }
  'error_count' => int(0)
  'errors' => array(0) {
  }
  'is_localtime' => bool(false)
  'relative' =>
  array(7) {
    'year' => int(0)
    'month' => int(0)
    'day' => int(0)
    'hour' => int(0)
    'minute' => int(0)
    'second' => int(0)
    'weekday' => int(4)
  }
}

参考

  • 指定されたフォーマットに従って datetime をパースする DateTimeImmutable::parseFromFormat()
  • checkdate() - グレゴリオ暦の日付/時刻の妥当性を確認します
  • getdate() - 日付/時刻情報を取得する

add a note add a note

User Contributed Notes 11 notes

up
14
admin at torntech dot com
11 years ago
A warning to others. Some keys will return with a default value where others will return as false if the date string has it omitted. Unsure if this is a bug or feature, but hopefully this will save someone some time.
<?php
///Example
$input = "Feb 2010";
$info = date_parse($input);
var_dump($info);

/*Returns:
array(12) {
    ["year"]=> int(2010)
    ["month"]=> int(2)
    ["day"]=> int(1)    //<---expected false like below
    ["hour"]=> bool(false)
    ["minute"]=> bool(false)
    ["second"]=> bool(false)
    ["fraction"]=> bool(false)
    ["warning_count"]=> int(0)
    ["warnings"]=> array(0) { }
    ["error_count"]=> int(0)
    ["errors"]=> array(0) { }
    ["is_localtime"]=> bool(false)
}*/
?>
up
8
alvaro at demogracia dot com
11 years ago
Be aware that date_parse() is happy with just a time zone and it can be pretty counter-intuitive. E.g.:

<?php
var_dump
( date_parse('Europe/Madrid') );
?>

... prints an array where year, month, day... are FALSE. But so do these:

<?php
var_dump
( date_parse('A') );
var_dump( date_parse('B') );
var_dump( date_parse('X') );
?>

Don't forget to further validate date_parse()'s output even when it isn't FALSE and the 'errors' key is empty.
up
2
paul at juniperwebcraft dot com
5 years ago
It's sometimes useful to be able to store incomplete dates, for example when all you know of someone's birthdate is the year or the month and day.

date_parse() handles (and MySQL accepts) dates containing zero-value elements such as "2017-00-00" and "0000-03-29", leaving it up to the parent application to determine when to require and how to handle missing date elements. date_parse() correctly reports zero values for zero-value date elements, reports an 'invalid date' warning, and does not report an error.

Example 1: Year only
<?php print_r( date_parse( '2017-00-00' ) );?>
generates:
<?php
Array
(
    [
year] => 2017
   
[month] => 0
   
[day] => 0
   
[hour] =>
    [
minute] =>
    [
second] =>
    [
fraction] =>
    [
warning_count] => 1
   
[warnings] => Array
        (
            [
11] => The parsed date was invalid
       
)

    [
error_count] => 0
   
[errors] => Array
        (
        )

    [
is_localtime] =>
)
?>

Example 2: Month and day only
<?php print_r( date_parse( '0000-03-29' ) )?>
generates:
<?php
Array
(
    [
year] => 0
   
[month] => 3
   
[day] => 29
   
[hour] =>
    [
minute] =>
    [
second] =>
    [
fraction] =>
    [
warning_count] => 1
   
[warnings] => Array
        (
            [
11] => The parsed date was invalid
       
)

    [
error_count] => 0
   
[errors] => Array
        (
        )

    [
is_localtime] =>
)
?>

However, simply omitting date elements gives PHP too much discretion in second-guessing our intentions:

Example 3: Truncated date:
<?php print_r( date_parse( '2017-03' ) )?>
generates:
<?php
Array
(
    [
year] => 2017
   
[month] => 3
   
[day] => 1
   
[hour] =>
    [
minute] =>
    [
second] =>
    [
fraction] =>
    [
warning_count] => 0
   
[warnings] => Array
        (
        )

    [
error_count] => 0
   
[errors] => Array
        (
        )

    [
is_localtime] =>
)
?>
In this case, PHP supplies a day value of 1 and does not report a warning.

Similarly, this feature of accepting zero date elements does not carry over to timestamps:

<?php $dDate = strtotime( '2017-03-00' );
print_r( getdate( $dDate ) ); ?>

displays:

<?php Array
(
    [
seconds] => 0
   
[minutes] => 0
   
[hours] => 0
   
[mday] => 28
   
[wday] => 2
   
[mon] => 2
   
[year] => 2017
   
[yday] => 58
   
[weekday] => Tuesday
   
[month] => February
   
[0] => 1488268800
)
?>
In this case, PHP interprets the "zeroth" day of March to be the last day of February.
up
1
edg at greenberg dot org
3 years ago
Passing "YYYY-MM" results in a valid date. Be careful to validate that your submitted date passed YOUR requirements.
up
0
y dot adounis at gmail dot com
2 years ago
Developers, be aware that using "now" will return an empty array, ex :

<?php
date_parse
("now");
?>

Will return :

Array
(
    [year] =>
    [month] =>
    [day] =>
    [hour] =>
    [minute] =>
    [second] =>
    [fraction] =>
    [warning_count] => 0
    [warnings] => Array
        (
        )

    [error_count] => 0
    [errors] => Array
        (
        )

    [is_localtime] =>
)
up
0
ryan_a_martin at yahoo dot com
11 years ago
See checkdate() at http://php.net/manual/en/function.checkdate.php for Gregorian date validation.
up
0
gpayne at galenaparkisd com
14 years ago
Careful - date_parse is perfectly happy with something like this:

date_parse("2006-2-31");
up
-2
adamm at extratech dot com
9 years ago
A warning to some
<?php
$time
= "00:14:38"
$parse_date = date_parse($time);
echo
var_dump($parse_date) ."<br>";
//here you will get what you expect

$time = "-00:14:38"
$parse_date = date_parse($time);
echo
var_dump($parse_date) ."<br>";
//here you will recieve hours minutes and seconds as booleans and as false and you will get error set to "Unexpected character"

$time = "00:-14:38"
$parse_date = date_parse($time);
echo
var_dump($parse_date) ."<br>";
//here you will recieve the same as the above

$time = "00:14:-38"
$parse_date = date_parse($time);
echo
var_dump($parse_date) ."<br>";
//here you will receive hours as 00 minutes as 14 and seconds as 0. The error will get set as the same as above. Meaning "Unexpected character"
?>
up
-5
alan at wilcoxengineering dot com
12 years ago
Caution: date_parse expects months 1..12 only.

date_parse("13/1/5769")  for  month=13, Ehul in Jewish calendar, results in  month==3 instead of month==13.

It does, however, report the error array showing "Unexpected Character."

It would be nice if date_parse could handle the months properly (just report back a "13" for the month). The older approach of substr() is my workaround.
up
-4
eugene at ultimatecms dot co dot za
12 years ago
<?php

$ida
= '091122671325';
$idb = '091123671325';

// This function will match the identity number up to the day, but only for a maximum of 99years+364days.
// Will not work when checking persons older than 100years-1day.

function idtodate($id)
{
       
$year = date("Y");
       
$month = date("m");
       
$day = date("d");

       
$nc = substr($year, 0, 2);
       
$ny = substr($year, 2, 2);

       
$y = substr($id, 0, 2);
       
$m = substr($id, 2, 2);
       
$d = substr($id, 4, 2);

        if(
$y.$m.$d <= $ny.$month.$day-1) {
               
$newc = $nc;
        } else {
               
$newc = $nc-1;
        }

       
$new = $newc.$y;

        return array(
'year' => $new, 'month' => $m, 'day' => $d);
}

echo
'ID: '.$ida.'<br>';
print_r(idtodate($ida));

echo
'<br><br>';

echo
'ID: '.$idb.'<br>';
print_r(idtodate($idb));

?>

Output:
1. If the year-month-day is smaller than today (2009-11-23), but bigger than 1999: year => 2009
ID: 091122671325
Array ( [year] => 2009 [month] => 11 [day] => 22 )

2. If the year-month-day is the same as, or bigger than today, but smaller than 2000: year => 1909
ID: 091123671325
Array ( [year] => 1909 [month] => 11 [day] => 23 )
To Top