Files
doc-en/reference/wddx/reference.xml
Antony Dovgal e093fea5c5 fix typo
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@174211 c90b9560-bf6c-de11-be94-00142212c4b1
2004-12-07 07:31:27 +00:00

137 lines
3.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<reference id="ref.wddx">
<title>WDDX Functions</title>
<titleabbrev>WDDX</titleabbrev>
<partintro>
<section id="wddx.intro">
&reftitle.intro;
<para>
These functions are intended for work with <ulink
url="&url.wddx;">WDDX</ulink>.
</para>
</section>
<section id="wddx.requirements">
&reftitle.required;
<para>
In order to use WDDX, you will need to install the expat library
(which comes with Apache 1.3.7 or higher).
</para>
</section>
&reference.wddx.configure;
<section id="wddx.configuration">
&reftitle.runtime;
&no.config;
</section>
<section id="wddx.resources">
&reftitle.resources;
&no.resource;
</section>
<section id="wddx.constants">
&reftitle.constants;
&no.constants;
</section>
<section id="wddx.examples">
&reftitle.examples;
<para>
All the functions that serialize variables use the first
element of an array to determine whether the array is to be
serialized into an array or structure. If the first element has
string key, then it is serialized into a structure, otherwise,
into an array.
</para>
<example>
<title>Serializing a single value with WDDX</title>
<programlisting role="php">
<![CDATA[
<?php
echo wddx_serialize_value("PHP to WDDX packet example", "PHP packet");
?>
]]>
</programlisting>
<para>
This example will produce:
</para>
<screen>
<![CDATA[
<wddxPacket version='1.0'><header comment='PHP packet'/><data>
<string>PHP to WDDX packet example</string></data></wddxPacket>
]]>
</screen>
</example>
<example>
<title>Using incremental packets with WDDX</title>
<programlisting role="php">
<![CDATA[
<?php
$pi = 3.1415926;
$packet_id = wddx_packet_start("PHP");
wddx_add_vars($packet_id, "pi");
/* Suppose $cities came from database */
$cities = array("Austin", "Novato", "Seattle");
wddx_add_vars($packet_id, "cities");
$packet = wddx_packet_end($packet_id);
echo $packet;
?>
]]>
</programlisting>
<para>
This example will produce:
</para>
<screen>
<![CDATA[
<wddxPacket version='1.0'><header comment='PHP'/><data><struct>
<var name='pi'><number>3.1415926</number></var><var name='cities'>
<array length='3'><string>Austin</string><string>Novato</string>
<string>Seattle</string></array></var></struct></data></wddxPacket>
]]>
</screen>
</example>
<note>
<para>
If you want to serialize non-ASCII characters you have to convert
your data to UTF-8 first (see <function>utf8_encode</function> and
<function>iconv</function>).
</para>
</note>
</section>
</partintro>
&reference.wddx.functions;
</reference>
<!-- 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
-->