php-opencloud / openstack

src/Common/JsonPath.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     /**
      * Set a node in the structure
      *
-     * @param $path  The XPath to use
+     * @param string $path  The XPath to use
      * @param $value The new value of the node
      */
     public function set($path, $value)

src/Common/Resource/HasWaiterTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -44,7 +44,7 @@ 
      *                              encapsulate your own logic to determine whether the resource has
      *                              successfully transitioned. When TRUE is returned by the callback,
      *                              the loop will end.
-     * @param int|bool $timeout     The maximum timeout in seconds. If the total time taken by the waiter has reached
+     * @param integer $timeout     The maximum timeout in seconds. If the total time taken by the waiter has reached
      *                              or exceed this timeout, the blocking operation will immediately cease. If FALSE
      *                              is provided, the timeout will never be considered.
      * @param int      $sleepPeriod The amount of time to pause between each HTTP request.
@@ -69,7 +69,7 @@ 
     /**
      * Internal method used to identify whether a timeout has been exceeded.
      *
-     * @param bool|int $timeout
+     * @param integer $timeout
      * @param int      $startTime
      *
      * @return bool
@@ -87,7 +87,7 @@ 
      * Convenience method providing a blocking operation until the resource transitions to an
      * ``ACTIVE`` status.
      *
-     * @param int|bool $timeout The maximum timeout in seconds. If the total time taken by the waiter has reached
+     * @param integer $timeout The maximum timeout in seconds. If the total time taken by the waiter has reached
      *                          or exceed this timeout, the blocking operation will immediately cease. If FALSE
      *                          is provided, the timeout will never be considered.
      */

src/ObjectStore/v1/Models/Container.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
      *
      * @param string $name The name of the object
      *
-     * @return Object
+     * @return \OpenStack\Common\Resource\ResourceInterface
      */
     public function getObject($name)
     {

src/Common/Api/Parameter.php

Spacing +3 added lines, -3 removed lines

@@ -123,7 +123,7 @@ 
         }
 
         $this->location = $this->location ?: self::DEFAULT_LOCATION;
-        $this->required = (bool)$this->required;
+        $this->required = (bool) $this->required;
 
         if (isset($data['items'])) {
             $this->itemSchema = new Parameter($data['items']);
@@ -225,8 +225,8 @@ 
     private function hasCorrectType($userValue)
     {
         // Helper fn to see whether an array is associative (i.e. a JSON object)
-        $isAssociative = function ($value) {
-            return is_array($value) && (bool)count(array_filter(array_keys($value), 'is_string'));
+        $isAssociative = function($value) {
+            return is_array($value) && (bool) count(array_filter(array_keys($value), 'is_string'));
         };
 
         // For params defined as objects, we'll let the user get away with

src/Common/Transport/Middleware.php

Spacing +4 added lines, -4 removed lines

@@ -13,10 +13,10 @@ 
 {
     public static function httpErrors()
     {
-        return function (callable $handler) {
-            return function ($request, array $options) use ($handler) {
+        return function(callable $handler) {
+            return function($request, array $options) use ($handler) {
                 return $handler($request, $options)->then(
-                    function (ResponseInterface $response) use ($request, $handler) {
+                    function(ResponseInterface $response) use ($request, $handler) {
                         if ($response->getStatusCode() < 400) {
                             return $response;
                         }
@@ -29,7 +29,7 @@ 
 
     public static function authHandler(callable $tokenGenerator, Token $token = null)
     {
-        return function (callable $handler) use ($tokenGenerator, $token) {
+        return function(callable $handler) use ($tokenGenerator, $token) {
             return new AuthHandler($handler, $tokenGenerator, $token);
         };
     }

src/Common/Api/Operator.php

Spacing +2 added lines, -2 removed lines

@@ -138,7 +138,7 @@ 
      */
     public function __call($methodName, $args)
     {
-        $e = function ($name) {
+        $e = function($name) {
             return new \RuntimeException(sprintf('%s::%s is not defined', $name, get_class($this)));
         };
 
@@ -149,7 +149,7 @@ 
             }
 
             $promise = new Promise(
-                function () use (&$promise, $realMethod, $args) {
+                function() use (&$promise, $realMethod, $args) {
                     $value = call_user_func_array([$this, $realMethod], $args);
                     $promise->resolve($value);
                 }

src/Common/Resource/AbstractResource.php

Doc Comments +7 added lines, -1 removed lines

@@ -96,6 +96,9 @@ 
         }
     }
 
+    /**
+     * @param string $type
+     */
     private function parseDocBlockValue($type, $val)
     {
         if (strpos($type, '[]') === 0 && is_array($val)) {
@@ -120,6 +123,9 @@ 
         ]);
     }
 
+    /**
+     * @return string
+     */
     private function normalizeModelClass($class)
     {
         if (strpos($class, '\\') === false) {
@@ -166,7 +172,7 @@ 
     /**
      * @param array $definition
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function executeWithState(array $definition)
     {

Spacing +3 added lines, -3 removed lines

@@ -178,7 +178,7 @@ 
         $resourcesKey = $this->resourcesKey;
 
         if (!$resourcesKey) {
-            $class =  substr(static::class, strrpos(static::class, '\\') + 1);
+            $class = substr(static::class, strrpos(static::class, '\\') + 1);
             $resourcesKey = strtolower(preg_replace('/([a-z])([A-Z])/', '$1_$2', $class)) . 's';
         }
 
@@ -192,14 +192,14 @@ 
     {
         $operation = $this->getOperation($def);
 
-        $requestFn = function ($marker) use ($operation, $userVals) {
+        $requestFn = function($marker) use ($operation, $userVals) {
             if ($marker) {
                 $userVals['marker'] = $marker;
             }
             return $this->sendRequest($operation, $userVals);
         };
 
-        $resourceFn = function (array $data) {
+        $resourceFn = function(array $data) {
             $resource = $this->newInstance();
             $resource->populateFromArray($data);
             return $resource;

src/Common/Service/Builder.php

Spacing +2 added lines, -2 removed lines

@@ -108,7 +108,7 @@ 
     /**
      * @codeCoverageIgnore
      */
-    private function addDebugMiddleware(array $options, HandlerStack &$stack)
+    private function addDebugMiddleware(array $options, HandlerStack & $stack)
     {
         if (!empty($options['debugLog'])
             && !empty($options['logger'])
@@ -133,7 +133,7 @@ 
     private function stockAuthHandler(array &$options)
     {
         if (!isset($options['authHandler'])) {
-            $options['authHandler'] = function () use ($options) {
+            $options['authHandler'] = function() use ($options) {
                 return $options['identityService']->generateToken($options);
             };
         }

src/Common/Error/Builder.php

Doc Comments +5 added lines, -2 removed lines

@@ -44,7 +44,7 @@ 
     /**
      * Internal method used when outputting headers in the error description.
      *
-     * @param $name
+     * @param string $name
      *
      * @return string
      */
@@ -57,7 +57,7 @@ 
      * Before outputting custom links, it is validated to ensure that the user is not
      * directed off to a broken link. If a 404 is detected, it is hidden.
      *
-     * @param $link The proposed link
+     * @param string $link The proposed link
      *
      * @return bool
      */
@@ -107,6 +107,9 @@ 
         return $e;
     }
 
+    /**
+     * @param integer $statusCode
+     */
     private function getStatusCodeMessage($statusCode)
     {
         $errors = [