Merge pull request #1 from php-opencloud/refactor

Refactor

Author: Jamie Hannaford

src/Common/Api/AbstractApi.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types = 1);
+<?php declare (strict_types = 1);
 
 namespace OpenCloud\Common\Api;
 

src/Common/Api/AbstractParams.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Api;
 
@@ -97,4 +97,4 @@ public function sortKey(): array
             'description' => "Sorts by one or more sets of attribute and sort direction combinations.",
         ];
     }
-}
+}

src/Common/Api/ApiInterface.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Api;
 

src/Common/Api/Operation.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Api;
 
@@ -131,4 +131,4 @@ public function validate(array $userValues): bool
 
         return true;
     }
-}
+}

src/Common/Api/OperatorInterface.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Api;
 
@@ -44,11 +44,21 @@ public function execute(array $definition, array $userValues = []): ResponseInte
     public function executeAsync(array $definition, array $userValues = []): PromiseInterface;
 
     /**
-     * @param string $name The name of the model class.
+     * Retrieves a populated Operation according to the definition and values provided. A
+     * HTTP client is also injected into the object to allow it to communicate with the remote API.
+     *
+     * @param array $definition The data that dictates how the operation works
+     *
+     * @return Operation
+     */
+    public function getOperation(array $definition): Operation;
+
+    /**
+     * @param string $class The name of the model class.
      * @param mixed  $data Either a {@see ResponseInterface} or data array that will populate the newly
      *                     created model class.
      *
      * @return \OpenCloud\Common\Resource\ResourceInterface
      */
-    public function model(string $name, $data = null): ResourceInterface;
+    public function model(string $class, $data = null): ResourceInterface;
 }

src/Common/Api/Operator.php renamed to src/Common/Api/OperatorTrait.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Api;
 
@@ -11,10 +11,7 @@
 use OpenCloud\Common\Transport\RequestSerializer;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * {@inheritDoc}
- */
-abstract class Operator implements OperatorInterface
+trait OperatorTrait
 {
     /** @var ClientInterface */
     protected $client;
@@ -55,18 +52,58 @@ public function __debugInfo()
     }
 
     /**
-     * Retrieves a populated Operation according to the definition and values provided. A
-     * HTTP client is also injected into the object to allow it to communicate with the remote API.
+     * Magic method which intercepts async calls, finds the sequential version, and wraps it in a
+     * {@see Promise} object. In order for this to happen, the called methods need to be in the
+     * following format: `createAsync`, where `create` is the sequential method being wrapped.
+     *
+     * @param $methodName The name of the method being invoked.
+     * @param $args       The arguments to be passed to the sequential method.
      *
-     * @param array $definition The data that dictates how the operation works
+     * @throws \RuntimeException If method does not exist
      *
-     * @return Operation
+     * @return Promise
+     */
+    public function __call($methodName, $args)
+    {
+        $e = function ($name) {
+            return new \RuntimeException(sprintf('%s::%s is not defined', get_class($this), $name));
+        };
+
+        if (substr($methodName, -5) === 'Async') {
+            $realMethod = substr($methodName, 0, -5);
+            if (!method_exists($this, $realMethod)) {
+                throw $e($realMethod);
+            }
+
+            $promise = new Promise(
+                function () use (&$promise, $realMethod, $args) {
+                    $value = call_user_func_array([$this, $realMethod], $args);
+                    $promise->resolve($value);
+                }
+            );
+
+            return $promise;
+        }
+
+        throw $e($methodName);
+    }
+
+    /**
+     * {@inheritdoc}
      */
     public function getOperation(array $definition): Operation
     {
         return new Operation($definition);
     }
 
+    /**
+     * @param Operation $operation
+     * @param array     $userValues
+     * @param bool      $async
+     *
+     * @return mixed
+     * @throws \Exception
+     */
     protected function sendRequest(Operation $operation, array $userValues = [], bool $async = false)
     {
         $operation->validate($userValues);
@@ -100,76 +137,16 @@ public function executeAsync(array $definition, array $userValues = []): Promise
     public function model(string $class, $data = null): ResourceInterface
     {
         $model = new $class($this->client, $this->api);
-
         // @codeCoverageIgnoreStart
         if (!$model instanceof ResourceInterface) {
             throw new \RuntimeException(sprintf('%s does not implement %s', $class, ResourceInterface::class));
         }
         // @codeCoverageIgnoreEnd
-
         if ($data instanceof ResponseInterface) {
             $model->populateFromResponse($data);
         } elseif (is_array($data)) {
             $model->populateFromArray($data);
         }
-
         return $model;
     }
-
-    /**
-     * Will create a new instance of this class with the current HTTP client and API injected in. This
-     * is useful when enumerating over a collection since multiple copies of the same resource class
-     * are needed.
-     *
-     * @return static
-     */
-    public function newInstance(): self
-    {
-        return new static($this->client, $this->api);
-    }
-
-    /**
-     * @return \GuzzleHttp\Psr7\Uri:null
-     */
-    protected function getHttpBaseUrl()
-    {
-        return $this->client->getConfig('base_uri');
-    }
-
-    /**
-     * Magic method which intercepts async calls, finds the sequential version, and wraps it in a
-     * {@see Promise} object. In order for this to happen, the called methods need to be in the
-     * following format: `createAsync`, where `create` is the sequential method being wrapped.
-     *
-     * @param $methodName The name of the method being invoked.
-     * @param $args       The arguments to be passed to the sequential method.
-     *
-     * @throws \RuntimeException If method does not exist
-     *
-     * @return Promise
-     */
-    public function __call($methodName, $args)
-    {
-        $e = function ($name) {
-            return new \RuntimeException(sprintf('%s::%s is not defined', get_class($this), $name));
-        };
-
-        if (substr($methodName, -5) === 'Async') {
-            $realMethod = substr($methodName, 0, -5);
-            if (!method_exists($this, $realMethod)) {
-                throw $e($realMethod);
-            }
-
-            $promise = new Promise(
-                function () use (&$promise, $realMethod, $args) {
-                    $value = call_user_func_array([$this, $realMethod], $args);
-                    $promise->resolve($value);
-                }
-            );
-
-            return $promise;
-        }
-
-        throw $e($methodName);
-    }
 }

src/Common/Api/Parameter.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Api;
 
@@ -240,7 +240,7 @@ private function validateObject($userValues)
     /**
      * Internal method which retrieves a nested property for object parameters.
      *
-     * @param $key The name of the child parameter
+     * @param string $key The name of the child parameter
      *
      * @returns Parameter
      * @throws \Exception

src/Common/ArrayAccessTrait.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common;
 

src/Common/Auth/AuthHandler.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Auth;
 

src/Common/Auth/Catalog.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare (strict_types=1);
 
 namespace OpenCloud\Common\Auth;