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 | class Question extends ActiveRecordModelExtender |
||
9 | { |
||
10 | |||
11 | /** |
||
12 | * @var string $tableName name of the database table. |
||
13 | */ |
||
14 | protected $tableName = "ramverk1_questions"; |
||
15 | |||
16 | /** |
||
17 | * Columns in the table. |
||
18 | * |
||
19 | * @var integer $id primary key auto incremented. |
||
20 | */ |
||
21 | public $id; |
||
22 | public $user; |
||
23 | |||
24 | public $title; |
||
25 | public $tags; |
||
26 | |||
27 | public $created; |
||
28 | public $status; # default is active |
||
29 | |||
30 | |||
31 | /** |
||
32 | * Returns post with markdown and gravatar |
||
33 | * @param string $sql |
||
34 | * @param array $param |
||
|
|||
35 | * |
||
36 | * @return array |
||
37 | */ |
||
38 | 2 | public function getQuestions($sql = null, $params = null) |
|
61 | |||
62 | /** |
||
63 | * Returns one question with it's own question text and other answers |
||
64 | * @param int $id |
||
65 | * |
||
66 | * @return object |
||
67 | */ |
||
68 | 1 | public function getQuestion($id) |
|
86 | |||
87 | /** |
||
88 | * Returns array of tags, keys are name, value is the integer of how many. |
||
89 | * |
||
90 | * @return array |
||
91 | */ |
||
92 | public function getPopularTags() |
||
109 | |||
110 | |||
111 | |||
112 | |||
113 | /** |
||
114 | * Check if a post belongs to user |
||
115 | * |
||
116 | * |
||
117 | * @return boolean |
||
118 | */ |
||
119 | View Code Duplication | public function controlAuthority($name) |
|
130 | } |
||
131 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.
Consider the following example. The parameter
$ireland
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was changed, but the annotation was not.