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 |
||
12 | View Code Duplication | class Transaction |
|
|
|||
13 | { |
||
14 | |||
15 | /** |
||
16 | * @var string |
||
17 | * @Serializer\Type("string") |
||
18 | */ |
||
19 | protected $orderId; |
||
20 | |||
21 | /** |
||
22 | * @var string |
||
23 | * @Serializer\Type("string") |
||
24 | */ |
||
25 | protected $refOrderId; |
||
26 | |||
27 | /** |
||
28 | * @var int |
||
29 | * @Serializer\Type("integer") |
||
30 | */ |
||
31 | protected $amount; |
||
32 | |||
33 | /** |
||
34 | * @var string |
||
35 | * @Serializer\Type("string") |
||
36 | */ |
||
37 | protected $transactionText; |
||
38 | |||
39 | /** |
||
40 | * @var \DateTimeInterface |
||
41 | * @Serializer\Type("DateTime<'Y-m-d\TH:i:s.u\Z'>") |
||
42 | */ |
||
43 | protected $timeStamp; |
||
44 | |||
45 | /** |
||
46 | * Gets amount value. |
||
47 | * |
||
48 | * @return int |
||
49 | */ |
||
50 | public function getAmount() |
||
54 | |||
55 | /** |
||
56 | * Sets amount variable. |
||
57 | * |
||
58 | * @param int $amount |
||
59 | * |
||
60 | * @return $this |
||
61 | */ |
||
62 | public function setAmount($amount) |
||
67 | |||
68 | /** |
||
69 | * Gets orderId value. |
||
70 | * |
||
71 | * @return string |
||
72 | */ |
||
73 | public function getOrderId() |
||
77 | |||
78 | /** |
||
79 | * Sets orderId variable. |
||
80 | * |
||
81 | * @param string $orderId |
||
82 | * |
||
83 | * @return $this |
||
84 | */ |
||
85 | public function setOrderId($orderId) |
||
90 | |||
91 | /** |
||
92 | * Gets refOrderId value. |
||
93 | * |
||
94 | * @return string |
||
95 | */ |
||
96 | public function getRefOrderId() |
||
100 | |||
101 | /** |
||
102 | * Sets refOrderId variable. |
||
103 | * |
||
104 | * @param string $refOrderId |
||
105 | * |
||
106 | * @return $this |
||
107 | */ |
||
108 | public function setRefOrderId($refOrderId) |
||
113 | |||
114 | /** |
||
115 | * Gets timeStamp value. |
||
116 | * |
||
117 | * @return \DateTimeInterface |
||
118 | */ |
||
119 | public function getTimeStamp() |
||
123 | |||
124 | /** |
||
125 | * Sets timeStamp variable. |
||
126 | * |
||
127 | * @param \DateTimeInterface $timeStamp |
||
128 | * |
||
129 | * @return $this |
||
130 | */ |
||
131 | public function setTimeStamp(\DateTimeInterface $timeStamp) |
||
136 | |||
137 | /** |
||
138 | * Gets transactionText value. |
||
139 | * |
||
140 | * @return string |
||
141 | */ |
||
142 | public function getTransactionText() |
||
146 | |||
147 | /** |
||
148 | * Sets transactionText variable. |
||
149 | * |
||
150 | * @param string $transactionText |
||
151 | * |
||
152 | * @return $this |
||
153 | */ |
||
154 | public function setTransactionText($transactionText) |
||
159 | } |
||
160 |
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.