perf(Arguments): Refactor the way the arguments works

To be sure we can work with SubKeyedArg that are having array as value.

Author: Antoine Aflalo

src/Request/Api/BaseRequest.php

@@ -14,8 +14,6 @@
 use ZEROSPAM\Framework\SDK\Request\Arguments\Mergeable\IMergeableArgument;
 use ZEROSPAM\Framework\SDK\Request\Arguments\Mergeable\Worker\ArgMerger;
 use ZEROSPAM\Framework\SDK\Request\Arguments\Stackable\IStackableArgument;
-use ZEROSPAM\Framework\SDK\Request\Arguments\Stackable\IStackableArrayArgument;
-use ZEROSPAM\Framework\SDK\Request\Arguments\Stackable\Worker\ArgArrayCollector;
 use ZEROSPAM\Framework\SDK\Request\Arguments\Stackable\Worker\ArgCollector;
 use ZEROSPAM\Framework\SDK\Request\Type\RequestType;
 use ZEROSPAM\Framework\SDK\Response\Api\IResponse;
@@ -44,10 +42,6 @@ abstract class BaseRequest implements IRequest
      * @var ArgCollector[]
      */
     private $stackableArguments = [];
-
-    /** @var ArgArrayCollector[] */
-    private $stackableArrayArguments = [];
-
     /**
      * @var \ZEROSPAM\Framework\SDK\Response\Api\IResponse
      */
@@ -80,15 +74,7 @@ public function addArgument(IArgument $arg): IRequest
             return $this;
         }
 
-        if ($arg instanceof IStackableArrayArgument) {
-            if (!isset($this->stackableArrayArguments[$arg->getKey()])) {
-                $this->stackableArrayArguments[$arg->getKey()] = new ArgArrayCollector();
-            }
-
-            $this->stackableArrayArguments[$arg->getKey()]->addArgument($arg);
-
-            return $this;
-        } elseif ($arg instanceof IStackableArgument) {
+        if ($arg instanceof IStackableArgument) {
             if (!isset($this->stackableArguments[$arg->getKey()])) {
                 $this->stackableArguments[$arg->getKey()] = new ArgCollector();
             }
@@ -293,10 +279,6 @@ private function generateUrl(): string
             $query[$key] = $value->toArray();
         }
 
-        foreach ($this->stackableArrayArguments as $key => $value) {
-            $query[$key] = $value->toArray();
-        }
-
         $queryArg = http_build_query($query, null, '&', PHP_QUERY_RFC3986);
 
         $fullUrl = $this->routeUrl() . '?' . preg_replace($re, $subst, $queryArg);

src/Request/Arguments/IArgument.php

@@ -25,4 +25,11 @@ interface IArgument extends PrimalValued
      * @return string
      */
     public function getKey(): string;
+
+    /**
+     * Possible Subkey of the argument
+     *
+     * @return string
+     */
+    public function getSubKey(): string;
 }

src/Request/Arguments/RequestArg.php

@@ -72,4 +72,14 @@ public function toPrimitive()
 
         return $value;
     }
+
+    /**
+     * Possible Subkey of the argument
+     *
+     * @return string
+     */
+    public function getSubKey(): string
+    {
+        return $this->toPrimitive();
+    }
 }

src/Request/Arguments/Stackable/ISubKeyedStackableArgument.php

@@ -10,10 +10,5 @@
 
 interface ISubKeyedStackableArgument extends IStackableArgument
 {
-    /**
-     * Possible Subkey of the argument
-     *
-     * @return string
-     */
-    public function getSubKey(): string;
+
 }

src/Request/Arguments/Stackable/Worker/ArgArrayCollector.php

@@ -41,11 +41,9 @@ protected function stackKey(): string
     }
 
     /**
-     * Add the argument.
-     *
      * @param IStackableArgument $argument
      *
-     * @return $this
+     * @return $this|ArgCollector
      */
     public function addArgument(IStackableArgument $argument)
     {
@@ -57,18 +55,16 @@ public function addArgument(IStackableArgument $argument)
         } else {
             $key = $this->stackKey();
         }
-        $primitive                    = $argument->toPrimitive();
-        $this->args[$key][$primitive] = $argument;
+
+        $this->args[$key][$argument->getSubKey()] = $argument;
 
         return $this;
     }
 
     /**
-     * Remove the argument.
-     *
      * @param IStackableArgument $argument
      *
-     * @return $this
+     * @return $this|ArgCollector
      */
     public function removeArgument(IStackableArgument $argument)
     {
@@ -78,7 +74,7 @@ public function removeArgument(IStackableArgument $argument)
             $key = $this->stackKey();
         }
 
-        unset($this->args[$key][$argument->toPrimitive()]);
+        unset($this->args[$key][$argument->getSubKey()]);
         if (empty($this->args[$key])) {
             unset($this->args[$key]);
         }

src/Request/Arguments/Stackable/Worker/ArgCollector.php

@@ -20,7 +20,6 @@
 class SearchKeyedArg extends SubKeyedStackableRequestArg
 {
 
-
     public function __construct(string $subKey, string $value)
     {
         parent::__construct('search', $subKey, $value);

tests/src/Base/Argument/SearchKeyedArg.php

@@ -9,6 +9,7 @@
 namespace ZEROSPAM\Framework\SDK\Test\Base\Argument;
 
 use ZEROSPAM\Framework\SDK\Request\Arguments\Mergeable\IMergeableArgument;
+use ZEROSPAM\Framework\SDK\Request\Arguments\RequestArg;
 
 /**
  * Class TestMergeableArg
@@ -17,7 +18,7 @@
  *
  * @package ZEROSPAM\Framework\SDK\Test\Base\Argument
  */
-class TestMergeableArg implements IMergeableArgument
+class TestMergeableArg extends RequestArg implements IMergeableArgument
 {
     /**
      * @var string
@@ -31,17 +32,7 @@ class TestMergeableArg implements IMergeableArgument
      */
     public function __construct(string $obj)
     {
-        $this->obj = $obj;
-    }
-
-    /**
-     * Key for the argument.
-     *
-     * @return string
-     */
-    public function getKey(): string
-    {
-        return 'mergeArg';
+        parent::__construct('mergeArg', $obj);
     }
 
     /**
@@ -53,14 +44,4 @@ public static function glue()
     {
         return ';';
     }
-
-    /**
-     * Return a primitive value for this object.
-     *
-     * @return int|float|string|float
-     */
-    public function toPrimitive()
-    {
-        return $this->obj;
-    }
 }