duration/duration-php

Time duration class

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

This package is auto-updated.

Last update: 2024-09-18 07:24:07 UTC


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

  • 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

Makefile

  • make test runs unit tests