MarcinOrlowski / laravel-api-response-builder

src/Validator.php

Indentation +1 added lines, -1 removed lines

@@ -132,7 +132,7 @@
 	 * @throws \InvalidArgumentException
 	 */
 	public static function assertIsType(string $var_name, $value, array $allowed_types,
-	                                    string $ex_class = Ex\InvalidTypeException::class): void
+										string $ex_class = Ex\InvalidTypeException::class): void
 	{
 		$type = \gettype($value);
 		if (!\in_array($type, $allowed_types, true)) {

src/ResponseBuilderServiceProvider.php

Indentation +2 added lines, -2 removed lines

@@ -78,7 +78,7 @@
 
 		Util::sortArrayByPri($merged_config['converter']['classes']);
 
-        $this->app['config']->set($key, $merged_config);
-    }
+		$this->app['config']->set($key, $merged_config);
+	}
 
 }

src/Converters/ToArrayConverter.php

Indentation +14 added lines, -14 removed lines

@@ -22,19 +22,19 @@
  */
 final class ToArrayConverter implements ConverterContract
 {
-    /**
-     * Returns array representation of the object.
-     *
-     * @param object $obj    Object to be converted
-     * @param array  $config Converter config array to be used for this object (based on exact class
-     *                       name match or inheritance).
-     *
-     * @return array
-     */
-    public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
-    {
-        Validator::assertIsObject('obj', $obj);
+	/**
+	 * Returns array representation of the object.
+	 *
+	 * @param object $obj    Object to be converted
+	 * @param array  $config Converter config array to be used for this object (based on exact class
+	 *                       name match or inheritance).
+	 *
+	 * @return array
+	 */
+	public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
+	{
+		Validator::assertIsObject('obj', $obj);
 
-        return $obj->toArray();
-    }
+		return $obj->toArray();
+	}
 }

src/Util.php

Spacing +5 added lines, -5 removed lines

@@ -40,20 +40,20 @@
 		$array = $original;
 		foreach ($merging as $m_key => $m_val) {
 			if (\array_key_exists($m_key, $original)) {
-				$orig_type = \gettype($original[ $m_key ]);
+				$orig_type = \gettype($original[$m_key]);
 				$m_type = \gettype($m_val);
 				if ($orig_type !== $m_type) {
 					throw new Ex\IncompatibleTypeException(
 						"Incompatible types. Cannot merge {$m_type} into {$orig_type} (key '{$m_key}').");
 				}
 
-				if (\is_array($merging[ $m_key ])) {
-					$array[ $m_key ] = static::mergeConfig($original[ $m_key ], $m_val);
+				if (\is_array($merging[$m_key])) {
+					$array[$m_key] = static::mergeConfig($original[$m_key], $m_val);
 				} else {
-					$array[ $m_key ] = $m_val;
+					$array[$m_key] = $m_val;
 				}
 			} else {
-				$array[ $m_key ] = $m_val;
+				$array[$m_key] = $m_val;
 			}
 		}
 

src/Converter.php

Indentation +2 added lines, -2 removed lines

@@ -147,7 +147,7 @@ 
 			$worker = new $cfg[ RB::KEY_HANDLER ]();
 			$result = $worker->convert($data, $cfg);
 			$result = $cfg[ RB::KEY_KEY ] === null ? $result : [$cfg[ RB::KEY_KEY ] => $result];
-        }
+		}
 
 		if ($result === null && \is_array($data)) {
 			$cfg = $this->getPrimitiveMappingConfigOrThrow($data);
@@ -225,7 +225,7 @@ 
 							"Missing '{$key_name}' entry in '{$class_name}' class mapping config.");
 					}
 
-                    Validator::assertIsType(RB::KEY_KEY, $class_config[$key_name], $allowed_types);
+					Validator::assertIsType(RB::KEY_KEY, $class_config[$key_name], $allowed_types);
 				}
 			}
 		}

Spacing +10 added lines, -10 removed lines

@@ -60,7 +60,7 @@ 
 		$result = null;
 
 		$type = \gettype($data);
