You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
1.1 KiB
32 lines
1.1 KiB
1 year ago
|
[![Total Downloads](https://img.shields.io/packagist/dt/cakephp/collection.svg?style=flat-square)](https://packagist.org/packages/cakephp/collection)
|
||
|
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE.txt)
|
||
|
|
||
|
# CakePHP Collection Library
|
||
|
|
||
|
The collection classes provide a set of tools to manipulate arrays or Traversable objects.
|
||
|
If you have ever used underscore.js, you have an idea of what you can expect from the collection classes.
|
||
|
|
||
|
## Usage
|
||
|
|
||
|
Collections can be created using an array or Traversable object. A simple use of a Collection would be:
|
||
|
|
||
|
```php
|
||
|
use Cake\Collection\Collection;
|
||
|
|
||
|
$items = ['a' => 1, 'b' => 2, 'c' => 3];
|
||
|
$collection = new Collection($items);
|
||
|
|
||
|
// Create a new collection containing elements
|
||
|
// with a value greater than one.
|
||
|
$overOne = $collection->filter(function ($value, $key, $iterator) {
|
||
|
return $value > 1;
|
||
|
});
|
||
|
```
|
||
|
|
||
|
The `Collection\CollectionTrait` allows you to integrate collection-like features into any Traversable object
|
||
|
you have in your application as well.
|
||
|
|
||
|
## Documentation
|
||
|
|
||
|
Please make sure you check the [official documentation](https://book.cakephp.org/3/en/core-libraries/collections.html)
|