voku / Arrayy

src/Arrayy.php

Doc Comments +4 added lines, -4 removed lines

@@ -1932,7 +1932,7 @@ 
      *
      * @param float|int|string $low  <p>First value of the sequence.</p>
      * @param float|int|string $high <p>The sequence is ended upon reaching the end value.</p>
-     * @param float|int        $step <p>Used as the increment between elements in the sequence.</p>
+     * @param integer        $step <p>Used as the increment between elements in the sequence.</p>
      *
      * @return static
      *                <p>(Immutable) Returns an new instance of the Arrayy object.</p>
@@ -2733,7 +2733,7 @@ 
     /**
      * Get the first key from the current array.
      *
-     * @return mixed|null
+     * @return integer|null
      *                    <p>Return null if there wasn't a element.</p>
      *
      * @phpstan-return TKey|null
@@ -4145,7 +4145,7 @@ 
     /**
      * Get the last key from the current array.
      *
-     * @return mixed|null
+     * @return null|integer
      *                    <p>Return null if there wasn't a element.</p>
      * @psalm-mutation-free
      */
@@ -4605,7 +4605,7 @@ 
     /**
      * Get the most used value from the array.
      *
-     * @return mixed|null
+     * @return integer|null
      *                    <p>(Immutable) Return null if there wasn't an element.</p>
      *
      * @phpstan-return T|null

Spacing +65 added lines, -65 removed lines

@@ -328,7 +328,7 @@ 
         /**
          * @phpstan-return \Generator<TKey,T> $generator
          */
