Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 43 |
|
0.00% |
0 / 7 |
CRAP | |
0.00% |
0 / 1 |
| DataTablePayload | |
0.00% |
0 / 43 |
|
0.00% |
0 / 7 |
210 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| customiseRowBy | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
2 | |||
| getPayload | |
0.00% |
0 / 17 |
|
0.00% |
0 / 1 |
6 | |||
| getCustomisedData | |
0.00% |
0 / 9 |
|
0.00% |
0 / 1 |
20 | |||
| count | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| applyDataTableFilters | |
0.00% |
0 / 8 |
|
0.00% |
0 / 1 |
20 | |||
| jsonSerialize | |
0.00% |
0 / 1 |
|
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 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\model\taskQueue\TaskLog; |
| 23 | |
| 24 | use oat\tao\model\datatable\DatatablePayload as DataTablePayloadInterface; |
| 25 | use oat\tao\model\datatable\implementation\DatatableRequest; |
| 26 | use oat\tao\model\datatable\DatatableRequest as DatatableRequestInterface; |
| 27 | use oat\tao\model\taskQueue\TaskLog\Broker\TaskLogBrokerInterface; |
| 28 | use oat\tao\model\taskQueue\TaskLog\Entity\EntityInterface; |
| 29 | |
| 30 | /** |
| 31 | * Helper class for handling js datatable request. |
| 32 | * |
| 33 | * @author Gyula Szucs <gyula@taotesting.com> |
| 34 | */ |
| 35 | class DataTablePayload implements DataTablePayloadInterface, \Countable |
| 36 | { |
| 37 | private $taskLogFilter; |
| 38 | private $broker; |
| 39 | private $request; |
| 40 | |
| 41 | /** |
| 42 | * @var \Closure |
| 43 | */ |
| 44 | private $rowCustomiser; |
| 45 | |
| 46 | /** |
| 47 | * @var bool |
| 48 | */ |
| 49 | private $overrideDefaultPayload = false; |
| 50 | |
| 51 | /** |
| 52 | * DataTablePayload constructor. |
| 53 | * |
| 54 | * @param TaskLogFilter $filter |
| 55 | * @param TaskLogBrokerInterface $broker |
| 56 | * @param DatatableRequestInterface $request |
| 57 | */ |
| 58 | public function __construct( |
| 59 | TaskLogFilter $filter, |
| 60 | TaskLogBrokerInterface $broker, |
| 61 | DatatableRequestInterface $request |
| 62 | ) { |
| 63 | $this->taskLogFilter = $filter; |
| 64 | $this->broker = $broker; |
| 65 | $this->request = $request; |
| 66 | |
| 67 | $this->applyDataTableFilters(); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * You can pass an anonymous function to customise the final payload: either to change the value of a field or |
| 72 | * to add extra field(s); |
| 73 | * |
| 74 | * The function will be bind to the task log entity (TaskLogEntity) so $this can be used inside of the closure. |
| 75 | * The return value needs to be an array. |
| 76 | * |
| 77 | * For example: |
| 78 | * <code> |
| 79 | * $payload->customiseRowBy(function (){ |
| 80 | * $row['extraField'] = 'value'; |
| 81 | * $row['extraField2'] = $this->getParameters()['some_parameter_key']; |
| 82 | * $row['createdAt'] = \tao_helpers_Date::displayeDate($this->getCreatedAt()); |
| 83 | * |
| 84 | * return $row; |
| 85 | * }); |
| 86 | * </code> |
| 87 | * |
| 88 | * @param \Closure $func |
| 89 | * @param boolean $overrideDefault Override default payload, return only data returned by $func |
| 90 | * @return DataTablePayload |
| 91 | */ |
| 92 | public function customiseRowBy(\Closure $func, $overrideDefault = false) |
| 93 | { |
| 94 | $this->rowCustomiser = $func; |
| 95 | $this->overrideDefaultPayload = $overrideDefault; |
| 96 | |
| 97 | return $this; |
| 98 | } |
| 99 | |
| 100 | public function getPayload(): array |
| 101 | { |
| 102 | $countTotal = $this->count(); |
| 103 | |
| 104 | $page = $this->request->getPage(); |
| 105 | $limit = $this->request->getRows(); |
| 106 | |
| 107 | // we don't want to "pollute" the original filter |
| 108 | $cloneFilter = clone $this->taskLogFilter; |
| 109 | |
| 110 | $cloneFilter->setLimit($limit) |
| 111 | ->setOffset($limit * ($page - 1)) |
| 112 | ->setSortBy($this->request->getSortBy()) |
| 113 | ->setSortOrder($this->request->getSortOrder()); |
| 114 | |
| 115 | // get task log entities by filters |
| 116 | $collection = $this->broker->search($cloneFilter); |
| 117 | |
| 118 | // get customised data |
| 119 | $customisedData = $this->getCustomisedData($collection); |
| 120 | |
| 121 | return [ |
| 122 | 'rows' => $limit, |
| 123 | 'page' => $page, |
| 124 | 'amount' => count($collection), |
| 125 | 'total' => ceil($countTotal / $limit), |
| 126 | 'data' => $customisedData ?: $collection->toArray(), |
| 127 | ]; |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Get customised data if we have a customiser set |
| 132 | * |
| 133 | * @param CollectionInterface|EntityInterface[] $collection |
| 134 | * @return array |
| 135 | */ |
| 136 | private function getCustomisedData(CollectionInterface $collection) |
| 137 | { |
| 138 | $data = []; |
| 139 | |
| 140 | if (!is_null($this->rowCustomiser)) { |
| 141 | foreach ($collection as $taskLogEntity) { |
| 142 | $newCustomiser = $this->rowCustomiser->bindTo($taskLogEntity, $taskLogEntity); |
| 143 | $customizedPayload = (array) $newCustomiser(); |
| 144 | |
| 145 | if ($this->overrideDefaultPayload) { |
| 146 | $data[] = $customizedPayload; |
| 147 | } else { |
| 148 | $data[] = array_merge($taskLogEntity->toArray(), $customizedPayload); |
| 149 | } |
| 150 | } |
| 151 | } |
| 152 | |
| 153 | return $data; |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * @return int |
| 158 | */ |
| 159 | public function count(): int |
| 160 | { |
| 161 | return $this->broker->count($this->taskLogFilter); |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Add filter values from request to the taskLogFilter. |
| 166 | */ |
| 167 | private function applyDataTableFilters() |
| 168 | { |
| 169 | $filters = $this->request->getFilters(); |
| 170 | |
| 171 | foreach ($filters as $fieldName => $filterValue) { |
| 172 | if (empty($filterValue)) { |
| 173 | continue; |
| 174 | } |
| 175 | |
| 176 | if (is_array($filterValue)) { |
| 177 | $this->taskLogFilter->in($fieldName, $filterValue); |
| 178 | continue; |
| 179 | } |
| 180 | |
| 181 | $this->taskLogFilter->eq($fieldName, (string) $filterValue); |
| 182 | } |
| 183 | } |
| 184 | |
| 185 | public function jsonSerialize(): array |
| 186 | { |
| 187 | return $this->getPayload(); |
| 188 | } |
| 189 | } |