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 |
||
21 | View Code Duplication | class TradingCard extends Game implements InputFilterAwareInterface |
|
|
|||
22 | { |
||
23 | const CLASSTYPE = 'tradingcard'; |
||
24 | |||
25 | /** |
||
26 | * the card models associated with the game |
||
27 | * @ORM\OneToMany(targetEntity="TradingCardModel", mappedBy="game") |
||
28 | */ |
||
29 | protected $models; |
||
30 | |||
31 | /** |
||
32 | * The number of cards in a booster |
||
33 | * @ORM\Column(name="booster_card_number", type="integer", nullable=true) |
||
34 | */ |
||
35 | protected $boosterCardNumber; |
||
36 | |||
37 | /** |
||
38 | * The number of boosters to deliver to user for each entry |
||
39 | * @ORM\Column(name="booster_draw_quantity", type="integer", nullable=true) |
||
40 | */ |
||
41 | protected $boosterDrawQuantity; |
||
42 | |||
43 | public function __construct() |
||
44 | { |
||
45 | parent::__construct(); |
||
46 | $this->setClassType(self::CLASSTYPE); |
||
47 | $this->models = new ArrayCollection(); |
||
48 | } |
||
49 | |||
50 | /** |
||
51 | * Gets the the card models associated with the game. |
||
52 | * |
||
53 | * @return mixed |
||
54 | */ |
||
55 | public function getModels() |
||
56 | { |
||
57 | return $this->models; |
||
58 | } |
||
59 | |||
60 | /** |
||
61 | * Sets the the card models associated with the game. |
||
62 | * |
||
63 | * @param mixed $models the models |
||
64 | * |
||
65 | * @return self |
||
66 | */ |
||
67 | protected function setModels($models) |
||
68 | { |
||
69 | $this->models = $models; |
||
70 | |||
71 | return $this; |
||
72 | } |
||
73 | |||
74 | /** |
||
75 | * Add a model to the trading card. |
||
76 | * |
||
77 | * |
||
78 | * @return void |
||
79 | */ |
||
80 | public function addModel($model) |
||
81 | { |
||
82 | $this->models[] = $model; |
||
83 | } |
||
84 | |||
85 | /** |
||
86 | * Gets the The number of cards in a booster. |
||
87 | * |
||
88 | * @return mixed |
||
89 | */ |
||
90 | public function getBoosterCardNumber() |
||
91 | { |
||
92 | return $this->boosterCardNumber; |
||
93 | } |
||
94 | |||
95 | /** |
||
96 | * Sets the The number of cards in a booster. |
||
97 | * |
||
98 | * @param mixed $boosterCardNumber the booster card number |
||
99 | * |
||
100 | * @return self |
||
101 | */ |
||
102 | public function setBoosterCardNumber($boosterCardNumber) |
||
103 | { |
||
104 | $this->boosterCardNumber = $boosterCardNumber; |
||
105 | |||
106 | return $this; |
||
107 | } |
||
108 | |||
109 | /** |
||
110 | * Gets the The number of boosters to deliver to user. |
||
111 | * |
||
112 | * @return mixed |
||
113 | */ |
||
114 | public function getBoosterDrawQuantity() |
||
115 | { |
||
116 | return $this->boosterDrawQuantity; |
||
117 | } |
||
118 | |||
119 | /** |
||
120 | * Sets the The number of boosters to deliver to user. |
||
121 | * |
||
122 | * @param mixed $boosterDrawQuantity the booster draw quantity |
||
123 | * |
||
124 | * @return self |
||
125 | */ |
||
126 | public function setBoosterDrawQuantity($boosterDrawQuantity) |
||
127 | { |
||
128 | $this->boosterDrawQuantity = $boosterDrawQuantity; |
||
129 | |||
130 | return $this; |
||
131 | } |
||
132 | |||
133 | /** |
||
134 | * Convert the object to an array. |
||
135 | * |
||
136 | * @return array |
||
137 | */ |
||
138 | public function getArrayCopy() |
||
139 | { |
||
140 | $obj_vars = parent::getArrayCopy(); |
||
141 | array_merge($obj_vars, get_object_vars($this)); |
||
142 | |||
143 | return $obj_vars; |
||
144 | } |
||
145 | |||
146 | public function setInputFilter(InputFilterInterface $inputFilter) |
||
147 | { |
||
148 | throw new \Exception("Not used"); |
||
149 | } |
||
150 | |||
151 | public function getInputFilter() |
||
163 | } |
||
164 |
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.