Fr3nch13/CakePHP Utilities

Hash

in package

• Application

Library of array functions for manipulating and extracting data from arrays or 'sets' of data.

Tags

link

https://book.cakephp.org/4/en/core-libraries/hash.html

Table of Contents

Methods

apply()  : mixed

Apply a callback to a set of extracted values using `$function`.

check()  : bool

Test whether a given path exists in $data.

combine()  : array<string|int, mixed>

Creates an associative array using `$keyPath` as the path to build its keys, and optionally `$valuePath` as path to get the values. If `$valuePath` is not specified, all values will be initialized to null (useful for Hash::merge). You can optionally group the values by what is obtained when following the path specified in `$groupPath`.

contains()  : bool

Determines if one array contains the exact keys and values of another.

diff()  : array<string|int, mixed>

Computes the difference between two complex arrays.

dimensions()  : int

Counts the dimensions of an array.

expand()  : array<string|int, mixed>

Expands a flat array to a nested array.

extract()  : ArrayAccess|array<string|int, mixed>

Gets the values from an array matching the $path expression.

filter()  : array<string|int, mixed>

Recursively filters a data set.

flatten()  : array<string|int, mixed>

Collapses a multi-dimensional array into a single dimension, using a delimited array path for each array element's key, i.e. [['Foo' => ['Bar' => 'Far']]] becomes ['0.Foo.Bar' => 'Far'].)

format()  : array<string|int, string>|null

Returns a formatted series of values extracted from `$data`, using `$format` as the format and `$paths` as the values to extract.

get()  : mixed

Get a single value specified by $path out of $data.

insert()  : array<string|int, mixed>

Insert $values into an array with the given $path. You can use `{n}` and `{s}` elements to insert $data multiple times.

map()  : array<string|int, mixed>

Map a callback across all elements in a set.

maxDimensions()  : int

Counts the dimensions of *all* array elements. Useful for finding the maximum number of dimensions in a mixed array.

merge()  : array<string|int, mixed>

This function can be thought of as a hybrid between PHP's `array_merge` and `array_merge_recursive`.

mergeDiff()  : array<string|int, mixed>

Merges the difference between $data and $compare onto $data.

nest()  : array<string|int, array<string|int, mixed>>

Takes in a flat array and returns a nested array

normalize()  : array<string|int, mixed>

Normalizes an array, and converts it to a standard format.

numeric()  : bool

Checks to see if all the values in the array are numeric

reduce()  : mixed

Reduce a set of extracted values using `$function`.

remove()  : array<string|int, mixed>

Remove data matching $path from the $data array.

sort()  : array<string|int, mixed>

Sorts an array by any value, determined by a Set-compatible path

_filter()  : bool

Callback function for filtering.

_matches()  : bool

Checks whether $data matches the attribute patterns

_matchToken()  : bool

Check a key against a token.

_merge()  : void

Merge helper function to reduce duplicated code between merge() and expand().

_simpleOp()  : array<string|int, mixed>

Perform a simple insert/remove operation.

_splitConditions()  : array<string|int, mixed>

Split token conditions

_squash()  : array<string|int, mixed>

Helper method for sort() Squashes an array to a single hash so it can be sorted.

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

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

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

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