SortedGenericList::atIndexOrNull() - Code Metrics - cunningsoft/generic-list - Measure and Improve Code Quality continuously with Scrutinizer

SortedGenericList::atIndexOrNull() A
last analyzed 2020-03-06 18:37 UTC

↳ Parent: SortedGenericList

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Cunningsoft\GenericList;

use function usort;

/**
 * This class must only be used in Sorted*List implementations. It provides a layer on top of php's array to ease
 * the creation of concrete list classes like SortedByAgeUserList or SortedByTitleBlogPostList. It also makes sure
 * it's elements are in the order defined in the sort callback.
 */
final class SortedGenericList extends GenericList
{
    public function sort(callable $callback): void
    {
        usort($this->elements, $callback);
    }

    /** @return mixed */
    public function atIndex(int $index)
    {
        if ($index < 0 || $index > $this->count() - 1) {
            throw new NoElementAtIndex($index);
        }

        return $this->elements[$index];
    }

    /** @return mixed|null */
    public function atIndexOrNull(int $index)
    {
        if ($index < 0 || $index > $this->count() - 1) {
            return null;
        }

        return $this->elements[$index];
    }

    /** @return mixed */
    public function first()
    {
        if ($this->isEmpty()) {
            throw new NoElements();
        }

        return $this->atIndex(0);
    }

    /** @return mixed|null */
    public function firstOrNull()
    {
        return $this->atIndexOrNull(0);
    }

    /** @return mixed */
    public function last()
    {
        if ($this->isEmpty()) {
            throw new NoElements();
        }

        return $this->atIndex($this->count() - 1);
    }

    /** @return mixed|null */
    public function lastOrNull()
    {
        return $this->atIndexOrNull($this->count() - 1);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Cunningsoft\GenericList;
6
7		use function usort;
8
9		/**
10		* This class must only be used in Sorted*List implementations. It provides a layer on top of php's array to ease
11		* the creation of concrete list classes like SortedByAgeUserList or SortedByTitleBlogPostList. It also makes sure
12		* it's elements are in the order defined in the sort callback.
13		*/
14		final class SortedGenericList extends GenericList
15		{
16	5	public function sort(callable $callback): void
17		{
18	5	usort($this->elements, $callback);
19	5	}
20
21		/** @return mixed */
22	10	public function atIndex(int $index)
23		{
24	10	if ($index < 0 \|\| $index > $this->count() - 1) {
25	3	throw new NoElementAtIndex($index);
26		}
27
28	7	return $this->elements[$index];
29		}
30
31		/** @return mixed\|null */
32	8	public function atIndexOrNull(int $index)
33		{
34	8	if ($index < 0 \|\| $index > $this->count() - 1) {
35	3	return null;
36		}
37
38	5	return $this->elements[$index];
39		}
40
41		/** @return mixed */
42	3	public function first()
43		{
44	3	if ($this->isEmpty()) {
45	1	throw new NoElements();
46		}
47
48	2	return $this->atIndex(0);
49		}
50
51		/** @return mixed\|null */
52	2	public function firstOrNull()
53		{
54	2	return $this->atIndexOrNull(0);
55		}
56
57		/** @return mixed */
58	3	public function last()
59		{
60	3	if ($this->isEmpty()) {
61	1	throw new NoElements();
62		}
63
64	2	return $this->atIndex($this->count() - 1);
65		}
66
67		/** @return mixed\|null */
68	2	public function lastOrNull()
69		{
70	2	return $this->atIndexOrNull($this->count() - 1);
71		}
72		}
73

cunningsoft / generic-list

SortedGenericList::atIndexOrNull() A last analyzed 2020-03-06 18:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SortedGenericList::atIndexOrNull() A
last analyzed 2020-03-06 18:37 UTC