Clean code ArrayHelper::class, StringHelper::class. (#550)

terabytesoftw · web-flow · commit 0e4337d3e131 · 2023-02-27T18:04:12.000-03:00
diff --git a/src/Helper/ArrayHelper.php b/src/Helper/ArrayHelper.php
@@ -5,14 +5,27 @@
 namespace Yiisoft\Db\Helper;
 
 use Closure;
+use Exception;
+
+use function array_key_exists;
+use function array_map;
+use function array_multisort;
+use function count;
+use function is_array;
+use function is_object;
+use function property_exists;
+use function range;
+use function strrpos;
+use function substr;
 
 /**
- * Short implementation of ArrayHelper from Yii2
+ * Short implementation of ArrayHelper from Yii2.
  */
 final class ArrayHelper
 {
     /**
      * Returns the values of a specified column in an array.
+     *
      * The input array should be multidimensional or an array of objects.
      *
      * For example,
@@ -31,10 +44,10 @@ final class ArrayHelper
      * });
      * ```
      *
-     * @param array $array
-     * @param string $name
+     * @param array $array Array to extract values from.
+     * @param string $name The column name.
      *
-     * @return array the list of column values
+     * @return array The list of column values.
      */
     public static function getColumn(array $array, string $name): array
     {
@@ -48,7 +61,9 @@ static function (array|object $element) use ($name): mixed {
 
     /**
      * Retrieves the value of an array element or object property with the given key or property name.
+     *
      * If the key does not exist in the array, the default value will be returned instead.
+     *
      * Not used when getting value from an object.
      *
      * The key may be specified in a dot format to retrieve the value of a sub-array or the property
@@ -76,15 +91,15 @@ static function (array|object $element) use ($name): mixed {
      * $value = \yii\helpers\ArrayHelper::getValue($versions, ['1.0', 'date']);
      * ```
      *
-     * @param array|object $array array or object to extract value from
-     * @param Closure|string $key key name of the array element, an array of keys or property name of the object,
-     * or an anonymous function returning the value. The anonymous function signature should be:
+     * @param array|object $array Array or object to extract value from.
+     * @param Closure|string $key Key name of the array element, an array of keys or property name of the object, or an
+     * anonymous function returning the value. The anonymous function signature should be:
+     *
      * `function($array, $defaultValue)`.
-     * The possibility to pass an array of keys is available since version 2.0.4.
-     * @param mixed|null $default the default value to be returned if the specified array key does not exist. Not used when
-     * getting value from an object.
+     * @param mixed|null $default The default value to be returned if the specified array key does not exist. Not used
+     * when getting value from an object.
      *
-     * @return mixed the value of the element if found, default value otherwise
+     * @return mixed The value of the element if found, default value otherwise
      */
     public static function getValueByPath(object|array $array, Closure|string $key, mixed $default = null): mixed
     {
@@ -121,13 +136,14 @@ public static function getValueByPath(object|array $array, Closure|string $key,
 
     /**
      * Indexes and/or groups the array according to a specified key.
+     *
      * The input should be either multidimensional array or an array of objects.
      *
-     * The $key can be either a key name of the sub-array, a property name of object, or an anonymous
-     * function that must return the value that will be used as a key.
+     * The $key can be either a key name of the sub-array, a property name of object, or an anonymous function that must
+     * return the value that will be used as a key.
      *
-     * $groups is an array of keys, that will be used to group the input array into one or more sub-arrays based
-     * on keys specified.
+     * $groups is an array of keys, that will be used to group the input array into one or more sub-arrays based on keys
+     * specified.
      *
      * If the `$key` is specified as `null` or a value of an element corresponding to the key is `null` in addition
      * to `$groups` not specified then the element is discarded.
@@ -195,16 +211,19 @@ public static function getValueByPath(object|array $array, Closure|string $key,
      * ]
      * ```
      *
-     * @param array[] $array the array that needs to be indexed or grouped
-     * @param string|null $key the column name or anonymous function which result will be used to index the array
-     * @param string[] $groups the array of keys, that will be used to group the input array
-     * by one or more keys. If the $key attribute or its value for the particular element is null and $groups is not
-     * defined, the array element will be discarded. Otherwise, if $groups is specified, array element will be added
-     * to the result array without any key. This parameter is available since version 2.0.8.
+     * @param array $array The array that needs to be indexed or grouped.
+     * @param string|null $key The column name or anonymous function which result will be used to index the array.
+     * @param array $groups The array of keys, that will be used to group the input array by one or more keys. If the
+     * $key attribute or its value for the particular element is null and $groups is not defined, the array element will
+     * be discarded. Otherwise, if $groups is specified, array element will be added to the result array without any
+     * key.
+     *
+     * @throws Exception
      *
-     * @throws \Exception
+     * @return array The indexed and/or grouped array.
      *
-     * @return array the indexed and/or grouped array
+     * @psalm-param array[] $array The array that needs to be indexed or grouped.
+     * @psalm-param string[] $groups The array of keys, that will be used to group the input array by one or more keys.
      *
      * @psalm-suppress MixedArrayAssignment
      */
@@ -231,10 +250,12 @@ public static function index(array $array, string|null $key = null, array $group
             } else {
                 /** @psalm-var mixed $value */
                 $value = self::getValueByPath($element, $key);
+
                 if ($value !== null) {
                     $lastArray[(string) $value] = $element;
                 }
             }
+
             unset($lastArray);
         }
 
@@ -249,9 +270,9 @@ public static function index(array $array, string|null $key = null, array $group
      *
      * Note that an empty array will NOT be considered associative.
      *
-     * @param array $array the array being checked
+     * @param array $array The array being checked
      *
-     * @return bool whether the array is associative
+     * @return bool Whether the array is associative
      */
     public static function isAssociative(array $array): bool
     {
@@ -271,8 +292,8 @@ public static function isAssociative(array $array): bool
     /**
      * Sorts an array of objects or arrays (with the same structure) by one or several keys.
      *
-     * @param array $array the array to be sorted. The array will be modified after calling this method.
-     * @param string $key the key(s) to be sorted by.
+     * @param array $array The array to be sorted. The array will be modified after calling this method.
+     * @param string $key The key(s) to be sorted by.
      */
     public static function multisort(
         array &$array,
@@ -289,8 +310,10 @@ public static function multisort(
             SORT_ASC,
             SORT_NUMERIC,
 
-            // This fix is used for cases when main sorting specified by columns has equal values
-            // Without it will lead to Fatal Error: Nesting level too deep - recursive dependency?
+            /**
+             * This fix is used for cases when main sorting specified by columns has equal values without it will lead
+             * to Fatal Error: Nesting level too deep - recursive dependency?
+             */
             range(1, count($array)),
             SORT_ASC,
             SORT_NUMERIC,
diff --git a/src/Helper/StringHelper.php b/src/Helper/StringHelper.php
@@ -4,26 +4,40 @@
 
 namespace Yiisoft\Db\Helper;
 
+use function addslashes;
+use function is_float;
+use function mb_strrpos;
+use function mb_strtolower;
+use function mb_substr;
+use function preg_replace;
+use function rtrim;
+use function str_replace;
+use function trim;
+
 final class StringHelper
 {
     /**
      * Returns the trailing name component of a path.
-     * This method is similar to the php function `basename()` except that it will
-     * treat both \ and / as directory separators, independent of the operating system.
-     * This method was mainly created to work on php namespaces. When working with real
-     * file paths, PHP's `basename()` should work fine for you.
+     *
+     * This method is similar to the php function `basename()` except that it will treat both \ and / as directory
+     * separators, independent of the operating system.
+     *
+     * This method was mainly created to work on php namespaces. When working with real file paths, PHP's `basename()`
+     * should work fine for you.
+     *
      * Note: this method is not aware of the actual filesystem, or path components such as "..".
      *
      * @param string $path A path string.
      *
      * @return string The trailing name component of the given path.
      *
-     * @see http://www.php.net/manual/en/function.basename.php
+     * @link http://www.php.net/manual/en/function.basename.php
      */
     public static function baseName(string $path): string
     {
         $path = rtrim(str_replace('\\', '/', $path), '/\\');
         $position = mb_strrpos($path, '/');
+
         if ($position !== false) {
             return mb_substr($path, $position + 1);
         }
@@ -34,14 +48,12 @@ public static function baseName(string $path): string
     /**
      * Returns string representation of a number value without thousands separators and with dot as decimal separator.
      *
-     * @param float|string $value
-     *
-     * @return string
+     * @param float|string $value The number value to be normalized.
      */
     public static function normalizeFloat(float|string $value): string
     {
         if (is_float($value)) {
-            $value = (string)$value;
+            $value = (string) $value;
         }
 
         $value = str_replace([' ', ','], ['', '.'], $value);
@@ -50,8 +62,8 @@ public static function normalizeFloat(float|string $value): string
 
     /**
      * Converts a PascalCase name into an ID in lowercase.
-     * Words in the ID may be concatenated using '_'.
-     * For example, 'PostTag' will be converted to 'post_tag'.
+     *
+     * Words in the ID may be concatenated using '_'. For example, 'PostTag' will be converted to 'post_tag'.
      *
      * @param string $input The string to be converted.
      *
@@ -60,9 +72,7 @@ public static function normalizeFloat(float|string $value): string
     public static function pascalCaseToId(string $input): string
     {
         $separator = '_';
-
         $result = preg_replace('/(?<=\p{L})(?<!\p{Lu})(\p{Lu})/u', addslashes($separator) . '\1', $input);
-
         return mb_strtolower(trim($result, $separator));
     }
 }
