<?xml version="1.0" encoding="utf-8"?>

<reference xml:id="class.weakmap" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

<title>WeakMap クラス</title>

<titleabbrev>WeakMap</titleabbrev>

<partintro>

<!-- {{{ WeakMap intro -->

<section xml:id="weakmap.intro">

&reftitle.intro;

<para>

<classname>WeakMap</classname> は、

オブジェクトをキーとして受け入れるマップ(辞書)です。

<classname>SplObjectStorage</classname> と似ていますが、

<classname>WeakMap</classname> のキーとなるオブジェクトは、

オブジェクトのリファレンスカウントが更新されません。

つまり、<classname>WeakMap</classname>

のキーとなっているオブジェクトだけが唯一の残された参照だった場合、

オブジェクトはガベージコレクションの対象となり

<classname>WeakMap</classname> から削除されます。

<classname>WeakMap</classname> の用途は、

長く生き残る必要がないオブジェクトから派生した、

データのキャッシュを作ることです。

</para>

<para>

<classname>WeakMap</classname> は

<interfacename>ArrayAccess</interfacename>,

<interfacename>Traversable</interfacename> (<interfacename>IteratorAggregate</interfacename> 経由),

<interfacename>Countable</interfacename> を実装しています。

よって、ほとんどのケースで、

連想配列と同じやり方で操作できます。

</para>

</section>

<!-- }}} -->

<section xml:id="weakmap.synopsis">

&reftitle.classsynopsis;

<!-- {{{ Synopsis -->

<classsynopsis class="class">

<ooclass>

<modifier>final</modifier>

<classname>WeakMap</classname>

</ooclass>

<oointerface>

<modifier>implements</modifier>

<interfacename>ArrayAccess</interfacename>

</oointerface>

<oointerface>

<interfacename>Countable</interfacename>

</oointerface>

<oointerface>

<interfacename>IteratorAggregate</interfacename>

</oointerface>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.weakmap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='WeakMap'])">

<xi:fallback/>

</xi:include>

</classsynopsis>

<!-- }}} -->

</section>

<!-- {{{ weakmap examples -->

<section xml:id="weakmap.examples">

&reftitle.examples;

<para>

<example>

<title><classname>Weakmap</classname> の使い方の例</title>

<programlisting role="php">

<![CDATA[

</programlisting>

&example.outputs;

<screen>

<![CDATA[

</screen>

</example>

</para>

</section>

<!-- }}} -->

</partintro>

&language.predefined.weakmap.count;

&language.predefined.weakmap.getiterator;

&language.predefined.weakmap.offsetexists;

&language.predefined.weakmap.offsetget;

&language.predefined.weakmap.offsetset;

&language.predefined.weakmap.offsetunset;

</reference>