Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 12 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
| HttpJsonResponseTrait | |
0.00% |
0 / 12 |
|
0.00% |
0 / 3 |
12 | |
0.00% |
0 / 1 |
| setSuccessJsonResponse | |
0.00% |
0 / 5 |
|
0.00% |
0 / 1 |
2 | |||
| setErrorJsonResponse | |
0.00% |
0 / 6 |
|
0.00% |
0 / 1 |
2 | |||
| getResponseFormatter | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getServiceLocator | n/a |
0 / 0 |
n/a |
0 / 0 |
0 | |||||
| 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) 2020 (original work) Open Assessment Technologies SA; |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | namespace oat\tao\model\http; |
| 23 | |
| 24 | use JsonSerializable; |
| 25 | use oat\tao\model\http\formatter\ResponseFormatter; |
| 26 | use oat\tao\model\http\response\ErrorJsonResponse; |
| 27 | use oat\tao\model\http\response\SuccessJsonResponse; |
| 28 | use Psr\Http\Message\ResponseInterface; |
| 29 | use Zend\ServiceManager\ServiceLocatorInterface; |
| 30 | |
| 31 | trait HttpJsonResponseTrait |
| 32 | { |
| 33 | /** @var ResponseInterface */ |
| 34 | protected $response; |
| 35 | |
| 36 | /** |
| 37 | * @param JsonSerializable|array|int|string|float $data |
| 38 | * @param int $statusCode |
| 39 | */ |
| 40 | protected function setSuccessJsonResponse($data, int $statusCode = 200): void |
| 41 | { |
| 42 | $this->response = $this->getResponseFormatter() |
| 43 | ->withJsonHeader() |
| 44 | ->withStatusCode($statusCode) |
| 45 | ->withBody(new SuccessJsonResponse($data)) |
| 46 | ->format($this->response); |
| 47 | } |
| 48 | |
| 49 | protected function setErrorJsonResponse( |
| 50 | string $errorMessage, |
| 51 | int $errorCode = 0, |
| 52 | array $data = [], |
| 53 | int $statusCode = 400 |
| 54 | ): void { |
| 55 | $this->response = $this->getResponseFormatter() |
| 56 | ->withJsonHeader() |
| 57 | ->withStatusCode($statusCode) |
| 58 | ->withBody(new ErrorJsonResponse($errorCode, $errorMessage, $data)) |
| 59 | ->format($this->response); |
| 60 | } |
| 61 | |
| 62 | protected function getResponseFormatter(): ResponseFormatter |
| 63 | { |
| 64 | return $this->getServiceLocator()->get(ResponseFormatter::class); |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * @return ServiceLocatorInterface |
| 69 | */ |
| 70 | abstract public function getServiceLocator(); |
| 71 | } |