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 |
||
| 19 | class ImageRoute implements RouteInterface |
||
| 20 | { |
||
| 21 | /** |
||
| 22 | * Default route options |
||
| 23 | * |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | protected $options = [ |
||
| 27 | 'controller' => \SvImages\Controller\ImageController::class, |
||
| 28 | 'action' => 'image', |
||
| 29 | 'allow_options_override' => true, |
||
| 30 | ]; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * Create a new page route. |
||
| 34 | * |
||
| 35 | * @param array $options |
||
| 36 | */ |
||
| 37 | 5 | public function __construct(array $options = []) |
|
| 47 | |||
| 48 | /** |
||
| 49 | * Match a given request. |
||
| 50 | * |
||
| 51 | * @param Request $request |
||
| 52 | * |
||
| 53 | * @return RouteMatch|null |
||
| 54 | */ |
||
| 55 | public function match(Request $request) |
||
| 82 | |||
| 83 | /** |
||
| 84 | * {@inheritDoc} |
||
| 85 | */ |
||
| 86 | 5 | public function assemble(array $params = [], array $options = []) |
|
| 87 | { |
||
| 88 | 5 | View Code Duplication | if (!array_key_exists('key', $params) || !is_string($params['key'])) { |
| 89 | 1 | throw new UnexpectedValueException('Route params requires "key" parameter'); |
|
| 90 | } |
||
| 91 | 4 | View Code Duplication | if (!array_key_exists('transformers', $params) || !is_string($params['transformers'])) { |
| 92 | 1 | throw new UnexpectedValueException('Route params requires "transformers" parameter'); |
|
| 93 | } |
||
| 94 | |||
| 95 | 3 | $path = sprintf( |
|
| 96 | 3 | '/%s/%s/f_key/%s', |
|
| 97 | 3 | $this->options['container'], |
|
| 98 | 3 | trim($params['transformers'], '/'), |
|
| 99 | 3 | ltrim($params['key'], '/') |
|
| 100 | ); |
||
| 101 | 3 | $parser = new UriParser($this->options); |
|
| 102 | 3 | $result = $parser->parseUri($path); |
|
| 103 | |||
| 104 | 2 | if (!$result instanceof Result) { |
|
| 105 | 1 | throw new RuntimeException(sprintf( |
|
| 106 | 1 | 'Generated URI "%s" is invalid. Please verify that all parameters are correct.', |
|
| 107 | 1 | $path |
|
| 108 | )); |
||
| 109 | } |
||
| 110 | 1 | return $path; |
|
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * {@inheritDoc} |
||
| 115 | */ |
||
| 116 | public function getAssembledParams() |
||
| 121 | |||
| 122 | /** |
||
| 123 | * @private |
||
| 124 | * @deprecated |
||
| 125 | */ |
||
| 126 | public static function factory($options = []) |
||
| 130 | } |
||
| 131 |
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: