1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* apparat-object |
5
|
|
|
* |
6
|
|
|
* @category Apparat |
7
|
|
|
* @package Apparat\Server |
8
|
|
|
* @subpackage Apparat\Server\Object |
9
|
|
|
* @author Joschi Kuphal <[email protected]> / @jkphl |
10
|
|
|
* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl |
11
|
|
|
* @license http://opensource.org/licenses/MIT The MIT License (MIT) |
12
|
|
|
*/ |
13
|
|
|
|
14
|
|
|
/*********************************************************************************** |
15
|
|
|
* The MIT License (MIT) |
16
|
|
|
* |
17
|
|
|
* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl |
18
|
|
|
* |
19
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of |
20
|
|
|
* this software and associated documentation files (the "Software"), to deal in |
21
|
|
|
* the Software without restriction, including without limitation the rights to |
22
|
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of |
23
|
|
|
* the Software, and to permit persons to whom the Software is furnished to do so, |
24
|
|
|
* subject to the following conditions: |
25
|
|
|
* |
26
|
|
|
* The above copyright notice and this permission notice shall be included in all |
27
|
|
|
* copies or substantial portions of the Software. |
28
|
|
|
* |
29
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
30
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS |
31
|
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR |
32
|
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER |
33
|
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
34
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
35
|
|
|
***********************************************************************************/ |
36
|
|
|
|
37
|
|
|
namespace Apparat\Object\Domain\Model\Object\Traits; |
38
|
|
|
|
39
|
|
|
use Apparat\Object\Domain\Model\Object\ObjectInterface; |
40
|
|
|
use Apparat\Object\Domain\Model\Object\Revision; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* Iterable trait for object proxy |
44
|
|
|
* |
45
|
|
|
* @package Apparat\Object |
46
|
|
|
* @subpackage Apparat\Object\Domain |
47
|
|
|
*/ |
48
|
|
|
trait IterableProxyTrait |
49
|
|
|
{ |
50
|
|
|
/** |
51
|
|
|
* Return the current revision |
52
|
|
|
* |
53
|
|
|
* @return ObjectInterface Self reference |
54
|
|
|
*/ |
55
|
|
|
public function current() |
56
|
|
|
{ |
57
|
|
|
return $this->object()->current(); |
|
|
|
|
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* Forward to the next revision |
62
|
|
|
*/ |
63
|
|
|
public function next() |
64
|
|
|
{ |
65
|
|
|
$this->object()->next(); |
|
|
|
|
66
|
|
|
} |
67
|
|
|
|
68
|
|
|
/** |
69
|
|
|
* Return the current revision number |
70
|
|
|
* |
71
|
|
|
* @return Revision Current (next) revision |
72
|
|
|
*/ |
73
|
|
|
public function key() |
74
|
|
|
{ |
75
|
|
|
return $this->object()->key(); |
|
|
|
|
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* Return whether the current revision is valid |
80
|
|
|
* |
81
|
|
|
* @return bool Current revision is valid |
82
|
|
|
*/ |
83
|
|
|
public function valid() |
84
|
|
|
{ |
85
|
|
|
return $this->object()->valid(); |
|
|
|
|
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
/** |
89
|
|
|
* Rewind to the first revision |
90
|
|
|
*/ |
91
|
|
|
public function rewind() |
92
|
|
|
{ |
93
|
|
|
$this->object()->rewind(); |
|
|
|
|
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* Return the number of available revisions |
98
|
|
|
* |
99
|
|
|
* @return int Number of available revisions |
100
|
|
|
*/ |
101
|
|
|
public function count() |
102
|
|
|
{ |
103
|
|
|
return $this->object()->count(); |
|
|
|
|
104
|
|
|
} |
105
|
|
|
} |
106
|
|
|
|
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()
as an abstract method to the trait will make sure it is available.