Maelstromeous / ps2alerts-api

src/Controller/Endpoint/AbstractEndpointController.php

Doc Comments +10 added lines, -10 removed lines

@@ -104,10 +104,10 @@ 
      * Builds an item response in Fractal then hands off to the responder
      *
      * @param  array $item                                The item to transform
-     * @param  mixed $callback                            The Transformer to pass through to Fractal
+     * @param  \League\Fractal\TransformerAbstract $callback                            The Transformer to pass through to Fractal
      * @param  \Symfony\Component\HttpFoundation\Response The client's response
      *
-     * @return array                                     The formatted array
+     * @return Response                                     The formatted array
      */
     protected function respondWithItem($item, $callback, Response $response)
     {
@@ -121,10 +121,10 @@ 
      * Builds a collection of items from Fractal then hands off to the responder
      *
      * @param  array $collection                         The collection to transform
-     * @param  mixed $callback                           The Transformer to pass through to Fractal
+     * @param  \League\Fractal\TransformerAbstract $callback                           The Transformer to pass through to Fractal
      * @param  \Symfony\Component\HttpFoundation\Response The client's response
      *
-     * @return array                                     The formatted array
+     * @return Response                                     The formatted array
      */
     protected function respondWithCollection($collection, $callback, Response $response)
     {
@@ -159,7 +159,7 @@ 
      * @param  string                                      $message   Response message to put in the error
      * @param  int                                         $errorCode Error code to set
      *
-     * @return array
+     * @return Response
      */
     protected function respondWithError(Response $response, $message, $errorCode)
     {
@@ -186,7 +186,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorEmpty(Response $response, $message = 'No data / Empty')
     {
@@ -200,7 +200,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorForbidden(Response $response, $message = 'Forbidden')
     {
@@ -214,7 +214,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorInternalError(Response $response, $message = 'Internal Error')
     {
@@ -228,7 +228,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorNotFound(Response $response, $message = 'Resource Not Found')
     {
@@ -242,7 +242,7 @@ 
      * @param  \Symfony\Component\HttpFoundation\Response $response
      * @param  string                                     $message
      *
-     * @return void
+     * @return Response
      */
     public function errorUnauthorized(Response $response, $message = 'Unauthorized')
     {

src/Repository/AbstractEndpointRepository.php

Doc Comments +6 added lines

@@ -57,6 +57,9 @@ 
         return $query;
     }
 
+    /**
+     * @param AbstractQuery $query
+     */
     public function fireStatementAndReturn($query, $single = false)
     {
         $pdo = $this->getDatabaseDriver();
@@ -104,6 +107,9 @@ 
         return $this->fireStatementAndReturn($query);
     }
 
+    /**
+     * @param string $key
+     */
     public function returnKeyType($key)
     {
         switch ($key) {

Indentation +2 added lines, -2 removed lines

@@ -81,7 +81,7 @@ 
         $key = $this->returnKeyType($keyType);
 
         $query->cols(['*'])
-              ->where("{$key} = {$id}");
+                ->where("{$key} = {$id}");
 
         return $this->fireStatementAndReturn($query, true);
     }
@@ -99,7 +99,7 @@ 
         $key = $this->returnKeyType($keyType);
 
         $query->cols(['*'])
-              ->where("{$key} = {$id}");
+                ->where("{$key} = {$id}");
 
         return $this->fireStatementAndReturn($query);
     }

src/Transformer/AlertTransformer.php

Doc Comments +11 added lines, -11 removed lines

@@ -132,7 +132,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeClasses($data)
     {
@@ -145,7 +145,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeCombatHistorys($data)
     {
@@ -158,7 +158,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Item
      */
     public function includeFactions($data)
     {
@@ -171,7 +171,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeMapInitials($data)
     {
@@ -184,7 +184,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeMaps($data)
     {
@@ -197,7 +197,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeOutfits($data)
     {
@@ -210,7 +210,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includePopulations($data)
     {
@@ -223,7 +223,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includePlayers($data)
     {
@@ -236,7 +236,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeVehicles($data)
     {
@@ -249,7 +249,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeWeapons($data)
     {
@@ -262,7 +262,7 @@ 
      *
      * @param  array $data
      *
-     * @return League\Fractal\Resource\Collection
+     * @return \League\Fractal\Resource\Collection
      */
     public function includeXps($data)
     {

src/container.php

Indentation +7 added lines, -7 removed lines

@@ -17,21 +17,21 @@
 
 // Inflectors
 $container->inflector('Ps2alerts\Api\Contract\ConfigAwareInterface')
-          ->invokeMethod('setConfig', ['config']);
+            ->invokeMethod('setConfig', ['config']);
 $container->inflector('Ps2alerts\Api\Contract\DatabaseAwareInterface')
-          ->invokeMethod('setDatabaseDriver', ['Aura\Sql']);
+            ->invokeMethod('setDatabaseDriver', ['Aura\Sql']);
 $container->inflector('Ps2alerts\Api\Contract\LogAwareInterface')
-          ->invokeMethod('setLogDriver', ['Monolog\Logger']);
+            ->invokeMethod('setLogDriver', ['Monolog\Logger']);
 $container->inflector('Ps2alerts\Api\Contract\TemplateAwareInterface')
-          ->invokeMethod('setTemplateDriver', ['Twig_Environment']);
+            ->invokeMethod('setTemplateDriver', ['Twig_Environment']);
 $container->inflector('Ps2alerts\Api\Contract\RedisAwareInterface')
-          ->invokeMethod('setRedisDriver', ['redis']);
+            ->invokeMethod('setRedisDriver', ['redis']);
 $container->inflector('Ps2alerts\Api\Contract\UuidAwareInterface')
-          ->invokeMethod('setUuidDriver', ['Ramsey\Uuid\Uuid']);
+            ->invokeMethod('setUuidDriver', ['Ramsey\Uuid\Uuid']);
 
 
 // Container Inflector
 $container->inflector('League\Container\ContainerAwareInterface')
-          ->invokeMethod('setContainer', [$container]);
+            ->invokeMethod('setContainer', [$container]);
 
 return $container;

src/Controller/Endpoint/AlertEndpointController.php

Doc Comments +3 added lines, -3 removed lines

@@ -26,11 +26,11 @@
      *
      * @see AbstractEndpointController::respondWithItem
      *
-     * @param  Symfony\Component\HttpFoundation\Request  $request
-     * @param  Symfony\Component\HttpFoundation\Response $response
+     * @param  Request  $request
+     * @param  Response $response
      * @param  array
      *
-     * @return array
+     * @return Response
      */
     public function getSingle(Request $request, Response $response, array $args)
     {