Класс Hash

_filter()source protected static

_filter( array $var )

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

Параметры

массив $var

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

Возвращаемое значение

boolean

_matchToken()source protected static

_matchToken( string $key , string $token )

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

Параметры

строка $key

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

строка $token

Токен, на который проверяется соответствие.

Возвращаемое значение

boolean

_matches()source protected static

_matches( array $data , string $selector )

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

Параметры

массив $data

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

строка $selector

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

Возвращаемое значение

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

_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 $key null )

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

Параметры

массив $data

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

строка $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

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

Возвращает

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

check()source public static

check( array $data , string $path )

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

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

Параметры

массив $data

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

строка $path

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

Возвращает

булево
Существование пути.

См. также

Hash::extract()

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::check

combine()source public static

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

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

Параметры

массив $data

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

строка $keyPath

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

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

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

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

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

Возвращает

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

Выбрасывает

CakeException
CakeException При неравном количестве ключей и значений.

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::combine

contains()source public static

contains( array $data , array $needle )

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

Параметры

массив $data

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

массив $needle

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

Возвращает

булево
true, если $data содержит $needle, иначе false

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::contains

diff()source public static

diff( array $data , array $compare )

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

Параметры

массив $data

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

массив $compare

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

Возвращает

массив

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::diff

dimensions()source public static

dimensions( array $data )

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

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

Параметры

массив $data

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

Возвращает

целое число
Число измерений в $data

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::dimensions

expand()source public static

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

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

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

Параметры

массив $data

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

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

Разделитель

Возвращает

массив

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::expand

extract()source public static

extract( array $data , string $path )

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

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

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

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

В данном примере с данными пользователей из вызова $User->find('all'):

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

Параметры

массив $data

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

строка $path

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

Возвращает

массив

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::extract

filter()source public static

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

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

Параметры

массив $data

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

обратный вызов $callback необязательно array('self', '_filter')

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::filter

flatten()source public static

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

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

Параметры

массив $data

Массив для преобразования

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

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

Возвращает

массив

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::flatten

format()source public static

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

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

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

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

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

Параметры

массив $data

Исходный массив, из которого извлекаются данные

массив $paths

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

строка $format

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::format
http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::format

См. также

sprintf()
Hash::extract()

get()source public static

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

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

Параметры

массив $data

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

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

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

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

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

Возвращает

смешанное
Извлеченное из массива значение или null.

Исключения

InvalidArgumentException

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::get

insert()source public static

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

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

Параметры

массив $data

Данные, которые нужно вставить.

строка $path

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

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::insert

map()source public static

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

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

Параметры

массив $data

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

строка $path

Путь для извлечения данных для применения.

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::map

maxDimensions()source public static

maxDimensions( array $data )

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

Параметры

массив $data

Массив, размерность которого нужно посчитать.

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::merge

mergeDiff()source public static

mergeDiff( array $data , array $compare )

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

Параметры

массив $data

Данные, к которым нужно добавить.

массив $compare

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::mergeDiff

nest()source public static

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

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

Параметры:

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

Параметры

массив $data

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

массив $options необязательно array()

Параметры:

Возвращает

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

Исключения

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

См. также

Hash::extract()

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::nest

normalize()source public static

normalize( array $data , boolean $assoc true )

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

Параметры

массив $data

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

логическое значение $assoc необязательно true

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

Возвращает

массив

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::normalize

numeric()source public static

numeric( array $data )

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

Параметры

массив $data

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::numeric

reduce()source public static

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

Сокращает набор извлеченных значений, используя $function.

Параметры

массив $data

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

строка $path

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

вызываемая функция $function

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

Возвращает

mixed
Значение после сокращения.

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::reduce

remove()source public static

remove( array $data , string $path )

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

Параметры

массив $data

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

строка $path

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::remove

sort()source public static

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

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

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

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

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

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

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

array('type' => 'regular', 'ignoreCase' => true)

При использовании массива, type по умолчанию равен 'обычной'. Параметр ignoreCase по умолчанию равен false.

Параметры

массив $data

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

строка $path

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

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

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

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

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

Возвращает

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

Ссылка

http://book.cakephp.org/2.0/ru/core-utility-libraries/hash.html#Hash::sort