PHP 8.1.24 Released!
    Submit a Pull Request Report a Bug

    WeakMap クラス

    (PHP 8)

    はじめに

    WeakMap は、 オブジェクトをキーとして受け入れるマップ(辞書)です。 SplObjectStorage と似ていますが、 WeakMap のキーとなるオブジェクトは、 オブジェクトのリファレンスカウントが更新されません。 つまり、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     "Dead!\n";
    }
    }

    $wm[$o] = new A;

    var_dump(count($wm));
    echo     "Unsetting...\n";
    unset(    $o);
    echo     "Done\n";
    var_dump(count($wm));

    上の例の出力は以下となります。

    int(1)
Unsetting...
Dead!
Done
int(0)

    目次

    ＋add a note

    User Contributed Notes 2 notes

    up
    7
    mrblc at example dot com
    5 months 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.
    up
    -11
    malferov at gmail dot com
    7 months 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
    To Top