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 |
||
| 22 | class SystemPropertyPayload extends AbstractPayload |
||
| 23 | {
|
||
| 24 | /** |
||
| 25 | * The name of the system property |
||
| 26 | * Optional No |
||
| 27 | * @var string |
||
| 28 | */ |
||
| 29 | //private $key; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * The value of the system property |
||
| 33 | * Optional Yes |
||
| 34 | * @var string |
||
| 35 | */ |
||
| 36 | //private $value; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * The value of the system property |
||
| 40 | * Optional Yes |
||
| 41 | * @var string |
||
| 42 | */ |
||
| 43 | private $property; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * SystemPropertyPayload constructor. |
||
| 47 | * @param $property |
||
| 48 | */ |
||
| 49 | public function __construct($property) |
||
| 54 | |||
| 55 | /** |
||
| 56 | * @param array $properties |
||
| 57 | */ |
||
| 58 | View Code Duplication | public function setProperty(array $properties) {
|
|
| 65 | |||
| 66 | /** |
||
| 67 | * @return array |
||
| 68 | */ |
||
| 69 | public function getProperty() {
|
||
| 72 | } |
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.