@@ -15,183 +15,183 @@ |
||
15 | 15 | */ |
16 | 16 | class Validator |
17 | 17 | { |
18 | - /** @var string */ |
|
19 | - public const TYPE_STRING = 'string'; |
|
20 | - |
|
21 | - /** @var string */ |
|
22 | - public const TYPE_INTEGER = 'integer'; |
|
23 | - |
|
24 | - /** @var string */ |
|
25 | - public const TYPE_BOOL = 'boolean'; |
|
26 | - |
|
27 | - /** @var string */ |
|
28 | - public const TYPE_ARRAY = 'array'; |
|
29 | - |
|
30 | - /** @var string */ |
|
31 | - public const TYPE_OBJECT = 'object'; |
|
32 | - |
|
33 | - /** @var string */ |
|
34 | - public const TYPE_NULL = 'NULL'; |
|
35 | - |
|
36 | - /** |
|
37 | - * Checks if given $val is of type boolean |
|
38 | - * |
|
39 | - * @param string $key Name of the key to be used if exception is thrown. |
|
40 | - * @param mixed $var Variable to be asserted. |
|
41 | - * |
|
42 | - * @return void |
|
43 | - * |
|
44 | - * @throws \InvalidArgumentException |
|
45 | - */ |
|
46 | - public static function assertIsBool(string $key, $var): void |
|
47 | - { |
|
48 | - self::assertIsType($key, $var, [self::TYPE_BOOL]); |
|
49 | - } |
|
50 | - |
|
51 | - /** |
|
52 | - * Checks if given $val is of type integer |
|
53 | - * |
|
54 | - * @param string $key Name of the key to be used if exception is thrown. |
|
55 | - * @param mixed $var Variable to be asserted. |
|
56 | - * |
|
57 | - * @return void |
|
58 | - * |
|
59 | - * @throws \InvalidArgumentException |
|
60 | - */ |
|
61 | - public static function assertIsInt(string $key, $var): void |
|
62 | - { |
|
63 | - self::assertIsType($key, $var, [self::TYPE_INTEGER]); |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * Checks if given $val is of type array |
|
68 | - * |
|
69 | - * @param string $key Name of the key to be used if exception is thrown. |
|
70 | - * @param mixed $var Variable to be asserted. |
|
71 | - * |
|
72 | - * @return void |
|
73 | - * |
|
74 | - * @throws \InvalidArgumentException |
|
75 | - */ |
|
76 | - public static function assertIsArray(string $key, $var): void |
|
77 | - { |
|
78 | - self::assertIsType($key, $var, [self::TYPE_ARRAY]); |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * Checks if given $val is an object |
|
83 | - * |
|
84 | - * @param string $key Name of the key to be used if exception is thrown. |
|
85 | - * @param mixed $var Variable to be asserted. |
|
86 | - * |
|
87 | - * @return void |
|
88 | - * |
|
89 | - * @throws \InvalidArgumentException |
|
90 | - */ |
|
91 | - public static function assertIsObject(string $key, $var): void |
|
92 | - { |
|
93 | - self::assertIsType($key, $var, [self::TYPE_OBJECT]); |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * Checks if given $val is of type string |
|
98 | - * |
|
99 | - * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
100 | - * @param mixed $var Variable to be asserted. |
|
101 | - * |
|
102 | - * @return void |
|
103 | - * |
|
104 | - * @throws \InvalidArgumentException |
|
105 | - */ |
|
106 | - public static function assertIsString(string $name, $var): void |
|
107 | - { |
|
108 | - self::assertIsType($name, $var, [self::TYPE_STRING]); |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
113 | - * @param mixed $var Variable to be asserted. |
|
114 | - * @param int $min Min allowed value (inclusive) |
|
115 | - * @param int $max Max allowed value (inclusive) |
|
116 | - * |
|
117 | - * @return void |
|
118 | - * |
|
119 | - * @throws \InvalidArgumentException |
|
120 | - * @throws \RuntimeException |
|
121 | - */ |
|
122 | - public static function assertIsIntRange(string $name, $var, int $min, int $max): void |
|
123 | - { |
|
124 | - self::assertIsInt($name, $var); |
|
125 | - |
|
126 | - if ($min > $max) { |
|
127 | - throw new \RuntimeException( |
|
128 | - \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name)); |
|
129 | - } |
|
130 | - |
|
131 | - if (($min > $var) || ($var > $max)) { |
|
132 | - throw new \InvalidArgumentException( |
|
133 | - \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $name, $var, $min, $max)); |
|
134 | - } |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * Checks if $item (of name $key) is of type that is include in $allowed_types. |
|
139 | - * |
|
140 | - * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
141 | - * @param mixed $var Variable to be asserted. |
|
142 | - * @param array $allowed_types Array of allowed types for $var, i.e. [Validator::TYPE_INTEGER] |
|
143 | - * |
|
144 | - * @return void |
|
145 | - * |
|
146 | - * @throws \InvalidArgumentException |
|
147 | - */ |
|
148 | - public static function assertIsType(string $name, $var, array $allowed_types): void |
|
149 | - { |
|
150 | - $type = \gettype($var); |
|
151 | - if (!\in_array($type, $allowed_types)) { |
|
152 | - throw new \InvalidArgumentException( |
|
153 | - \sprintf('"%s" must be one of allowed types: %s (%s given)', |
|
154 | - $name, implode(', ', $allowed_types), \gettype($var)) |
|
155 | - ); |
|
156 | - } |
|
157 | - } |
|
158 | - |
|
159 | - /** |
|
160 | - * Ensures given $http_code is valid code for error response. |
|
161 | - * |
|
162 | - * @param int $http_code |
|
163 | - */ |
|
164 | - public static function assertErrorHttpCode(int $http_code): void |
|
165 | - { |
|
166 | - self::assertIsInt('http_code', $http_code); |
|
167 | - self::assertIsIntRange('http_code', $http_code, |
|
168 | - ResponseBuilder::ERROR_HTTP_CODE_MIN, ResponseBuilder::ERROR_HTTP_CODE_MAX); |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * Ensures given $http_code is valid for response indicating sucessful operation. |
|
173 | - * |
|
174 | - * @param int $http_code |
|
175 | - */ |
|
176 | - public static function assertOkHttpCode(int $http_code): void |
|
177 | - { |
|
178 | - self::assertIsInt('http_code', $http_code); |
|
179 | - self::assertIsIntRange('http_code', $http_code, 200, 299); |
|
180 | - } |
|
181 | - |
|
182 | - /** |
|
183 | - * Ensures $obj is instance of $cls. |
|
184 | - * |
|
185 | - * @param string $name |
|
186 | - * @param object $obj |
|
187 | - * @param string $cls |
|
188 | - */ |
|
189 | - public static function assertInstanceOf(string $name, object $obj, string $cls): void |
|
190 | - { |
|
191 | - if (!($obj instanceof $cls)) { |
|
192 | - throw new \InvalidArgumentException( |
|
193 | - \sprintf('"%s" must be instance of "%s".', $name, $cls) |
|
194 | - ); |
|
195 | - } |
|
196 | - } |
|
18 | + /** @var string */ |
|
19 | + public const TYPE_STRING = 'string'; |
|
20 | + |
|
21 | + /** @var string */ |
|
22 | + public const TYPE_INTEGER = 'integer'; |
|
23 | + |
|
24 | + /** @var string */ |
|
25 | + public const TYPE_BOOL = 'boolean'; |
|
26 | + |
|
27 | + /** @var string */ |
|
28 | + public const TYPE_ARRAY = 'array'; |
|
29 | + |
|
30 | + /** @var string */ |
|
31 | + public const TYPE_OBJECT = 'object'; |
|
32 | + |
|
33 | + /** @var string */ |
|
34 | + public const TYPE_NULL = 'NULL'; |
|
35 | + |
|
36 | + /** |
|
37 | + * Checks if given $val is of type boolean |
|
38 | + * |
|
39 | + * @param string $key Name of the key to be used if exception is thrown. |
|
40 | + * @param mixed $var Variable to be asserted. |
|
41 | + * |
|
42 | + * @return void |
|
43 | + * |
|
44 | + * @throws \InvalidArgumentException |
|
45 | + */ |
|
46 | + public static function assertIsBool(string $key, $var): void |
|
47 | + { |
|
48 | + self::assertIsType($key, $var, [self::TYPE_BOOL]); |
|
49 | + } |
|
50 | + |
|
51 | + /** |
|
52 | + * Checks if given $val is of type integer |
|
53 | + * |
|
54 | + * @param string $key Name of the key to be used if exception is thrown. |
|
55 | + * @param mixed $var Variable to be asserted. |
|
56 | + * |
|
57 | + * @return void |
|
58 | + * |
|
59 | + * @throws \InvalidArgumentException |
|
60 | + */ |
|
61 | + public static function assertIsInt(string $key, $var): void |
|
62 | + { |
|
63 | + self::assertIsType($key, $var, [self::TYPE_INTEGER]); |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * Checks if given $val is of type array |
|
68 | + * |
|
69 | + * @param string $key Name of the key to be used if exception is thrown. |
|
70 | + * @param mixed $var Variable to be asserted. |
|
71 | + * |
|
72 | + * @return void |
|
73 | + * |
|
74 | + * @throws \InvalidArgumentException |
|
75 | + */ |
|
76 | + public static function assertIsArray(string $key, $var): void |
|
77 | + { |
|
78 | + self::assertIsType($key, $var, [self::TYPE_ARRAY]); |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * Checks if given $val is an object |
|
83 | + * |
|
84 | + * @param string $key Name of the key to be used if exception is thrown. |
|
85 | + * @param mixed $var Variable to be asserted. |
|
86 | + * |
|
87 | + * @return void |
|
88 | + * |
|
89 | + * @throws \InvalidArgumentException |
|
90 | + */ |
|
91 | + public static function assertIsObject(string $key, $var): void |
|
92 | + { |
|
93 | + self::assertIsType($key, $var, [self::TYPE_OBJECT]); |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * Checks if given $val is of type string |
|
98 | + * |
|
99 | + * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
100 | + * @param mixed $var Variable to be asserted. |
|
101 | + * |
|
102 | + * @return void |
|
103 | + * |
|
104 | + * @throws \InvalidArgumentException |
|
105 | + */ |
|
106 | + public static function assertIsString(string $name, $var): void |
|
107 | + { |
|
108 | + self::assertIsType($name, $var, [self::TYPE_STRING]); |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
113 | + * @param mixed $var Variable to be asserted. |
|
114 | + * @param int $min Min allowed value (inclusive) |
|
115 | + * @param int $max Max allowed value (inclusive) |
|
116 | + * |
|
117 | + * @return void |
|
118 | + * |
|
119 | + * @throws \InvalidArgumentException |
|
120 | + * @throws \RuntimeException |
|
121 | + */ |
|
122 | + public static function assertIsIntRange(string $name, $var, int $min, int $max): void |
|
123 | + { |
|
124 | + self::assertIsInt($name, $var); |
|
125 | + |
|
126 | + if ($min > $max) { |
|
127 | + throw new \RuntimeException( |
|
128 | + \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name)); |
|
129 | + } |
|
130 | + |
|
131 | + if (($min > $var) || ($var > $max)) { |
|
132 | + throw new \InvalidArgumentException( |
|
133 | + \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $name, $var, $min, $max)); |
|
134 | + } |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * Checks if $item (of name $key) is of type that is include in $allowed_types. |
|
139 | + * |
|
140 | + * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
141 | + * @param mixed $var Variable to be asserted. |
|
142 | + * @param array $allowed_types Array of allowed types for $var, i.e. [Validator::TYPE_INTEGER] |
|
143 | + * |
|
144 | + * @return void |
|
145 | + * |
|
146 | + * @throws \InvalidArgumentException |
|
147 | + */ |
|
148 | + public static function assertIsType(string $name, $var, array $allowed_types): void |
|
149 | + { |
|
150 | + $type = \gettype($var); |
|
151 | + if (!\in_array($type, $allowed_types)) { |
|
152 | + throw new \InvalidArgumentException( |
|
153 | + \sprintf('"%s" must be one of allowed types: %s (%s given)', |
|
154 | + $name, implode(', ', $allowed_types), \gettype($var)) |
|
155 | + ); |
|
156 | + } |
|
157 | + } |
|
158 | + |
|
159 | + /** |
|
160 | + * Ensures given $http_code is valid code for error response. |
|
161 | + * |
|
162 | + * @param int $http_code |
|
163 | + */ |
|
164 | + public static function assertErrorHttpCode(int $http_code): void |
|
165 | + { |
|
166 | + self::assertIsInt('http_code', $http_code); |
|
167 | + self::assertIsIntRange('http_code', $http_code, |
|
168 | + ResponseBuilder::ERROR_HTTP_CODE_MIN, ResponseBuilder::ERROR_HTTP_CODE_MAX); |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * Ensures given $http_code is valid for response indicating sucessful operation. |
|
173 | + * |
|
174 | + * @param int $http_code |
|
175 | + */ |
|
176 | + public static function assertOkHttpCode(int $http_code): void |
|
177 | + { |
|
178 | + self::assertIsInt('http_code', $http_code); |
|
179 | + self::assertIsIntRange('http_code', $http_code, 200, 299); |
|
180 | + } |
|
181 | + |
|
182 | + /** |
|
183 | + * Ensures $obj is instance of $cls. |
|
184 | + * |
|
185 | + * @param string $name |
|
186 | + * @param object $obj |
|
187 | + * @param string $cls |
|
188 | + */ |
|
189 | + public static function assertInstanceOf(string $name, object $obj, string $cls): void |
|
190 | + { |
|
191 | + if (!($obj instanceof $cls)) { |
|
192 | + throw new \InvalidArgumentException( |
|
193 | + \sprintf('"%s" must be instance of "%s".', $name, $cls) |
|
194 | + ); |
|
195 | + } |
|
196 | + } |
|
197 | 197 | } |
@@ -12,78 +12,78 @@ discard block |
||
12 | 12 | */ |
13 | 13 | |
14 | 14 | return [ |
15 | - /* |
|
15 | + /* |
|
16 | 16 | |----------------------------------------------------------------------------------------------------------- |
17 | 17 | | Code range settings |
18 | 18 | |----------------------------------------------------------------------------------------------------------- |
19 | 19 | */ |
20 | - 'min_code' => 100, |
|
21 | - 'max_code' => 1024, |
|
20 | + 'min_code' => 100, |
|
21 | + 'max_code' => 1024, |
|
22 | 22 | |
23 | - /* |
|
23 | + /* |
|
24 | 24 | |----------------------------------------------------------------------------------------------------------- |
25 | 25 | | Error code to message mapping |
26 | 26 | |----------------------------------------------------------------------------------------------------------- |
27 | 27 | | |
28 | 28 | */ |
29 | - 'map' => [ |
|
30 | - // YOUR_API_CODE => '<MESSAGE_KEY>', |
|
31 | - ], |
|
29 | + 'map' => [ |
|
30 | + // YOUR_API_CODE => '<MESSAGE_KEY>', |
|
31 | + ], |
|
32 | 32 | |
33 | - /* |
|
33 | + /* |
|
34 | 34 | |----------------------------------------------------------------------------------------------------------- |
35 | 35 | | Response Builder data converter |
36 | 36 | |----------------------------------------------------------------------------------------------------------- |
37 | 37 | | |
38 | 38 | */ |
39 | - 'converter' => [ |
|
40 | - \Illuminate\Database\Eloquent\Model::class => [ |
|
41 | - 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
42 | - // 'key' => 'item', |
|
43 | - 'pri' => 0, |
|
44 | - ], |
|
45 | - \Illuminate\Support\Collection::class => [ |
|
46 | - 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
47 | - // 'key' => 'item', |
|
48 | - 'pri' => 0, |
|
49 | - ], |
|
50 | - \Illuminate\Database\Eloquent\Collection::class => [ |
|
51 | - 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
52 | - // 'key' => 'item', |
|
53 | - 'pri' => 0, |
|
54 | - ], |
|
55 | - \Illuminate\Http\Resources\Json\JsonResource::class => [ |
|
56 | - 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
57 | - // 'key' => 'item', |
|
58 | - 'pri' => 0, |
|
59 | - ], |
|
39 | + 'converter' => [ |
|
40 | + \Illuminate\Database\Eloquent\Model::class => [ |
|
41 | + 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
42 | + // 'key' => 'item', |
|
43 | + 'pri' => 0, |
|
44 | + ], |
|
45 | + \Illuminate\Support\Collection::class => [ |
|
46 | + 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
47 | + // 'key' => 'item', |
|
48 | + 'pri' => 0, |
|
49 | + ], |
|
50 | + \Illuminate\Database\Eloquent\Collection::class => [ |
|
51 | + 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
52 | + // 'key' => 'item', |
|
53 | + 'pri' => 0, |
|
54 | + ], |
|
55 | + \Illuminate\Http\Resources\Json\JsonResource::class => [ |
|
56 | + 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class, |
|
57 | + // 'key' => 'item', |
|
58 | + 'pri' => 0, |
|
59 | + ], |
|
60 | 60 | |
61 | - /* |
|
61 | + /* |
|
62 | 62 | |----------------------------------------------------------------------------------------------------------- |
63 | 63 | | Generic converters should have lower pri to allow dedicated ones to kick in first when class matches |
64 | 64 | |----------------------------------------------------------------------------------------------------------- |
65 | 65 | */ |
66 | - \JsonSerializable::class => [ |
|
67 | - 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class, |
|
68 | - // 'key' => 'item', |
|
69 | - 'pri' => -10, |
|
70 | - ], |
|
71 | - \Illuminate\Contracts\Support\Arrayable::class => [ |
|
72 | - 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class, |
|
73 | - // 'key' => 'item', |
|
74 | - 'pri' => -10, |
|
75 | - ], |
|
66 | + \JsonSerializable::class => [ |
|
67 | + 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class, |
|
68 | + // 'key' => 'item', |
|
69 | + 'pri' => -10, |
|
70 | + ], |
|
71 | + \Illuminate\Contracts\Support\Arrayable::class => [ |
|
72 | + 'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class, |
|
73 | + // 'key' => 'item', |
|
74 | + 'pri' => -10, |
|
75 | + ], |
|
76 | 76 | |
77 | - ], |
|
77 | + ], |
|
78 | 78 | |
79 | - /* |
|
79 | + /* |
|
80 | 80 | |----------------------------------------------------------------------------------------------------------- |
81 | 81 | | Exception handler error codes |
82 | 82 | |----------------------------------------------------------------------------------------------------------- |
83 | 83 | | |
84 | 84 | */ |
85 | - 'exception_handler' => [ |
|
86 | - /* |
|
85 | + 'exception_handler' => [ |
|
86 | + /* |
|
87 | 87 | * The following keys are supported for each handler specified. |
88 | 88 | * `handler` |
89 | 89 | * `pri` |
@@ -103,19 +103,19 @@ discard block |
||
103 | 103 | * message ($ex->getMessage()). |
104 | 104 | */ |
105 | 105 | |
106 | - \Illuminate\Validation\ValidationException::class => [ |
|
107 | - 'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class, |
|
108 | - 'pri' => -100, |
|
109 | - 'config' => [ |
|
106 | + \Illuminate\Validation\ValidationException::class => [ |
|
107 | + 'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class, |
|
108 | + 'pri' => -100, |
|
109 | + 'config' => [ |
|
110 | 110 | // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION, |
111 | 111 | // 'http_code' => HttpResponse::HTTP_UNPROCESSABLE_ENTITY, |
112 | - ], |
|
113 | - ], |
|
112 | + ], |
|
113 | + ], |
|
114 | 114 | |
115 | 115 | \Symfony\Component\HttpKernel\Exception\HttpException::class => [ |
116 | - 'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class, |
|
117 | - 'pri' => -100, |
|
118 | - 'config' => [ |
|
116 | + 'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class, |
|
117 | + 'pri' => -100, |
|
118 | + 'config' => [ |
|
119 | 119 | // HttpException::class => [ |
120 | 120 | // // used by unauthenticated() to obtain api and http code for the exception |
121 | 121 | // HttpResponse::HTTP_UNAUTHORIZED => [ |
@@ -131,41 +131,41 @@ discard block |
||
131 | 131 | // 'http_code' => HttpResponse::HTTP_BAD_REQUEST, |
132 | 132 | // ], |
133 | 133 | // ], |
134 | - ], |
|
134 | + ], |
|
135 | 135 | // // This is final exception handler. If ex is not dealt with yet this is its last stop. |
136 | - // default handler is mandatory and MUST have both `api_code` and `http_code` set. |
|
136 | + // default handler is mandatory and MUST have both `api_code` and `http_code` set. |
|
137 | 137 | |
138 | - 'default' => [ |
|
139 | - 'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class, |
|
140 | - 'pri' => -127, |
|
141 | - 'config' => [ |
|
138 | + 'default' => [ |
|
139 | + 'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class, |
|
140 | + 'pri' => -127, |
|
141 | + 'config' => [ |
|
142 | 142 | // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION, |
143 | 143 | // 'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR, |
144 | - ], |
|
145 | - ], |
|
146 | - ], |
|
147 | - ], |
|
144 | + ], |
|
145 | + ], |
|
146 | + ], |
|
147 | + ], |
|
148 | 148 | |
149 | - /* |
|
149 | + /* |
|
150 | 150 | |----------------------------------------------------------------------------------------------------------- |
151 | 151 | | data-to-json encoding options |
152 | 152 | |----------------------------------------------------------------------------------------------------------- |
153 | 153 | | |
154 | 154 | */ |
155 | - 'encoding_options' => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE, |
|
155 | + 'encoding_options' => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE, |
|
156 | 156 | |
157 | - /* |
|
157 | + /* |
|
158 | 158 | |----------------------------------------------------------------------------------------------------------- |
159 | 159 | | Debug config |
160 | 160 | |----------------------------------------------------------------------------------------------------------- |
161 | 161 | | |
162 | 162 | */ |
163 | - 'debug' => [ |
|
164 | - 'debug_key' => 'debug', |
|
165 | - 'exception_handler' => [ |
|
166 | - 'trace_key' => 'trace', |
|
167 | - 'trace_enabled' => env('APP_DEBUG', false), |
|
168 | - ], |
|
169 | - ], |
|
163 | + 'debug' => [ |
|
164 | + 'debug_key' => 'debug', |
|
165 | + 'exception_handler' => [ |
|
166 | + 'trace_key' => 'trace', |
|
167 | + 'trace_enabled' => env('APP_DEBUG', false), |
|
168 | + ], |
|
169 | + ], |
|
170 | 170 | |
171 | 171 | ]; |
@@ -10,58 +10,58 @@ |
||
10 | 10 | */ |
11 | 11 | return [ |
12 | 12 | |
13 | - 'ok' => 'OK', |
|
14 | - 'no_error_message' => 'Fehler #:api_code', |
|
13 | + 'ok' => 'OK', |
|
14 | + 'no_error_message' => 'Fehler #:api_code', |
|
15 | 15 | |
16 | - // Used by Exception Handler Helper (when used) |
|
17 | - 'uncaught_exception' => 'Ungefangene Ausnahme: :message', |
|
18 | - 'http_exception' => 'HTTP Ausnahme: :message', |
|
16 | + // Used by Exception Handler Helper (when used) |
|
17 | + 'uncaught_exception' => 'Ungefangene Ausnahme: :message', |
|
18 | + 'http_exception' => 'HTTP Ausnahme: :message', |
|
19 | 19 | |
20 | - // HttpException handler (added in 6.4.0) |
|
21 | - // Error messages for HttpException caught w/o custom messages |
|
22 | - // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
23 | - // |
|
24 | - // German translation based on https://wiki.selfhtml.org/wiki/HTTP/Statuscodes |
|
25 | - 'http_400' => 'Ungültige Anfrage', |
|
26 | - 'http_401' => 'Unautorisiert', |
|
27 | - 'http_402' => 'Bezahlung benötigt', |
|
28 | - 'http_403' => 'Verboten', |
|
29 | - 'http_404' => 'Nicht gefunden', |
|
30 | - 'http_405' => 'Methode nicht erlaubt', |
|
31 | - 'http_406' => 'Nicht akzeptabel', |
|
32 | - 'http_407' => 'Proxy-Authentifizierung benötigt', |
|
33 | - 'http_408' => 'Anfrage-Zeitüberschreitung', |
|
34 | - 'http_409' => 'Konflikt', |
|
35 | - 'http_410' => 'Verschwunden', |
|
36 | - 'http_411' => 'Länge benötigt', |
|
37 | - 'http_412' => 'Vorbedingung missglückt', |
|
38 | - 'http_413' => 'Anfrage-Entität zu groß', |
|
39 | - 'http_414' => 'Anfrage-URI zu lang', |
|
40 | - 'http_415' => 'Nicht unterstützter Medientyp', |
|
41 | - 'http_416' => 'Anfrage-Bereich nicht erfüllbar', |
|
42 | - 'http_417' => 'Erwartung missglückt', |
|
43 | - 'http_421' => 'Fehlgeleitete Anforderung', |
|
44 | - 'http_422' => 'Kann nicht verarbeitet werden', |
|
45 | - 'http_423' => 'Gesperrt', |
|
46 | - 'http_424' => 'Vorhergehende Bedingung nicht erfüllt', |
|
47 | - 'http_425' => 'Too Early', // FIXME |
|
48 | - 'http_426' => 'Update benötigt', |
|
49 | - 'http_428' => ' Vorbedingung benötigt', |
|
50 | - 'http_429' => 'Zu viele Anfragen', |
|
51 | - 'http_431' => 'Headerfelds zu groß', |
|
52 | - 'http_451' => 'Ressource aus rechtlichen Gründen nicht verfügbar', |
|
20 | + // HttpException handler (added in 6.4.0) |
|
21 | + // Error messages for HttpException caught w/o custom messages |
|
22 | + // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
23 | + // |
|
24 | + // German translation based on https://wiki.selfhtml.org/wiki/HTTP/Statuscodes |
|
25 | + 'http_400' => 'Ungültige Anfrage', |
|
26 | + 'http_401' => 'Unautorisiert', |
|
27 | + 'http_402' => 'Bezahlung benötigt', |
|
28 | + 'http_403' => 'Verboten', |
|
29 | + 'http_404' => 'Nicht gefunden', |
|
30 | + 'http_405' => 'Methode nicht erlaubt', |
|
31 | + 'http_406' => 'Nicht akzeptabel', |
|
32 | + 'http_407' => 'Proxy-Authentifizierung benötigt', |
|
33 | + 'http_408' => 'Anfrage-Zeitüberschreitung', |
|
34 | + 'http_409' => 'Konflikt', |
|
35 | + 'http_410' => 'Verschwunden', |
|
36 | + 'http_411' => 'Länge benötigt', |
|
37 | + 'http_412' => 'Vorbedingung missglückt', |
|
38 | + 'http_413' => 'Anfrage-Entität zu groß', |
|
39 | + 'http_414' => 'Anfrage-URI zu lang', |
|
40 | + 'http_415' => 'Nicht unterstützter Medientyp', |
|
41 | + 'http_416' => 'Anfrage-Bereich nicht erfüllbar', |
|
42 | + 'http_417' => 'Erwartung missglückt', |
|
43 | + 'http_421' => 'Fehlgeleitete Anforderung', |
|
44 | + 'http_422' => 'Kann nicht verarbeitet werden', |
|
45 | + 'http_423' => 'Gesperrt', |
|
46 | + 'http_424' => 'Vorhergehende Bedingung nicht erfüllt', |
|
47 | + 'http_425' => 'Too Early', // FIXME |
|
48 | + 'http_426' => 'Update benötigt', |
|
49 | + 'http_428' => ' Vorbedingung benötigt', |
|
50 | + 'http_429' => 'Zu viele Anfragen', |
|
51 | + 'http_431' => 'Headerfelds zu groß', |
|
52 | + 'http_451' => 'Ressource aus rechtlichen Gründen nicht verfügbar', |
|
53 | 53 | |
54 | - 'http_500' => 'Interner Server-Fehler', |
|
55 | - 'http_501' => 'Nicht implementiert', |
|
56 | - 'http_502' => 'Schlechtes Portal', |
|
57 | - 'http_503' => 'Dienst nicht verfügbar', |
|
58 | - 'http_504' => 'Portal-Auszeit', |
|
59 | - 'http_505' => 'HTTP-Version nicht unterstützt', |
|
60 | - 'http_506' => 'Variant Also Negotiates', // FIXME |
|
61 | - 'http_507' => 'Speicher des Servers reicht nicht aus', |
|
62 | - 'http_508' => 'Endlosschleife', |
|
63 | - 'http_509' => 'Unassigned', // FIXME |
|
64 | - 'http_510' => 'Zu wenig Informationen', |
|
65 | - 'http_511' => 'Identizifierung benötigt', |
|
54 | + 'http_500' => 'Interner Server-Fehler', |
|
55 | + 'http_501' => 'Nicht implementiert', |
|
56 | + 'http_502' => 'Schlechtes Portal', |
|
57 | + 'http_503' => 'Dienst nicht verfügbar', |
|
58 | + 'http_504' => 'Portal-Auszeit', |
|
59 | + 'http_505' => 'HTTP-Version nicht unterstützt', |
|
60 | + 'http_506' => 'Variant Also Negotiates', // FIXME |
|
61 | + 'http_507' => 'Speicher des Servers reicht nicht aus', |
|
62 | + 'http_508' => 'Endlosschleife', |
|
63 | + 'http_509' => 'Unassigned', // FIXME |
|
64 | + 'http_510' => 'Zu wenig Informationen', |
|
65 | + 'http_511' => 'Identizifierung benötigt', |
|
66 | 66 | ]; |
67 | 67 |
@@ -44,7 +44,7 @@ discard block |
||
44 | 44 | 'http_422' => 'Kann nicht verarbeitet werden', |
45 | 45 | 'http_423' => 'Gesperrt', |
46 | 46 | 'http_424' => 'Vorhergehende Bedingung nicht erfüllt', |
47 | - 'http_425' => 'Too Early', // FIXME |
|
47 | + 'http_425' => 'Too Early', // FIXME |
|
48 | 48 | 'http_426' => 'Update benötigt', |
49 | 49 | 'http_428' => ' Vorbedingung benötigt', |
50 | 50 | 'http_429' => 'Zu viele Anfragen', |
@@ -57,10 +57,10 @@ discard block |
||
57 | 57 | 'http_503' => 'Dienst nicht verfügbar', |
58 | 58 | 'http_504' => 'Portal-Auszeit', |
59 | 59 | 'http_505' => 'HTTP-Version nicht unterstützt', |
60 | - 'http_506' => 'Variant Also Negotiates', // FIXME |
|
60 | + 'http_506' => 'Variant Also Negotiates', // FIXME |
|
61 | 61 | 'http_507' => 'Speicher des Servers reicht nicht aus', |
62 | 62 | 'http_508' => 'Endlosschleife', |
63 | - 'http_509' => 'Unassigned', // FIXME |
|
63 | + 'http_509' => 'Unassigned', // FIXME |
|
64 | 64 | 'http_510' => 'Zu wenig Informationen', |
65 | 65 | 'http_511' => 'Identizifierung benötigt', |
66 | 66 | ]; |
@@ -10,56 +10,56 @@ |
||
10 | 10 | */ |
11 | 11 | return [ |
12 | 12 | |
13 | - 'ok' => 'OK', |
|
14 | - 'no_error_message' => 'Error #:api_code', |
|
13 | + 'ok' => 'OK', |
|
14 | + 'no_error_message' => 'Error #:api_code', |
|
15 | 15 | |
16 | - // Used by Exception Handler Helper (when used) |
|
17 | - 'uncaught_exception' => 'Uncaught exception: :message', |
|
18 | - 'http_exception' => 'HTTP exception: :message', |
|
16 | + // Used by Exception Handler Helper (when used) |
|
17 | + 'uncaught_exception' => 'Uncaught exception: :message', |
|
18 | + 'http_exception' => 'HTTP exception: :message', |
|
19 | 19 | |
20 | - // HttpException handler (added in 6.4.0) |
|
21 | - // Error messages for HttpException caught w/o custom messages |
|
22 | - // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
23 | - 'http_400' => 'Bad Request', |
|
24 | - 'http_401' => 'Unauthorized', |
|
25 | - 'http_402' => 'Payment Required', |
|
26 | - 'http_403' => 'Forbidden', |
|
27 | - 'http_404' => 'Not Found', |
|
28 | - 'http_405' => 'Method Not Allowed', |
|
29 | - 'http_406' => 'Not Acceptable', |
|
30 | - 'http_407' => 'Proxy Authentication Required', |
|
31 | - 'http_408' => 'Request Timeout', |
|
32 | - 'http_409' => 'Conflict', |
|
33 | - 'http_410' => 'Gone', |
|
34 | - 'http_411' => 'Length Required', |
|
35 | - 'http_412' => 'Precondition Failed', |
|
36 | - 'http_413' => 'Payload Too Large', |
|
37 | - 'http_414' => 'URI Too Long', |
|
38 | - 'http_415' => 'Unsupported Media Type', |
|
39 | - 'http_416' => 'Range Not Satisfiable', |
|
40 | - 'http_417' => 'Expectation Failed', |
|
41 | - 'http_421' => 'Misdirected Request', |
|
42 | - 'http_422' => 'Unprocessable Entity', |
|
43 | - 'http_423' => 'Locked', |
|
44 | - 'http_424' => 'Failed Dependency', |
|
45 | - 'http_425' => 'Too Early', |
|
46 | - 'http_426' => 'Upgrade Required', |
|
47 | - 'http_428' => 'Precondition Required', |
|
48 | - 'http_429' => 'Too Many Requests', |
|
49 | - 'http_431' => 'Request Header Fields Too Large', |
|
50 | - 'http_451' => 'Unavailable For Legal Reasons', |
|
20 | + // HttpException handler (added in 6.4.0) |
|
21 | + // Error messages for HttpException caught w/o custom messages |
|
22 | + // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
23 | + 'http_400' => 'Bad Request', |
|
24 | + 'http_401' => 'Unauthorized', |
|
25 | + 'http_402' => 'Payment Required', |
|
26 | + 'http_403' => 'Forbidden', |
|
27 | + 'http_404' => 'Not Found', |
|
28 | + 'http_405' => 'Method Not Allowed', |
|
29 | + 'http_406' => 'Not Acceptable', |
|
30 | + 'http_407' => 'Proxy Authentication Required', |
|
31 | + 'http_408' => 'Request Timeout', |
|
32 | + 'http_409' => 'Conflict', |
|
33 | + 'http_410' => 'Gone', |
|
34 | + 'http_411' => 'Length Required', |
|
35 | + 'http_412' => 'Precondition Failed', |
|
36 | + 'http_413' => 'Payload Too Large', |
|
37 | + 'http_414' => 'URI Too Long', |
|
38 | + 'http_415' => 'Unsupported Media Type', |
|
39 | + 'http_416' => 'Range Not Satisfiable', |
|
40 | + 'http_417' => 'Expectation Failed', |
|
41 | + 'http_421' => 'Misdirected Request', |
|
42 | + 'http_422' => 'Unprocessable Entity', |
|
43 | + 'http_423' => 'Locked', |
|
44 | + 'http_424' => 'Failed Dependency', |
|
45 | + 'http_425' => 'Too Early', |
|
46 | + 'http_426' => 'Upgrade Required', |
|
47 | + 'http_428' => 'Precondition Required', |
|
48 | + 'http_429' => 'Too Many Requests', |
|
49 | + 'http_431' => 'Request Header Fields Too Large', |
|
50 | + 'http_451' => 'Unavailable For Legal Reasons', |
|
51 | 51 | |
52 | - 'http_500' => 'Internal Server Error', |
|
53 | - 'http_501' => 'Not Implemented', |
|
54 | - 'http_502' => 'Bad Gateway', |
|
55 | - 'http_503' => 'Service Unavailable', |
|
56 | - 'http_504' => 'Gateway Timeout', |
|
57 | - 'http_505' => 'HTTP Version Not Supported', |
|
58 | - 'http_506' => 'Variant Also Negotiates', |
|
59 | - 'http_507' => 'Insufficient Storage', |
|
60 | - 'http_508' => 'Loop Detected', |
|
61 | - 'http_509' => 'Unassigned', |
|
62 | - 'http_510' => 'Not Extended', |
|
63 | - 'http_511' => 'Network Authentication Required', |
|
52 | + 'http_500' => 'Internal Server Error', |
|
53 | + 'http_501' => 'Not Implemented', |
|
54 | + 'http_502' => 'Bad Gateway', |
|
55 | + 'http_503' => 'Service Unavailable', |
|
56 | + 'http_504' => 'Gateway Timeout', |
|
57 | + 'http_505' => 'HTTP Version Not Supported', |
|
58 | + 'http_506' => 'Variant Also Negotiates', |
|
59 | + 'http_507' => 'Insufficient Storage', |
|
60 | + 'http_508' => 'Loop Detected', |
|
61 | + 'http_509' => 'Unassigned', |
|
62 | + 'http_510' => 'Not Extended', |
|
63 | + 'http_511' => 'Network Authentication Required', |
|
64 | 64 | ]; |
65 | 65 |
@@ -10,55 +10,55 @@ |
||
10 | 10 | */ |
11 | 11 | return [ |
12 | 12 | |
13 | - 'ok' => 'OK', |
|
14 | - 'no_error_message' => 'Błąd #:api_code', |
|
13 | + 'ok' => 'OK', |
|
14 | + 'no_error_message' => 'Błąd #:api_code', |
|
15 | 15 | |
16 | - // Used by Exception Handler Helper (when used) |
|
17 | - 'uncaught_exception' => 'Nieprzechwycony wyjątek: :message', |
|
18 | - 'http_exception' => 'Wyjątek HTTP: :message', |
|
16 | + // Used by Exception Handler Helper (when used) |
|
17 | + 'uncaught_exception' => 'Nieprzechwycony wyjątek: :message', |
|
18 | + 'http_exception' => 'Wyjątek HTTP: :message', |
|
19 | 19 | |
20 | - // HttpException handler (added in 6.4.0) |
|
21 | - // Error messages for HttpException caught w/o custom messages |
|
22 | - // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
23 | - 'http_400' => 'Bad Request', |
|
24 | - 'http_401' => 'Unauthorized', |
|
25 | - 'http_402' => 'Payment Required', |
|
26 | - 'http_403' => 'Forbidden', |
|
27 | - 'http_404' => 'Not Found', |
|
28 | - 'http_405' => 'Method Not Allowed', |
|
29 | - 'http_406' => 'Not Acceptable', |
|
30 | - 'http_407' => 'Proxy Authentication Required', |
|
31 | - 'http_408' => 'Request Timeout', |
|
32 | - 'http_409' => 'Conflict', |
|
33 | - 'http_410' => 'Gone', |
|
34 | - 'http_411' => 'Length Required', |
|
35 | - 'http_412' => 'Precondition Failed', |
|
36 | - 'http_413' => 'Payload Too Large', |
|
37 | - 'http_414' => 'URI Too Long', |
|
38 | - 'http_415' => 'Unsupported Media Type', |
|
39 | - 'http_416' => 'Range Not Satisfiable', |
|
40 | - 'http_417' => 'Expectation Failed', |
|
41 | - 'http_421' => 'Misdirected Request', |
|
42 | - 'http_422' => 'Unprocessable Entity', |
|
43 | - 'http_423' => 'Locked', |
|
44 | - 'http_424' => 'Failed Dependency', |
|
45 | - 'http_425' => 'Too Early', |
|
46 | - 'http_426' => 'Upgrade Required', |
|
47 | - 'http_428' => 'Precondition Required', |
|
48 | - 'http_429' => 'Too Many Requests', |
|
49 | - 'http_431' => 'Request Header Fields Too Large', |
|
50 | - 'http_451' => 'Unavailable For Legal Reasons', |
|
20 | + // HttpException handler (added in 6.4.0) |
|
21 | + // Error messages for HttpException caught w/o custom messages |
|
22 | + // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
23 | + 'http_400' => 'Bad Request', |
|
24 | + 'http_401' => 'Unauthorized', |
|
25 | + 'http_402' => 'Payment Required', |
|
26 | + 'http_403' => 'Forbidden', |
|
27 | + 'http_404' => 'Not Found', |
|
28 | + 'http_405' => 'Method Not Allowed', |
|
29 | + 'http_406' => 'Not Acceptable', |
|
30 | + 'http_407' => 'Proxy Authentication Required', |
|
31 | + 'http_408' => 'Request Timeout', |
|
32 | + 'http_409' => 'Conflict', |
|
33 | + 'http_410' => 'Gone', |
|
34 | + 'http_411' => 'Length Required', |
|
35 | + 'http_412' => 'Precondition Failed', |
|
36 | + 'http_413' => 'Payload Too Large', |
|
37 | + 'http_414' => 'URI Too Long', |
|
38 | + 'http_415' => 'Unsupported Media Type', |
|
39 | + 'http_416' => 'Range Not Satisfiable', |
|
40 | + 'http_417' => 'Expectation Failed', |
|
41 | + 'http_421' => 'Misdirected Request', |
|
42 | + 'http_422' => 'Unprocessable Entity', |
|
43 | + 'http_423' => 'Locked', |
|
44 | + 'http_424' => 'Failed Dependency', |
|
45 | + 'http_425' => 'Too Early', |
|
46 | + 'http_426' => 'Upgrade Required', |
|
47 | + 'http_428' => 'Precondition Required', |
|
48 | + 'http_429' => 'Too Many Requests', |
|
49 | + 'http_431' => 'Request Header Fields Too Large', |
|
50 | + 'http_451' => 'Unavailable For Legal Reasons', |
|
51 | 51 | |
52 | - 'http_500' => 'Internal Server Error', |
|
53 | - 'http_501' => 'Not Implemented', |
|
54 | - 'http_502' => 'Bad Gateway', |
|
55 | - 'http_503' => 'Service Unavailable', |
|
56 | - 'http_504' => 'Gateway Timeout', |
|
57 | - 'http_505' => 'HTTP Version Not Supported', |
|
58 | - 'http_506' => 'Variant Also Negotiates', |
|
59 | - 'http_507' => 'Insufficient Storage', |
|
60 | - 'http_508' => 'Loop Detected', |
|
61 | - 'http_509' => 'Unassigned', |
|
62 | - 'http_510' => 'Not Extended', |
|
63 | - 'http_511' => 'Network Authentication Required', |
|
52 | + 'http_500' => 'Internal Server Error', |
|
53 | + 'http_501' => 'Not Implemented', |
|
54 | + 'http_502' => 'Bad Gateway', |
|
55 | + 'http_503' => 'Service Unavailable', |
|
56 | + 'http_504' => 'Gateway Timeout', |
|
57 | + 'http_505' => 'HTTP Version Not Supported', |
|
58 | + 'http_506' => 'Variant Also Negotiates', |
|
59 | + 'http_507' => 'Insufficient Storage', |
|
60 | + 'http_508' => 'Loop Detected', |
|
61 | + 'http_509' => 'Unassigned', |
|
62 | + 'http_510' => 'Not Extended', |
|
63 | + 'http_511' => 'Network Authentication Required', |
|
64 | 64 | ]; |
@@ -22,175 +22,175 @@ |
||
22 | 22 | */ |
23 | 23 | class Converter |
24 | 24 | { |
25 | - /** |
|
26 | - * @var array |
|
27 | - */ |
|
28 | - protected $classes = []; |
|
29 | - |
|
30 | - /** |
|
31 | - * Converter constructor. |
|
32 | - * |
|
33 | - * @throws \RuntimeException |
|
34 | - */ |
|
35 | - public function __construct() |
|
36 | - { |
|
37 | - $this->classes = static::getClassesMapping() ?? []; |
|
38 | - } |
|
39 | - |
|
40 | - /** |
|
41 | - * Returns local copy of configuration mapping for the classes. |
|
42 | - * |
|
43 | - * @return array |
|
44 | - */ |
|
45 | - public function getClasses(): array |
|
46 | - { |
|
47 | - return $this->classes; |
|
48 | - } |
|
49 | - |
|
50 | - /** |
|
51 | - * Checks if we have "classes" mapping configured for $data object class. |
|
52 | - * Returns @true if there's valid config for this class. |
|
53 | - * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured. |
|
54 | - * Throws \InvalidArgumentException if No data conversion mapping configured for given class. |
|
55 | - * |
|
56 | - * @param object $data Object to check mapping for. |
|
57 | - * |
|
58 | - * @return array |
|
59 | - * |
|
60 | - * @throws \InvalidArgumentException |
|
61 | - */ |
|
62 | - protected function getClassMappingConfigOrThrow(object $data): array |
|
63 | - { |
|
64 | - $result = null; |
|
65 | - |
|
66 | - // check for exact class name match... |
|
67 | - $cls = \get_class($data); |
|
68 | - if (\is_string($cls)) { |
|
69 | - if (\array_key_exists($cls, $this->classes)) { |
|
70 | - $result = $this->classes[ $cls ]; |
|
71 | - } else { |
|
72 | - // no exact match, then lets try with `instanceof` |
|
73 | - foreach (\array_keys($this->getClasses()) as $class_name) { |
|
74 | - if ($data instanceof $class_name) { |
|
75 | - $result = $this->classes[ $class_name ]; |
|
76 | - break; |
|
77 | - } |
|
78 | - } |
|
79 | - } |
|
80 | - } |
|
81 | - |
|
82 | - if ($result === null) { |
|
83 | - throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls)); |
|
84 | - } |
|
85 | - |
|
86 | - return $result; |
|
87 | - } |
|
88 | - |
|
89 | - /** |
|
90 | - * We need to prepare source data |
|
91 | - * |
|
92 | - * @param object|array|null $data |
|
93 | - * |
|
94 | - * @return array|null |
|
95 | - * |
|
96 | - * @throws \InvalidArgumentException |
|
97 | - */ |
|
98 | - public function convert($data = null): ?array |
|
99 | - { |
|
100 | - if ($data === null) { |
|
101 | - return null; |
|
102 | - } |
|
103 | - |
|
104 | - Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY, |
|
105 | - Validator::TYPE_OBJECT]); |
|
106 | - |
|
107 | - if (\is_object($data)) { |
|
108 | - $cfg = $this->getClassMappingConfigOrThrow($data); |
|
109 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
110 | - $data = $worker->convert($data, $cfg); |
|
111 | - } else { |
|
112 | - $data = $this->convertArray($data); |
|
113 | - } |
|
114 | - |
|
115 | - return $data; |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * Recursively walks $data array and converts all known objects if found. Note |
|
120 | - * $data array is passed by reference so source $data array may be modified. |
|
121 | - * |
|
122 | - * @param array $data array to recursively convert known elements of |
|
123 | - * |
|
124 | - * @return array |
|
125 | - * |
|
126 | - * @throws \RuntimeException |
|
127 | - */ |
|
128 | - protected function convertArray(array $data): array |
|
129 | - { |
|
130 | - // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then |
|
131 | - // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON |
|
132 | - // array. But you can't mix these two as the final JSON would not produce predictable results. |
|
133 | - $string_keys_cnt = 0; |
|
134 | - $int_keys_cnt = 0; |
|
135 | - foreach ($data as $key => $val) { |
|
136 | - if (\is_int($key)) { |
|
137 | - $int_keys_cnt++; |
|
138 | - } else { |
|
139 | - $string_keys_cnt++; |
|
140 | - } |
|
141 | - |
|
142 | - if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) { |
|
143 | - throw new \RuntimeException( |
|
144 | - 'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' . |
|
145 | - 'Arrays with mixed keys are not supported by design.'); |
|
146 | - } |
|
147 | - } |
|
148 | - |
|
149 | - foreach ($data as $key => $val) { |
|
150 | - if (\is_array($val)) { |
|
151 | - $data[ $key ] = $this->convertArray($val); |
|
152 | - } elseif (\is_object($val)) { |
|
153 | - $cfg = $this->getClassMappingConfigOrThrow($val); |
|
154 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
155 | - $converted_data = $worker->convert($val, $cfg); |
|
156 | - $data[ $key ] = $converted_data; |
|
157 | - } |
|
158 | - } |
|
159 | - |
|
160 | - return $data; |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Reads and validates "classes" config mapping |
|
165 | - * |
|
166 | - * @return array Classes mapping as specified in configuration or empty array if configuration found |
|
167 | - * |
|
168 | - * @throws \RuntimeException if "classes" mapping is technically invalid (i.e. not array etc). |
|
169 | - */ |
|
170 | - protected static function getClassesMapping(): array |
|
171 | - { |
|
172 | - $classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER); |
|
173 | - |
|
174 | - if ($classes !== null) { |
|
175 | - if (!\is_array($classes)) { |
|
176 | - throw new \RuntimeException( |
|
177 | - \sprintf('CONFIG: "classes" mapping must be an array (%s given)', \gettype($classes))); |
|
178 | - } |
|
179 | - |
|
180 | - $mandatory_keys = [ |
|
181 | - ResponseBuilder::KEY_HANDLER, |
|
182 | - ]; |
|
183 | - foreach ($classes as $class_name => $class_config) { |
|
184 | - foreach ($mandatory_keys as $key_name) { |
|
185 | - if (!\array_key_exists($key_name, $class_config)) { |
|
186 | - throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping"); |
|
187 | - } |
|
188 | - } |
|
189 | - } |
|
190 | - } else { |
|
191 | - $classes = []; |
|
192 | - } |
|
193 | - |
|
194 | - return $classes; |
|
195 | - } |
|
25 | + /** |
|
26 | + * @var array |
|
27 | + */ |
|
28 | + protected $classes = []; |
|
29 | + |
|
30 | + /** |
|
31 | + * Converter constructor. |
|
32 | + * |
|
33 | + * @throws \RuntimeException |
|
34 | + */ |
|
35 | + public function __construct() |
|
36 | + { |
|
37 | + $this->classes = static::getClassesMapping() ?? []; |
|
38 | + } |
|
39 | + |
|
40 | + /** |
|
41 | + * Returns local copy of configuration mapping for the classes. |
|
42 | + * |
|
43 | + * @return array |
|
44 | + */ |
|
45 | + public function getClasses(): array |
|
46 | + { |
|
47 | + return $this->classes; |
|
48 | + } |
|
49 | + |
|
50 | + /** |
|
51 | + * Checks if we have "classes" mapping configured for $data object class. |
|
52 | + * Returns @true if there's valid config for this class. |
|
53 | + * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured. |
|
54 | + * Throws \InvalidArgumentException if No data conversion mapping configured for given class. |
|
55 | + * |
|
56 | + * @param object $data Object to check mapping for. |
|
57 | + * |
|
58 | + * @return array |
|
59 | + * |
|
60 | + * @throws \InvalidArgumentException |
|
61 | + */ |
|
62 | + protected function getClassMappingConfigOrThrow(object $data): array |
|
63 | + { |
|
64 | + $result = null; |
|
65 | + |
|
66 | + // check for exact class name match... |
|
67 | + $cls = \get_class($data); |
|
68 | + if (\is_string($cls)) { |
|
69 | + if (\array_key_exists($cls, $this->classes)) { |
|
70 | + $result = $this->classes[ $cls ]; |
|
71 | + } else { |
|
72 | + // no exact match, then lets try with `instanceof` |
|
73 | + foreach (\array_keys($this->getClasses()) as $class_name) { |
|
74 | + if ($data instanceof $class_name) { |
|
75 | + $result = $this->classes[ $class_name ]; |
|
76 | + break; |
|
77 | + } |
|
78 | + } |
|
79 | + } |
|
80 | + } |
|
81 | + |
|
82 | + if ($result === null) { |
|
83 | + throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls)); |
|
84 | + } |
|
85 | + |
|
86 | + return $result; |
|
87 | + } |
|
88 | + |
|
89 | + /** |
|
90 | + * We need to prepare source data |
|
91 | + * |
|
92 | + * @param object|array|null $data |
|
93 | + * |
|
94 | + * @return array|null |
|
95 | + * |
|
96 | + * @throws \InvalidArgumentException |
|
97 | + */ |
|
98 | + public function convert($data = null): ?array |
|
99 | + { |
|
100 | + if ($data === null) { |
|
101 | + return null; |
|
102 | + } |
|
103 | + |
|
104 | + Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY, |
|
105 | + Validator::TYPE_OBJECT]); |
|
106 | + |
|
107 | + if (\is_object($data)) { |
|
108 | + $cfg = $this->getClassMappingConfigOrThrow($data); |
|
109 | + $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
110 | + $data = $worker->convert($data, $cfg); |
|
111 | + } else { |
|
112 | + $data = $this->convertArray($data); |
|
113 | + } |
|
114 | + |
|
115 | + return $data; |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * Recursively walks $data array and converts all known objects if found. Note |
|
120 | + * $data array is passed by reference so source $data array may be modified. |
|
121 | + * |
|
122 | + * @param array $data array to recursively convert known elements of |
|
123 | + * |
|
124 | + * @return array |
|
125 | + * |
|
126 | + * @throws \RuntimeException |
|
127 | + */ |
|
128 | + protected function convertArray(array $data): array |
|
129 | + { |
|
130 | + // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then |
|
131 | + // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON |
|
132 | + // array. But you can't mix these two as the final JSON would not produce predictable results. |
|
133 | + $string_keys_cnt = 0; |
|
134 | + $int_keys_cnt = 0; |
|
135 | + foreach ($data as $key => $val) { |
|
136 | + if (\is_int($key)) { |
|
137 | + $int_keys_cnt++; |
|
138 | + } else { |
|
139 | + $string_keys_cnt++; |
|
140 | + } |
|
141 | + |
|
142 | + if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) { |
|
143 | + throw new \RuntimeException( |
|
144 | + 'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' . |
|
145 | + 'Arrays with mixed keys are not supported by design.'); |
|
146 | + } |
|
147 | + } |
|
148 | + |
|
149 | + foreach ($data as $key => $val) { |
|
150 | + if (\is_array($val)) { |
|
151 | + $data[ $key ] = $this->convertArray($val); |
|
152 | + } elseif (\is_object($val)) { |
|
153 | + $cfg = $this->getClassMappingConfigOrThrow($val); |
|
154 | + $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
155 | + $converted_data = $worker->convert($val, $cfg); |
|
156 | + $data[ $key ] = $converted_data; |
|
157 | + } |
|
158 | + } |
|
159 | + |
|
160 | + return $data; |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Reads and validates "classes" config mapping |
|
165 | + * |
|
166 | + * @return array Classes mapping as specified in configuration or empty array if configuration found |
|
167 | + * |
|
168 | + * @throws \RuntimeException if "classes" mapping is technically invalid (i.e. not array etc). |
|
169 | + */ |
|
170 | + protected static function getClassesMapping(): array |
|
171 | + { |
|
172 | + $classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER); |
|
173 | + |
|
174 | + if ($classes !== null) { |
|
175 | + if (!\is_array($classes)) { |
|
176 | + throw new \RuntimeException( |
|
177 | + \sprintf('CONFIG: "classes" mapping must be an array (%s given)', \gettype($classes))); |
|
178 | + } |
|
179 | + |
|
180 | + $mandatory_keys = [ |
|
181 | + ResponseBuilder::KEY_HANDLER, |
|
182 | + ]; |
|
183 | + foreach ($classes as $class_name => $class_config) { |
|
184 | + foreach ($mandatory_keys as $key_name) { |
|
185 | + if (!\array_key_exists($key_name, $class_config)) { |
|
186 | + throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping"); |
|
187 | + } |
|
188 | + } |
|
189 | + } |
|
190 | + } else { |
|
191 | + $classes = []; |
|
192 | + } |
|
193 | + |
|
194 | + return $classes; |
|
195 | + } |
|
196 | 196 | } |
@@ -67,12 +67,12 @@ discard block |
||
67 | 67 | $cls = \get_class($data); |
68 | 68 | if (\is_string($cls)) { |
69 | 69 | if (\array_key_exists($cls, $this->classes)) { |
70 | - $result = $this->classes[ $cls ]; |
|
70 | + $result = $this->classes[$cls]; |
|
71 | 71 | } else { |
72 | 72 | // no exact match, then lets try with `instanceof` |
73 | 73 | foreach (\array_keys($this->getClasses()) as $class_name) { |
74 | 74 | if ($data instanceof $class_name) { |
75 | - $result = $this->classes[ $class_name ]; |
|
75 | + $result = $this->classes[$class_name]; |
|
76 | 76 | break; |
77 | 77 | } |
78 | 78 | } |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | |
107 | 107 | if (\is_object($data)) { |
108 | 108 | $cfg = $this->getClassMappingConfigOrThrow($data); |
109 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
109 | + $worker = new $cfg[ResponseBuilder::KEY_HANDLER](); |
|
110 | 110 | $data = $worker->convert($data, $cfg); |
111 | 111 | } else { |
112 | 112 | $data = $this->convertArray($data); |
@@ -148,12 +148,12 @@ discard block |
||
148 | 148 | |
149 | 149 | foreach ($data as $key => $val) { |
150 | 150 | if (\is_array($val)) { |
151 | - $data[ $key ] = $this->convertArray($val); |
|
151 | + $data[$key] = $this->convertArray($val); |
|
152 | 152 | } elseif (\is_object($val)) { |
153 | 153 | $cfg = $this->getClassMappingConfigOrThrow($val); |
154 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
154 | + $worker = new $cfg[ResponseBuilder::KEY_HANDLER](); |
|
155 | 155 | $converted_data = $worker->convert($val, $cfg); |
156 | - $data[ $key ] = $converted_data; |
|
156 | + $data[$key] = $converted_data; |
|
157 | 157 | } |
158 | 158 | } |
159 | 159 |
@@ -42,12 +42,12 @@ |
||
42 | 42 | $config = \array_replace($default_config, $user_config); |
43 | 43 | |
44 | 44 | $http_code = $ex->getStatusCode(); |
45 | - $result = $config[ $http_code ] ?? null; |
|
45 | + $result = $config[$http_code] ?? null; |
|
46 | 46 | |
47 | 47 | // If we do not have dedicated entry fort this particular http_code, |
48 | 48 | // fall back to default value. |
49 | 49 | if ($result === null) { |
50 | - $result = $config[ ResponseBuilder::KEY_DEFAULT ]; |
|
50 | + $result = $config[ResponseBuilder::KEY_DEFAULT]; |
|
51 | 51 | } |
52 | 52 | |
53 | 53 | // Some defaults to fall back to if not set in user config. |