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    /**
38     * @return array[]
39     *
40     */
41    public function getSchemaConstraintList($schema): array
42    {
43        $list = [];
44        $locale = \App::$language->getLocale();
45        foreach ($schema->properties as $key => $property) {
46            if (isset($property['x-locale'])) {
47                $constraints = $property['x-locale'][$locale];
48                if ($constraints) {
49                    $list[$key]['description'] = $constraints['messages'];
50                }
51            }
52        }
53        return $list;
54    }
55
56    /**
57     * Transform validation error data from JSON pointer format to field names
58     * Maps pointers like "/id" to "id", "/changePassword" to "changePassword", etc.
59     * Handles nested paths like "/contact/email" by flattening them.
60     * Also handles data that's already in field name format (for test compatibility).
61     *
62     * @param array|null $errorData The exception data with JSON pointers as keys, or field names
63     * @return array Transformed data with field names as keys
64     */
65    protected function transformValidationErrors($errorData)
66    {
67        if (!is_array($errorData) && !($errorData instanceof \Traversable)) {
68            return [];
69        }
70        $transformed = [];
71        foreach ($errorData as $pointer => $item) {
72            // Extract field name from JSON pointer (e.g., "/id" -> "id", "/contact/email" -> "contact/email")
73            // If the key doesn't start with "/", it's already a field name, so use it as-is
74            $fieldName = (strpos($pointer, '/') === 0) ? ltrim($pointer, '/') : $pointer;
75            // Handle root level errors
76            if ($fieldName === '' || $fieldName === null) {
77                $fieldName = '_root';
78            }
79            // Ensure the item structure is correct (has 'messages' array)
80            if (is_array($item) && isset($item['messages'])) {
81                $transformed[$fieldName] = $item;
82            } elseif (is_array($item)) {
83                // If item is an array but doesn't have 'messages', wrap it
84                $transformed[$fieldName] = $item;
85            } else {
86                $transformed[$fieldName] = $item;
87            }
88        }
89        return $transformed;
90    }
91
92    /**
93     * Wraps an HTTP write operation with standardized exception handling.
94     *
95     * @param callable $httpCall
96     * @return mixed
97     * @throws \BO\Zmsclient\Exception
98     */
99    protected function handleEntityWrite(callable $httpCall)
100    {
101        try {
102            return $httpCall();
103        } catch (\BO\Zmsclient\Exception $exception) {
104            if ('BO\Zmsentities\Exception\SchemaValidation' == $exception->template) {
105                return [
106                    'template' => 'exception/bo/zmsentities/exception/schemavalidation.twig',
107                    'include' => true,
108                    'data' => $this->transformValidationErrors($exception->data)
109                ];
110            }
111
112            $template = TwigExceptionHandler::getExceptionTemplate($exception);
113            if (
114                '' != $exception->template
115                && \App::$slim->getContainer()->get('view')->getLoader()->exists($template)
116            ) {
117                return [
118                    'template' => $template,
119                    'include' => true,
120                    'data' => $this->transformValidationErrors($exception->data)
121                ];
122            }
123
124            throw $exception;
125        }
126    }
127}