cvs: phpdoc /en/functions wddx.xml

From: Date: Sun, 16 Sep 2001 23:01:50 +0000
Subject: cvs: phpdoc /en/functions wddx.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969337594@lists.php.net to get a copy of this message
eschmid Sun Sep 16 19:01:50 2001 EDT Modified files: /phpdoc/en/functions wddx.xml Log: Whitespace fix. </para> should be on a newline. Index: phpdoc/en/functions/wddx.xml diff -u phpdoc/en/functions/wddx.xml:1.10 phpdoc/en/functions/wddx.xml:1.11 --- phpdoc/en/functions/wddx.xml:1.10 Sun Sep 16 15:34:10 2001 +++ phpdoc/en/functions/wddx.xml Sun Sep 16 19:01:49 2001 @@ -1,19 +1,19 @@ <?xml encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <reference id="ref.wddx"> - <title>WDDX functions</title> + <title>WDDX Functions</title> <titleabbrev>WDDX</titleabbrev> <partintro> <para> - These functions are intended for work with - <ulink url="&url.wddx;">WDDX</ulink>. + These functions are intended for work with <ulink + url="&url.wddx;">WDDX</ulink>. </para> <para> In order to use WDDX, you will need to install the expat library - (which comes with apache 1.3.7 or higher) and recompile PHP with - <option role="configure">--with-xml</option> and - <option role="configure">--enable-wddx</option>. + (which comes with apache 1.3.7 or higher) and recompile PHP with + <option role="configure">--with-xml</option> and <option + role="configure">--enable-wddx</option>. </para> <para> Note that all the functions that serialize variables use the first @@ -21,7 +21,6 @@ serialized into an array or structure. If the first element has string key, then it is serialized into a structure, otherwise, into an array. - <example> <title>Serializing a single value</title> <programlisting role="php"> @@ -29,8 +28,8 @@ print wddx_serialize_value("PHP to WDDX packet example", "PHP packet"); ?&gt; </programlisting> - </example></para> - + </example> + </para> <para> This example will produce: <informalexample> @@ -56,11 +55,10 @@ print $packet; ?&gt; </programlisting> - </example></para> - + </example> + </para> <para> This example will produce: - <informalexample> <programlisting role="php"> &lt;wddxPacket version='1.0'&gt;&lt;header comment='PHP'/&gt;&lt;data&gt;&lt;struct&gt; @@ -68,8 +66,8 @@ &lt;array length='3'&gt;&lt;string&gt;Austin&lt;/string&gt;&lt;string&gt;Novato&lt;/string&gt; &lt;string&gt;Seattle&lt;/string&gt;&lt;/array&gt;&lt;/var&gt;&lt;/struct&gt;&lt;/data&gt;&lt;/wddxPacket&gt; </programlisting> - </informalexample></para> - + </informalexample> + </para> </partintro> <refentry id="function.wddx-serialize-value"> @@ -88,14 +86,13 @@ <parameter><optional>comment</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - <para> <function>wddx_serialize_value</function> is used to create a WDDX packet from a single given value. It takes the value contained in <parameter>var</parameter>, and an optional <parameter>comment</parameter> string that appears in the packet - header, and returns the WDDX packet.</para> - + header, and returns the WDDX packet. + </para> </refsect1> </refentry> @@ -115,18 +112,17 @@ </paramdef> </funcprototype> </funcsynopsis> - <para> <function>wddx_serialize_vars</function> is used to create a WDDX packet with a structure that contains the serialized - representation of the passed variables.</para> - + representation of the passed variables. + </para> <para> <function>wddx_serialize_vars</function> takes a variable number of arguments, each of which can be either a string naming a variable or an array containing strings naming the variables or - another array, etc.</para> - + another array, etc. + </para> <para> <example> <title>wddx_serialize_vars example</title> @@ -141,8 +137,8 @@ print wddx_serialize_vars("a", "b", $clvars); ?&gt; </programlisting> - </example></para> - + </example> + </para> <para> The above example will produce: <programlisting> @@ -150,8 +146,8 @@ &lt;var name='b'&gt;&lt;number&gt;5.5&lt;/number&gt;&lt;/var&gt;&lt;var name='c'&gt;&lt;array length='3'&gt; &lt;string&gt;blue&lt;/string&gt;&lt;string&gt;orange&lt;/string&gt;&lt;string&gt;violet&lt;/string&gt;&lt;/array&gt;&lt;/var&gt; &lt;var name='d'&gt;&lt;string&gt;colors&lt;/string&gt;&lt;/var&gt;&lt;/struct&gt;&lt;/data&gt;&lt;/wddxPacket&gt; - </programlisting></para> - + </programlisting> + </para> </refsect1> </refentry> @@ -171,7 +167,6 @@ <parameter><optional>comment</optional></parameter></paramdef> </funcprototype> </funcsynopsis> - <para> Use <function>wddx_packet_start</function> to start a new WDDX packet for incremental addition of variables. It takes an @@ -195,12 +190,11 @@ <paramdef>int <parameter>packet_id</parameter></paramdef> </funcprototype> </funcsynopsis> - <para> <function>wddx_packet_end</function> ends the WDDX packet specified by the <parameter>packet_id</parameter> and returns the - string with the packet.</para> - + string with the packet. + </para> </refsect1> </refentry> @@ -223,14 +217,13 @@ </paramdef> </funcprototype> </funcsynopsis> - <para> <function>wddx_add_vars</function> is used to serialize passed variables and add the result to the packet specified by the <parameter>packet_id</parameter>. The variables to be serialized are specified in exactly the same way as - <function>wddx_serialize_vars</function>.</para> - + <function>wddx_serialize_vars</function>. + </para> </refsect1> </refentry> @@ -247,13 +240,12 @@ <paramdef>string <parameter>packet</parameter></paramdef> </funcprototype> </funcsynopsis> - <para> <function>wddx_deserialize</function> takes a <parameter>packet</parameter> string and deserializes it. It returns the result which can be string, number, or array. Note - that structures are deserialized into associative arrays.</para> - + that structures are deserialized into associative arrays. + </para> </refsect1> </refentry> </reference>

« previous php.doc (#969337594) next »