Datastructures
PHP Manual

The SplObjectStorage class

Introduction

The SplObjectStorage class provides a map from objects to data or, by ignoring data, an object set. This dual purpose can be useful in many cases involving the need to uniquely identify objects.

Class synopsis

SplObjectStorage
implements Countable SeekableIterator Serializable ArrayAccess
/* Methods */
public int addAll(SplObjectStorage $storage)
public void attach(object $object, mixed $info = null)
public bool contains(object $object)
public int count(int $mode = COUNT_NORMAL)
public object current()
public void detach(object $object)
public string getHash(object $object)
public mixed getInfo()
public int key()
public void next()
public bool offsetExists(object $object)
public mixed offsetGet(object $object)
public void offsetSet(object $object, mixed $info = null)
public void offsetUnset(object $object)
public int removeAll(SplObjectStorage $storage)
public int removeAllExcept(SplObjectStorage $storage)
public void rewind()
public void seek(int $offset)
public string serialize()
public void setInfo(mixed $info)
public void unserialize(string $data)
public bool valid()

Examples

Example #1 SplObjectStorage as a set

<?php
// As an object set
$s = new SplObjectStorage();

$o1 = new stdClass;
$o2 = new stdClass;
$o3 = new stdClass;

$s->attach($o1);
$s->attach($o2);

var_dump($s->contains($o1));
var_dump($s->contains($o2));
var_dump($s->contains($o3));

$s->detach($o2);

var_dump($s->contains($o1));
var_dump($s->contains($o2));
var_dump($s->contains($o3));
?>

The above example will output:

bool(true)
bool(true)
bool(false)
bool(true)
bool(false)
bool(false)

Example #2 SplObjectStorage as a map

<?php
// As a map from objects to data
$s = new SplObjectStorage();

$o1 = new stdClass;
$o2 = new stdClass;
$o3 = new stdClass;

$s[$o1] = "data for object 1";
$s[$o2] = array(1,2,3);

if (isset($s[$o2])) {
    var_dump($s[$o2]);
}
?>

The above example will output:

array(3) {
  [0]=>
  int(1)
  [1]=>
  int(2)
  [2]=>
  int(3)
}

Changelog

Version Description
8.4.0 Implement SeekableIterator, previously only Iterator was implemented.
Table of Contents