Die Klasse WeakMap

(PHP 8)

Einführung

Eine WeakMap ist eine Zuordnungstabelle (Map oder Dictionary), die Objekte als Schlüssel akzeptiert. Jedoch - anders als bei einem ansonsten ähnlichen SplObjectStorage - zählt ein Objekt, welches in einer WeakMap enthalten ist, nicht auf dessen Referenzzähler ein. Das bedeutet, dass wenn zu einem beliebigen Zeitpunkt die letzte verbleibende Referenz auf ein Objekt diejenige in einer WeakMap ist, wird das Objekt durch die Garbage Collection bereinigt und aus der WeakMap entfernt. Der primäre Anwendungsfall ist das Erzeugen eines Caches von Daten, die sich aus einem Objekt ableiten und keine längere Lebensdauer als das zugrunde liegende Objekt benötigen.

WeakMap implementiert ArrayAccess, Iterator und Countable, kann also in den meisten Fällen genau wie ein assoziatives Array verwendet werden.

Klassenbeschreibung

final class WeakMap implements ArrayAccess, Countable, IteratorAggregate {

/* Methoden */

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

}

Beispiele

Beispiel #1 Weakmap-Anwendungsbeispiel

<?php
$wm = new WeakMap();

$o = new stdClass;

class A {
    public function __destruct() {
        echo "Zerstört!\n";
    }
}

$wm[$o] = new A;

var_dump(count($wm));
echo "Entferne...\n";
unset($o);
echo "Fertig\n";
var_dump(count($wm));

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

int(1)
Entferne...
Zerstört!
Fertig
int(0)

Inhaltsverzeichnis

WeakMap::count — Zählt die aktiven Einträge in der Map
WeakMap::getIterator — Liefert einen externen Iterator
WeakMap::offsetExists — Prüft, ob ein bestimmtes Objekt in der Map enthalten ist
WeakMap::offsetGet — Gibt den Wert zurück, der einem bestimmten Objekt zugeordnet ist
WeakMap::offsetSet — Aktualisiert die Map mit einem neuen Schlüssel-Wert-Paar
WeakMap::offsetUnset — Entfernt einen Eintrag aus der Map

＋add a note

User Contributed Notes 2 notes

down

mrblc at example dot com ¶

1 year ago

@ malferov at gmail dot com

It works as intended. As soon as:
<?php
$wp[new stdClass()] = 'value';
?>
is executed, number of references is zero and garbage collector will remove it.

down

-11

malferov at gmail dot com ¶

1 year 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