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 |
||
29 | class OpenStates extends BaseAPI |
||
30 | { |
||
31 | |||
32 | const BASE_URI = 'http://openstates.org/api/v1/'; |
||
33 | |||
34 | /** |
||
35 | * Create OpenStates API |
||
36 | * |
||
37 | * @param array $options api options (json, sync, etc.) |
||
38 | */ |
||
39 | public function __construct($options = []) |
||
43 | |||
44 | /** |
||
45 | * Create Guzzle Client |
||
46 | * |
||
47 | * @param string $key Sunlight Foundation API key |
||
48 | * |
||
49 | * @return null |
||
50 | */ |
||
51 | View Code Duplication | public function setClient($key) |
|
62 | |||
63 | /** |
||
64 | * Return Guzzle Client |
||
65 | * |
||
66 | * @return GuzzleHTTP/Client OpenStates Guzzle Client |
||
67 | */ |
||
68 | public function getClient() |
||
72 | |||
73 | /** |
||
74 | * Search OpenStates Legislators |
||
75 | * |
||
76 | * @param array $search search fields |
||
77 | * @param array $fields display fields |
||
78 | * |
||
79 | * @return Response Guzzle Response |
||
80 | */ |
||
81 | View Code Duplication | public function legislators($search = [], $fields = []) |
|
94 | |||
95 | /** |
||
96 | * Lookup legislators that serve districts containing a given point |
||
97 | * |
||
98 | * @param float $lat Latitude |
||
99 | * @param float $lng Longitude |
||
100 | * @param array $fields display fields |
||
101 | * |
||
102 | * @return Response Guzzle Response |
||
103 | */ |
||
104 | public function geoLookup($lat, $lng, $fields = []) |
||
110 | } |
||
111 |
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.