Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
19 | class Container extends AbstractResource implements Creatable, Deletable, Retrievable, Listable, HasMetadata |
||
20 | { |
||
21 | use MetadataTrait; |
||
22 | |||
23 | const METADATA_PREFIX = 'X-Container-Meta-'; |
||
24 | |||
25 | /** @var int */ |
||
26 | public $objectCount; |
||
27 | |||
28 | /** @var int */ |
||
29 | public $bytesUsed; |
||
30 | |||
31 | /** @var string */ |
||
32 | public $name; |
||
33 | |||
34 | /** @var array */ |
||
35 | public $metadata; |
||
36 | |||
37 | protected $markerKey = 'name'; |
||
38 | |||
39 | /** |
||
40 | * {@inheritdoc} |
||
41 | */ |
||
42 | 5 | public function populateFromResponse(ResponseInterface $response) |
|
50 | |||
51 | /** |
||
52 | * Retrieves a collection of object resources in the form of a generator. |
||
53 | * |
||
54 | * @param array $options {@see \OpenStack\ObjectStore\v1\Api::getContainer} |
||
55 | * @param callable|null $mapFn Allows a function to be mapped over each element. |
||
56 | * |
||
57 | * @return \Generator |
||
58 | */ |
||
59 | 1 | public function listObjects(array $options = [], callable $mapFn = null) |
|
64 | |||
65 | /** |
||
66 | * {@inheritdoc} |
||
67 | */ |
||
68 | 1 | public function retrieve() |
|
73 | |||
74 | /** |
||
75 | * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putContainer} |
||
76 | * |
||
77 | * @return $this |
||
78 | */ |
||
79 | 3 | public function create(array $data) |
|
88 | |||
89 | /** |
||
90 | * {@inheritdoc} |
||
91 | */ |
||
92 | 1 | public function delete() |
|
96 | |||
97 | /** |
||
98 | * {@inheritdoc} |
||
99 | */ |
||
100 | 1 | public function mergeMetadata(array $metadata) |
|
105 | |||
106 | /** |
||
107 | * {@inheritdoc} |
||
108 | */ |
||
109 | 1 | View Code Duplication | public function resetMetadata(array $metadata) |
126 | |||
127 | /** |
||
128 | * {@inheritdoc} |
||
129 | */ |
||
130 | 2 | public function getMetadata() |
|
135 | |||
136 | /** |
||
137 | * Retrieves an Object and populates its `name` and `containerName` properties according to the name provided and |
||
138 | * the name of this container. A HTTP call will not be executed by default - you need to call |
||
139 | * {@see Object::retrieve} or {@see Object::download} on the returned Object object to do that. |
||
140 | * |
||
141 | * @param string $name The name of the object |
||
142 | * |
||
143 | * @return Object |
||
144 | */ |
||
145 | 4 | public function getObject($name) |
|
149 | |||
150 | /** |
||
151 | * Identifies whether an object exists in this container. |
||
152 | * |
||
153 | * @param string $name The name of the object. |
||
154 | * |
||
155 | * @return bool TRUE if the object exists, FALSE if it does not. |
||
156 | * |
||
157 | * @throws BadResponseError For any other HTTP error which does not have a 404 Not Found status. |
||
158 | * @throws \Exception For any other type of fatal error. |
||
159 | */ |
||
160 | 3 | View Code Duplication | public function objectExists($name) |
172 | |||
173 | /** |
||
174 | * Creates a single object according to the values provided. |
||
175 | * |
||
176 | * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject} |
||
177 | * |
||
178 | * @return Object |
||
179 | */ |
||
180 | 2 | public function createObject(array $data) |
|
184 | |||
185 | /** |
||
186 | * Creates a Dynamic Large Object by chunking a file into smaller segments and uploading them into a holding |
||
187 | * container. When this completes, a manifest file is uploaded which references the prefix of the segments, |
||
188 | * allowing concatenation when a request is executed against the manifest. |
||
189 | * |
||
190 | * @param array $data {@see \OpenStack\ObjectStore\v1\Api::putObject} |
||
191 | * @param int $data['segmentSize'] The size in Bytes of each segment |
||
192 | * @param string $data['segmentContainer'] The container to which each segment will be uploaded |
||
193 | * @param string $data['segmentPrefix'] The prefix that will come before each segment. If omitted, a default |
||
194 | * is used: name/timestamp/filesize |
||
195 | * |
||
196 | * @return Object |
||
197 | */ |
||
198 | 1 | public function createLargeObject(array $data) |
|
235 | } |
||
236 |
This check looks for assignments to scalar types that may be of the wrong type.
To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.