Merge pull request #15 from lordthorzonus/analysis-x0nJbb

Apply fixes from StyleCI

Author: lordthorzonus

src/CacheMap.php

@@ -70,8 +70,7 @@ public function count(): int
     /**
      * Returns the index of the value from the cache array with the given key.
      *
-     * @param mixed $cacheKey
-     *
+     * @param  mixed  $cacheKey
      * @return mixed
      */
     private function findCacheIndexByKey($cacheKey)

src/CacheMapInterface.php

@@ -10,27 +10,24 @@ interface CacheMapInterface
      * Returns the given entry from cache with the given key.
      * Returns false if no entry with the key is found.
      *
-     * @param mixed $key
-     *
+     * @param  mixed  $key
      * @return bool|mixed
      */
     public function get($key);
 
     /**
      * Sets the cache with the given key and value.
      *
-     * @param mixed $key
-     * @param mixed $value
-     *
+     * @param  mixed  $key
+     * @param  mixed  $value
      * @return void
      */
     public function set($key, $value): void;
 
     /**
      * Deletes the cache entry with the given key.
      *
-     * @param mixed $key
-     *
+     * @param  mixed  $key
      * @return void
      */
     public function delete($key): void;

src/DataLoader.php

@@ -29,11 +29,11 @@ final class DataLoader implements DataLoaderInterface
     /**
      * Initiates a new DataLoader.
      *
-     * @param callable $batchLoadFunction The function which will be called for the batch loading.
-     * It must accept an array of keys and returns a Promise which resolves to an array of values.
-     * @param LoopInterface $loop
-     * @param CacheMapInterface $cacheMap
-     * @param null|DataLoaderOptions $options
+     * @param  callable  $batchLoadFunction  The function which will be called for the batch loading.
+     *                                       It must accept an array of keys and returns a Promise which resolves to an array of values.
+     * @param  LoopInterface  $loop
+     * @param  CacheMapInterface  $cacheMap
+     * @param  null|DataLoaderOptions  $options
      */
     public function __construct(
         callable $batchLoadFunction,
@@ -166,7 +166,7 @@ private function dispatchQueue(): void
     /**
      * Dispatches a batch of a queue. The given batch can also be the whole queue.
      *
-     * @param array $batch
+     * @param  array  $batch
      */
     private function dispatchQueueBatch($batch)
     {
@@ -195,9 +195,8 @@ function ($values) use ($batch, $keys) {
     /**
      * Dispatches the given queue in multiple batches.
      *
-     * @param array $queue
-     * @param int $maxBatchSize
-     *
+     * @param  array  $queue
+     * @param  int  $maxBatchSize
      * @return void
      */
     private function dispatchQueueInMultipleBatches(array $queue, $maxBatchSize): void
@@ -214,8 +213,8 @@ private function dispatchQueueInMultipleBatches(array $queue, $maxBatchSize): vo
     /**
      * Handles the batch by resolving the promises and rejecting ones that return Exceptions.
      *
-     * @param array $batch
-     * @param array $values
+     * @param  array  $batch
+     * @param  array  $values
      */
     private function handleSuccessfulDispatch(array $batch, array $values): void
     {
@@ -230,8 +229,8 @@ private function handleSuccessfulDispatch(array $batch, array $values): void
     /**
      * Handles the failed batch dispatch.
      *
-     * @param array $batch
-     * @param \Exception $error
+     * @param  array  $batch
+     * @param  \Exception  $error
      */
     private function handleFailedDispatch(array $batch, \Exception $error)
     {
@@ -245,8 +244,8 @@ private function handleFailedDispatch(array $batch, \Exception $error)
     /**
      * Validates the batch promise's output.
      *
-     * @param array $values Values from resolved promise.
-     * @param array $keys Keys which the DataLoaders load was called with
+     * @param  array  $values  Values from resolved promise.
+     * @param  array  $keys  Keys which the DataLoaders load was called with
      *
      * @throws DataLoaderException
      */

src/DataLoaderInterface.php

@@ -12,9 +12,9 @@ interface DataLoaderInterface
     /**
      * Returns a Promise for the value represented by the given key.
      *
-     * @param mixed $key
-     *
+     * @param  mixed  $key
      * @return ExtendedPromiseInterface
+     *
      * @throws \InvalidArgumentException
      */
     public function load($key): ExtendedPromiseInterface;
@@ -29,18 +29,17 @@ public function load($key): ExtendedPromiseInterface;
      *      $dataLoader->load('b');
      *  });
      *
-     * @param array $keys
-     *
+     * @param  array  $keys
      * @return ExtendedPromiseInterface
+     *
      * @throws \InvalidArgumentException
      */
     public function loadMany(array $keys): ExtendedPromiseInterface;
 
     /**
      * Clears the value for the given key from the cache if it exists.
      *
-     * @param int|string $key
-     *
+     * @param  int|string  $key
      * @return void
      */
     public function clear($key): void;
@@ -55,9 +54,8 @@ public function clearAll(): void;
     /**
      * Adds the given key and value to the cache. If the key already exists no change is made.
      *
-     * @param int|string $key
-     * @param int|string $value
-     *
+     * @param  int|string  $key
+     * @param  int|string  $value
      * @return void
      */
     public function prime($key, $value): void;

tests/Unit/DataLoaderAbuseTest.php

@@ -210,7 +210,7 @@ public function batch_function_must_promise_an_array_of_correct_length()
      * Creates a simple DataLoader.
      *
      * @param $batchLoadFunction
-     * @param array $options
+     * @param  array  $options
      * @return DataLoader
      */
     private function createDataLoader($batchLoadFunction, $options = null)

tests/Unit/DataLoaderTest.php

@@ -857,8 +857,7 @@ function ($keys) use (&$bLoadCalls, $deepLoader) {
     /**
      * Creates a simple DataLoader which returns the given keys as values.
      *
-     * @param array $options
-     *
+     * @param  array  $options
      * @return DataLoader
      */
     private function createIdentityLoader($options = null)
@@ -877,8 +876,7 @@ function ($keys) {
     /**
      * Creates a simple DataLoader which returns the given keys as values.
      *
-     * @param array $options
-     *
+     * @param  array  $options
      * @return DataLoader
      */
     private function createEvenLoader($options = null)