From 2c3b121e72d2adc73cb2fa6d7aaf6f8ef470a5ad Mon Sep 17 00:00:00 2001
From: Etienne Kneuss <colder@php.net>
Date: Fri, 30 Mar 2012 15:37:30 +0000
Subject: [PATCH] Document WeakMap, available as of Weakref 0.2.0, Add version
 information for everything

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324645 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/weakref/book.xml                 |   1 +
 reference/weakref/versions.xml             |  47 ++++++++
 reference/weakref/weakmap.xml              | 125 +++++++++++++++++++++
 reference/weakref/weakmap/construct.xml    |  56 +++++++++
 reference/weakref/weakmap/count.xml        |  53 +++++++++
 reference/weakref/weakmap/current.xml      |  55 +++++++++
 reference/weakref/weakmap/key.xml          |  56 +++++++++
 reference/weakref/weakmap/next.xml         |  55 +++++++++
 reference/weakref/weakmap/offsetexists.xml |  63 +++++++++++
 reference/weakref/weakmap/offsetget.xml    |  65 +++++++++++
 reference/weakref/weakmap/offsetset.xml    |  74 ++++++++++++
 reference/weakref/weakmap/offsetunset.xml  |  64 +++++++++++
 reference/weakref/weakmap/rewind.xml       |  55 +++++++++
 reference/weakref/weakmap/valid.xml        |  54 +++++++++
 reference/weakref/weakref.xml              |  14 +--
 15 files changed, 830 insertions(+), 7 deletions(-)
 create mode 100644 reference/weakref/versions.xml
 create mode 100644 reference/weakref/weakmap.xml
 create mode 100644 reference/weakref/weakmap/construct.xml
 create mode 100644 reference/weakref/weakmap/count.xml
 create mode 100644 reference/weakref/weakmap/current.xml
 create mode 100644 reference/weakref/weakmap/key.xml
 create mode 100644 reference/weakref/weakmap/next.xml
 create mode 100644 reference/weakref/weakmap/offsetexists.xml
 create mode 100644 reference/weakref/weakmap/offsetget.xml
 create mode 100644 reference/weakref/weakmap/offsetset.xml
 create mode 100644 reference/weakref/weakmap/offsetunset.xml
 create mode 100644 reference/weakref/weakmap/rewind.xml
 create mode 100644 reference/weakref/weakmap/valid.xml

diff --git a/reference/weakref/book.xml b/reference/weakref/book.xml
index 1af2517c2f..7d710476a7 100644
--- a/reference/weakref/book.xml
+++ b/reference/weakref/book.xml
@@ -66,6 +66,7 @@ Object is dead!
 
  &reference.weakref.setup;
  &reference.weakref.weakref;
+ &reference.weakref.weakmap;
 
 </book>
 
