Sequence::boundaries() - Code Metrics - Inspection of "Feature/adding method sequence substract" - thephpleague/period - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#81)

unknown

created 2019-03-18 15:53 UTC

Sequence::boundaries() A

↳ Parent: Sequence

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	8
ccs	5
cts	5
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?php

/**
 * League.Period (https://period.thephpleague.com)
 *
 * (c) Ignace Nyamagana Butera <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace League\Period;

use ArrayAccess;
use Countable;
use Iterator;
use IteratorAggregate;
use JsonSerializable;
use function array_filter;
use function array_merge;
use function array_splice;
use function array_unshift;
use function array_values;
use function count;
use function reset;
use function sort;
use function sprintf;
use function uasort;
use function usort;
use const ARRAY_FILTER_USE_BOTH;

/**
 * A class to manipulate interval collection.
 *
 * @package League.period
 * @author  Ignace Nyamagana Butera <[email protected]>
 * @since   4.1.0
 */
final class Sequence implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
{
    /**
     * @var Period[]
     */
    private $intervals = [];

    /**
     * new instance.
     *
     * @param Period ...$intervals
     */
    public function __construct(Period ...$intervals)
    {
        $this->intervals = $intervals;
    }

    /**
     * Returns the sequence boundaries as a Period instance.
     *
     * If the sequence contains no interval null is returned.
     *
     * @return ?Period
     */
    public function boundaries(): ?Period
    {
        $period = reset($this->intervals);
        if (false === $period) {
            return null;
        }

        return $period->merge(...$this->intervals);
    }

    /**
     * Returns the gaps inside the instance.
     */
    public function gaps(): self
    {
        $sequence = new self();
        $interval = null;
        foreach ($this->sorted([$this, 'sortByStartDate']) as $period) {
            if (null === $interval) {
                $interval = $period;
                continue;
            }

            if (!$interval->overlaps($period) && !$interval->abuts($period)) {
                $sequence->push($interval->gap($period));
            }

            if (!$interval->contains($period)) {
                $interval = $period;
            }
        }

        return $sequence;
    }

    /**
     * Sorts two Interval instance using their start datepoint.
     */
    private function sortByStartDate(Period $interval1, Period $interval2): int
    {
        return $interval1->getStartDate() <=> $interval2->getStartDate();
    }

    /**
     * Returns the intersections inside the instance.
     */
    public function substract(Sequence $subIntervals): self
    {
        if (count($this) == 0) {
            return new self();
        } else if (count($subIntervals) == 0) {
            return $this;
        } else if (count($this) == 1 && count($subIntervals) == 1) {
            return $this->get(0)->substract($subIntervals->get(0));
        } else if (count($this) > 1) {
            $diffSequences = [];
            foreach ($this->intervals as $intervalA) {
                $tmpSequence = new self($intervalA);
                $diffSequences[] = $tmpSequence->substract($subIntervals);
            }

            $newSequence = new self();
            foreach ($diffSequences as $diffSequence) {
                foreach ($diffSequence as $sequence) {
                    $newSequence->push($sequence);
                }
            }

            return $newSequence;
        } else if (count($this) == 1 && count($subIntervals) > 1) {
            $newSequence = new self($this->get(0));
            foreach ($subIntervals as $subInterval) {
                $tmpSequence = new self($subInterval);
                $newSequence = $newSequence->substract($tmpSequence);
            }

            return $newSequence;
        }

        return new self();
    }

    /**
     * Returns the intersections inside the instance.
     */
    public function intersections(): self
    {
        $sequence = new self();
        $current = null;
        $isPreviouslyContained = false;
        foreach ($this->sorted([$this, 'sortByStartDate']) as $period) {
            if (null === $current) {
                $current = $period;
                continue;
            }

            $isContained = $current->contains($period);
            if ($isContained && $isPreviouslyContained) {
                continue;
            }

            if ($current->overlaps($period)) {
                $sequence->push($current->intersect($period));
            }

            $isPreviouslyContained = $isContained;
            if (!$isContained) {
                $current = $period;
            }
        }

        return $sequence;
    }

