Класс WeakMap

(PHP 8)

Введение

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

WeakMap реализует ArrayAccess, Iterator и 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)

＋add a note

User Contributed Notes 1 note

down

-1

malferov at gmail dot com ¶

1 month ago


<?php

$wp = new WeakMap();

// It's not working.
// Has no error but not adding dynamically specifying object to map;
// garbage collector will not be able to clear unnamed value, as I suppose
$wp[new stdClass()] = 'value';
echo $wp->count() . PHP_EOL; // 0

// It's working, as expected
$obj = new stdClass();
$wp[$obj] = 'value';
echo $wp->count(); // 1

＋add a note