diff --git a/reference/weakref/versions.xml b/reference/weakref/versions.xml
new file mode 100644
index 0000000000..3a854a594d
--- /dev/null
+++ b/reference/weakref/versions.xml
@@ -0,0 +1,47 @@
+<?xml version='1.0' encoding='utf-8'?>
+<!-- $Revision: 288721 $ -->
+<!--
+  Do NOT translate this file
+-->
+<versions> 
+ <function name='weakref' from='PECL weakref &gt;= 0.1.0'/>
+ <function name='weakref::__construct' from='PECL weakref &gt;= 0.1.0'/>
+ <function name='weakref::acquire' from='PECL weakref &gt;= 0.1.0'/>
+ <function name='weakref::get' from='PECL weakref &gt;= 0.1.0'/>
+ <function name='weakref::release' from='PECL weakref &gt;= 0.1.0'/>
+ <function name='weakref::valid' from='PECL weakref &gt;= 0.1.0'/>
+
+ <function name='weakmap' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::__construct' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::count' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::offsetExists' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::offsetGet' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::offsetSet' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::offsetUnset' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::rewind' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::valid' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::key' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::current' from='PECL weakref &gt;= 0.2.0'/>
+ <function name='weakmap::next' from='PECL weakref &gt;= 0.2.0'/>
+</versions>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap.xml b/reference/weakref/weakmap.xml
new file mode 100644
index 0000000000..dfb76e8e21
--- /dev/null
+++ b/reference/weakref/weakmap.xml
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<phpdoc:classref xml:id="class.weakmap" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The WeakMap class</title>
+ <titleabbrev>WeakMap</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ WeakMap intro -->
+  <section xml:id="weakmap.intro">
+   &reftitle.intro;
+   <para>
+
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="weakmap.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>WeakMap</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>WeakMap</classname>
+     </ooclass>
+     
+     <oointerface>
+      <interfacename>Countable</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>ArrayAccess</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>Iterator</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>Traversable</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+<!-- }}} -->
+    
+    <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[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+<!-- {{{ weakmap examples -->
+  <section xml:id="weakmap.examples">
+   &reftitle.examples;
+   <para>
+    <example>
+     <title><classname>Weakmap</classname> usage example</title>
+     <programlisting role="php">
+<![CDATA[
+<?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));
+]]>
+     </programlisting>
+     &example.outputs;
+     <screen>
+<![CDATA[
+int(1)
+Unsetting..
+Dead!
+Done
+int(0)
+]]>
+     </screen>
+    </example>
+   </para>
+  </section>
+<!-- }}} -->
+
+ </partintro>
+
+ &reference.weakref.entities.weakmap;
+
+</phpdoc:classref>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/construct.xml b/reference/weakref/weakmap/construct.xml
new file mode 100644
index 0000000000..cd2294c5cb
--- /dev/null
+++ b/reference/weakref/weakmap/construct.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::__construct</refname>
+  <refpurpose>Constructs a new map</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <methodname>WeakMap::__construct</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Constructs a new map.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/count.xml b/reference/weakref/weakmap/count.xml
new file mode 100644
index 0000000000..b0bb65d7ea
--- /dev/null
+++ b/reference/weakref/weakmap/count.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::count</refname>
+  <refpurpose>Counts the number of live entries in the map</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>WeakMap::count</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Counts the number of live entries in the map.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the number of live entries in the map.
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/current.xml b/reference/weakref/weakmap/current.xml
new file mode 100644
index 0000000000..56a08c50f7
--- /dev/null
+++ b/reference/weakref/weakmap/current.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::current</refname>
+  <refpurpose>Returns the current value under iteration</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>mixed</type><methodname>WeakMap::current</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the current value being iterated on in the map.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The value currently being iterated on.
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/key.xml b/reference/weakref/weakmap/key.xml
new file mode 100644
index 0000000000..75d3f2207d
--- /dev/null
+++ b/reference/weakref/weakmap/key.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::key</refname>
+  <refpurpose>Returns the current key under iteration.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>object</type><methodname>WeakMap::key</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the object serving as key in the map, at the current iterating
+   position.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The object key currently being iterated.
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/next.xml b/reference/weakref/weakmap/next.xml
new file mode 100644
index 0000000000..0b6077e978
--- /dev/null
+++ b/reference/weakref/weakmap/next.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::next</refname>
+  <refpurpose>Advances to the next map element</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>WeakMap::next</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Advances to the next map element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/offsetexists.xml b/reference/weakref/weakmap/offsetexists.xml
new file mode 100644
index 0000000000..e2186d26ea
--- /dev/null
+++ b/reference/weakref/weakmap/offsetexists.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::offsetExists</refname>
+  <refpurpose>Checks whether a certain object is in the map</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>WeakMap::offsetExists</methodname>
+   <methodparam><type>object</type><parameter>object</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Checks whether the passed object is referenced in the map.
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>object</parameter></term>
+    <listitem>
+     <para>
+      Object to check for.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the object is contained in the map, &false; otherwise.
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/offsetget.xml b/reference/weakref/weakmap/offsetget.xml
new file mode 100644
index 0000000000..f5eec1d26e
--- /dev/null
+++ b/reference/weakref/weakmap/offsetget.xml
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::offsetGet</refname>
+  <refpurpose>Returns the value pointed to by a certain object</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>mixed</type><methodname>WeakMap::offsetGet</methodname>
+   <methodparam><type>object</type><parameter>object</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Returns the value pointed to by a certain object.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>object</parameter></term>
+    <listitem>
+     <para>
+      Some object contained as key in the map.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the value associated to the object passed as argument, &null;
+   otherwise.
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/offsetset.xml b/reference/weakref/weakmap/offsetset.xml
new file mode 100644
index 0000000000..6611e06229
--- /dev/null
+++ b/reference/weakref/weakmap/offsetset.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.offsetset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::offsetSet</refname>
+  <refpurpose>Updates the map with a new key-value pair</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>WeakMap::offsetSet</methodname>
+   <methodparam><type>object</type><parameter>object</parameter></methodparam>
+   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Updates the map with a new key-value pair. If the key already existed in
+   the map, the old value is replaced with the new.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>object</parameter></term>
+    <listitem>
+     <para>
+       The object serving as key of the key-value pair. 
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>value</parameter></term>
+    <listitem>
+     <para>
+       The arbitrary data serving as value of the key-value pair. 
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/offsetunset.xml b/reference/weakref/weakmap/offsetunset.xml
new file mode 100644
index 0000000000..45cad347c1
--- /dev/null
+++ b/reference/weakref/weakmap/offsetunset.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::offsetUnset</refname>
+  <refpurpose>Removes an entry from the map</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>WeakMap::offsetUnset</methodname>
+   <methodparam><type>object</type><parameter>object</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Removes an entry from the map.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>object</parameter></term>
+    <listitem>
+     <para>
+      The key object to remove from the map. 
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/rewind.xml b/reference/weakref/weakmap/rewind.xml
new file mode 100644
index 0000000000..2d1a4fa2d6
--- /dev/null
+++ b/reference/weakref/weakmap/rewind.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::rewind</refname>
+  <refpurpose>Rewinds the iterator to the beginning of the map</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>WeakMap::rewind</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+    Rewinds the iterator to the beginning of the map.  
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+    &return.void;
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakmap/valid.xml b/reference/weakref/weakmap/valid.xml
new file mode 100644
index 0000000000..f963e1c4c9
--- /dev/null
+++ b/reference/weakref/weakmap/valid.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="weakmap.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>WeakMap::valid</refname>
+  <refpurpose>Returns whether the iterator is still on a valid map element</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>WeakMap::valid</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns whether the iterator is still on a valid map element.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+    Returns &true; if the iterator is on a valid element that can be
+    accessed, &false; otherwise.
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/weakref/weakref.xml b/reference/weakref/weakref.xml
index aa8b847132..6d6a96236c 100644
--- a/reference/weakref/weakref.xml
+++ b/reference/weakref/weakref.xml
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
 <phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.weakref" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
