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 |
||
8 | trait HasGatewaySpecificFields |
||
9 | { |
||
10 | protected $gatewaySpecificFieldsConfig = array( |
||
11 | 'test' => array( |
||
12 | 'required' => array(), |
||
13 | 'optional' => array(), |
||
14 | ), |
||
15 | 'fake' => array( |
||
16 | 'required' => array( |
||
17 | 'foo', |
||
18 | ), |
||
19 | 'optional' => array( |
||
20 | 'bar', |
||
21 | ), |
||
22 | ), |
||
23 | 'conekta' => array( |
||
24 | 'required' => array(), |
||
25 | 'optional' => array( |
||
26 | 'device_fingerprint', |
||
27 | 'customer', |
||
28 | 'phone', |
||
29 | ), |
||
30 | ), |
||
31 | ); |
||
32 | |||
33 | 18 | public function getGatewaySpecificFields() |
|
37 | |||
38 | 2 | public function setGatewaySpecificFields($value) |
|
42 | |||
43 | /** |
||
44 | * @param array $data |
||
45 | * @return array |
||
46 | * @throws InvalidRequestException |
||
47 | */ |
||
48 | 18 | protected function fillGatewaySpecificFields($data) |
|
72 | } |
||
73 |
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()
as an abstract method to the trait will make sure it is available.