flugger / laravel-responder

src/Http/ErrorResponseBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
     /**
      * Constructor.
      *
-     * @param \Illuminate\Contracts\Routing\ResponseFactory|\Laravel\Lumen\Http\ResponseFactory $responseFactory
+     * @param \Illuminate\Contracts\Routing\ResponseFactory $responseFactory
      * @param \Symfony\Component\Translation\TranslatorInterface                                $translator
      */
     public function __construct($responseFactory, TranslatorInterface $translator)

Spacing +16 added lines, -16 removed lines

@@ -20,7 +20,7 @@ 
      *
      * @var array
      */
-    protected $data = [];
+    protected $data = [ ];
 
     /**
      * The error code used to identify the error.
@@ -41,7 +41,7 @@ 
      *
      * @var array
      */
-    protected $parameters = [];
+    protected $parameters = [ ];
 
     /**
      * The HTTP status code for the response.
@@ -63,11 +63,11 @@ 
      * @param \Illuminate\Contracts\Routing\ResponseFactory|\Laravel\Lumen\Http\ResponseFactory $responseFactory
      * @param \Symfony\Component\Translation\TranslatorInterface                                $translator
      */
-    public function __construct($responseFactory, TranslatorInterface $translator)
+    public function __construct( $responseFactory, TranslatorInterface $translator )
     {
         $this->translator = $translator;
 
-        parent::__construct($responseFactory);
+        parent::__construct( $responseFactory );
     }
 
     /**
@@ -76,9 +76,9 @@ 
      * @param  array $data
      * @return self
      */
-    public function addData(array $data):ErrorResponseBuilder
+    public function addData( array $data ):ErrorResponseBuilder
     {
-        $this->data = array_merge($this->data, $data);
+        $this->data = array_merge( $this->data, $data );
 
         return $this;
     }
@@ -90,11 +90,11 @@ 
      * @param  string|array|null $message
      * @return self
      */
