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 |
||
13 | class PeclAmqpDriver implements Driver |
||
14 | { |
||
15 | const DELIVERY_MODE = 'delivery_mode'; |
||
16 | const CONTENT_TYPE = 'content_type'; |
||
17 | const APPLICATION_HEADERS = 'headers'; |
||
18 | const CORRELATION_ID = 'correlation_id'; |
||
19 | const REPLY_TO = 'reply_to'; |
||
20 | |||
21 | /** @var \AMQPConnection */ |
||
22 | private $connection; |
||
23 | |||
24 | /** @var \AMQPChannel */ |
||
25 | private $channel; |
||
26 | |||
27 | /** |
||
28 | * PeclAmqpDriver constructor. |
||
29 | * |
||
30 | * @param \AMQPConnection $connection |
||
31 | */ |
||
32 | public function __construct(\AMQPConnection $connection) |
||
36 | |||
37 | /** |
||
38 | * Declare a persistent queue |
||
39 | * |
||
40 | * @param string $queueName |
||
41 | * @param string $type |
||
42 | * |
||
43 | * @return string |
||
44 | */ |
||
45 | public function declareSimpleQueue($queueName = '', $type = self::QUEUE_DURABLE) |
||
58 | |||
59 | /** |
||
60 | * Declare an exchange |
||
61 | * |
||
62 | * @param string $exchangeName |
||
63 | * @param string $type |
||
64 | * |
||
65 | * @return string |
||
66 | */ |
||
67 | public function declareExchange($exchangeName = '', $type = self::EXCHANGE_TYPE_FANOUT) |
||
76 | |||
77 | /** |
||
78 | * Bind an existing queue to an exchange |
||
79 | * |
||
80 | * @param string $exchange |
||
81 | * @param string $queueName |
||
82 | * @param string $routingKey |
||
83 | * |
||
84 | * @return void |
||
85 | */ |
||
86 | public function bindQueue($exchange, $queueName, $routingKey = '') |
||
91 | |||
92 | /** |
||
93 | * Create a persisting queue and bind it to an exchange |
||
94 | * |
||
95 | * @param string $exchange |
||
96 | * @param string $queueName |
||
97 | * @param string $routingKey |
||
98 | * |
||
99 | * @return void |
||
100 | */ |
||
101 | public function declareAndBindQueue($exchange, $queueName, $routingKey = '') |
||
106 | |||
107 | /** |
||
108 | * Delete a queue |
||
109 | * |
||
110 | * @param string $queueName |
||
111 | * |
||
112 | * @return void |
||
113 | */ |
||
114 | public function deleteQueue($queueName) |
||
118 | |||
119 | /** |
||
120 | * Delete an exchange |
||
121 | * |
||
122 | * @param string $exchangeName |
||
123 | * |
||
124 | * @return void |
||
125 | */ |
||
126 | public function deleteExchange($exchangeName) |
||
130 | |||
131 | /** |
||
132 | * Publish a message in the exchange |
||
133 | * |
||
134 | * @param string $exchangeName |
||
135 | * @param Message $message |
||
136 | * |
||
137 | * @return void |
||
138 | */ |
||
139 | public function publish($exchangeName, Message $message) |
||
149 | |||
150 | /** |
||
151 | * Consume the queue |
||
152 | * |
||
153 | * @param string $queueName |
||
154 | * @param callable $callback |
||
155 | * @param int $timeout |
||
156 | * @param bool $autoAck |
||
157 | * |
||
158 | * @return void |
||
159 | */ |
||
160 | public function consume($queueName, callable $callback, $timeout = 0, $autoAck = true) |
||
190 | |||
191 | /** |
||
192 | * Acknowledge the reception of the message. |
||
193 | * |
||
194 | * @param Message $message |
||
195 | * |
||
196 | * @return void |
||
197 | */ |
||
198 | public function ack(Message $message) |
||
203 | |||
204 | /** |
||
205 | * Acknowledge an error during the consumption of the message |
||
206 | * |
||
207 | * @param Message $message |
||
208 | * @param bool $requeue |
||
209 | * |
||
210 | * @return void |
||
211 | */ |
||
212 | public function nack(Message $message, $requeue = true) |
||
217 | |||
218 | /** |
||
219 | * Close the connection |
||
220 | * |
||
221 | * @return void |
||
222 | */ |
||
223 | public function close() |
||
227 | |||
228 | /** |
||
229 | * @return \AMQPChannel |
||
230 | */ |
||
231 | private function getChannel() |
||
240 | |||
241 | /** |
||
242 | * @param string $queueName |
||
243 | * |
||
244 | * @return \AMQPQueue |
||
245 | */ |
||
246 | private function getQueue($queueName) |
||
255 | |||
256 | /** |
||
257 | * @param string $exchangeName |
||
258 | * |
||
259 | * @return \AMQPExchange |
||
260 | */ |
||
261 | private function getExchange($exchangeName) |
||
270 | |||
271 | /** |
||
272 | * Returns the message parameters |
||
273 | * |
||
274 | * @param Message $message |
||
275 | * |
||
276 | * @return array |
||
277 | */ |
||
278 | View Code Duplication | private static function getMessageProperties(Message $message) |
|
297 | } |
||
298 |
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.