https://github.com/Solution10/collection

Like arrays, only better! Small, lightweight PHP 5.3 Collection class with smart slicing and fancy sorting.
https://github.com/Solution10/collection

arrays composer-packages data-structures php

Last synced: about 2 months ago
JSON representation

Like arrays, only better! Small, lightweight PHP 5.3 Collection class with smart slicing and fancy sorting.

• Host: GitHub
• URL: https://github.com/Solution10/collection
• Owner: solution10
• License: mit
• Created: 2014-07-16T20:19:42.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-29T20:24:49.000Z (about 10 years ago)
• Last Synced: 2024-08-18T15:44:41.464Z (5 months ago)
• Topics: arrays, composer-packages, data-structures, php
• Language: PHP
• Size: 266 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Solution10\Collection

Like Arrays. Only better!

[![Build Status](https://travis-ci.org/Solution10/collection.svg?branch=master)](https://travis-ci.org/Solution10/collection)

[![Coverage Status](https://coveralls.io/repos/Solution10/collection/badge.png)](https://coveralls.io/r/Solution10/collection)

[![Latest Stable Version](https://poser.pugx.org/solution10/collection/v/stable.svg)](https://packagist.org/packages/solution10/collection)

[![Total Downloads](https://poser.pugx.org/solution10/collection/downloads.svg)](https://packagist.org/packages/solution10/collection)

[![Latest Unstable Version](https://poser.pugx.org/solution10/collection/v/unstable.svg)](https://packagist.org/packages/solution10/collection)

[![License](https://poser.pugx.org/solution10/collection/license.svg)](https://packagist.org/packages/solution10/collection)

## What does this do?

Collections, at their core, are implementations of Iterator, ArrayAccess and Countable. But they're also a lot more than that.

Splice subsections of arrays simply by passing keys:

```php

$collection = new Collection(array('Apple', 'Orange', 'Banana'));

$subset = $collection['0:1'];

// $subset is now: array('Apple', 'Orange')

$collection = new Collection(array('Apple', 'Orange', 'Banana'));

$subset = $collection['-2:2'];

// $subset contains ('Orange', 'Banana')

$collection = new Collection(array('Apple', 'Orange', 'Banana', 'Grapes'));

$subset = $collection[':LAST'];

// $subset is simply array('Grapes')

```

Quickly and easily Sort

```php

$collection = new Collection(array(100, 50, 70, 10));

$collection->sort(Collection::SORT_ASC);

// $collection's order is now: 10, 50, 70, 100

$collection = new Collection(array(

    array(

        'name' => 'Sarah',

        'job' => 'Manager',

    ),

    array(

        'name' => 'Alex',

        'job' => 'Developer',

    ),

    array(

        'name' => 'Tracy',

        'job' => 'HR'

    ),

));

$collection->sortByMember('name', Collection::SORT_ASC);

```

For full feature list, [check out the docs](http://github.com/Solution10/collection/wiki).

## Installation

Install via composer:

```json

"require": {

    "solution10/collection": "1.*"

}

```

## Requirements

- PHP >= 5.3

That's it!

## Documentation

See the [Github Wiki](http://github.com/Solution10/collection/wiki)

or the [docs/ folder in the repo](http://github.com/solution10/collection/tree/master/docs).

To get api docs; from a checkout of the project run:

    $ make && open api/index.html

## License

[MIT](http://github.com/solution10/collection/tree/master/LICENSE.md)

## Contributing

[Contributors Notes](http://github.com/solution10/collection/tree/master/CONTRIBUTING.md)