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:
Complex classes like TrashService 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 TrashService, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
30 | class TrashService implements TrashServiceInterface |
||
31 | { |
||
32 | /** |
||
33 | * @var \eZ\Publish\Core\Repository\Repository |
||
34 | */ |
||
35 | protected $repository; |
||
36 | |||
37 | /** |
||
38 | * @var \eZ\Publish\SPI\Persistence\Handler |
||
39 | */ |
||
40 | protected $persistenceHandler; |
||
41 | |||
42 | /** |
||
43 | * @var array |
||
44 | */ |
||
45 | protected $settings; |
||
46 | |||
47 | /** |
||
48 | * @var \eZ\Publish\Core\Repository\Helper\NameSchemaService |
||
49 | */ |
||
50 | protected $nameSchemaService; |
||
51 | |||
52 | /** |
||
53 | * Setups service with reference to repository object that created it & corresponding handler. |
||
54 | * |
||
55 | * @param \eZ\Publish\API\Repository\Repository $repository |
||
56 | * @param \eZ\Publish\SPI\Persistence\Handler $handler |
||
57 | * @param \eZ\Publish\Core\Repository\Helper\NameSchemaService $nameSchemaService |
||
58 | * @param array $settings |
||
59 | */ |
||
60 | public function __construct( |
||
74 | |||
75 | /** |
||
76 | * Loads a trashed location object from its $id. |
||
77 | * |
||
78 | * Note that $id is identical to original location, which has been previously trashed |
||
79 | * |
||
80 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the trashed location |
||
81 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the location with the given id does not exist |
||
82 | * |
||
83 | * @param mixed $trashItemId |
||
84 | * |
||
85 | * @return \eZ\Publish\API\Repository\Values\Content\TrashItem |
||
86 | */ |
||
87 | public function loadTrashItem($trashItemId) |
||
101 | |||
102 | /** |
||
103 | * Sends $location and all its children to trash and returns the corresponding trash item, or true if the user is not allowed to read the trashed location. |
||
104 | * |
||
105 | * Content is left untouched. |
||
106 | * |
||
107 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to trash the given location |
||
108 | * |
||
109 | * @param \eZ\Publish\API\Repository\Values\Content\Location $location |
||
110 | * |
||
111 | * @return null|true|\eZ\Publish\API\Repository\Values\Content\TrashItem null if location was deleted, otherwise TrashItem, or true if the user is not allowed to read the trashed location |
||
112 | */ |
||
113 | public function trash(Location $location) |
||
141 | |||
142 | /** |
||
143 | * Recovers the $trashedLocation at its original place if possible. |
||
144 | * |
||
145 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to recover the trash item at the parent location location |
||
146 | * |
||
147 | * If $newParentLocation is provided, $trashedLocation will be restored under it. |
||
148 | * |
||
149 | * @param \eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem |
||
150 | * @param \eZ\Publish\API\Repository\Values\Content\Location $newParentLocation |
||
151 | * |
||
152 | * @return \eZ\Publish\API\Repository\Values\Content\Location the newly created or recovered location |
||
153 | */ |
||
154 | public function recover(APITrashItem $trashItem, Location $newParentLocation = null) |
||
202 | |||
203 | /** |
||
204 | * Empties trash. |
||
205 | * |
||
206 | * All locations contained in the trash will be removed. Content objects will be removed |
||
207 | * if all locations of the content are gone. |
||
208 | * |
||
209 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to empty the trash |
||
210 | */ |
||
211 | View Code Duplication | public function emptyTrash() |
|
227 | |||
228 | /** |
||
229 | * Deletes a trash item. |
||
230 | * |
||
231 | * The corresponding content object will be removed |
||
232 | * |
||
233 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to delete this trash item |
||
234 | * |
||
235 | * @param \eZ\Publish\API\Repository\Values\Content\TrashItem $trashItem |
||
236 | */ |
||
237 | View Code Duplication | public function deleteTrashItem(APITrashItem $trashItem) |
|
256 | |||
257 | /** |
||
258 | * Returns a collection of Trashed locations contained in the trash. |
||
259 | * |
||
260 | * $query allows to filter/sort the elements to be contained in the collection. |
||
261 | * |
||
262 | * @param \eZ\Publish\API\Repository\Values\Content\Query $query |
||
263 | * |
||
264 | * @return \eZ\Publish\API\Repository\Values\Content\SearchResult |
||
265 | */ |
||
266 | public function findTrashItems(Query $query) |
||
311 | |||
312 | /** |
||
313 | * Builds the domain TrashItem object from provided persistence trash item. |
||
314 | * |
||
315 | * @param \eZ\Publish\SPI\Persistence\Content\Location\Trashed $spiTrashItem |
||
316 | * |
||
317 | * @return \eZ\Publish\API\Repository\Values\Content\TrashItem |
||
318 | */ |
||
319 | View Code Duplication | protected function buildDomainTrashItemObject(Trashed $spiTrashItem) |
|
337 | |||
338 | /** |
||
339 | * @param int $timestamp |
||
340 | * |
||
341 | * @return \DateTime |
||
342 | */ |
||
343 | protected function getDateTime($timestamp) |
||
350 | } |
||
351 |
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.
Either this assignment is in error or an instanceof check should be added for that assignment.