Surfnet\StepupSelfService\SelfServiceBundle\Value\TimeFrame

Complexity

Total Complexity

7

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
use Surfnet\StepupSelfService\SelfServiceBundle\Exception\InvalidArgumentException;
use Stringable;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\DateTime;

final readonly class TimeFrame implements Stringable

Missing doc comment for class TimeFrame

A parse error occurred: Syntax error, unexpected T_READONLY, expecting T_CLASS on line 28 at column 6

{
    final private function __construct(private DateInterval $timeFrame)

Missing doc comment for function __construct()

    {
    }

    /**

Missing short description in doc comment

     * @param int $seconds

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return TimeFrame

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function ofSeconds($seconds): self
    {
        if (!is_int($seconds) || $seconds < 1) {
            throw InvalidArgumentException::invalidType('positive integer', 'seconds', $seconds);
        }

        return new TimeFrame(new DateInterval('PT' . $seconds . 'S'));
    }

    /**

Missing short description in doc comment

Parameter $dateTime should have a doc-comment as per coding-style.

     * @return DateTime
     */
    public function getEndWhenStartingAt(DateTime $dateTime): DateTime
    {
        return $dateTime->add($this->timeFrame);
    }

    /**

Missing short description in doc comment

Parameter $other should have a doc-comment as per coding-style.

     * @return bool
     */
    public function equals(TimeFrame $other): bool
    {
        return $this->timeFrame->s === $other->timeFrame->s;
    }

    public function __toString(): string

Missing doc comment for function __toString()

    {
        return $this->timeFrame->format('%S');
    }
}