File: wddx.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (247 lines) | stat: -rwxr-xr-x 8,645 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.wddx">
  <title>Funciones WDDX</title>
  <titleabbrev>WDDX</titleabbrev>
  
  <partintro>
   <para>
    Estas funciones permiten el uso de <ulink url="&url.wddx;">WDDX</ulink>.</para>
	
   <para>
    Debe saber que todas las funciones que serializan variables usan el primer
    elemento de un array para determinar si este ha de serializarse en forma de
    array o como estructura.  Si el primer elemento esta indexado por una cadena,
    se serializa como estructura, y en caso contrario, como array.

    <example>
     <title>Serializacion de un valor simple</title>
     <programlisting role="php">
&lt;?php
print wddx_serialize_value("Ejemplo de PHP a paquete WDDX", "Paquete PHP");
?&gt;
     </programlisting>
    </example></para>
	  
   <para>
    Este ejemplo producira:
    <informalexample>
     <programlisting role="php">
&lt;wddxPacket version='0.9'&gt;&lt;header comment='Paquete PHP'/&gt;&lt;data&gt;
&lt;string&gt;Ejemplo de PHP a paquete WDDX&lt;/string&gt;&lt;/data&gt;&lt;/wddxPacket&gt;
     </programlisting>
    </informalexample>

    <example>
     <title>Uso de paquetes incrementales</title>
     <programlisting role="php">
&lt;?php
$pi = 3.1415926;
$packet_id = wddx_packet_start("PHP");
wddx_add_vars($packet_id, "pi");

/* Suponga que $ciudades se ha obtenido de una base de datos */
$ciudades = array("Austin", "Novato", "Seattle");
wddx_add_vars($packet_id, "ciudades");

$packet = wddx_packet_end($packet_id);
print $packet;
?&gt;
     </programlisting>
    </example></para>
	  
   <para>
    Este ejemplo producira:

    <informalexample>
     <programlisting role="php">
&lt;wddxPacket version='0.9'&gt;&lt;header comment='PHP'/&gt;&lt;data&gt;&lt;struct&gt;
&lt;var name='pi'&gt;&lt;number&gt;3.1415926&lt;/number&gt;&lt;/var&gt;&lt;var name='ciudades'&gt;
&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>
   
  </partintro>
  
  <refentry id="function.wddx-serialize-value">
   <refnamediv>
    <refname>wddx_serialize_value</refname>
    <refpurpose>Serializa un valor simple en un paquete WDDX</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripcion</title>
     <methodsynopsis>
     <type>cadena</type><methodname>wddx_serialize_value</methodname>
     <methodparam><type>varios-tipos</type><parameter>var</parameter></methodparam>
     <methodparam choice="opt"><type>cadena</type><parameter>comentario</parameter></methodparam>
     </methodsynopsis>
	
    <para>
     <function>wddx_serialize_value</function> se utiliza para crear un
     paquete WDDX desde un valor simple dado.  Toma el valor contenido en
     <parameter>var</parameter>, y una cadena 
     <parameter>comentario</parameter> opcional que aparecera en la cabecera
     del paquete, y devuelve el paquete WDDX.</para>
	 	 
   </refsect1>
  </refentry>
  
  <refentry id="function.wddx-serialize-vars">
   <refnamediv>
    <refname>wddx_serialize_vars</refname>
    <refpurpose>Serializa variables en un paquete WDDX</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripcion</title>
     <methodsynopsis>
     <type>cadena</type><methodname>wddx_serialize_vars</methodname>
     <methodparam><type>varios-tipos</type><parameter>nombre_var</parameter></methodparam>
     <methodparam choice="opt"><type>varios-tipos</type><parameter>...</parameter></methodparam>
     </methodsynopsis>
	
    <para>
     <function>wddx_serialize_vars</function> se utiliza para crear un
     paquete WDDX con una estructura que contiene la representacion
     serializada de las variables pasadas como parametros.</para>
	 
    <para>
     <function>wddx_serialize_vars</function> toma un numero variable de
     argumentos, cada uno de los cuales puede ser una cadena con el nombre
     de una variable o un array con nombres de variables, o de otro array,
     etc.</para>
	 
    <para>
     <example>
      <title>wddx_serialize_vars example</title>
      <programlisting>
