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 |
||
| 23 | class PlatesStrategy extends ApplicationStrategy implements StrategyInterface |
||
| 24 | { |
||
| 25 | use HasLayoutTrait; |
||
| 26 | |||
| 27 | /** @var PlatesEngine $viewEngine */ |
||
| 28 | private $viewEngine; |
||
| 29 | |||
| 30 | /** @var NotFoundDecorator $notFoundDecorator */ |
||
| 31 | private $notFoundDecorator; |
||
| 32 | |||
| 33 | /** @var NotAllowedDecorator $notAllowedDecorator */ |
||
| 34 | private $notAllowedDecorator; |
||
| 35 | |||
| 36 | /** @var ExceptionDecorator $exceptionDecorator */ |
||
| 37 | private $exceptionDecorator; |
||
| 38 | |||
| 39 | /** @var bool */ |
||
| 40 | private $i18nEnabled = false; |
||
| 41 | |||
| 42 | /** @var array */ |
||
| 43 | private $supportedLocales = []; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * PlatesStrategy constructor. |
||
| 47 | * @param PlatesEngine $viewEngine |
||
| 48 | * @param NotFoundDecorator $notFound |
||
| 49 | * @param NotAllowedDecorator $notAllowed |
||
| 50 | * @param string $layout |
||
| 51 | */ |
||
| 52 | 9 | public function __construct(PlatesEngine $viewEngine, NotFoundDecorator $notFound, NotAllowedDecorator $notAllowed, string $layout, ExceptionDecorator $exceptionDecorator) |
|
| 60 | |||
| 61 | /** |
||
| 62 | * @param bool $i18nEnabled |
||
| 63 | */ |
||
| 64 | 8 | public function setI18nEnabled(bool $i18nEnabled): void |
|
| 68 | |||
| 69 | /** |
||
| 70 | * @param array $locales |
||
| 71 | */ |
||
| 72 | 8 | public function setSupportedLocales(array $locales): void |
|
| 76 | |||
| 77 | |||
| 78 | /** |
||
| 79 | * Invoke the route callable based on the strategy. |
||
| 80 | * |
||
| 81 | * @param \League\Route\Route $route |
||
| 82 | * @param \Psr\Http\Message\ServerRequestInterface $request |
||
| 83 | * |
||
| 84 | * @return \Psr\Http\Message\ResponseInterface |
||
| 85 | */ |
||
| 86 | 5 | public function invokeRouteCallable(Route $route, ServerRequestInterface $request): ResponseInterface |
|
| 117 | |||
| 118 | /** |
||
| 119 | * @param ResponseInterface $response |
||
| 120 | * @param string $body |
||
| 121 | * @param int $status |
||
| 122 | * @return \Psr\Http\Message\MessageInterface|Response |
||
| 123 | */ |
||
| 124 | 3 | View Code Duplication | private function getResponseWithBodyAndStatus(Response $response, string $body, int $status = 200) |
| 132 | |||
| 133 | /** |
||
| 134 | * Get a middleware that will decorate a NotFoundException |
||
| 135 | * |
||
| 136 | * @param \League\Route\Http\Exception\NotFoundException $exception |
||
| 137 | * |
||
| 138 | * @return \Psr\Http\Server\MiddlewareInterface |
||
| 139 | */ |
||
| 140 | 1 | public function getNotFoundDecorator(NotFoundException $e): MiddlewareInterface |
|
| 144 | |||
| 145 | /** |
||
| 146 | * Get a middleware that will decorate a NotAllowedException |
||
| 147 | * |
||
| 148 | * @param \League\Route\Http\Exception\NotFoundException $e |
||
| 149 | * |
||
| 150 | * @return \Psr\Http\Server\MiddlewareInterface |
||
| 151 | */ |
||
| 152 | 1 | public function getMethodNotAllowedDecorator(MethodNotAllowedException $e): MiddlewareInterface |
|
| 156 | |||
| 157 | /** |
||
| 158 | * @return MiddlewareInterface |
||
| 159 | */ |
||
| 160 | 5 | public function getExceptionHandler(): MiddlewareInterface |
|
| 164 | } |
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: