Book/datetime-Phpdoc专题

日期和时间

简介
安装／配置
预定义常量
范例
- Date/Time Arithmetic
DateTime — DateTime 类
- DateTime::add — 给一个 DateTime 对象增加一定量的天，月，年，小时，分钟以及秒。
- DateTime::__construct — 返回一个新的 DateTime 对象
- DateTime::createFromFormat — 根据给定的格式解析日期时间字符串
- DateTime::createFromImmutable — Returns new DateTime object encapsulating the given DateTimeImmutable object
- DateTime::createFromInterface — Returns new DateTime object encapsulating the given DateTimeInterface object
- DateTime::getLastErrors — 获取警告和错误信息
- DateTime::modify — 修改日期时间对象的值
- DateTime::__set_state — __set_state 魔术方法处理函数
- DateTime::setDate — 设置 DateTime 对象的日期
- DateTime::setISODate — 设置 ISO 日期
- DateTime::setTime — 设置 DateTime 对象的时间
- DateTime::setTimestamp — 以 Unix 时间戳的方式设置 DateTime 对象
- DateTime::setTimezone — 设置 DateTime 对象的时区
- DateTime::sub — 对一个 DateTime 对象减去一定量的日、月、年、小时、分钟和秒。
DateTimeImmutable — The DateTimeImmutable class
- DateTimeImmutable::add — Adds an amount of days, months, years, hours, minutes and seconds
- DateTimeImmutable::__construct — Returns new DateTimeImmutable object
- DateTimeImmutable::createFromFormat — Parses a time string according to a specified format
- DateTimeImmutable::createFromInterface — Returns new DateTimeImmutable object encapsulating the given DateTimeInterface object
- DateTimeImmutable::createFromMutable — Returns new DateTimeImmutable object encapsulating the given DateTime object
- DateTimeImmutable::getLastErrors — Returns the warnings and errors
- DateTimeImmutable::modify — Creates a new object with modified timestamp
- DateTimeImmutable::__set_state — The __set_state handler
- DateTimeImmutable::setDate — Sets the date
- DateTimeImmutable::setISODate — Sets the ISO date
- DateTimeImmutable::setTime — Sets the time
- DateTimeImmutable::setTimestamp — Sets the date and time based on a Unix timestamp
- DateTimeImmutable::setTimezone — Sets the time zone
- DateTimeImmutable::sub — Subtracts an amount of days, months, years, hours, minutes and seconds
DateTimeInterface — The DateTimeInterface interface
- DateTime::diff — Returns the difference between two DateTime objects
- DateTime::format — Returns date formatted according to given format
- DateTime::getOffset — Returns the timezone offset
- DateTime::getTimestamp — Gets the Unix timestamp
- DateTime::getTimezone — Return time zone relative to given DateTime
- DateTime::__wakeup — The __wakeup handler
DateTimeZone — The DateTimeZone class
- DateTimeZone::__construct — 创建新的DateTimeZone对象
- DateTimeZone::getLocation — 返回与时区相关的定位信息。
- DateTimeZone::getName — 返回时区名称。
- DateTimeZone::getOffset — 返回相对于 GMT 的时差。
- DateTimeZone::getTransitions — Returns all transitions for the timezone
- DateTimeZone::listAbbreviations — 返回一个包含 dst (夏令时)，时差和时区信息的关联数组。
- DateTimeZone::listIdentifiers — 返回一个包含了所有时区标示符的索引数组。
DateInterval — DateInterval 类
- DateInterval::__construct — Creates a new DateInterval object
- DateInterval::createFromDateString — Sets up a DateInterval from the relative parts of the string
- DateInterval::format — Formats the interval
DatePeriod — DatePeriod 类
- DatePeriod::__construct — Creates a new DatePeriod object
- DatePeriod::getDateInterval — Gets the interval
- DatePeriod::getEndDate — Gets the end date
- DatePeriod::getRecurrences — Gets the number of recurrences
- DatePeriod::getStartDate — Gets the start date
Date/Time 函数
- checkdate — 验证一个格里高里日期
- date_add — 别名 DateTime::add
- date_create_from_format — 别名 DateTime::createFromFormat
- date_create_immutable_from_format — 别名 DateTimeImmutable::createFromFormat
- date_create_immutable — 别名 DateTimeImmutable::__construct
- date_create — 别名 DateTime::__construct
- date_date_set — 别名 DateTime::setDate
- date_default_timezone_get — 取得一个脚本中所有日期时间函数所使用的默认时区
- date_default_timezone_set — 设定用于一个脚本中所有日期时间函数的默认时区
- date_diff — 别名 DateTime::diff
- date_format — 别名 DateTime::format
- date_get_last_errors — 别名 DateTime::getLastErrors
- date_interval_create_from_date_string — 别名 DateInterval::createFromDateString
- date_interval_format — 别名 DateInterval::format
- date_isodate_set — 别名 DateTime::setISODate
- date_modify — 别名 DateTime::modify
- date_offset_get — 别名 DateTime::getOffset
- date_parse_from_format — Get info about given date formatted according to the specified format
- date_parse — Returns associative array with detailed info about given date/time
- date_sub — 别名 DateTime::sub
- date_sun_info — Returns an array with information about sunset/sunrise and twilight begin/end
- date_sunrise — 返回给定的日期与地点的日出时间
- date_sunset — 返回给定的日期与地点的日落时间
- date_time_set — 别名 DateTime::setTime
- date_timestamp_get — 别名 DateTime::getTimestamp
- date_timestamp_set — 别名 DateTime::setTimestamp
- date_timezone_get — 别名 DateTime::getTimezone
- date_timezone_set — 别名 DateTime::setTimezone
- date — 格式化一个本地时间／日期
- getdate — 取得日期／时间信息
- gettimeofday — 取得当前时间
- gmdate — 格式化一个 GMT/UTC 日期／时间
- gmmktime — 取得 GMT 日期的 UNIX 时间戳
- gmstrftime — 根据区域设置格式化 GMT/UTC 时间／日期
- idate — 将本地时间日期格式化为整数
- localtime — 取得本地时间
- microtime — 返回当前 Unix 时间戳和微秒数
- mktime — 取得一个日期的 Unix 时间戳
- strftime — 根据区域设置格式化本地时间／日期
- strptime — 解析由 strftime 生成的日期／时间
- strtotime — 将任何字符串的日期时间描述解析为 Unix 时间戳
- time — 返回当前的 Unix 时间戳
- timezone_abbreviations_list — 别名 DateTimeZone::listAbbreviations
- timezone_identifiers_list — 别名 DateTimeZone::listIdentifiers
- timezone_location_get — 别名 DateTimeZone::getLocation
- timezone_name_from_abbr — Returns the timezone name from abbreviation
- timezone_name_get — 别名 DateTimeZone::getName
- timezone_offset_get — 别名 DateTimeZone::getOffset
- timezone_open — 别名 DateTimeZone::__construct
- timezone_transitions_get — 别名 DateTimeZone::getTransitions
- timezone_version_get — Gets the version of the timezonedb
Supported Date and Time Formats
所支持的时区列表
- 非洲
- 美洲
- 南极洲
- 北极
- 亚洲
- 大西洋
- 澳洲
- 欧洲
- 印度
- 太平洋地区
- 其他

简介

日期和时间。

类摘要

DateTime

class DateTime implements DateTimeInterface {

/* 继承的常量 */

const string DateTimeInterface::ATOM = "Y-m-d\TH:i:sP" ;

const string DateTimeInterface::COOKIE = "l, d-M-Y H:i:s T" ;

const string DateTimeInterface::ISO8601 = "Y-m-d\TH:i:sO" ;

const string DateTimeInterface::RFC822 = "D, d M y H:i:s O" ;

const string DateTimeInterface::RFC850 = "l, d-M-y H:i:s T" ;

const string DateTimeInterface::RFC1036 = "D, d M y H:i:s O" ;

const string DateTimeInterface::RFC1123 = "D, d M Y H:i:s O" ;

const string DateTimeInterface::RFC7231 = "D, d M Y H:i:s \G\M\T" ;

const string DateTimeInterface::RFC2822 = "D, d M Y H:i:s O" ;

const string DateTimeInterface::RFC3339 = "Y-m-d\TH:i:sP" ;

const string DateTimeInterface::RFC3339_EXTENDED = "Y-m-d\TH:i:s.vP" ;

const string DateTimeInterface::RSS = "D, d M Y H:i:s O" ;

const string DateTimeInterface::W3C = "Y-m-d\TH:i:sP" ;

/* 方法 */

public __construct ([ string $time = "now" [, DateTimeZone $timezone = null ]] )

public DateTime add ( DateInterval $interval )

public static DateTime createFromFormat ( string $format , string $time [, DateTimeZone $timezone ] )

public static DateTime createFromImmutable ( DateTimeImmutable $object )

public static DateTime createFromInterface ( DateTimeInterface $object )

public static array getLastErrors ( void )

public DateTime modify ( string $modifier )

public static DateTime __set_state ( array $array )

public DateTime setDate ( int $year , int $month , int $day )

public DateTime setISODate ( int $year , int $week [, int $dayOfWeek = 1 ] )

public DateTime setTime ( int $hour , int $minute [, int $second = 0 [, int $microsecond = 0 ]] )

public DateTime setTimestamp ( int $unixtimestamp )

public DateTime setTimezone ( DateTimeZone $timezone )

public DateTime sub ( DateInterval $interval )

public DateIntervalfalse diff ( DateTimeInterface $targetObject [, bool $absolute = false ] )

public string format ( string $format )

publicint getOffset ( void )

public int getTimestamp ( void )

public DateTimeZonefalse getTimezone ( void )

public void __wakeup ( void )

}