-        $generator = function () use ($key, $value): \Generator {
+        $generator = function() use ($key, $value): \Generator {
             if ($this->properties !== []) {
                 $this->checkType($key, $value);
             }
@@ -516,7 +516,7 @@ 
 
             /** @phpstan-var \Arrayy\ArrayyRewindableGenerator<TKey,T> */
             $generatorTmp = new ArrayyRewindableExtendedGenerator(
-                static function () use ($generator): \Generator {
+                static function() use ($generator): \Generator {
                     yield from $generator;
                 },
                 null,
@@ -724,7 +724,7 @@ 
                  */
                 $this->callAtPath(
                     $containerPath,
-                    static function ($container) use ($lastOffset, &$offsetExists) {
+                    static function($container) use ($lastOffset, &$offsetExists) {
                         $offsetExists = \array_key_exists($lastOffset, $container);
                     }
                 );
@@ -829,7 +829,7 @@ 
                  */
                 $this->callAtPath(
                     \implode($this->pathSeparator, $path),
-                    static function (&$offset) use ($pathToUnset) {
+                    static function(&$offset) use ($pathToUnset) {
                         if (\is_array($offset)) {
                             unset($offset[$pathToUnset]);
                         } else {
@@ -884,7 +884,7 @@ 
 
         if (\strpos($iteratorClass, '\\') === 0) {
             /** @var class-string<\Arrayy\ArrayyIterator<TKey,T>> $iteratorClass */
-            $iteratorClass = '\\' . $iteratorClass;
+            $iteratorClass = '\\'.$iteratorClass;
             if (\class_exists($iteratorClass)) {
                 /**
                  * @psalm-suppress PropertyTypeCoercion
@@ -895,7 +895,7 @@ 
             }
         }
 
-        throw new \InvalidArgumentException('The iterator class does not exist: ' . $iteratorClass);
+        throw new \InvalidArgumentException('The iterator class does not exist: '.$iteratorClass);
     }
 
     /**
@@ -1074,13 +1074,13 @@ 
 
         foreach ($this->getGenerator() as $key => $item) {
             if ($item instanceof self) {
-                $result[$prefix . $key] = $item->appendToEachKey($prefix);
+                $result[$prefix.$key] = $item->appendToEachKey($prefix);
             } elseif (\is_array($item)) {
-                $result[$prefix . $key] = self::create($item, $this->iteratorClass, false)
+                $result[$prefix.$key] = self::create($item, $this->iteratorClass, false)
                     ->appendToEachKey($prefix)
                     ->toArray();
             } else {
-                $result[$prefix . $key] = $item;
+                $result[$prefix.$key] = $item;
             }
         }
 
@@ -1115,7 +1115,7 @@ 
             } elseif (\is_object($item) === true) {
                 $result[$key] = $item;
             } else {
-                $result[$key] = $prefix . $item;
+                $result[$key] = $prefix.$item;
             }
         }
 
@@ -1302,7 +1302,7 @@ 
     public function chunk($size, $preserveKeys = false): self
     {
         if ($preserveKeys) {
-            $generator = function () use ($size) {
+            $generator = function() use ($size) {
                 $values = [];
                 $tmpCounter = 0;
                 foreach ($this->getGenerator() as $key => $value) {
@@ -1322,7 +1322,7 @@ 
                 }
             };
         } else {
-            $generator = function () use ($size) {
+            $generator = function() use ($size) {
                 $values = [];
                 $tmpCounter = 0;
                 foreach ($this->getGenerator() as $value) {
@@ -1366,7 +1366,7 @@ 
     public function clean(): self
     {
         return $this->filter(
-            static function ($value) {
+            static function($value) {
                 return (bool) $value;
             }
         );
@@ -1707,9 +1707,9 @@ 
 
         foreach ($items as $key => $value) {
             if (\is_array($value) && $value !== []) {
-                $flatten[] = $this->flatten($delimiter, $prepend . $key . $delimiter, $value);
+                $flatten[] = $this->flatten($delimiter, $prepend.$key.$delimiter, $value);
             } else {
-                $flatten[] = [$prepend . $key => $value];
+                $flatten[] = [$prepend.$key => $value];
             }
         }
 
@@ -1894,7 +1894,7 @@ 
          */
         \array_walk(
             $array,
-            static function (&$val) {
+            static function(&$val) {
                 if ((string) $val === $val) {
                     $val = \trim($val);
                 }
@@ -2132,7 +2132,7 @@ 
             $array = $array[0];
         }
 
-        $generator = function () use ($array): \Generator {
+        $generator = function() use ($array): \Generator {
             foreach ($this->getGenerator() as $key => $value) {
                 if (\in_array($value, $array, true) === false) {
                     yield $key => $value;
@@ -2167,7 +2167,7 @@ 
             $array = $array[0];
         }
 
-        $generator = function () use ($array): \Generator {
+        $generator = function() use ($array): \Generator {
             foreach ($this->getGenerator() as $key => $value) {
                 if (\array_key_exists($key, $array) === false) {
                     yield $key => $value;
@@ -2202,7 +2202,7 @@ 
             $array = $array[0];
         }
 
-        $generator = function () use ($array): \Generator {
+        $generator = function() use ($array): \Generator {
             foreach ($this->getGenerator() as $key => $value) {
                 $isset = isset($array[$key]);
 
@@ -2511,7 +2511,7 @@ 
         }
 
         if ($flag === \ARRAY_FILTER_USE_KEY) {
-            $generator = function () use ($closure) {
+            $generator = function() use ($closure) {
                 foreach ($this->getGenerator() as $key => $value) {
                     if ($closure($key) === true) {
                         yield $key => $value;
@@ -2523,7 +2523,7 @@ 
             /** @phpstan-var \Closure(T=,TKey=):bool $closure */
             $closure = $closure;
 
-            $generator = function () use ($closure) {
+            $generator = function() use ($closure) {
                 foreach ($this->getGenerator() as $key => $value) {
                     if ($closure($value, $key) === true) {
                         yield $key => $value;
@@ -2531,7 +2531,7 @@ 
                 }
             };
         } else {
-            $generator = function () use ($closure) {
+            $generator = function() use ($closure) {
                 foreach ($this->getGenerator() as $key => $value) {
                     if ($closure($value) === true) {
                         yield $key => $value;
@@ -2587,40 +2587,40 @@ 
         }
 
         $ops = [
-            'eq' => static function ($item, $prop, $value): bool {
+            'eq' => static function($item, $prop, $value): bool {
                 return $item[$prop] === $value;
             },
-            'gt' => static function ($item, $prop, $value): bool {
+            'gt' => static function($item, $prop, $value): bool {
                 return $item[$prop] > $value;
             },
-            'ge' => static function ($item, $prop, $value): bool {
+            'ge' => static function($item, $prop, $value): bool {
                 return $item[$prop] >= $value;
             },
-            'gte' => static function ($item, $prop, $value): bool {
+            'gte' => static function($item, $prop, $value): bool {
                 return $item[$prop] >= $value;
             },
-            'lt' => static function ($item, $prop, $value): bool {
+            'lt' => static function($item, $prop, $value): bool {
                 return $item[$prop] < $value;
             },
-            'le' => static function ($item, $prop, $value): bool {
+            'le' => static function($item, $prop, $value): bool {
                 return $item[$prop] <= $value;
             },
-            'lte' => static function ($item, $prop, $value): bool {
+            'lte' => static function($item, $prop, $value): bool {
                 return $item[$prop] <= $value;
             },
-            'ne' => static function ($item, $prop, $value): bool {
+            'ne' => static function($item, $prop, $value): bool {
                 return $item[$prop] !== $value;
             },
-            'contains' => static function ($item, $prop, $value): bool {
+            'contains' => static function($item, $prop, $value): bool {
                 return \in_array($item[$prop], (array) $value, true);
             },
-            'notContains' => static function ($item, $prop, $value): bool {
+            'notContains' => static function($item, $prop, $value): bool {
                 return !\in_array($item[$prop], (array) $value, true);
             },
-            'newer' => static function ($item, $prop, $value): bool {
+            'newer' => static function($item, $prop, $value): bool {
                 return \strtotime($item[$prop]) > \strtotime($value);
             },
-            'older' => static function ($item, $prop, $value): bool {
+            'older' => static function($item, $prop, $value): bool {
                 return \strtotime($item[$prop]) < \strtotime($value);
             },
         ];
@@ -2628,7 +2628,7 @@ 
         $result = \array_values(
             \array_filter(
                 $this->toArray(false, true),
-                static function ($item) use (
+                static function($item) use (
                     $property,
                     $value,
                     $ops,
@@ -2855,7 +2855,7 @@ 
      */
     public function flip(): self
     {
-        $generator = function (): \Generator {
+        $generator = function(): \Generator {
             foreach ($this->getGenerator() as $key => $value) {
                 yield (string) $value => $key;
             }
@@ -3129,9 +3129,9 @@ 
         $jsonObject = \json_decode($json, false);
 
         $mapper = new \Arrayy\Mapper\Json();
-        $mapper->undefinedPropertyHandler = static function ($object, $key, $jsonValue) use ($class) {
+        $mapper->undefinedPropertyHandler = static function($object, $key, $jsonValue) use ($class) {
             if ($class->checkPropertiesMismatchInConstructor) {
-                throw new \TypeError('Property mismatch - input: ' . \print_r(['key' => $key, 'jsonValue' => $jsonValue], true) . ' for object: ' . \get_class($object));
+                throw new \TypeError('Property mismatch - input: '.\print_r(['key' => $key, 'jsonValue' => $jsonValue], true).' for object: '.\get_class($object));
             }
         };
 
@@ -3196,13 +3196,13 @@ 
     public function getColumn($columnKey = null, $indexKey = null): self
     {
         if ($columnKey === null && $indexKey === null) {
-            $generator = function () {
+            $generator = function() {
                 foreach ($this->getGenerator() as $value) {
                     yield $value;
                 }
             };
         } else {
-            $generator = function () use ($columnKey, $indexKey) {
+            $generator = function() use ($columnKey, $indexKey) {
                 foreach ($this->getGenerator() as $value) {
                     // reset
                     $newKey = null;
@@ -3505,7 +3505,7 @@ 
 
         if ($UN_FOUND === null) {
             // Generate unique string to use as marker.
-            $UN_FOUND = 'arrayy--' . \uniqid('arrayy', true);
+            $UN_FOUND = 'arrayy--'.\uniqid('arrayy', true);
         }
 
         if (\is_array($key)) {
@@ -3557,7 +3557,7 @@ 
      */
     public function implode(string $glue = '', string $prefix = ''): string
     {
-        return $prefix . $this->implode_recursive($glue, $this->toArray(), false);
+        return $prefix.$this->implode_recursive($glue, $this->toArray(), false);
     }
 
     /**
@@ -3671,7 +3671,7 @@ 
                 \array_uintersect(
                     $this->toArray(),
                     $search,
-                    static function ($a, $b) {
+                    static function($a, $b) {
                         return $a === $b ? 0 : -1;
                     }
                 ),
@@ -4022,13 +4022,13 @@ 
         // non recursive
 
         if ($search_values === null) {
-            $arrayFunction = function (): \Generator {
+            $arrayFunction = function(): \Generator {
                 foreach ($this->getGenerator() as $key => $value) {
                     yield $key;
                 }
             };
         } else {
-            $arrayFunction = function () use ($search_values, $strict): \Generator {
+            $arrayFunction = function() use ($search_values, $strict): \Generator {
                 $is_array_tmp = \is_array($search_values);
 
                 /** @noinspection PhpParameterByRefIsNotUsedAsReferenceInspection */
@@ -4277,7 +4277,7 @@ 
         $useArguments = \func_num_args() > 2;
 
         return static::create(
-            function () use ($useArguments, $callable, $useKeyAsSecondParameter, $arguments) {
+            function() use ($useArguments, $callable, $useKeyAsSecondParameter, $arguments) {
                 foreach ($this->getGenerator() as $key => $value) {
                     if ($useArguments) {
                         if ($useKeyAsSecondParameter) {
@@ -4779,7 +4779,7 @@ 
      */
     public function nth(int $step, int $offset = 0): self
     {
-        $arrayFunction = function () use ($step, $offset): \Generator {
+        $arrayFunction = function() use ($step, $offset): \Generator {
             $position = 0;
             foreach ($this->getGenerator() as $key => $value) {
                 if ($position++ % $step !== $offset) {
@@ -4813,7 +4813,7 @@ 
     {
         $keys = \array_flip($keys);
 
-        $generator = function () use ($keys): \Generator {
+        $generator = function() use ($keys): \Generator {
             foreach ($this->getGenerator() as $key => $value) {
                 if (isset($keys[$key])) {
                     yield $key => $value;
@@ -4950,7 +4950,7 @@ 
      */
     public function prependImmutable($value, $key = null)
     {
-        $generator = function () use ($key, $value): \Generator {
+        $generator = function() use ($key, $value): \Generator {
             if ($this->properties !== []) {
                 $this->checkType($key, $value);
             }
@@ -5000,7 +5000,7 @@ 
                 )->prependToEachKey($suffix)
                     ->toArray();
             } else {
-                $result[$key . $suffix] = $item;
+                $result[$key.$suffix] = $item;
             }
         }
 
@@ -5040,7 +5040,7 @@ 
             } elseif (\is_object($item) === true) {
                 $result[$key] = $item;
             } else {
-                $result[$key] = $item . $suffix;
+                $result[$key] = $item.$suffix;
             }
         }
 
@@ -5849,7 +5849,7 @@ 
      */
     public function replaceValues($search, $replacement = ''): self
     {
-        $callable = static function ($value) use ($search, $replacement) {
+        $callable = static function($value) use ($search, $replacement) {
             return \str_replace($search, $replacement, $value);
         };
 
@@ -6545,7 +6545,7 @@ 
              * @psalm-suppress MissingClosureParamType
              */
             $results = $arrayy->each(
-                static function ($value) use ($sorter) {
+                static function($value) use ($sorter) {
                     if (\is_callable($sorter) === true) {
                         return $sorter($value);
                     }
@@ -6618,7 +6618,7 @@ 
     public function split(int $numberOfPieces = 2, bool $keepKeys = false): self
     {
         if ($keepKeys) {
-            $generator = function () use ($numberOfPieces) {
+            $generator = function() use ($numberOfPieces) {
                 $carry = [];
                 $i = 1;
                 foreach ($this->getGenerator() as $key => $value) {
@@ -6641,7 +6641,7 @@ 
                 }
             };
         } else {
-            $generator = function () use ($numberOfPieces) {
+            $generator = function() use ($numberOfPieces) {
                 $carry = [];
                 $i = 1;
                 foreach ($this->getGenerator() as $value) {
@@ -6688,7 +6688,7 @@ 
     public function stripEmpty(): self
     {
         return $this->filter(
-            static function ($item) {
+            static function($item) {
                 if ($item === null) {
                     return false;
                 }
@@ -6892,7 +6892,7 @@ 
         // INFO: \array_unique() can't handle e.g. "stdClass"-values in an array
 
         $this->array = $this->reduce(
-            static function ($resultArray, $value, $key) {
+            static function($resultArray, $value, $key) {
                 if (!\in_array($value, $resultArray, true)) {
                     $resultArray[] = $value;
                 }
@@ -6931,7 +6931,7 @@ 
          */
         $this->array = \array_reduce(
             \array_keys($array),
-            static function ($resultArray, $key) use ($array) {
+            static function($resultArray, $key) use ($array) {
                 if (!\in_array($array[$key], $resultArray, true)) {
                     $resultArray[$key] = $array[$key];
                 }
@@ -7028,7 +7028,7 @@ 
     public function values(): self
     {
         return static::create(
-            function () {
+            function() {
                 foreach ($this->getGenerator() as $value) {
                     yield $value;
                 }
@@ -7112,7 +7112,7 @@ 
     public function where(string $keyOrPropertyOrMethod, $value): self
     {
         return $this->filter(
-            function ($item) use ($keyOrPropertyOrMethod, $value) {
+            function($item) use ($keyOrPropertyOrMethod, $value) {
                 $accessorValue = $this->extractValue(
                     $item,
                     $keyOrPropertyOrMethod
@@ -7407,7 +7407,7 @@ 
     protected function getPropertiesFromPhpDoc()
     {
         static $PROPERTY_CACHE = [];
-        $cacheKey = 'Class::' . static::class;
+        $cacheKey = 'Class::'.static::class;
 
         if (isset($PROPERTY_CACHE[$cacheKey])) {
             return $PROPERTY_CACHE[$cacheKey];
@@ -7717,7 +7717,7 @@ 
         if ($array === null) {
             $array = [];
         } elseif (!\is_array($array)) {
-            throw new \RuntimeException('Can not set value at this path "' . $key . '" because (' . \gettype($array) . ')"' . \print_r($array, true) . '" is not an array.');
+            throw new \RuntimeException('Can not set value at this path "'.$key.'" because ('.\gettype($array).')"'.\print_r($array, true).'" is not an array.');
         }
 
         $array[$key] = $value;
@@ -7789,7 +7789,7 @@ 
                 &&
                 \count(\array_diff_key($properties, $data)) > 0
             ) {
-                throw new \TypeError('Property mismatch - input: ' . \print_r(\array_keys($data), true) . ' | expected: ' . \print_r(\array_keys($properties), true));
+                throw new \TypeError('Property mismatch - input: '.\print_r(\array_keys($data), true).' | expected: '.\print_r(\array_keys($properties), true));
             }
 
             foreach ($data as $key => &$valueInner) {
@@ -7906,7 +7906,7 @@ 
              *
              * @return void
              */
-            static function (&$item) {
+            static function(&$item) {
                 if ($item instanceof self) {
                     $item = $item->getArray();
                 }
@@ -7931,7 +7931,7 @@ 
             &&
             $this->checkPropertiesMismatch === true
         ) {
-            throw new \TypeError('The key "' . $key . '" does not exists as "@property" phpdoc. (' . \get_class($this) . ').');
+            throw new \TypeError('The key "'.$key.'" does not exists as "@property" phpdoc. ('.\get_class($this).').');
         }
 
         if (isset($this->properties[self::ARRAYY_HELPER_TYPES_FOR_ALL_PROPERTIES])) {