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 |
||
| 5 | class Tickets extends Resource |
||
| 6 | { |
||
| 7 | /** |
||
| 8 | * @param array $ticket Array of deal properties. |
||
| 9 | * |
||
| 10 | * @throws \SevenShores\Hubspot\Exceptions\BadRequest |
||
| 11 | * |
||
| 12 | * @return mixed |
||
| 13 | */ |
||
| 14 | public function create(array $ticket) |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @param int $id The deal id. |
||
| 25 | * @param array $ticket The deal properties to update. |
||
| 26 | * |
||
| 27 | * @return mixed |
||
| 28 | */ |
||
| 29 | public function update($id, array $ticket) |
||
| 37 | |||
| 38 | /** |
||
| 39 | * @param array $params |
||
| 40 | * |
||
| 41 | * @throws \SevenShores\Hubspot\Exceptions\BadRequest |
||
| 42 | * |
||
| 43 | * @return \Psr\Http\Message\ResponseInterface|\SevenShores\Hubspot\Http\Response |
||
| 44 | */ |
||
| 45 | View Code Duplication | public function getAll(array $params = []) |
|
| 53 | |||
| 54 | /** |
||
| 55 | * @param int $id |
||
| 56 | * |
||
| 57 | * @return mixed |
||
| 58 | */ |
||
| 59 | public function delete($id) |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @param int $id |
||
| 68 | * |
||
| 69 | * @return mixed |
||
| 70 | */ |
||
| 71 | public function getById($id) |
||
| 77 | |||
| 78 | /** |
||
| 79 | * @param array $params Optional parameters ['timestamp', 'changeType', 'objectId'] |
||
| 80 | * |
||
| 81 | * @return mixed |
||
| 82 | */ |
||
| 83 | View Code Duplication | public function getChangelog(array $params = []) |
|
| 90 | } |
||
| 91 |
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.