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 | 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 | 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 | 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 | public function popMessage($queueName, $duration = 5) |
||
117 | |||
118 | /** |
||
119 | * If the driver supports it, this will be called when a message |
||
120 | * have been consumed. |
||
121 | * |
||
122 | * @param string $queueName |
||
123 | * @param mixed $receipt |
||
124 | */ |
||
125 | public function acknowledgeMessage($queueName, $receipt) |
||
129 | |||
130 | /** |
||
131 | * Returns a $limit numbers of messages without removing them |
||
132 | * from the queue. |
||
133 | * |
||
134 | * @param string $queueName |
||
135 | * @param int $index |
||
136 | * @param int $limit |
||
137 | */ |
||
138 | public function peekQueue($queueName, $index = 0, $limit = 20) |
||
141 | |||
142 | /** |
||
143 | * Removes the queue. |
||
144 | * |
||
145 | * @param string $queueName |
||
146 | */ |
||
147 | public function removeQueue($queueName) |
||
151 | |||
152 | /** |
||
153 | * @return array |
||
154 | */ |
||
155 | public function info() |
||
158 | |||
159 | public function __destruct() |
||
165 | |||
166 | private function getChannel() |
||
174 | } |
||
175 |
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.