Merge pull request #35 from GawainLynch/clean-up

PSR-2, PSR-5, Bolt & Symfony clean up and unused imports
xiaohutai · Dec 6, 2016 · d62f564 · d62f564
2 parents 18d313c + c856755
commit d62f564
Show file tree

Hide file tree

Showing 44 changed files with 198 additions and 148 deletions.
diff --git a/src/Action/ContentListAction.php b/src/Action/ContentListAction.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Bolt\Extension\Bolt\JsonApi\Action;
 
 use Bolt\Extension\Bolt\JsonApi\Converter\Parameter\ParameterCollection;
@@ -11,14 +10,16 @@
 
 /**
  * Class ContentListAction
+ *
  * @package Bolt\Extension\Bolt\JsonApi\Action
  */
 class ContentListAction extends FetchAction
 {
     /**
      * @param $contentType
-     * @param Request $request
+     * @param Request             $request
      * @param ParameterCollection $parameters
+     *
      * @return ApiResponse
      */
     public function handle($contentType, Request $request, ParameterCollection $parameters)
@@ -34,7 +35,7 @@ public function handle($contentType, Request $request, ParameterCollection $para
 
         $results = $set->get($contentType);
 
-        $this->throwErrorOnNoResults($results, "Bad request: There were no results based upon your criteria!");
+        $this->throwErrorOnNoResults($results, 'Bad request: There were no results based upon your criteria!');
 
         $this->fetchIncludes(
             $parameters->getParametersByType('includes'),
@@ -58,8 +59,8 @@ public function handle($contentType, Request $request, ParameterCollection $para
                 $request
             ),
             'meta' => [
-                "count" => count($items),
-                "total" => $set->getTotalResults()
+                'count' => count($items),
+                'total' => $set->getTotalResults(),
             ],
             'data' => $items,
         ];

diff --git a/src/Action/FetchAction.php b/src/Action/FetchAction.php
@@ -24,10 +24,11 @@ class FetchAction
 
     /**
      * FetchAction constructor.
-     * @param Query $query
-     * @param Parser $parser
+     *
+     * @param Query     $query
+     * @param Parser    $parser
      * @param DataLinks $dataLinks
-     * @param Config $config
+     * @param Config    $config
      */
     public function __construct(
         Query $query,

diff --git a/src/Action/MenuAction.php b/src/Action/MenuAction.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Bolt\Extension\Bolt\JsonApi\Action;
 
 use Bolt\Config;
@@ -10,6 +9,7 @@
 
 /**
  * Class MenuAction
+ *
  * @package Bolt\Extension\Bolt\JsonApi\Action
  */
 class MenuAction
@@ -22,7 +22,8 @@ class MenuAction
 
     /**
      * MenuAction constructor.
-     * @param Config $boltConfig
+     *
+     * @param Config                                     $boltConfig
      * @param \Bolt\Extension\Bolt\JsonApi\Config\Config $extensionConfig
      */
     public function __construct(Config $boltConfig, \Bolt\Extension\Bolt\JsonApi\Config\Config $extensionConfig)
@@ -33,6 +34,7 @@ public function __construct(Config $boltConfig, \Bolt\Extension\Bolt\JsonApi\Con
 
     /**
      * @param Request $request
+     *
      * @return ApiResponse
      */
     public function handle(Request $request)
@@ -41,7 +43,7 @@ public function handle(Request $request)
             $name = "/$name";
         }
 
-        $menu = $this->boltConfig->get('menu'.$name, false);
+        $menu = $this->boltConfig->get('menu' . $name, false);
 
         if (! $menu) {
             throw new ApiNotFoundException(
@@ -50,7 +52,7 @@ public function handle(Request $request)
         }
 
         return new ApiResponse([
-            'data' => $menu
+            'data' => $menu,
         ], $this->extensionConfig);
     }
 }
diff --git a/src/Action/SearchAction.php b/src/Action/SearchAction.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Bolt\Extension\Bolt\JsonApi\Action;
 
 use Bolt\Extension\Bolt\JsonApi\Converter\Parameter\ParameterCollection;
@@ -11,14 +10,16 @@
 
 /**
  * Class SearchAction
+ *
  * @package Bolt\Extension\Bolt\JsonApi\Action
  */
 class SearchAction extends FetchAction
 {
     /**
-     * @param null $contentType
-     * @param Request $request
+     * @param null                $contentType
+     * @param Request             $request
      * @param ParameterCollection $parameters
+     *
      * @return ApiResponse
      */
     public function handle($contentType = null, Request $request, ParameterCollection $parameters)
@@ -27,7 +28,7 @@ public function handle($contentType = null, Request $request, ParameterCollectio
 
         if (! $search) {
             throw new ApiInvalidRequestException(
-                "No query parameter q specified."
+                'No query parameter q specified.'
             );
         }
 
@@ -70,8 +71,8 @@ public function handle($contentType = null, Request $request, ParameterCollectio
                 $request
             ),
             'meta' => [
-                "count" => count($items),
-                "total" => $set->getTotalResults()
+                'count' => count($items),
+                'total' => $set->getTotalResults(),
             ],
             'data' => $items,
         ], $this->config);

diff --git a/src/Action/SingleAction.php b/src/Action/SingleAction.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace Bolt\Extension\Bolt\JsonApi\Action;
 
 use Bolt\Extension\Bolt\JsonApi\Converter\Parameter\ParameterCollection;
@@ -11,6 +10,7 @@
 
 /**
  * Class SingleAction
+ *
  * @package Bolt\Extension\Bolt\JsonApi\Action
  */
 class SingleAction extends FetchAction
@@ -19,8 +19,9 @@ class SingleAction extends FetchAction
      * @param $contentType
      * @param $slug
      * @param $relatedContentType
-     * @param Request $request
+     * @param Request             $request
      * @param ParameterCollection $parameters
+     *
      * @return array|ApiResponse
      */
     public function handle($contentType, $slug, $relatedContentType, Request $request, ParameterCollection $parameters)
@@ -62,13 +63,13 @@ public function handle($contentType, $slug, $relatedContentType, Request $reques
                 'links' => [
                     'self' => $this->config->getBasePath() .
                         "/$contentType/$slug/$relatedContentType" .
-                        $this->dataLinks->makeQueryParameters($request->query->all())
+                        $this->dataLinks->makeQueryParameters($request->query->all()),
                 ],
                 'meta' => [
-                    "count" => count($items),
-                    "total" => count($items)
+                    'count' => count($items),
+                    'total' => count($items),
                 ],
-                'data' => $items
+                'data' => $items,
             ], $this->config);
         } else {
             //$allFields = $this->APIHelper->getAllFieldNames($contentType);
@@ -81,7 +82,7 @@ public function handle($contentType, $slug, $relatedContentType, Request $reques
 
             $defaultQueryString = $this->dataLinks->makeQueryParameters($request->query->all());
             $links = [
-                'self' => $values['links']['self'] . $defaultQueryString
+                'self' => $values['links']['self'] . $defaultQueryString,
             ];
 
             // optional: This adds additional relationships links in the root
@@ -118,7 +119,7 @@ public function handle($contentType, $slug, $relatedContentType, Request $reques
 
             $response = [
                 'links' => $links,
-                'data' => $values,
+                'data'  => $values,
             ];
 
             if (!empty($included)) {

diff --git a/src/Config/Config.php b/src/Config/Config.php
@@ -7,11 +7,10 @@
 
 class Config
 {
-
     /**
      * @var string
      */
-    private $base = "/json";
+    private $base = '/json';
 
     /**
      * @var string
@@ -258,6 +257,7 @@ public function setJsonOptions($jsonOptions)
 
     /**
      * @param $contentType
+     *
      * @return array
      */
     public function getWhereClauses($contentType)
@@ -271,6 +271,7 @@ public function getWhereClauses($contentType)
 
     /**
      * @param $contentType
+     *
      * @return array
      */
     public function getListFields($contentType)
@@ -284,6 +285,7 @@ public function getListFields($contentType)
 
     /**
      * @param $contentType
+     *
      * @return array
      */
     public function getItemFields($contentType)
@@ -297,6 +299,7 @@ public function getItemFields($contentType)
 
     /**
      * @param $contentType
+     *
      * @return array
      */
     public function getAllowedFields($contentType)

diff --git a/src/Controllers/ContentController.php b/src/Controllers/ContentController.php
@@ -1,20 +1,14 @@
 <?php
 namespace Bolt\Extension\Bolt\JsonApi\Controllers;
 
-use Bolt\Content;
 use Bolt\Extension\Bolt\JsonApi\Config\Config;
-use Bolt\Extension\Bolt\JsonApi\Exception\ApiNotFoundException;
-use Bolt\Extension\Bolt\JsonApi\Response\ApiInvalidRequestResponse;
-use Bolt\Extension\Bolt\JsonApi\Response\ApiNotFoundResponse;
-use Bolt\Extension\Bolt\JsonApi\Response\ApiResponse;
 use Silex\Application;
 use Silex\ControllerCollection;
 use Silex\ControllerProviderInterface;
-use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Class ContentController
+ *
  * @package JSONAPI\Controllers
  */
 class ContentController implements ControllerProviderInterface
@@ -26,6 +20,7 @@ class ContentController implements ControllerProviderInterface
 
     /**
      * ContentController constructor.
+     *
      * @param Config $config
      */
     public function __construct(Config $config)
@@ -47,24 +42,24 @@ public function connect(Application $app)
          */
         $ctr = $app['controllers_factory'];
 
-        $ctr->get("/menu", [$app['jsonapi.action.menu'], "handle"])
+        $ctr->get('/menu', [$app['jsonapi.action.menu'], 'handle'])
             ->bind('jsonapi.menu');
 
-        $ctr->get("/search", [$app['jsonapi.action.search'], "handle"])
+        $ctr->get('/search', [$app['jsonapi.action.search'], 'handle'])
             ->bind('jsonapi.searchAll')
             ->convert('parameters', 'jsonapi.converter:grabParameters');
 
-        $ctr->get("/{contentType}/search", [$app['jsonapi.action.search'], "handle"])
+        $ctr->get('/{contentType}/search', [$app['jsonapi.action.search'], 'handle'])
             ->bind('jsonapi.searchContent')
             ->convert('parameters', 'jsonapi.converter:grabParameters');
 
-        $ctr->get("/{contentType}/{slug}/{relatedContentType}", [$app['jsonapi.action.single'], 'handle'])
+        $ctr->get('/{contentType}/{slug}/{relatedContentType}', [$app['jsonapi.action.single'], 'handle'])
             ->value('relatedContentType', null)
             ->assert('slug', '[a-zA-Z0-9_\-]+')
             ->bind('jsonapi.singleContent')
             ->convert('parameters', 'jsonapi.converter:grabParameters');
 
-        $ctr->get("/{contentType}", [$app['jsonapi.action.contentlist'], "handle"])
+        $ctr->get('/{contentType}', [$app['jsonapi.action.contentlist'], 'handle'])
             ->bind('jsonapi.listContent')
             ->convert('parameters', 'jsonapi.converter:grabParameters');
 

diff --git a/src/Converter/JSONAPIConverter.php b/src/Converter/JSONAPIConverter.php
@@ -1,24 +1,21 @@
 <?php
 
-
 namespace Bolt\Extension\Bolt\JsonApi\Converter;
 
 use Bolt\Extension\Bolt\JsonApi\Config\Config;
 use Bolt\Extension\Bolt\JsonApi\Converter\Parameter\ParameterFactory;
 use Bolt\Extension\Bolt\JsonApi\Converter\Parameter\ParameterInterface;
-use Bolt\Extension\Bolt\JsonApi\Response\ApiInvalidRequestResponse;
-use Bolt\Extension\Bolt\JsonApi\Response\ApiNotFoundResponse;
 use Bolt\Storage\Mapping\MetadataDriver;
 use Doctrine\Common\Collections\Collection;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Class JSONAPIConverter
+ *
  * @package Bolt\Extension\Bolt\JsonApi\Converter
  */
 class JSONAPIConverter
 {
-
     /** @var Config $config */
     protected $config;
 
@@ -27,7 +24,8 @@ class JSONAPIConverter
 
     /**
      * JSONAPIConverter constructor.
-     * @param Config $config
+     *
+     * @param Config         $config
      * @param MetadataDriver $metadata
      */
     public function __construct(Config $config, MetadataDriver $metadata)
@@ -38,8 +36,10 @@ public function __construct(Config $config, MetadataDriver $metadata)
 
     /**
      * Create an array of parameters to be handled by our ParameterFactory class
+     *
      * @param $converter
      * @param Request $request
+     *
      * @return Collection|ParameterInterface[]
      */
     public function grabParameters($converter, Request $request)
@@ -72,6 +72,7 @@ public function grabParameters($converter, Request $request)
 
     /**
      * @param $parameters
+     *
      * @return mixed
      */
     protected function isSearch($parameters)