    /**
     * Returns the unions inside the instance.
     */
    public function unions(): self
    {
        $sequence = $this
            ->sorted([$this, 'sortByStartDate'])
            ->reduce([$this, 'calculateUnion'], new self())
        ;

        if ($sequence->intervals === $this->intervals) {
            return $this;
        }

        return $sequence;
    }

    /**
     * Iteratively calculate the union sequence.
     */
    private function calculateUnion(Sequence $sequence, Period $period): Sequence
    {
        if ($sequence->isEmpty()) {
            $sequence->push($period);

            return $sequence;
        }

        $index = $sequence->count() - 1;
        $interval = $sequence->get($index);
        if ($interval->overlaps($period) || $interval->abuts($period)) {
            $sequence->set($index, $interval->merge($period));

            return $sequence;
        }

        $sequence->push($period);

        return $sequence;
    }

    /**
     * Returns the sequence boundaries as a Period instance.
     *
     * DEPRECATION WARNING! This method will be removed in the next major point release
     *
     * @deprecated deprecated since version 4.4.0
     * @see        ::boundaries
     *
     * If the sequence contains no interval null is returned.
     *
     * @return ?Period
     */
    public function getBoundaries(): ?Period
    {
        return $this->boundaries();
    }

    /**
     * Returns the intersections inside the instance.
     *
     * DEPRECATION WARNING! This method will be removed in the next major point release
     *
     * @deprecated deprecated since version 4.4.0
     * @see        ::intersections
     */
    public function getIntersections(): self
    {
        return $this->intersections();
    }

    /**
     * Returns the gaps inside the instance.
     *
     * DEPRECATION WARNING! This method will be removed in the next major point release
     *
     * @deprecated deprecated since version 4.4.0
     * @see        ::gaps
     */
    public function getGaps(): self
    {
        return $this->gaps();
    }

    /**
     * Returns the sum of all instances durations as expressed in seconds.
     */
    public function getTotalTimestampInterval(): float
    {
        $retval = 0;
        foreach ($this->intervals as $interval) {
            $retval += $interval->getTimestampInterval();
        }

        return $retval;
    }

