nextcloud /
activity
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 APIv2 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 APIv2, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 45 | class APIv2 extends OCSController { |
||
| 46 | |||
| 47 | /** @var string */ |
||
| 48 | protected $filter; |
||
| 49 | |||
| 50 | /** @var int */ |
||
| 51 | protected $since; |
||
| 52 | |||
| 53 | /** @var int */ |
||
| 54 | protected $limit; |
||
| 55 | |||
| 56 | /** @var string */ |
||
| 57 | protected $sort; |
||
| 58 | |||
| 59 | /** @var string */ |
||
| 60 | protected $objectType; |
||
| 61 | |||
| 62 | /** @var int */ |
||
| 63 | protected $objectId; |
||
| 64 | |||
| 65 | /** @var string */ |
||
| 66 | protected $user; |
||
| 67 | |||
| 68 | /** @var bool */ |
||
| 69 | protected $loadPreviews; |
||
| 70 | |||
| 71 | /** @var IManager */ |
||
| 72 | protected $activityManager; |
||
| 73 | |||
| 74 | /** @var Data */ |
||
| 75 | protected $data; |
||
| 76 | |||
| 77 | /** @var GroupHelper */ |
||
| 78 | protected $helper; |
||
| 79 | |||
| 80 | /** @var UserSettings */ |
||
| 81 | protected $settings; |
||
| 82 | |||
| 83 | /** @var IURLGenerator */ |
||
| 84 | protected $urlGenerator; |
||
| 85 | |||
| 86 | /** @var IUserSession */ |
||
| 87 | protected $userSession; |
||
| 88 | |||
| 89 | /** @var IPreview */ |
||
| 90 | protected $preview; |
||
| 91 | |||
| 92 | /** @var IMimeTypeDetector */ |
||
| 93 | protected $mimeTypeDetector; |
||
| 94 | |||
| 95 | /** @var View */ |
||
| 96 | protected $view; |
||
| 97 | |||
| 98 | /** @var ViewInfoCache */ |
||
| 99 | protected $infoCache; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * OCSEndPoint constructor. |
||
| 103 | * |
||
| 104 | * @param string $appName |
||
| 105 | * @param IRequest $request |
||
| 106 | * @param IManager $activityManager |
||
| 107 | * @param Data $data |
||
| 108 | * @param GroupHelper $helper |
||
| 109 | * @param UserSettings $settings |
||
| 110 | * @param IURLGenerator $urlGenerator |
||
| 111 | * @param IUserSession $userSession |
||
| 112 | * @param IPreview $preview |
||
| 113 | * @param IMimeTypeDetector $mimeTypeDetector |
||
| 114 | * @param View $view |
||
| 115 | * @param ViewInfoCache $infoCache |
||
| 116 | */ |
||
| 117 | 66 | public function __construct($appName, |
|
| 141 | |||
| 142 | /** |
||
| 143 | * @param string $filter |
||
| 144 | * @param int $since |
||
| 145 | * @param int $limit |
||
| 146 | * @param bool $previews |
||
| 147 | * @param string $objectType |
||
| 148 | * @param int $objectId |
||
| 149 | * @param string $sort |
||
| 150 | * @throws InvalidFilterException when the filter is invalid |
||
| 151 | * @throws \OutOfBoundsException when no user is given |
||
| 152 | */ |
||
| 153 | 22 | protected function validateParameters($filter, $since, $limit, $previews, $objectType, $objectId, $sort) { |
|
| 179 | |||
| 180 | /** |
||
| 181 | * @NoAdminRequired |
||
| 182 | * |
||
| 183 | * @param int $since |
||
| 184 | * @param int $limit |
||
| 185 | * @param bool $previews |
||
| 186 | * @param string $object_type |
||
| 187 | * @param int $object_id |
||
| 188 | * @param string $sort |
||
| 189 | * @return DataResponse |
||
| 190 | */ |
||
| 191 | 2 | public function getDefault($since = 0, $limit = 50, $previews = false, $object_type = '', $object_id = 0, $sort = 'desc') { |
|
| 194 | |||
| 195 | /** |
||
| 196 | * @NoAdminRequired |
||
| 197 | * |
||
| 198 | * @param string $filter |
||
| 199 | * @param int $since |
||
| 200 | * @param int $limit |
||
| 201 | * @param bool $previews |
||
| 202 | * @param string $object_type |
||
| 203 | * @param int $object_id |
||
| 204 | * @param string $sort |
||
| 205 | * @return DataResponse |
||
| 206 | */ |
||
| 207 | 2 | public function getFilter($filter, $since = 0, $limit = 50, $previews = false, $object_type = '', $object_id = 0, $sort = 'desc') { |
|
| 210 | |||
| 211 | /** |
||
| 212 | * @NoAdminRequired |
||
| 213 | * |
||
| 214 | * @return DataResponse |
||
| 215 | */ |
||
| 216 | 1 | public function listFilters() { |
|
| 237 | |||
| 238 | /** |
||
| 239 | * @param string $filter |
||
| 240 | * @param int $since |
||
| 241 | * @param int $limit |
||
| 242 | * @param bool $previews |
||
| 243 | * @param string $filterObjectType |
||
| 244 | * @param int $filterObjectId |
||
| 245 | * @param string $sort |
||
| 246 | * @return DataResponse |
||
| 247 | */ |
||
| 248 | 11 | protected function get($filter, $since, $limit, $previews, $filterObjectType, $filterObjectId, $sort) { |
|
| 313 | |||
| 314 | /** |
||
| 315 | * @param array $headers |
||
| 316 | * @param bool $hasMoreActivities |
||
| 317 | * @param array $data |
||
| 318 | * @return array |
||
| 319 | */ |
||
| 320 | 6 | protected function generateHeaders(array $headers, $hasMoreActivities, array $data) { |
|
| 352 | |||
| 353 | /** |
||
| 354 | * @param string $owner |
||
| 355 | * @param int $fileId |
||
| 356 | * @param string $filePath |
||
| 357 | * @return array |
||
| 358 | */ |
||
| 359 | 7 | protected function getPreview($owner, $fileId, $filePath) { |
|
| 396 | |||
| 397 | /** |
||
| 398 | * @param string $filePath |
||
| 399 | * @param array $info |
||
| 400 | * @return array |
||
| 401 | */ |
||
| 402 | 3 | protected function getPreviewFromPath($filePath, $info) { |
|
| 412 | |||
| 413 | /** |
||
| 414 | * @param string $mimeType |
||
| 415 | * @return string |
||
| 416 | */ |
||
| 417 | 3 | protected function getPreviewPathFromMimeType($mimeType) { |
|
| 425 | |||
| 426 | /** |
||
| 427 | * @param string $path |
||
| 428 | * @param bool $isDir |
||
| 429 | * @param string $view |
||
| 430 | * @return string |
||
| 431 | */ |
||
| 432 | 6 | protected function getPreviewLink($path, $isDir, $view) { |
|
| 445 | } |
||
| 446 |
Loading history...
This error could be the result of:
1. Missing dependencies
PHP Analyzer uses your
composer.jsonfile (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects thecomposer.jsonto be in the root folder of your repository.Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the
requireorrequire-devsection?2. Missing use statement
PHP does not complain about undefined classes in
ìnstanceofchecks. For example, the following PHP code will work perfectly fine:If you have not tested against this specific condition, such errors might go unnoticed.