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 |
||
| 17 | class PluginApiService |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * Url for Api |
||
| 21 | * |
||
| 22 | * @var string |
||
| 23 | */ |
||
| 24 | private $apiUrl; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * @var EccubeConfig |
||
| 28 | */ |
||
| 29 | private $eccubeConfig; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * PluginApiService constructor. |
||
| 33 | * @param EccubeConfig $eccubeConfig |
||
| 34 | */ |
||
| 35 | public function __construct(EccubeConfig $eccubeConfig) |
||
| 39 | |||
| 40 | /** |
||
| 41 | * @return mixed |
||
| 42 | */ |
||
| 43 | public function getApiUrl() |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @param mixed $apiUrl |
||
| 54 | */ |
||
| 55 | public function setApiUrl($apiUrl) |
||
| 59 | |||
| 60 | public function getCategory() |
||
| 66 | |||
| 67 | public function getPlugins($data = array()) |
||
| 79 | |||
| 80 | /** |
||
| 81 | * API request processing |
||
| 82 | * |
||
| 83 | * @param string $url |
||
| 84 | * @param array $data |
||
| 85 | * |
||
| 86 | * @return array |
||
| 87 | */ |
||
| 88 | public function getRequestApi($url, $data = array()) |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Get message |
||
| 121 | * |
||
| 122 | * @param $info |
||
| 123 | * |
||
| 124 | * @return string |
||
| 125 | */ |
||
| 126 | View Code Duplication | public function getResponseErrorMessage($info) |
|
| 138 | } |
||
| 139 |
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArrayis initialized the first time when the foreach loop is entered. You can also see that the value of thebarkey is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.