Validation/library/Message/Formatter/NestedArrayFormatter.php at 9f8c946a4514c6181969c04edfff97de2a52f4fc · Respect/Validation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?php

/*
 * Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
 * SPDX-License-Identifier: MIT
 */

declare(strict_types=1);

namespace Respect\Validation\Message\Formatter;

use Respect\Validation\Message\ArrayFormatter;
use Respect\Validation\Message\Renderer;
use Respect\Validation\Result;

use function array_reduce;
use function count;
use function current;
use function is_array;
use function is_numeric;

final readonly class NestedArrayFormatter implements ArrayFormatter
{
    /**
     * @param array<string|int, mixed> $templates
     *
     * @return array<string|int, mixed>
     */
    public function format(Result $result, Renderer $renderer, array $templates): array
    {
        if ($result->children === []) {
            return [$this->getKey($result) => $renderer->render($result, $templates)];
        }

        [$children, $hasString] = $this->prepareChildren($result->children);

        $messages = array_reduce(
            $children,
            fn(array $messages, array $item) => $this->appendMessage(
                $messages,
                $item['key'],
                $item['child'],
                $renderer,
                $templates,
                $hasString,
            ),
            [],
        );

        if (count($messages) > 1) {
            return ['__root__' => $renderer->render($result, $templates)] + $messages;
        }

        return $messages;
    }

    /**
     * @param array<Result> $children
     *
     * @return array{0: array<array{key: string|int, child: Result}>, 1: bool}
     */
    private function prepareChildren(array $children): array
    {
        $mapped = [];
        $hasString = false;

        foreach ($children as $child) {
            $key = $this->getKey($child);
            if (!is_numeric($key)) {
                $hasString = true;
            }

            $mapped[] = ['key' => $key, 'child' => $child];
        }

        return [$mapped, $hasString];
    }

    /**
     * @param array<string|int, mixed> $messages
     * @param array<string|int, mixed> $templates
     *
     * @return array<string|int, mixed>
     */
    private function appendMessage(
        array $messages,
        string|int $key,
        Result $child,
        Renderer $renderer,
        array $templates,
        bool $hasString,
    ): array {
        if ($hasString && is_numeric($key)) {
            $key = $child->id->value;
        }

        $message = $this->renderChild($child, $renderer, $templates);

        if (!$hasString) {
            $messages[] = $message;

            return $messages;
        }

        if (isset($messages[$key])) {
            if (!is_array($messages[$key])) {
                $messages[$key] = [$messages[$key]];
            }

            $messages[$key][] = $message;

            return $messages;
        }

        $messages[$key] = $message;

        return $messages;
    }

    /**
     * @param array<string|int, array<string>> $templates
     *
     * @return array<string>|string
     */
    private function renderChild(Result $child, Renderer $renderer, array $templates): array|string
    {
        $formatted = $this->format(
            $child->withoutName(),
            $renderer,
            $templates,
        );

        if (count($formatted) === 1) {
            return current($formatted);
        }

        return $formatted;
    }

    private function getKey(Result $result): string|int
    {
        return $result->path->value ?? $result->id->value;
    }
}