&lt;?php
$a = 1;
$b = 5.5;
$c = array("azul", "naranja", "violeta");
$d = "colores";

$clvars = array("c", "d");
print wddx_serialize_vars("a", "b", $clvars);
?&gt;
      </programlisting>
     </example></para>
	 
    <para>
     El ejemplo anterior producira:
     <programlisting>
&lt;wddxPacket version='0.9'&gt;&lt;header/&gt;&lt;data&gt;&lt;struct&gt;&lt;var name='a'&gt;&lt;number&gt;1&lt;/number&gt;&lt;/var&gt;
&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;azul&lt;/string&gt;&lt;string&gt;naranja&lt;/string&gt;&lt;string&gt;violeta&lt;/string&gt;&lt;/array&gt;&lt;/var&gt;
&lt;var name='d'&gt;&lt;string&gt;colores&lt;/string&gt;&lt;/var&gt;&lt;/struct&gt;&lt;/data&gt;&lt;/wddxPacket&gt;
     </programlisting></para>
	
   </refsect1>
  </refentry>
  
  <refentry id="function.wddx-packet-start">
   <refnamediv>
    <refname>wddx_packet_start</refname>
    <refpurpose>Comienza un nuevo paquete WDDX con una estructura dentro</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripcion</title>
     <methodsynopsis>
     <type>entero</type><methodname>wddx_packet_start</methodname>
     <methodparam choice="opt"><type>cadena</type><parameter>comentario</parameter></methodparam>
     </methodsynopsis>
	
    <para>
     Utilice <function>wddx_packet_start</function> para comenzar un nuevo
     paquete WDDX que permita la adicion sucesiva de variables. Recibe
     el parametro opcional <parameter>comentario</parameter> y devuelve un 
     identificador de paquete para su uso en posteriores llamadas. 
     Automaticamente define una estructura dentro del paquete para contener
     las variables.</para>
	 
   </refsect1>
  </refentry>
  
  <refentry id="function.wddx-packet-end">
   <refnamediv>
    <refname>wddx_packet_end</refname>
    <refpurpose>Finaliza un paquete WDDX con el identificador dado</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripcion</title>
     <methodsynopsis>
     <type>cadena</type><methodname>wddx_packet_end</methodname>
     <methodparam><type>entero</type><parameter>packet_id</parameter></methodparam>
     </methodsynopsis>
	
    <para>
     <function>wddx_packet_end</function> finaliza el paquete WDDX
     especificado por el <parameter>packet_id</parameter> y devuelve la
     cadena con el paquete.</para>
	 
   </refsect1>
  </refentry>
  
  <refentry id="function.wddx-add-vars">
   <refnamediv>
    <refname>wddx_add_vars</refname>
    <refpurpose>Finaliza un paquete WDDX con el identificador dado</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripcion</title>
     <methodsynopsis>
     <methodname>wddx_add_vars</methodname>
     <methodparam><type>entero</type><parameter>packet_id</parameter></methodparam>
     <methodparam><type>varios-tipos</type><parameter>name_var</parameter></methodparam>
     <methodparam choice="opt"><type>varios-tipos</type><parameter>...</parameter></methodparam>
     </methodsynopsis>
	
    <para>
     <function>wddx_add_vars</function> se utiliza para serializar las
     variables dadas e incorporar el resultado al paquete especificado por
     <parameter>packet_id</parameter>.  Las variables a serializar se
     especifican exactamente igual que en
     <function>wddx_serialize_vars</function>.</para>
     
   </refsect1>
  </refentry>
  
  <refentry id="function.wddx-deserialize">
   <refnamediv>
    <refname>wddx_deserialize</refname>
    <refpurpose>Des-serializa un paquete WDDX</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripcion</title>
     <methodsynopsis>
     <type>varios-tipos</type><methodname>wddx_deserialize</methodname>
     <methodparam><type>cadena</type><parameter>packet</parameter></methodparam>
     </methodsynopsis>
	
    <para>
     <function>wddx_deserialized</function> toma una cadena
     <parameter>packet</parameter> y la desserializa.  Devuelve
     el resultado que puede ser de tipo cadena, numerico o array.  Las
     estructuras son desserializadas en forma de arrays asociativos.</para>
     
   </refsect1>
  </refentry>
 </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:
-->