@@ -17,165 +17,165 @@ |
||
| 17 | 17 | */ |
| 18 | 18 | class Validator |
| 19 | 19 | { |
| 20 | - /** |
|
| 21 | - * Checks if given $val is of type boolean |
|
| 22 | - * |
|
| 23 | - * @param string $var_name Name of the key to be used if exception is thrown. |
|
| 24 | - * @param mixed $value Variable to be asserted. |
|
| 25 | - * |
|
| 26 | - * @return void |
|
| 27 | - * |
|
| 28 | - * @throws \InvalidArgumentException |
|
| 29 | - */ |
|
| 30 | - public static function assertIsBool(string $var_name, $value): void |
|
| 31 | - { |
|
| 32 | - self::assertIsType($var_name, $value, [Type::BOOLEAN]); |
|
| 33 | - } |
|
| 20 | + /** |
|
| 21 | + * Checks if given $val is of type boolean |
|
| 22 | + * |
|
| 23 | + * @param string $var_name Name of the key to be used if exception is thrown. |
|
| 24 | + * @param mixed $value Variable to be asserted. |
|
| 25 | + * |
|
| 26 | + * @return void |
|
| 27 | + * |
|
| 28 | + * @throws \InvalidArgumentException |
|
| 29 | + */ |
|
| 30 | + public static function assertIsBool(string $var_name, $value): void |
|
| 31 | + { |
|
| 32 | + self::assertIsType($var_name, $value, [Type::BOOLEAN]); |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Checks if given $val is of type integer |
|
| 37 | - * |
|
| 38 | - * @param string $key Name of the key to be used if exception is thrown. |
|
| 39 | - * @param mixed $value Variable to be asserted. |
|
| 40 | - * |
|
| 41 | - * @return void |
|
| 42 | - * |
|
| 43 | - * @throws \InvalidArgumentException |
|
| 44 | - */ |
|
| 45 | - public static function assertIsInt(string $key, $value): void |
|
| 46 | - { |
|
| 47 | - self::assertIsType($key, $value, [Type::INTEGER]); |
|
| 48 | - } |
|
| 35 | + /** |
|
| 36 | + * Checks if given $val is of type integer |
|
| 37 | + * |
|
| 38 | + * @param string $key Name of the key to be used if exception is thrown. |
|
| 39 | + * @param mixed $value Variable to be asserted. |
|
| 40 | + * |
|
| 41 | + * @return void |
|
| 42 | + * |
|
| 43 | + * @throws \InvalidArgumentException |
|
| 44 | + */ |
|
| 45 | + public static function assertIsInt(string $key, $value): void |
|
| 46 | + { |
|
| 47 | + self::assertIsType($key, $value, [Type::INTEGER]); |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Checks if given $val is of type array |
|
| 52 | - * |
|
| 53 | - * @param string $var_name Name of the key to be used if exception is thrown. |
|
| 54 | - * @param mixed $value Variable to be asserted. |
|
| 55 | - * |
|
| 56 | - * @return void |
|
| 57 | - * |
|
| 58 | - * @throws \InvalidArgumentException |
|
| 59 | - */ |
|
| 60 | - public static function assertIsArray(string $var_name, $value): void |
|
| 61 | - { |
|
| 62 | - self::assertIsType($var_name, $value, [Type::ARRAY]); |
|
| 63 | - } |
|
| 50 | + /** |
|
| 51 | + * Checks if given $val is of type array |
|
| 52 | + * |
|
| 53 | + * @param string $var_name Name of the key to be used if exception is thrown. |
|
| 54 | + * @param mixed $value Variable to be asserted. |
|
| 55 | + * |
|
| 56 | + * @return void |
|
| 57 | + * |
|
| 58 | + * @throws \InvalidArgumentException |
|
| 59 | + */ |
|
| 60 | + public static function assertIsArray(string $var_name, $value): void |
|
| 61 | + { |
|
| 62 | + self::assertIsType($var_name, $value, [Type::ARRAY]); |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Checks if given $val is an object |
|
| 67 | - * |
|
| 68 | - * @param string $var_name Name of the key to be used if exception is thrown. |
|
| 69 | - * @param mixed $value Variable to be asserted. |
|
| 70 | - * |
|
| 71 | - * @return void |
|
| 72 | - * |
|
| 73 | - * @throws \InvalidArgumentException |
|
| 74 | - */ |
|
| 75 | - public static function assertIsObject(string $var_name, $value): void |
|
| 76 | - { |
|
| 77 | - self::assertIsType($var_name, $value, [Type::OBJECT]); |
|
| 78 | - } |
|
| 65 | + /** |
|
| 66 | + * Checks if given $val is an object |
|
| 67 | + * |
|
| 68 | + * @param string $var_name Name of the key to be used if exception is thrown. |
|
| 69 | + * @param mixed $value Variable to be asserted. |
|
| 70 | + * |
|
| 71 | + * @return void |
|
| 72 | + * |
|
| 73 | + * @throws \InvalidArgumentException |
|
| 74 | + */ |
|
| 75 | + public static function assertIsObject(string $var_name, $value): void |
|
| 76 | + { |
|
| 77 | + self::assertIsType($var_name, $value, [Type::OBJECT]); |
|
| 78 | + } |
|
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Checks if given $val is of type string |
|
| 82 | - * |
|
| 83 | - * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
| 84 | - * @param mixed $value Variable to be asserted. |
|
| 85 | - * |
|
| 86 | - * @return void |
|
| 87 | - * |
|
| 88 | - * @throws \InvalidArgumentException |
|
| 89 | - */ |
|
| 90 | - public static function assertIsString(string $name, $value): void |
|
| 91 | - { |
|
| 92 | - self::assertIsType($name, $value, [Type::STRING]); |
|
| 93 | - } |
|
| 80 | + /** |
|
| 81 | + * Checks if given $val is of type string |
|
| 82 | + * |
|
| 83 | + * @param string $name Label or name of the variable to be used in exception message (if thrown). |
|
| 84 | + * @param mixed $value Variable to be asserted. |
|
| 85 | + * |
|
| 86 | + * @return void |
|
| 87 | + * |
|
| 88 | + * @throws \InvalidArgumentException |
|
| 89 | + */ |
|
| 90 | + public static function assertIsString(string $name, $value): void |
|
| 91 | + { |
|
| 92 | + self::assertIsType($name, $value, [Type::STRING]); |
|
| 93 | + } |
|
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * @param string $var_name Label or name of the variable to be used in exception message (if thrown). |
|
| 97 | - * @param mixed $value Variable to be asserted. |
|
| 98 | - * @param int $min Min allowed value (inclusive) |
|
| 99 | - * @param int $max Max allowed value (inclusive) |
|
| 100 | - * |
|
| 101 | - * @return void |
|
| 102 | - * |
|
| 103 | - * @throws \InvalidArgumentException |
|
| 104 | - * @throws \RuntimeException |
|
| 105 | - */ |
|
| 106 | - public static function assertIsIntRange(string $var_name, $value, int $min, int $max): void |
|
| 107 | - { |
|
| 108 | - self::assertIsInt($var_name, $value); |
|
| 95 | + /** |
|
| 96 | + * @param string $var_name Label or name of the variable to be used in exception message (if thrown). |
|
| 97 | + * @param mixed $value Variable to be asserted. |
|
| 98 | + * @param int $min Min allowed value (inclusive) |
|
| 99 | + * @param int $max Max allowed value (inclusive) |
|
| 100 | + * |
|
| 101 | + * @return void |
|
| 102 | + * |
|
| 103 | + * @throws \InvalidArgumentException |
|
| 104 | + * @throws \RuntimeException |
|
| 105 | + */ |
|
| 106 | + public static function assertIsIntRange(string $var_name, $value, int $min, int $max): void |
|
| 107 | + { |
|
| 108 | + self::assertIsInt($var_name, $value); |
|
| 109 | 109 | |
| 110 | - if ($min > $max) { |
|
| 111 | - throw new \RuntimeException( |
|
| 112 | - \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $var_name)); |
|
| 113 | - } |
|
| 110 | + if ($min > $max) { |
|
| 111 | + throw new \RuntimeException( |
|
| 112 | + \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $var_name)); |
|
| 113 | + } |
|
| 114 | 114 | |
| 115 | - if (($min > $value) || ($value > $max)) { |
|
| 116 | - throw new \InvalidArgumentException( |
|
| 117 | - \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $var_name, $value, $min, $max)); |
|
| 118 | - } |
|
| 119 | - } |
|
| 115 | + if (($min > $value) || ($value > $max)) { |
|
| 116 | + throw new \InvalidArgumentException( |
|
| 117 | + \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $var_name, $value, $min, $max)); |
|
| 118 | + } |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Checks if $item (of name $key) is of type that is include in $allowed_types. |
|
| 123 | - * |
|
| 124 | - * @param string $var_name Label or name of the variable to be used in exception message (if thrown). |
|
| 125 | - * @param mixed $value Variable to be asserted. |
|
| 126 | - * @param array $allowed_types Array of allowed types for $var, i.e. [Type::INTEGER] |
|
| 127 | - * |
|
| 128 | - * @return void |
|
| 129 | - * |
|
| 130 | - * @throws \InvalidArgumentException |
|
| 131 | - */ |
|
| 132 | - public static function assertIsType(string $var_name, $value, array $allowed_types): void |
|
| 133 | - { |
|
| 134 | - $type = \gettype($value); |
|
| 135 | - if (!\in_array($type, $allowed_types, true)) { |
|
| 136 | - throw new \InvalidArgumentException( |
|
| 137 | - \sprintf('"%s" must be one of allowed types: %s (%s given).', |
|
| 138 | - $var_name, implode(', ', $allowed_types), \gettype($value)) |
|
| 139 | - ); |
|
| 140 | - } |
|
| 141 | - } |
|
| 121 | + /** |
|
| 122 | + * Checks if $item (of name $key) is of type that is include in $allowed_types. |
|
| 123 | + * |
|
| 124 | + * @param string $var_name Label or name of the variable to be used in exception message (if thrown). |
|
| 125 | + * @param mixed $value Variable to be asserted. |
|
| 126 | + * @param array $allowed_types Array of allowed types for $var, i.e. [Type::INTEGER] |
|
| 127 | + * |
|
| 128 | + * @return void |
|
| 129 | + * |
|
| 130 | + * @throws \InvalidArgumentException |
|
| 131 | + */ |
|
| 132 | + public static function assertIsType(string $var_name, $value, array $allowed_types): void |
|
| 133 | + { |
|
| 134 | + $type = \gettype($value); |
|
| 135 | + if (!\in_array($type, $allowed_types, true)) { |
|
| 136 | + throw new \InvalidArgumentException( |
|
| 137 | + \sprintf('"%s" must be one of allowed types: %s (%s given).', |
|
| 138 | + $var_name, implode(', ', $allowed_types), \gettype($value)) |
|
| 139 | + ); |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Ensures given $http_code is valid code for error response. |
|
| 145 | - * |
|
| 146 | - * @param int $http_code |
|
| 147 | - */ |
|
| 148 | - public static function assertErrorHttpCode(int $http_code): void |
|
| 149 | - { |
|
| 150 | - self::assertIsInt('http_code', $http_code); |
|
| 151 | - self::assertIsIntRange('http_code', $http_code, |
|
| 152 | - RB::ERROR_HTTP_CODE_MIN, RB::ERROR_HTTP_CODE_MAX); |
|
| 153 | - } |
|
| 143 | + /** |
|
| 144 | + * Ensures given $http_code is valid code for error response. |
|
| 145 | + * |
|
| 146 | + * @param int $http_code |
|
| 147 | + */ |
|
| 148 | + public static function assertErrorHttpCode(int $http_code): void |
|
| 149 | + { |
|
| 150 | + self::assertIsInt('http_code', $http_code); |
|
| 151 | + self::assertIsIntRange('http_code', $http_code, |
|
| 152 | + RB::ERROR_HTTP_CODE_MIN, RB::ERROR_HTTP_CODE_MAX); |
|
| 153 | + } |
|
| 154 | 154 | |
| 155 | - /** |
|
| 156 | - * Ensures given $http_code is valid for response indicating sucessful operation. |
|
| 157 | - * |
|
| 158 | - * @param int $http_code |
|
| 159 | - */ |
|
| 160 | - public static function assertOkHttpCode(int $http_code): void |
|
| 161 | - { |
|
| 162 | - self::assertIsInt('http_code', $http_code); |
|
| 163 | - self::assertIsIntRange('http_code', $http_code, 200, 299); |
|
| 164 | - } |
|
| 155 | + /** |
|
| 156 | + * Ensures given $http_code is valid for response indicating sucessful operation. |
|
| 157 | + * |
|
| 158 | + * @param int $http_code |
|
| 159 | + */ |
|
| 160 | + public static function assertOkHttpCode(int $http_code): void |
|
| 161 | + { |
|
| 162 | + self::assertIsInt('http_code', $http_code); |
|
| 163 | + self::assertIsIntRange('http_code', $http_code, 200, 299); |
|
| 164 | + } |
|
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * Ensures $obj (that is value coming from variable, which name is passed in $label) is instance of $cls class. |
|
| 168 | - * |
|
| 169 | - * @param string $var_name Name of variable that the $obj value is coming from. Used for exception message. |
|
| 170 | - * @param object $obj Object to check instance of |
|
| 171 | - * @param string $cls Target class we want to check $obj agains. |
|
| 172 | - */ |
|
| 173 | - public static function assertInstanceOf(string $var_name, object $obj, string $cls): void |
|
| 174 | - { |
|
| 175 | - if (!($obj instanceof $cls)) { |
|
| 176 | - throw new \InvalidArgumentException( |
|
| 177 | - \sprintf('"%s" must be instance of "%s".', $var_name, $cls) |
|
| 178 | - ); |
|
| 179 | - } |
|
| 180 | - } |
|
| 166 | + /** |
|
| 167 | + * Ensures $obj (that is value coming from variable, which name is passed in $label) is instance of $cls class. |
|
| 168 | + * |
|
| 169 | + * @param string $var_name Name of variable that the $obj value is coming from. Used for exception message. |
|
| 170 | + * @param object $obj Object to check instance of |
|
| 171 | + * @param string $cls Target class we want to check $obj agains. |
|
| 172 | + */ |
|
| 173 | + public static function assertInstanceOf(string $var_name, object $obj, string $cls): void |
|
| 174 | + { |
|
| 175 | + if (!($obj instanceof $cls)) { |
|
| 176 | + throw new \InvalidArgumentException( |
|
| 177 | + \sprintf('"%s" must be instance of "%s".', $var_name, $cls) |
|
| 178 | + ); |
|
| 179 | + } |
|
| 180 | + } |
|
| 181 | 181 | } |
@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | * @return HttpResponse |
| 86 | 86 | */ |
| 87 | 87 | public static function success($data = null, $api_code = null, array $placeholders = null, |
| 88 | - int $http_code = null, int $json_opts = null): HttpResponse |
|
| 88 | + int $http_code = null, int $json_opts = null): HttpResponse |
|
| 89 | 89 | { |
| 90 | 90 | return static::asSuccess($api_code) |
| 91 | 91 | ->withData($data) |
@@ -113,7 +113,7 @@ discard block |
||
| 113 | 113 | * @return HttpResponse |
| 114 | 114 | */ |
| 115 | 115 | public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null, |
| 116 | - int $json_opts = null): HttpResponse |
|
| 116 | + int $json_opts = null): HttpResponse |
|
| 117 | 117 | { |
| 118 | 118 | return static::asError($api_code) |
| 119 | 119 | ->withPlaceholders($placeholders) |
@@ -162,7 +162,7 @@ discard block |
||
| 162 | 162 | public function withHttpCode(int $http_code = null): self |
| 163 | 163 | { |
| 164 | 164 | Validator::assertIsType('http_code', $http_code, [Type::INTEGER, |
| 165 | - Type::NULL]); |
|
| 165 | + Type::NULL]); |
|
| 166 | 166 | $this->http_code = $http_code; |
| 167 | 167 | |
| 168 | 168 | return $this; |
@@ -196,7 +196,7 @@ discard block |
||
| 196 | 196 | public function withJsonOptions(int $json_opts = null): self |
| 197 | 197 | { |
| 198 | 198 | Validator::assertIsType('json_opts', $json_opts, [Type::INTEGER, |
| 199 | - Type::NULL]); |
|
| 199 | + Type::NULL]); |
|
| 200 | 200 | $this->json_opts = $json_opts; |
| 201 | 201 | |
| 202 | 202 | return $this; |
@@ -210,7 +210,7 @@ discard block |
||
| 210 | 210 | public function withDebugData(array $debug_data = null): self |
| 211 | 211 | { |
| 212 | 212 | Validator::assertIsType('$debug_data', $debug_data, [Type::ARRAY, |
| 213 | - Type::NULL]); |
|
| 213 | + Type::NULL]); |
|
| 214 | 214 | $this->debug_data = $debug_data; |
| 215 | 215 | |
| 216 | 216 | return $this; |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | public function withMessage(string $msg = null): self |
| 225 | 225 | { |
| 226 | 226 | Validator::assertIsType('message', $msg, [Type::STRING, |
| 227 | - Type::NULL]); |
|
| 227 | + Type::NULL]); |
|
| 228 | 228 | $this->message = $msg; |
| 229 | 229 | |
| 230 | 230 | return $this; |
@@ -311,8 +311,8 @@ discard block |
||
| 311 | 311 | * @noinspection PhpTooManyParametersInspection |
| 312 | 312 | */ |
| 313 | 313 | protected function make(bool $success, int $api_code, $msg_or_api_code, $data = null, |
| 314 | - int $http_code = null, array $placeholders = null, array $http_headers = null, |
|
| 315 | - int $json_opts = null, array $debug_data = null): HttpResponse |
|
| 314 | + int $http_code = null, array $placeholders = null, array $http_headers = null, |
|
| 315 | + int $json_opts = null, array $debug_data = null): HttpResponse |
|
| 316 | 316 | { |
| 317 | 317 | $http_headers = $http_headers ?? []; |
| 318 | 318 | $http_code = $http_code ?? ($success ? RB::DEFAULT_HTTP_CODE_OK : RB::DEFAULT_HTTP_CODE_ERROR); |
@@ -351,8 +351,8 @@ discard block |
||
| 351 | 351 | * @noinspection PhpTooManyParametersInspection |
| 352 | 352 | */ |
| 353 | 353 | protected function buildResponse(bool $success, int $api_code, |
| 354 | - $msg_or_api_code, array $placeholders = null, |
|
| 355 | - $data = null, array $debug_data = null): array |
|
| 354 | + $msg_or_api_code, array $placeholders = null, |
|
| 355 | + $data = null, array $debug_data = null): array |
|
| 356 | 356 | { |
| 357 | 357 | // ensure $data is either @null, array or object of class with configured mapping. |
| 358 | 358 | $data = (new Converter())->convert($data); |
@@ -23,27 +23,27 @@ discard block |
||
| 23 | 23 | */ |
| 24 | 24 | class Converter |
| 25 | 25 | { |
| 26 | - /** @var array */ |
|
| 27 | - protected $classes = []; |
|
| 26 | + /** @var array */ |
|
| 27 | + protected $classes = []; |
|
| 28 | 28 | |
| 29 | - /** @var array */ |
|
| 30 | - protected $primitives = []; |
|
| 29 | + /** @var array */ |
|
| 30 | + protected $primitives = []; |
|
| 31 | 31 | |
| 32 | - /** @var bool */ |
|
| 33 | - protected $debug_enabled = false; |
|
| 32 | + /** @var bool */ |
|
| 33 | + protected $debug_enabled = false; |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Converter constructor. |
|
| 37 | - * |
|
| 38 | - * @throws \RuntimeException |
|
| 39 | - */ |
|
| 40 | - public function __construct() |
|
| 41 | - { |
|
| 42 | - $this->classes = static::getClassesMapping() ?? []; |
|
| 43 | - $this->primitives = static::getPrimitivesMapping() ?? []; |
|
| 35 | + /** |
|
| 36 | + * Converter constructor. |
|
| 37 | + * |
|
| 38 | + * @throws \RuntimeException |
|
| 39 | + */ |
|
| 40 | + public function __construct() |
|
| 41 | + { |
|
| 42 | + $this->classes = static::getClassesMapping() ?? []; |
|
| 43 | + $this->primitives = static::getPrimitivesMapping() ?? []; |
|
| 44 | 44 | |
| 45 | - $this->debug_enabled = Config::get(RB::CONF_KEY_DEBUG_CONVERTER_DEBUG_ENABLED, false); |
|
| 46 | - } |
|
| 45 | + $this->debug_enabled = Config::get(RB::CONF_KEY_DEBUG_CONVERTER_DEBUG_ENABLED, false); |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | 48 | /** |
| 49 | 49 | * Returns "converter/primitives" entry for given primitive object or throws exception if no config found. |
@@ -56,200 +56,200 @@ discard block |
||
| 56 | 56 | * |
| 57 | 57 | * @throws \InvalidArgumentException |
| 58 | 58 | */ |
| 59 | - protected function getPrimitiveMappingConfigOrThrow($data): array |
|
| 60 | - { |
|
| 61 | - $result = null; |
|
| 62 | - |
|
| 63 | - $type = \gettype($data); |
|
| 64 | - $result = $this->primitives[ $type ] ?? null; |
|
| 65 | - if (!\is_array($result) && !empty($result)) { |
|
| 66 | - throw new \RuntimeException(sprintf('No data conversion mapping config for "%s" primitive.', $type)); |
|
| 67 | - } |
|
| 68 | - |
|
| 69 | - if ($result === null) { |
|
| 70 | - throw new \RuntimeException(sprintf('No data conversion mapping configured for "%s" primitive.', $type)); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - if ($this->debug_enabled) { |
|
| 74 | - Log::debug(__CLASS__ . ": Converting primitive type of '{$type}' to data node '{$result[RB::KEY_KEY]}'."); |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - return $result; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * Returns "converter/map" mapping configured for given $data object class or throws exception if not found. |
|
| 82 | - * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured. |
|
| 83 | - * Throws \InvalidArgumentException if No data conversion mapping configured for given class. |
|
| 84 | - * |
|
| 85 | - * @param object $data Object to get config for. |
|
| 86 | - * |
|
| 87 | - * @return array |
|
| 88 | - * |
|
| 89 | - * @throws \InvalidArgumentException |
|
| 90 | - */ |
|
| 91 | - protected function getClassMappingConfigOrThrow(object $data): array |
|
| 92 | - { |
|
| 93 | - $result = null; |
|
| 94 | - $debug_result = ''; |
|
| 95 | - |
|
| 96 | - // check for exact class name match... |
|
| 97 | - $cls = \get_class($data); |
|
| 98 | - if (\is_string($cls)) { |
|
| 99 | - if (\array_key_exists($cls, $this->classes)) { |
|
| 100 | - $result = $this->classes[ $cls ]; |
|
| 101 | - $debug_result = 'exact config match'; |
|
| 102 | - } else { |
|
| 103 | - // no exact match, then lets try with `instanceof` |
|
| 104 | - foreach (\array_keys($this->classes) as $class_name) { |
|
| 105 | - if ($data instanceof $class_name) { |
|
| 106 | - $result = $this->classes[ $class_name ]; |
|
| 107 | - $debug_result = "subclass of {$class_name}"; |
|
| 108 | - break; |
|
| 109 | - } |
|
| 110 | - } |
|
| 111 | - } |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - if ($result === null) { |
|
| 115 | - throw new \RuntimeException(sprintf('No data conversion mapping configured for "%s" class.', $cls)); |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - if ($this->debug_enabled) { |
|
| 59 | + protected function getPrimitiveMappingConfigOrThrow($data): array |
|
| 60 | + { |
|
| 61 | + $result = null; |
|
| 62 | + |
|
| 63 | + $type = \gettype($data); |
|
| 64 | + $result = $this->primitives[ $type ] ?? null; |
|
| 65 | + if (!\is_array($result) && !empty($result)) { |
|
| 66 | + throw new \RuntimeException(sprintf('No data conversion mapping config for "%s" primitive.', $type)); |
|
| 67 | + } |
|
| 68 | + |
|
| 69 | + if ($result === null) { |
|
| 70 | + throw new \RuntimeException(sprintf('No data conversion mapping configured for "%s" primitive.', $type)); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + if ($this->debug_enabled) { |
|
| 74 | + Log::debug(__CLASS__ . ": Converting primitive type of '{$type}' to data node '{$result[RB::KEY_KEY]}'."); |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + return $result; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * Returns "converter/map" mapping configured for given $data object class or throws exception if not found. |
|
| 82 | + * Throws \RuntimeException if there's no config "classes" mapping entry for this object configured. |
|
| 83 | + * Throws \InvalidArgumentException if No data conversion mapping configured for given class. |
|
| 84 | + * |
|
| 85 | + * @param object $data Object to get config for. |
|
| 86 | + * |
|
| 87 | + * @return array |
|
| 88 | + * |
|
| 89 | + * @throws \InvalidArgumentException |
|
| 90 | + */ |
|
| 91 | + protected function getClassMappingConfigOrThrow(object $data): array |
|
| 92 | + { |
|
| 93 | + $result = null; |
|
| 94 | + $debug_result = ''; |
|
| 95 | + |
|
| 96 | + // check for exact class name match... |
|
| 97 | + $cls = \get_class($data); |
|
| 98 | + if (\is_string($cls)) { |
|
| 99 | + if (\array_key_exists($cls, $this->classes)) { |
|
| 100 | + $result = $this->classes[ $cls ]; |
|
| 101 | + $debug_result = 'exact config match'; |
|
| 102 | + } else { |
|
| 103 | + // no exact match, then lets try with `instanceof` |
|
| 104 | + foreach (\array_keys($this->classes) as $class_name) { |
|
| 105 | + if ($data instanceof $class_name) { |
|
| 106 | + $result = $this->classes[ $class_name ]; |
|
| 107 | + $debug_result = "subclass of {$class_name}"; |
|
| 108 | + break; |
|
| 109 | + } |
|
| 110 | + } |
|
| 111 | + } |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + if ($result === null) { |
|
| 115 | + throw new \RuntimeException(sprintf('No data conversion mapping configured for "%s" class.', $cls)); |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + if ($this->debug_enabled) { |
|
| 119 | 119 | Log::debug(__CLASS__ . ": Converting {$cls} using {$result[RB::KEY_HANDLER]} because: {$debug_result}."); |
| 120 | - } |
|
| 121 | - |
|
| 122 | - return $result; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Main entry for data conversion |
|
| 127 | - * |
|
| 128 | - * @param object|array|null $data |
|
| 129 | - * |
|
| 130 | - * @return mixed|null |
|
| 131 | - * |
|
| 132 | - * @throws \InvalidArgumentException |
|
| 133 | - */ |
|
| 134 | - public function convert($data = null): ?array |
|
| 135 | - { |
|
| 136 | - if ($data === null) { |
|
| 137 | - return null; |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - $result = null; |
|
| 141 | - |
|
| 142 | - Validator::assertIsType('data', $data, [ |
|
| 143 | - Type::ARRAY, |
|
| 144 | - Type::BOOLEAN, |
|
| 145 | - Type::DOUBLE, |
|
| 146 | - Type::INTEGER, |
|
| 147 | - Type::STRING, |
|
| 148 | - Type::OBJECT, |
|
| 149 | - ]); |
|
| 150 | - |
|
| 151 | - if ($result === null && \is_object($data)) { |
|
| 152 | - $cfg = $this->getClassMappingConfigOrThrow($data); |
|
| 153 | - $worker = new $cfg[ RB::KEY_HANDLER ](); |
|
| 154 | - $result = [$cfg[ RB::KEY_KEY ] => $worker->convert($data, $cfg)]; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - if ($result === null && \is_array($data)) { |
|
| 158 | - $cfg = $this->getPrimitiveMappingConfigOrThrow($data); |
|
| 159 | - |
|
| 160 | - $result = $this->convertArray($data); |
|
| 161 | - if (!Util::isArrayWithNonNumericKeys($data)){ |
|
| 162 | - $result = [$cfg[ RB::KEY_KEY ] => $result]; |
|
| 163 | - } |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) { |
|
| 167 | - $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data]; |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - return $result; |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Recursively walks $data array and converts all known objects if found. Note |
|
| 175 | - * $data array is passed by reference so source $data array may be modified. |
|
| 176 | - * |
|
| 177 | - * @param array $data array to recursively convert known elements of |
|
| 178 | - * |
|
| 179 | - * @return array |
|
| 180 | - * |
|
| 181 | - * @throws \RuntimeException |
|
| 182 | - */ |
|
| 183 | - protected function convertArray(array $data): array |
|
| 184 | - { |
|
| 185 | - // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then |
|
| 186 | - // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON |
|
| 187 | - // array. But you can't mix these two as the final JSON would not produce predictable results. |
|
| 188 | - $string_keys_cnt = 0; |
|
| 189 | - $int_keys_cnt = 0; |
|
| 190 | - foreach ($data as $key => $val) { |
|
| 191 | - if (\is_int($key)) { |
|
| 192 | - $int_keys_cnt++; |
|
| 193 | - } else { |
|
| 194 | - $string_keys_cnt++; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) { |
|
| 198 | - throw new \RuntimeException( |
|
| 199 | - 'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' . |
|
| 200 | - 'Arrays with mixed keys are not supported by design.'); |
|
| 201 | - } |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - foreach ($data as $key => $val) { |
|
| 205 | - if (\is_array($val)) { |
|
| 206 | - $data[ $key ] = $this->convertArray($val); |
|
| 207 | - } elseif (\is_object($val)) { |
|
| 208 | - $cfg = $this->getClassMappingConfigOrThrow($val); |
|
| 209 | - $worker = new $cfg[ RB::KEY_HANDLER ](); |
|
| 210 | - $converted_data = $worker->convert($val, $cfg); |
|
| 211 | - $data[ $key ] = $converted_data; |
|
| 212 | - } |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - return $data; |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Reads and validates "converter/map" config mapping |
|
| 220 | - * |
|
| 221 | - * @return array Classes mapping as specified in configuration or empty array if configuration found |
|
| 222 | - * |
|
| 223 | - * @throws \RuntimeException if config mapping is technically invalid (i.e. not array etc). |
|
| 224 | - */ |
|
| 225 | - protected static function getClassesMapping(): array |
|
| 226 | - { |
|
| 227 | - $classes = Config::get(RB::CONF_KEY_CONVERTER_CLASSES) ?? []; |
|
| 228 | - |
|
| 229 | - if (!\is_array($classes)) { |
|
| 230 | - throw new \RuntimeException( |
|
| 231 | - \sprintf('CONFIG: "%s" mapping must be an array (%s given)', RB::CONF_KEY_CONVERTER_CLASSES, \gettype($classes))); |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - if (!empty($classes)) { |
|
| 235 | - $mandatory_keys = [ |
|
| 236 | - RB::KEY_HANDLER, |
|
| 237 | - RB::KEY_KEY, |
|
| 238 | - ]; |
|
| 239 | - foreach ($classes as $class_name => $class_config) { |
|
| 240 | - if (!\is_array($class_config)) { |
|
| 241 | - throw new \InvalidArgumentException(sprintf("CONFIG: Config for '{$class_name}' class must be an array (%s given).", \gettype($class_config))); |
|
| 242 | - } |
|
| 243 | - foreach ($mandatory_keys as $key_name) { |
|
| 244 | - if (!\array_key_exists($key_name, $class_config)) { |
|
| 245 | - throw new \RuntimeException("CONFIG: Missing '{$key_name}' in '{$class_name}' class mapping config."); |
|
| 246 | - } |
|
| 247 | - } |
|
| 248 | - } |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - return $classes; |
|
| 252 | - } |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + return $result; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Main entry for data conversion |
|
| 127 | + * |
|
| 128 | + * @param object|array|null $data |
|
| 129 | + * |
|
| 130 | + * @return mixed|null |
|
| 131 | + * |
|
| 132 | + * @throws \InvalidArgumentException |
|
| 133 | + */ |
|
| 134 | + public function convert($data = null): ?array |
|
| 135 | + { |
|
| 136 | + if ($data === null) { |
|
| 137 | + return null; |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + $result = null; |
|
| 141 | + |
|
| 142 | + Validator::assertIsType('data', $data, [ |
|
| 143 | + Type::ARRAY, |
|
| 144 | + Type::BOOLEAN, |
|
| 145 | + Type::DOUBLE, |
|
| 146 | + Type::INTEGER, |
|
| 147 | + Type::STRING, |
|
| 148 | + Type::OBJECT, |
|
| 149 | + ]); |
|
| 150 | + |
|
| 151 | + if ($result === null && \is_object($data)) { |
|
| 152 | + $cfg = $this->getClassMappingConfigOrThrow($data); |
|
| 153 | + $worker = new $cfg[ RB::KEY_HANDLER ](); |
|
| 154 | + $result = [$cfg[ RB::KEY_KEY ] => $worker->convert($data, $cfg)]; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + if ($result === null && \is_array($data)) { |
|
| 158 | + $cfg = $this->getPrimitiveMappingConfigOrThrow($data); |
|
| 159 | + |
|
| 160 | + $result = $this->convertArray($data); |
|
| 161 | + if (!Util::isArrayWithNonNumericKeys($data)){ |
|
| 162 | + $result = [$cfg[ RB::KEY_KEY ] => $result]; |
|
| 163 | + } |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) { |
|
| 167 | + $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data]; |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + return $result; |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Recursively walks $data array and converts all known objects if found. Note |
|
| 175 | + * $data array is passed by reference so source $data array may be modified. |
|
| 176 | + * |
|
| 177 | + * @param array $data array to recursively convert known elements of |
|
| 178 | + * |
|
| 179 | + * @return array |
|
| 180 | + * |
|
| 181 | + * @throws \RuntimeException |
|
| 182 | + */ |
|
| 183 | + protected function convertArray(array $data): array |
|
| 184 | + { |
|
| 185 | + // This is to ensure that we either have array with user provided keys i.e. ['foo'=>'bar'], which will then |
|
| 186 | + // be turned into JSON object or array without user specified keys (['bar']) which we would return as JSON |
|
| 187 | + // array. But you can't mix these two as the final JSON would not produce predictable results. |
|
| 188 | + $string_keys_cnt = 0; |
|
| 189 | + $int_keys_cnt = 0; |
|
| 190 | + foreach ($data as $key => $val) { |
|
| 191 | + if (\is_int($key)) { |
|
| 192 | + $int_keys_cnt++; |
|
| 193 | + } else { |
|
| 194 | + $string_keys_cnt++; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + if (($string_keys_cnt > 0) && ($int_keys_cnt > 0)) { |
|
| 198 | + throw new \RuntimeException( |
|
| 199 | + 'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' . |
|
| 200 | + 'Arrays with mixed keys are not supported by design.'); |
|
| 201 | + } |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + foreach ($data as $key => $val) { |
|
| 205 | + if (\is_array($val)) { |
|
| 206 | + $data[ $key ] = $this->convertArray($val); |
|
| 207 | + } elseif (\is_object($val)) { |
|
| 208 | + $cfg = $this->getClassMappingConfigOrThrow($val); |
|
| 209 | + $worker = new $cfg[ RB::KEY_HANDLER ](); |
|
| 210 | + $converted_data = $worker->convert($val, $cfg); |
|
| 211 | + $data[ $key ] = $converted_data; |
|
| 212 | + } |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + return $data; |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Reads and validates "converter/map" config mapping |
|
| 220 | + * |
|
| 221 | + * @return array Classes mapping as specified in configuration or empty array if configuration found |
|
| 222 | + * |
|
| 223 | + * @throws \RuntimeException if config mapping is technically invalid (i.e. not array etc). |
|
| 224 | + */ |
|
| 225 | + protected static function getClassesMapping(): array |
|
| 226 | + { |
|
| 227 | + $classes = Config::get(RB::CONF_KEY_CONVERTER_CLASSES) ?? []; |
|
| 228 | + |
|
| 229 | + if (!\is_array($classes)) { |
|
| 230 | + throw new \RuntimeException( |
|
| 231 | + \sprintf('CONFIG: "%s" mapping must be an array (%s given)', RB::CONF_KEY_CONVERTER_CLASSES, \gettype($classes))); |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + if (!empty($classes)) { |
|
| 235 | + $mandatory_keys = [ |
|
| 236 | + RB::KEY_HANDLER, |
|
| 237 | + RB::KEY_KEY, |
|
| 238 | + ]; |
|
| 239 | + foreach ($classes as $class_name => $class_config) { |
|
| 240 | + if (!\is_array($class_config)) { |
|
| 241 | + throw new \InvalidArgumentException(sprintf("CONFIG: Config for '{$class_name}' class must be an array (%s given).", \gettype($class_config))); |
|
| 242 | + } |
|
| 243 | + foreach ($mandatory_keys as $key_name) { |
|
| 244 | + if (!\array_key_exists($key_name, $class_config)) { |
|
| 245 | + throw new \RuntimeException("CONFIG: Missing '{$key_name}' in '{$class_name}' class mapping config."); |
|
| 246 | + } |
|
| 247 | + } |
|
| 248 | + } |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + return $classes; |
|
| 252 | + } |
|
| 253 | 253 | |
| 254 | 254 | /** |
| 255 | 255 | * Reads and validates "converter/primitives" config mapping |
@@ -61,7 +61,7 @@ discard block |
||
| 61 | 61 | $result = null; |
| 62 | 62 | |
| 63 | 63 | $type = \gettype($data); |
| 64 | - $result = $this->primitives[ $type ] ?? null; |
|
| 64 | + $result = $this->primitives[$type] ?? null; |
|
| 65 | 65 | if (!\is_array($result) && !empty($result)) { |
| 66 | 66 | throw new \RuntimeException(sprintf('No data conversion mapping config for "%s" primitive.', $type)); |
| 67 | 67 | } |
@@ -97,13 +97,13 @@ discard block |
||
| 97 | 97 | $cls = \get_class($data); |
| 98 | 98 | if (\is_string($cls)) { |
| 99 | 99 | if (\array_key_exists($cls, $this->classes)) { |
| 100 | - $result = $this->classes[ $cls ]; |
|
| 100 | + $result = $this->classes[$cls]; |
|
| 101 | 101 | $debug_result = 'exact config match'; |
| 102 | 102 | } else { |
| 103 | 103 | // no exact match, then lets try with `instanceof` |
| 104 | 104 | foreach (\array_keys($this->classes) as $class_name) { |
| 105 | 105 | if ($data instanceof $class_name) { |
| 106 | - $result = $this->classes[ $class_name ]; |
|
| 106 | + $result = $this->classes[$class_name]; |
|
| 107 | 107 | $debug_result = "subclass of {$class_name}"; |
| 108 | 108 | break; |
| 109 | 109 | } |
@@ -150,21 +150,21 @@ discard block |
||
| 150 | 150 | |
| 151 | 151 | if ($result === null && \is_object($data)) { |
| 152 | 152 | $cfg = $this->getClassMappingConfigOrThrow($data); |
| 153 | - $worker = new $cfg[ RB::KEY_HANDLER ](); |
|
| 154 | - $result = [$cfg[ RB::KEY_KEY ] => $worker->convert($data, $cfg)]; |
|
| 153 | + $worker = new $cfg[RB::KEY_HANDLER](); |
|
| 154 | + $result = [$cfg[RB::KEY_KEY] => $worker->convert($data, $cfg)]; |
|
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | if ($result === null && \is_array($data)) { |
| 158 | 158 | $cfg = $this->getPrimitiveMappingConfigOrThrow($data); |
| 159 | 159 | |
| 160 | 160 | $result = $this->convertArray($data); |
| 161 | - if (!Util::isArrayWithNonNumericKeys($data)){ |
|
| 162 | - $result = [$cfg[ RB::KEY_KEY ] => $result]; |
|
| 161 | + if (!Util::isArrayWithNonNumericKeys($data)) { |
|
| 162 | + $result = [$cfg[RB::KEY_KEY] => $result]; |
|
| 163 | 163 | } |
| 164 | 164 | } |
| 165 | 165 | |
| 166 | - if ( \is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) { |
|
| 167 | - $result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data]; |
|
| 166 | + if (\is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) { |
|
| 167 | + $result = [$this->getPrimitiveMappingConfigOrThrow($data)[RB::KEY_KEY] => $data]; |
|
| 168 | 168 | } |
| 169 | 169 | |
| 170 | 170 | return $result; |
@@ -203,12 +203,12 @@ discard block |
||
| 203 | 203 | |
| 204 | 204 | foreach ($data as $key => $val) { |
| 205 | 205 | if (\is_array($val)) { |
| 206 | - $data[ $key ] = $this->convertArray($val); |
|
| 206 | + $data[$key] = $this->convertArray($val); |
|
| 207 | 207 | } elseif (\is_object($val)) { |
| 208 | 208 | $cfg = $this->getClassMappingConfigOrThrow($val); |
| 209 | - $worker = new $cfg[ RB::KEY_HANDLER ](); |
|
| 209 | + $worker = new $cfg[RB::KEY_HANDLER](); |
|
| 210 | 210 | $converted_data = $worker->convert($val, $cfg); |
| 211 | - $data[ $key ] = $converted_data; |
|
| 211 | + $data[$key] = $converted_data; |
|
| 212 | 212 | } |
| 213 | 213 | } |
| 214 | 214 | |