array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'class.ds-collection.php', 1 => 'Ds\\Collection', 2 => 'The Collection interface', ), 'up' => array ( 0 => 'book.ds.php', 1 => 'Data Structures', ), 'prev' => array ( 0 => 'ds.examples.php', 1 => 'Examples', ), 'next' => array ( 0 => 'ds-collection.clear.php', 1 => 'Ds\\Collection::clear', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ds/ds.collection.xml', ), 'history' => array ( ), 'extra_header_links' => array ( 'rel' => 'alternate', 'href' => '/manual/en/feeds/class.ds-collection.atom', 'type' => 'application/atom+xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

The Collection interface

(PECL ds >= 1.0.0)

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

interface Ds\Collection extends Countable, IteratorAggregate, JsonSerializable {
/* Methods */
public clear(): void
public copy(): Ds\Collection
public isEmpty(): bool
public toArray(): array
/* Inherited methods */
public Countable::count(): int
public IteratorAggregate::getIterator(): Traversable
public JsonSerializable::jsonSerialize(): mixed
}

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