diff --git a/reference/array/functions/array-rand.xml b/reference/array/functions/array-rand.xml index 2a2619eaa2..fc8e9b0605 100644 --- a/reference/array/functions/array-rand.xml +++ b/reference/array/functions/array-rand.xml @@ -1,13 +1,12 @@ - - + array_rand Pick one or more random entries out of an array - - Description + + &reftitle.description; mixedarray_rand arrayinput @@ -15,20 +14,44 @@ array_rand is rather useful when you want to - pick one or more random entries out of an array. It takes an - input array and an optional argument - num_req which specifies how many entries you - want to pick - if not specified, it defaults to 1. + pick one or more random entries out of an array. + + + &reftitle.parameters; + + + + input + + + The input array. + + + + + num_req + + + Specifies how many entries you want to pick - if not specified, + defaults to 1. + + + + + + + + &reftitle.returnvalues; If you are picking only one entry, array_rand returns the key for a random entry. Otherwise, it returns an array of keys for the random entries. This is done so that you can pick random keys as well as values out of the array. - - ¬e.randomseed; - + + + &reftitle.examples; <function>array_rand</function> example @@ -45,8 +68,17 @@ echo $input[$rand_keys[1]] . "\n"; + + + &reftitle.notes; + ¬e.randomseed; + + + &reftitle.seealso; - See also shuffle. + + shuffle + diff --git a/reference/array/functions/array-reduce.xml b/reference/array/functions/array-reduce.xml index dd9506324e..0d5d697dba 100644 --- a/reference/array/functions/array-reduce.xml +++ b/reference/array/functions/array-reduce.xml @@ -1,13 +1,12 @@ - - + array_reduce Iteratively reduce the array to a single value using a callback function - - Description + + &reftitle.description; mixedarray_reduce arrayinput @@ -18,12 +17,54 @@ array_reduce applies iteratively the function function to the elements of the array input, so as to reduce the array to - a single value. If the optional initial is - available, it will be used at the beginning of the process, or as - a final result in case the array is empty. + a single value. + + + + &reftitle.parameters; + + + + input + + + The input array. + + + + + function + + + The callback function. + + + + + initial + + + If the optional initial is available, it will + be used at the beginning of the process, or as a final result in case + the array is empty. + + + + + + + + &reftitle.returnvalues; + + Returns the resulting value. + + If the array is empty and initial is not passed, array_reduce returns &null;. + + + &reftitle.examples; <function>array_reduce</function> example @@ -50,19 +91,24 @@ $d = array_reduce($x, "rsum", 1); ?> ]]> + + This will result in $b containing + 15, $c containing + 1200 (= 10*1*2*3*4*5), and $d + containing 1. + + + + &reftitle.seealso; - This will result in $b containing - 15, $c containing - 1200 (= 10*1*2*3*4*5), and - $d containing 1. - - - See also array_filter, - array_map, - array_unique, and - array_count_values. + + array_filter + array_map + array_unique + array_count_values + diff --git a/reference/array/functions/array-sum.xml b/reference/array/functions/array-sum.xml index ddb2dfb335..0e9acf8e3f 100644 --- a/reference/array/functions/array-sum.xml +++ b/reference/array/functions/array-sum.xml @@ -1,21 +1,68 @@ - - + array_sum Calculate the sum of values in an array - - Description + + &reftitle.description; numberarray_sum arrayarray - array_sum returns the sum of values - in an array as an integer or float. + array_sum returns the sum of values in an array. + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + + + + &reftitle.returnvalues; + + Returns the sum of values as an integer or float. + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.2.1 + + PHP versions prior to 4.2.1 modified the passed array itself and + converted strings to numbers (which most of the time converted them + to zero, depending on their value). + + + + + + + + + &reftitle.examples; <function>array_sum</function> examples @@ -39,14 +86,6 @@ sum(b) = 6.9 - - - PHP versions prior to 4.2.1 modified the passed array - itself and converted strings to numbers (which most - of the time converted them to zero, depending on - their value). - - diff --git a/reference/array/functions/array-unshift.xml b/reference/array/functions/array-unshift.xml index d9712d6a63..68895d6353 100644 --- a/reference/array/functions/array-unshift.xml +++ b/reference/array/functions/array-unshift.xml @@ -1,13 +1,12 @@ - - + array_unshift Prepend one or more elements to the beginning of an array - - Description + + &reftitle.description; intarray_unshift arrayarray @@ -15,16 +14,44 @@ mixed... - array_unshift prepends passed elements to - the front of the array. Note that the list - of elements is prepended as a whole, so that the prepended - elements stay in the same order. All numerical array keys will be - modified to start counting from zero while literal keys won't be touched. + array_unshift prepends passed elements to the front + of the array. Note that the list of elements is + prepended as a whole, so that the prepended elements stay in the same + order. All numerical array keys will be modified to start counting from + zero while literal keys won't be touched. + + + &reftitle.parameters; - Returns the new number of elements in the - array. + + + array + + + The input array. + + + + + var + + + The prepended variable. + + + + + + + &reftitle.returnvalues; + + Returns the new number of elements in the array. + + + + &reftitle.examples; <function>array_unshift</function> example @@ -51,10 +78,15 @@ Array + + + &reftitle.seealso; - See also array_shift, - array_push, and - array_pop. + + array_shift + array_push + array_pop + diff --git a/reference/array/functions/arsort.xml b/reference/array/functions/arsort.xml index 6daa22977e..1e2f55298b 100644 --- a/reference/array/functions/arsort.xml +++ b/reference/array/functions/arsort.xml @@ -1,30 +1,63 @@ - - + arsort Sort an array in reverse order and maintain index association - - Description + + &reftitle.description; boolarsort arrayarray intsort_flags - This function sorts an array such that array indices maintain - their correlation with the array elements they are associated - with. This is used mainly when sorting associative arrays where - the actual element order is significant. + This function sorts an array such that array indices maintain their + correlation with the array elements they are associated with. + + This is used mainly when sorting associative arrays where the actual + element order is significant. + + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + sort_flags + + + You may modify the behavior of the sort using the optional parameter + sort_flags, for details see + sort. + + + + + + + + &reftitle.returnvalues; &return.success; - - <function>arsort</function> example - + + + &reftitle.examples; + + + <function>arsort</function> example + "lemon", "a" => "orange", "b" => "banana", "c" => "apple"); @@ -34,29 +67,32 @@ foreach ($fruits as $key => $val) { } ?> ]]> - - &example.outputs; - + + &example.outputs; + - - - - The fruits have been sorted in reverse alphabetical order, and - the index associated with each element has been maintained. + + + The fruits have been sorted in reverse alphabetical order, and + the index associated with each element has been maintained. + + + + + &reftitle.seealso; - You may modify the behavior of the sort using the optional - parameter sort_flags, for details - see sort. - - - See also asort, rsort, - ksort, and sort. + + asort + rsort + ksort + sort + diff --git a/reference/array/functions/krsort.xml b/reference/array/functions/krsort.xml index 7992e4f5c8..fe0e081bca 100644 --- a/reference/array/functions/krsort.xml +++ b/reference/array/functions/krsort.xml @@ -1,13 +1,12 @@ - - + krsort Sort an array by key in reverse order - - Description + + &reftitle.description; boolkrsort arrayarray @@ -17,9 +16,40 @@ Sorts an array by key in reverse order, maintaining key to data correlations. This is useful mainly for associative arrays. + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + sort_flags + + + You may modify the behavior of the sort using the optional parameter + sort_flags, for details see + sort. + + + + + + + + &reftitle.returnvalues; &return.success; + + + &reftitle.examples; <function>krsort</function> example @@ -45,16 +75,19 @@ a = orange + + + &reftitle.seealso; - You may modify the behavior of the sort using the optional - parameter sort_flags, for details - see sort. + + asort + arsort + ksort + sort + natsort + rsort + - - See also asort, arsort, - ksort, sort, - natsort, and rsort. - diff --git a/reference/array/functions/prev.xml b/reference/array/functions/prev.xml index 5ad74f3a1f..93478ac15a 100644 --- a/reference/array/functions/prev.xml +++ b/reference/array/functions/prev.xml @@ -1,38 +1,49 @@ - - + prev Rewind the internal array pointer - - Description + + &reftitle.description; mixedprev arrayarray + + Rewind the internal array pointer. + + + prev behaves just like next, + except it rewinds the internal array pointer one place instead of advancing it. + + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + + + + &reftitle.returnvalues; Returns the array value in the previous place that's pointed to by the internal array pointer, or &false; if there are no more elements. - - &return.falseproblem; - - - - You won't be able to distinguish the beginning of an array from a - boolean &false; element. To properly traverse an array - which may contain &false; elements, see the each - function. - - - - prev behaves just like - next, except it rewinds the internal array - pointer one place instead of advancing it. - + + + &reftitle.examples; Example use of <function>prev</function> and friends @@ -50,10 +61,29 @@ $mode = end($transport); // $mode = 'plane'; + + + &reftitle.notes; + &return.falseproblem; + + + You won't be able to distinguish the beginning of an array from a + boolean &false; element. To properly traverse an array + which may contain &false; elements, see the each + function. + + + + + &reftitle.seealso; - See also current, end, - next, reset, - and each. + + current + end + next + reset + each + diff --git a/reference/array/functions/reset.xml b/reference/array/functions/reset.xml index 7199540c77..7bd21b98a3 100644 --- a/reference/array/functions/reset.xml +++ b/reference/array/functions/reset.xml @@ -1,22 +1,46 @@ - - + reset Set the internal pointer of an array to its first element - - Description + + &reftitle.description; mixedreset arrayarray - reset rewinds array's - internal pointer to the first element and returns the value of the first - array element, or &false; if the array is empty. + reset rewinds array's internal + pointer to the first element and returns the value of the first array + element. + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + + + + &reftitle.returnvalues; + + Returns the value of the first array element, or &false; if the array is + empty. + + + + &reftitle.examples; <function>reset</function> example @@ -43,10 +67,17 @@ echo current($array) . "
\n"; // "step one" + + + &reftitle.seealso; - See also current, - each, end, - next, and prev. + + current + each + end + next + prev + diff --git a/reference/array/functions/rsort.xml b/reference/array/functions/rsort.xml index 338ce5268f..191e9af728 100644 --- a/reference/array/functions/rsort.xml +++ b/reference/array/functions/rsort.xml @@ -1,13 +1,12 @@ - - + rsort Sort an array in reverse order - - Description + + &reftitle.description; boolrsort arrayarray @@ -16,10 +15,40 @@ This function sorts an array in reverse order (highest to lowest). - ¬e.no-key-association; + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + sort_flags + + + You may modify the behavior of the sort using the optional + parameter sort_flags, for details see + sort. + + + + + + + + &reftitle.returnvalues; &return.success; + + + &reftitle.examples; <function>rsort</function> example @@ -43,21 +72,27 @@ foreach ($fruits as $key => $val) { 3 = apple ]]> + + The fruits have been sorted in reverse alphabetical order. + + + + &reftitle.notes; + ¬e.no-key-association; + + + &reftitle.seealso; - The fruits have been sorted in reverse alphabetical order. - - - You may modify the behavior of the sort using the optional - parameter sort_flags, for details - see sort. - - - See also arsort, - asort, ksort, - krsort, - sort, and usort. + + arsort + asort + ksort + krsort + sort + usort + diff --git a/reference/array/functions/uasort.xml b/reference/array/functions/uasort.xml index df2e31048e..3c1b0f0983 100644 --- a/reference/array/functions/uasort.xml +++ b/reference/array/functions/uasort.xml @@ -1,40 +1,69 @@ - - + uasort Sort an array with a user-defined comparison function and maintain index association - - Description + + &reftitle.description; booluasort arrayarray callbackcmp_function - This function sorts an array such that array indices maintain - their correlation with the array elements they are associated - with. This is used mainly when sorting associative arrays where - the actual element order is significant. The comparison function - is user-defined. + This function sorts an array such that array indices maintain their + correlation with the array elements they are associated with, using a + user-defined comparison function. + + This is used mainly when sorting associative arrays where the actual + element order is significant. + + + + &reftitle.parameters; + + + + array + + + The input array. + + + + + cmp_function + + + See usort and uksort for + examples of user-defined comparison functions. + + + + + + + + &reftitle.returnvalues; &return.success; - - - Please see usort and - uksort for examples of user-defined - comparison functions. - - + + + &reftitle.seealso; - See also usort, uksort, - sort, asort, - arsort, ksort, - and rsort. + + usort + uksort + asort + arsort + ksort + rsort + sort + diff --git a/reference/com/functions/com-create-guid.xml b/reference/com/functions/com-create-guid.xml index da887a79d8..5e4466d320 100644 --- a/reference/com/functions/com-create-guid.xml +++ b/reference/com/functions/com-create-guid.xml @@ -1,23 +1,36 @@ - + com_create_guid Generate a globally unique identifier (GUID) - - Description + + &reftitle.description; stringcom_create_guid - Generates a Globally Unique Identifier (GUID) and returns it as a string. + Generates a Globally Unique Identifier (GUID). + + A GUID is generated in the same way as DCE UUID's, except that the Microsoft convention is to enclose a GUID in curly braces. + + + &reftitle.returnvalues; - See also uuid_create in the PECL uuid extension. + Returns the GUID as a string. + + + + &reftitle.seealso; + + + uuid_create in the PECL uuid extension + diff --git a/reference/com/functions/com-release.xml b/reference/com/functions/com-release.xml index 199a2f5267..f2ce8d32f9 100644 --- a/reference/com/functions/com-release.xml +++ b/reference/com/functions/com-release.xml @@ -1,32 +1,56 @@ - - + com_release Decreases the components reference counter [deprecated] - - Description + + &reftitle.description; - voidcom_release - + voidcom_release + Decreases the components reference counter. - + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 5.0.0 + + This function was removed. + + + + + + + + + &reftitle.notes; You should never need to use this function. - - - This function has gone away in PHP 5. - - - diff --git a/reference/com/functions/variant-abs.xml b/reference/com/functions/variant-abs.xml index 2cf6957729..2fddc1c759 100644 --- a/reference/com/functions/variant-abs.xml +++ b/reference/com/functions/variant-abs.xml @@ -1,27 +1,49 @@ - + variant_abs Returns the absolute value of a variant - - Description + + &reftitle.description; mixedvariant_abs mixedval - + + Returns the absolute value of a variant. + + + + &reftitle.parameters; + + + + val + + + The variant. + + + + + &com.variant-arith; + + + + &reftitle.returnvalues; Returns the absolute value of val. - + + + &reftitle.seealso; - See also abs. + + abs + - - &com.variant-arith; - diff --git a/reference/com/functions/variant-cat.xml b/reference/com/functions/variant-cat.xml index 74c0ec2126..46039b89c2 100644 --- a/reference/com/functions/variant-cat.xml +++ b/reference/com/functions/variant-cat.xml @@ -1,32 +1,65 @@ - - + variant_cat concatenates two variant values together and returns the result - - Description + + &reftitle.description; mixedvariant_cat mixedleft mixedright - Concatenates left with right and returns the result. - - See also for the string - concatenation operator; this function is notionally equivalent to + This function is notionally equivalent to $left . $right. - + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + &com.variant-arith; + + &reftitle.returnvalues; + + Returns the result of the concatenation. + + + + &reftitle.seealso; + + + for the string + concatenation operator + + + - + variant_cmp Compares two variants - - Description + + &reftitle.description; intvariant_cmp mixedleft @@ -15,109 +14,134 @@ intlcid intflags - - Compares left with right - and returns one of the following values: - + Compares left with right. + + + This function will only compare scalar values, not arrays or variant records. + + + + &reftitle.parameters; + + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + + lcid + + + A valid Locale Identifier to use when comparing strings (this affects + string collation). + + + + + flags + + + flags can be one or more of the following values + OR'd together, and affects string comparisons: + + Variant Comparision Flags + + + + value + meaning + + + + + NORM_IGNORECASE + Compare case insensitively + + + NORM_IGNORENONSPACE + Ignore nonspacing characters + + + NORM_IGNORESYMBOLS + Ignore symbols + + + NORM_IGNOREWIDTH + Ignore string width + + + NORM_IGNOREKANATYPE + Ignore Kana type + + + NORM_IGNOREKASHIDA + Ignore Arabic kashida characters + + + +
+ + + + + + &com.variant-arith; + + + &reftitle.returnvalues; + + Returns one of the following: Variant Comparision Results - - - value - meaning - - - - - VARCMP_LT - left is less than - right - - - - - VARCMP_EQ - left is equal to - right - - - - - VARCMP_GT - left is greater than - right - - - - - VARCMP_NULL - Either left, - right or both are &null; - - - + + + value + meaning + + + + + VARCMP_LT + left is less than + right + + + + VARCMP_EQ + left is equal to + right + + + + VARCMP_GT + left is greater than + right + + + + VARCMP_NULL + Either left, + right or both are &null; + + - -
- - - - This function will only compare scalar values, not arrays or variant records. - - - - lcid is a valid Locale Identifier to use when - comparing strings (this affects string collation). - flags can be one or more of the following values - OR'd together, and affects string comparisons: - - - Variant Comparision Flags - - - - value - meaning - - - - - NORM_IGNORECASE - Compare case insensitively - - - - NORM_IGNORENONSPACE - Ignore nonspacing characters - - - - NORM_IGNORESYMBOLS - Ignore symbols - - - - NORM_IGNOREWIDTH - Ignore string width - - - - NORM_IGNOREKANATYPE - Ignore Kana type - - - - NORM_IGNOREKASHIDA - Ignore Arabic kashida characters - - - -
- - - &com.variant-arith; + + + diff --git a/reference/com/functions/variant-mod.xml b/reference/com/functions/variant-mod.xml index feb7a32a9d..2e4a83aaa8 100644 --- a/reference/com/functions/variant-mod.xml +++ b/reference/com/functions/variant-mod.xml @@ -1,31 +1,61 @@ - - + variant_mod Divides two variants and returns only the remainder - - Description + + &reftitle.description; mixedvariant_mod mixedleft mixedright - Divides left by right and returns the remainder. - + + + &reftitle.parameters; - See also variant_div, - variant_idiv. + + + left + + + The left operand. + + + + + right + + + The right operand. + + + + - &com.variant-arith; + + &reftitle.returnvalues; + + Returns the remainder of the division. + + + + &reftitle.seealso; + + + variant_div + variant_idiv + + + - + variant_neg Performs logical negation on a variant - - Description + + &reftitle.description; mixedvariant_neg mixedvariant - - Performs logical negation of variant and returns - the result. + Performs logical negation of variant. + + + + &reftitle.parameters; + + + + variant + + + The variant. + + + + - &com.variant-arith; + + &reftitle.returnvalues; + + Returns the result of the logical negation. + + - + variant_not Performs bitwise not negation on a variant - - Description + + &reftitle.description; mixedvariant_not mixedvariant - Performs bitwise not negation on variant and - returns the result. If variant is &null;, the - result will also be &null;. + returns the result. + + + + &reftitle.parameters; + + + + variant + + + The variant. + + + + - &com.variant-arith; + + &reftitle.returnvalues; + + Returns the bitwise not negation. If variant is + &null;, the result will also be &null;. + + - + variant_round Rounds a variant to the specified number of decimal places - - Description + + &reftitle.description; mixedvariant_round mixedvariant intdecimals - Returns the value of variant rounded to decimals decimal places. - + + + &reftitle.parameters; - See also round. + + + variant + + + The variant. + + + + + decimals + + + Number of decimal places. + + + + - &com.variant-arith; + + &reftitle.returnvalues; + + Returns the rounded value. + + + + &reftitle.seealso; + + + round + + + - + variant_set Assigns a new value for a variant object - - Description + + &reftitle.description; voidvariant_set variantvariant mixedvalue - Converts value to a variant and assigns it to the variant object; no new variant object is created, and the old value of variant is freed/released. - + + + &reftitle.parameters; + + + + variant + + + The variant. + + + + + value + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + diff --git a/reference/domxml/functions/xpath-new-context.xml b/reference/domxml/functions/xpath-new-context.xml index c3664c0b8d..198117e619 100644 --- a/reference/domxml/functions/xpath-new-context.xml +++ b/reference/domxml/functions/xpath-new-context.xml @@ -1,26 +1,31 @@ - - - - - xpath_new_context - - Creates new xpath context - - - - &reftitle.description; - - XPathContextxpath_new_context - domdocumentdom_document - - - - - See also xpath_eval. - - - + + + + xpath_new_context + + Creates new xpath context + + + + &reftitle.description; + + XPathContextxpath_new_context + domdocumentdom_document + + + Creates a new xpath context. + + + + &reftitle.seealso; + + + xpath_eval + + + + + xptr_new_context @@ -7,7 +7,7 @@ Create new XPath Context - + &reftitle.description; XPathContextxptr_new_context diff --git a/reference/hw/functions/hw-children.xml b/reference/hw/functions/hw-children.xml index ec492ee9b2..6fec08ef46 100644 --- a/reference/hw/functions/hw-children.xml +++ b/reference/hw/functions/hw-children.xml @@ -1,18 +1,46 @@ - - + hw_Children Object ids of children - - Description + + &reftitle.description; arrayhw_children intconnection intobjectID + + Returns the identifiers of the collection children. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; Returns an array of object ids. Each id belongs to a child of the collection with ID objectID. diff --git a/reference/hw/functions/hw-childrenobj.xml b/reference/hw/functions/hw-childrenobj.xml index 656f478969..9704bda040 100644 --- a/reference/hw/functions/hw-childrenobj.xml +++ b/reference/hw/functions/hw-childrenobj.xml @@ -1,22 +1,49 @@ - - + hw_ChildrenObj Object records of children - - Description + + &reftitle.description; arrayhw_childrenobj intconnection intobjectID - Returns an array of object records. Each object record - belongs to a child of the collection with ID - objectID. + Returns the object records of the collection children. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an array of object records. Each object record belongs to a child + of the collection with ID objectID. The array contains all children both documents and collections. diff --git a/reference/hw/functions/hw-document-attributes.xml b/reference/hw/functions/hw-document-attributes.xml index ab5b21adea..84d72b747a 100644 --- a/reference/hw/functions/hw-document-attributes.xml +++ b/reference/hw/functions/hw-document-attributes.xml @@ -1,13 +1,12 @@ - - + hw_Document_Attributes Object record of hw_document - - Description + + &reftitle.description; stringhw_document_attributes inthw_document @@ -19,9 +18,35 @@ For backward compatibility, hw_documentattributes is also accepted. This is deprecated, however. + + + &reftitle.parameters; - See also hw_document_bodytag, - and hw_document_size. + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the object record of the document. + + + + &reftitle.seealso; + + + hw_document_bodytag + hw_document_size + diff --git a/reference/hw/functions/hw-document-content.xml b/reference/hw/functions/hw-document-content.xml index cbed055b1e..f1d8c7caf8 100644 --- a/reference/hw/functions/hw-document-content.xml +++ b/reference/hw/functions/hw-document-content.xml @@ -1,26 +1,51 @@ - - + hw_Document_Content Returns content of hw_document - - Description + + &reftitle.description; stringhw_document_content inthw_document + + Gets the content of the document. + + + + &reftitle.parameters; + + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; Returns the content of the document. If the document is an HTML document the content is everything after the BODY tag. Information from the HEAD and BODY tag is in the stored in the object record. + + + &reftitle.seealso; - See also hw_document_attributes, - hw_document_size, - and hw_document_setcontent. + + hw_document_attributes + hw_document_size + hw_document_setcontent + diff --git a/reference/hw/functions/hw-document-size.xml b/reference/hw/functions/hw-document-size.xml index 4fc005d9d4..1f3640d79c 100644 --- a/reference/hw/functions/hw-document-size.xml +++ b/reference/hw/functions/hw-document-size.xml @@ -1,28 +1,54 @@ - - + hw_Document_Size Size of hw_document - - Description + + &reftitle.description; inthw_document_size inthw_document - Returns the size in bytes of the document. - - See also hw_document_bodytag, - and hw_document_attributes. + Gets the size of the document. For backward compatibility, hw_documentsize is also accepted. This is deprecated, however. + + &reftitle.parameters; + + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the size in bytes of the document. + + + + &reftitle.seealso; + + + hw_document_attributes + hw_document_bodytag + + + - + hw_Free_Document Frees hw_document - - Description + + &reftitle.description; boolhw_free_document inthw_document @@ -16,6 +15,27 @@ Frees the memory occupied by the Hyperwave document. + + &reftitle.parameters; + + + + hw_document + + + The document identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + - + hw_GetParents Object ids of parents - - Description + + &reftitle.description; arrayhw_getparents intconnection intobjectID - Returns an indexed array of object ids. Each object id belongs to - a parent of the object with ID objectID. + Returns the object identifiers of the parents of an object. + + + + &reftitle.parameters; + + + + connection + + + The connection identifier. + + + + + objectID + + + The object identifier. + + + + + + + + &reftitle.returnvalues; + + Returns an indexed array of object ids. Each object id belongs to a parent + of the object with ID objectID. diff --git a/reference/stream/functions/stream-register-wrapper.xml b/reference/stream/functions/stream-register-wrapper.xml index 4118ba18e4..9d8fff69b9 100644 --- a/reference/stream/functions/stream-register-wrapper.xml +++ b/reference/stream/functions/stream-register-wrapper.xml @@ -1,16 +1,14 @@ - + stream_register_wrapper - Alias of stream_wrapper_register + &Alias; stream_wrapper_register - - Description + + &reftitle.description; - This function is an alias of stream_wrapper_register. - This function is included for compatability with PHP 4.3.0 and PHP 4.3.1 - only. stream_wrapper_register should be used instead. + &info.function.alias; stream_wrapper_register. diff --git a/reference/stream/functions/stream-wrapper-restore.xml b/reference/stream/functions/stream-wrapper-restore.xml index 161ab924e3..a54efbbc7a 100644 --- a/reference/stream/functions/stream-wrapper-restore.xml +++ b/reference/stream/functions/stream-wrapper-restore.xml @@ -1,12 +1,12 @@ - + stream_wrapper_restore Restores a previously unregistered built-in wrapper - - Description + + &reftitle.description; boolstream_wrapper_restore stringprotocol @@ -16,6 +16,26 @@ stream_wrapper_unregister. + + &reftitle.parameters; + + + + protocol + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + diff --git a/reference/stream/functions/stream-wrapper-unregister.xml b/reference/stream/functions/stream-wrapper-unregister.xml index 813180e4b5..f8b453d7d5 100644 --- a/reference/stream/functions/stream-wrapper-unregister.xml +++ b/reference/stream/functions/stream-wrapper-unregister.xml @@ -1,22 +1,41 @@ - + stream_wrapper_unregister Unregister a URL wrapper - - Description + + &reftitle.description; boolstream_wrapper_unregister stringprotocol - stream_wrapper_unregister allows you to - disable an already defined stream wrapper. Once the wrapper - has been disabled you may override it with a user-defined wrapper - using stream_wrapper_register or - reenable it later on with stream_wrapper_restore. + Allows you to disable an already defined stream wrapper. Once the wrapper + has been disabled you may override it with a user-defined wrapper using + stream_wrapper_register or reenable it later on with + stream_wrapper_restore. + + + + &reftitle.parameters; + + + + protocol + + + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/tidy/functions/tidy-get-output.xml b/reference/tidy/functions/tidy-get-output.xml index fc224d0ef7..2c96098093 100644 --- a/reference/tidy/functions/tidy-get-output.xml +++ b/reference/tidy/functions/tidy-get-output.xml @@ -1,20 +1,43 @@ - + tidy_get_output Return a string representing the parsed tidy markup - - Description + + &reftitle.description; stringtidy_get_output tidyobject - tidy_get_output returns a string with the repaired - html. + Gets a string with the repaired html. + + + &reftitle.parameters; + + + + object + + + The tidy object. + + + + + + + + &reftitle.returnvalues; + + Returns the parsed tidy markup. + + + + &reftitle.examples; <function>tidy_get_output</function> example diff --git a/reference/tidy/functions/tidy-node-get-attr.xml b/reference/tidy/functions/tidy-node-get-attr.xml index 7cd1c352eb..f2b5799cc9 100644 --- a/reference/tidy/functions/tidy-node-get-attr.xml +++ b/reference/tidy/functions/tidy-node-get-attr.xml @@ -1,19 +1,17 @@ - + tidy_node->get_attr Return the attribute with the provided attribute id - - Description + + &reftitle.description; tidy_attrtidy_node->get_attr intattrib_id - - &warn.undocumented.func; - + &warn.undocumented.func; diff --git a/reference/tidy/functions/tidy-node-next.xml b/reference/tidy/functions/tidy-node-next.xml index 74b51861b7..4e91084796 100644 --- a/reference/tidy/functions/tidy-node-next.xml +++ b/reference/tidy/functions/tidy-node-next.xml @@ -1,19 +1,17 @@ - + tidy_node->next Returns the next sibling to this node - - Description + + &reftitle.description; tidy_nodetidy_node->next - - &warn.undocumented.func; - + &warn.undocumented.func; diff --git a/reference/tidy/functions/tidy-node-prev.xml b/reference/tidy/functions/tidy-node-prev.xml index 5353a35a0d..8741c43da8 100644 --- a/reference/tidy/functions/tidy-node-prev.xml +++ b/reference/tidy/functions/tidy-node-prev.xml @@ -1,19 +1,17 @@ - + tidy_node->prev Returns the previous sibling to this node - - Description + + &reftitle.description; tidy_nodetidy_node->prev - - &warn.undocumented.func; - + &warn.undocumented.func; diff --git a/reference/tidy/functions/tidy-reset-config.xml b/reference/tidy/functions/tidy-reset-config.xml index 27de2030a1..da01abf977 100644 --- a/reference/tidy/functions/tidy-reset-config.xml +++ b/reference/tidy/functions/tidy-reset-config.xml @@ -1,12 +1,12 @@ - + tidy_reset_config Restore Tidy configuration to default values - - Description + + &reftitle.description; booltidy_reset_config @@ -14,7 +14,16 @@ This function restores the Tidy configuration to the default values. - ¬e.tidy.1only; + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.notes; + ¬e.tidy.1only; diff --git a/reference/tidy/functions/tidy-save-config.xml b/reference/tidy/functions/tidy-save-config.xml index 5c05200362..e7e6ab77f3 100644 --- a/reference/tidy/functions/tidy-save-config.xml +++ b/reference/tidy/functions/tidy-save-config.xml @@ -1,27 +1,56 @@ - + tidy_save_config Save current settings to named file - - Description + + &reftitle.description; booltidy_save_config stringfilename - tidy_save_config saves current settings to the - specified file. Only non-default values are written. + Saves current settings to the specified file. Only non-default values are + written. + + + &reftitle.parameters; - See also tidy_get_config, - tidy_getopt, - tidy_reset_config and - tidy_setopt. + + + filename + + + Path to the config file. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.notes; + ¬e.tidy.1only; + + + &reftitle.seealso; + + + tidy_get_config + tidy_getopt + tidy_reset_config + tidy_setopt + - ¬e.tidy.1only; diff --git a/reference/uodbc/functions/odbc-close-all.xml b/reference/uodbc/functions/odbc-close-all.xml index c64ac5864e..963bfa2960 100644 --- a/reference/uodbc/functions/odbc-close-all.xml +++ b/reference/uodbc/functions/odbc-close-all.xml @@ -1,13 +1,12 @@ - - + odbc_close_all Close all ODBC connections - - Description + + &reftitle.description; voidodbc_close_all @@ -15,14 +14,23 @@ odbc_close_all will close down all connections to database server(s). - - - This function will fail if there are open transactions on a - connection. This connection will remain open in this case. - - + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.notes; + + + This function will fail if there are open transactions on a connection. + This connection will remain open in this case. + + + - + odbc_close Close an ODBC connection - - Description + + &reftitle.description; voidodbc_close resourceconnection_id - odbc_close will close down the connection to - the database server associated with the given connection - identifier. - - - This function will fail if there are open transactions on this - connection. The connection will remain open in this case. - - + Closes down the connection to the database server. + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.notes; + + + This function will fail if there are open transactions on this + connection. The connection will remain open in this case. + + + - + odbc_commit Commit an ODBC transaction - - Description + + &reftitle.description; boolodbc_commit resourceconnection_id - odbc_commit commits all pending transactions - on the connection_id connection. &return.success; + Commits all pending transactions on the connection. + + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success; diff --git a/reference/uodbc/functions/odbc-cursor.xml b/reference/uodbc/functions/odbc-cursor.xml index b14c3ea17c..55720618cd 100644 --- a/reference/uodbc/functions/odbc-cursor.xml +++ b/reference/uodbc/functions/odbc-cursor.xml @@ -1,19 +1,39 @@ - - + odbc_cursor Get cursorname - - Description + + &reftitle.description; stringodbc_cursor resourceresult_id - odbc_cursor will return a cursorname for the given result_id. + Gets the cursorname for the given result_id. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + + + + &reftitle.returnvalues; + + Returns the cursor name, as a string. diff --git a/reference/uodbc/functions/odbc-do.xml b/reference/uodbc/functions/odbc-do.xml index 9c85956b9a..cea9f94801 100644 --- a/reference/uodbc/functions/odbc-do.xml +++ b/reference/uodbc/functions/odbc-do.xml @@ -1,21 +1,15 @@ - - + odbc_do - Synonym for odbc_exec + &Alias; odbc_exec - - Description - - resourceodbc_do - resourceconn_id - stringquery - + + &reftitle.description; - odbc_do will execute a query on the given - connection. + &info.function.alias; + odbc_exec. diff --git a/reference/uodbc/functions/odbc-field-name.xml b/reference/uodbc/functions/odbc-field-name.xml index 8e512176e3..e720a71da6 100644 --- a/reference/uodbc/functions/odbc-field-name.xml +++ b/reference/uodbc/functions/odbc-field-name.xml @@ -1,23 +1,49 @@ - - + odbc_field_name Get the columnname - - Description + + &reftitle.description; stringodbc_field_name resourceresult_id intfield_number - odbc_field_name will return the name of the - field occupying the given column number in the given ODBC result - identifier. Field numbering starts at 1. - &false; is returned on error. + Gets the name of the field occupying the given column number in the given + result identifier. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + field_number + + + The field number. Field numbering starts at 1. + + + + + + + + &reftitle.returnvalues; + + Returns the field name as a string, or &false; on error. diff --git a/reference/uodbc/functions/odbc-field-num.xml b/reference/uodbc/functions/odbc-field-num.xml index 5122ded784..311fcfbc4b 100644 --- a/reference/uodbc/functions/odbc-field-num.xml +++ b/reference/uodbc/functions/odbc-field-num.xml @@ -1,23 +1,50 @@ - - + odbc_field_num Return column number - - Description + + &reftitle.description; intodbc_field_num resourceresult_id stringfield_name - odbc_field_num will return the number of the - column slot that corresponds to the named field in the given ODBC - result identifier. Field numbering starts at 1. - &false; is returned on error. + Gets the number of the column slot that corresponds to the named field in + the given result identifier. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + field_name + + + The field name. + + + + + + + + &reftitle.returnvalues; + + Returns the field number as a integer, or &false; on error. + Field numbering starts at 1. diff --git a/reference/uodbc/functions/odbc-field-precision.xml b/reference/uodbc/functions/odbc-field-precision.xml index 4004c60db8..3248e04d0e 100644 --- a/reference/uodbc/functions/odbc-field-precision.xml +++ b/reference/uodbc/functions/odbc-field-precision.xml @@ -1,26 +1,24 @@ - - + odbc_field_precision - Synonym for odbc_field_len + &Alias; odbc_field_len - - Description - - intodbc_field_precision - resourceresult_id - intfield_number - + + &reftitle.description; - odbc_field_precision will return the precision - of the field referenced by number in the given ODBC result - identifier. + &info.function.alias; + odbc_field_len. + + + &reftitle.seealso; - See also: odbc_field_scale to get the scale of a - floating point number. + + odbc_field_scale to get the scale of a + floating point number. + diff --git a/reference/uodbc/functions/odbc-field-scale.xml b/reference/uodbc/functions/odbc-field-scale.xml index 6e49016f54..3304b9523b 100644 --- a/reference/uodbc/functions/odbc-field-scale.xml +++ b/reference/uodbc/functions/odbc-field-scale.xml @@ -1,24 +1,51 @@ - - + odbc_field_scale Get the scale of a field - - Description + + &reftitle.description; intodbc_field_scale resourceresult_id intfield_number - odbc_field_scale will return the scale - of the field referenced by number in the given ODBC result + Gets the scale of the field referenced by number in the given result identifier. + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + field_number + + + The field number. Field numbering starts at 1. + + + + + + + + &reftitle.returnvalues; + + Returns the field scale as a integer, or &false; on error. + + - + odbc_field_type Datatype of a field - - Description + + &reftitle.description; stringodbc_field_type resourceresult_id intfield_number - odbc_field_type will return the SQL type of - the field referenced by number in the given ODBC result - identifier. Field numbering starts at 1. + Gets the SQL type of the field referenced by number in the given result + identifier. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier. + + + + + field_number + + + The field number. Field numbering starts at 1. + + + + + + + + &reftitle.returnvalues; + + Returns the field type as a string, or &false; on error. diff --git a/reference/uodbc/functions/odbc-num-fields.xml b/reference/uodbc/functions/odbc-num-fields.xml index fb70de21be..a81df95cd5 100644 --- a/reference/uodbc/functions/odbc-num-fields.xml +++ b/reference/uodbc/functions/odbc-num-fields.xml @@ -1,22 +1,39 @@ - - + odbc_num_fields Number of columns in a result - - Description + + &reftitle.description; intodbc_num_fields resourceresult_id - odbc_num_fields will return the number of - fields (columns) in an ODBC result. This function will return -1 - on error. The argument is a valid result identifier returned by - odbc_exec. + Gets the number of fields (columns) in an ODBC result. + + + + &reftitle.parameters; + + + + result_id + + + The result identifier returned by odbc_exec. + + + + + + + + &reftitle.returnvalues; + + Returns the number of fields, or -1 on error. diff --git a/reference/uodbc/functions/odbc-rollback.xml b/reference/uodbc/functions/odbc-rollback.xml index 77049f5e9b..672e32af67 100644 --- a/reference/uodbc/functions/odbc-rollback.xml +++ b/reference/uodbc/functions/odbc-rollback.xml @@ -1,22 +1,39 @@ - - + odbc_rollback Rollback a transaction - - Description + + &reftitle.description; boolodbc_rollback resourceconnection_id - Rolls back all pending statements on - connection_id. Returns - &true; on success, &false; on - failure. + Rolls back all pending statements on the connection. + + + + &reftitle.parameters; + + + + connection_id + + + The connection identifier. + + + + + + + + &reftitle.returnvalues; + + &return.success;