[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/weakref/_book.xml_versions.xml_weakmap/construct
From: Etienne_Kneuss <colder () php ! net>
Date: 2012-03-30 15:37:30
Message-ID: svn-colder-1333121850-324645-1135353177 () svn ! php ! net
[Download RAW message or body]
colder Fri, 30 Mar 2012 15:37:30 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=324645
Log:
Document WeakMap, available as of Weakref 0.2.0, Add version information for everything
Changed paths:
U phpdoc/en/trunk/reference/weakref/book.xml
A phpdoc/en/trunk/reference/weakref/versions.xml
A phpdoc/en/trunk/reference/weakref/weakmap/
A phpdoc/en/trunk/reference/weakref/weakmap/construct.xml
A phpdoc/en/trunk/reference/weakref/weakmap/count.xml
A phpdoc/en/trunk/reference/weakref/weakmap/current.xml
A phpdoc/en/trunk/reference/weakref/weakmap/key.xml
A phpdoc/en/trunk/reference/weakref/weakmap/next.xml
A phpdoc/en/trunk/reference/weakref/weakmap/offsetexists.xml
A phpdoc/en/trunk/reference/weakref/weakmap/offsetget.xml
A phpdoc/en/trunk/reference/weakref/weakmap/offsetset.xml
A phpdoc/en/trunk/reference/weakref/weakmap/offsetunset.xml
A phpdoc/en/trunk/reference/weakref/weakmap/rewind.xml
A phpdoc/en/trunk/reference/weakref/weakmap/valid.xml
A phpdoc/en/trunk/reference/weakref/weakmap.xml
U phpdoc/en/trunk/reference/weakref/weakref.xml
["svn-diffs-324645.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/reference/weakref/book.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/book.xml 2012-03-30 14:49:27 UTC (rev 324644)
+++ phpdoc/en/trunk/reference/weakref/book.xml 2012-03-30 15:37:30 UTC (rev 324645)
@@ -66,6 +66,7 @@
&reference.weakref.setup;
&reference.weakref.weakref;
+ &reference.weakref.weakmap;
</book>
Added: phpdoc/en/trunk/reference/weakref/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/versions.xml (rev 0)
+++ phpdoc/en/trunk/reference/weakref/versions.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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 >= 0.1.0'/>
+ <function name='weakref::__construct' from='PECL weakref >= 0.1.0'/>
+ <function name='weakref::acquire' from='PECL weakref >= 0.1.0'/>
+ <function name='weakref::get' from='PECL weakref >= 0.1.0'/>
+ <function name='weakref::release' from='PECL weakref >= 0.1.0'/>
+ <function name='weakref::valid' from='PECL weakref >= 0.1.0'/>
+
+ <function name='weakmap' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::__construct' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::count' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::offsetExists' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::offsetGet' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::offsetSet' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::offsetUnset' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::rewind' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::valid' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::key' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::current' from='PECL weakref >= 0.2.0'/>
+ <function name='weakmap::next' from='PECL weakref >= 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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/construct.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/construct.xml 2012-03-30 15:37:30 UTC \
(rev 324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/count.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/count.xml (rev \
0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/count.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/current.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/current.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/current.xml 2012-03-30 15:37:30 UTC \
(rev 324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/key.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/key.xml (rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/key.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/next.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/next.xml (rev \
0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/next.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/offsetexists.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/offsetexists.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/offsetexists.xml 2012-03-30 15:37:30 \
UTC (rev 324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/offsetget.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/offsetget.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/offsetget.xml 2012-03-30 15:37:30 UTC \
(rev 324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/offsetset.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/offsetset.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/offsetset.xml 2012-03-30 15:37:30 UTC \
(rev 324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/offsetunset.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/offsetunset.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/offsetunset.xml 2012-03-30 15:37:30 UTC \
(rev 324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/rewind.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/rewind.xml (rev \
0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/rewind.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap/valid.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap/valid.xml (rev \
0)
+++ phpdoc/en/trunk/reference/weakref/weakmap/valid.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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
+-->
Added: phpdoc/en/trunk/reference/weakref/weakmap.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakmap.xml (rev 0)
+++ phpdoc/en/trunk/reference/weakref/weakmap.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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
+-->
Modified: phpdoc/en/trunk/reference/weakref/weakref.xml
===================================================================
--- phpdoc/en/trunk/reference/weakref/weakref.xml 2012-03-30 14:49:27 UTC (rev \
324644)
+++ phpdoc/en/trunk/reference/weakref/weakref.xml 2012-03-30 15:37:30 UTC (rev \
324645) @@ -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 @@
$o1 = new MyClass;
-$r1 = new Weakref($o1);
+$r1 = new WeakRef($o1);
if ($r1->valid()) {
echo "Object still exists!\n";
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic