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 |
||
27 | class ExtendedHeaderReader |
||
28 | { |
||
29 | /** |
||
30 | * @var StreamInterface |
||
31 | */ |
||
32 | protected $stream; |
||
33 | |||
34 | /** |
||
35 | * @var HeaderInterface |
||
36 | */ |
||
37 | protected $header; |
||
38 | |||
39 | /** |
||
40 | * @var Integer8Reader |
||
41 | */ |
||
42 | protected $integer8Reader; |
||
43 | |||
44 | /** |
||
45 | * @var Integer16Reader |
||
46 | */ |
||
47 | protected $integer16Reader; |
||
48 | |||
49 | /** |
||
50 | * @var Integer32Reader |
||
51 | */ |
||
52 | protected $integer32Reader; |
||
53 | |||
54 | /** |
||
55 | * @var SynchsafeInteger32Reader |
||
56 | */ |
||
57 | protected $synchsafeInteger32Reader; |
||
58 | |||
59 | /** |
||
60 | * Create ID3v2 extended header reader. |
||
61 | * |
||
62 | * @param StreamInterface $stream |
||
63 | * @param HeaderInterface $header |
||
64 | */ |
||
65 | public function __construct(StreamInterface $stream, HeaderInterface $header) |
||
70 | |||
71 | /** |
||
72 | * Get 8-bit integer reader. |
||
73 | * |
||
74 | * @return Integer8Reader |
||
75 | */ |
||
76 | public function getInteger8Reader() |
||
77 | { |
||
78 | if (null === $this->integer8Reader) { |
||
79 | $this->integer8Reader = new Integer8Reader($this->stream); |
||
80 | } |
||
81 | |||
82 | return $this->integer8Reader; |
||
83 | } |
||
84 | |||
85 | /** |
||
86 | * Get 16-bit integer reader |
||
87 | * |
||
88 | * @return Integer16Reader |
||
89 | */ |
||
90 | View Code Duplication | public function getInteger16Reader() |
|
99 | |||
100 | /** |
||
101 | * Get 32-bit integer reader |
||
102 | * |
||
103 | * @return Integer32Reader |
||
104 | */ |
||
105 | View Code Duplication | public function getInteger32Reader() |
|
114 | |||
115 | /** |
||
116 | * Get synchsafe 32-bit integer reader |
||
117 | * |
||
118 | * @return SynchsafeInteger32Reader |
||
119 | */ |
||
120 | View Code Duplication | public function getSynchsafeInteger32Reader() |
|
129 | |||
130 | /** |
||
131 | * Read ID3v2 extended header size. |
||
132 | * |
||
133 | * @return int |
||
134 | */ |
||
135 | protected function readSize() |
||
143 | |||
144 | /** |
||
145 | * Read ID3v2 extended header flags. |
||
146 | * |
||
147 | * @return array |
||
148 | */ |
||
149 | protected function readFlags() |
||
169 | |||
170 | /** |
||
171 | * Read ID3v2 extended header padding. |
||
172 | * |
||
173 | * @return int |
||
174 | */ |
||
175 | protected function readPadding() |
||
179 | |||
180 | /** |
||
181 | * Read ID3v2 extended header CRC-32 data. |
||
182 | * |
||
183 | * @return int |
||
184 | */ |
||
185 | protected function readCrc32() |
||
195 | |||
196 | /** |
||
197 | * Read ID3v2 extended header restrictions. |
||
198 | * |
||
199 | * @return int |
||
200 | */ |
||
201 | protected function readRestrictions() |
||
207 | |||
208 | /** |
||
209 | * Read ID3v2 extended header. |
||
210 | * |
||
211 | * @return ExtendedHeaderInterface |
||
212 | */ |
||
213 | public function read() |
||
241 | } |
||
242 |
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.