Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
87.80%
36 / 41
75.00%
3 / 4
 CRAP
0.00%
0 / 1
BaseController
87.80%
36 / 41
75.00%
3 / 4
 21.80
0.00%
0 / 1
 __invoke
100.00%
3 / 3
100.00%
1 / 1
 1
 readResponse
n/a
0 / 0
n/a
0 / 0
 1
 getSchemaConstraintList
100.00%
8 / 8
100.00%
1 / 1
 4
 transformValidationErrors
61.54%
8 / 13
0.00%
0 / 1
 15.69
 handleEntityWrite
100.00%
17 / 17
100.00%
1 / 1
 5
1<?php
2
3/**
4 * @package Zmsadmin
5 * @copyright BerlinOnline Stadtportal GmbH & Co. KG
6 **/
7
8namespace BO\Zmsadmin;
9
10use BO\Zmsadmin\Helper\TwigExceptionHandler;
11use Psr\Http\Message\RequestInterface;
12use Psr\Http\Message\ResponseInterface;
13
14/**
15 * @SuppressWarnings(NumberOfChildren)
16 *
17 */
18abstract class BaseController extends \BO\Slim\Controller
19{
20    #[\Override]
21    public function __invoke(RequestInterface $request, ResponseInterface $response, array $args)
22    {
23        $request = $this->initRequest($request);
24        $noCacheResponse = \BO\Slim\Render::withLastModified($response, time(), '0');
25        return $this->readResponse($request, $noCacheResponse, $args);
26    }
27
28    /**
29     * @codeCoverageIgnore
30     *
31     */
32    public function readResponse(RequestInterface $request, ResponseInterface $response, array $args)
33    {
34        return parent::__invoke($request, $response, $args);
35    }
36
37    public function getSchemaConstraintList($schema)
38    {
39        $list = [];
40        $locale = \App::$language->getLocale();
41        foreach ($schema->properties as $key => $property) {
42            if (isset($property['x-locale'])) {
43                $constraints = $property['x-locale'][$locale];
44                if ($constraints) {
45                    $list[$key]['description'] = $constraints['messages'];
46                }
47            }
48        }
49        return $list;
50    }
51
52    /**
53     * Transform validation error data from JSON pointer format to field names
54     * Maps pointers like "/id" to "id", "/changePassword" to "changePassword", etc.
55     * Handles nested paths like "/contact/email" by flattening them.
56     * Also handles data that's already in field name format (for test compatibility).
57     *
58     * @param array|null $errorData The exception data with JSON pointers as keys, or field names
59     * @return array Transformed data with field names as keys
60     */
61    protected function transformValidationErrors($errorData)
62    {
63        if (!is_array($errorData) && !($errorData instanceof \Traversable)) {
64            return [];
65        }
66        $transformed = [];
67        foreach ($errorData as $pointer => $item) {
68            // Extract field name from JSON pointer (e.g., "/id" -> "id", "/contact/email" -> "contact/email")
69            // If the key doesn't start with "/", it's already a field name, so use it as-is
70            $fieldName = (strpos($pointer, '/') === 0) ? ltrim($pointer, '/') : $pointer;
71            // Handle root level errors
72            if ($fieldName === '' || $fieldName === null) {
73                $fieldName = '_root';
74            }
75            // Ensure the item structure is correct (has 'messages' array)
76            if (is_array($item) && isset($item['messages'])) {
77                $transformed[$fieldName] = $item;
78            } elseif (is_array($item)) {
79                // If item is an array but doesn't have 'messages', wrap it
80                $transformed[$fieldName] = $item;
81            } else {
82                $transformed[$fieldName] = $item;
83            }
84        }
85        return $transformed;
86    }
87
88    /**
89     * Wraps an HTTP write operation with standardized exception handling.
90     *
91     * @param callable $httpCall
92     * @return mixed
93     * @throws \BO\Zmsclient\Exception
94     */
95    protected function handleEntityWrite(callable $httpCall)
96    {
97        try {
98            return $httpCall();
99        } catch (\BO\Zmsclient\Exception $exception) {
100            if ('BO\Zmsentities\Exception\SchemaValidation' == $exception->template) {
101                return [
102                    'template' => 'exception/bo/zmsentities/exception/schemavalidation.twig',
103                    'include' => true,
104                    'data' => $this->transformValidationErrors($exception->data)
105                ];
106            }
107
108            $template = TwigExceptionHandler::getExceptionTemplate($exception);
109            if (
110                '' != $exception->template
111                && \App::$slim->getContainer()->get('view')->getLoader()->exists($template)
112            ) {
113                return [
114                    'template' => $template,
115                    'include' => true,
116                    'data' => $this->transformValidationErrors($exception->data)
117                ];
118            }
119
120            throw $exception;
121        }
122    }
123}