trait Units

Trait Units.

Add, subtract and set units.

Methods

addRealUnit(string$unit,int$value =1)

Add seconds to the instance using timestamp. Positive $value travels forward while negative $value travels into the past.

subRealUnit($unit,$value =1)

No description

static bool
isModifiableUnit(string$unit)

Returns true if a property can be changed via setter.

rawAdd(DateInterval$interval)

Call native PHP DateTime/DateTimeImmutable add() method.

add($unit,$value =1,$overflow =null)

No description

addUnit(string$unit,int$value =1,bool|null$overflow =null)

Add given units to the current instance.

subUnit(string$unit,int$value =1,bool|null$overflow =null)

Subtract given units to the current instance.

rawSub(DateInterval$interval)

Call native PHP DateTime/DateTimeImmutable sub() method.

sub($unit,$value =1,$overflow =null)

No description

subtract(string|DateInterval$unit,int$value =1,bool|null$overflow =null)

Subtract given units or interval to the current instance.

Details

at line38
Units addRealUnit(string$unit,int$value =1)

Add seconds to the instance using timestamp. Positive $value travels forward while negative $value travels into the past.

Parameters

string $unit
int $value

Return Value

Units

at line139
subRealUnit($unit,$value =1)

Parameters

$unit
$value

at line151
staticbool isModifiableUnit(string$unit)

Returns true if a property can be changed via setter.

Parameters

string $unit

Return Value

bool

at line178
Units rawAdd(DateInterval$interval)

Call native PHP DateTime/DateTimeImmutable add() method.

Parameters

DateInterval $interval

Return Value

Units

at line197
add($unit,$value =1,$overflow =null)

Parameters

$unit
$value
$overflow

at line231
Units addUnit(string$unit,int$value =1,bool|null$overflow =null)

Add given units to the current instance.

Parameters

string $unit
int $value
bool|null $overflow

Return Value

Units

at line329
Units subUnit(string$unit,int$value =1,bool|null$overflow =null)

Subtract given units to the current instance.

Parameters

string $unit
int $value
bool|null $overflow

Return Value

Units

at line341
Units rawSub(DateInterval$interval)

Call native PHP DateTime/DateTimeImmutable sub() method.

Parameters

DateInterval $interval

Return Value

Units

at line360
sub($unit,$value =1,$overflow =null)

Parameters

$unit
$value
$overflow

at line396
Units subtract(string|DateInterval$unit,int$value =1,bool|null$overflow =null)

Subtract given units or interval to the current instance.

Parameters

string|DateInterval $unit
int $value
bool|null $overflow

Return Value

Units

See also

sub()