Passed
Pull Request — main (#308)
by Paul
13:29 queued 06:46
created

TimeFrame   A

Complexity

Total Complexity 7

Size/Duplication

Total Lines 49
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 9
dl 0
loc 49
rs 10
c 1
b 0
f 0
wmc 7
1
<?php
2
3
/**
4
 * Copyright 2016 SURFnet bv
5
 *
6
 * Licensed under the Apache License, Version 2.0 (the "License");
7
 * you may not use this file except in compliance with the License.
8
 * You may obtain a copy of the License at
9
 *
10
 *     http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing, software
13
 * distributed under the License is distributed on an "AS IS" BASIS,
14
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
 * See the License for the specific language governing permissions and
16
 * limitations under the License.
17
 */
0 ignored issues
show
Coding Style introduced by
PHP version not specified
Loading history...
Coding Style introduced by
Missing @category tag in file comment
Loading history...
Coding Style introduced by
Missing @package tag in file comment
Loading history...
Coding Style introduced by
Missing @author tag in file comment
Loading history...
Coding Style introduced by
Missing @license tag in file comment
Loading history...
Coding Style introduced by
Missing @link tag in file comment
Loading history...
18
19
namespace Surfnet\StepupSelfService\SelfServiceBundle\Value;
20
21
use DateInterval;
22
use Surfnet\StepupSelfService\SelfServiceBundle\Exception\InvalidArgumentException;
23
24
final readonly class TimeFrame implements \Stringable
0 ignored issues
show
Bug introduced by
A parse error occurred: Syntax error, unexpected T_READONLY, expecting T_CLASS on line 24 at column 6
Loading history...
Coding Style introduced by
Missing doc comment for class TimeFrame
Loading history...
25
{
26
    final private function __construct(private DateInterval $timeFrame)
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function __construct()
Loading history...
27
    {
28
    }
29
30
    /**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
31
     * @param int $seconds
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
32
     * @return TimeFrame
0 ignored issues
show
Coding Style introduced by
Tag @return cannot be grouped with parameter tags in a doc comment
Loading history...
33
     */
34
    public static function ofSeconds($seconds): self
35
    {
36
        if (!is_int($seconds) || $seconds < 1) {
37
            throw InvalidArgumentException::invalidType('positive integer', 'seconds', $seconds);
38
        }
39
40
        return new TimeFrame(new DateInterval('PT' . $seconds . 'S'));
41
    }
42
43
    /**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
Coding Style introduced by
Parameter $dateTime should have a doc-comment as per coding-style.
Loading history...
44
     * @return DateTime
45
     */
46
    public function getEndWhenStartingAt(DateTime $dateTime): \Surfnet\StepupSelfService\SelfServiceBundle\Value\DateTime
47
    {
48
        return $dateTime->add($this->timeFrame);
49
    }
50
51
    /**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
Coding Style introduced by
Parameter $other should have a doc-comment as per coding-style.
Loading history...
52
     * @return bool
53
     */
54
    public function equals(TimeFrame $other): bool
55
    {
56
        return $this->timeFrame->s === $other->timeFrame->s;
57
    }
58
59
    public function __toString(): string
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function __toString()
Loading history...
60
    {
61
        return $this->timeFrame->format('%S');
62
    }
63
}
64