La clase SplObjectStorage

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Introducción

La clase SplObjectStorage proporciona un mapa de objetos o de datos, o bien, ignorando los índices, un conjunto de objetos. Este doble propósito es útil en numerosas situaciones, donde es necesario identificar de manera única objetos.

Sinopsis de la Clase

class SeekableSplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess {

/* Métodos */

public SplObjectStorage::addAll(SplObjectStorage $storage): int

#[\Deprecated]
public SplObjectStorage::attach(object $object, mixed $info = null): void

#[\Deprecated]
public SplObjectStorage::contains(object $object): bool

public SplObjectStorage::count(int $mode = COUNT_NORMAL): int

public SplObjectStorage::current(): object

#[\Deprecated]
public SplObjectStorage::detach(object $object): void

public SplObjectStorage::getHash(object $object): string

public SplObjectStorage::getInfo(): mixed

public SplObjectStorage::key(): int

public SplObjectStorage::next(): void

public SplObjectStorage::offsetExists(object $object): bool

public SplObjectStorage::offsetGet(object $object): mixed

public SplObjectStorage::offsetSet(object $object, mixed $info = null): void

public SplObjectStorage::offsetUnset(object $object): void

public SplObjectStorage::removeAll(SplObjectStorage $storage): int

public SplObjectStorage::removeAllExcept(SplObjectStorage $storage): int

public SplObjectStorage::rewind(): void

public SplObjectStorage::seek(int $offset): void

public SplObjectStorage::serialize(): string

public SplObjectStorage::setInfo(mixed $info): void

public SplObjectStorage::unserialize(string $data): void

public SplObjectStorage::valid(): bool

}

Ejemplos

Ejemplo #1 Ejemplo con SplObjectStorage, en forma de conjunto de objetos

<?php
// Un conjunto de objetos
$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));
?>

El ejemplo anterior mostrará:

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

Ejemplo #2 Ejemplo con SplObjectStorage, en forma de mapa

<?php
// Un mapa de objetos
$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]);
}
?>

El ejemplo anterior mostrará:

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

Historial de cambios

Versión	Descripción
8.4.0	Implementa SeekableIterator, anteriormente solo se implementaba la interfaz Iterator.

Tabla de contenidos

SplObjectStorage::addAll — Agrega todos los objetos de otro almacenamiento
SplObjectStorage::attach — Agrega un objeto en el almacenamiento
SplObjectStorage::contains — Comprueba si el almacenamiento contiene un objeto específico
SplObjectStorage::count — Devuelve el número de objetos en el almacenamiento
SplObjectStorage::current — Devuelve el objeto actual
SplObjectStorage::detach — Quita un object del almacenamiento
SplObjectStorage::getHash — Calcular un identificador único (hash) para los objetos contenidos
SplObjectStorage::getInfo — Devuelve los datos asociados con la entrada del iterador actual
SplObjectStorage::key — Devuelve el índice en el que se encuentra el iterador actualmente
SplObjectStorage::next — Mover a la siguiente entrada
SplObjectStorage::offsetExists — Comprueba si un objeto existe en el almacenamiento
SplObjectStorage::offsetGet — Devuelve los datos asociados con un object
SplObjectStorage::offsetSet — Asocia datos a un objeto en el almacenamiento
SplObjectStorage::offsetUnset — Quita un objeto de el almacenamiento
SplObjectStorage::removeAll — Remover objetos contenidos en otro almacenamiento de el almacenamiento actual
SplObjectStorage::removeAllExcept — Remover objetos excepto los contenidos en otro almacenamiento del almacenamiento actual
SplObjectStorage::rewind — Rebobina el iterador a el primer elemento de el almacenamiento
SplObjectStorage::seek — Busca un iterador en una posición
SplObjectStorage::serialize — Serializa el almacenamiento
SplObjectStorage::setInfo — Establece los datos asociados con el iterador de la entrada actual
SplObjectStorage::unserialize — Deserializa un almacenamiento desde su representación string
SplObjectStorage::valid — Comprobar si la entrada actual del iterador es válida