DateTime::setDate
date_date_set
(PHP 5 >= 5.2.0)
DateTime::setDate -- date_date_set — Sets the date
Description
Object oriented style
Procedural style
Resets the current date of the DateTime object to a different date.
Parameters
-
object -
Procedural style only: A DateTime object returned by date_create(). The function modifies this object.
-
year -
Year of the date.
-
month -
Month of the date.
-
day -
Day of the date.
Return Values
Returns the DateTime object for method chaining or FALSE on failure.
Changelog
| Version | Description |
|---|---|
| 5.3.0 | Changed the
return value on success from NULL to DateTime. |
Examples
Example #1 DateTime::setDate() example
Object oriented style
<?php
$date = new DateTime();
$date->setDate(2001, 2, 3);
echo $date->format('Y-m-d');
?>
Procedural style
<?php
$date = date_create();
date_date_set($date, 2001, 2, 3);
echo date_format($date, 'Y-m-d');
?>
The above examples will output:
2001-02-03
Example #2 Values exceeding ranges are added to their parent values
<?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";
?>
The above example will output:
2001-02-28 2001-03-01 2002-02-03
See Also
- DateTime::setISODate() - Sets the ISO date
- DateTime::setTime() - Sets the time
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с датой и временем
- Дата и Время
- DateTime::add
- Функция DateTime::__construct() - Конструктор класса DateTime
- Функция DateTime::createFromFormat() - Создает и возвращает экземпляр класса DateTime, соответствующий заданному формату
- Функция DateTime::getLastErrors() - Возвращает предупреждения и ошибки
- Функция DateTime::modify() - Изменение временной метки
- Функция DateTime::__set_state() - Обработчик __set_state
- Функция DateTime::setDate() - Установка даты
- Функция DateTime::setISODate() - Установка ISO даты
- Функция DateTime::setTime() - Установка времени
- Функция DateTime::setTimestamp() - Устанавливает дату и время, основываясь на метке времени Unix
- Функция DateTime::setTimezone() - Установка временной зоны для объекта класса DateTime
- DateTime::sub
Коментарии
Be warned, DateTime::setDate() does not check for invalid input.
Illustration:
<?php
$dt = new DateTime();
$dt->setDate(2012, 11, 31); // returns DateTime object and not false although this date does not exist
echo $dt->format('Y-m-d'); // output: 2012-12-01
?>
No error was generated on entering a non existing date, php silently changed it.
Be carreful about this bug in php 5.6 and lower (fixed in php 7.0 and higher) :
<?php
$date = new DateTime("first day of last month");
echo $date->format('Y-m-d');
echo ' => ' ;
$date->setDate(2013, 2, 3);
echo $date->format('Y-m-d');
?>
Output <=5.6 : 2017-03-01 => 2013-02-01
Output >=7.0 : 2017-03-31 => 2013-02-03
Same goes for "Last day of last month", and the funny part, it will take the last day of the new month setted by setDate
Example with a Leap Year :
<?php
$date = new DateTime("last day of last month");
echo $date->format('Y-m-d');
echo ' => ' ;
$date->setDate(2012, 2, 3);
echo $date->format('Y-m-d');
?>
Output <=5.6 : 2017-03-31 => 2012-02-29
Output >=7.0 : 2017-03-31 => 2012-02-03
Correction on the previous comment :
Bug fixed in php 7.0.17 and 7.1.3, for the version 7.0.0 to 7.0.16 and 7.1.0 to 7.1.2, the bug is still present