- <title>The Weakref class</title>
- <titleabbrev>Weakref</titleabbrev>
+ <title>The WeakRef class</title>
+ <titleabbrev>WeakRef</titleabbrev>
 
  <partintro>
 
@@ -10,7 +10,7 @@
   <section xml:id="weakref.intro">
    &reftitle.intro;
    <para>
-    The Weakref class provides a gateway to objects without preventing the garbage collector from freeing those objects.
+    The WeakRef class provides a gateway to objects without preventing the garbage collector from freeing those objects.
     It also provides a way to turn a weak reference into a strong one.
    </para>
   </section>
@@ -21,13 +21,13 @@
 
 <!-- {{{ Synopsis -->
    <classsynopsis>
-    <ooclass><classname>Weakref</classname></ooclass>
+    <ooclass><classname>WeakRef</classname></ooclass>
 
 <!-- {{{ Class synopsis -->
 
     <classsynopsisinfo>
      <ooclass>
-      <classname>Weakref</classname>
+      <classname>WeakRef</classname>
      </ooclass>
 
     </classsynopsisinfo>
@@ -44,7 +44,7 @@
    &reftitle.examples;
    <para>
     <example>
-     <title><classname>Weakref</classname> usage example</title>
+     <title><classname>WeakRef</classname> usage example</title>
      <programlisting role="php">
 <![CDATA[
 <?php
@@ -56,7 +56,7 @@ class MyClass {
 
 $o1 = new MyClass;
 
-$r1 = new Weakref($o1);
+$r1 = new WeakRef($o1);
 
 if ($r1->valid()) {
     echo "Object still exists!\n";