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 |
||
| 9 | final class Driver implements \Bernard\Driver |
||
| 10 | { |
||
| 11 | /** |
||
| 12 | * @var AbstractConnection |
||
| 13 | */ |
||
| 14 | private $connection; |
||
| 15 | |||
| 16 | /** |
||
| 17 | * @var AMQPChannel |
||
| 18 | */ |
||
| 19 | private $channel; |
||
| 20 | |||
| 21 | /** |
||
| 22 | * @var string |
||
| 23 | */ |
||
| 24 | private $exchange; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * @var array|null |
||
| 28 | */ |
||
| 29 | private $defaultMessageParams; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * @param AbstractConnection $connection |
||
| 33 | * @param string $exchange |
||
| 34 | * @param array $defaultMessageParams |
||
| 35 | */ |
||
| 36 | 7 | public function __construct(AbstractConnection $connection, $exchange, array $defaultMessageParams = null) |
|
| 42 | |||
| 43 | /** |
||
| 44 | * Returns a list of all queue names. |
||
| 45 | * |
||
| 46 | * @return array |
||
| 47 | */ |
||
| 48 | public function listQueues() |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Create a queue. |
||
| 54 | * |
||
| 55 | * @param string $queueName |
||
| 56 | */ |
||
| 57 | 1 | public function createQueue($queueName) |
|
| 64 | |||
| 65 | /** |
||
| 66 | * Count the number of messages in queue. This can be a approximately number. |
||
| 67 | * |
||
| 68 | * @param string $queueName |
||
| 69 | * |
||
| 70 | * @return int |
||
| 71 | */ |
||
| 72 | public function countMessages($queueName) |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Insert a message at the top of the queue. |
||
| 81 | * |
||
| 82 | * @param string $queueName |
||
| 83 | * @param string $message |
||
| 84 | */ |
||
| 85 | 2 | public function pushMessage($queueName, $message) |
|
| 90 | |||
| 91 | /** |
||
| 92 | * Remove the next message in line. And if no message is available |
||
| 93 | * wait $duration seconds. |
||
| 94 | * |
||
| 95 | * @param string $queueName |
||
| 96 | * @param int $duration |
||
| 97 | * |
||
| 98 | * @return array An array like array($message, $receipt); |
||
| 99 | */ |
||
| 100 | 2 | public function popMessage($queueName, $duration = 5) |
|
| 118 | |||
| 119 | /** |
||
| 120 | * If the driver supports it, this will be called when a message |
||
| 121 | * have been consumed. |
||
| 122 | * |
||
| 123 | * @param string $queueName |
||
| 124 | * @param mixed $receipt |
||
| 125 | */ |
||
| 126 | 1 | public function acknowledgeMessage($queueName, $receipt) |
|
| 130 | |||
| 131 | /** |
||
| 132 | * Returns a $limit numbers of messages without removing them |
||
| 133 | * from the queue. |
||
| 134 | * |
||
| 135 | * @param string $queueName |
||
| 136 | * @param int $index |
||
| 137 | * @param int $limit |
||
| 138 | */ |
||
| 139 | public function peekQueue($queueName, $index = 0, $limit = 20) |
||
| 142 | |||
| 143 | /** |
||
| 144 | * Removes the queue. |
||
| 145 | * |
||
| 146 | * @param string $queueName |
||
| 147 | */ |
||
| 148 | public function removeQueue($queueName) |
||
| 152 | |||
| 153 | /** |
||
| 154 | * @return array |
||
| 155 | */ |
||
| 156 | public function info() |
||
| 159 | |||
| 160 | 1 | public function __destruct() |
|
| 166 | |||
| 167 | 6 | private function getChannel() |
|
| 175 | } |
||
| 176 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.