Documentation

DatePoint extends DateTimeImmutable
in package

FinalYes

An immmutable DateTime with stricter error handling and return types than the native one.

Tags
author

Nicolas Grekas p@tchwork.com

Table of Contents

Methods

__construct()  : mixed
add()  : static
createFromFormat()  : static
createFromInterface()  : static
createFromMutable()  : static
createFromTimestamp()  : static
getMicrosecond()  : int
getTimezone()  : DateTimeZone
modify()  : static
setDate()  : static
setISODate()  : static
setMicrosecond()  : static
setTime()  : static
setTimestamp()  : static
setTimezone()  : static
sub()  : static

Methods

__construct()

public __construct([string $datetime = 'now' ][, DateTimeZone|null $timezone = null ][, parent|null $reference = null ]) : mixed
Parameters
$datetime : string = 'now'
$timezone : DateTimeZone|null = null
$reference : parent|null = null
Tags
throws
DateMalformedStringException

When $datetime is invalid

add()

public add(DateInterval $interval) : static
Parameters
$interval : DateInterval
Return values
static

createFromFormat()

public static createFromFormat(string $format, string $datetime[, DateTimeZone|null $timezone = null ]) : static
Parameters
$format : string
$datetime : string
$timezone : DateTimeZone|null = null
Tags
throws
DateMalformedStringException

When $format or $datetime are invalid

Return values
static

createFromInterface()

public static createFromInterface(DateTimeInterface $object) : static
Parameters
$object : DateTimeInterface
Return values
static

createFromMutable()

public static createFromMutable(DateTime $object) : static
Parameters
$object : DateTime
Return values
static

createFromTimestamp()

public static createFromTimestamp(int|float $timestamp) : static
Parameters
$timestamp : int|float
Return values
static

getMicrosecond()

public getMicrosecond() : int
Return values
int

getTimezone()

public getTimezone() : DateTimeZone
Return values
DateTimeZone

setDate()

public setDate(int $year, int $month, int $day) : static
Parameters
$year : int
$month : int
$day : int
Return values
static

setISODate()

public setISODate(int $year, int $week[, int $day = 1 ]) : static
Parameters
$year : int
$week : int
$day : int = 1
Return values
static

setMicrosecond()

public setMicrosecond(int $microsecond) : static
Parameters
$microsecond : int
Return values
static

setTime()

public setTime(int $hour, int $minute[, int $second = 0 ][, int $microsecond = 0 ]) : static
Parameters
$hour : int
$minute : int
$second : int = 0
$microsecond : int = 0
Return values
static

setTimestamp()

public setTimestamp(int $value) : static
Parameters
$value : int
Return values
static

setTimezone()

public setTimezone(DateTimeZone $timezone) : static
Parameters
$timezone : DateTimeZone
Return values
static

sub()

public sub(DateInterval $interval) : static
Parameters
$interval : DateInterval
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results