1 | <?php |
||
10 | class Parameters implements Arrayable, \Iterator { |
||
11 | |||
12 | use RefPart; |
||
13 | |||
14 | /** @var ArrayList */ |
||
15 | private $parameters; |
||
16 | |||
17 | 12 | public function __construct($contents = []) { |
|
18 | 12 | $this->parse($contents === null ? [] : $contents); |
|
19 | 12 | } |
|
20 | |||
21 | 12 | private function parse($contents) { |
|
22 | 12 | $data = CollectionUtils::toMap($contents); |
|
23 | |||
24 | 12 | $this->parameters = new ArrayList(); |
|
25 | 12 | $this->parseRef($data); |
|
26 | |||
27 | 12 | if (!$this->hasRef()) { |
|
28 | 12 | foreach ($data as $param) { |
|
29 | 4 | $this->parameters->add(new Parameter($param)); |
|
30 | 12 | } |
|
31 | 12 | } |
|
32 | 12 | } |
|
33 | |||
34 | 8 | public function toArray() { |
|
35 | 8 | if ($this->hasRef()) { |
|
36 | 1 | return ['$ref' => $this->getRef()]; |
|
37 | } |
||
38 | |||
39 | 7 | return $this->parameters->toArray(); |
|
40 | } |
||
41 | |||
42 | 1 | public function size() { |
|
45 | |||
46 | /** |
||
47 | * Searches whether a parameter with the given name exists |
||
48 | * |
||
49 | * @param string $name |
||
50 | * @return boolean |
||
51 | */ |
||
52 | 1 | public function searchByName($name) { |
|
57 | |||
58 | /** |
||
59 | * Returns parameter with the given name if it exists |
||
60 | * |
||
61 | * @param string $name |
||
62 | * @return Parameter|void |
||
63 | */ |
||
64 | 12 | public function findByName($name) { |
|
71 | |||
72 | /** |
||
73 | * Searches for the parameter with the given name. Creates a parameter with the given name |
||
74 | * if none exists |
||
75 | * |
||
76 | * @param string $name |
||
77 | * @return Parameter |
||
78 | */ |
||
79 | public function getByName($name) { |
||
89 | |||
90 | /** |
||
91 | * Searches whether a parameter with the given unique combination exists |
||
92 | * |
||
93 | * @param string $name |
||
94 | * @param string $id |
||
|
|||
95 | * @return boolean |
||
96 | */ |
||
97 | public function search($name, $in) { |
||
102 | |||
103 | 1 | public function find($name, $in) { |
|
110 | |||
111 | 1 | public function get($name, $in) { |
|
122 | |||
123 | /** |
||
124 | * Adds a parameter |
||
125 | * |
||
126 | * @param Parameter $param |
||
127 | */ |
||
128 | 1 | public function add(Parameter $param) { |
|
131 | |||
132 | /** |
||
133 | * Removes a parameter |
||
134 | * |
||
135 | * @param Parameter $param |
||
136 | */ |
||
137 | 1 | public function remove(Parameter $param) { |
|
140 | |||
141 | /** |
||
142 | * Returns whether a given parameter exists |
||
143 | * |
||
144 | * @param Parameter $param |
||
145 | * @return boolean |
||
146 | */ |
||
147 | 1 | public function contains(Parameter $param) { |
|
150 | |||
151 | public function current() { |
||
154 | |||
155 | public function key() { |
||
158 | |||
159 | public function next() { |
||
162 | |||
163 | public function rewind() { |
||
166 | |||
167 | public function valid() { |
||
170 | } |
||
171 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.