Introduce DefaultsAwareInterface

Author: tomkyle

src/DefaultsAwareInterface.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * tomkyle/matomo-api-client (https://github.com/tomkyle/matomo-api-client)
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace tomkyle\MatomoApiClient;
+
+use Psr\Log;
+
+interface DefaultsAwareInterface extends Log\LoggerAwareInterface
+{
+
+    /**
+     * Gets default API parameters.
+     *
+     * @return array<string,string>
+     */
+    public function getDefaults(): array;
+
+    /**
+     * Sets default API parameters.
+     *
+     * @param array<string,string> $defaults
+     */
+    public function setDefaults(array $defaults): self;
+
+    /**
+     * Merges new API parameters into the existing defaults.
+     *
+     * @param array<string,string> $defaults
+     */
+    public function mergeDefaults(array $defaults): self;
+}

src/MatomoApiClient.php

@@ -21,7 +21,7 @@
 /**
  * Provides a client for interacting with the Matomo API.
  */
-class MatomoApiClient implements MatomoApiClientInterface
+class MatomoApiClient implements MatomoApiClientInterface, DefaultsAwareInterface
 {
     use Log\LoggerAwareTrait;
 
@@ -162,19 +162,15 @@ public function setApi(UriInterface $uri): self
     }
 
     /**
-     * Gets default API parameters.
-     *
-     * @return array<string,string>
+     * @inheritDoc
      */
     public function getDefaults(): array
     {
         return $this->defaults;
     }
 
     /**
-     * Sets default API parameters.
-     *
-     * @param array<string,string> $defaults
+     * @inheritDoc
      */
     public function setDefaults(array $defaults): self
     {
@@ -183,9 +179,7 @@ public function setDefaults(array $defaults): self
     }
 
     /**
-     * Merges new API parameters into the existing defaults.
-     *
-     * @param array<string,string> $defaults
+     * @inheritDoc
      */
     public function mergeDefaults(array $defaults): self
     {

src/MatomoApiClientTrait.php

@@ -42,4 +42,37 @@ public function getMatomoClient(): MatomoApiClientInterface
         return $this->matomo_client;
     }
 
+
+    /**
+     * @inheritDoc
+     */
+    public function getDefaults(): array
+    {
+        if ($this->matomo_client instanceOf DefaultsAwareInterface) {
+            return $this->matomo_client->getDefaults();
+        }
+        return [];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setDefaults(array $defaults): self
+    {
+        if ($this->matomo_client instanceOf DefaultsAwareInterface) {
+            $this->matomo_client->setDefaults($defaults);
+        }
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function mergeDefaults(array $defaults): self
+    {
+        if ($this->matomo_client instanceOf DefaultsAwareInterface) {
+            $this->matomo_client->mergeDefaults($defaults);
+        }
+        return $this;
+    }
 }

src/ProcessingMatomoApiClient.php

@@ -11,7 +11,7 @@
 
 use Psr\Log;
 
-class ProcessingMatomoApiClient implements MatomoApiClientInterface
+class ProcessingMatomoApiClient implements MatomoApiClientInterface, DefaultsAwareInterface
 {
     use MatomoApiClientTrait;
     use Log\LoggerAwareTrait;

src/Psr6CacheMatomoApiClient.php

@@ -12,7 +12,7 @@
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log;
 
-class Psr6CacheMatomoApiClient implements MatomoApiClientInterface
+class Psr6CacheMatomoApiClient implements MatomoApiClientInterface, DefaultsAwareInterface
 {
     use MatomoApiClientTrait;
     use Log\LoggerAwareTrait;
@@ -23,7 +23,7 @@ class Psr6CacheMatomoApiClient implements MatomoApiClientInterface
      * @var CacheItemPoolInterface
      */
     protected $cache;
-    
+
     /**
      * Constructs a new cache proxy instance.
      *
@@ -58,7 +58,7 @@ public function request(array $params, ?string $method = null): array
             $this->logger->log(Log\LogLevel::INFO, "Matomo API response found in cache", ['cacheKey' => $cacheKey]);
             $result = $cacheItem->get();
             if (is_array($result)) {
-                return $result;                
+                return $result;
             }
 
             throw new \UnexpectedValueException("Expected cached Matomo API response to be an array.");

src/RetryingMatomoApiClient.php

@@ -11,7 +11,7 @@
 
 use Psr\Log;
 
-class RetryingMatomoApiClient implements MatomoApiClientInterface
+class RetryingMatomoApiClient implements MatomoApiClientInterface, DefaultsAwareInterface
 {
     use MatomoApiClientTrait;
     use Log\LoggerAwareTrait;