    /**
     * Tells whether some intervals in the current instance satisfies the predicate.
     */
    public function some(callable $predicate): bool
    {
        foreach ($this->intervals as $offset => $interval) {
            if (true === $predicate($interval, $offset)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Tells whether all intervals in the current instance satisfies the predicate.
     */
    public function every(callable $predicate): bool
    {
        foreach ($this->intervals as $offset => $interval) {
            if (true !== $predicate($interval, $offset)) {
                return false;
            }
        }

        return [] !== $this->intervals;
    }

    /**
     * Returns the array representation of the sequence.
     *
     * @return Period[]
     */
    public function toArray(): array
    {
        return $this->intervals;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize(): array
    {
        return $this->intervals;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): Iterator
    {
        foreach ($this->intervals as $offset => $interval) {
            yield $offset => $interval;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return count($this->intervals);
    }

    /**
     * @inheritdoc
     *
     * @param int $offset
     */
    public function offsetExists($offset): bool
    {
        return isset($this->intervals[$offset]);
    }

    /**
     * @inheritdoc
     *
     * @param int $offset
     */
    public function offsetGet($offset): Period
    {
        return $this->get($offset);
    }

    /**
     * @inheritdoc
     *
     * @param int $offset
     */
    public function offsetUnset($offset): void
    {
        $this->remove($offset);
    }

    /**
     * @inheritdoc
     *
     * @param mixed|int $offset
     * @param Period    $interval
     */
    public function offsetSet($offset, $interval): void
    {
        if (null !== $offset) {
            $this->set($offset, $interval);
            return;
        }

        $this->push($interval);
    }

    /**
     * Tells whether the sequence is empty.
     */
    public function isEmpty(): bool
    {
        return [] === $this->intervals;
    }

    /**
     * Tells whether the given interval is present in the sequence.
     *
     * @param Period ...$intervals
     */
    public function contains(Period $interval, Period ...$intervals): bool
    {
        $intervals[] = $interval;
        foreach ($intervals as $period) {
            if (false === $this->indexOf($period)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Attempts to find the first offset attached to the submitted interval.
     *
     * If no offset is found the method returns boolean false.
     *
     * @return int|bool
     */
    public function indexOf(Period $interval)
    {
        foreach ($this->intervals as $offset => $period) {
            if ($period->equals($interval)) {
                return $offset;
            }
        }

        return false;
    }

    /**
     * Returns the interval specified at a given offset.
     *
     * @throws InvalidIndex If the offset is illegal for the current sequence
     */
    public function get(int $offset): Period
    {
        $period = $this->intervals[$offset] ?? null;
        if (null !== $period) {
            return $period;
        }

        throw new InvalidIndex(sprintf('%s is an invalid offset in the current sequence', $offset));
    }

    /**
     * Sort the current instance according to the given comparison callable
     * and maintain index association.
     *
     * Returns true on success or false on failure
     */
    public function sort(callable $compare): bool
    {
        return uasort($this->intervals, $compare);
    }

    /**
     * Adds new intervals at the front of the sequence.
     *
     * The sequence is re-indexed after addition
     *
     * @param Period ...$intervals
     */
    public function unshift(Period $interval, Period ...$intervals): void
    {
        $this->intervals = array_merge([$interval], $intervals, $this->intervals);
    }

    /**
     * Adds new intervals at the end of the sequence.
     *
     * @param Period ...$intervals
     */
    public function push(Period $interval, Period ...$intervals): void
    {
        $this->intervals = array_merge($this->intervals, [$interval], $intervals);
    }

    /**
     * Inserts new intervals at the specified offset of the sequence.
     *
     * The sequence is re-indexed after addition
     *
     * @param Period ...$intervals
     *
     * @throws InvalidIndex If the offset is illegal for the current sequence.
     */
    public function insert(int $offset, Period $interval, Period ...$intervals): void
    {
        if ($offset < 0 || $offset > count($this->intervals)) {
            throw new InvalidIndex(sprintf('%s is an invalid offset in the current sequence', $offset));
        }

        array_unshift($intervals, $interval);
        array_splice($this->intervals, $offset, 0, $intervals);
    }

    /**
     * Updates the interval at the specify offset.
     *
     * @throws InvalidIndex If the offset is illegal for the current sequence.
     */
    public function set(int $offset, Period $interval): void
    {
        $this->get($offset);
        $this->intervals[$offset] = $interval;
    }

    /**
     * Removes an interval from the sequence at the given offset and returns it.
     *
     * The sequence is re-indexed after removal
     *
     * @throws InvalidIndex If the offset is illegal for the current sequence.
     */
    public function remove(int $offset): Period
    {
        $interval = $this->get($offset);
        unset($this->intervals[$offset]);

        $this->intervals = array_values($this->intervals);

        return $interval;
    }

    /**
     * Filters the sequence according to the given predicate.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the interval which validate the predicate.
     */
    public function filter(callable $predicate): self
    {
        $intervals = array_filter($this->intervals, $predicate, ARRAY_FILTER_USE_BOTH);
        if ($intervals === $this->intervals) {
            return $this;
        }

        return new self(...$intervals);
    }

    /**
     * Removes all intervals from the sequence.
     */
    public function clear(): void
    {
        $this->intervals = [];
    }

    /**
     * Returns an instance sorted according to the given comparison callable
     * but does not maintain index association.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the sorted intervals. The key are re-indexed
     */
    public function sorted(callable $compare): self
    {
        $intervals = $this->intervals;
        usort($intervals, $compare);
        if ($intervals === $this->intervals) {
            return $this;
        }

        return new self(...$intervals);
    }

    /**
     * Returns an instance where the given function is applied to each element in
     * the collection. The callable MUST return a Period object and takes a Period
     * and its associated key as argument.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the returned intervals.
     */
    public function map(callable $func): self
    {
        $intervals = [];
        foreach ($this->intervals as $offset => $interval) {
            $intervals[$offset] = $func($interval, $offset);
        }

        if ($intervals === $this->intervals) {
            return $this;
        }

        $mapped = new self();
        $mapped->intervals = $intervals;

        return $mapped;
    }

    /**
     * Iteratively reduces the sequence to a single value using a callback.
     *
     * @param callable $func Accepts the carry, the current value and the current offset, and
     *                       returns an updated carry value.
     *
     * @param mixed|null $carry Optional initial carry value.
     *
     * @return mixed The carry value of the final iteration, or the initial
     *               value if the sequence was empty.
     */
    public function reduce(callable $func, $carry = null)
    {
        foreach ($this->intervals as $offset => $interval) {
            $carry = $func($carry, $interval, $offset);
        }

        return $carry;
    }
}


1		<?php
2
3		/**
4		* League.Period (https://period.thephpleague.com)
5		*
6		* (c) Ignace Nyamagana Butera <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		declare(strict_types=1);
13
14		namespace League\Period;
15
16		use ArrayAccess;
17		use Countable;
18		use Iterator;
19		use IteratorAggregate;
20		use JsonSerializable;
21		use function array_filter;
22		use function array_merge;
23		use function array_splice;
24		use function array_unshift;
25		use function array_values;
26		use function count;
27		use function reset;
28		use function sort;
29		use function sprintf;
30		use function uasort;
31		use function usort;
32		use const ARRAY_FILTER_USE_BOTH;
33
34		/**
35		* A class to manipulate interval collection.
36		*
37		* @package League.period
38		* @author Ignace Nyamagana Butera <[email protected]>
39		* @since 4.1.0
40		*/
41		final class Sequence implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable
42		{
43		/**
44		* @var Period[]
45		*/
46		private $intervals = [];
47
48		/**
49		* new instance.
50		*
51		* @param Period ...$intervals
52		*/
53	111	public function __construct(Period ...$intervals)
54		{
55	111	$this->intervals = $intervals;
56	111	}
57
58		/**
59		* Returns the sequence boundaries as a Period instance.
60		*
61		* If the sequence contains no interval null is returned.
62		*
63		* @return ?Period
64		*/
65	15	public function boundaries(): ?Period
66		{
67	15	$period = reset($this->intervals);
68	15	if (false === $period) {
69	6	return null;
70		}
71
72	15	return $period->merge(...$this->intervals);
73		}
74
75		/**
76		* Returns the gaps inside the instance.
77		*/
78	9	public function gaps(): self
79		{
80	9	$sequence = new self();
81	9	$interval = null;
82	9	foreach ($this->sorted([$this, 'sortByStartDate']) as $period) {
83	9	if (null === $interval) {
84	9	$interval = $period;
85	9	continue;
86		}
87
88	9	if (!$interval->overlaps($period) && !$interval->abuts($period)) {
89	6	$sequence->push($interval->gap($period));
90		}
91
92	9	if (!$interval->contains($period)) {
93	7	$interval = $period;
94		}
95		}
96
97	9	return $sequence;
98		}
99
100		/**
101		* Sorts two Interval instance using their start datepoint.
102		*/
103	15	private function sortByStartDate(Period $interval1, Period $interval2): int
104		{
105	15	return $interval1->getStartDate() <=> $interval2->getStartDate();
106		}
107
108		/**
109		* Returns the intersections inside the instance.
110		*/
111	9	public function substract(Sequence $subIntervals): self
112		{
113	9	if (count($this) == 0) {
114	3	return new self();
115	9	} else if (count($subIntervals) == 0) {
116	3	return $this;
117	6	} else if (count($this) == 1 && count($subIntervals) == 1) {
118	6	return $this->get(0)->substract($subIntervals->get(0));
119	6	} else if (count($this) > 1) {
120	6	$diffSequences = [];
121	6	foreach ($this->intervals as $intervalA) {
122	6	$tmpSequence = new self($intervalA);
123	6	$diffSequences[] = $tmpSequence->substract($subIntervals);
124		}
125
126	6	$newSequence = new self();
127	6	foreach ($diffSequences as $diffSequence) {
128	6	foreach ($diffSequence as $sequence) {
129	4	$newSequence->push($sequence);
130		}
131		}
132
133	6	return $newSequence;
134	3	} else if (count($this) == 1 && count($subIntervals) > 1) {
135	3	$newSequence = new self($this->get(0));
136	3	foreach ($subIntervals as $subInterval) {
137	3	$tmpSequence = new self($subInterval);
138	3	$newSequence = $newSequence->substract($tmpSequence);
139		}
140
141	3	return $newSequence;
142		}
143
144		return new self();
145		}
146
147		/**
148		* Returns the intersections inside the instance.
149		*/
150	9	public function intersections(): self
151		{
152	9	$sequence = new self();
153	9	$current = null;
154	9	$isPreviouslyContained = false;
155	9	foreach ($this->sorted([$this, 'sortByStartDate']) as $period) {
156	9	if (null === $current) {
157	9	$current = $period;
158	9	continue;
159		}
160
161	9	$isContained = $current->contains($period);
162	9	if ($isContained && $isPreviouslyContained) {
163	3	continue;
164		}
165
166	9	if ($current->overlaps($period)) {
167	6	$sequence->push($current->intersect($period));
168		}
169
170	9	$isPreviouslyContained = $isContained;
171	9	if (!$isContained) {
172	7	$current = $period;
173		}
174		}
175
176	9	return $sequence;
177		}
178
179		/**
180		* Returns the unions inside the instance.
181		*/
182	6	public function unions(): self
183		{
184		$sequence = $this
185	6	->sorted([$this, 'sortByStartDate'])
186	6	->reduce([$this, 'calculateUnion'], new self())
187		;
188
189	6	if ($sequence->intervals === $this->intervals) {
190	3	return $this;
191		}
192
193	3	return $sequence;
194		}
195
196		/**
197		* Iteratively calculate the union sequence.
198		*/
199	6	private function calculateUnion(Sequence $sequence, Period $period): Sequence
200		{
201	6	if ($sequence->isEmpty()) {
202	6	$sequence->push($period);
203
204	6	return $sequence;
205		}
206
207	3	$index = $sequence->count() - 1;
208	3	$interval = $sequence->get($index);
209	3	if ($interval->overlaps($period) \|\| $interval->abuts($period)) {
210	3	$sequence->set($index, $interval->merge($period));
211
212	3	return $sequence;
213		}
214
215	3	$sequence->push($period);
216
217	3	return $sequence;
218		}
219
220		/**
221		* Returns the sequence boundaries as a Period instance.
222		*
223		* DEPRECATION WARNING! This method will be removed in the next major point release
224		*
225		* @deprecated deprecated since version 4.4.0
226		* @see ::boundaries
227		*
228		* If the sequence contains no interval null is returned.
229		*
230		* @return ?Period
231		*/
232	12	public function getBoundaries(): ?Period
233		{
234	12	return $this->boundaries();
235		}
236
237		/**
238		* Returns the intersections inside the instance.
239		*
240		* DEPRECATION WARNING! This method will be removed in the next major point release
241		*
242		* @deprecated deprecated since version 4.4.0
243		* @see ::intersections
244		*/
245	9	public function getIntersections(): self
246		{
247	9	return $this->intersections();
248		}
249
250		/**
251		* Returns the gaps inside the instance.
252		*
253		* DEPRECATION WARNING! This method will be removed in the next major point release
254		*
255		* @deprecated deprecated since version 4.4.0
256		* @see ::gaps
257		*/
258	9	public function getGaps(): self
259		{
260	9	return $this->gaps();
261		}
262
263		/**
264		* Returns the sum of all instances durations as expressed in seconds.
265		*/
266	3	public function getTotalTimestampInterval(): float
267		{
268	3	$retval = 0;
269	3	foreach ($this->intervals as $interval) {
270	3	$retval += $interval->getTimestampInterval();
271		}
272
273	3	return $retval;
274		}
275
276		/**
277		* Tells whether some intervals in the current instance satisfies the predicate.
278		*/
279	3	public function some(callable $predicate): bool
280		{
281	3	foreach ($this->intervals as $offset => $interval) {
282	3	if (true === $predicate($interval, $offset)) {
283	3	return true;
284		}
285		}
286
287	3	return false;
288		}
289
290		/**
291		* Tells whether all intervals in the current instance satisfies the predicate.
292		*/
293	3	public function every(callable $predicate): bool
294		{
295	3	foreach ($this->intervals as $offset => $interval) {
296	3	if (true !== $predicate($interval, $offset)) {
297	3	return false;
298		}
299		}
300
301	3	return [] !== $this->intervals;
302		}
303
304		/**
305		* Returns the array representation of the sequence.
306		*
307		* @return Period[]
308		*/
309	6	public function toArray(): array
310		{
311	6	return $this->intervals;
312		}
313
314		/**
315		* {@inheritdoc}
316		*/
317	3	public function jsonSerialize(): array
318		{
319	3	return $this->intervals;
320		}
321
322		/**
323		* {@inheritdoc}
324		*/
325	24	public function getIterator(): Iterator
326		{
327	24	foreach ($this->intervals as $offset => $interval) {
328	21	yield $offset => $interval;
329		}
330	24	}
331
332		/**
333		* {@inheritdoc}
334		*/
335	51	public function count(): int
336		{
337	51	return count($this->intervals);
338		}
339
340		/**
341		* @inheritdoc
342		*
343		* @param int $offset
344		*/
345	3	public function offsetExists($offset): bool
346		{
347	3	return isset($this->intervals[$offset]);
348		}
349
350		/**
351		* @inheritdoc
352		*
353		* @param int $offset
354		*/
355	12	public function offsetGet($offset): Period
356		{
357	12	return $this->get($offset);
358		}
359
360		/**
361		* @inheritdoc
362		*
363		* @param int $offset
364		*/
365	6	public function offsetUnset($offset): void
366		{
367	6	$this->remove($offset);
368	3	}
369
370		/**
371		* @inheritdoc
372		*
373		* @param mixed\|int $offset
374		* @param Period $interval
375		*/
376	9	public function offsetSet($offset, $interval): void
377		{
378	9	if (null !== $offset) {
379	9	$this->set($offset, $interval);
380	3	return;
381		}
382
383	3	$this->push($interval);
384	3	}
385
386		/**
387		* Tells whether the sequence is empty.
388		*/
389	15	public function isEmpty(): bool
390		{
391	15	return [] === $this->intervals;
392		}
393
394		/**
395		* Tells whether the given interval is present in the sequence.
396		*
397		* @param Period ...$intervals
398		*/
399	6	public function contains(Period $interval, Period ...$intervals): bool
400		{
401	6	$intervals[] = $interval;
402	6	foreach ($intervals as $period) {
403	6	if (false === $this->indexOf($period)) {
404	4	return false;
405		}
406		}
407
408	6	return true;
409		}
410
411		/**
412		* Attempts to find the first offset attached to the submitted interval.
413		*
414		* If no offset is found the method returns boolean false.
415		*
416		* @return int\|bool
417		*/
418	6	public function indexOf(Period $interval)
419		{
420	6	foreach ($this->intervals as $offset => $period) {
421	6	if ($period->equals($interval)) {
422	6	return $offset;
423		}
424		}
425
426	6	return false;
427		}
428
429		/**
430		* Returns the interval specified at a given offset.
431		*
432		* @throws InvalidIndex If the offset is illegal for the current sequence
433		*/
434	57	public function get(int $offset): Period
435		{
436	57	$period = $this->intervals[$offset] ?? null;
437	57	if (null !== $period) {
438	48	return $period;
439		}
440
441	15	throw new InvalidIndex(sprintf('%s is an invalid offset in the current sequence', $offset));
442		}
443
444		/**
445		* Sort the current instance according to the given comparison callable
446		* and maintain index association.
447		*
448		* Returns true on success or false on failure
449		*/
450	6	public function sort(callable $compare): bool
451		{
452	6	return uasort($this->intervals, $compare);
453		}
454
455		/**
456		* Adds new intervals at the front of the sequence.
457		*
458		* The sequence is re-indexed after addition
459		*
460		* @param Period ...$intervals
461		*/
462	3	public function unshift(Period $interval, Period ...$intervals): void
463		{
464	3	$this->intervals = array_merge([$interval], $intervals, $this->intervals);
465	3	}
466
467		/**
468		* Adds new intervals at the end of the sequence.
469		*
470		* @param Period ...$intervals
471		*/
472	27	public function push(Period $interval, Period ...$intervals): void
473		{
474	27	$this->intervals = array_merge($this->intervals, [$interval], $intervals);
475	27	}
476
477		/**
478		* Inserts new intervals at the specified offset of the sequence.
479		*
480		* The sequence is re-indexed after addition
481		*
482		* @param Period ...$intervals
483		*
484		* @throws InvalidIndex If the offset is illegal for the current sequence.
485		*/
486	3	public function insert(int $offset, Period $interval, Period ...$intervals): void
487		{
488	3	if ($offset < 0 \|\| $offset > count($this->intervals)) {
489	3	throw new InvalidIndex(sprintf('%s is an invalid offset in the current sequence', $offset));
490		}
491
492	3	array_unshift($intervals, $interval);
493	3	array_splice($this->intervals, $offset, 0, $intervals);
494	3	}
495
496		/**
497		* Updates the interval at the specify offset.
498		*
499		* @throws InvalidIndex If the offset is illegal for the current sequence.
500		*/
501	12	public function set(int $offset, Period $interval): void
502		{
503	12	$this->get($offset);
504	9	$this->intervals[$offset] = $interval;
505	9	}
506
507		/**
508		* Removes an interval from the sequence at the given offset and returns it.
509		*
510		* The sequence is re-indexed after removal
511		*
512		* @throws InvalidIndex If the offset is illegal for the current sequence.
513		*/
514	9	public function remove(int $offset): Period
515		{
516	9	$interval = $this->get($offset);
517	6	unset($this->intervals[$offset]);
518
519	6	$this->intervals = array_values($this->intervals);
520
521	6	return $interval;
522		}
523
524		/**
525		* Filters the sequence according to the given predicate.
526		*
527		* This method MUST retain the state of the current instance, and return
528		* an instance that contains the interval which validate the predicate.
529		*/
530	6	public function filter(callable $predicate): self
531		{
532	6	$intervals = array_filter($this->intervals, $predicate, ARRAY_FILTER_USE_BOTH);
533	6	if ($intervals === $this->intervals) {
534	3	return $this;
535		}
536
537	3	return new self(...$intervals);
538		}
539
540		/**
541		* Removes all intervals from the sequence.
542		*/
543	3	public function clear(): void
544		{
545	3	$this->intervals = [];
546	3	}
547
548		/**
549		* Returns an instance sorted according to the given comparison callable
550		* but does not maintain index association.
551		*
552		* This method MUST retain the state of the current instance, and return
553		* an instance that contains the sorted intervals. The key are re-indexed
554		*/
555	24	public function sorted(callable $compare): self
556		{
557	24	$intervals = $this->intervals;
558	24	usort($intervals, $compare);
559	24	if ($intervals === $this->intervals) {
560	12	return $this;
561		}
562
563	15	return new self(...$intervals);
564		}
565
566		/**
567		* Returns an instance where the given function is applied to each element in
568		* the collection. The callable MUST return a Period object and takes a Period
569		* and its associated key as argument.
570		*
571		* This method MUST retain the state of the current instance, and return
572		* an instance that contains the returned intervals.
573		*/
574	9	public function map(callable $func): self
575		{
576	9	$intervals = [];
577	9	foreach ($this->intervals as $offset => $interval) {
578	9	$intervals[$offset] = $func($interval, $offset);
579		}
580
581	9	if ($intervals === $this->intervals) {
582	3	return $this;
583		}
584
585	6	$mapped = new self();
586	6	$mapped->intervals = $intervals;
587
588	6	return $mapped;
589		}
590
591		/**
592		* Iteratively reduces the sequence to a single value using a callback.
593		*
594		* @param callable $func Accepts the carry, the current value and the current offset, and
595		* returns an updated carry value.
596		*
597		* @param mixed\|null $carry Optional initial carry value.
598		*
599		* @return mixed The carry value of the final iteration, or the initial
600		* value if the sequence was empty.
601		*/
602	6	public function reduce(callable $func, $carry = null)
603		{
604	6	foreach ($this->intervals as $offset => $interval) {
605	6	$carry = $func($carry, $interval, $offset);
606		}
607
608	6	return $carry;
609		}
610		}
611

thephpleague / period

Pull Request — master (#81)

Sequence::boundaries() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like