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 |
||
14 | View Code Duplication | class EmailParser extends Parser |
|
|
|||
15 | { |
||
16 | const EMAIL_MAX_LENGTH = 254; |
||
17 | |||
18 | /** |
||
19 | * @var string |
||
20 | */ |
||
21 | protected $domainPart = ''; |
||
22 | |||
23 | /** |
||
24 | * @var string |
||
25 | */ |
||
26 | protected $localPart = ''; |
||
27 | |||
28 | 181 | public function parse(string $str) : Result |
|
29 | { |
||
30 | 181 | $result = parent::parse($str); |
|
31 | |||
32 | 181 | $this->addLongEmailWarning($this->localPart, $this->domainPart); |
|
33 | |||
34 | 181 | return $result; |
|
35 | } |
||
36 | |||
37 | 177 | protected function preLeftParsing(): Result |
|
38 | { |
||
39 | 177 | if (!$this->hasAtToken()) { |
|
40 | 1 | return new InvalidEmail(new NoLocalPart(), $this->lexer->token["value"]); |
|
41 | } |
||
42 | 176 | return new ValidEmail(); |
|
43 | } |
||
44 | |||
45 | 176 | protected function parseLeftFromAt(): Result |
|
46 | { |
||
47 | 176 | return $this->processLocalPart(); |
|
48 | } |
||
49 | |||
50 | 140 | protected function parseRightFromAt(): Result |
|
54 | |||
55 | 176 | private function processLocalPart() : Result |
|
56 | { |
||
57 | 176 | $localPartParser = new LocalPart($this->lexer); |
|
64 | |||
65 | 140 | private function processDomainPart() : Result |
|
74 | |||
75 | 4 | public function getDomainPart() : string |
|
79 | |||
80 | 4 | public function getLocalPart() : string |
|
84 | |||
85 | 181 | private function addLongEmailWarning(string $localPart, string $parsedDomainPart) : void |
|
91 | } |
||
92 |
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.