[Refactor] Reduce API class constructor arguments

Author: lindyhopchris

src/Api/Api.php

@@ -60,34 +60,24 @@ class Api
     private $name;
 
     /**
-     * @var EncodingList
-     */
-    private $encodings;
-
-    /**
-     * @var DecodingList
-     */
-    private $decodings;
-
-    /**
-     * @var bool
+     * @var Url
      */
-    private $useEloquent;
+    private $url;
 
     /**
-     * @var Url
+     * @var Config
      */
-    private $url;
+    private $config;
 
     /**
-     * @var Jobs
+     * @var EncodingList|null
      */
-    private $jobs;
+    private $encodings;
 
     /**
-     * @var string|null
+     * @var DecodingList|null
      */
-    private $supportedExt;
+    private $decodings;
 
     /**
      * @var ContainerInterface|null
@@ -104,71 +94,27 @@ class Api
      */
     private $responses;
 
-    /**
-     * @var array
-     */
-    private $providers;
-
-    /**
-     * @var string|null
-     */
-    private $connection;
-
-    /**
-     * @var bool
-     */
-    private $transactions;
-
-    /**
-     * @var string|null
-     */
-    private $modelNamespace;
-
     /**
      * Api constructor.
      *
      * @param Factory $factory
      * @param AggregateResolver $resolver
-     * @param $apiName
-     * @param EncodingList $encodings
-     * @param DecodingList $decodings
+     * @param string $name
      * @param Url $url
-     * @param Jobs $jobs
-     * @param bool $useEloquent
-     * @param string|null $supportedExt
-     * @param array $providers
-     * @param string|null $connection
-     * @param bool $transactions
-     * @param string|null $modelNamespace
+     * @param Config $config
      */
     public function __construct(
         Factory $factory,
         AggregateResolver $resolver,
-        $apiName,
-        EncodingList $encodings,
-        DecodingList $decodings,
+        string $name,
         Url $url,
-        Jobs $jobs,
-        $useEloquent = true,
-        $supportedExt = null,
-        array $providers = [],
-        string $connection = null,
-        bool $transactions = true,
-        string $modelNamespace = null
+        Config $config
     ) {
         $this->factory = $factory;
         $this->resolver = $resolver;
-        $this->name = $apiName;
-        $this->encodings = $encodings;
-        $this->decodings = $decodings;
+        $this->name = $name;
         $this->url = $url;
-        $this->jobs = $jobs;
-        $this->useEloquent = $useEloquent;
-        $this->supportedExt = $supportedExt;
-        $this->providers = $providers;
-        $this->connection = $connection;
-        $this->transactions = $transactions;
-        $this->modelNamespace = $modelNamespace;
+        $this->config = $config;
     }
 
     /**
@@ -223,7 +169,7 @@ public function getName()
      */
     public function isEloquent()
     {
-        return $this->useEloquent;
+        return $this->config->useEloquent();
     }
 
     /**
@@ -239,7 +185,7 @@ public function getUrl()
      */
     public function getJobs()
     {
-        return $this->jobs;
+        return Jobs::fromArray($this->config->jobs());
     }
 
     /**
@@ -271,27 +217,38 @@ public function getStore()
      */
     public function getSupportedExtensions()
     {
-        if (!$this->supportedExt) {
-            return null;
+        if ($ext = $this->config->supportedExt()) {
+            return $this->factory->createSupportedExtensions($ext);
         }
 
-        return $this->factory->createSupportedExtensions($this->supportedExt);
+        return null;
     }
 
     /**
      * @return EncodingList
      */
     public function getEncodings(): EncodingList
     {
-        return $this->encodings;
+        if ($this->encodings) {
+            return $this->encodings;
+        }
+
+        return $this->encodings = EncodingList::fromArray(
+            $this->config->encoding(),
+            $this->url->toString()
+        );
     }
 
     /**
      * @return DecodingList
      */
     public function getDecodings(): DecodingList
     {
-        return $this->decodings;
+        if ($this->decodings) {
+            return $this->decodings;
+        }
+
+        return $this->decodings = DecodingList::fromArray($this->config->decoding());
     }
 
     /**
@@ -303,8 +260,8 @@ public function getDefaultCodec(): Codec
     {
         return $this->factory->createCodec(
             $this->getContainer(),
-            $this->encodings->find(MediaTypeInterface::JSON_API_MEDIA_TYPE) ?: Encoding::jsonApi(),
-            $this->decodings->find(MediaTypeInterface::JSON_API_MEDIA_TYPE)
+            $this->getEncodings()->find(MediaTypeInterface::JSON_API_MEDIA_TYPE) ?: Encoding::jsonApi(),
+            $this->getDecodings()->find(MediaTypeInterface::JSON_API_MEDIA_TYPE)
         );
     }
 
@@ -329,7 +286,7 @@ public function getResponses()
      */
     public function getConnection(): ?string
     {
-        return $this->connection;
+        return $this->config->dbConnection();
     }
 
     /**
@@ -339,7 +296,7 @@ public function getConnection(): ?string
      */
     public function hasTransactions(): bool
     {
-        return $this->transactions;
+        return $this->config->dbTransactions();
     }
 
     /**
@@ -356,7 +313,7 @@ public function exceptions(): ExceptionParserInterface
      */
     public function getModelNamespace(): ?string
     {
-        return $this->modelNamespace;
+        return $this->config->modelNamespace();
     }
 
     /**
@@ -438,7 +395,7 @@ public function providers(): ResourceProviders
     {
         return new ResourceProviders(
             $this->factory,
-            $this->providers
+            $this->config->providers()
         );
     }
 

src/Api/Config.php

@@ -0,0 +1,134 @@
+<?php
+
+namespace CloudCreativity\LaravelJsonApi\Api;
+
+use Illuminate\Support\Arr;
+
+final class Config
+{
+
+    /**
+     * @var array
+     */
+    private $config;
+
+    /**
+     * Config constructor.
+     *
+     * @param array $config
+     */
+    public function __construct(array $config)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * Get all config.
+     *
+     * @return array
+     */
+    public function all(): array
+    {
+        return $this->config;
+    }
+
+    /**
+     * Get the database connection for controller transactions.
+     *
+     * @return string|null
+     * @deprecated
+     */
+    public function dbConnection(): ?string
+    {
+        return Arr::get($this->config, 'controllers.connection');
+    }
+
+    /**
+     * Should database transactions be used by controllers?
+     *
+     * @return bool
+     */
+    public function dbTransactions(): bool
+    {
+        return Arr::get($this->config, 'controllers.transactions', true);
+    }
+
+    /**
+     * Get the decoding media types configuration.
+     *
+     * @return array
+     */
+    public function decoding(): array
+    {
+        return $this->config['decoding'];
+    }
+
+    /**
+     * Get the encoding media types configuration.
+     *
+     * @return array
+     */
+    public function encoding(): array
+    {
+        return $this->config['encoding'] ?? [];
+    }
+
+    /**
+     * Get the asynchronous job configuration.
+     *
+     * @return array
+     */
+    public function jobs(): array
+    {
+        return $this->config['jobs'] ?? [];
+    }
+
+    /**
+     * Get the default namespace for the application's models.
+     *
+     * @return string|null
+     */
+    public function modelNamespace(): ?string
+    {
+        return $this->config['model-namespace'] ?? null;
+    }
+
+    /**
+     * Get resource providers.
+     *
+     * @return array
+     */
+    public function providers(): array
+    {
+        return $this->config['providers'] ?? [];
+    }
+
+    /**
+     * Get the supported extensions.
+     *
+     * @return string|null
+     * @deprecated
+     */
+    public function supportedExt(): ?string
+    {
+        return $this->config['supported-ext'] ?? null;
+    }
+
+    /**
+     * @return array
+     */
+    public function url(): array
+    {
+        return $this->config['url'] ?? [];
+    }
+
+    /**
+     * Are the application's models predominantly Eloquent models?
+     *
+     * @return bool
+     */
+    public function useEloquent(): bool
+    {
+        return $this->config['use-eloquent'] ?? true;
+    }
+}