wddx-serialize-vars.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.wddx-serialize-vars" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>wddx_serialize_vars</refname>
  <refpurpose>Serialize variables into a WDDX packet</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
  &warn.removed.function-7-4-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>wddx_serialize_vars</methodname>
   <methodparam><type>mixed</type><parameter>var_name</parameter></methodparam>
   <methodparam rep="repeat"><type>mixed</type><parameter>var_names</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a WDDX packet with a structure that contains the serialized
   representation of the passed variables.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   This function takes a variable number of parameters.
   <variablelist>
    <varlistentry>
     <term><parameter>var_name</parameter></term>
     <listitem>
      <para>
       Can be either a string naming a variable or an array containing
       strings naming the variables or another array, etc.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>var_names</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the WDDX packet, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>wddx_serialize_vars</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = 1;
$b = 5.5;
$c = array("blue", "orange", "violet");
$d = "colors";

$clvars = array("c", "d");
echo wddx_serialize_vars("a", "b", $clvars);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
<wddxPacket version='1.0'><header/><data><struct><var name='a'><number>1</number></var>
<var name='b'><number>5.5</number></var><var name='c'><array length='3'>
<string>blue</string><string>orange</string><string>violet</string></array></var>
<var name='d'><string>colors</string></var></struct></data></wddxPacket>
]]>
    </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
-->