Documentation for SplObjectStorage::removeAllExcept (Patch by Matthew Turland)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@307130 c90b9560-bf6c-de11-be94-00142212c4b1

reference/spl/splobjectstorage/removeallexcept.xml

@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 288721 $ -->
+
+<refentry xml:id="splobjectstorage.removeallexcept" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SplObjectStorage::removeAllExcept</refname>
+  <refpurpose>Removes all objects except for those contained in another storage from the current storage</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>SplObjectStorage::removeAllExcept</methodname>
+   <methodparam><type>SplObjectStorage</type><parameter>storage</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Removes all objects except for those contained in another storage from the current storage.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>storage</parameter></term>
+     <listitem>
+      <para>
+       The storage containing the elements to retain in the current storage.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>SplObjectStorage::removeAllExcept</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+&lt;?php
+$a = (object) 'a'; 
+$b = (object) 'b'; 
+$c = (object) 'c'; 
+
+$foo = new SplObjectStorage;
+$foo-&gt;attach($a);
+$foo-&gt;attach($b);
+
+$bar = new SplObjectStorage;
+$bar-&gt;attach($b);
+$bar-&gt;attach($c);
+
+$foo-&gt;removeAllExcept($bar);
+var_dump($foo-&gt;contains($a));
+var_dump($foo-&gt;contains($b));
+?&gt;
+]]>
+    </programlisting>
+    &example.outputs.similar;
+    <screen>
+<![CDATA[
+bool(false)
+bool(true)
+]]>
+    </screen>
+   </example>
+  </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
+-->
+

reference/spl/versions.xml

@@ -944,6 +944,7 @@
  <function name='splobjectstorage::offsetset' from='PHP 5 &gt;= 5.3.0'/>
  <function name='splobjectstorage::offsetunset' from='PHP 5 &gt;= 5.3.0'/>
  <function name='splobjectstorage::removeall' from='PHP 5 &gt;= 5.3.0'/>
+ <function name='splobjectstorage::removeallexcept' from='PHP 5 &gt;= 5.3.5'/>
  <function name='splobjectstorage::rewind' from='PHP 5 &gt;= 5.1.0'/>
  <function name='splobjectstorage::serialize' from='PHP 5 &gt;= 5.2.2'/>
  <function name='splobjectstorage::setinfo' from='PHP 5 &gt;= 5.3.0'/>