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 SeekableInterfaceTrait |
29
|
|
|
{ |
30
|
|
|
/** |
31
|
|
|
* Seek to a specific position in the collection. |
32
|
|
|
* |
33
|
|
|
* @see ArrayIterator::seek |
34
|
|
|
* @param integer $position The location in the collection to seek to. |
35
|
|
|
* @return mixed The value of the node at the seek location. |
36
|
|
|
*/ |
37
|
|
|
public function seek($position) |
38
|
|
|
{ |
39
|
|
|
$this->iterator->rewind(); |
|
|
|
|
40
|
|
|
$this->iterator->seek($position); |
41
|
|
|
|
42
|
|
|
return $this->iterator->current(); |
43
|
|
|
} |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* Return the current entry in the collection. |
47
|
|
|
* |
48
|
|
|
* @see ArrayIterator::current() |
49
|
|
|
* @return mixed The current entry in the collection. |
50
|
|
|
*/ |
51
|
|
|
public function current() |
52
|
|
|
{ |
53
|
|
|
return $this->iterator->current(); |
54
|
|
|
} |
55
|
|
|
|
56
|
|
|
/** |
57
|
|
|
* Return the current key in the collection. |
58
|
|
|
* |
59
|
|
|
* @see ArrayIterator::key() |
60
|
|
|
* @return mixed The current key in the collection. |
61
|
|
|
*/ |
62
|
|
|
public function key() |
63
|
|
|
{ |
64
|
|
|
return $this->iterator->key(); |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* Move to the next entry in the collection. |
69
|
|
|
* |
70
|
|
|
* @see ArrayIterator::next() |
71
|
|
|
*/ |
72
|
|
|
public function next() |
73
|
|
|
{ |
74
|
|
|
$this->iterator->next(); |
75
|
|
|
|
76
|
|
|
return $this; |
77
|
|
|
} |
78
|
|
|
|
79
|
|
|
/** |
80
|
|
|
* Rewind pointer back to the beginning of the collection. |
81
|
|
|
* |
82
|
|
|
* @see ArrayIterator::rewind() |
83
|
|
|
*/ |
84
|
|
|
public function rewind() |
85
|
|
|
{ |
86
|
|
|
$this->iterator->rewind(); |
87
|
|
|
|
88
|
|
|
return $this; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* Check whether or not the collection contains more entries. |
93
|
|
|
* |
94
|
|
|
* @see ArrayIterator::valid() |
95
|
|
|
* @return boolean A value of `true` indicates that the collection contains more entries. A value of `false` |
96
|
|
|
* indicates that there are no remaining entries. |
97
|
|
|
*/ |
98
|
|
|
public function valid() |
99
|
|
|
{ |
100
|
|
|
return $this->iterator->valid(); |
101
|
|
|
} |
102
|
|
|
} |
103
|
|
|
|
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: