From 49d51f7bae637a12ec03324abdfbb1b84cdbd88b Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Thu, 10 Sep 2009 06:05:12 +0000
Subject: [PATCH] Added skeletons for the ArrayObject unserialize/serialize
 methods

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288223 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/arrayobject/serialize.xml   | 96 +++++++++++++++++++++++
 reference/spl/arrayobject/unserialize.xml | 79 +++++++++++++++++++
 2 files changed, 175 insertions(+)
 create mode 100644 reference/spl/arrayobject/serialize.xml
 create mode 100644 reference/spl/arrayobject/unserialize.xml

diff --git a/reference/spl/arrayobject/serialize.xml b/reference/spl/arrayobject/serialize.xml
new file mode 100644
index 0000000000..9a04a20a4e
--- /dev/null
+++ b/reference/spl/arrayobject/serialize.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="arrayobject.serialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ArrayObject::serialize</refname>
+  <refpurpose>Serialize an ArrayObject</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>ArrayObject::serialize</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Serializes an <classname>ArrayObject</classname>.
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The serialized representation of the <classname>ArrayObject</classname>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>ArrayObject::serialize</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$o = new ArrayObject();
+
+$s1 = serialize($o);
+$s2 = $o->serialize();
+
+var_dump($s1);
+var_dump($s2);
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+string(45) "C:11:"ArrayObject":21:{x:i:0;a:0:{};m:a:0:{}}"
+string(21) "x:i:0;a:0:{};m:a:0:{}"
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>ArrayObject::unserialize</methodname></member>
+    <member><function>serialize</function></member>
+    <member><link linkend="language.oop.serialization">Serializing Objects</link></member>
+   </simplelist>
+  </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:"../../../../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/spl/arrayobject/unserialize.xml b/reference/spl/arrayobject/unserialize.xml
new file mode 100644
index 0000000000..f974167519
--- /dev/null
+++ b/reference/spl/arrayobject/unserialize.xml
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="arrayobject.unserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ArrayObject::unserialize</refname>
+  <refpurpose>Unserialize an ArrayObject</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>ArrayObject::unserialize</methodname>
+   <methodparam><type>string</type><parameter>serialized</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Unserializes a serialized <classname>ArrayObject</classname>.
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>serialized</parameter></term>
+     <listitem>
+      <para>
+       The serialized <classname>ArrayObject</classname>.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The unserialized <classname>ArrayObject</classname>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><methodname>ArrayIterator::serialize</methodname></member>
+    <member><function>unserialize</function></member>
+    <member><link linkend="language.oop.serialization">Serializing Objects</link></member>
+   </simplelist>
+  </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:"../../../../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
+-->