Класс Hash

_filter()source защищённый статический

_filter( array $var )

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

Параметры

массив $var

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

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

boolean

_matchToken()source защищённый статический

_matchToken( string $key , string $token )

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

Параметры

строка $key

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

строка $token

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

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

boolean

_matches()source защищённый статический

_matches( array $data , string $selector )

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

Параметры

массив $data

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

строка $selector

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

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

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

_simpleOp()source защищённый статический

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

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

Параметры

строка $op

Тип операции.

массив $data

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

массив $path

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

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

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

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

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

_splitConditions()source защищённый статический

_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. Функция получит извлечённые значения в качестве первого аргумента.

Пример

Вы можете легко посчитать результаты extract, используя 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 из вызова $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 '.' )

Преобразует многомерный массив в одномерный, используя разделитель для ключей элементов массива, например, array(array('Foo' => array('Bar' => 'Far'))) преобразуется в array('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

Данные, над которыми нужно выполнить map, и из которых нужно извлечь данные.

строка $path

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

вызываемый $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

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

Возвращает

смешанный тип
Сокращенное значение.

Ссылка

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