更新日志

版本	说明
7.2.0	DateTime 的类常量现在定义在 DateTimeInterface 上。
7.0.0	新增常量：DATE_RFC3339_EXTENDED 和 DateTime::RFC3339_EXTENDED。
5.5.0	实现 DateTimeInterface 接口。
5.4.24	COOKIE 格式从 2 位数字表示年份（RFC 850）修改为 4 位数字表示年份（RFC 1036）。
5.2.2	DateTime 对象进行比较操作（comparison operators）的时候可以正常工作了。在之前的版本中，当使用 == 进行相等比较的时候，所有的 DateTime 对象都会被视为是相等的。

DateTime::add

date_add

给一个 DateTime 对象增加一定量的天，月，年，小时，分钟以及秒。

说明

面向对象风格

public DateTime DateTime::add ( DateInterval $interval )

过程化风格

DateTime date_add ( DateTime $object , DateInterval $interval )

将给定的 DateInterval 对象加到 DateTime 对象上。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

interval
DateInterval 对象。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::add 例程

面向对象风格

<?php
$date = new DateTime('2000-01-01');
$date->add(new DateInterval('P10D'));
echo $date->format('Y-m-d') . "\n";
?>

过程化风格

<?php
$date = date_create('2000-01-01');
date_add($date, date_interval_create_from_date_string('10 days'));
echo date_format($date, 'Y-m-d');
?>

以上例程会输出：

2000-01-11

示例 #2 Further DateTime::add 例程

<?php
$date = new DateTime('2000-01-01');
$date->add(new DateInterval('PT10H30S'));
echo $date->format('Y-m-d H:i:s') . "\n";

$date = new DateTime('2000-01-01');
$date->add(new DateInterval('P7Y5M4DT4H3M2S'));
echo $date->format('Y-m-d H:i:s') . "\n";
?>

以上例程会输出：

2000-01-01 10:00:30
2007-06-05 04:03:02

示例 #3 当在 DateTime 上加月的时候要注意

<?php
$date = new DateTime('2000-12-31');
$interval = new DateInterval('P1M');

$date->add($interval);
echo $date->format('Y-m-d') . "\n";

$date->add($interval);
echo $date->format('Y-m-d') . "\n";
?>

以上例程会输出：

2001-01-31
2001-03-03

注释

在 PHP 5.2 的版本中，也可以使用 DateTime::modify 方法来替代本方法。

参见

DateTime::sub
DateTime::diff
DateTime::modify

DateTime::__construct

date_create

返回一个新的 DateTime 对象

说明

面向对象风格

public DateTime::__construct ([ string $time = "now" [, DateTimeZone $timezone = null ]] )

过程化风格

DateTime date_create ([ string $time = "now" [, DateTimeZone $timezone = null ]] )

返回一个新的 DateTime 对象。

参数

time
日期/时间字符串。正确格式的说明详见日期与时间格式。

如果这个参数为字符串 "now" 表示获取当前时间。如果同时指定了 $timezone 参数，那么获取指定时区的当前时间。

timezone
DateTimeZone 对象，表示要获取哪个时区的 $time。

如果省略了 $timezone 参数，那么会使用当前时区。

Note:

当 $time 参数是 UNIX 时间戳（例如 @946684800），或者已经包含时区信息（例如 2010-01-28T15:00:00+02:00）的时候， $timezone 参数和当前时区都将被忽略。

返回值

返回一个新的 DateTime 对象实例，或者在发生错误的时候返回过程化风格在失败时返回 false。。

错误／异常

如果发生错误，会抛出 Exception。

更新日志

版本	说明
7.1	微秒部分不再是 '00000' 了，而是真实的微秒数据。
5.3.0	如果 `time` 参数不是一个有效的日期/时间格式，会抛出异常。在之前的版本中是会发出一个错误。

范例

示例 #1 DateTime::__construct 例程

面向对象风格

<?php
try {
    $date = new DateTime('2000-01-01');
} catch (Exception $e) {
    echo $e->getMessage();
    exit(1);
}

