TimeUnit.php

<?php
/*
 * Copyright (c) 2012 Janos Szurovecz
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace precore\util\concurrent;

use DateInterval;
use precore\lang\Enum;
use precore\lang\IllegalStateException;
use precore\util\Preconditions;

class TimeUnit extends Enum
{
    const C0 = 1;
    const C1 = 1000;
    const C2 = 1000000;
    const C3 = 60000000;
    const C4 = 3600000000;
    const C5 = 86400000000;

    /**
     * Does not support toDateInterval()
     *
     * @var TimeUnit
     */
    public static $MICROSECONDS;

    /**
     * Does not support toDateInterval()
     *
     * @var TimeUnit
     */
    public static $MILLISECONDS;

    /**
     * @var TimeUnit
     */
    public static $SECONDS;

    /**
     * @var TimeUnit
     */
    public static $MINUTES;

    /**
     * @var TimeUnit
     */
    public static $HOURS;

    /**
     * @var TimeUnit
     */
    public static $DAYS;

    private $inMicros;
    private $dateIntervalFormat;

    protected static function constructorArgs()
    {
        return [
            'MICROSECONDS' => [self::C0, null],
            'MILLISECONDS' => [self::C1, null],
            'SECONDS' => [self::C2, 'PT%dS'],
            'MINUTES' => [self::C3, 'PT%dM'],
            'HOURS' => [self::C4, 'PT%dH'],
            'DAYS' => [self::C5, 'P%dD']
        ];
    }

    /**
     * @param $inMicros float The amount of microseconds of this unit.
     * @param $dateIntervalFormat string the format character for DateInterval
     */
    protected function __construct($inMicros, $dateIntervalFormat)
    {
        $this->inMicros = $inMicros;
        $this->dateIntervalFormat = $dateIntervalFormat;
    }

    /**
     * Equivalent to TimeUnit::$MICROSECONDS->convert($duration, $this).
     *
     * @param $duration float
     * @return float
     */
    public function toMicros($duration)
    {
        return TimeUnit::$MICROSECONDS->convert($duration, $this);
    }

    /**
     * Equivalent to TimeUnit::$MILLISECONDS->convert($duration, $this).
     *
     * @param $duration float
     * @return float
     */
    public function toMillis($duration)
    {
        return TimeUnit::$MILLISECONDS->convert($duration, $this);
    }

    /**
     * Equivalent to TimeUnit::$SECONDS->convert(duration, $this).
     *
     * @param $duration float
     * @return float
     */
    public function toSeconds($duration)
    {
        return TimeUnit::$SECONDS->convert($duration, $this);
    }

    /**
     * Equivalent to TimeUnit::$MINUTES->convert(duration, $this).
     *
     * @param $duration float
     * @return float
     */
    public function toMinutes($duration)
    {
        return TimeUnit::$MINUTES->convert($duration, $this);
    }

    /**
     * Equivalent to TimeUnit::$HOURS->convert(duration, $this).
     *
     * @param $duration float
     * @return float
     */
    public function toHours($duration)
    {
        return TimeUnit::$HOURS->convert($duration, $this);
    }

    /**
     * Equivalent to TimeUnit::$DAYS->convert($duration, $this).
     *
     * @param $duration float
     * @return float
     */
    public function toDays($duration)
    {
        return TimeUnit::$DAYS->convert($duration, $this);
    }

    /**
     * Creates a DateInterval with the given duration and this unit.
     *
     * @param $duration int
     * @throws IllegalStateException if this object does not have proper DateInterval format string
     * @return DateInterval
     */
    public function toDateInterval($duration)
    {
        Preconditions::checkState($this->dateIntervalFormat !== null, '[%s] does not support toDateInterval()', $this);
        return new DateInterval(sprintf($this->dateIntervalFormat, $duration));
    }

    /**
     * Convert the given time duration in the given unit to this unit.
     *
     * For example, to convert 10 minutes to milliseconds, use: TimeUnit::$MILLISECONDS->convert(10, TimeUnit::$MINUTES)
     *
     * @param $duration float The time duration in the given sourceUnit
     * @param TimeUnit $timeUnit the unit of the sourceDuration argument
     * @return float the converted duration in this unit
     */
    public function convert($duration, TimeUnit $timeUnit)
    {
        return $duration * ($timeUnit->inMicros / $this->inMicros);
    }

    /**
     * Sleeps the process using this TimeUnit.
     *
     * @param $duration
     */
    public function sleep($duration)
    {
        usleep($this->toMicros($duration));
    }
}
TimeUnit::init();