Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 16 |
|
0.00% |
0 / 8 |
CRAP | |
0.00% |
0 / 1 |
| InMemoryQueueBroker | |
0.00% |
0 / 16 |
|
0.00% |
0 / 8 |
110 | |
0.00% |
0 / 1 |
| getQueue | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| createQueue | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| count | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| push | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| pop | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
6 | |||
| doPop | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| delete | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| doDelete | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * This program is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU General Public License |
| 6 | * as published by the Free Software Foundation; under version 2 |
| 7 | * of the License (non-upgradable). |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 17 | * |
| 18 | * Copyright (c) 2017-2021 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\model\taskQueue\Queue\Broker; |
| 23 | |
| 24 | use oat\tao\model\taskQueue\Task\TaskInterface; |
| 25 | |
| 26 | /** |
| 27 | * Stores tasks in memory. It accomplishes Sync Queue mechanism. |
| 28 | * |
| 29 | * @author Gyula Szucs <gyula@taotesting.com> |
| 30 | */ |
| 31 | class InMemoryQueueBroker extends AbstractQueueBroker implements SyncQueueBrokerInterface |
| 32 | { |
| 33 | public const ID = 'memory'; |
| 34 | |
| 35 | /** |
| 36 | * @var \SplQueue |
| 37 | */ |
| 38 | private $queue; |
| 39 | |
| 40 | /** |
| 41 | * @return \SplQueue |
| 42 | */ |
| 43 | private function getQueue() |
| 44 | { |
| 45 | if (is_null($this->queue)) { |
| 46 | $this->createQueue(); |
| 47 | } |
| 48 | return $this->queue; |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Initiates the SplQueue |
| 53 | */ |
| 54 | public function createQueue() |
| 55 | { |
| 56 | $this->queue = new \SplQueue(); |
| 57 | $this->logDebug('Memory Queue created'); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * @return int |
| 62 | */ |
| 63 | public function count(): int |
| 64 | { |
| 65 | return $this->getQueue()->count(); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * @param TaskInterface $task |
| 70 | * @return bool |
| 71 | */ |
| 72 | public function push(TaskInterface $task) |
| 73 | { |
| 74 | $this->getQueue()->enqueue($this->serializeTask($task)); |
| 75 | |
| 76 | return true; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Overwriting the parent totally because in this case we need a much simpler logic for popping messages. |
| 81 | * |
| 82 | * @return mixed|null |
| 83 | */ |
| 84 | public function pop() |
| 85 | { |
| 86 | if (!$this->count()) { |
| 87 | return null; |
| 88 | } |
| 89 | |
| 90 | $task = $this->getQueue()->dequeue(); |
| 91 | |
| 92 | return $this->unserializeTask($task, ''); |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Do nothing. |
| 97 | */ |
| 98 | protected function doPop() |
| 99 | { |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Do nothing, because dequeue automatically deletes the message from the queue |
| 104 | * |
| 105 | * @param TaskInterface $task |
| 106 | */ |
| 107 | public function delete(TaskInterface $task) |
| 108 | { |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Do nothing. |
| 113 | * |
| 114 | * @param string $receipt |
| 115 | * @param array $logContext |
| 116 | */ |
| 117 | protected function doDelete($receipt, array $logContext = []) |
| 118 | { |
| 119 | } |
| 120 | } |