Класс WeakMap

(PHP 8)

Введение

Класс WeakMap — карта, или словарь, который принимает объекты как ключи. Однако, объект в ключе экземпляра WeakMap не влияет на счётчик ссылок объекта, в отличие от аналогичного в остальном класса SplObjectStorage. То есть, как только единственной оставшейся ссылкой на объект будет ключ экземпляра WeakMap, сборщик мусора соберёт и удалит объект из экземпляра WeakMap. Основная задача класса — создавать кеши данных, которые получили из объекта, которым не нужно жить дольше, чем объект.

Класс WeakMap реализует интерфейсы ArrayAccess, Traversable (через интерфейс IteratorAggregate) и Countable, поэтому с объектом класса часто работают так же, как с ассоциативным массивом.

Обзор классов

final class WeakMap implements ArrayAccess, Countable, IteratorAggregate {
/* Методы */
public count(): int
public getIterator(): Iterator
public offsetExists(object $object): bool
public offsetGet(object $object): mixed
public offsetSet(object $object, mixed $value): void
public offsetUnset(object $object): void
}

Примеры

Пример #1 Пример использования класса Weakmap

<?php

$wm = new WeakMap();

$o = new stdClass;

class A {
public function __destruct() {
echo "Уничтожено!\n";
}
}

$wm[$o] = new A;

var_dump(count($wm));
echo "Сброс...\n";
unset($o);
echo "Готово\n";
var_dump(count($wm));

?>

Результат выполнения приведённого примера: 

int(1)
Сброс...
Уничтожено!
Готово
int(0)

Содержание

  • WeakMap::count — Подсчитывает количество живых записей в коллекции (map)
  • WeakMap::getIterator — Получает внешний итератор
  • WeakMap::offsetExists — Проверяет, есть ли в коллекции (map) определённый объект
  • WeakMap::offsetGet — Возвращает значение, на которое указывает определённый объект
  • WeakMap::offsetSet — Обновляет коллекцию (map) новой парой ключ-значение
  • WeakMap::offsetUnset — Удаляет запись из коллекции (map)