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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Webapi\Model\Config;
use Zend\Code\Reflection\MethodReflection;
/**
* Class reflector.
*/
class ClassReflector
{
/**
* @var \Magento\Framework\Reflection\TypeProcessor
*/
protected $_typeProcessor;
/**
* Construct reflector.
*
* @param \Magento\Framework\Reflection\TypeProcessor $typeProcessor
*/
public function __construct(\Magento\Framework\Reflection\TypeProcessor $typeProcessor)
{
$this->_typeProcessor = $typeProcessor;
}
/**
* Reflect methods in given class and set retrieved data into reader.
*
* @param string $className
* @param array $methods
* @return array <pre>array(
* $firstMethod => array(
* 'documentation' => $methodDocumentation,
* 'interface' => array(
* 'in' => array(
* 'parameters' => array(
* $firstParameter => array(
* 'type' => $type,
* 'required' => $isRequired,
* 'documentation' => $parameterDocumentation
* ),
* ...
* )
* ),
* 'out' => array(
* 'parameters' => array(
* $firstParameter => array(
* 'type' => $type,
* 'required' => $isRequired,
* 'documentation' => $parameterDocumentation
* ),
* ...
* )
* )
* )
* ),
* ...
* )</pre>
*/
public function reflectClassMethods($className, $methods)
{
$data = [];
$classReflection = new \Zend\Code\Reflection\ClassReflection($className);
/** @var \Zend\Code\Reflection\MethodReflection $methodReflection */
foreach ($classReflection->getMethods() as $methodReflection) {
$methodName = $methodReflection->getName();
if (array_key_exists($methodName, $methods)) {
$data[$methodName] = $this->extractMethodData($methodReflection);
}
}
return $data;
}
/**
* Retrieve method interface and documentation description.
*
* @param \Zend\Code\Reflection\MethodReflection $method
* @return array
* @throws \InvalidArgumentException
*/
public function extractMethodData(\Zend\Code\Reflection\MethodReflection $method)
{
$methodData = ['documentation' => $this->extractMethodDescription($method), 'interface' => []];
/** @var \Zend\Code\Reflection\ParameterReflection $parameter */
foreach ($method->getParameters() as $parameter) {
$parameterData = [
'type' => $this->_typeProcessor->register($this->_typeProcessor->getParamType($parameter)),
'required' => !$parameter->isOptional(),
'documentation' => $this->_typeProcessor->getParamDescription($parameter),
];
if ($parameter->isOptional()) {
$parameterData['default'] = $parameter->getDefaultValue();
}
$methodData['interface']['in']['parameters'][$parameter->getName()] = $parameterData;
}
$returnType = $this->_typeProcessor->getGetterReturnType($method);
if ($returnType['type'] != 'void' && $returnType['type'] != 'null') {
$methodData['interface']['out']['parameters']['result'] = [
'type' => $this->_typeProcessor->register($returnType['type']),
'documentation' => $returnType['description'],
'required' => true,
];
}
$exceptions = $this->_typeProcessor->getExceptions($method);
if (!empty($exceptions)) {
$methodData['interface']['out']['throws'] = $exceptions;
}
return $methodData;
}
/**
* Retrieve method full documentation description.
*
* @param \Zend\Code\Reflection\MethodReflection $method
* @return string
*/
protected function extractMethodDescription(\Zend\Code\Reflection\MethodReflection $method)
{
$methodReflection = new MethodReflection(
$method->getDeclaringClass()->getName(),
$method->getName()
);
$docBlock = $methodReflection->getDocBlock();
if (!$docBlock) {
throw new \LogicException(
'The docBlock of the method '.
$method->getDeclaringClass()->getName() . '::' . $method->getName() . ' is empty.'
);
}
return $this->_typeProcessor->getDescription($docBlock);
}
/**
* Retrieve class full documentation description.
*
* @param string $className
* @return string
*/
public function extractClassDescription($className)
{
$classReflection = new \Zend\Code\Reflection\ClassReflection($className);
$docBlock = $classReflection->getDocBlock();
if (!$docBlock) {
return '';
}
return $this->_typeProcessor->getDescription($docBlock);
}
}