echo $date->format('Y-m-d');
?>

过程化风格

<?php
$date = date_create('2000-01-01');
if (!$date) {
    $e = date_get_last_errors();
    foreach ($e['errors'] as $error) {
        echo "$error\n";
    }
    exit(1);
}

echo date_format($date, 'Y-m-d');
?>

以上例程会输出：

2000-01-01

示例 #2 DateTime::__construct 的复杂用法

<?php
// 指定时间，但是使用电脑的时区
$date = new DateTime('2000-01-01');
echo $date->format('Y-m-d H:i:sP') . "\n";

// 指定时间和时区
$date = new DateTime('2000-01-01', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";

// 使用当前时间以及电脑的时区
$date = new DateTime();
echo $date->format('Y-m-d H:i:sP') . "\n";

// 使用当前时间和指定的时区
$date = new DateTime(null, new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";

// 使用 UNIX 时间戳作为时间，请注意这里的生成的 DateTime 对象对应的是 UTC 时区
$date = new DateTime('@946684800');
echo $date->format('Y-m-d H:i:sP') . "\n";

// 指定一个无效的时间，会自动对应到有效的时间
$date = new DateTime('2000-02-30');
echo $date->format('Y-m-d H:i:sP') . "\n";
?>

以上例程的输出类似于：

2000-01-01 00:00:00-05:00
2000-01-01 00:00:00+12:00
2010-04-24 10:24:16-04:00
2010-04-25 02:24:16+12:00
2000-01-01 00:00:00+00:00
2000-03-01 00:00:00-05:00

参见

DateTime::createFromFormat
DateTimeZone::__construct
日期时间格式
date.timezone ini 设置
date_default_timezone_set
DateTime::getLastErrors
checkdate

DateTime::createFromFormat

date_create_from_format

根据给定的格式解析日期时间字符串

说明

面向对象风格

public static DateTime DateTime::createFromFormat ( string $format , string $time [, DateTimeZone $timezone ] )

过程化风格

DateTime date_create_from_format ( string $format , string $time [, DateTimeZone $timezone ] )

将 time 参数给定的日期时间字符串，根据 format 参数给定的格式解析为一个新的 DateTime 对象。

参数

format
在解析日期时间字符串的时候使用的格式 string。参加下列的格式清单。大部分格式和 date 函数中的格式是一致的。

`format` 中的字符	解释	示例
日	---	---
d 和 j	一个月中的第几天，2 位数字表示，有前导 0 或者无前导 0	01 到 31 或者 1 到 31
D 和 l	星期几的文字表示	Mon 到 Sun 或者 Sunday 到 Saturday
S	2 个字母表示的一个月中的第几天（序数词），在进行解析的时候会被忽略	st，nd，rd 或者 th。
z	一年中的第几天，从 0 开始	0 到 365
月	---	---
F 和 M	文本表示的月份，例如 January 或者 Sept	January 到 December 或者 Jan 到 Dec
m 和 n	数值表示的月份，有前导 0 或者无前导 0	01 到 12 or 1 到 12
年	---	---
Y	4 位数字表示的年	例如：1999 或 2003
y	2 位数字表示的年，可用的范围是 1970 至 2069（不含）	例如： 99 或 03 （表示 1999 和 2003）
时间	---	---
a 和 A	上午、下午	am 或 pm
g and h	12 小时制的小时，有前导 0 或者无前导 0	1 到 12 或者 01 到 12
G 和 H	24 小时制的小时，有前导 0 或者无前导 0	0 到 23 或 00 到 23
i	分钟，有前导 0	00 到 59
s	秒，有前导 0	00 到 59
u	微秒，最多到 6 位数字	示例：45，654321
时区	---	---
e，O, P 和 T	时区名称，或者是以 UTC 时区为基准的小时偏移量，或者是以 UTC 为基准的小时和分钟的偏移量，小时和分钟之间用冒号（:）分隔。	示例：UTC，GMT， Atlantic/Azores 或 +0200 或 +02:00 或 EST，MDT
完整的日期和时间	---	---
U	从 Unix Epoch (January 1 1970 00:00:00 GMT) 开始计算的时间，以秒为单位	示例：1292177455
空白字符和分隔字符	---	---
（空格）	一个空格字符或者一个 tab 字符	示例：
#	可以是一下分隔符号中的任意一个： ;， :，/，.， ,，-，( 或 )	示例：/
;， :，/，.， ,，-，( 或 )	特殊字符	示例：-
?	随机字节	示例：^ （需要注意的是，对于 UTF-8 字符，可能会需要多个 ?。这种情况下，请使用 *）
*	随机字节，直到遇到下一个有效的分隔符号或者数值	示例：使用 Y--d* 格式用来解析 2009-aWord-08 字符串的时候， * 会匹配 aWord
!	将所有的字段（年、月、日、时、分、秒、微秒以及时区）重置到 Unix Epoch 时间。	如果不使用 !, 格式，那么所有的字段会被设置为系统当前的日期和时间。
\|	将尚未被解析的字段，也即格式字符串中未明确指定的字段（年、月、日、时、分、秒、微秒以及时区）重置到 Unix Epoch 时间。	Y-m-d\| 会解析日期时间字符串中的年、月和日，但是对于时、分、秒字段会设置为 0.
+	在格式字符串中使用这个格式表示字符，并且所提供的日期时间字符串中包含除了格式字符之外的其他数据的话，不会发出一个错误，而是发出一个警告。	使用 DateTime::getLastErrors 方法来检测所给定的日期时间字符串中是否包含格式字符串指定的内容之外的数据。

如果在格式字符串中包含不可识别的字符，那么会导致解析失败，并且在返回的结构中附加一个错误信息。可以通过 DateTime::getLastErrors 来探查解析是否存在错误。

如果需要在格式字符串 format 参数中使用上述表示格式的字符作为一个普通字符，请对其使用反斜线（\）进行转义。

如果格式字符串参数 format 中不包含 ! 字符，那么没有在 format 参数中指明的字段，在解析结果中将会被设置为系统当前时间对应的字段值。

如果格式字符串参数 format 包含了 ! 字符，那么没有在 format 参数中指明的字段，以及在 ! 左侧对应的字段，在解析结果中将会被设置为 Unix epoch 时间对应的字段。

The Unix epoch 为 1970-01-01 00:00:00 UTC。

time
用来表示日期时间的字符串。

timezone
DateTimeZone 对象，表示在解析日期时间字符串的时候需要使用的时区。

如果忽略 timezone 参数，并且表示日期时间的字符串 time 中也不包含时区信息，那么将会使用系统当前时区作为解析结果对象的时区。

Note:

如果 time 参数是 UNIX 时间戳格式（例如：946684800），或者其中已经包含了时区信息（例如：2010-01-28T15:00:00+02:00），那么 timezone 以及系统当前时区都将会被忽略。

返回值

返回一个 DateTime 对象。或者在失败时返回 false。

更新日志

版本	说明
5.3.9	新增 `format` 格式字符串中对于 + 格式字符的支持。

范例

示例 #1 DateTime::createFromFormat 例程

面向对象风格

<?php
$date = DateTime::createFromFormat('j-M-Y', '15-Feb-2009');
echo $date->format('Y-m-d');
?>

过程化风格

<?php
$date = date_create_from_format('j-M-Y', '15-Feb-2009');
echo date_format($date, 'Y-m-d');
?>

以上例程会输出：

2009-02-15

示例 #2 DateTime::createFromFormat 的复杂用法

<?php
echo 'Current time: ' . date('Y-m-d H:i:s') . "\n";

$format = 'Y-m-d';
$date = DateTime::createFromFormat($format, '2009-02-15');
echo "Format: $format; " . $date->format('Y-m-d H:i:s') . "\n";

$format = 'Y-m-d H:i:s';
$date = DateTime::createFromFormat($format, '2009-02-15 15:16:17');
echo "Format: $format; " . $date->format('Y-m-d H:i:s') . "\n";

$format = 'Y-m-!d H:i:s';
$date = DateTime::createFromFormat($format, '2009-02-15 15:16:17');
echo "Format: $format; " . $date->format('Y-m-d H:i:s') . "\n";

$format = '!d';
$date = DateTime::createFromFormat($format, '15');
echo "Format: $format; " . $date->format('Y-m-d H:i:s') . "\n";
?>

以上例程的输出类似于：

Current time: 2010-04-23 10:29:35
Format: Y-m-d; 2009-02-15 10:29:35
Format: Y-m-d H:i:s; 2009-02-15 15:16:17
Format: Y-m-!d H:i:s; 1970-01-15 15:16:17
Format: !d; 1970-01-15 00:00:00

示例 #3 格式化字符串中包含了需要进行转义的字符

<?php
echo DateTime::createFromFormat('H\h i\m s\s','23h 15m 03s')->format('H:i:s');
?>

以上例程的输出类似于：

23:15:03

参见

DateTime::__construct
DateTime::getLastErrors
checkdate
strptime

DateTime::createFromImmutable

Returns new DateTime object encapsulating the given DateTimeImmutable object

说明

public static DateTime DateTime::createFromImmutable ( DateTimeImmutable $object )

参数

object
The immutable DateTimeImmutable object that needs to be converted to a mutable version. This object is not modified, but instead a new DateTime object is created containing the same date, time, and timezone information.

范例

示例 #1 Creating a mutable date time object

<?php
$date = new DateTimeImmutable("2014-06-20 11:45 Europe/London");

$mutable = DateTime::createFromImmutable( $date );
?>

返回值

Returns a new DateTime instance.

DateTime::createFromInterface

Returns new DateTime object encapsulating the given DateTimeInterface object

说明

public static DateTime DateTime::createFromInterface ( DateTimeInterface $object )

参数

object
The DateTimeInterface object that needs to be converted to a mutable version. This object is not modified, but instead a new DateTime object is created containing the same date, time, and timezone information.

返回值

Returns a new DateTime instance.

范例

示例 #1 Creating a mutable date time object

<?php
$date = new DateTimeImmutable("2014-06-20 11:45 Europe/London");

$mutable = DateTime::createFromInterface($date);

$date = new DateTime("2014-06-20 11:45 Europe/London");
$also_mutable = DateTime::createFromInterface($date);
?>

DateTime::getLastErrors

date_get_last_errors

获取警告和错误信息

说明

面向对象风格

public static array DateTime::getLastErrors ( void )

过程化风格

array date_get_last_errors ( void )

返回在解析日期时间字符串的过程中发生的警告和错误信息。

参数

此函数没有参数。

返回值

返回一个数组，其中包含在解析日期时间字符串的过程中发生的警告和错误信息。

范例

示例 #1 DateTime::getLastErrors 例程

面向对象风格

<?php
try {
    $date = new DateTime('asdfasdf');
} catch (Exception $e) {
    // 仅出于演示的目的...
    print_r(DateTime::getLastErrors());

    // 实际的代码中你应该这样使用返回对象
    // echo $e->getMessage();
}
?>

过程化风格

<?php
$date = date_create('asdfasdf');
print_r(date_get_last_errors());
?>

以上例程会输出：

Array
(
   [warning_count] => 1
   [warnings] => Array
       (
           [6] => Double timezone specification
       )

   [error_count] => 1
   [errors] => Array
       (
           [0] => The timezone could not be found in the database
       )

)

返回数组中的索引 6 和 0 表示在解析过程中，所提供的日期时间字符串中无法正确解析的字符位置。

DateTime::modify

date_modify

修改日期时间对象的值

说明

面向对象风格

public DateTime DateTime::modify ( string $modifier )

过程化风格

DateTime date_modify ( DateTime $object , string $modifier )

修改一个日期时间对象的值。支持 DateTimeImmutable::__construct 函数所允许的字符串。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

modifier
日期/时间字符串。正确格式的说明详见日期与时间格式。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::modify 例程

面向对象风格

<?php
$date = new DateTime('2006-12-12');
$date->modify('+1 day');
echo $date->format('Y-m-d');
?>

过程化风格

<?php
$date = date_create('2006-12-12');
date_modify($date, '+1 day');
echo date_format($date, 'Y-m-d');
?>

以上例程会输出：

2006-12-13

示例 #2 增加或者减少月份的时候需要注意

<?php
$date = new DateTime('2000-12-31');

$date->modify('+1 month');
echo $date->format('Y-m-d') . "\n";

$date->modify('+1 month');
echo $date->format('Y-m-d') . "\n";
?>

以上例程会输出：

2001-01-31
2001-03-03

参见

strtotime
DateTime::add
DateTime::sub
DateTime::setDate
DateTime::setISODate
DateTime::setTime
DateTime::setTimestamp

DateTime::__set_state

__set_state 魔术方法处理函数

说明

public static DateTime DateTime::__set_state ( array $array )

__set_state() 魔术方法处理函数。

参数

array
用来初始化对象属性值的数组。

返回值

返回 DateTime 对象实例。

DateTime::setDate

date_date_set

设置 DateTime 对象的日期

说明

面向对象风格

public DateTime DateTime::setDate ( int $year , int $month , int $day )

过程化风格

DateTime date_date_set ( DateTime $object , int $year , int $month , int $day )

设置 DateTime 对象的日期。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

year
年份。

month
月份。

day
日。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::setDate 例程

面向对象风格

<?php
$date = new DateTime();
$date->setDate(2001, 2, 3);
echo $date->format('Y-m-d');
?>

过程化风格

<?php
$date = date_create();
date_date_set($date, 2001, 2, 3);
echo date_format($date, 'Y-m-d');
?>

以上例程会输出：

2001-02-03

示例 #2 超出范围的部分会向上一级增加

<?php
$date = new DateTime();

$date->setDate(2001, 2, 28);
echo $date->format('Y-m-d') . "\n";

$date->setDate(2001, 2, 29);
echo $date->format('Y-m-d') . "\n";

$date->setDate(2001, 14, 3);
echo $date->format('Y-m-d') . "\n";
?>

以上例程会输出：

2001-02-28
2001-03-01
2002-02-03

参见

DateTime::setISODate
DateTime::setTime

DateTime::setISODate

date_isodate_set

设置 ISO 日期

说明

面向对象风格

public DateTime DateTime::setISODate ( int $year , int $week [, int $dayOfWeek = 1 ] )

过程化风格

DateTime date_isodate_set ( DateTime $object , int $year , int $week [, int $dayOfWeek = 1 ] )

以 ISO 8601 规范的格式设置日期，使用周和日的偏移量作为参数，而不是使用月和日。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

year
年份。

week
周。

dayOfWeek
从周的第一天计算，日在一周内的偏移量。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::setISODate 例程

面向对象风格

<?php
$date = new DateTime();

$date->setISODate(2008, 2);
echo $date->format('Y-m-d') . "\n";

$date->setISODate(2008, 2, 7);
echo $date->format('Y-m-d') . "\n";
?>

过程化风格

<?php
$date = date_create();

date_isodate_set($date, 2008, 2);
echo date_format($date, 'Y-m-d') . "\n";

date_isodate_set($date, 2008, 2, 7);
echo date_format($date, 'Y-m-d') . "\n";
?>

以上例程会输出：

2008-01-07
2008-01-13

示例 #2 超出有效范围的部分，会加到上一级

<?php
$date = new DateTime();

$date->setISODate(2008, 2, 7);
echo $date->format('Y-m-d') . "\n";

$date->setISODate(2008, 2, 8);
echo $date->format('Y-m-d') . "\n";

$date->setISODate(2008, 53, 7);
echo $date->format('Y-m-d') . "\n";
?>

以上例程会输出：

2008-01-13
2008-01-14
2009-01-04

示例 #3 找出来某个周所属的月份

<?php
$date = new DateTime();
$date->setISODate(2008, 14);
echo $date->format('n');
?>

以上例程会输出：

参见

DateTime::setDate
DateTime::setTime

DateTime::setTime

date_time_set

设置 DateTime 对象的时间

说明

面向对象风格

public DateTime DateTime::setTime ( int $hour , int $minute [, int $second = 0 [, int $microsecond = 0 ]] )

过程化风格

DateTime date_time_set ( DateTime $object , int $hour , int $minute [, int $second = 0 [, int $microsecond = 0 ]] )

设置 DateTime 对象的时间。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

hour
小时。

minute
分钟。

second
秒。

microsecond
微秒。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

更新日志

版本	说明
7.1.0	新增 `microsecond` 参数。

范例

示例 #1 DateTime::setTime 例程

面向对象风格

<?php
$date = new DateTime('2001-01-01');

$date->setTime(14, 55);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(14, 55, 24);
echo $date->format('Y-m-d H:i:s') . "\n";
?>

过程化风格

<?php
$date = date_create('2001-01-01');

date_time_set($date, 14, 55);
echo date_format($date, 'Y-m-d H:i:s') . "\n";

date_time_set($date, 14, 55, 24);
echo date_format($date, 'Y-m-d H:i:s') . "\n";
?>

以上例程的输出类似于：

2001-01-01 14:55:00
2001-01-01 14:55:24

示例 #2 超出有效范围的部分会增加到上一级

<?php
$date = new DateTime('2001-01-01');

$date->setTime(14, 55, 24);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(14, 55, 65);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(14, 65, 24);
echo $date->format('Y-m-d H:i:s') . "\n";

$date->setTime(25, 55, 24);
echo $date->format('Y-m-d H:i:s') . "\n";
?>

以上例程会输出：

2001-01-01 14:55:24
2001-01-01 14:56:05
2001-01-01 15:05:24
2001-01-02 01:55:24

参见

DateTime::setDate
DateTime::setISODate

DateTime::setTimestamp

date_timestamp_set

以 Unix 时间戳的方式设置 DateTime 对象

说明

面向对象风格

public DateTime DateTime::setTimestamp ( int $unixtimestamp )

过程化风格

DateTime date_timestamp_set ( DateTime $object , int $unixtimestamp )

以 Unix 时间戳的方式设置 DateTime 对象的日期和时间。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

unixtimestamp
表示日期时间的 Unix 时间戳。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::setTimestamp 例程

面向对象风格

<?php
$date = new DateTime();
echo $date->format('U = Y-m-d H:i:s') . "\n";

$date->setTimestamp(1171502725);
echo $date->format('U = Y-m-d H:i:s') . "\n";
?>

过程化风格

<?php
$date = date_create();
echo date_format($date, 'U = Y-m-d H:i:s') . "\n";

date_timestamp_set($date, 1171502725);
echo date_format($date, 'U = Y-m-d H:i:s') . "\n";
?>

以上例程的输出类似于：

1272508903 = 2010-04-28 22:41:43
1171502725 = 2007-02-14 20:25:25

注释

PHP 5.2 之后的版本中，可以使用 Unix 时间戳作为构造函数的参数生成新的 DateTime 对象，例如：

示例 #2 PHP 5.2 之后的版本中，DateTime::setTimestamp 替代方案

<?php
$ts = 1171502725;
$date = new DateTime("@$ts");
echo $date->format('U = Y-m-d H:i:s') . "\n";
?>

以上例程的输出类似于：

1171502725 = 2007-02-14 20:25:25

参见

DateTime::getTimestamp

DateTime::setTimezone

date_timezone_set

设置 DateTime 对象的时区

说明

面向对象风格

public DateTime DateTime::setTimezone ( DateTimeZone $timezone )

过程化风格

DateTime date_timezone_set ( DateTime $object , DateTimeZone $timezone )

设置 DateTime object 的时区。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

timezone
DateTimeZone 对象，表示要设置为时区。

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::setTimeZone 例程

面向对象风格

<?php
$date = new DateTime('2000-01-01', new DateTimeZone('Pacific/Nauru'));
echo $date->format('Y-m-d H:i:sP') . "\n";

$date->setTimezone(new DateTimeZone('Pacific/Chatham'));
echo $date->format('Y-m-d H:i:sP') . "\n";
?>

过程化风格

<?php
$date = date_create('2000-01-01', timezone_open('Pacific/Nauru'));
echo date_format($date, 'Y-m-d H:i:sP') . "\n";

date_timezone_set($date, timezone_open('Pacific/Chatham'));
echo date_format($date, 'Y-m-d H:i:sP') . "\n";
?>

以上例程会输出：

2000-01-01 00:00:00+12:00
2000-01-01 01:45:00+13:45

参见

DateTime::getTimezone
DateTimeZone::__construct

DateTime::sub

date_sub

对一个 DateTime 对象减去一定量的日、月、年、小时、分钟和秒。

说明

面向对象风格

public DateTime DateTime::sub ( DateInterval $interval )

过程化风格

DateTime date_sub ( DateTime $object , DateInterval $interval )

DateInterval 对象，表示要减去多少量的时间。

参数

object
仅过程化风格：由 date_create 返回的 DateTime 类型的对象。此函数会修改这个对象。

interval
DateInterval 对象

返回值

返回被修改的 DateTime 对象，或者在失败时返回 false.

范例

示例 #1 DateTime::sub 例程

面向对象风格

<?php
$date = new DateTime('2000-01-20');
$date->sub(new DateInterval('P10D'));
echo $date->format('Y-m-d') . "\n";
?>

过程化风格

<?php
$date = date_create('2000-01-20');
date_sub($date, date_interval_create_from_date_string('10 days'));
echo date_format($date, 'Y-m-d');
?>

以上例程会输出：

2000-01-10

示例 #2 Further DateTime::sub 例程

<?php
$date = new DateTime('2000-01-20');
$date->sub(new DateInterval('PT10H30S'));
echo $date->format('Y-m-d H:i:s') . "\n";

$date = new DateTime('2000-01-20');
$date->sub(new DateInterval('P7Y5M4DT4H3M2S'));
echo $date->format('Y-m-d H:i:s') . "\n";
?>

以上例程会输出：

2000-01-19 13:59:30
1992-08-15 19:56:58

示例 #3 减去一定量的月份的时候需要注意

<?php
$date = new DateTime('2001-04-30');
$interval = new DateInterval('P1M');

$date->sub($interval);
echo $date->format('Y-m-d') . "\n";

$date->sub($interval);
echo $date->format('Y-m-d') . "\n";
?>

以上例程会输出：

2001-03-30
2001-03-02

注释

在 PHP 5.2 之后，可以使用 DateTime::modify 作为替代。

参见

DateTime::add
DateTime::diff
DateTime::modify

简介

Representation of date and time.

类摘要

DateTimeImmutable

class DateTimeImmutable implements DateTimeInterface {