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 |
||
| 15 | class ImageBrowserController extends Controller |
||
| 16 | { |
||
| 17 | use NotificationResponse; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Get files by directory path. |
||
| 21 | * |
||
| 22 | * @param \Illuminate\Http\Request $request |
||
| 23 | * @return array |
||
| 24 | */ |
||
| 25 | public function getFiles(Request $request) |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Upload image file. |
||
| 35 | * |
||
| 36 | * @param \Illuminate\Http\Request $request |
||
| 37 | * @return array |
||
| 38 | */ |
||
| 39 | public function uploadFile(Request $request) |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Show all files on selected path. |
||
| 52 | * |
||
| 53 | * @param string $currentPath |
||
| 54 | * @param array $mediaFiles |
||
| 55 | * @return array |
||
| 56 | */ |
||
| 57 | View Code Duplication | public function getMediaFiles($currentPath = null, $mediaFiles = []) |
|
| 71 | } |
||
| 72 |
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: