TimeRange::fromArray() - Code Metrics - Inspection of "Merge pull request #84 from spatie/version-2.0" - spatie/opening-hours - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f6c114...c14204 )

by Kyle

created 2018-12-13 07:59 UTC

TimeRange::fromArray() A

↳ Parent: TimeRange

Complexity

Conditions	5
Paths	12

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	9.2408
c	0
b	0
f	0
cc	5
nc	12
nop	1

<?php

namespace Spatie\OpeningHours;

use Spatie\OpeningHours\Helpers\DataTrait;
use Spatie\OpeningHours\Exceptions\InvalidTimeRangeList;
use Spatie\OpeningHours\Exceptions\InvalidTimeRangeArray;
use Spatie\OpeningHours\Exceptions\InvalidTimeRangeString;

class TimeRange
{
    use DataTrait;

    /** @var \Spatie\OpeningHours\Time */
    protected $start;

    /** @var \Spatie\OpeningHours\Time */
    protected $end;

    protected function __construct(Time $start, Time $end)
    {
        $this->start = $start;
        $this->end = $end;
    }

    public static function fromString(string $string): self
    {
        $times = explode('-', $string);

        if (count($times) !== 2) {
            throw InvalidTimeRangeString::forString($string);
        }

        return new self(Time::fromString($times[0]), Time::fromString($times[1]));
    }

    public static function fromArray(array $array): self
    {
        $values = [];
        $keys = ['hours', 'data'];

        foreach ($keys as $key) {
            if (isset($array[$key])) {
                $values[] = $array[$key];
                unset($array[$key]);
            }
        }

        if (count($array)) {
            array_push($values, ...$array);
        }
        list($hours, $data) = array_pad($values, count($keys), null);

        if (! $hours) {
            throw InvalidTimeRangeArray::create();
        }

        return static::fromString($hours)->setData($data);
    }

    public static function fromDefinition($value): self
    {
        return is_array($value) ? static::fromArray($value) : static::fromString($value);
    }

    public static function fromList(array $ranges): self
    {
        if (count($ranges) === 0) {
            throw InvalidTimeRangeList::create();
        }

        foreach ($ranges as $range) {
            if (! ($range instanceof self)) {
                throw InvalidTimeRangeList::create();
            }
        }

        $start = $ranges[0]->start();
        $end = $ranges[0]->end();

        foreach (array_slice($ranges, 1) as $range) {
            $rangeStart = $range->start();
            if ($rangeStart->format('Gi') < $start->format('Gi')) {
                $start = $rangeStart;
            }
            $rangeEnd = $range->end();
            if ($rangeEnd->format('Gi') > $end->format('Gi')) {
                $end = $rangeEnd;
            }
        }

        return new self($start, $end);
    }

    public function start(): Time
    {
        return $this->start;
    }

    public function end(): Time
    {
        return $this->end;
    }

    public function spillsOverToNextDay(): bool
    {
        return $this->end->isBefore($this->start);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function containsTime(Time $time): bool
    {
        if ($this->spillsOverToNextDay()) {
            if ($time->isSameOrAfter($this->start)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return $time->isAfter($this->end);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            return $time->isBefore($this->end);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return $time->isSameOrAfter($this->start) && $time->isBefore($this->end);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function overlaps(self $timeRange): bool
    {
        return $this->containsTime($timeRange->start) || $this->containsTime($timeRange->end);
    }

    public function format(string $timeFormat = 'H:i', string $rangeFormat = '%s-%s'): string
    {
        return sprintf($rangeFormat, $this->start->format($timeFormat), $this->end->format($timeFormat));
    }

    public function __toString(): string
    {
        return $this->format();
    }
}


1			<?php
2
3			namespace Spatie\OpeningHours;
4
5			use Spatie\OpeningHours\Helpers\DataTrait;
6			use Spatie\OpeningHours\Exceptions\InvalidTimeRangeList;
7			use Spatie\OpeningHours\Exceptions\InvalidTimeRangeArray;
8			use Spatie\OpeningHours\Exceptions\InvalidTimeRangeString;
9
10			class TimeRange
11			{
12			use DataTrait;
13
14			/** @var \Spatie\OpeningHours\Time */
15			protected $start;
16
17			/** @var \Spatie\OpeningHours\Time */
18			protected $end;
19
20			protected function __construct(Time $start, Time $end)
21			{
22			$this->start = $start;
23			$this->end = $end;
24			}
25
26			public static function fromString(string $string): self
27			{
28			$times = explode('-', $string);
29
30			if (count($times) !== 2) {
31			throw InvalidTimeRangeString::forString($string);
32			}
33
34			return new self(Time::fromString($times[0]), Time::fromString($times[1]));
35			}
36
37			public static function fromArray(array $array): self
38			{
39			$values = [];
40			$keys = ['hours', 'data'];
41
42			foreach ($keys as $key) {
43			if (isset($array[$key])) {
44			$values[] = $array[$key];
45			unset($array[$key]);
46			}
47			}
48
49			if (count($array)) {
50			array_push($values, ...$array);
51			}
52			list($hours, $data) = array_pad($values, count($keys), null);
53
54			if (! $hours) {
55			throw InvalidTimeRangeArray::create();
56			}
57
58			return static::fromString($hours)->setData($data);
59			}
60
61			public static function fromDefinition($value): self
62			{
63			return is_array($value) ? static::fromArray($value) : static::fromString($value);
64			}
65
66			public static function fromList(array $ranges): self
67			{
68			if (count($ranges) === 0) {
69			throw InvalidTimeRangeList::create();
70			}
71
72			foreach ($ranges as $range) {
73			if (! ($range instanceof self)) {
74			throw InvalidTimeRangeList::create();
75			}
76			}
77
78			$start = $ranges[0]->start();
79			$end = $ranges[0]->end();
80
81			foreach (array_slice($ranges, 1) as $range) {
82			$rangeStart = $range->start();
83			if ($rangeStart->format('Gi') < $start->format('Gi')) {
84			$start = $rangeStart;
85			}
86			$rangeEnd = $range->end();
87			if ($rangeEnd->format('Gi') > $end->format('Gi')) {
88			$end = $rangeEnd;
89			}
90			}
91
92			return new self($start, $end);
93			}
94
95			public function start(): Time
96			{
97			return $this->start;
98			}
99
100			public function end(): Time
101			{
102			return $this->end;
103			}
104
105			public function spillsOverToNextDay(): bool
106			{
107			return $this->end->isBefore($this->start);
			0 ignored issues – show Documentation introduced 2017-11-09 10:47 UTC by Report Bug Copy Issue Report `$this->start` is of type `object<Spatie\OpeningHours\Time>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
108			}
109
110			public function containsTime(Time $time): bool
111			{
112			if ($this->spillsOverToNextDay()) {
113			if ($time->isSameOrAfter($this->start)) {
			0 ignored issues – show Documentation introduced 2018-10-02 12:17 UTC by Report Bug Copy Issue Report `$this->start` is of type `object<Spatie\OpeningHours\Time>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
114			return $time->isAfter($this->end);
			0 ignored issues – show Documentation introduced 2017-11-09 10:47 UTC by Report Bug Copy Issue Report `$this->end` is of type `object<Spatie\OpeningHours\Time>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
115			}
116
117			return $time->isBefore($this->end);
			0 ignored issues – show Documentation introduced 2017-11-09 10:47 UTC by Report Bug Copy Issue Report `$this->end` is of type `object<Spatie\OpeningHours\Time>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
118			}
119
120			return $time->isSameOrAfter($this->start) && $time->isBefore($this->end);
			0 ignored issues – show Documentation introduced 2017-11-09 10:47 UTC by Report Bug Copy Issue Report `$this->start` is of type `object<Spatie\OpeningHours\Time>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2017-11-09 10:47 UTC by Report Bug Copy Issue Report `$this->end` is of type `object<Spatie\OpeningHours\Time>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
121			}
122
123			public function overlaps(self $timeRange): bool
124			{
125			return $this->containsTime($timeRange->start) \|\| $this->containsTime($timeRange->end);
126			}
127
128			public function format(string $timeFormat = 'H:i', string $rangeFormat = '%s-%s'): string
129			{
130			return sprintf($rangeFormat, $this->start->format($timeFormat), $this->end->format($timeFormat));
131			}
132
133			public function __toString(): string
134			{
135			return $this->format();
136			}
137			}
138

spatie / opening-hours

GitHub Access Token became invalid

Push — master ( f6c114...c14204 )

TimeRange::fromArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like