Skip to content

Commit

Permalink
Attempt to remove of Yiisoft/Array depedency (#479)
Browse files Browse the repository at this point in the history 
* Attempt to remove of Yiisoft/Array depedency

* styleci

* styleci

* psalm

* test fix

* remove real test

* fix

* add more tests

* stylec

* Attempt to remove of Yiisoft/Array depedency

* styleci

* styleci

* styleci

* styleci

* fix for float

* add mini test

* add mini test2
  • Loading branch information
@darkdef
darkdef committed Jan 15, 2023
1 parent ec14da3 commit 7f38ec8
Show file tree
Hide file tree
Showing 5 changed files with 555 additions and 3 deletions.
1 change: 0 additions & 1 deletion composer.json
View file
Expand Up @@ -25,7 +25,6 @@
"ext-mbstring": "*",
"ext-pdo": "*",
"psr/log": "^2.0|^3.0",
"yiisoft/arrays": "^2.0",
"yiisoft/cache": "^2.0"
},
"require-dev": {
Expand Down
296 changes: 296 additions & 0 deletions src/Helper/ArrayHelper.php
View file
@@ -0,0 +1,296 @@
<?php

declare(strict_types=1);

namespace Yiisoft\Db\Helper;

use Closure;

/**
* Short implementation of ArrayHelper from Yii2
*/
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,
*
* ```php
* $array = [
* ['id' => '123', 'data' => 'abc'],
* ['id' => '345', 'data' => 'def'],
* ];
* $result = ArrayHelper::getColumn($array, 'id');
* // the result is: ['123', '345']
*
* // using anonymous function
* $result = ArrayHelper::getColumn($array, function ($element) {
* return $element['id'];
* });
* ```
*
* @param array $array
* @param string $name
*
* @return array the list of column values
*/
public static function getColumn(array $array, string $name): array
{
return array_map(
static function (array|object $element) use ($name): mixed {
return static::getValueByPath($element, $name);
},
$array
);
}

/**
* 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
* of an embedded object. In particular, if the key is `x.y.z`, then the returned value would
* be `$array['x']['y']['z']` or `$array->x->y->z` (if `$array` is an object). If `$array['x']`
* or `$array->x` is neither an array nor an object, the default value will be returned.
* Note that if the array already has an element `x.y.z`, then its value will be returned
* instead of going through the sub-arrays. So it is better to be done specifying an array of key names
* like `['x', 'y', 'z']`.
*
* Below are some usage examples,
*
* ```php
* // working with array
* $username = ArrayHelper::getValueByPath($_POST, 'username');
* // working with object
* $username = ArrayHelper::getValueByPath($user, 'username');
* // working with anonymous function
* $fullName = ArrayHelper::getValueByPath($user, function ($user, $defaultValue) {
* return $user->firstName . ' ' . $user->lastName;
* });
* // using dot format to retrieve the property of embedded object
* $street = \yii\helpers\ArrayHelper::getValue($users, 'address.street');
* // using an array of keys to retrieve the value
* $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:
* `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.
*
* @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
{
if ($key instanceof Closure) {
return $key($array, $default);
}

if (is_object($array) && property_exists($array, $key)) {
return $array->$key;
}

if (is_array($array) && array_key_exists($key, $array)) {
return $array[$key];
}

if ($key && ($pos = strrpos($key, '.')) !== false) {
/** @psalm-var array<string, mixed>|object $array */
$array = static::getValueByPath($array, substr($key, 0, $pos), $default);
$key = substr($key, $pos + 1);
}

if (is_object($array)) {
// this is expected to fail if the property does not exist, or __get() is not implemented
// it is not reliably possible to check whether a property is accessible beforehand
return $array->$key;
}

if (array_key_exists($key, $array)) {
return $array[$key];
}

return $default;
}

