The SplObjectStorage class

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

简介

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 SplObjectStorage implements Countable, SeekableIterator, Serializable, ArrayAccess {
/* 方法 */
public function addAll(SplObjectStorage $storage): int
#[\Deprecated]
public function attach(object $object, mixed $info = null): void
#[\Deprecated]
public function contains(object $object): bool
public function count(int $mode = COUNT_NORMAL): int
public function current(): object
#[\Deprecated]
public function detach(object $object): void
public function getHash(object $object): string
public function getInfo(): mixed
public function key(): int
public function next(): void
public function offsetExists(object $object): bool
public function offsetGet(object $object): mixed
public function offsetSet(object $object, mixed $info = null): void
public function offsetUnset(object $object): void
public function removeAll(SplObjectStorage $storage): int
public function removeAllExcept(SplObjectStorage $storage): int
public function rewind(): void
public function seek(int $offset): void
public function serialize(): string
public function setInfo(mixed $info): void
public function unserialize(string $data): void
public function valid(): bool
}

示例

示例 #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));
?>

以上示例会输出：

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

示例 #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]);
}
?>

以上示例会输出：

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

更新日志

版本 说明
8.4.0 Implement SeekableIterator, previously only Iterator was implemented.

目录