diff --git a/reference/wddx/functions/wddx-add-vars.xml b/reference/wddx/functions/wddx-add-vars.xml index 4bbea874f7..b39436cad7 100644 --- a/reference/wddx/functions/wddx-add-vars.xml +++ b/reference/wddx/functions/wddx-add-vars.xml @@ -1,25 +1,61 @@ - - + wddx_add_vars Add variables to a WDDX packet with the specified ID - - Description + + + &reftitle.description; boolwddx_add_vars - intpacket_id - mixedname_var + resourcepacket_id + mixedvar_name mixed... - wddx_add_vars is used to serialize passed - variables and add the result to the packet specified by the - packet_id. The variables to be serialized - are specified in exactly the same way as - wddx_serialize_vars. + Serializes the passed variables and add the result to the fiven packet. + + + + + &reftitle.parameters; + + This function takes a variable number of parameters. + + + packet_id + + + A WDDX packet, returned by wddx_packet_start. + + + + + var_name + + + Can be either a string naming a variable or an array containing + strings naming the variables or another array, etc. + + + + + ... + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/wddx/functions/wddx-packet-end.xml b/reference/wddx/functions/wddx-packet-end.xml index d28c64e180..845f53c564 100644 --- a/reference/wddx/functions/wddx-packet-end.xml +++ b/reference/wddx/functions/wddx-packet-end.xml @@ -1,21 +1,42 @@ - - + wddx_packet_end Ends a WDDX packet with the specified ID - - Description + + + &reftitle.description; stringwddx_packet_end resourcepacket_id - wddx_packet_end ends the WDDX packet - specified by the packet_id and returns the - string with the packet. + Ends and returns the given WDDX packet. + + + + + &reftitle.parameters; + + + + packet_id + + + A WDDX packet, returned by wddx_packet_start. + + + + + + + + + &reftitle.returnvalues; + + Returns the string containing the WDDX packet. diff --git a/reference/wddx/functions/wddx-packet-start.xml b/reference/wddx/functions/wddx-packet-start.xml index 568c5282c8..2629713022 100644 --- a/reference/wddx/functions/wddx-packet-start.xml +++ b/reference/wddx/functions/wddx-packet-start.xml @@ -1,23 +1,44 @@ - - + wddx_packet_start Starts a new WDDX packet with structure inside it - - Description + + + &reftitle.description; resourcewddx_packet_start stringcomment - Use wddx_packet_start to start a new WDDX - packet for incremental addition of variables. It takes an - optional comment string and returns a - packet ID for use in later functions. It automatically creates a - structure definition inside the packet to contain the variables. + Start a new WDDX packet for incremental addition of variables. + It automatically creates a structure definition inside the packet to + contain the variables. + + + + + &reftitle.parameters; + + + + comment + + + An optional comment string. + + + + + + + + + &reftitle.returnvalues; + + Returns a packet ID for use in later functions, or &false; on error. diff --git a/reference/wddx/functions/wddx-serialize-value.xml b/reference/wddx/functions/wddx-serialize-value.xml index 1ff6f28577..2d93d13a87 100644 --- a/reference/wddx/functions/wddx-serialize-value.xml +++ b/reference/wddx/functions/wddx-serialize-value.xml @@ -1,24 +1,51 @@ - - + wddx_serialize_value Serialize a single value into a WDDX packet - - Description + + + &reftitle.description; stringwddx_serialize_value mixedvar stringcomment - wddx_serialize_value is used to create a - WDDX packet from a single given value. It takes the value - contained in var, and an optional - comment string that appears in the packet - header, and returns the WDDX packet. + Creates a WDDX packet from a single given value. + + + + + &reftitle.parameters; + + + + var + + + The value to be serialized + + + + + comment + + + An optional comment string that appears in the packet header. + + + + + + + + + &reftitle.returnvalues; + + Returns the WDDX packet, or &false; on error. diff --git a/reference/wddx/functions/wddx-serialize-vars.xml b/reference/wddx/functions/wddx-serialize-vars.xml index 7752b67f1d..7832f2259b 100644 --- a/reference/wddx/functions/wddx-serialize-vars.xml +++ b/reference/wddx/functions/wddx-serialize-vars.xml @@ -1,29 +1,58 @@ - - + wddx_serialize_vars Serialize variables into a WDDX packet - - Description + + + &reftitle.description; stringwddx_serialize_vars mixedvar_name mixed... - wddx_serialize_vars is used to create a WDDX - packet with a structure that contains the serialized + Creates a WDDX packet with a structure that contains the serialized representation of the passed variables. + + + + &reftitle.parameters; - wddx_serialize_vars 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. + This function takes a variable number of parameters. + + + var_name + + + Can be either a string naming a variable or an array containing + strings naming the variables or another array, etc. + + + + + ... + + + + + + + + + + &reftitle.returnvalues; + + Returns the WDDX packet, or &false; on error. + + + + + &reftitle.examples; <function>wddx_serialize_vars</function> example @@ -40,18 +69,16 @@ echo wddx_serialize_vars("a", "b", $clvars); ?> ]]> - - - - The above example will produce: - + &example.outputs; +
1 5.5 blueorangeviolet colors ]]> - + + diff --git a/reference/wddx/functions/wddx-unserialize.xml b/reference/wddx/functions/wddx-unserialize.xml index 431eae9498..c53c169ecd 100644 --- a/reference/wddx/functions/wddx-unserialize.xml +++ b/reference/wddx/functions/wddx-unserialize.xml @@ -1,22 +1,43 @@ - - + wddx_unserialize Unserializes a WDDX packet - - Description + + + &reftitle.description; mixedwddx_unserialize stringpacket - wddx_unserialize takes a - packet string and unserializes it. It - returns the result which can be string, number, or array. Note - that structures are unserialized into associative arrays. + Unserializes a WDDX packet. + + + + + &reftitle.parameters; + + + + packet + + + A WDDX packet, as a string or stream. + + + + + + + + + &reftitle.returnvalues; + + Returns the unserialized value which can be a string, a number or an + array. Note that structures are unserialized into associative arrays.