Raphhh /
trex-reflection
Complex classes like CallableReflection often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CallableReflection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class CallableReflection |
||
| 11 | { |
||
| 12 | /** |
||
| 13 | * type const |
||
| 14 | */ |
||
| 15 | const ERROR_TYPE = 0; |
||
| 16 | const FUNCTION_TYPE = 1; |
||
| 17 | const CLOSURE_TYPE = 2; |
||
| 18 | const INSTANCE_METHOD_TYPE = 3; |
||
| 19 | const STATIC_METHOD_TYPE = 4; |
||
| 20 | const INVOKED_OBJECT_TYPE = 5; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * reflected callback |
||
| 24 | * |
||
| 25 | * @var callable |
||
| 26 | */ |
||
| 27 | private $callable; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * type of the reflected callback (const XXX_TYPE) |
||
| 31 | * |
||
| 32 | * @var int |
||
| 33 | */ |
||
| 34 | private $type; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * initializes the reflected callback |
||
| 38 | * |
||
| 39 | * @param callable $callable |
||
| 40 | */ |
||
| 41 | 95 | public function __construct(callable $callable) |
|
| 45 | |||
| 46 | /** |
||
| 47 | * getter of $callable |
||
| 48 | * |
||
| 49 | * @return callable |
||
| 50 | */ |
||
| 51 | 95 | public function getCallable() |
|
| 55 | |||
| 56 | /** |
||
| 57 | * Returns the appropriate class of the callable reflection. |
||
| 58 | * |
||
| 59 | * @return \ReflectionFunctionAbstract |
||
|
|
|||
| 60 | * @throws \LogicException |
||
| 61 | */ |
||
| 62 | 19 | public function getReflector() |
|
| 63 | { |
||
| 64 | 19 | if ($this->isFunction() || $this->isClosure()) { |
|
| 65 | 6 | return new \ReflectionFunction($this->getCallable()); |
|
| 66 | } |
||
| 67 | 13 | if ($this->isMethod()) { |
|
| 68 | 10 | return new \ReflectionMethod($this->getClassName(), $this->getMethodName()); |
|
| 69 | } |
||
| 70 | 3 | if ($this->isInvokedObject()) { |
|
| 71 | 3 | return new \ReflectionMethod($this->getClassName(), '__invoke'); |
|
| 72 | } |
||
| 73 | throw new \LogicException('Unknown callable reflection'); |
||
| 74 | } |
||
| 75 | |||
| 76 | /** |
||
| 77 | * invokes the reflected callback |
||
| 78 | * |
||
| 79 | * @return mixed |
||
| 80 | */ |
||
| 81 | 5 | public function invoke() |
|
| 85 | |||
| 86 | /** |
||
| 87 | * invokes the reflected callback |
||
| 88 | * |
||
| 89 | * @param array $args |
||
| 90 | * @return mixed |
||
| 91 | */ |
||
| 92 | 18 | public function invokeArgs(array $args) |
|
| 96 | |||
| 97 | /** |
||
| 98 | * Invokes the reflected callback with associative params. |
||
| 99 | * |
||
| 100 | * @param array $args |
||
| 101 | * @return mixed |
||
| 102 | */ |
||
| 103 | 9 | public function invokeA(array $args) |
|
| 107 | |||
| 108 | /** |
||
| 109 | * invokes the reflected callback with static binding |
||
| 110 | * |
||
| 111 | * @return mixed |
||
| 112 | */ |
||
| 113 | 5 | public function invokeStatic() |
|
| 117 | |||
| 118 | /** |
||
| 119 | * invokes the reflected callback with static binding |
||
| 120 | * |
||
| 121 | * @param array $args |
||
| 122 | * @return mixed |
||
| 123 | */ |
||
| 124 | 15 | public function invokeArgsStatic(array $args) |
|
| 128 | |||
| 129 | /** |
||
| 130 | * Invokes the reflected callback with static binding. |
||
| 131 | * Uses an associative array of params. |
||
| 132 | * |
||
| 133 | * @param array $args |
||
| 134 | * @return mixed |
||
| 135 | */ |
||
| 136 | 5 | public function invokeAStatic(array $args) |
|
| 140 | |||
| 141 | /** |
||
| 142 | * getter of $type |
||
| 143 | * |
||
| 144 | * @return int |
||
| 145 | */ |
||
| 146 | 74 | public function getType() |
|
| 147 | { |
||
| 148 | 74 | if (null === $this->type) { |
|
| 149 | 74 | $this->initType(); |
|
| 150 | 74 | } |
|
| 151 | 74 | return $this->type; |
|
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * indicates whether the callback is a function |
||
| 156 | * |
||
| 157 | * @return bool |
||
| 158 | */ |
||
| 159 | 29 | public function isFunction() |
|
| 163 | |||
| 164 | /** |
||
| 165 | * indicates whether the callback is a Closure |
||
| 166 | * |
||
| 167 | * @return bool |
||
| 168 | */ |
||
| 169 | 26 | public function isClosure() |
|
| 173 | |||
| 174 | /** |
||
| 175 | * indicates whether the callback is a method |
||
| 176 | * |
||
| 177 | * @return bool |
||
| 178 | */ |
||
| 179 | 23 | public function isMethod() |
|
| 183 | |||
| 184 | /** |
||
| 185 | * indicates whether the callback is a object method |
||
| 186 | * |
||
| 187 | * @return bool |
||
| 188 | */ |
||
| 189 | 33 | public function isInstanceMethod() |
|
| 193 | |||
| 194 | /** |
||
| 195 | * indicates whether the callback is a class method |
||
| 196 | * |
||
| 197 | * @return bool |
||
| 198 | */ |
||
| 199 | 19 | public function isStaticMethod() |
|
| 203 | |||
| 204 | /** |
||
| 205 | * indicates whether the callback is an invoked object |
||
| 206 | * |
||
| 207 | * @return bool |
||
| 208 | */ |
||
| 209 | 19 | public function isInvokedObject() |
|
| 213 | |||
| 214 | /** |
||
| 215 | * returns the name of the function, if the reflected callback is a function |
||
| 216 | * |
||
| 217 | * @return string |
||
| 218 | */ |
||
| 219 | 5 | public function getFunctionName() |
|
| 220 | { |
||
| 221 | 5 | if ($this->isFunction()) { |
|
| 222 | 1 | return $this->getCallable(); |
|
| 223 | } |
||
| 224 | 4 | return ''; |
|
| 225 | } |
||
| 226 | |||
| 227 | /** |
||
| 228 | * returns the Closure object, if the reflected callback is a Closure |
||
| 229 | * |
||
| 230 | * @return \Closure|null |
||
| 231 | */ |
||
| 232 | 5 | public function getClosure() |
|
| 233 | { |
||
| 234 | 5 | if ($this->isClosure()) { |
|
| 235 | 1 | return $this->getCallable(); |
|
| 236 | } |
||
| 237 | 4 | return null; |
|
| 238 | } |
||
| 239 | |||
| 240 | /** |
||
| 241 | * returns the name of the method, if the reflected callback is a method (except __invoke) |
||
| 242 | * |
||
| 243 | * @return string |
||
| 244 | */ |
||
| 245 | 15 | public function getMethodName() |
|
| 246 | { |
||
| 247 | 15 | if ($this->isMethod()) { |
|
| 248 | 12 | return $this->explodeCallable()[1]; |
|
| 249 | } |
||
| 250 | 3 | return ''; |
|
| 251 | } |
||
| 252 | |||
| 253 | /** |
||
| 254 | * returns the name of the class, if the reflected callback is an object (except Closure) |
||
| 255 | * |
||
| 256 | * @return string |
||
| 257 | */ |
||
| 258 | 18 | public function getClassName() |
|
| 259 | { |
||
| 260 | 18 | if ($this->isMethod() || $this->isInvokedObject()) { |
|
| 261 | 16 | $callable = $this->explodeCallable(); |
|
| 262 | 16 | if ($this->isInstanceMethod() || $this->isInvokedObject()) { |
|
| 263 | 12 | return get_class($callable[0]); |
|
| 264 | } |
||
| 265 | 4 | return $callable[0]; |
|
| 266 | } |
||
| 267 | 2 | return ''; |
|
| 268 | } |
||
| 269 | |||
| 270 | /** |
||
| 271 | * returns the object, if the reflected callback is an object (except Closure) |
||
| 272 | * |
||
| 273 | * @return object|null |
||
| 274 | */ |
||
| 275 | 5 | public function getObject() |
|
| 276 | { |
||
| 277 | 5 | if ($this->isInstanceMethod() || $this->isInvokedObject()) { |
|
| 278 | 2 | return $this->explodeCallable()[0]; |
|
| 279 | } |
||
| 280 | 3 | return null; |
|
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * setter of $callable |
||
| 285 | * |
||
| 286 | * @param callable $callable |
||
| 287 | */ |
||
| 288 | 95 | private function setCallable(callable $callable) |
|
| 292 | |||
| 293 | /** |
||
| 294 | * explodes the reflected callback in an array and splits method/function from class/object |
||
| 295 | * |
||
| 296 | * @return array |
||
| 297 | */ |
||
| 298 | 60 | private function explodeCallable() |
|
| 299 | { |
||
| 300 | 60 | if (is_string($this->getCallable())) { |
|
| 301 | 28 | return explode('::', $this->getCallable()); |
|
| 302 | } |
||
| 303 | 46 | if (is_array($this->getCallable())) { |
|
| 304 | 32 | return $this->getCallable(); |
|
| 305 | } |
||
| 306 | 14 | return array($this->getCallable()); |
|
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * setter of $type |
||
| 311 | * |
||
| 312 | * @param int $type |
||
| 313 | */ |
||
| 314 | 74 | private function setType($type) |
|
| 318 | |||
| 319 | /** |
||
| 320 | * initializes $type |
||
| 321 | */ |
||
| 322 | 74 | private function initType() |
|
| 323 | { |
||
| 324 | 74 | if ($this->getCallable() instanceof \Closure) { |
|
| 325 | 14 | $this->setType(self::CLOSURE_TYPE); |
|
| 326 | |||
| 351 | |||
| 352 | /** |
||
| 353 | * @param array $args |
||
| 354 | * @throws \InvalidArgumentException |
||
| 355 | * @return array |
||
| 356 | */ |
||
| 357 | 14 | private function mapArgs(array $args) |
|
| 378 | } |
||
| 379 |
Loading history...
This check looks for the generic type
arrayas a return type and suggests a more specific type. This type is inferred from the actual code.