SymfonyWorld Online 2022 Winter Edition

DateTimeImmutable::setTime

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

DateTimeImmutable::setTimeSets the time

Description

public DateTimeImmutable::setTime(
    int $hour,
    int $minute,
    int $second = 0,
    int $microsecond = 0
): DateTimeImmutable

Returns a new DateTimeImmutable object with the time set to the given time.

Parameters

object

Procedural style only: A DateTime object returned by date_create(). The function modifies this object.

hour

Hour of the time.

minute

Minute of the time.

second

Second of the time.

microsecond

Microsecond of the time.

Return Values

Returns a new modified DateTimeImmutable object or false on failure.

Changelog

Version Description
7.1.0 The microsecond parameter was added.

Examples

Example #1 DateTimeImmutable::setTime() example

Object-oriented style

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

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

$newDate $date->setTime(145524);
echo 
$date->format('Y-m-d H:i:s') . "\n";
?>

The above examples will output something similar to:

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

Example #2 Values exceeding ranges are added to their parent values

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

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

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

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

$newDate $date->setTime(255524);
echo 
$newDate->format('Y-m-d H:i:s') . "\n";
?>

The above example will output:

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

See Also

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top