AliasTrait   A
last analyzed

Complexity

Total Complexity 9

Size/Duplication

Total Lines 82
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 0

Importance

Changes 3
Bugs 1 Features 0
Metric Value
wmc 9
c 3
b 1
f 0
lcom 1
cbo 0
dl 0
loc 82
rs 10

6 Methods

Rating   Name   Duplication   Size   Complexity  
A exists() 0 4 1
A get() 0 8 2
A set() 0 6 1
A remove() 0 8 3
A length() 0 4 1
A size() 0 4 1
1
<?php
2
/**
3
 * Copyright (c) 2014-2016 Ryan Parman.
4
 *
5
 * Permission is hereby granted, free of charge, to any person obtaining a copy
6
 * of this software and associated documentation files (the "Software"), to deal
7
 * in the Software without restriction, including without limitation the rights
8
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the Software is
10
 * furnished to do so, subject to the following conditions:
11
 *
12
 * The above copyright notice and this permission notice shall be included in
13
 * all copies or substantial portions of the Software.
14
 *
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
 * THE SOFTWARE.
22
 *
23
 * http://opensource.org/licenses/MIT
24
 */
25
26
namespace Skyzyx\StrongTypes\Collection;
27
28
trait AliasTrait
29
{
30
    /**
31
     * Check whether or not a specific offset exists.
32
     *
33
     * @see ArrayIterator::offsetExists
34
     * @param  integer $offset The location in the collection to verify the existence of.
35
     * @return boolean A value of `true` indicates that the collection offset exists. A value of `false`
36
     *                        indicates that it does not.
37
     */
38
    public function exists($offset)
39
    {
40
        return $this->collection->offsetExists($offset);
0 ignored issues
show
Bug introduced by
The property collection does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
41
    }
42
43
    /**
44
     * Get the value for a specific offset.
45
     *
46
     * @see ArrayIterator::offsetGet
47
     * @param  integer $offset The location in the collection to retrieve the value for.
48
     * @return mixed   The value of the collection offset. `NULL` is returned if the offset does not exist.
49
     */
50
    public function get($offset)
51
    {
52
        if ($this->collection->offsetExists($offset)) {
53
            return $this->collection->offsetGet($offset);
54
        }
55
56
        return null;
57
    }
58
59
    /**
60
     * Set the value for a specific offset.
61
     *
62
     * @see ArrayIterator::offsetSet
63
     * @param integer $offset The location in the collection to set a new value for.
64
     * @param integer $value  The new value for the collection location.
65
     */
66
    public function set($offset, $value)
67
    {
68
        $this->collection->offsetSet($offset, $value);
69
70
        return $this;
71
    }
72
73
    /**
74
     * Unset the value for a specific offset.
75
     *
76
     * @see ArrayIterator::offsetUnset
77
     * @param integer $offset The location in the collection to unset.
78
     */
79
    public function remove($offset)
80
    {
81
        if ($offset !== null && $this->collection->offsetExists($offset)) {
82
            $this->collection->offsetUnset($offset);
83
        }
84
85
        return $this;
86
    }
87
88
    /**
89
     * Count the number of elements in a collection.
90
     *
91
     * @aliasof count
92
     * @return integer The number of elements in a collection.
93
     */
94
    public function length()
95
    {
96
        return $this->collection->count();
97
    }
98
99
    /**
100
     * Count the number of elements in a collection.
101
     *
102
     * @aliasof set
103
     * @return integer The number of elements in a collection.
104
     */
105
    public function size()
106
    {
107
        return $this->collection->count();
108
    }
109
}
110