Complex classes like Body 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 Body, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
16 | abstract class Body |
||
17 | { |
||
18 | const SWAGGER_PROPERTIES="properties"; |
||
19 | const SWAGGER_ADDITIONAL_PROPERTIES="additionalProperties"; |
||
20 | const SWAGGER_REQUIRED="required"; |
||
21 | |||
22 | /** |
||
23 | * @var Schema |
||
24 | */ |
||
25 | protected $schema; |
||
26 | |||
27 | /** |
||
28 | * @var array |
||
29 | */ |
||
30 | protected $structure; |
||
31 | |||
32 | /** |
||
33 | * @var string |
||
34 | */ |
||
35 | protected $name; |
||
36 | |||
37 | /** |
||
38 | * OpenApi 2.0 does not describe null values, so this flag defines, |
||
39 | * if match is ok when one of property, which has type, is null |
||
40 | * |
||
41 | * @var bool |
||
42 | */ |
||
43 | protected $allowNullValues; |
||
44 | |||
45 | /** |
||
46 | * Body constructor. |
||
47 | * |
||
48 | * @param Schema $schema |
||
49 | * @param string $name |
||
50 | * @param array $structure |
||
51 | * @param bool $allowNullValues |
||
52 | */ |
||
53 | public function __construct(Schema $schema, $name, $structure, $allowNullValues = false) |
||
54 | { |
||
55 | $this->schema = $schema; |
||
56 | $this->name = $name; |
||
57 | if (!is_array($structure)) { |
||
58 | throw new InvalidArgumentException('I expected the structure to be an array'); |
||
59 | } |
||
60 | $this->structure = $structure; |
||
61 | $this->allowNullValues = $allowNullValues; |
||
62 | } |
||
63 | |||
64 | /** |
||
65 | * @param Schema $schema |
||
66 | * @param string $name |
||
67 | * @param array $structure |
||
68 | * @param bool $allowNullValues |
||
69 | * @return OpenApiResponseBody|SwaggerResponseBody |
||
70 | * @throws GenericSwaggerException |
||
71 | */ |
||
72 | public static function getInstance(Schema $schema, $name, $structure, $allowNullValues = false) |
||
73 | { |
||
74 | if ($schema instanceof SwaggerSchema) { |
||
75 | return new SwaggerResponseBody($schema, $name, $structure, $allowNullValues); |
||
76 | } |
||
77 | |||
78 | if ($schema instanceof OpenApiSchema) { |
||
79 | return new OpenApiResponseBody($schema, $name, $structure, $allowNullValues); |
||
80 | } |
||
81 | |||
82 | throw new GenericSwaggerException("Cannot get instance SwaggerBody or SchemaBody from " . get_class($schema)); |
||
83 | } |
||
84 | |||
85 | abstract public function match($body); |
||
86 | |||
87 | /** |
||
88 | * @param string $name |
||
89 | * @param array $schemaArray |
||
90 | * @param string $body |
||
91 | * @param string $type |
||
92 | * @return bool |
||
93 | * @throws NotMatchedException |
||
94 | */ |
||
95 | protected function matchString($name, $schemaArray, $body, $type) |
||
107 | |||
108 | /** |
||
109 | * @param string $name |
||
110 | * @param array $schemaArray |
||
111 | * @param string $body |
||
112 | * @param string $type |
||
113 | * @return bool |
||
114 | */ |
||
115 | protected function matchFile($name, $schemaArray, $body, $type) |
||
123 | |||
124 | /** |
||
125 | * @param string $name |
||
126 | * @param string $body |
||
127 | * @param string $type |
||
128 | * @return bool |
||
129 | * @throws NotMatchedException |
||
130 | */ |
||
131 | protected function matchNumber($name, $body, $type) |
||
143 | |||
144 | /** |
||
145 | * @param string $name |
||
146 | * @param string $body |
||
147 | * @param string $type |
||
148 | * @return bool |
||
149 | * @throws NotMatchedException |
||
150 | */ |
||
151 | protected function matchBool($name, $body, $type) |
||
163 | |||
164 | /** |
||
165 | * @param string $name |
||
166 | * @param array $schemaArray |
||
167 | * @param string $body |
||
168 | * @param string $type |
||
169 | * @return bool |
||
170 | * @throws DefinitionNotFoundException |
||
171 | * @throws GenericSwaggerException |
||
172 | * @throws InvalidDefinitionException |
||
173 | * @throws InvalidRequestException |
||
174 | * @throws NotMatchedException |
||
175 | */ |
||
176 | protected function matchArray($name, $schemaArray, $body, $type) |
||
190 | |||
191 | /** |
||
192 | * @param string $name |
||
193 | * @param array $schemaArray |
||
194 | * @param string $body |
||
195 | * @return mixed|null |
||
196 | */ |
||
197 | protected function matchTypes($name, $schemaArray, $body) |
||
247 | |||
248 | /** |
||
249 | * @param string $name |
||
250 | * @param array $schemaArray |
||
251 | * @param string $body |
||
252 | * @return bool|null |
||
253 | * @throws DefinitionNotFoundException |
||
254 | * @throws GenericSwaggerException |
||
255 | * @throws InvalidDefinitionException |
||
256 | * @throws InvalidRequestException |
||
257 | * @throws NotMatchedException |
||
258 | */ |
||
259 | public function matchObjectProperties($name, $schemaArray, $body) |
||
322 | |||
323 | /** |
||
324 | * @param string $name |
||
325 | * @param array $schemaArray |
||
326 | * @param array $body |
||
327 | * @return bool |
||
328 | * @throws DefinitionNotFoundException |
||
329 | * @throws InvalidDefinitionException |
||
330 | * @throws GenericSwaggerException |
||
331 | * @throws InvalidRequestException |
||
332 | * @throws NotMatchedException |
||
333 | */ |
||
334 | protected function matchSchema($name, $schemaArray, $body) |
||
368 | |||
369 | /** |
||
370 | * @param string $name |
||
371 | * @param string $body |
||
372 | * @param string $type |
||
373 | * @param bool $nullable |
||
374 | * @return bool |
||
375 | * @throws NotMatchedException |
||
376 | */ |
||
377 | protected function matchNull($name, $body, $type, $nullable) |
||
392 | } |
||
393 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.