The Collection interface

Introduction

Collection is the base interface which covers functionality common to all the data structures in this library. It guarantees that all structures are traversable, countable, and can be converted to json using json_encode.

Interface synopsis

Ds\Collection extends Countable IteratorAggregate JsonSerializable

/* Methods */

public void Ds\Collection::clear()

public Ds\Collection Ds\Collection::copy()

public bool Ds\Collection::isEmpty()

public array Ds\Collection::toArray()

/* Inherited methods */

public int Countable::count()

public Traversable IteratorAggregate::getIterator()

public mixed JsonSerializable::jsonSerialize()

Changelog

Version	Description
PECL ds 1.4.0	Collection implements IteratorAggregate now instead of just Traversable. (This change came to the polyfill in 1.4.1.)

Table of Contents

Ds\Collection::clear — Removes all values
Ds\Collection::copy — Returns a shallow copy of the collection
Ds\Collection::isEmpty — Returns whether the collection is empty
Ds\Collection::toArray — Converts the collection to an array