1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* @author Patsura Dmitry https://github.com/ovr <[email protected]> |
4
|
|
|
*/ |
5
|
|
|
|
6
|
|
|
namespace PHPSA\Definition; |
7
|
|
|
|
8
|
|
|
use PHPSA\Context; |
9
|
|
|
use PHPSA\Exception\NotImplementedException; |
10
|
|
|
use ReflectionClass; |
11
|
|
|
|
12
|
|
|
/** |
13
|
|
|
* Class created from Reflection |
14
|
|
|
*/ |
15
|
|
|
class RuntimeClassDefinition extends ClassDefinition |
16
|
|
|
{ |
17
|
|
|
/** |
18
|
|
|
* @var ReflectionClass |
19
|
|
|
*/ |
20
|
|
|
protected $reflection; |
21
|
|
|
|
22
|
|
|
/** |
23
|
|
|
* @param ReflectionClass $reflection |
24
|
|
|
*/ |
25
|
|
|
public function __construct(ReflectionClass $reflection) |
26
|
|
|
{ |
27
|
|
|
$this->reflection = $reflection; |
28
|
|
|
} |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* @param Context $context |
32
|
|
|
* @return $this |
33
|
|
|
*/ |
34
|
|
|
public function compile(Context $context) |
35
|
|
|
{ |
36
|
|
|
return $this; |
|
|
|
|
37
|
|
|
} |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* @param string $name |
41
|
|
|
* @param boolean|false $inherit |
42
|
|
|
* @return bool |
43
|
|
|
*/ |
44
|
|
|
public function hasMethod($name, $inherit = false) |
45
|
|
|
{ |
46
|
|
|
return $this->reflection->hasMethod($name); |
47
|
|
|
} |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* @param string $name |
51
|
|
|
* @param bool $inherit |
52
|
|
|
* @return bool |
53
|
|
|
*/ |
54
|
|
|
public function hasConst($name, $inherit = false) |
55
|
|
|
{ |
56
|
|
|
if (!$this->reflection->hasConstant($name)) { |
57
|
|
|
return false; |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
// NOTE: ReflectionClass::hasConstant also checks parent classes, so if $inherit is true, the job is already done. |
61
|
|
|
if ($inherit) { |
62
|
|
|
return true; |
63
|
|
|
} |
64
|
|
|
|
65
|
|
|
// but if it's not, we need to make sure that the constant is defined only in the current class. It means that |
66
|
|
|
// we have to check that it has no parent or that the parent does not define the constant. |
67
|
|
|
$parent = $this->reflection->getParentClass(); |
68
|
|
|
if (!$parent) { |
69
|
|
|
return true; |
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
return !$parent->hasConstant($name); |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* @param $name |
77
|
|
|
* @param bool $inherit |
78
|
|
|
* @return ReflectionClassMethod |
79
|
|
|
*/ |
80
|
|
|
public function getMethod($name, $inherit = false) |
81
|
|
|
{ |
82
|
|
|
return new ReflectionClassMethod($this->reflection->getMethod($name)); |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* @param $name |
87
|
|
|
* @param bool $inherit |
88
|
|
|
* @param bool $isParent It's an internal parameter |
89
|
|
|
* @return bool |
90
|
|
|
*/ |
91
|
|
|
public function hasProperty($name, $inherit = false, $isParent = true) |
92
|
|
|
{ |
93
|
|
|
return $this->reflection->hasProperty($name); |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* @return string |
98
|
|
|
*/ |
99
|
|
|
public function getFilepath() |
100
|
|
|
{ |
101
|
|
|
throw new NotImplementedException(__FUNCTION__); |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
/** |
105
|
|
|
* @return bool |
106
|
|
|
*/ |
107
|
|
|
public function isAbstract() |
108
|
|
|
{ |
109
|
|
|
return $this->reflection->isAbstract(); |
110
|
|
|
} |
111
|
|
|
|
112
|
|
|
/** |
113
|
|
|
* @return null|RuntimeClassDefinition |
114
|
|
|
*/ |
115
|
|
|
public function getExtendsClassDefinition() |
116
|
|
|
{ |
117
|
|
|
$parentReflection = $this->reflection->getParentClass(); |
118
|
|
|
if (!$parentReflection) { |
119
|
|
|
return null; |
120
|
|
|
} |
121
|
|
|
|
122
|
|
|
return new static($parentReflection); |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
/** |
126
|
|
|
* @return null|string |
127
|
|
|
*/ |
128
|
|
|
public function getExtendsClass() |
129
|
|
|
{ |
130
|
|
|
$parentReflection = $this->reflection->getParentClass(); |
131
|
|
|
if (!$parentReflection) { |
132
|
|
|
return null; |
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
return $parentReflection->getName(); |
136
|
|
|
} |
137
|
|
|
} |
138
|
|
|
|
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.