/**
* 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.
*
* $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.
*
* For example:
*
* ```php
* $array = [
* ['id' => '123', 'data' => 'abc', 'device' => 'laptop'],
* ['id' => '345', 'data' => 'def', 'device' => 'tablet'],
* ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone'],
* ];
* $result = ArrayHelper::index($array, 'id');
* ```
*
* The result will be an associative array, where the key is the value of `id` attribute
*
* ```php
* [
* '123' => ['id' => '123', 'data' => 'abc', 'device' => 'laptop'],
* '345' => ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone']
* // The second element of an original array is overwritten by the last element because of the same id
* ]
* ```
*
* Passing `id` as a third argument will group `$array` by `id`:
*
* ```php
* $result = ArrayHelper::index($array, null, 'id');
* ```
*
* The result will be a multidimensional array grouped by `id` on the first level, by `device` on the second level
* and indexed by `data` on the third level:
*
* ```php
* [
* '123' => [
* ['id' => '123', 'data' => 'abc', 'device' => 'laptop']
* ],
* '345' => [ // all elements with this index are present in the result array
* ['id' => '345', 'data' => 'def', 'device' => 'tablet'],
* ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone'],
* ]
* ]
* ```
*
* The result will be a multidimensional array grouped by `id` on the first level, by the `device` on the second one
* and indexed by the `data` on the third level:
*
* ```php
* [
* '123' => [
* 'laptop' => [
* 'abc' => ['id' => '123', 'data' => 'abc', 'device' => 'laptop']
* ]
* ],
* '345' => [
* 'tablet' => [
* 'def' => ['id' => '345', 'data' => 'def', 'device' => 'tablet']
* ],
* 'smartphone' => [
* 'hgi' => ['id' => '345', 'data' => 'hgi', 'device' => 'smartphone']
* ]
* ]
* ]
* ```
*
* @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.
*
* @throws \Exception
*
* @return array the indexed and/or grouped array
*/
public static function index(array $array, string|null $key = null, array $groups = []): array
{
$result = [];
foreach ($array as $element) {
$lastArray = &$result;

foreach ($groups as $group) {
/** @psalm-var string $value */
$value = static::getValueByPath($element, $group);
if (!array_key_exists($value, $lastArray)) {
$lastArray[$value] = [];
}
$lastArray = &$lastArray[$value];
}

if ($key === null) {
if (!empty($groups)) {
$lastArray[] = $element;
}
} else {
/** @psalm-var mixed $value */
$value = static::getValueByPath($element, $key);
if ($value !== null) {
$lastArray[(string)$value] = $element;
}
}
unset($lastArray);
}

return $result;
}

/**
* Returns a value indicating whether the given array is an associative array.
*
* An array is associative if all its keys are strings.
*
* Note that an empty array will NOT be considered associative.
*
* @param array $array the array being checked
*
* @return bool whether the array is associative
*/
public static function isAssociative(array $array): bool
{
if (empty($array)) {
return false;
}

foreach ($array as $key => $_value) {
if (is_string($key)) {
return true;
}
}

return false;
}

/**
* 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.
*/
public static function multisort(
array &$array,
string $key
): void {
if (empty($array)) {
return;
}

$column = static::getColumn($array, $key);

array_multisort(
$column,
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?
range(1, count($array)),
SORT_ASC,
SORT_NUMERIC,
$array
);
}
}
2 changes: 1 addition & 1 deletion src/Query/Query.php
View file
Expand Up @@ -6,7 +6,6 @@

use Closure;
use Throwable;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Db\Command\CommandInterface;
use Yiisoft\Db\Connection\ConnectionInterface;
use Yiisoft\Db\Exception\Exception;
Expand All @@ -15,6 +14,7 @@
use Yiisoft\Db\Exception\NotSupportedException;
use Yiisoft\Db\Expression\Expression;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\Helper\ArrayHelper;
use Yiisoft\Db\Query\Helper\QueryHelper;
use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;

Expand Down

0 comments on commit 7f38ec8

Please sign in to comment.