Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
50.00% |
15 / 30 |
|
50.00% |
5 / 10 |
CRAP | |
0.00% |
0 / 1 |
| CallbackTask | |
50.00% |
15 / 30 |
|
50.00% |
5 / 10 |
64.12 | |
0.00% |
0 / 1 |
| __invoke | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| __clone | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
6 | |||
| setCallable | |
75.00% |
3 / 4 |
|
0.00% |
0 / 1 |
2.06 | |||
| getCallable | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
3 | |||
| markAsEnqueued | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
| isEnqueued | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| jsonSerialize | |
100.00% |
5 / 5 |
|
100.00% |
1 / 1 |
3 | |||
| applyWorkerContext | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
6 | |||
| hasChildren | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| getChildren | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 | |||
| 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 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\model\taskQueue\Task; |
| 23 | |
| 24 | /** |
| 25 | * Wrapper class to store callables (even Action instances) in task queue for later execution |
| 26 | * |
| 27 | * @author Gyula Szucs <gyula@taotesting.com> |
| 28 | */ |
| 29 | final class CallbackTask extends AbstractTask implements CallbackTaskInterface |
| 30 | { |
| 31 | private $callable; |
| 32 | private $enqueued = false; |
| 33 | |
| 34 | /** |
| 35 | * @return \common_report_Report |
| 36 | */ |
| 37 | public function __invoke() |
| 38 | { |
| 39 | return call_user_func($this->getCallable(), $this->getParameters()); |
| 40 | } |
| 41 | |
| 42 | public function __clone() |
| 43 | { |
| 44 | if (is_object($this->callable)) { |
| 45 | $this->callable = clone $this->callable; |
| 46 | } |
| 47 | |
| 48 | $this->enqueued = false; |
| 49 | |
| 50 | parent::__clone(); |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * @param callable $callable |
| 55 | * @return CallbackTaskInterface |
| 56 | */ |
| 57 | public function setCallable(callable $callable) |
| 58 | { |
| 59 | if ($callable instanceof TaskAwareInterface) { |
| 60 | $callable->setTask($this); |
| 61 | } |
| 62 | |
| 63 | $this->callable = $callable; |
| 64 | |
| 65 | return $this; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * @return callable|string|object |
| 70 | */ |
| 71 | public function getCallable() |
| 72 | { |
| 73 | if (is_null($this->callable) && ($callableFromJSON = $this->getMetadata('__callable__'))) { |
| 74 | $this->callable = $callableFromJSON; |
| 75 | } |
| 76 | |
| 77 | return $this->callable; |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * @return CallbackTaskInterface |
| 82 | */ |
| 83 | public function markAsEnqueued() |
| 84 | { |
| 85 | $this->enqueued = true; |
| 86 | |
| 87 | return $this; |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * @return bool |
| 92 | */ |
| 93 | public function isEnqueued() |
| 94 | { |
| 95 | return $this->enqueued; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * @return array |
| 100 | */ |
| 101 | public function jsonSerialize(): array |
| 102 | { |
| 103 | $callableClassOrArray = $this->getCallable(); |
| 104 | |
| 105 | if (is_object($callableClassOrArray) && !$callableClassOrArray instanceof \JsonSerializable) { |
| 106 | $callableClassOrArray = get_class($callableClassOrArray); |
| 107 | } |
| 108 | |
| 109 | $this->setMetadata('__callable__', $callableClassOrArray); |
| 110 | |
| 111 | return parent::jsonSerialize(); |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * @return CallbackTaskInterface |
| 116 | */ |
| 117 | public function applyWorkerContext() |
| 118 | { |
| 119 | parent::applyWorkerContext(); |
| 120 | |
| 121 | if ($this->getCallable() instanceof WorkerContextAwareInterface) { |
| 122 | $this->getCallable()->applyWorkerContext(); |
| 123 | } |
| 124 | |
| 125 | return $this; |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * @return bool |
| 130 | */ |
| 131 | public function hasChildren() |
| 132 | { |
| 133 | if ($this->getCallable() instanceof ChildTaskAwareInterface) { |
| 134 | return $this->getCallable()->hasChildren(); |
| 135 | } |
| 136 | |
| 137 | return parent::hasChildren(); |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * @return string[] |
| 142 | */ |
| 143 | public function getChildren() |
| 144 | { |
| 145 | if ($this->getCallable() instanceof ChildTaskAwareInterface) { |
| 146 | return $this->getCallable()->getChildren(); |
| 147 | } |
| 148 | |
| 149 | return parent::getChildren(); |
| 150 | } |
| 151 | } |