Append an item to array.
", "summaryRaw": "Append an item to array.", "description": "Usage
\n__::append([1, 2, 3], 4);Result
\n[1, 2, 3, 4]Creates an array of elements split into groups the length of $size.
If array can't be split evenly, the final chunk will be the remaining\nelements. When $preserveKeys is set to TRUE, keys will be preserved.\nDefault is FALSE, which will reindex the chunk numerically.
Usage
\n__::chunk([1, 2, 3, 4, 5], 3);Result
\n[[1, 2, 3], [4, 5]]When given a \\Traversable object for $iterable, a generator will be returned.\nOtherwise, an array will be returned.
Creates an array with all falsey values removed.
", "summaryRaw": "Creates an array with all falsey values removed.", "description": "The following values are considered falsey:
\nfalsenull0\"\"undefinedNaNUsage
\n__::compact([0, 1, false, 2, '', 3]);Result
\n[1, 2, 3]Creates a slice of array with n elements dropped from the beginning.
", "summaryRaw": "Creates a slice of array with n elements dropped from the beginning.", "description": "Usage
\n__::drop([0, 1, 3, 5], 2);Result
\n[3, 5]Creates a slice of an array with n elements dropped from the end.
", "summaryRaw": "Creates a slice of an array with n elements dropped from the end.", "description": "If the provided iterator is an array, then an array will be returned.\nOtherwise, a Generator will be returned. In this latter case, the entire\niterable will be buffered in memory. If the iterable contains many\nelements, then this could cause memory issues.
\nUsage
\n__::dropRight([0, 1, 3, 5], 2);Result
\n[0, 1]An array containing a subset of the input array with front items matching the condition\nremoved. If the provided iterable is not an array, then a Generator will be returned.
" } }, { "name": "dropRightWhile", "namespace": "arrays", "summary": "Creates a slice of the provided array with all elements matching the condition\nremoved from the end.
", "summaryRaw": "Creates a slice of the provided array with all elements matching the condition\nremoved from the end.", "description": "If the provided iterator is an array, then an array will be returned.\nOtherwise, a Generator will be returned. In this latter case, the entire\niterable will be buffered in memory. If the iterable contains many\nelements, then this could cause memory issues.
\nDrop by Primitive Condition
\n__::dropRightWhile([1, 2, 3, 3], 3);Result
\n[1, 2]Drop by Callback
\n__::dropRightWhile([1, 2, 3, 4, 5], static function ($item) {
\n return $item > 3;
\n});Result
\n[1, 2, 3]An array containing a subset of the input array with front items matching the condition\nremoved. If the provided iterable is not an array, then a Generator will be returned.
" } }, { "name": "dropWhile", "namespace": "arrays", "summary": "Creates a slice of the provided array with all elements matching the condition\nremoved from the front.
", "summaryRaw": "Creates a slice of the provided array with all elements matching the condition\nremoved from the front.", "description": "Drop by Primitive Condition
\n__::dropWhile([1, 1, 2, 3, 4], 1);Result
\n[2, 3, 4]Drop by Callback
\n__::dropWhile([1, 2, 3, 4, 5], static function ($item) {
\n return $item < 3;
\n});Result
\n[3, 4, 5]An array containing a subset of the input array with front\nitems matching the condition removed. If the input was not an array, then a \\Generator\nwill be returned.
" } }, { "name": "flatten", "namespace": "arrays", "summary": "Flattens a multidimensional array or iterable.
", "summaryRaw": "Flattens a multidimensional array or iterable.", "description": "If $shallow is set to TRUE, the array will only be flattened a single level.
Usage
\n__::flatten([1, 2, [3, [4]]], false);Result
\n[1, 2, 3, 4]Patches array by xpath.
", "summaryRaw": "Patches array by xpath.", "description": "Usage
\n__::patch(
\n [
\n 'addr' => [
\n 'country' => 'US',
\n 'zip' => 12345
\n ]
\n ],
\n [
\n '/addr/country' => 'CA',
\n '/addr/zip' => 54321
\n ]
\n);Result
\n['addr' => ['country' => 'CA', 'zip' => 54321]]Returns patched array
" } }, { "name": "prepend", "namespace": "arrays", "summary": "Prepend item or value to an array.
", "summaryRaw": "Prepend item or value to an array.", "description": "Usage
\n__::prepend([1, 2, 3], 4);Result
\n[4, 1, 2, 3]Shuffle an array ensuring no item remains in the same position.
", "summaryRaw": "Shuffle an array ensuring no item remains in the same position.", "description": "Usage
\n__::randomize([1, 2, 3]);Result
\n[2, 3, 1]Generate range of values based on start, end, and step.
", "summaryRaw": "Generate range of values based on start, end, and step.", "description": "Usage
\n__::range(1, 10, 2);Result
\n[1, 3, 5, 7, 9]range of values
" } }, { "name": "repeat", "namespace": "arrays", "summary": "Generate array of repeated values.
", "summaryRaw": "Generate array of repeated values.", "description": "Usage
\n__::repeat('foo', 3);Result
\n['foo', 'foo', 'foo']Returns a new array of filled values.
" } }, { "name": "assign", "namespace": "collections", "summary": "Combines and merge collections provided with each others.
", "summaryRaw": "Combines and merge collections provided with each others.", "description": "If the collections have common keys, then the last passed keys override the\nprevious. If numerical indexes are passed, then last passed indexes override\nthe previous.
\nFor a recursive merge, see __::merge().
Usage
\n__::assign(
\n [
\n 'color' => [
\n 'favorite' => 'red',
\n 5
\n ],
\n 3
\n ],
\n [
\n 10,
\n 'color' => [
\n 'favorite' => 'green',
\n 'blue'
\n ]
\n ]
\n);Result
\n[
\n 'color' => ['favorite' => 'green', 'blue'],
\n 10
\n]Assigned collection.
" } }, { "name": "concat", "namespace": "collections", "summary": "Combines and concat collections provided with each others.
", "summaryRaw": "Combines and concat collections provided with each others.", "description": "If the collections have common keys, then the values are appended in an array.\nIf numerical indexes are passed, then values are appended.
\nFor a recursive merge, see __::merge().
Usage
\n__::concat(
\n ['color' => ['favorite' => 'red', 5], 3],
\n [10, 'color' => ['favorite' => 'green', 'blue']]
\n);Result
\n[
\n 'color' => ['favorite' => ['green'], 5, 'blue'],
\n 3,
\n 10
\n]If the first argument given to this function is an\n\\stdClass, an \\stdClass will be returned. Otherwise, an array will be\nreturned.
Recursively combines and concat collections provided with each others.
", "summaryRaw": "Recursively combines and concat collections provided with each others.", "description": "If the collections have common keys, then the values are appended in an array.\nIf numerical indexes are passed, then values are appended.
\nFor a non-recursive concat, see __::concat().
Usage
\n__::concatDeep(
\n ['color' => ['favorite' => 'red', 5], 3],
\n [10, 'color' => ['favorite' => 'green', 'blue']]
\n);Result
\n[
\n 'color' => [
\n 'favorite' => ['red', 'green'],
\n 5,
\n 'blue'
\n ],
\n 3,
\n 10
\n]A concatenated collection. When the first argument given\nis an \\stdClass, then resulting value will be an \\stdClass. Otherwise,\nan array will always be returned.
Iterate over elements of the collection and invokes iteratee for each element.
", "summaryRaw": "Iterate over elements of the collection and invokes iteratee for each element.", "description": "The iteratee is invoked with three arguments: (value, index|key, collection).\nIteratee functions may exit iteration early by explicitly returning false.
\nUsage
\n__::doForEach([1, 2, 3], function ($value, $key, $collection) {
\n print_r($value)
\n});Result
\n(Side effect: print 1, 2, 3)Iterate over elements of the collection, from right to left, and invokes iteratee\nfor each element.
", "summaryRaw": "Iterate over elements of the collection, from right to left, and invokes iteratee\nfor each element.", "description": "The iteratee is invoked with three arguments: (value, index|key, collection).\nIteratee functions may exit iteration early by explicitly returning false.
\nUsage
\n__::doForEachRight([1, 2, 3], function ($value, $key, $collection) {
\n print_r($value);
\n});Result
\n(Side effect: print 3, 2, 1)Flattens a complex collection by mapping each ending leafs value to a key\nconsisting of all previous indexes.
", "summaryRaw": "Flattens a complex collection by mapping each ending leafs value to a key\nconsisting of all previous indexes.", "description": "Usage
\n__::ease([
\n 'foo' => ['bar' => 'ter'],
\n 'baz' => ['b', 'z']
\n]);Result
\n[
\n 'foo.bar' => 'ter',
\n 'baz.0' => 'b',
\n 'baz.1' => 'z'
\n]flatten collection
" } }, { "name": "every", "namespace": "collections", "summary": "Checks if predicate returns truthy for all elements of collection.
", "summaryRaw": "Checks if predicate returns truthy for all elements of collection.", "description": "Iteration is stopped once predicate returns falsey.
\nUsage
\n__::every([1, 3, 4], function ($value, $key, $collection) {
\n return is_int($v);
\n});Result
\ntrueReturns the values in the collection that pass the truth test.
", "summaryRaw": "Returns the values in the collection that pass the truth test.", "description": "When $closure is set to null, this function will automatically remove falsey\nvalues. When $closure is given, then values where the closure returns false\nwill be removed.
Usage
\n$a = [
\n ['name' => 'fred', 'age' => 32],
\n ['name' => 'maciej', 'age' => 16]
\n];
\n
\n__::filter($a, function($n) {
\n return $n['age'] > 24;
\n});Result
\n[['name' => 'fred', 'age' => 32]]When given a \\Traversable object for $iterable, a generator will be returned.\nOtherwise, an array will be returned.
Return the first element that matches the given condition or $returnValue if no value is found (defaults to null).
Find by Primitive Condition in Array
\n$data = [
\n \"table\" => \"trick\",
\n \"pen\" => \"defend\",
\n \"motherly\" => \"wide\",
\n \"may\" => \"needle\",
\n \"sweat\" => \"cake\",
\n \"sword\" => \"defend\",
\n];
\n
\n__::find($data, \"defend\");Result
\n\"defend\"Find by Callback in an Array
\n$data = [
\n \"table\" => (object)[\"name\" => \"trick\"],
\n \"pen\" => (object)[\"name\" => \"defend\"],
\n \"motherly\" => (object)[\"name\" => \"wide\"],
\n \"may\" => (object)[\"name\" => \"needle\"],
\n \"sweat\" => (object)[\"name\" => \"cake\"],
\n \"sword\" => (object)[\"name\" => \"defend\"],
\n];
\n
\n__::find($data, static function ($object, $key, $collection) {
\n return $object->name === \"defend\";
\n});Result
\n$data[\"pen\"]The entity from the iterable. If no value is found, $returnValue is returned, which defaults to\nnull.
Find the first key/value pair of a given element that matches the given condition or null if no match is found.
", "summaryRaw": "Find the first key/value pair of a given element that matches the given condition or null if no match is found.", "description": "Find by Primitive Condition in Array
\n$data = [
\n \"table\" => \"trick\",
\n \"pen\" => \"defend\",
\n \"motherly\" => \"wide\",
\n \"may\" => \"needle\",
\n \"sweat\" => \"cake\",
\n \"sword\" => \"defend\",
\n];
\n
\n__::findEntry($data, \"defend\");Result
\n[\"pen\", \"defend\"]Find by Callback in an Array
\n$data = [
\n \"table\" => (object)[\"name\" => \"trick\"],
\n \"pen\" => (object)[\"name\" => \"defend\"],
\n \"motherly\" => (object)[\"name\" => \"wide\"],
\n \"may\" => (object)[\"name\" => \"needle\"],
\n \"sweat\" => (object)[\"name\" => \"cake\"],
\n \"sword\" => (object)[\"name\" => \"defend\"],
\n];
\n
\n__::findEntry($data, static function ($object, $key, $collection) {
\n return $object->name === \"defend\";
\n});Result
\n[\"pen\", $data[\"pen\"]]An array with two values, the 0th index is the key and the 1st index is the value. Null is\nreturned if no entries can be found in the given collection.
" } }, { "name": "findIndex", "namespace": "collections", "summary": "Return the index or key of the first element that matches the given condition or $returnValue if no value is\nfound (defaults to -1).
Find Index by Primitive Condition in a Numerically Indexed Array
\n$data = [
\n \"native\",
\n \"pale\",
\n \"explain\",
\n \"persuade\",
\n \"elastic\",
\n \"explain\",
\n];
\n
\n__::findIndex($data, \"explain\")Result
\n2Find Index by Primitive Condition in an Associative Array
\n$data = [
\n \"table\" => \"trick\",
\n \"pen\" => \"defend\",
\n \"motherly\" => \"wide\",
\n \"may\" => \"needle\",
\n \"sweat\" => \"cake\",
\n \"sword\" => \"defend\",
\n];
\n
\n__::findIndex($data, \"defend\")Result
\n\"pen\"Find by Callback Usage
\n$data = [
\n \"table\" => (object)[\"name\" => \"trick\"],
\n \"pen\" => (object)[\"name\" => \"defend\"],
\n \"motherly\" => (object)[\"name\" => \"wide\"],
\n \"may\" => (object)[\"name\" => \"needle\"],
\n \"sweat\" => (object)[\"name\" => \"cake\"],
\n \"sword\" => (object)[\"name\" => \"defend\"],
\n];
\n
\n__::findIndex($data, static function ($object, $key, $collection) {
\n return $object->name === \"defend\";
\n})Result
\n\"pen\"The index where the respective value is found. When given a numerically\nindexed array, an int will be returned but when an associative array is given, a string will\nbe returned.\nIf no value is found, $returnValue is returned, which defaults to -1.
Return the last element that matches the given condition or $returnValue if no value is found (defaults to null).
Warning: If you give this function an iterator, it will convert the iterator into an array and then use that\narray to find the last element; this will incur a performance hit.
\nFind by Primitive Condition in Array
\n$data = [
\n \"table\" => \"trick\",
\n \"pen\" => \"defend\",
\n \"motherly\" => \"wide\",
\n \"may\" => \"needle\",
\n \"sweat\" => \"cake\",
\n \"sword\" => \"defend\",
\n];
\n
\n__::findLast($data, \"defend\");Result
\n\"defend\"Find by Callback in an Array
\n$data = [
\n \"table\" => (object)[\"name\" => \"trick\"],
\n \"pen\" => (object)[\"name\" => \"defend\"],
\n \"motherly\" => (object)[\"name\" => \"wide\"],
\n \"may\" => (object)[\"name\" => \"needle\"],
\n \"sweat\" => (object)[\"name\" => \"cake\"],
\n \"sword\" => (object)[\"name\" => \"defend\"],
\n];
\n
\n__::findLast($data, static function ($object, $key, $collection) {
\n return $object->name === \"defend\";
\n});Result
\n$data[\"sword\"]The entity from the iterable. If no value is found, $returnValue is returned, which defaults to\nnull.
Find the last key/value pair of a given element that matches the given condition or null if no match is found.
", "summaryRaw": "Find the last key/value pair of a given element that matches the given condition or null if no match is found.", "description": "Find by Primitive Condition in Array
\n$data = [
\n \"table\" => \"trick\",
\n \"pen\" => \"defend\",
\n \"motherly\" => \"wide\",
\n \"may\" => \"needle\",
\n \"sweat\" => \"cake\",
\n \"sword\" => \"defend\",
\n];
\n
\n__::findLastEntry($data, \"defend\");Result
\n[\"sword\", \"defend\"]Find by Callback in an Array
\n$data = [
\n \"table\" => (object)[\"name\" => \"trick\"],
\n \"pen\" => (object)[\"name\" => \"defend\"],
\n \"motherly\" => (object)[\"name\" => \"wide\"],
\n \"may\" => (object)[\"name\" => \"needle\"],
\n \"sweat\" => (object)[\"name\" => \"cake\"],
\n \"sword\" => (object)[\"name\" => \"defend\"],
\n];
\n
\n__::findLastEntry($data, static function ($object, $key, $collection) {
\n return $object->name === \"defend\";
\n});Result
\n[\"sword\", $data[\"sword\"]]An array with two values, the 0th index is the key and the 1st index is the value. Null is\nreturned if no entries can be found in the given collection.
" } }, { "name": "findLastIndex", "namespace": "collections", "summary": "Return the index or key of the last element that matches the given condition or $returnValue if no value is found\n(defaults to -1).
Warning: If you give this function an iterator, it will convert the iterator into an array and then use that\narray to find the last element; this will incur a performance hit.
\nFind Index by Primitive Condition in a Numerically Indexed Array
\n$data = [
\n \"native\",
\n \"pale\",
\n \"explain\",
\n \"persuade\",
\n \"elastic\",
\n \"explain\",
\n];
\n
\n__::findIndex($data, \"explain\")Result
\n5Find Index by Primitive Condition in an Associative Array
\n$data = [
\n \"table\" => \"trick\",
\n \"pen\" => \"defend\",
\n \"motherly\" => \"wide\",
\n \"may\" => \"needle\",
\n \"sweat\" => \"cake\",
\n \"sword\" => \"defend\",
\n];
\n
\n__::findLastIndex($data, \"defend\")Result
\n\"sword\"Find by Callback Usage
\n$data = [
\n \"table\" => (object)[\"name\" => \"trick\"],
\n \"pen\" => (object)[\"name\" => \"defend\"],
\n \"motherly\" => (object)[\"name\" => \"wide\"],
\n \"may\" => (object)[\"name\" => \"needle\"],
\n \"sweat\" => (object)[\"name\" => \"cake\"],
\n \"sword\" => (object)[\"name\" => \"defend\"],
\n];
\n
\n__::findLastIndex($data, static function ($object, $key, $collection) {
\n return $object->name === \"defend\";
\n})Result
\n\"sword\"The index where the respective value is found. When given a numerically\nindexed array, an int will be returned but when an associative array is given, a string will\nbe returned.\nIf no value is found, $returnValue is returned, which defaults to -1.
Gets the first element of an array/iterable. Passing n returns the first n elements.
", "summaryRaw": "Gets the first element of an array/iterable. Passing n returns the first n elements.", "description": "When $count is null, only the first element will be returned.
Usage
\n__::first([1, 2, 3, 4, 5], 2);Result
\n[1, 2]Get item of an array or object by index, accepting path (nested index).
", "summaryRaw": "Get item of an array or object by index, accepting path (nested index).", "description": "If $collection is an object that implements the ArrayAccess interface, this\nfunction will treat it as an array instead of accessing class properties.
Use a period (.) in $path to go down a level in a multidimensional array.
Usage
\n__::get(['foo' => ['bar' => 'ter']], 'foo.bar');Result
\n'ter'Get an iterator from an object that supports iterators; including generators.
", "summaryRaw": "Get an iterator from an object that supports iterators; including generators.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "input", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "\\Traversable" } ], "changelog": [], "exceptions": [ { "exception": "\\InvalidArgumentException", "message": "when $input does not implement `\\Iterator` or `\\IteratorAggregate`" }, { "exception": "\\Exception", "message": "when `\\IteratorAggregate::getIterator()` throws an exception" } ], "return": { "type": "\\Traversable", "description": "" } }, { "name": "groupBy", "namespace": "collections", "summary": "Returns an associative array where the keys are values of $key.
", "summaryRaw": "Returns an associative array where the keys are values of $key.", "description": "Based on Chauncey McAskill's array_group_by()\nfunction.
\nGroup by Key Usage
\n__::groupBy([
\n ['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'School bus'],
\n ['state' => 'CA', 'city' => 'San Diego', 'object' => 'Light bulb'],
\n ['state' => 'CA', 'city' => 'Mountain View', 'object' => 'Space pen'],
\n ],
\n 'state'
\n);Result
\n[
\n 'IN' => [
\n ['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'School bus'],
\n ],
\n 'CA' => [
\n ['state' => 'CA', 'city' => 'San Diego', 'object' => 'Light bulb'],
\n ['state' => 'CA', 'city' => 'Mountain View', 'object' => 'Space pen'],
\n ]
\n]Group by Nested Key (Dot Notation)
\n__::groupBy([
\n ['object' => 'School bus', 'metadata' => ['state' => 'IN', 'city' => 'Indianapolis']],
\n ['object' => 'Manhole', 'metadata' => ['state' => 'IN', 'city' => 'Indianapolis']],
\n ['object' => 'Basketball', 'metadata' => ['state' => 'IN', 'city' => 'Plainfield']],
\n ['object' => 'Light bulb', 'metadata' => ['state' => 'CA', 'city' => 'San Diego']],
\n ['object' => 'Space pen', 'metadata' => ['state' => 'CA', 'city' => 'Mountain View']],
\n ],
\n 'metadata.state'
\n);Result
\n[
\n 'IN' => [
\n 'Indianapolis' => [
\n ['object' => 'School bus', 'metadata' => ['state' => 'IN', 'city' => 'Indianapolis']],
\n ['object' => 'Manhole', 'metadata' => ['state' => 'IN', 'city' => 'Indianapolis']],
\n ],
\n 'Plainfield' => [
\n ['object' => 'Basketball', 'metadata' => ['state' => 'IN', 'city' => 'Plainfield']],
\n ],
\n ],
\n 'CA' => [
\n 'San Diego' => [
\n ['object' => 'Light bulb', 'metadata' => ['state' => 'CA', 'city' => 'San Diego']],
\n ],
\n 'Mountain View' => [
\n ['object' => 'Space pen', 'metadata' => ['state' => 'CA', 'city' => 'Mountain View']],
\n ],
\n ],
\n]Group by Closure Usage
\n__::groupBy([
\n (object)['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'School bus'],
\n (object)['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'Manhole'],
\n (object)['state' => 'CA', 'city' => 'San Diego', 'object' => 'Light bulb'],
\n ],
\n function ($value) {
\n return $value->city;
\n }
\n);Result
\n[
\n 'Indianapolis' => [
\n ['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'School bus'],
\n ['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'Manhole'],
\n ],
\n 'San Diego' => [
\n ['state' => 'CA', 'city' => 'San Diego', 'object' => 'Light bulb'],
\n ]
\n]Return true if $collection contains the requested $key.
In contrast to isset(), __::has() returns true if the key exists but is null.
Array Usage
\n __::has(['foo' => ['bar' => 'num'], 'foz' => 'baz'], 'foo.bar');Result
\ntrueObject Usage
\n __::hasKeys((object) ['foo' => 'bar', 'foz' => 'baz'], 'bar');Result
\nfalseReturns true if $input contains all requested $keys. If $strict is true\nit also checks if $input exclusively contains the given $keys.
Usage
\n__::hasKeys(['foo' => 'bar', 'foz' => 'baz'], ['foo', 'foz']);Result
\ntrueCheck if value is an empty array or object.
", "summaryRaw": "Check if value is an empty array or object.", "description": "We consider any non enumerable as empty.
\nUsage
\n__::isEmpty([]);Result
\ntrueGet last item(s) of an array.
", "summaryRaw": "Get last item(s) of an array.", "description": "Usage
\n__::last([1, 2, 3, 4, 5], 2);Result
\n[4, 5]Returns an array of values by mapping each in collection through the iteratee.
", "summaryRaw": "Returns an array of values by mapping each in collection through the iteratee.", "description": "Usage
\n__::map([1, 2, 3], function($value, $key, $collection) {
\n return $value * 3;
\n});Result
\n[3, 6, 9]Transforms the keys in a collection by running each key through the iterator.
", "summaryRaw": "Transforms the keys in a collection by running each key through the iterator.", "description": "This function throws an \\Exception when the closure doesn't return a valid\nkey that can be used in a PHP array.
Usage
\n__::mapKeys(['x' => 1], function($key, $value, $collection) {
\n return \"{$key}_{$value}\";
\n});Result
\n['x_1' => 1]Transforms the values in a collection by running each value through the iterator.
", "summaryRaw": "Transforms the values in a collection by running each value through the iterator.", "description": "Usage
\n__::mapValues(['x' => 1], function($value, $key, $collection) {
\n return \"{$key}_{$value}\";
\n});Result
\n['x' => 'x_1']Returns the maximum value from the collection.
", "summaryRaw": "Returns the maximum value from the collection.", "description": "If passed an iterator, max will return max value returned by the iterator.
\nUsage
\n__::max([1, 2, 3]);Result
\n3maximum value
" } }, { "name": "merge", "namespace": "collections", "summary": "Recursively combines and merge collections provided with each others.
", "summaryRaw": "Recursively combines and merge collections provided with each others.", "description": "For a non-recursive merge, see __::assign().
Usage
\n__::merge(
\n ['color' => ['favorite' => 'red', 'model' => 3, 5], 3],
\n [10, 'color' => ['favorite' => 'green', 'blue']]
\n);Result
\n['color' => ['favorite' => 'green', 'model' => 3, 'blue'], 10]Concatenated collection.
" } }, { "name": "min", "namespace": "collections", "summary": "Returns the minimum value from the collection. If passed an iterator, min will\nreturn min value returned by the iterator.
", "summaryRaw": "Returns the minimum value from the collection. If passed an iterator, min will\nreturn min value returned by the iterator.", "description": "Usage
\n__::min([1, 2, 3]);Result
\n1Returns an array having only keys present in the given path list.
", "summaryRaw": "Returns an array having only keys present in the given path list.", "description": "Values for missing keys values will be filled with provided default value.
\nUsage
\n__::pick(
\n [
\n 'a' => 1,
\n 'b' => ['c' => 3, 'd' => 4]
\n ],
\n ['a', 'b.d']
\n);Result
\n[
\n 'a' => 1,
\n 'b' => ['d' => 4]
\n]Returns an array of values belonging to a given property of each item in a collection.
", "summaryRaw": "Returns an array of values belonging to a given property of each item in a collection.", "description": "Usage
\n$a = [
\n ['foo' => 'bar', 'bis' => 'ter' ],
\n ['foo' => 'bar2', 'bis' => 'ter2'],
\n];
\n
\n__::pluck($a, 'foo');Result
\n['bar', 'bar2']Reduces $collection to a value which is the $accumulator result of running\neach element in $collection thru $iteratee, where each successive invocation\nis supplied the return value of the previous.
If $accumulator is not given, the first element of $collection is used as\nthe initial value.
Usage: Sum Example
\n__::reduce([1, 2], function ($accumulator, $value, $key, $collection) {
\n return $accumulator + $value;
\n}, 0);Result
\n3Usage: Array Counter
\n$a = [
\n ['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'School bus'],
\n ['state' => 'IN', 'city' => 'Indianapolis', 'object' => 'Manhole'],
\n ['state' => 'IN', 'city' => 'Plainfield', 'object' => 'Basketball'],
\n ['state' => 'CA', 'city' => 'San Diego', 'object' => 'Light bulb'],
\n ['state' => 'CA', 'city' => 'Mountain View', 'object' => 'Space pen'],
\n];
\n
\n$iteratee = function ($accumulator, $value) {
\n if (isset($accumulator[$value['city']]))
\n $accumulator[$value['city']]++;
\n else
\n $accumulator[$value['city']] = 1;
\n return $accumulator;
\n};
\n
\n__::reduce($c, $iteratee, []);Result
\n[
\n 'Indianapolis' => 2,
\n 'Plainfield' => 1,
\n 'San Diego' => 1,
\n 'Mountain View' => 1,
\n]Usage: Objects
\n$object = new \\stdClass();
\n$object->a = 1;
\n$object->b = 2;
\n$object->c = 1;
\n
\n__::reduce($object, function ($result, $value, $key) {
\n if (!isset($result[$value]))
\n $result[$value] = [];
\n
\n $result[$value][] = $key;
\n
\n return $result;
\n}, [])Result
\n[
\n '1' => ['a', 'c'],
\n '2' => ['b']
\n]Returns the accumulated value.
" } }, { "name": "reduceRight", "namespace": "collections", "summary": "Reduces $collection to a value which is the $accumulator result of running\neach element in $collection - from right to left - thru $iteratee, where\neach successive invocation is supplied the return value of the previous.
If $accumulator is not given, the first element of $collection is used as\nthe initial value.
Usage
\n__::reduceRight(['a', 'b', 'c'], function ($accumulator, $value, $key, $collection) {
\n return $accumulator . $value;
\n}, '');Result
\n'cba'Returns the accumulated value.
" } }, { "name": "reverseIterable", "namespace": "collections", "summary": "Return the reverse of an array or other foreach-able (Iterable).
", "summaryRaw": "Return the reverse of an array or other foreach-able (Iterable).", "description": "For array it does not make a copy of it; but does make a copy to memory for other\ntraversables.
\nCode (using yield) is from mpen and linepogl\nSee https://stackoverflow.com/a/36605605/1956471
Usage
\n__::reverseIterable([1, 2, 3]);Result
\nGenerator([3, 2, 1])Return a new collection with the item set at index to given value. Index can\nbe a path of nested indexes.
", "summaryRaw": "Return a new collection with the item set at index to given value. Index can\nbe a path of nested indexes.", "description": "$collection is an object that implements the ArrayAccess interface,\nthis function will treat it as an array.This function throws an \\Exception if the path consists of a non-collection.
Usage
\n__::set(['foo' => ['bar' => 'ter']], 'foo.baz.ber', 'fer');Result
\n['foo' => ['bar' => 'ter', 'baz' => ['ber' => 'fer']]]the new collection with the item set
" } }, { "name": "size", "namespace": "collections", "summary": "Get the size of an array or \\Countable object. Or get the number of properties\nan object has.
", "summaryRaw": "Get the size of an array or \\Countable object. Or get the number of properties\nan object has.", "description": "Usage
\n__::size(null) // false
\n__::size(\"true\") // false; a string is not a collection
\n__::size([1, 2, 3]) // 3
\n__::size((object)[1, 2]) // 2
\n__::size(new ArrayIterator(5, 4)) // 2False when the given object does not support getting its\nsize.
" } }, { "name": "unease", "namespace": "collections", "summary": "Builds a multidimensional collection out of a hash map using the key as\nindicator where to put the value.
", "summaryRaw": "Builds a multidimensional collection out of a hash map using the key as\nindicator where to put the value.", "description": "Usage
\n__::unease(['foo.bar' => 'ter', 'baz.0' => 'b', , 'baz.1' => 'z']);Result
\n['foo' => ['bar' => 'ter'], 'baz' => ['b', 'z']]Return data matching specific key value condition.
", "summaryRaw": "Return data matching specific key value condition.", "description": "Usage
\n$a = [
\n ['name' => 'fred', 'age' => 32],
\n ['name' => 'maciej', 'age' => 16]
\n];
\n
\n__::where($a, ['age' => 16]);Result
\n[['name' => 'maciej', 'age' => 16]]Create a web friendly URL slug from a string.
", "summaryRaw": "Create a web friendly URL slug from a string.", "description": "Although supported, transliteration is discouraged because:
\nUsage
\n__::slug('Jakieś zdanie z dużą ilością obcych znaków!');Result
\n'jakies-zdanie-z-duza-iloscia-obcych-znakow'Truncate string based on count of words
", "summaryRaw": "Truncate string based on count of words", "description": "Usage
\n$string = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque et mi orci.';
\n
\n__::truncate($string);Result
\n'Lorem ipsum dolor sit amet, ...'Convert any URLs into HTML anchor tags in a string.
", "summaryRaw": "Convert any URLs into HTML anchor tags in a string.", "description": "Usage
\n__::urlify(\"I love https://google.com\");Result
\n'I love <a href=\"https://google.com\">google.com</a>'Check if give value is array or not.
", "summaryRaw": "Check if give value is array or not.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "var", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isCollection", "namespace": "objects", "summary": "Check if the object is a collection.
", "summaryRaw": "Check if the object is a collection.", "description": "A collection is either an array or an object.
", "descriptionRaw": "A collection is either an array or an object.", "arguments": [ { "name": "object", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isEmail", "namespace": "objects", "summary": "Check if the value is valid email.
", "summaryRaw": "Check if the value is valid email.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "value", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isEqual", "namespace": "objects", "summary": "Check if the objects are equals.
", "summaryRaw": "Check if the objects are equals.", "description": "Perform a deep (recursive) comparison when the parameters are arrays or objects.
\nNote: This method supports comparing arrays, object objects, booleans, numbers, strings.\nobject objects are compared by their own enumerable properties (as returned by get_object_vars).
\nUsage
\n__::isEqual(['honfleur' => 1, 'rungis' => [2, 3]], ['honfleur' => 1, 'rungis' => [1, 2]]);Result
\nfalseCheck if give value is function or not.
", "summaryRaw": "Check if give value is function or not.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "var", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isIterable", "namespace": "objects", "summary": "Check to see if something is iterable.
", "summaryRaw": "Check to see if something is iterable.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "value", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" }, { "name": "strict", "isVariadic": false, "description": "Match PHP 7.1 behavior where and `\\stdClass` is not iterable", "defaultValue": true, "defaultValueAsString": "true", "type": "bool" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isNull", "namespace": "objects", "summary": "Check if give value is null or not.
", "summaryRaw": "Check if give value is null or not.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "var", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isNumber", "namespace": "objects", "summary": "Check if give value is number or not.
", "summaryRaw": "Check if give value is number or not.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "value", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isObject", "namespace": "objects", "summary": "Check if give value is object or not.
", "summaryRaw": "Check if give value is object or not.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "var", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "isString", "namespace": "objects", "summary": "Check if give value is string or not.
", "summaryRaw": "Check if give value is string or not.", "description": "", "descriptionRaw": "", "arguments": [ { "name": "var", "isVariadic": false, "description": "", "defaultValue": null, "defaultValueAsString": null, "type": "mixed" } ], "changelog": [], "exceptions": [], "return": { "type": "bool", "description": "" } }, { "name": "chain", "namespace": "sequences", "summary": "Returns a wrapper instance, allows the value to be passed through multiple\nbottomline functions.
", "summaryRaw": "Returns a wrapper instance, allows the value to be passed through multiple\nbottomline functions.", "description": "Usage
\n__::chain([0, 1, 2, 3, null])
\n ->compact()
\n ->prepend(4)
\n ->value()
\n;Result
\n[4, 1, 2, 3]Converts string to camel case.
", "summaryRaw": "Converts string to [camel case](https://en.wikipedia.org/wiki/CamelCase).", "description": "Usage
\n__::camelCase('Foo Bar');Result
\n'fooBar'Converts the first character of string to upper case and the remaining\nto lower case.
", "summaryRaw": "Converts the first character of string to upper case and the remaining\nto lower case.", "description": "Usage
\n__::capitalize('FRED');Result
\n'Fred'Converts string to kebab case.
", "summaryRaw": "Converts string to [kebab case](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles).", "description": "Usage
\n__::kebabCase('Foo Bar');Result
\n'foo-bar'Converts string, as space separated words, to lower case.
", "summaryRaw": "Converts string, as space separated words, to lower case.", "description": "Usage
\n__::lowerCase('--Foo-Bar--');Result
\n'foo bar'Converts the first character of string to lower case, like lcfirst.
", "summaryRaw": "Converts the first character of string to lower case, like lcfirst.", "description": "Usage
\n__::lowerFirst('Fred');Result
\n'fred'Converts string to snake case.
", "summaryRaw": "Converts string to [snake case](https://en.wikipedia.org/wiki/Snake_case).", "description": "Usage
\n__::snakeCase('Foo Bar');Result
\n'foo_bar'Split a string by string.
", "summaryRaw": "Split a string by string.", "description": "-limit are returned.Usage
\n__::split('a-b-c', '-', 2);Result
\n['a', 'b-c']Converts string to start case.
", "summaryRaw": "Converts string to [start case](https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage).", "description": "Usage
\n__::startCase('--foo-bar--');Result
\n'Foo Bar'Converts string, as a whole, to lower case just like strtolower().
Usage
\n__::toLower('fooBar');Result
\n'foobar'Converts string, as a whole, to lower case just like strtoupper().
Usage
\n__::toUpper('fooBar');Result
\n'FOOBAR'Converts string, as space separated words, to upper case.
", "summaryRaw": "Converts string, as space separated words, to upper case.", "description": "Usage
\n__::upperCase('--foo-bar');Result
\n'FOO BAR'Converts the first character of string to upper case, like ucfirst().
Usage
\n__::upperFirst('fred');Result
\n'Fred'Splits string into an array of its words.
", "summaryRaw": "Splits string into an array of its words.", "description": "Usage: Default Behavior
\n__::words('fred, barney, & pebbles');Result
\n['fred', 'barney', 'pebbles']Use a custom regex to define how words are split.
\nUsage: Custom Pattern
\n__::words('fred, barney, & pebbles', '/[^, ]+/');Result
\n['fred', 'barney', '&', 'pebbles']Returns the first argument it receives.
", "summaryRaw": "Returns the first argument it receives.", "description": "Usage
\n__::identity('arg1', 'arg2');Result
\n'arg1'Alias to original time() function which returns current time.
", "summaryRaw": "Alias to original time() function which returns current time.", "description": "", "descriptionRaw": "", "arguments": [], "changelog": [], "exceptions": [], "return": { "type": "mixed", "description": "" } } ] }