@@ -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 | } |
@@ -15,14 +15,14 @@ |
||
15 | 15 | */ |
16 | 16 | interface ConverterContract |
17 | 17 | { |
18 | - /** |
|
19 | - * Returns array representation of the object. |
|
20 | - * |
|
21 | - * @param object $obj Object to be converted |
|
22 | - * @param array $config Converter config array to be used for this object (based on exact class |
|
23 | - * name match or inheritance). |
|
24 | - * |
|
25 | - * @return array |
|
26 | - */ |
|
27 | - public function convert($obj, array $config): array; |
|
18 | + /** |
|
19 | + * Returns array representation of the object. |
|
20 | + * |
|
21 | + * @param object $obj Object to be converted |
|
22 | + * @param array $config Converter config array to be used for this object (based on exact class |
|
23 | + * name match or inheritance). |
|
24 | + * |
|
25 | + * @return array |
|
26 | + */ |
|
27 | + public function convert($obj, array $config): array; |
|
28 | 28 | } |
@@ -19,19 +19,19 @@ |
||
19 | 19 | |
20 | 20 | class ToArrayConverter implements ConverterContract |
21 | 21 | { |
22 | - /** |
|
23 | - * Returns array representation of the object. |
|
24 | - * |
|
25 | - * @param object $obj Object to be converted |
|
26 | - * @param array $config Converter config array to be used for this object (based on exact class |
|
27 | - * name match or inheritance). |
|
28 | - * |
|
29 | - * @return array |
|
30 | - */ |
|
31 | - public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array |
|
32 | - { |
|
33 | - Validator::assertIsObject('obj', $obj); |
|
22 | + /** |
|
23 | + * Returns array representation of the object. |
|
24 | + * |
|
25 | + * @param object $obj Object to be converted |
|
26 | + * @param array $config Converter config array to be used for this object (based on exact class |
|
27 | + * name match or inheritance). |
|
28 | + * |
|
29 | + * @return array |
|
30 | + */ |
|
31 | + public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array |
|
32 | + { |
|
33 | + Validator::assertIsObject('obj', $obj); |
|
34 | 34 | |
35 | - return $obj->toArray(); |
|
36 | - } |
|
35 | + return $obj->toArray(); |
|
36 | + } |
|
37 | 37 | } |
@@ -19,19 +19,19 @@ |
||
19 | 19 | |
20 | 20 | class ArrayableConverter implements ConverterContract |
21 | 21 | { |
22 | - /** |
|
23 | - * Returns array representation of the object implementing Arrayable interface |
|
24 | - * |
|
25 | - * @param Arrayable $obj Object to be converted |
|
26 | - * @param array $config Converter config array to be used for this object (based on exact class |
|
27 | - * name match or inheritance). |
|
28 | - * |
|
29 | - * @return array |
|
30 | - */ |
|
31 | - public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array |
|
32 | - { |
|
33 | - Validator::assertInstanceOf('obj', $obj, Arrayable::class); |
|
22 | + /** |
|
23 | + * Returns array representation of the object implementing Arrayable interface |
|
24 | + * |
|
25 | + * @param Arrayable $obj Object to be converted |
|
26 | + * @param array $config Converter config array to be used for this object (based on exact class |
|
27 | + * name match or inheritance). |
|
28 | + * |
|
29 | + * @return array |
|
30 | + */ |
|
31 | + public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array |
|
32 | + { |
|
33 | + Validator::assertInstanceOf('obj', $obj, Arrayable::class); |
|
34 | 34 | |
35 | - return $obj->toArray(); |
|
36 | - } |
|
35 | + return $obj->toArray(); |
|
36 | + } |
|
37 | 37 | } |
@@ -19,19 +19,19 @@ |
||
19 | 19 | |
20 | 20 | class JsonSerializableConverter implements ConverterContract |
21 | 21 | { |
22 | - /** |
|
23 | - * Returns array representation of the object implementing \JsonSerializable interface. |
|
24 | - * |
|
25 | - * @param \JsonSerializable $obj Object to be converted |
|
26 | - * @param array $config Converter config array to be used for this object (based on exact class |
|
27 | - * name match or inheritance). |
|
28 | - * |
|
29 | - * @return array |
|
30 | - */ |
|
31 | - public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array |
|
32 | - { |
|
33 | - Validator::assertInstanceOf('obj', $obj, \JsonSerializable::class); |
|
22 | + /** |
|
23 | + * Returns array representation of the object implementing \JsonSerializable interface. |
|
24 | + * |
|
25 | + * @param \JsonSerializable $obj Object to be converted |
|
26 | + * @param array $config Converter config array to be used for this object (based on exact class |
|
27 | + * name match or inheritance). |
|
28 | + * |
|
29 | + * @return array |
|
30 | + */ |
|
31 | + public function convert($obj, array /** @scrutinizer ignore-unused */ $config): array |
|
32 | + { |
|
33 | + Validator::assertInstanceOf('obj', $obj, \JsonSerializable::class); |
|
34 | 34 | |
35 | - return ['val' => json_decode($obj->jsonSerialize(), true)]; |
|
36 | - } |
|
35 | + return ['val' => json_decode($obj->jsonSerialize(), true)]; |
|
36 | + } |
|
37 | 37 | } |
@@ -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 | | Converters for generic classes should use lower priority to allow dedicated converters to be used. |
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 options can be used for each entry specified: |
88 | 88 | * `api_code` : (int) mandatory api_code to be used for given exception |
89 | 89 | * `http_code` : (int) optional HTTP code. If not specified, exception's HTTP status code will be used. |
@@ -96,8 +96,8 @@ discard block |
||
96 | 96 | * `msg_key` is set, or message referenced by `msg_key` completely ignoring exception |
97 | 97 | * message ($ex->getMessage()). |
98 | 98 | */ |
99 | - 'map' => [ |
|
100 | - /* |
|
99 | + 'map' => [ |
|
100 | + /* |
|
101 | 101 | * HTTP Exceptions |
102 | 102 | * --------------- |
103 | 103 | * Configure how you want Http Exception to be handled based on its Http status code. |
@@ -105,51 +105,51 @@ discard block |
||
105 | 105 | * Additionally, you can specify `http_code` to be any valid 400-599 HTTP status code, otherwise |
106 | 106 | * code set in the exception will be used. |
107 | 107 | */ |
108 | - // HttpException::class => [ |
|
109 | - // // used by unauthenticated() to obtain api and http code for the exception |
|
110 | - // HttpResponse::HTTP_UNAUTHORIZED => [ |
|
111 | - // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_UNATHORIZED_EXCEPTION, |
|
112 | - // ], |
|
113 | - // // Required by ValidationException handler |
|
114 | - // HttpResponse::HTTP_UNPROCESSABLE_ENTITY => [ |
|
115 | - // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION, |
|
116 | - // ], |
|
117 | - // // default handler is mandatory and MUST have both `api_code` and `http_code` set. |
|
118 | - // 'default' => [ |
|
119 | - // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_GENERIC_HTTP_EXCEPTION, |
|
120 | - // 'http_code' => HttpResponse::HTTP_BAD_REQUEST, |
|
121 | - // ], |
|
122 | - // ], |
|
123 | - // // This is final exception handler. If ex is not dealt with yet this is its last stop. |
|
124 | - // // default handler is mandatory and MUST have both `api_code` and `http_code` set. |
|
125 | - // 'default' => [ |
|
126 | - // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION, |
|
127 | - // 'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR, |
|
128 | - // ], |
|
129 | - // ], |
|
130 | - ], |
|
131 | - ], |
|
108 | + // HttpException::class => [ |
|
109 | + // // used by unauthenticated() to obtain api and http code for the exception |
|
110 | + // HttpResponse::HTTP_UNAUTHORIZED => [ |
|
111 | + // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_UNATHORIZED_EXCEPTION, |
|
112 | + // ], |
|
113 | + // // Required by ValidationException handler |
|
114 | + // HttpResponse::HTTP_UNPROCESSABLE_ENTITY => [ |
|
115 | + // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION, |
|
116 | + // ], |
|
117 | + // // default handler is mandatory and MUST have both `api_code` and `http_code` set. |
|
118 | + // 'default' => [ |
|
119 | + // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_GENERIC_HTTP_EXCEPTION, |
|
120 | + // 'http_code' => HttpResponse::HTTP_BAD_REQUEST, |
|
121 | + // ], |
|
122 | + // ], |
|
123 | + // // This is final exception handler. If ex is not dealt with yet this is its last stop. |
|
124 | + // // default handler is mandatory and MUST have both `api_code` and `http_code` set. |
|
125 | + // 'default' => [ |
|
126 | + // 'api_code' => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION, |
|
127 | + // 'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR, |
|
128 | + // ], |
|
129 | + // ], |
|
130 | + ], |
|
131 | + ], |
|
132 | 132 | |
133 | - /* |
|
133 | + /* |
|
134 | 134 | |----------------------------------------------------------------------------------------------------------- |
135 | 135 | | data-to-json encoding options |
136 | 136 | |----------------------------------------------------------------------------------------------------------- |
137 | 137 | | |
138 | 138 | */ |
139 | - 'encoding_options' => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE, |
|
139 | + 'encoding_options' => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE, |
|
140 | 140 | |
141 | - /* |
|
141 | + /* |
|
142 | 142 | |----------------------------------------------------------------------------------------------------------- |
143 | 143 | | Debug config |
144 | 144 | |----------------------------------------------------------------------------------------------------------- |
145 | 145 | | |
146 | 146 | */ |
147 | - 'debug' => [ |
|
148 | - 'debug_key' => 'debug', |
|
149 | - 'exception_handler' => [ |
|
150 | - 'trace_key' => 'trace', |
|
151 | - 'trace_enabled' => env('APP_DEBUG', false), |
|
152 | - ], |
|
153 | - ], |
|
147 | + 'debug' => [ |
|
148 | + 'debug_key' => 'debug', |
|
149 | + 'exception_handler' => [ |
|
150 | + 'trace_key' => 'trace', |
|
151 | + 'trace_enabled' => env('APP_DEBUG', false), |
|
152 | + ], |
|
153 | + ], |
|
154 | 154 | |
155 | 155 | ]; |
@@ -22,173 +22,173 @@ |
||
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 (array_key_exists($cls, $this->classes)) { |
|
69 | - $result = $this->classes[ $cls ]; |
|
70 | - } else { |
|
71 | - // no exact match, then lets try with `instanceof` |
|
72 | - foreach (array_keys($this->getClasses()) as $class_name) { |
|
73 | - if ($data instanceof $class_name) { |
|
74 | - $result = $this->classes[ $class_name ]; |
|
75 | - break; |
|
76 | - } |
|
77 | - } |
|
78 | - } |
|
79 | - |
|
80 | - if ($result === null) { |
|
81 | - throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls)); |
|
82 | - } |
|
83 | - |
|
84 | - return $result; |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * We need to prepare source data |
|
89 | - * |
|
90 | - * @param object|array|null $data |
|
91 | - * |
|
92 | - * @return array|null |
|
93 | - * |
|
94 | - * @throws \InvalidArgumentException |
|
95 | - */ |
|
96 | - public function convert($data = null): ?array |
|
97 | - { |
|
98 | - if ($data === null) { |
|
99 | - return null; |
|
100 | - } |
|
101 | - |
|
102 | - Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY, |
|
103 | - Validator::TYPE_OBJECT]); |
|
104 | - |
|
105 | - if (is_object($data)) { |
|
106 | - $cfg = $this->getClassMappingConfigOrThrow($data); |
|
107 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
108 | - $data = $worker->convert($data, $cfg); |
|
109 | - } else { |
|
110 | - $data = $this->convertArray($data); |
|
111 | - } |
|
112 | - |
|
113 | - return $data; |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Recursively walks $data array and converts all known objects if found. Note |
|
118 | - * $data array is passed by reference so source $data array may be modified. |
|
119 | - * |
|
120 | - * @param array $data array to recursively convert known elements of |
|
121 | - * |
|
122 | - * @return array |
|
123 | - * |
|
124 | - * @throws \RuntimeException |
|
125 | - */ |
|
126 | - protected function convertArray(array $data): array |
|
127 | - { |
|
128 | - // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then |
|
129 | - // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON |
|
130 | - // array. But you can't mix these two as the final JSON would not produce predictable results. |
|
131 | - $string_keys_cnt = 0; |
|
132 | - $int_keys_cnt = 0; |
|
133 | - foreach ($data as $key => $val) { |
|
134 | - if (is_int($key)) { |
|
135 | - $int_keys_cnt++; |
|
136 | - } else { |
|
137 | - $string_keys_cnt++; |
|
138 | - } |
|
139 | - |
|
140 | - if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) { |
|
141 | - throw new \RuntimeException( |
|
142 | - 'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' . |
|
143 | - 'Arrays with mixed keys are not supported by design.'); |
|
144 | - } |
|
145 | - } |
|
146 | - |
|
147 | - foreach ($data as $key => $val) { |
|
148 | - if (is_array($val)) { |
|
149 | - $data[ $key ] = $this->convertArray($val); |
|
150 | - } elseif (is_object($val)) { |
|
151 | - $cfg = $this->getClassMappingConfigOrThrow($val); |
|
152 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
153 | - $converted_data = $worker->convert($val, $cfg); |
|
154 | - $data[ $key ] = $converted_data; |
|
155 | - } |
|
156 | - } |
|
157 | - |
|
158 | - return $data; |
|
159 | - } |
|
160 | - |
|
161 | - /** |
|
162 | - * Reads and validates "classes" config mapping |
|
163 | - * |
|
164 | - * @return array Classes mapping as specified in configuration or empty array if configuration found |
|
165 | - * |
|
166 | - * @throws \RuntimeException if "classes" mapping is technically invalid (i.e. not array etc). |
|
167 | - */ |
|
168 | - protected static function getClassesMapping(): array |
|
169 | - { |
|
170 | - $classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER); |
|
171 | - |
|
172 | - if ($classes !== null) { |
|
173 | - if (!is_array($classes)) { |
|
174 | - throw new \RuntimeException( |
|
175 | - sprintf('CONFIG: "classes" mapping must be an array (%s given)', gettype($classes))); |
|
176 | - } |
|
177 | - |
|
178 | - $mandatory_keys = [ |
|
179 | - ResponseBuilder::KEY_HANDLER, |
|
180 | - ]; |
|
181 | - foreach ($classes as $class_name => $class_config) { |
|
182 | - foreach ($mandatory_keys as $key_name) { |
|
183 | - if (!array_key_exists($key_name, $class_config)) { |
|
184 | - throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping"); |
|
185 | - } |
|
186 | - } |
|
187 | - } |
|
188 | - } else { |
|
189 | - $classes = []; |
|
190 | - } |
|
191 | - |
|
192 | - return $classes; |
|
193 | - } |
|
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 (array_key_exists($cls, $this->classes)) { |
|
69 | + $result = $this->classes[ $cls ]; |
|
70 | + } else { |
|
71 | + // no exact match, then lets try with `instanceof` |
|
72 | + foreach (array_keys($this->getClasses()) as $class_name) { |
|
73 | + if ($data instanceof $class_name) { |
|
74 | + $result = $this->classes[ $class_name ]; |
|
75 | + break; |
|
76 | + } |
|
77 | + } |
|
78 | + } |
|
79 | + |
|
80 | + if ($result === null) { |
|
81 | + throw new \InvalidArgumentException(sprintf('No data conversion mapping configured for "%s" class.', $cls)); |
|
82 | + } |
|
83 | + |
|
84 | + return $result; |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * We need to prepare source data |
|
89 | + * |
|
90 | + * @param object|array|null $data |
|
91 | + * |
|
92 | + * @return array|null |
|
93 | + * |
|
94 | + * @throws \InvalidArgumentException |
|
95 | + */ |
|
96 | + public function convert($data = null): ?array |
|
97 | + { |
|
98 | + if ($data === null) { |
|
99 | + return null; |
|
100 | + } |
|
101 | + |
|
102 | + Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY, |
|
103 | + Validator::TYPE_OBJECT]); |
|
104 | + |
|
105 | + if (is_object($data)) { |
|
106 | + $cfg = $this->getClassMappingConfigOrThrow($data); |
|
107 | + $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
108 | + $data = $worker->convert($data, $cfg); |
|
109 | + } else { |
|
110 | + $data = $this->convertArray($data); |
|
111 | + } |
|
112 | + |
|
113 | + return $data; |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Recursively walks $data array and converts all known objects if found. Note |
|
118 | + * $data array is passed by reference so source $data array may be modified. |
|
119 | + * |
|
120 | + * @param array $data array to recursively convert known elements of |
|
121 | + * |
|
122 | + * @return array |
|
123 | + * |
|
124 | + * @throws \RuntimeException |
|
125 | + */ |
|
126 | + protected function convertArray(array $data): array |
|
127 | + { |
|
128 | + // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then |
|
129 | + // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON |
|
130 | + // array. But you can't mix these two as the final JSON would not produce predictable results. |
|
131 | + $string_keys_cnt = 0; |
|
132 | + $int_keys_cnt = 0; |
|
133 | + foreach ($data as $key => $val) { |
|
134 | + if (is_int($key)) { |
|
135 | + $int_keys_cnt++; |
|
136 | + } else { |
|
137 | + $string_keys_cnt++; |
|
138 | + } |
|
139 | + |
|
140 | + if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) { |
|
141 | + throw new \RuntimeException( |
|
142 | + 'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' . |
|
143 | + 'Arrays with mixed keys are not supported by design.'); |
|
144 | + } |
|
145 | + } |
|
146 | + |
|
147 | + foreach ($data as $key => $val) { |
|
148 | + if (is_array($val)) { |
|
149 | + $data[ $key ] = $this->convertArray($val); |
|
150 | + } elseif (is_object($val)) { |
|
151 | + $cfg = $this->getClassMappingConfigOrThrow($val); |
|
152 | + $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
153 | + $converted_data = $worker->convert($val, $cfg); |
|
154 | + $data[ $key ] = $converted_data; |
|
155 | + } |
|
156 | + } |
|
157 | + |
|
158 | + return $data; |
|
159 | + } |
|
160 | + |
|
161 | + /** |
|
162 | + * Reads and validates "classes" config mapping |
|
163 | + * |
|
164 | + * @return array Classes mapping as specified in configuration or empty array if configuration found |
|
165 | + * |
|
166 | + * @throws \RuntimeException if "classes" mapping is technically invalid (i.e. not array etc). |
|
167 | + */ |
|
168 | + protected static function getClassesMapping(): array |
|
169 | + { |
|
170 | + $classes = Config::get(ResponseBuilder::CONF_KEY_CONVERTER); |
|
171 | + |
|
172 | + if ($classes !== null) { |
|
173 | + if (!is_array($classes)) { |
|
174 | + throw new \RuntimeException( |
|
175 | + sprintf('CONFIG: "classes" mapping must be an array (%s given)', gettype($classes))); |
|
176 | + } |
|
177 | + |
|
178 | + $mandatory_keys = [ |
|
179 | + ResponseBuilder::KEY_HANDLER, |
|
180 | + ]; |
|
181 | + foreach ($classes as $class_name => $class_config) { |
|
182 | + foreach ($mandatory_keys as $key_name) { |
|
183 | + if (!array_key_exists($key_name, $class_config)) { |
|
184 | + throw new \RuntimeException("CONFIG: Missing '{$key_name}' for '{$class_name}' class mapping"); |
|
185 | + } |
|
186 | + } |
|
187 | + } |
|
188 | + } else { |
|
189 | + $classes = []; |
|
190 | + } |
|
191 | + |
|
192 | + return $classes; |
|
193 | + } |
|
194 | 194 | } |
@@ -66,12 +66,12 @@ discard block |
||
66 | 66 | // check for exact class name match... |
67 | 67 | $cls = get_class($data); |
68 | 68 | if (array_key_exists($cls, $this->classes)) { |
69 | - $result = $this->classes[ $cls ]; |
|
69 | + $result = $this->classes[$cls]; |
|
70 | 70 | } else { |
71 | 71 | // no exact match, then lets try with `instanceof` |
72 | 72 | foreach (array_keys($this->getClasses()) as $class_name) { |
73 | 73 | if ($data instanceof $class_name) { |
74 | - $result = $this->classes[ $class_name ]; |
|
74 | + $result = $this->classes[$class_name]; |
|
75 | 75 | break; |
76 | 76 | } |
77 | 77 | } |
@@ -104,7 +104,7 @@ discard block |
||
104 | 104 | |
105 | 105 | if (is_object($data)) { |
106 | 106 | $cfg = $this->getClassMappingConfigOrThrow($data); |
107 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
107 | + $worker = new $cfg[ResponseBuilder::KEY_HANDLER](); |
|
108 | 108 | $data = $worker->convert($data, $cfg); |
109 | 109 | } else { |
110 | 110 | $data = $this->convertArray($data); |
@@ -146,12 +146,12 @@ discard block |
||
146 | 146 | |
147 | 147 | foreach ($data as $key => $val) { |
148 | 148 | if (is_array($val)) { |
149 | - $data[ $key ] = $this->convertArray($val); |
|
149 | + $data[$key] = $this->convertArray($val); |
|
150 | 150 | } elseif (is_object($val)) { |
151 | 151 | $cfg = $this->getClassMappingConfigOrThrow($val); |
152 | - $worker = new $cfg[ ResponseBuilder::KEY_HANDLER ](); |
|
152 | + $worker = new $cfg[ResponseBuilder::KEY_HANDLER](); |
|
153 | 153 | $converted_data = $worker->convert($val, $cfg); |
154 | - $data[ $key ] = $converted_data; |
|
154 | + $data[$key] = $converted_data; |
|
155 | 155 | } |
156 | 156 | } |
157 | 157 |