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 ArrayAccessTrait |
29
|
|
|
{ |
30
|
|
|
/** |
31
|
|
|
* Check whether or not a specific offset exists. |
32
|
|
|
* |
33
|
|
|
* @aliasof exists |
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 offsetExists($offset) |
39
|
|
|
{ |
40
|
|
|
return $this->collection->offsetExists($offset); |
|
|
|
|
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* Get the value for a specific offset. |
45
|
|
|
* |
46
|
|
|
* @aliasof get |
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 offsetGet($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
|
|
|
* @aliasof set |
63
|
|
|
* @param integer $offset The location in the collection to set a new value for. |
64
|
|
|
* @param mixed $value The new value for the collection location. |
65
|
|
|
*/ |
66
|
|
|
public function offsetSet($offset, $value) |
67
|
|
|
{ |
68
|
|
|
$this->collection->offsetSet($offset, $value); |
69
|
|
|
$this->value = $this->collection->getArrayCopy(); |
|
|
|
|
70
|
|
|
|
71
|
|
|
return $this; |
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* Unset the value for a specific offset. |
76
|
|
|
* |
77
|
|
|
* @aliasof remove |
78
|
|
|
* @param integer $offset The location in the collection to unset. |
79
|
|
|
*/ |
80
|
|
|
public function offsetUnset($offset) |
81
|
|
|
{ |
82
|
|
|
$this->collection->offsetUnset($offset); |
83
|
|
|
$this->value = $this->collection->getArrayCopy(); |
84
|
|
|
|
85
|
|
|
return $this; |
86
|
|
|
} |
87
|
|
|
} |
88
|
|
|
|
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: