Класс Hash

_filter()source protected static

_filter( mixed $var )

Функция обратного вызова для фильтрации.

Параметры

mixed $var

Массив для фильтрации.

Возвращает

boolean

_matchToken()source protected static

_matchToken( string $key , string $token )

Проверка ключа на соответствие токену.

Параметры

string $key

Ключ в массиве, который ищется.

string $token

Токен для сопоставления.

Возвращает

boolean

_matches()source protected static

_matches( array|ArrayAccess $data , string $selector )

Проверяет, соответствует ли $data заданным шаблонам атрибутов

Параметры

array|ArrayAccess $data

Массив данных для проверки.

string $selector

Шаблоны для проверки.

Возвращает

boolean
Соответствие выражению.

_merge()source protected static

_merge( array $stack , array $return )

Вспомогательная функция для слияния, для сокращения дублирования кода между merge() и expand().

Параметры

array $stack

Стек операций для обработки.

array $return

Возвращаемое значение для обработки.

_simpleOp()source protected static

_simpleOp( string $op , array $data , array $path , mixed $values null )

Выполнить простое операцию вставки/удаления.

Параметры

строка $op

Операция, которую нужно выполнить.

массив $data

Данные, над которыми нужно выполнить операцию.

массив $path

Путь для работы.

смешанный $values необязательный null

Значения для вставки при выполнении вставки.

Возвращает

массив
данные.

_splitConditions()source protected static

_splitConditions( string $token )

Разделить условия токена

Параметры

строка $token

разделяемый токен.

Возвращает

массив
[токен, условия] с разделенным токеном

_squash()source protected static

_squash( array $data , string|null $key null )

Вспомогательный метод для sort(). Сжимает массив в один хеш, чтобы его можно было отсортировать.

Параметры

массив $data

Данные для сжатия.

строка|null $key необязательный null

Ключ для данных.

Возвращает

массив

apply()source public static

apply( array $data , string $path , callable $function )

Применить обратный вызов к набору извлеченных значений, используя $function. Функция получит извлеченные значения в качестве первого аргумента.

Пример

Вы можете легко подсчитать результаты извлечения, используя apply(). Например, чтобы подсчитать комментарии к статье:

$count = Hash::apply($data, 'Article.Comment.{n}', 'count');

Вы также можете использовать функцию, например array_sum, чтобы просуммировать результаты.

$total = Hash::apply($data, '{n}.Item.price', 'array_sum');

Параметры

массив $data

Данные для обработки.

строка $path

Путь для извлечения из $data.

вызываемый объект $function

Функция, которая должна быть вызвана для каждого извлеченного значения.

Возвращает

смешанный
Результаты примененного метода.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::apply

check()source public static

check( array $data , string $path )

Проверить, существует ли заданный путь в $data. Этот метод использует тот же синтаксис пути, что и Hash::extract().

Проверка путей, которые могут указывать на несколько элементов, гарантирует, что существует хотя бы один соответствующий элемент.

Параметры

массив $data

Данные для проверки.

строка $path

Путь для проверки.

Возвращает

логическое
Существование пути.

См. также

\Cake\Utility\Hash::extract()

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::check

combine()source public static

combine( array $data , string $keyPath , string|null $valuePath null , string|null $groupPath null )

Создает ассоциативный массив, используя $keyPath в качестве пути для построения ключей и, необязательно, $valuePath в качестве пути для получения значений. Если $valuePath не указан, все значения будут инициализированы как null (полезно для Hash::merge). Вы можете дополнительно сгруппировать значения в зависимости от того, что получается при следование пути, указанному в $groupPath.

Параметры

массив $data

Массив, из которого извлекаются ключи и значения.

строка $keyPath

Строка, разделенная точками.

строка|null $valuePath необязательный null

Строка, разделенная точками.

строка|null $groupPath необязательный null

Строка, разделенная точками.

Возвращает

массив
Комбинированный массив

Исключение

RuntimeException
Когда количество ключей и значений не совпадает.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::combine

contains()source public static

contains( array $data , array $needle )

Определяет, содержит ли один массив точные ключи и значения другого.

Параметры

массив $data

Данные для поиска.

массив $needle

Значения для поиска в $data.

Возвращает

логическое
true, если $data содержит $needle, иначе false

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::contains

diff()source public static

diff( array $data , array $compare )

Вычисляет разницу между двумя сложными массивами. Этот метод отличается от встроенной функции array_diff() тем, что сохраняет ключи и работает с многомерными массивами.

Параметры

массив $data

Первое значение.

массив $compare

Второе значение.

Возвращает

массив

Возвращает пары ключ => значение, которые не являются общими в $data и $compare. Выражение для этой функции: ($data - $compare) + ($compare - ($data - $compare)).

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::diff

dimensions()source public static

dimensions( array $data )

Подсчитывает размерности массива. Учитывает только размерность первого элемента массива.

Если у вас неравномерный или неоднородный массив, воспользуйтесь Hash::maxDimensions() для получения размерностей массива.

Параметры

массив $data

Массив для подсчета размерностей.

Возвращает

целое число
Количество размерностей в $data

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::dimensions

expand()source public static

expand( array $data , string $separator '.' )

Развертывает плоский массив в вложенный массив.

Например, распаковывает массив, который был свернут с помощью Hash::flatten() в многомерный массив. Таким образом, ['0.Foo.Bar' => 'Far'] становится [['Foo' => ['Bar' => 'Far']]].

Параметры

массив $data

Плоский массив.

строка $separator необязательный '.'

Разделитель.

Возвращает

массив

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::expand

extract()source public static

extract( array|ArrayAccess $data , string $path )

Получает значения из массива, соответствующие выражению $path. Выражение пути – это выражение, разделенное точками, которое может содержать набор шаблонов и выражений:

• {n} Сопоставляет любой числовой ключ или целое число.
• {s} Сопоставляет любой строковый ключ.
• {*} Сопоставляет любое значение.
• Foo Сопоставляет любой ключ с точным значением.

Существует ряд операторов атрибутов:

• =, != Равенство.
• >, <, >=, <= Сравнение значений.
• =/.../ Сопоставление с шаблоном регулярного выражения.

Учитывая набор данных пользователя в массиве, полученный из $User->find('all'):

• 1.User.name Получить имя пользователя в индексе 1.
• {n}.User.name Получить имя каждого пользователя в наборе пользователей.
• {n}.User[id].name Получить имя каждого пользователя с ключом id.
• {n}.User[id>=2].name Получить имя каждого пользователя с ключом id, большим или равным 2.
• {n}.User[username=/^paul/] Получить элементы пользователя с именем пользователя, соответствующим ^paul.
• {n}.User[id=1].name Получить имя пользователя с id, соответствующим 1.

Параметры

массив|ArrayAccess $data

Данные для извлечения.

строка $path

Путь для извлечения.

Возвращает

массив|ArrayAccess

Массив извлеченных значений. Возвращает пустой массив, если совпадений нет.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::extract

filter()source public static

filter( array $data , callable|array $callback ['self', '_filter'] )

Рекурсивно фильтрует набор данных.

Параметры

массив $data

Массив для фильтрации или значение при использовании обратного вызова

вызываемый объект/массив $callback необязательно ['self', '_filter']

Функция для фильтрации данных. По умолчанию static::_filter() , которая удаляет все непустые значения, отличные от нуля.

Возвращает

массив
Отфильтрованный массив

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::filter

flatten()source public static

flatten( array $data , string $separator '.' )

Сжимает многомерный массив в одномерный, используя разделитель для пути к ключу каждого элемента массива, т.е. [['Foo' => ['Bar' => 'Far']]] преобразуется в ['0.Foo.Bar' => 'Far'].

Параметры

массив $data

Массив для сжатия

строка $separator необязательно '.'

Строка, используемая для разделения элементов ключа массива в пути, по умолчанию '.'

Возвращает

массив

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::flatten

format()source public static

format( array $data , array $paths , string $format )

Возвращает отформатированный ряд значений, извлечённых из $data, используя $format в качестве формата и $paths в качестве значений для извлечения.

Использование:

$result = Hash::format($users, ['{n}.User.id', '{n}.User.name'], '%s : %s');

Строка $format может использовать любые параметры форматирования, поддерживаемые vsprintf() и sprintf().

Параметры

массив $data

Исходный массив для извлечения данных

массив $paths

Массив, содержащий один или несколько путей ключей в стиле Hash::extract()

строка $format

Строка формата, в которую будут вставлены значения, см. sprintf()

Возвращает

массив|null
Массив строк, извлечённых из $path и отформатированных с помощью $format

См. также

sprintf()
\Cake\Utility\Hash::extract()

get()source public static

get( array|ArrayAccess $data , string|array $path , mixed $default null )

Получает единственное значение, заданное $path, из $data. Не поддерживает полный функционал записи в стиле точки, но быстрее при простых операциях чтения.

Параметры

массив|ArrayAccess $data

Массив данных или объект, реализующий интерфейс \ArrayAccess для работы.

строка|массив $path

Путь, ищущийся. Может быть строкой с разделителями точек или массивом фрагментов пути.

смешанный $default необязательно null

Значение, возвращаемое, когда путь не существует

Возвращает

смешанный
Значение, извлечённое из массива, или null.

Исключения

InvalidArgumentException

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::get

insert()source public static

insert( array $data , string $path , array|null $values null )

Вставляет $values в массив по заданному $path. Вы можете использовать элементы {n} и {s} для вставки $data несколько раз.

Параметры

массив $data

Данные для вставки.

строка $path

Путь для вставки.

массив|null $values необязательно null

Значения для вставки.

Возвращает

массив
Данные с вставленными $values.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::insert

map()source public static

map( array $data , string $path , callable $function )

Применяет обратный вызов ко всем элементам набора. Может быть предоставлен путь, чтобы изменить только части набора.

Параметры

массив $data

Данные для обработки, из которых извлекаются данные.

строка $path

Путь для извлечения данных для обработки.

вызываемый объект $function

Функция, вызываемая для каждого извлечённого значения.

Возвращает

массив
Массив изменённых значений.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::map

maxDimensions()source public static

maxDimensions( array $data )

Подсчитывает размерности всех элементов массива. Полезно для поиска максимального числа размерностей в смешанном массиве.

Параметры

массив $data

Массив для подсчёта размерностей

Возвращает

целое число
Максимальное число размерностей в $data

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::maxDimensions

merge()source public static

merge( array $data , mixed $merge )

Эта функция можно представить как гибрид между PHP's array_merge и array_merge_recursive.

Разница между этим методом и встроенными методами заключается в том, что если ключ массива содержит другой массив, то Hash::merge() будет работать рекурсивно (в отличие от array_merge). Но он не будет работать рекурсивно для ключей, содержащих скалярные значения (в отличие от array_merge_recursive).

Примечание: эта функция может принимать неограниченное количество аргументов и преобразует не массивы аргументы в массивы при слиянии.

Параметры

массив $data

Массив для слияния

смешанный $merge

Массив для слияния. Аргумент и все последующие аргументы будут преобразованы в массивы при слиянии

Возвращает

массив
Объединённый массив

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::merge

mergeDiff()source public static

mergeDiff( array $data , array $compare )

Объединяет разницу между $data и $compare в $data.

Параметры

массив $data

Данные для добавления.

массив $compare

Данные для сравнения и добавления.

Возвращает

массив
Объединённый массив.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::mergeDiff

nest()source public static

nest( array $data , array $options [] )

Принимает плоский массив и возвращает вложенный массив

Параметры:

• children Имя ключа для использования в результирующем наборе для дочерних элементов.
• idPath Путь к ключу, идентифицирующему каждый элемент. Должен быть совместим с Hash::extract(). По умолчанию {n}.$alias.id
• parentPath Путь к ключу, идентифицирующему родителя каждого элемента. Должен быть совместим с Hash::extract(). По умолчанию {n}.$alias.parent_id
• root Идентификатор желаемого верхнего результата.

Параметры

массив $data

Данные для вложения.

массив $options необязательно []

Параметры:

Возвращает

массив
результатов, вложенных

Исключения

InvalidArgumentException
При предоставлении некорректных данных.

См. также

\Cake\Utility\Hash::extract()

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::nest

normalize()source public static

normalize( array $data , boolean $assoc true )

Нормализует массив и преобразует его в стандартный формат.

Параметры

массив $data

Список для нормализации

булево значение $assoc необязательно true

Если true, $data будет преобразован в ассоциативный массив.

Возвращает

массив

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::normalize

numeric()source public static

numeric( array $data )

Проверяет, являются ли все значения в массиве числовыми.

Параметры

массив $data

Массив для проверки.

Возвращает

boolean
true, если значения являются числовыми, иначе false

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::numeric

reduce()source public static

reduce( array $data , string $path , callable $function )

Сведение набора извлечённых значений с использованием $function.

Параметры

массив $data

Данные для сведения.

строка $path

Путь для извлечения из $data.

обратный вызов $function

Функция для вызова для каждого извлечённого значения.

Возвращает

смешанное
Сведённое значение.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::reduce

remove()source public static

remove( array $data , string $path )

Удаление данных, соответствующих $path, из массива $data. Можно использовать {n} и {s} для удаления нескольких элементов из $data.

Параметры

массив $data

Данные для обработки

строка $path

Выражение пути для удаления.

Возвращает

массив
Изменённый массив.

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::remove

sort()source public static

sort( array $data , string $path , string $dir 'asc' , array|string $type 'regular' )

Сортирует массив по любому значению, определяемому путем, совместимым с набором.

Направления сортировки

• asc Сортировка по возрастанию.
• desc Сортировка по убыванию.

Типы сортировки

• regular Для обычной сортировки (не изменять типы)
• numeric Сравнивать значения численно
• string Сравнивать значения как строки
• locale Сравнивать элементы как строки, основываясь на текущем языке
• natural Сравнивать элементы как строки с использованием "естественного упорядочения" удобным для человека способом. Например, отсортирует foo10 ниже foo2.

Для выполнения сортировки без учёта регистра, передайте тип как массив следующим образом:

Hash::sort($data, 'some.attribute', 'asc', ['type' => 'regular', 'ignoreCase' => true]);

При использовании массива, type по умолчанию равен 'regular'. Опция ignoreCase по умолчанию false.

Параметры

массив $data

Массив данных для сортировки

строка $path

Путь, совместимый с набором, к значению массива

строка $dir необязательно 'asc'

См. направления выше. По умолчанию 'asc'.

массив|строка $type необязательно 'regular'

См. типы направлений выше. По умолчанию 'regular'.

Возвращает

массив
Отсортированный массив данных

Ссылка

https://book.cakephp.org/3.0/ru/core-libraries/hash.html#Cake\Utility\Hash::sort