SymfonyWorld Online 2022 Winter Edition

DateTimeImmutable::setISODate

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

DateTimeImmutable::setISODateSets the ISO date

Description

public DateTimeImmutable::setISODate(int $year, int $week, int $dayOfWeek = 1): DateTimeImmutable

Returns a new DateTimeImmutable object with the date set according to the ISO 8601 standard - using weeks and day offsets rather than specific dates.

Parameters

object

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

year

Year of the date.

week

Week of the date.

dayOfWeek

Offset from the first day of the week.

Return Values

Returns a new modified DateTimeImmutable object or false on failure.

Examples

Example #1 DateTimeImmutable::setISODate() example

Object-oriented style

<?php
$date 
= new DateTimeImmutable();

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

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

Procedural style

<?php
$date 
date_create();

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

date_isodate_set($date200827);
echo 
date_format($date'Y-m-d') . "\n";
?>

The above examples will output:

2008-01-07
2008-01-13

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

<?php
$date 
= new DateTimeImmutable();

$newDate $date->setISODate(200827);
echo 
$newDate->format('Y-m-d') . "\n";

$newDate $date->setISODate(200828);
echo 
$newDate->format('Y-m-d') . "\n";

$newDate $date->setISODate(2008537);
echo 
$newDate->format('Y-m-d') . "\n";
?>

The above example will output:

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

Example #3 Finding the month a week is in

<?php
$date 
= new DateTimeImmutable();
$newDate $date->setISODate(200814);
echo 
$newDate->format('n');
?>

The above examples will output:

3

See Also

add a note

User Contributed Notes

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