blob: 8715f07f2f1ead599a74994fa3546c49efffe503 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<?php
namespace App\Model;
use App\Model\Model;
use ArrayAccess;
use Countable;
use Exception;
use Iterator;
/**
* A collection of models
*
* @author Phil Burton <phil@pgburton.com>
*/
class Collection implements ArrayAccess, Iterator, Countable
{
/**
* Raw array of models
*
* @var Model[]
*/
protected $models;
/**
* Current index of array
*
* @var int
*/
protected $position;
/**
* Initalise the collection
*
* @author Phil Burton <phil@pgburton.com>
* @param $array
*/
public function __construct($array = [])
{
// Initalise Index
$this->position = 0;
// Initalise empty array
$this->setFromArray($array);
}
/**
* Reset array to a new array of models
*
* @author Phil Burton <phil@pgburton.com>
* @param array $array
*/
public function setFromArray(array $array)
{
$this->models = [];
foreach ($array as $model) {
$this->models[] = $model;
}
}
/**
* Set the offset
* Only allow values that are an instance of User
*
* @author Phil Burton <phil@pgburton.com>
* @param mixed $offset
* @param mixed $value
*/
public function offsetSet($offset, $value)
{
if (!$value instanceof Model) {
throw new Exception(
'Collection expects a value of type ' . Model::class . ', ' . gettype($value) . ' given'
);
}
if (is_null($offset)) {
$this->models[] = $value;
} else {
$this->models[$offset] = $value;
}
}
/**
* Return true if the given offset exists
* Otherwise return false
*
* @author Phil Burton <phil@pgburton.com>
* @param mixed $offset
*/
public function offsetExists($offset)
{
return isset($this->models[$offset]);
}
/**
* Unset a given offset
*
* @author Phil Burton <phil@pgburton.com>
* @param mixed $offset
*/
public function offsetUnset($offset)
{
unset($this->models[$offset]);
}
/**
* Get the value at a given offset
*
* @author Phil Burton <phil@pgburton.com>
* @param mixed $offset
*/
public function offsetGet($offset)
{
return isset($this->models[$offset]) ? $this->models[$offset] : null;
}
/**
* Return current user
*
* @author Phil Burton <phil@pgburton.com>
* @return Model
*/
public function current()
{
return $this->models[$this->position];
}
/**
* Return true if the current index exists in user array
* Otherwise return false
*
* @author Phil Burton <phil@pgburton.com>
* @return bool
*/
public function valid()
{
return isset($this->models[$this->position]);
}
/**
* Reset index back to 0
*
* @author Phil Burton <phil@pgburton.com>
*/
public function rewind()
{
$this->position = 0;
}
/**
* Return the current index
*
* @author Phil Burton <phil@pgburton.com>
* @return int
*/
public function key()
{
return $this->position;
}
/**
* Increment index by 1
*
* @author Phil Burton <phil@pgburton.com>
*/
public function next()
{
++$this->position;
}
/**
* Create and return new collection of the merged arrays from thsi and a given collection
*
* @author Phil Burton <phil@pgburton.com>
* @param Collection $collection
* @return Collection
*/
public function merge(Collection $collection): Collection
{
return new Collection(array_merge($collection->toArray(), $this->toArray()));
}
/**
* Return count of users
*
* @author Phil Burton <phil@pgburton.com>
* @return int
*/
public function count(): int
{
return count($this->models);
}
}
|