-    public function setError(string $errorCode = null, $message = null):ErrorResponseBuilder
+    public function setError( string $errorCode = null, $message = null ):ErrorResponseBuilder
     {
         $this->errorCode = $errorCode;
 
-        if (is_array($message)) {
+        if ( is_array( $message ) ) {
             $this->parameters = $message;
         } else {
             $this->message = $message;
@@ -110,13 +110,13 @@ 
      * @return self
      * @throws \InvalidArgumentException
      */
-    public function setStatus(int $statusCode):ResponseBuilder
+    public function setStatus( int $statusCode ):ResponseBuilder
     {
-        if ($statusCode < 400 || $statusCode >= 600) {
-            throw new InvalidArgumentException("{$statusCode} is not a valid error HTTP status code.");
+        if ( $statusCode < 400 || $statusCode >= 600 ) {
+            throw new InvalidArgumentException( "{$statusCode} is not a valid error HTTP status code." );
         }
 
-        return parent::setStatus($statusCode);
+        return parent::setStatus( $statusCode );
     }
 
     /**
@@ -139,7 +139,7 @@ 
      */
     protected function buildErrorData()
     {
-        if (is_null($this->errorCode)) {
+        if ( is_null( $this->errorCode ) ) {
             return null;
         }
 
@@ -148,7 +148,7 @@ 
             'message' => $this->message ?: $this->resolveMessage()
         ];
 
-        return array_merge($data, $this->data);
+        return array_merge( $data, $this->data );
     }
 
     /**
@@ -158,10 +158,10 @@ 
      */
     protected function resolveMessage()
     {
-        if (! $this->translator->has($code = "errors.$this->errorCode")) {
+        if ( ! $this->translator->has( $code = "errors.$this->errorCode" ) ) {
             return null;
         }
 
-        return $this->translator->trans($code, $this->parameters);
+        return $this->translator->trans( $code, $this->parameters );
     }
 }
\ No newline at end of file

src/Http/SuccessResponseBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
     /**
      * SuccessResponseBuilder constructor.
      *
-     * @param \Illuminate\Contracts\Routing\ResponseFactory|\Laravel\Lumen\Http\ResponseFactory $responseFactory
+     * @param \Illuminate\Contracts\Routing\ResponseFactory $responseFactory
      * @param \Flugg\Responder\ResourceFactory                                                  $resourceFactory
      * @param \League\Fractal\Manager                                                           $manager
      */

Spacing +66 added lines, -66 removed lines

@@ -37,14 +37,14 @@ 
      *
      * @var array
      */
-    protected $meta = [];
+    protected $meta = [ ];
 
     /**
      * The included relations.
      *
      * @var array
      */
-    protected $relations = [];
+    protected $relations = [ ];
 
     /**
      * The Fractal resource instance containing the data and transformer.
@@ -74,13 +74,13 @@ 
      * @param \Flugg\Responder\ResourceFactory                                                  $resourceFactory
      * @param \League\Fractal\Manager                                                           $manager
      */
-    public function __construct($responseFactory, ResourceFactory $resourceFactory, Manager $manager)
+    public function __construct( $responseFactory, ResourceFactory $resourceFactory, Manager $manager )
     {
         $this->resourceFactory = $resourceFactory;
         $this->manager = $manager;
         $this->resource = $this->resourceFactory->make();
 
-        parent::__construct($responseFactory);
+        parent::__construct( $responseFactory );
     }
 
     /**
@@ -89,9 +89,9 @@ 
      * @param  array $data
      * @return self
      */
-    public function addMeta(array $data):SuccessResponseBuilder
+    public function addMeta( array $data ):SuccessResponseBuilder
     {
-        $this->meta = array_merge($this->meta, $data);
+        $this->meta = array_merge( $this->meta, $data );
 
         return $this;
     }
@@ -104,7 +104,7 @@ 
      */
     public function include($relations):SuccessResponseBuilder
     {
-        $this->relations = array_merge($this->relations, $relations);
+        $this->relations = array_merge( $this->relations, $relations );
 
         return $this;
     }
@@ -115,9 +115,9 @@ 
      * @param  \League\Fractal\Serializer\SerializerAbstract|string $serializer
      * @return self
      */
-    public function serializer($serializer):SuccessResponseBuilder
+    public function serializer( $serializer ):SuccessResponseBuilder
     {
-        $this->manager->setSerializer($this->resolveSerializer($serializer));
+        $this->manager->setSerializer( $this->resolveSerializer( $serializer ) );
 
         return $this;
     }
@@ -129,13 +129,13 @@ 
      * @return self
      * @throws \InvalidArgumentException
      */
-    public function setStatus(int $statusCode):ResponseBuilder
+    public function setStatus( int $statusCode ):ResponseBuilder
     {
-        if ($statusCode < 100 || $statusCode >= 400) {
-            throw new InvalidArgumentException("{$statusCode} is not a valid success HTTP status code.");
+        if ( $statusCode < 100 || $statusCode >= 400 ) {
+            throw new InvalidArgumentException( "{$statusCode} is not a valid success HTTP status code." );
         }
 
-        return parent::setStatus($statusCode);
+        return parent::setStatus( $statusCode );
     }
 
     /**
@@ -147,25 +147,25 @@ 
      * @param  string|null          $resourceKey
      * @return self
      */
-    public function transform($data = null, $transformer = null, string $resourceKey = null):SuccessResponseBuilder
+    public function transform( $data = null, $transformer = null, string $resourceKey = null ):SuccessResponseBuilder
     {
-        $resource = $this->resourceFactory->make($data);
+        $resource = $this->resourceFactory->make( $data );
 
-        if (! is_null($resource->getData())) {
-            $model = $this->resolveModel($resource->getData());
-            $transformer = $this->resolveTransformer($model, $transformer);
-            $resourceKey = $this->resolveResourceKey($model, $resourceKey);
+        if ( ! is_null( $resource->getData() ) ) {
+            $model = $this->resolveModel( $resource->getData() );
+            $transformer = $this->resolveTransformer( $model, $transformer );
+            $resourceKey = $this->resolveResourceKey( $model, $resourceKey );
         }
 
-        if ($transformer instanceof Transformer) {
-            $this->include($relations = $this->resolveNestedRelations($resource->getData()));
+        if ( $transformer instanceof Transformer ) {
+            $this->include( $relations = $this->resolveNestedRelations( $resource->getData() ) );
 
-            if ($transformer->allRelationsAllowed()) {
-                $transformer->setRelations($relations);
+            if ( $transformer->allRelationsAllowed() ) {
+                $transformer->setRelations( $relations );
             }
         }
 
-        $this->resource = $resource->setTransformer($transformer)->setResourceKey($resourceKey);
+        $this->resource = $resource->setTransformer( $transformer )->setResourceKey( $resourceKey );
 
         return $this;
     }
@@ -177,7 +177,7 @@ 
      */
     public function toArray():array
     {
-        return $this->serialize($this->getResource());
+        return $this->serialize( $this->getResource() );
     }
 
     /**
@@ -187,14 +187,14 @@ 
      */
     public function getResource():ResourceInterface
     {
-        $this->manager->parseIncludes($this->relations);
+        $this->manager->parseIncludes( $this->relations );
         $transformer = $this->resource->getTransformer();
 
-        if ($transformer instanceof Transformer && $transformer->allRelationsAllowed()) {
-            $this->resource->setTransformer($transformer->setRelations($this->manager->getRequestedIncludes()));
+        if ( $transformer instanceof Transformer && $transformer->allRelationsAllowed() ) {
+            $this->resource->setTransformer( $transformer->setRelations( $this->manager->getRequestedIncludes() ) );
         }
 
-        return $this->resource->setMeta($this->meta);
+        return $this->resource->setMeta( $this->meta );
     }
 
     /**
@@ -214,13 +214,13 @@ 
      * @return \League\Fractal\Serializer\SerializerAbstract
      * @throws \Flugg\Responder\Exceptions\InvalidSerializerException
      */
-    protected function resolveSerializer($serializer):SerializerAbstract
+    protected function resolveSerializer( $serializer ):SerializerAbstract
     {
-        if (is_string($serializer)) {
+        if ( is_string( $serializer ) ) {
             $serializer = new $serializer;
         }
 
-        if (! $serializer instanceof SerializerAbstract) {
+        if ( ! $serializer instanceof SerializerAbstract ) {
             throw new InvalidSerializerException();
         }
 
@@ -234,15 +234,15 @@ 
      * @return \Illuminate\Database\Eloquent\Model
      * @throws \InvalidArgumentException
      */
-    protected function resolveModel($data):Model
+    protected function resolveModel( $data ):Model
     {
-        if ($data instanceof Model) {
+        if ( $data instanceof Model ) {
             return $data;
         }
 
-        $model = array_values($data)[0];
-        if (! $model instanceof Model) {
-            throw new InvalidArgumentException('You can only transform data containing Eloquent models.');
+        $model = array_values( $data )[ 0 ];
+        if ( ! $model instanceof Model ) {
+            throw new InvalidArgumentException( 'You can only transform data containing Eloquent models.' );
         }
 
         return $model;
@@ -255,15 +255,15 @@ 
      * @param  \Flugg\Responder\Transformer|callable|null $transformer
      * @return \Flugg\Responder\Transformer|callable
      */
-    protected function resolveTransformer(Model $model, $transformer = null)
+    protected function resolveTransformer( Model $model, $transformer = null )
     {
-        $transformer = $transformer ?: $this->resolveTransformerFromModel($model);
+        $transformer = $transformer ?: $this->resolveTransformerFromModel( $model );
 
-        if (is_string($transformer)) {
+        if ( is_string( $transformer ) ) {
             $transformer = new $transformer;
         }
 
-        return $this->parseTransformer($transformer, $model);
+        return $this->parseTransformer( $transformer, $model );
     }
 
     /**
@@ -273,10 +273,10 @@ 
      * @param  \Illuminate\Database\ELoquent\Model $model
      * @return \Flugg\Responder\Transformer|callable
      */
-    protected function resolveTransformerFromModel(Model $model)
+    protected function resolveTransformerFromModel( Model $model )
     {
-        if (! $model instanceof Transformable) {
-            return function ($model) {
+        if ( ! $model instanceof Transformable ) {
+            return function ( $model ) {
                 return $model->toArray();
             };
         }
@@ -292,14 +292,14 @@ 
      * @return \Flugg\Responder\Transformer|callable
      * @throws \InvalidTransformerException
      */
-    protected function parseTransformer($transformer, Model $model)
+    protected function parseTransformer( $transformer, Model $model )
     {
-        if ($transformer instanceof Transformer) {
-            $relations = $transformer->allRelationsAllowed() ? $this->resolveRelations($model) : $transformer->getRelations();
-            $transformer = $transformer->setRelations($relations);
+        if ( $transformer instanceof Transformer ) {
+            $relations = $transformer->allRelationsAllowed() ? $this->resolveRelations( $model ) : $transformer->getRelations();
+            $transformer = $transformer->setRelations( $relations );
 
-        } elseif (! is_callable($transformer)) {
-            throw new InvalidTransformerException($model);
+        } elseif ( ! is_callable( $transformer ) ) {
+            throw new InvalidTransformerException( $model );
         }
 
         return $transformer;
@@ -311,9 +311,9 @@ 
      * @param  \Illuminate\Database\Eloquent\Model $model
      * @return array
      */
-    protected function resolveRelations(Model $model):array
+    protected function resolveRelations( Model $model ):array
     {
-        return array_keys($model->getRelations());
+        return array_keys( $model->getRelations() );
     }
 
     /**
@@ -322,22 +322,22 @@ 
      * @param  \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model $data
      * @return array
      */
-    protected function resolveNestedRelations($data):array
+    protected function resolveNestedRelations( $data ):array
     {
-        if (is_null($data)) {
-            return [];
+        if ( is_null( $data ) ) {
+            return [ ];
         }
 
-        $data = $data instanceof Model ? [$data] : $data;
+        $data = $data instanceof Model ? [ $data ] : $data;
 
-        return collect($data)->flatMap(function ($model) {
-            $relations = collect($model->getRelations());
+        return collect( $data )->flatMap( function ( $model ) {
+            $relations = collect( $model->getRelations() );
 
-            return $relations->keys()->merge($relations->flatMap(function ($relation, $key) {
-                return collect($this->resolveNestedRelations($relation))->map(function ($nestedRelation) use ($key) {
+            return $relations->keys()->merge( $relations->flatMap( function ( $relation, $key ) {
+                return collect( $this->resolveNestedRelations( $relation ) )->map( function ( $nestedRelation ) use ($key) {
                     return $key . '.' . $nestedRelation;
                 });
-            }));
+            }) );
         })->toArray();
     }
 
@@ -348,13 +348,13 @@ 
      * @param  string|null                         $resourceKey
      * @return string
      */
-    protected function resolveResourceKey(Model $model, string $resourceKey = null):string
+    protected function resolveResourceKey( Model $model, string $resourceKey = null ):string
     {
-        if (! is_null($resourceKey)) {
+        if ( ! is_null( $resourceKey ) ) {
             return $resourceKey;
         }
 
-        if (method_exists($model, 'getResourceKey')) {
+        if ( method_exists( $model, 'getResourceKey' ) ) {
             return $model->getResourceKey();
         }
 
@@ -367,8 +367,8 @@ 
      * @param  ResourceInterface $resource
      * @return array
      */
-    protected function serialize(ResourceInterface $resource):array
+    protected function serialize( ResourceInterface $resource ):array
     {
-        return $this->manager->createData($resource)->toArray();
+        return $this->manager->createData( $resource )->toArray();
     }
 }
\ No newline at end of file

src/ResponderServiceProvider.php

Spacing +33 added lines, -33 removed lines

@@ -43,18 +43,18 @@ 
      */
     public function boot()
     {
-        if ($this->app instanceof Laravel && $this->app->runningInConsole()) {
+        if ( $this->app instanceof Laravel && $this->app->runningInConsole() ) {
             $this->bootLaravelApplication();
 
-        } elseif ($this->app instanceof Lumen) {
+        } elseif ( $this->app instanceof Lumen ) {
             $this->bootLumenApplication();
         }
 
-        $this->mergeConfigFrom(__DIR__ . '/../resources/config/responder.php', 'responder');
+        $this->mergeConfigFrom( __DIR__ . '/../resources/config/responder.php', 'responder' );
 
-        $this->commands([
+        $this->commands( [
             MakeTransformer::class
-        ]);
+        ] );
 
         include __DIR__ . '/helpers.php';
     }
@@ -69,8 +69,8 @@ 
         $this->registerFractal();
         $this->registerResponseBuilders();
 
-        $this->app->bind(Responder::class, function ($app) {
-            return new Responder($app[SuccessResponseBuilder::class], $app[ErrorResponseBuilder::class]);
+        $this->app->bind( Responder::class, function ( $app ) {
+            return new Responder( $app[ SuccessResponseBuilder::class ], $app[ ErrorResponseBuilder::class ] );
         });
 
         $this->registerAliases();
@@ -83,7 +83,7 @@ 
      */
     public function provides()
     {
-        return ['responder', 'responder.success', 'responder.error', 'responder.manager', 'responder.serializer'];
+        return [ 'responder', 'responder.success', 'responder.error', 'responder.manager', 'responder.serializer' ];
     }
 
     /**
@@ -94,17 +94,17 @@ 
      */
     protected function registerFractal()
     {
-        $this->app->bind(SerializerAbstract::class, function ($app) {
-            $serializer = $app->config->get('responder.serializer');
+        $this->app->bind( SerializerAbstract::class, function ( $app ) {
+            $serializer = $app->config->get( 'responder.serializer' );
 
             return new $serializer;
         });
 
-        $this->app->bind(Manager::class, function ($app) {
-            return (new Manager())->setSerializer($app[SerializerAbstract::class]);
+        $this->app->bind( Manager::class, function ( $app ) {
+            return (new Manager())->setSerializer( $app[ SerializerAbstract::class ] );
         });
 
-        $this->app->bind(ResourceFactory::class, function () {
+        $this->app->bind( ResourceFactory::class, function () {
             return new ResourceFactory();
         });
     }
@@ -116,20 +116,20 @@ 
      */
     protected function registerResponseBuilders()
     {
-        $this->app->bind(SuccessResponseBuilder::class, function ($app) {
-            $builder = new SuccessResponseBuilder(response(), $app[ResourceFactory::class], $app[Manager::class]);
+        $this->app->bind( SuccessResponseBuilder::class, function ( $app ) {
+            $builder = new SuccessResponseBuilder( response(), $app[ ResourceFactory::class ], $app[ Manager::class ] );
 
-            if ($parameter = $this->app->config->get('responder.includeFromParameter')) {
-                $builder->include($this->app[Request::class]->input($parameter, []));
+            if ( $parameter = $this->app->config->get( 'responder.includeFromParameter' ) ) {
+                $builder->include( $this->app[ Request::class ]->input( $parameter, [ ] ) );
             }
 
-            return $builder->setIncludeStatusCode($app->config->get('responder.include_status_code'));
+            return $builder->setIncludeStatusCode( $app->config->get( 'responder.include_status_code' ) );
         });
 
-        $this->app->bind(ErrorResponseBuilder::class, function ($app) {
-            $builder = new ErrorResponseBuilder(response(), $app['translator']);
+        $this->app->bind( ErrorResponseBuilder::class, function ( $app ) {
+            $builder = new ErrorResponseBuilder( response(), $app[ 'translator' ] );
 
-            return $builder->setIncludeStatusCode($app->config->get('responder.include_status_code'));
+            return $builder->setIncludeStatusCode( $app->config->get( 'responder.include_status_code' ) );
         });
     }
 
@@ -140,11 +140,11 @@ 
      */
     protected function registerAliases()
     {
-        $this->app->alias(Responder::class, 'responder');
-        $this->app->alias(SuccessResponseBuilder::class, 'responder.success');
-        $this->app->alias(ErrorResponseBuilder::class, 'responder.error');
-        $this->app->alias(Manager::class, 'responder.manager');
-        $this->app->alias(Manager::class, 'responder.serializer');
+        $this->app->alias( Responder::class, 'responder' );
+        $this->app->alias( SuccessResponseBuilder::class, 'responder.success' );
+        $this->app->alias( ErrorResponseBuilder::class, 'responder.error' );
+        $this->app->alias( Manager::class, 'responder.manager' );
+        $this->app->alias( Manager::class, 'responder.serializer' );
     }
 
     /**
@@ -154,13 +154,13 @@ 
      */
     protected function bootLaravelApplication()
     {
-        $this->publishes([
-            __DIR__ . '/../resources/config/responder.php' => config_path('responder.php')
-        ], 'config');
+        $this->publishes( [
+            __DIR__ . '/../resources/config/responder.php' => config_path( 'responder.php' )
+        ], 'config' );
 
-        $this->publishes([
-            __DIR__ . '/../resources/lang/en/errors.php' => resource_path('lang/en/errors.php')
-        ], 'lang');
+        $this->publishes( [
+            __DIR__ . '/../resources/lang/en/errors.php' => resource_path( 'lang/en/errors.php' )
+        ], 'lang' );
     }
 
     /**
@@ -170,6 +170,6 @@ 
      */
     protected function bootLumenApplication()
     {
-        $this->app->configure('responder');
+        $this->app->configure( 'responder' );
     }
 }
\ No newline at end of file

src/Http/ResponseBuilder.php

Spacing +14 added lines, -14 removed lines

@@ -44,7 +44,7 @@ 
      *
      * @param \Illuminate\Contracts\Routing\ResponseFactory|\Laravel\Lumen\Http\ResponseFactory $responseFactory
      */
-    public function __construct($responseFactory)
+    public function __construct( $responseFactory )
     {
         $this->responseFactory = $responseFactory;
     }
@@ -56,15 +56,15 @@ 
      * @param  array    $headers
      * @return \Illuminate\Http\JsonResponse
      */
-    public function respond(int $statusCode = null, array $headers = []):JsonResponse
+    public function respond( int $statusCode = null, array $headers = [ ] ):JsonResponse
     {
-        if (! is_null($statusCode)) {
-            $this->setStatus($statusCode);
+        if ( ! is_null( $statusCode ) ) {
+            $this->setStatus( $statusCode );
         }
 
-        $data = $this->includeStatusCode($this->toArray());
+        $data = $this->includeStatusCode( $this->toArray() );
 
-        return $this->responseFactory->json($data, $this->statusCode, $headers);
+        return $this->responseFactory->json( $data, $this->statusCode, $headers );
     }
 
     /**
@@ -73,7 +73,7 @@ 
      * @param  int $statusCode
      * @return self
      */
-    public function setStatus(int $statusCode):ResponseBuilder
+    public function setStatus( int $statusCode ):ResponseBuilder
     {
         $this->statusCode = $statusCode;
 
@@ -86,7 +86,7 @@ 
      * @param  bool $includeStatusCode
      * @return self
      */
-    public function setIncludeStatusCode(bool $includeStatusCode):ResponseBuilder
+    public function setIncludeStatusCode( bool $includeStatusCode ):ResponseBuilder
     {
         $this->includeStatusCode = $includeStatusCode;
 
@@ -100,7 +100,7 @@ 
      */
     public function toCollection():Collection
     {
-        return new Collection($this->toArray());
+        return new Collection( $this->toArray() );
     }
 
     /**
@@ -109,9 +109,9 @@ 
      * @param  int $options
      * @return string
      */
-    public function toJson($options = 0)
+    public function toJson( $options = 0 )
     {
-        return json_encode($this->jsonSerialize(), $options);
+        return json_encode( $this->jsonSerialize(), $options );
     }
 
     /**
@@ -137,12 +137,12 @@ 
      * @param  array $data
      * @return array
      */
-    protected function includeStatusCode(array $data):array
+    protected function includeStatusCode( array $data ):array
     {
-        if (! $this->includeStatusCode) {
+        if ( ! $this->includeStatusCode ) {
             return $data;
         }
 
-        return array_merge(['status' => $this->statusCode], $data);
+        return array_merge( [ 'status' => $this->statusCode ], $data );
     }
 }
\ No newline at end of file