duration/duration-php

Time duration class

v0.0.7 2023-05-18 04:07 UTC

Requires

• php: >=8.2
• ext-posix: *

Requires (Dev)

• phpunit/phpunit: ^10.1

MIT

• Daniel Berstein

README

Duration is a class to abstract time durations

Installation

composer require duration/duration-php

Usage

require __DIR__ . '/vendor/autoload.php';
use Duration\Duration;
$d = Duration::parse("1h59m59s999ms999us999ns");
$d->add(Duration::parse("1ns"));
echo $d; // prints "2h"

Methods

• Duration::parse(): creates new instance by parsing string like Go

  $d = Duration::parse("+1h59m59s999ms999us999ns")

• new / constructor: creates new instance

  $d = new Duration([$n=0, [$multiplier=1]) $d = new Duration(); // 0 nanoseconds $d = new Duration(1); // 1 nanosecond $d = new Duration(1, Duration::Millisecond); // 1000000 nanoseconds

Convenience multipliers	Example	Nanoseconds
Duration::Nanosecond	new Duration(1, Duration::Nanosecond)	1
Duration::Microsecond	new Duration(1, Duration::Microsecond)	1000
Duration::Millisecond	new Duration(1, Duration::Millisecond)	1000000
Duration::Second	new Duration(1, Duration::Second)	1000000000
Duration::Minute	new Duration(1, Duration::Minute)	60000000000
Duration::Hour	new Duration(1, Duration::Hour)	3600000000000

• add(Duration): adds duration to $d

  $q = Duration::parse("1m"); $d->add($q) -> Duration

• sub(Duration): subtracts duration from $d

  $q = Duration::parse("1m"); $d->sub($q) -> Duration

• truncate(Duration): rounds to nearest duration

  $q = Duration::parse("5m"); $d->truncate($q) -> Duration

• abs(): returns absolute duration

  Note: same as Go's time#Duration.Abs(), abs of duration for PHP_MIN_INT returns duration for PHP_MAX_INT and viceversa.

  $d->abs() -> Duration

Time duration properties

method	returns
$d->hours()	float
$d->minutes()	float
$d->seconds()	float
$d->microseconds()	float
$d->nanoseconds()	int

Makefile

• make test runs unit tests