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 |
||
| 20 | View Code Duplication | class UserGroupEntity implements DataEntityInterface |
|
|
|
|||
| 21 | { |
||
| 22 | /** @var int */ |
||
| 23 | private $userGroupId; |
||
| 24 | /** @var string */ |
||
| 25 | private $name; |
||
| 26 | /** @var string */ |
||
| 27 | private $title; |
||
| 28 | /** @var string */ |
||
| 29 | private $description; |
||
| 30 | /** @var bool */ |
||
| 31 | private $isReadOnly; |
||
| 32 | /** @var DateTime */ |
||
| 33 | private $dateCreated; |
||
| 34 | /** @var DateTime */ |
||
| 35 | private $dateModified; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Sets the value of the entity identifier. |
||
| 39 | * |
||
| 40 | * @param int $entityId |
||
| 41 | * @return UserGroupEntity |
||
| 42 | */ |
||
| 43 | 1 | public function setKeyData($entityId) |
|
| 49 | |||
| 50 | /** |
||
| 51 | * Gets the value of the entity identifier. |
||
| 52 | * |
||
| 53 | * @return int |
||
| 54 | */ |
||
| 55 | 2 | public function getKeyData() |
|
| 59 | |||
| 60 | /** |
||
| 61 | * @param int $userGroupId |
||
| 62 | * |
||
| 63 | * @return UserGroupEntity |
||
| 64 | */ |
||
| 65 | 7 | public function setUserGroupId($userGroupId) |
|
| 71 | |||
| 72 | /** |
||
| 73 | * @return int |
||
| 74 | */ |
||
| 75 | 3 | public function getUserGroupId() |
|
| 79 | |||
| 80 | /** |
||
| 81 | * @param string $name |
||
| 82 | * |
||
| 83 | * @return UserGroupEntity |
||
| 84 | */ |
||
| 85 | 4 | public function setName($name) |
|
| 91 | |||
| 92 | /** |
||
| 93 | * @return string |
||
| 94 | */ |
||
| 95 | 2 | public function getName() |
|
| 99 | |||
| 100 | /** |
||
| 101 | * @param string $title |
||
| 102 | * |
||
| 103 | * @return UserGroupEntity |
||
| 104 | */ |
||
| 105 | 4 | public function setTitle($title) |
|
| 111 | |||
| 112 | /** |
||
| 113 | * @return string |
||
| 114 | */ |
||
| 115 | 3 | public function getTitle() |
|
| 119 | |||
| 120 | /** |
||
| 121 | * @param string $description |
||
| 122 | * |
||
| 123 | * @return UserGroupEntity |
||
| 124 | */ |
||
| 125 | 4 | public function setDescription($description) |
|
| 131 | |||
| 132 | /** |
||
| 133 | * @return string |
||
| 134 | */ |
||
| 135 | 3 | public function getDescription() |
|
| 139 | |||
| 140 | /** |
||
| 141 | * @param bool $state |
||
| 142 | * |
||
| 143 | * @return UserGroupEntity |
||
| 144 | */ |
||
| 145 | 4 | public function setReadOnly($state) |
|
| 151 | |||
| 152 | /** |
||
| 153 | * @return bool |
||
| 154 | */ |
||
| 155 | 3 | public function getReadOnly() |
|
| 159 | |||
| 160 | /** |
||
| 161 | * @param DateTime $dateCreated |
||
| 162 | * |
||
| 163 | * @return UserGroupEntity |
||
| 164 | */ |
||
| 165 | 4 | public function setDateCreated(DateTime $dateCreated) |
|
| 171 | |||
| 172 | /** |
||
| 173 | * @return DateTime |
||
| 174 | */ |
||
| 175 | 2 | public function getDateCreated() |
|
| 179 | |||
| 180 | /** |
||
| 181 | * @param DateTime $dateModified |
||
| 182 | * |
||
| 183 | * @return UserGroupEntity |
||
| 184 | */ |
||
| 185 | 4 | public function setDateModified(DateTime $dateModified) |
|
| 191 | |||
| 192 | /** |
||
| 193 | * @return DateTime |
||
| 194 | */ |
||
| 195 | 2 | public function getDateModified() |
|
| 199 | } |
||
| 200 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.