yii\helpers\BaseArrayHelper::getValue PHP Метод

Документация по классу BaseArrayHelper Показать файл Открыть проект

getValue() публичный статический Метод

If the key does not exist in the array or object, the default value will be returned instead. 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 = \yii\helpers\ArrayHelper::getValue($_POST, 'username'); working with object $username = \yii\helpers\ArrayHelper::getValue($user, 'username'); working with anonymous function $fullName = \yii\helpers\ArrayHelper::getValue($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']);

public static getValue ( array \| object $array, string \| Closure \| array $key, mixed $default = null ) : mixed
$array	array \| object	array or object to extract value from
$key	string \| Closure \| array	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.
$default	mixed	the default value to be returned if the specified array key does not exist. Not used when getting value from an object.
Результат	mixed	the value of the element if found, default value otherwise

    public static function getValue($array, $key, $default = null)
    {
        if ($key instanceof \Closure) {
            return $key($array, $default);
        }
        if (is_array($key)) {
            $lastKey = array_pop($key);
            foreach ($key as $keyPart) {
                $array = static::getValue($array, $keyPart);
            }
            $key = $lastKey;
        }
        if (is_array($array) && (isset($array[$key]) || array_key_exists($key, $array))) {
            return $array[$key];
        }
        if (($pos = strrpos($key, '.')) !== false) {
            $array = static::getValue($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};
        } elseif (is_array($array)) {
            return isset($array[$key]) || array_key_exists($key, $array) ? $array[$key] : $default;
        } else {
            return $default;
        }
    }

BaseArrayHelper

filter

getColumn

getValue

htmlDecode

htmlEncode

index

isAssociative

isIn

isIndexed

isSubset

isTraversable

keyExists

map

merge

multisort

remove

removeValue

toArray