-		$result = $this->primitives[ $type ] ?? null;
+		$result = $this->primitives[$type] ?? null;
 
 		if ($result === null) {
 			throw new Ex\ConfigurationNotFoundException(
@@ -92,13 +92,13 @@ 
 		$cls = \get_class($data);
 		if ($cls !== false) {
 			if (\array_key_exists($cls, $this->classes)) {
-				$result = $this->classes[ $cls ];
+				$result = $this->classes[$cls];
 				$debug_result = 'exact config match';
 			} else {
 				// no exact match, then lets try with `instanceof`
 				foreach (\array_keys($this->classes) as $class_name) {
 					if ($data instanceof $class_name) {
-						$result = $this->classes[ $class_name ];
+						$result = $this->classes[$class_name];
 						$debug_result = "subclass of {$class_name}";
 						break;
 					}
@@ -144,9 +144,9 @@ 
 
 		if ($result === null && \is_object($data)) {
 			$cfg = $this->getClassMappingConfigOrThrow($data);
-			$worker = new $cfg[ RB::KEY_HANDLER ]();
+			$worker = new $cfg[RB::KEY_HANDLER]();
 			$result = $worker->convert($data, $cfg);
-			$result = $cfg[ RB::KEY_KEY ] === null ? $result : [$cfg[ RB::KEY_KEY ] => $result];
+			$result = $cfg[RB::KEY_KEY] === null ? $result : [$cfg[RB::KEY_KEY] => $result];
         }
 
 		if ($result === null && \is_array($data)) {
@@ -154,12 +154,12 @@ 
 
 			$result = $this->convertArray($data);
 			if (!Util::isArrayWithNonNumericKeys($data)) {
-				$result = [$cfg[ RB::KEY_KEY ] => $result];
+				$result = [$cfg[RB::KEY_KEY] => $result];
 			}
 		}
 
 		if (\is_bool($data) || \is_float($data) || \is_int($data) || \is_string($data)) {
-			$result = [$this->getPrimitiveMappingConfigOrThrow($data)[ RB::KEY_KEY ] => $data];
+			$result = [$this->getPrimitiveMappingConfigOrThrow($data)[RB::KEY_KEY] => $data];
 		}
 
 		return $result;
@@ -179,12 +179,12 @@ 
 
 		foreach ($data as $key => $val) {
 			if (\is_array($val)) {
-				$data[ $key ] = $this->convertArray($val);
+				$data[$key] = $this->convertArray($val);
 			} elseif (\is_object($val)) {
 				$cfg = $this->getClassMappingConfigOrThrow($val);
-				$worker = new $cfg[ RB::KEY_HANDLER ]();
+				$worker = new $cfg[RB::KEY_HANDLER]();
 				$converted_data = $worker->convert($val, $cfg);
-				$data[ $key ] = $converted_data;
+				$data[$key] = $converted_data;
 			}
 		}
 

config/response_builder.php

Indentation +116 added lines, -116 removed lines

@@ -12,117 +12,117 @@ 
  */
 
 return [
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Code range settings
     |-----------------------------------------------------------------------------------------------------------
     */
-    'min_code'          => 100,
-    'max_code'          => 1024,
+	'min_code'          => 100,
+	'max_code'          => 1024,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Error code to message mapping
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'map'               => [
-        // YOUR_API_CODE => '<MESSAGE_KEY>',
-    ],
+	'map'               => [
+		// YOUR_API_CODE => '<MESSAGE_KEY>',
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Response Builder data converter
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'converter'         => [
-	    'primitives' => [
-		    /* Configuration for primitives used when such data is passed directly as payload (i.e. `success(15)`;) */
-		    'array'   => [
-			    'key' => 'values',
-		    ],
-		    'boolean' => [
-			    'key' => 'value',
-		    ],
-		    'double'  => [
-			    'key' => 'value',
-		    ],
-		    'integer' => [
-			    'key' => 'value',
-		    ],
-		    'string'  => [
-			    'key' => 'value',
-		    ],
-	    ],
-
-	    /* Object converters configuration for supported classes */
-    	'classes' => [
-	        \Illuminate\Database\Eloquent\Model::class          => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'item',
-	            'pri'     => 0,
-	        ],
-	        \Illuminate\Support\Collection::class               => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'items',
-	            'pri'     => 0,
-	        ],
-	        \Illuminate\Database\Eloquent\Collection::class     => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'items',
-	            'pri'     => 0,
-	        ],
-	        \Illuminate\Http\Resources\Json\JsonResource::class => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
-	            'key'     => 'item',
-	            'pri'     => 0,
-	        ],
-
-	        /*
+	'converter'         => [
+		'primitives' => [
+			/* Configuration for primitives used when such data is passed directly as payload (i.e. `success(15)`;) */
+			'array'   => [
+				'key' => 'values',
+			],
+			'boolean' => [
+				'key' => 'value',
+			],
+			'double'  => [
+				'key' => 'value',
+			],
+			'integer' => [
+				'key' => 'value',
+			],
+			'string'  => [
+				'key' => 'value',
+			],
+		],
+
+		/* Object converters configuration for supported classes */
+		'classes' => [
+			\Illuminate\Database\Eloquent\Model::class          => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'item',
+				'pri'     => 0,
+			],
+			\Illuminate\Support\Collection::class               => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'items',
+				'pri'     => 0,
+			],
+			\Illuminate\Database\Eloquent\Collection::class     => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'items',
+				'pri'     => 0,
+			],
+			\Illuminate\Http\Resources\Json\JsonResource::class => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ToArrayConverter::class,
+				'key'     => 'item',
+				'pri'     => 0,
+			],
+
+			/*
 			|-----------------------------------------------------------------------------------------------------------
 			| Paginators converts to objects already, so we do not array wrapping here, hence setting `key` to null
 			|-----------------------------------------------------------------------------------------------------------
 			*/
 
-	        \Illuminate\Pagination\LengthAwarePaginator::class => [
-		        'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
-		        'key'     => null,
-		        'pri'     => 0,
-	        ],
-	        \Illuminate\Pagination\Paginator::class => [
-		        'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
-		        'key'     => null,
-		        'pri'     => 0,
-	        ],
-
-	        /*
+			\Illuminate\Pagination\LengthAwarePaginator::class => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+				'key'     => null,
+				'pri'     => 0,
+			],
+			\Illuminate\Pagination\Paginator::class => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+				'key'     => null,
+				'pri'     => 0,
+			],
+
+			/*
 	        |-----------------------------------------------------------------------------------------------------------
 	        | Generic converters should have lower pri to allow dedicated ones to kick in first when class matches
 	        |-----------------------------------------------------------------------------------------------------------
 	        */
-	        \JsonSerializable::class                            => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class,
-	             'key'     => 'item',
-	            'pri'     => -10,
-	        ],
-	        \Illuminate\Contracts\Support\Arrayable::class      => [
-	            'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
-	            'key'     => 'items',
-	            'pri'     => -10,
-	        ],
-        ],
-
-    ],
-
-    /*
+			\JsonSerializable::class                            => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\JsonSerializableConverter::class,
+				 'key'     => 'item',
+				'pri'     => -10,
+			],
+			\Illuminate\Contracts\Support\Arrayable::class      => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\Converters\ArrayableConverter::class,
+				'key'     => 'items',
+				'pri'     => -10,
+			],
+		],
+
+	],
+
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Exception handler error codes
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'exception_handler' => [
-	    /*
+	'exception_handler' => [
+		/*
 	     * The following keys are supported for each handler specified.
 	     *   `handler`
 	     *   `pri`
@@ -142,19 +142,19 @@ 
 		 *                  message ($ex->getMessage()).
 		 */
 
