bytic / utility

src/Time/Duration.php

<?php

namespace Nip\Utility\Time;

/**
 * Class Duration
 * @package Nip\Utility\Time
 */
class Duration
{
    protected $value = null;
    protected $parts = null;
    protected $seconds = null;

    /**
     * Duration constructor.
     *
     * @param $duration
     */
    public function __construct($duration)
    {
        if (is_numeric($duration)) {
            $this->setSeconds($duration);
        }
        if (is_string($duration)) {
            $this->setValue($duration);
            $this->parseSeconds();
        }
    }

    /**
     * @param null $value

Are you sure the doc-type for parameter $value is correct as it would always require null to be passed?

     */
    public function setValue($value)
    {
        $this->value = $value;
    }

    public function parseSeconds()
    {
        $parts = $this->getParts();
        if (count($parts) == 3) {
            $seconds = 0;
            $seconds += $parts['h'] * 3600;
            $seconds += $parts['m'] * 60;
            $seconds += $parts['s'];
            $this->setSeconds($seconds);
        }
    }

    /**
     * @return []

The doc comment [] at position 0 could not be parsed: Unknown type name '[' at position 0 in [].

     */
    public function getParts()
    {
        if ($this->parts === null) {
            $this->parseParts();
        }

        return $this->parts;
    }

    /**
     * @param array $parts
     */
    public function setParts($parts)
    {
        $this->parts = $parts;
    }

    public function parseParts()
    {
        $this->parts = [];
        if ($this->value && substr_count($this->value, ':') == 2) {
            $this->parsePartsFromString();

            return;
        }
        if ($this->seconds > 0) {
            $this->parsePartsFromSeconds();

            return;
        }
    }

    public function parsePartsFromString()
    {
        list($hours, $minutes, $seconds) = explode(':', $this->value);

        $this->setHoursPart($hours);
        $this->setMinutesPart($minutes);
        $this->setSecondsPart($seconds);
    }

    /**
     * @param   string  $value
     */
    public function setHoursPart($value)
    {
        $this->setPart('h', $value);
    }

    /**
     * @param string $p
     * @param string $v
     */
    public function setPart($p, $v)
    {
        $this->parts[$p] = $v;
    }

    /**
     * @param string $v
     */
    public function setMinutesPart($v)
    {
        $this->setPart('m', $v);
    }

    /**
     * @param string $v
     */
    public function setSecondsPart($v)
    {
        $this->setPart('s', $v);
    }

    /**
     * @param $v
     */
    public function setMicroPart($v)
    {
        $this->setPart('ms', $v);
    }

    public function parsePartsFromSeconds()
    {
        $seconds = $this->getSeconds();
        if ($hours = intval((floor($seconds / 3600)))) {
            $seconds = $seconds - $hours * 3600;
        }

        $this->setHoursPart($hours);

        if ($minutes = intval((floor($seconds / 60)))) {
            $seconds = $seconds - $minutes * 60;
        }

        $this->setMinutesPart($minutes);

        $seconds = round($seconds, 2);
        $this->setSecondsPart(intval($seconds));

        $micro = round($seconds - intval($seconds), 2);
        $this->setMicroPart($micro);
    }

    /**
     * @return double
     */
    public function getSeconds()
    {
        if ($this->seconds === null) {
            $this->parseSeconds();
        }

        return $this->seconds;
    }

    /**
     * @param null $seconds

Are you sure the doc-type for parameter $seconds is correct as it would always require null to be passed?

     */
    public function setSeconds($seconds)
    {
        $this->seconds = $seconds;
    }

    /**
     * @return string
     */
    public function getHoursPart()
    {
        return $this->getPart('h');
    }

    /**
     * @param   string  $part
     * @param   int     $default
     *
     * @return int|mixed
     */
    public function getPart($part, $default = 0)
    {
        if ($this->parts === null) {
            $this->parseParts();
        }

        return isset($this->parts[$part]) ? $this->parts[$part] : $default;
    }

    /**
     * @return string
     */
    public function getMinutesPart()
    {
        return $this->getPart('m');
    }

    /**
     * @return string
     */
    public function getSecondsPart()
    {
        return $this->getPart('s');
    }

    /**
     * @return string
     */
    public function getMicroPart()
    {
        return $this->getPart('ms');
    }

    /**
     * @return string
     */
    public function getDefaultString()
    {
        $hours   = str_pad($this->getHoursPart(), 2, 0, STR_PAD_LEFT);
        $minutes = str_pad($this->getMinutesPart(), 2, 0, STR_PAD_LEFT);
        $seconds = str_pad($this->getSecondsPart(), 2, 0, STR_PAD_LEFT);
        $micro   = str_pad(str_replace('0.', '', $this->getMicroPart()), 2, 0, STR_PAD_LEFT);
        return $hours . ':' . $minutes . ':' . $seconds . '.' . $micro;
    }

    /**
     * @return string
     */
    public function getHTML()
    {
        $return = '<time>';

        $hours = str_pad($this->getHoursPart(), 2, 0, STR_PAD_LEFT);
        $return .= '<span class="hour">' . $hours . '</span>';

        $minutes = str_pad($this->getMinutesPart(), 2, 0, STR_PAD_LEFT);
        $return .= '<span class="separator">:</span>';
        $return .= '<span class="minutes">' . $minutes . '</span>';

        $seconds = str_pad($this->getSecondsPart(), 2, 0, STR_PAD_LEFT);
        $return .= '<span class="separator">:</span>';
        $return .= '<span class="seconds">' . $seconds . '</span>';

        $micro = str_replace('0.', '', $this->getMicroPart());
        $return .= '<span class="micro">.' . $micro . '</span>';

        $return .= '</time>';

        return $return;
    }

    /**
     * @return string
     */
    public function getFormatedString()
    {
        $return = '';

        $hours = $this->getHoursPart();
        if ($hours or $return) {
            $return .= ($return ? ' ' : '') . str_pad($hours, 2, 0, STR_PAD_LEFT) . 'h';
        }

        $minutes = $this->getMinutesPart();
        if ($minutes or $return) {
            $return .= ($return ? ' ' : '') . str_pad($minutes, 2, 0, STR_PAD_LEFT) . 'm';
        }

        $seconds = $this->getSecondsPart();
        if ($seconds) {
            $return .= ($return ? ' ' : '') . str_pad($seconds, 2, 0, STR_PAD_LEFT) . 's';
        }

        return $return;
    }
}