Index | Collection

A

Collection — Class in namespace CharlotteDunois\Collect: Collection, an util to conventionally store a key-value pair.
Collection::current() — Method in class Collection: Returns the current element.
Collection::clear() — Method in class Collection: Clears the Collection.
Collection::chunk() — Method in class Collection: Breaks the collection into multiple, smaller chunks of a given size. Returns a new Collection.
Collection::count() — Method in class Collection: Returns the total number of items in the collection.
Collection::copy() — Method in class Collection: Returns a copy of itself.

$Collection#data — Property in class Collection
Collection::delete() — Method in class Collection: Removes an item from the collection by its key.
Collection::diff() — Method in class Collection: Compares the collection against another collection or a plain PHP array based on its value. Returns a new Collection.
Collection::diffKeys() — Method in class Collection: Compares the collection against another collection or a plain PHP array based on its key. Returns a new Collection.

Collection::each() — Method in class Collection: Iterates over the items in the collection and passes each item to a given callback. Returning false in the callback will stop the processing.
Collection::every() — Method in class Collection: Returns true if all elements pass the given truth test.
Collection::except() — Method in class Collection: Returns all items in the collection except for those with the specified keys. Returns a new Collection.

Collection::filter() — Method in class Collection: Filters the collection by a given callback, keeping only those items that pass a given truth test. Returns a new Collection.
Collection::first() — Method in class Collection: Returns the first element in the collection that passes a given truth test.
Collection::flatten() — Method in class Collection: Flattens a multi-dimensional collection into a single dimension. Returns a new Collection.
Collection::flattenDo() — Method in class Collection

Collection::get() — Method in class Collection: Returns the item for a given key. If the key does not exist, null is returned.
Collection::groupBy() — Method in class Collection: Groups the collection's items by a given key. Returns a new Collection.

Collection::has() — Method in class Collection: Determines if a given key exists in the collection.

Collection::implode() — Method in class Collection: Joins the items in a collection. Its arguments depend on the type of items in the collection.
Collection::indexOf() — Method in class Collection: Returns the position of the given value in the collection. Returns null if the given value couldn't be found.
Collection::intersect() — Method in class Collection: Removes any values that are not present in the given array or collection. Returns a new Collection.

Collection::key() — Method in class Collection: Fetch the key from the current element.
Collection::keys() — Method in class Collection: Returns all of the collection's keys. Returns a new Collection.

Collection::last() — Method in class Collection: Returns the last element in the collection that passes a given truth test.

Collection::map() — Method in class Collection: Iterates through the collection and passes each value to the given callback. The callback is free to modify the item and return it, thus forming a new collection of modified items.
Collection::max() — Method in class Collection: Return the maximum value of a given key.
Collection::min() — Method in class Collection: Return the minimum value of a given key.
Collection::merge() — Method in class Collection: Merges the given collection into this collection, resulting in a new collection.

Collection::next() — Method in class Collection: Advances the internal pointer.
Collection::nth() — Method in class Collection: Creates a new collection consisting of every n-th element.

Collection::only() — Method in class Collection: Returns the items in the collection with the specified keys. Returns a new Collection.

Collection::partition() — Method in class Collection: Partitions the collection into two collections where the first collection contains the items that passed and the second contains the items that failed.
Collection::pluck() — Method in class Collection: Return the values from a single column in the input array. Returns a new Collection.

Collection::rewind() — Method in class Collection: Resets the internal pointer.
Collection::random() — Method in class Collection: Returns one random item, or multiple random items inside a Collection, from the Collection. Returns a new Collection.
Collection::reduce() — Method in class Collection: Reduces the collection to a single value, passing the result of each iteration into the subsequent iteration.
Collection::reverse() — Method in class Collection: Reverses the order of the collection's items. Returns a new Collection.

Collection::set() — Method in class Collection: Sets a key-value pair.
Collection::search() — Method in class Collection: Searches the collection for the given value and returns its key if found. If the item is not found, false is returned.
Collection::shuffle() — Method in class Collection: Randomly shuffles the items in the collection. Returns a new Collection.
Collection::slice() — Method in class Collection: Returns a slice of the collection starting at the given index. Returns a new Collection.
Collection::some() — Method in class Collection: Returns true if at least one element passes the given truth test.
Collection::sort() — Method in class Collection: Sorts the collection, using sort behaviour flags. Returns a new Collection.
Collection::sortKey() — Method in class Collection: Sorts the collection by key, using sort behaviour flags. Returns a new Collection.
Collection::sortCustom() — Method in class Collection: Sorts the collection using a custom sorting function. Returns a new Collection.
Collection::sortCustomKey() — Method in class Collection: Sorts the collection by key using a custom sorting function. Returns a new Collection.

Collection::unique() — Method in class Collection: Returns all of the unique items in the collection. Returns a new Collection.

Collection::valid() — Method in class Collection: Checks if current position is valid.
Collection::values() — Method in class Collection: Returns a new collection with the keys reset to consecutive integers.

Collection::__construct() — Method in class Collection: I think you are supposed to know what this does.
Collection::__debugInfo() — Method in class Collection