-    	\Illuminate\Validation\ValidationException::class => [
-		    'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class,
-		    'pri'     => -100,
-		    'config' => [
+		\Illuminate\Validation\ValidationException::class => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\ValidationExceptionHandler::class,
+			'pri'     => -100,
+			'config' => [
 //		        'api_code'  => ApiCodes::YOUR_API_CODE_FOR_VALIDATION_EXCEPTION,
 //		        'http_code' => HttpResponse::HTTP_UNPROCESSABLE_ENTITY,
-		    	],
-	    ],
+				],
+		],
 
 		\Symfony\Component\HttpKernel\Exception\HttpException::class => [
-	        'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
-	        'pri'     => -100,
-	        'config'  => [
+			'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
+			'pri'     => -100,
+			'config'  => [
 //		        HttpException::class => [
 //			        // used by unauthenticated() to obtain api and http code for the exception
 //			        HttpResponse::HTTP_UNAUTHORIZED         => [
@@ -170,47 +170,47 @@ 
 //				        'http_code' => HttpResponse::HTTP_BAD_REQUEST,
 //			        ],
 //		        ],
-	        ],
+			],
 //	        // This is final exception handler. If ex is not dealt with yet this is its last stop.
-	        // default handler is mandatory and MUST have both `api_code` and `http_code` set.
+			// default handler is mandatory and MUST have both `api_code` and `http_code` set.
 
-	        'default' => [
-		        'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
-		        'pri'     => -127,
-		        'config'  => [
+			'default' => [
+				'handler' => \MarcinOrlowski\ResponseBuilder\ExceptionHandlers\HttpExceptionHandler::class,
+				'pri'     => -127,
+				'config'  => [
 //			        'api_code'  => ApiCodes::YOUR_API_CODE_FOR_UNHANDLED_EXCEPTION,
 //			        'http_code' => HttpResponse::HTTP_INTERNAL_SERVER_ERROR,
-		        ],
-	        ],
-	    ],
-    ],
+				],
+			],
+		],
+	],
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | data-to-json encoding options
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'encoding_options'  => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE,
+	'encoding_options'  => JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_UNICODE,
 
-    /*
+	/*
     |-----------------------------------------------------------------------------------------------------------
     | Debug config
     |-----------------------------------------------------------------------------------------------------------
     |
     */
-    'debug'             => [
-        'debug_key'         => 'debug',
-        'exception_handler' => [
-            'trace_key'     => 'trace',
-            'trace_enabled' => env('APP_DEBUG', false),
-        ],
-
-        // Controls debugging features of payload converter class.
-        'converter' => [
-        	// Set to true to figure out what converter is used for given data payload and why.
-        	'debug_enabled' => env('RB_CONVERTER_DEBUG', false),
-        ],
-    ],
+	'debug'             => [
+		'debug_key'         => 'debug',
+		'exception_handler' => [
+			'trace_key'     => 'trace',
+			'trace_enabled' => env('APP_DEBUG', false),
+		],
+
+		// Controls debugging features of payload converter class.
+		'converter' => [
+			// Set to true to figure out what converter is used for given data payload and why.
+			'debug_enabled' => env('RB_CONVERTER_DEBUG', false),
+		],
+	],
 
 ];