nextcloud /
server
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 |
||
| 31 | class NavigationController extends OCSController { |
||
| 32 | |||
| 33 | /** @var INavigationManager */ |
||
| 34 | private $navigationManager; |
||
| 35 | |||
| 36 | /** @var IURLGenerator */ |
||
| 37 | private $urlGenerator; |
||
| 38 | |||
| 39 | public function __construct(string $appName, IRequest $request, INavigationManager $navigationManager, IURLGenerator $urlGenerator) { |
||
| 44 | |||
| 45 | /** |
||
| 46 | * @NoAdminRequired |
||
| 47 | * @NoCSRFRequired |
||
| 48 | * |
||
| 49 | * @param bool $absolute |
||
| 50 | * @return DataResponse |
||
| 51 | */ |
||
| 52 | public function getAppsNavigation(bool $absolute = false): DataResponse { |
||
| 59 | |||
| 60 | /** |
||
| 61 | * @NoAdminRequired |
||
| 62 | * @NoCSRFRequired |
||
| 63 | * |
||
| 64 | * @param bool $absolute |
||
| 65 | * @return DataResponse |
||
| 66 | */ |
||
| 67 | public function getSettingsNavigation(bool $absolute = false): DataResponse { |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Rewrite href attribute of navigation entries to an absolute URL |
||
| 77 | * |
||
| 78 | * @param array $navigation |
||
| 79 | * @return array |
||
| 80 | */ |
||
| 81 | private function rewriteToAbsoluteUrls(array $navigation): array { |
||
| 92 | } |
||
| 93 |
Let’s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let’s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: