From 7c62d81304ba372389361d0effeb085a48c18a39 Mon Sep 17 00:00:00 2001 From: Jeroen van Wolffelaar Date: Sat, 23 Jun 2001 20:10:52 +0000 Subject: [PATCH] Changed all identifiers between and/or tags that had ONLY the first letter uppercase to all-lowercase git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@50055 c90b9560-bf6c-de11-be94-00142212c4b1 --- features/http-auth.xml | 4 +- functions/apache.xml | 8 +- functions/array.xml | 154 +++++++++++++++++++-------------------- functions/aspell.xml | 16 ++-- functions/calendar.xml | 2 +- functions/com.xml | 2 +- functions/datetime.xml | 18 ++--- functions/dba.xml | 18 ++--- functions/dir.xml | 2 +- functions/errorfunc.xml | 2 +- functions/filesystem.xml | 34 ++++----- functions/ftp.xml | 2 +- functions/funchand.xml | 12 +-- functions/gettext.xml | 2 +- functions/http.xml | 6 +- functions/ibase.xml | 4 +- functions/icap.xml | 12 +-- functions/imap.xml | 2 +- functions/info.xml | 4 +- functions/mail.xml | 2 +- functions/math.xml | 6 +- functions/mcrypt.xml | 50 ++++++------- functions/mhash.xml | 14 ++-- functions/misc.xml | 18 ++--- functions/msql.xml | 2 +- functions/mssql.xml | 28 +++---- functions/mysql.xml | 10 +-- functions/network.xml | 26 +++---- functions/nis.xml | 16 ++-- functions/pgsql.xml | 50 ++++++------- functions/pspell.xml | 64 ++++++++-------- functions/readline.xml | 2 +- functions/regex.xml | 6 +- functions/sem.xml | 14 ++-- functions/strings.xml | 58 +++++++-------- functions/swf.xml | 2 +- functions/uodbc.xml | 8 +- functions/url.xml | 14 ++-- functions/var.xml | 12 +-- functions/yaz.xml | 4 +- functions/zlib.xml | 12 +-- language/variables.xml | 2 +- 42 files changed, 362 insertions(+), 362 deletions(-) diff --git a/features/http-auth.xml b/features/http-auth.xml index ad5557e4a1..6d421708e9 100644 --- a/features/http-auth.xml +++ b/features/http-auth.xml @@ -5,13 +5,13 @@ The HTTP Authentication hooks in PHP are only available when it is running as an Apache module and is hence not available in the CGI version. In an Apache module PHP script, it is possible to use the - Header function to send an "Authentication Required" + header function to send an "Authentication Required" message to the client browser causing it to pop up a Username/Password input window. Once the user has filled in a username and a password, the URL containing the PHP script will be called again with the variables, $PHP_AUTH_USER, $PHP_AUTH_PW and $PHP_AUTH_TYPE set to the user name, password and authentication type respectively. Only "Basic" - authentication is supported at this point. See the Header + authentication is supported at this point. See the header function for more information. diff --git a/functions/apache.xml b/functions/apache.xml index 4a8939f9f7..0e8f41eb8f 100644 --- a/functions/apache.xml +++ b/functions/apache.xml @@ -49,7 +49,7 @@ - Apache_lookup_uri only works when PHP + apache_lookup_uri only works when PHP is installed as an Apache module. @@ -75,7 +75,7 @@ - Apache_note is an Apache-specific function + apache_note is an Apache-specific function which gets and sets values in a request's notes table. If called with one argument, it returns the current value of note @@ -183,7 +183,7 @@ while (list ($header, $value) = each ($headers)) { request. - Getallheaders is currently only supported + getallheaders is currently only supported when PHP runs as an Apache module. @@ -205,7 +205,7 @@ while (list ($header, $value) = each ($headers)) { - Virtual is an Apache-specific function which + virtual is an Apache-specific function which is equivalent to <!--#include virtual...--> in mod_include. It performs an Apache sub-request. It is useful for including CGI scripts or .shtml files, or anything else that you would diff --git a/functions/array.xml b/functions/array.xml index 4e3cffc9bf..1e7cd7d207 100644 --- a/functions/array.xml +++ b/functions/array.xml @@ -49,7 +49,7 @@ - Array is a language construct used to + array is a language construct used to represent literal arrays, and not a regular function. @@ -68,7 +68,7 @@ arrays, and how to skip-and-continue numeric indices in normal arrays. - <function>Array</function> example + <function>array</function> example $fruits = array ( "fruits" => array ("a"=>"orange", "b"=>"banana", "c"=>"apple"), @@ -80,7 +80,7 @@ $fruits = array ( - Automatic index with <function>Array</function> + Automatic index with <function>array</function> $array = array( 1, 1, 1, 1, 1, 8=>1, 4=>1, 19, 3=>13); print_r($array); @@ -108,7 +108,7 @@ Array This example creates a 1-based array. - 1-based index with <function>Array</function> + 1-based index with <function>array</function> $firstquarter = array(1 => 'January', 'February', 'March'); print_r($firstquarter); @@ -146,13 +146,13 @@ Array - Array_count_values returns an array using + array_count_values returns an array using the values of the input array as keys and their frequency in input as values. - <function>Array_count_values</function> example + <function>array_count_values</function> example $array = array (1, "hello", 1, "world", "hello"); array_count_values ($array); // returns array (1=>2, "hello"=>2, "world"=>1) @@ -180,14 +180,14 @@ array_count_values ($array); // returns array (1=>2, "hello"=>2, "world"=& - Array_diff returns an array + array_diff returns an array containing all the values of array1 that are not present in any of the other arguments. Note that keys are preserved. - <function>Array_diff</function> example + <function>array_diff</function> example $array1 = array ("a" => "green", "red", "blue", "red"); $array2 = array ("b" => "green", "yellow", "red"); @@ -223,7 +223,7 @@ $result = array_diff ($array1, $array2); - Array_filter returns an array + array_filter returns an array containing all the elements of input filtered according a callback function. If the input is an associative array @@ -231,7 +231,7 @@ $result = array_diff ($array1, $array2); - <function>Array_filter</function> example + <function>array_filter</function> example function odd($var) { return ($var % 2 == 1); @@ -293,7 +293,7 @@ $even_arr = array_filter($array2, "even"); - <function>Array_flip</function> example + <function>array_flip</function> example $trans = array_flip ($trans); $original = strtr ($str, $trans); @@ -302,7 +302,7 @@ $original = strtr ($str, $trans); - <function>Array_flip</function> example : collision + <function>array_flip</function> example : collision $trans = array ("a" => 1, "b" => 1, "c" => 2); $trans = array_flip ($trans); @@ -331,14 +331,14 @@ $trans = array_flip ($trans); - Array_intersect returns an array + array_intersect returns an array containing all the values of array1 that are present in all the arguments. Note that keys are preserved. - <function>Array_intersect</function> example + <function>array_intersect</function> example $array1 = array ("a" => "green", "red", "blue"); $array2 = array ("b" => "green", "yellow", "red"); @@ -375,7 +375,7 @@ $result = array_intersect ($array1, $array2); - Array_keys returns the keys, numeric and + array_keys returns the keys, numeric and string, from the input array. @@ -385,7 +385,7 @@ $result = array_intersect ($array1, $array2); - <function>Array_keys</function> example + <function>array_keys</function> example $array = array (0 => 100, "color" => "red"); array_keys ($array); // returns array (0, "color") @@ -445,7 +445,7 @@ function array_keys ($arr, $term="") { - Array_map returns an array + array_map returns an array containing all the elements of arr1 after applying the callback function to each one. The number of parameters that the callback function accepts should @@ -453,7 +453,7 @@ function array_keys ($arr, $term="") { - <function>Array_map</function> example + <function>array_map</function> example function cube($n) { return $n*$n*$n; @@ -470,7 +470,7 @@ $b = array_map("cube", $a); - <function>Array_map</function> - using more arrays + <function>array_map</function> - using more arrays function show_Spanish($n, $m) { return "The number $n is called $m in Spanish"; @@ -547,7 +547,7 @@ print_r($d); - <function>Array_map</function> - creating an array of arrays + <function>array_map</function> - creating an array of arrays $a = array(1, 2, 3, 4, 5); $b = array("one", "two", "three", "four", "five"); @@ -623,7 +623,7 @@ print_r($d); - Array_merge merges the elements of two or + array_merge merges the elements of two or more arrays together so that the values of one are appended to the end of the previous one. It returns the resulting array. @@ -671,7 +671,7 @@ array_merge ($array1, $array2); - Array_merge_recursive merges the elements of + array_merge_recursive merges the elements of two or more arrays together so that the values of one are appended to the end of the previous one. It returns the resulting array. @@ -685,7 +685,7 @@ array_merge ($array1, $array2); - <function>Array_merge_recursive</function> example + <function>array_merge_recursive</function> example $ar1 = array ("color" => array ("favorite" => "red"), 5); $ar2 = array (10, "color" => array ("favorite" => "green", "blue")); @@ -726,7 +726,7 @@ $result = array_merge_recursive ($ar1, $ar2); - Array_multisort can be used to sort several + array_multisort can be used to sort several arrays at once or a multi-dimensional array according by one of more dimensions. It maintains key association when sorting. @@ -831,7 +831,7 @@ array_multisort ($ar[0], SORT_ASC, SORT_STRING, - Array_pad returns a copy of the + array_pad returns a copy of the input padded to size specified by pad_size with value pad_value. If @@ -843,7 +843,7 @@ array_multisort ($ar[0], SORT_ASC, SORT_STRING, - <function>Array_pad</function> example + <function>array_pad</function> example $input = array (12, 10, 9); @@ -875,7 +875,7 @@ $result = array_pad ($input, 2, "noop"); - Array_pop pops and returns the last value of + array_pop pops and returns the last value of the array, shortening the array by one element. If array is empty (or is not an array), @@ -883,7 +883,7 @@ $result = array_pad ($input, 2, "noop"); - <function>Array_pop</function> example + <function>array_pop</function> example $stack = array ("orange", "apple", "raspberry"); $fruit = array_pop ($stack); @@ -923,7 +923,7 @@ $fruit = array_pop ($stack); - Array_push treats + array_push treats array as a stack, and pushes the passed variables onto the end of array. The length of array increases by the number of @@ -938,7 +938,7 @@ $array[] = $var; - <function>Array_push</function> example + <function>array_push</function> example $stack = array (1, 2); array_push ($stack, "+", 3); @@ -976,7 +976,7 @@ array_push ($stack, "+", 3); - Array_rand is rather useful when you want to + 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 @@ -994,7 +994,7 @@ array_push ($stack, "+", 3); - <function>Array_rand</function> example + <function>array_rand</function> example srand ((double) microtime() * 10000000); $input = array ("Neo", "Morpheus", "Trinity", "Cypher", "Tank"); @@ -1024,14 +1024,14 @@ print $input[$rand_keys[1]]."\n"; - Array_reverse takes input + array_reverse takes input array and returns a new array with the order of the elements reversed, preserving the keys if preserve_keys is TRUE. - <function>Array_reverse</function> example + <function>array_reverse</function> example $input = array ("php", 4.0, array ("green", "red")); $result = array_reverse ($input); @@ -1073,7 +1073,7 @@ $result_keyed = array_reverse ($input, TRUE); - Array_reduce applies iteratively the + array_reduce applies iteratively the callback function to the elements of the array input, so as to reduce the array to a single value. If the optional intial is @@ -1082,7 +1082,7 @@ $result_keyed = array_reverse ($input, TRUE); - <function>Array_reduce</function> example + <function>array_reduce</function> example function rsum($v, $w) { $v += $w; @@ -1131,7 +1131,7 @@ $d = array_reduce($x, "rsum", 1); - Array_shift shifts the first value of the + array_shift shifts the first value of the array off and returns it, shortening the array by one element and moving everything down. @@ -1140,7 +1140,7 @@ $d = array_reduce($x, "rsum", 1); - <function>Array_shift</function> example + <function>array_shift</function> example $args = array ("-v", "-f"); $opt = array_shift ($args); @@ -1179,7 +1179,7 @@ $opt = array_shift ($args); - Array_slice returns a sequence of elements + array_slice returns a sequence of elements from the array specified by the offset and length parameters. @@ -1201,7 +1201,7 @@ $opt = array_shift ($args); - <function>Array_slice</function> examples + <function>array_slice</function> examples $input = array ("a", "b", "c", "d", "e"); @@ -1244,7 +1244,7 @@ $output = array_slice ($input, 0, 3); // returns "a", "b", and "c" - Array_splice removes the elements designated + array_splice removes the elements designated by offset and length from the input array, and replaces them with the @@ -1298,7 +1298,7 @@ $a[$x] = $y array_splice ($input, $x, 1, $y) - <function>Array_splice</function> examples + <function>array_splice</function> examples $input = array ("red", "green", "blue", "yellow"); array_splice ($input, 2); @@ -1341,12 +1341,12 @@ array_splice ($input, -1, 1, array("black", "maroon")); - Array_sum returns the sum of values + array_sum returns the sum of values in an array as an integer or float. - <function>Array_sum</function> examples + <function>array_sum</function> examples $a = array(2,4,6,8); echo "sum(a) = ".array_sum($a)."\n"; @@ -1375,14 +1375,14 @@ echo "sum(b) = ".array_sum($b)."\n"; - Array_unique takes input + array_unique takes input array and returns a new array without duplicate values. Note that keys are preserved. - <function>Array_unique</function> example + <function>array_unique</function> example $input = array ("a" => "green", "red", "b" => "green", "blue", "red"); $result = array_unique ($input); @@ -1418,7 +1418,7 @@ $result = array_unique ($input); - Array_unshift prepends passed elements to + 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. @@ -1429,7 +1429,7 @@ $result = array_unique ($input); - <function>Array_unshift</function> example + <function>array_unshift</function> example $queue = array ("p1", "p3"); array_unshift ($queue, "p4", "p5", "p6"); @@ -1467,7 +1467,7 @@ array_unshift ($queue, "p4", "p5", "p6"); - <function>Array_values</function> example + <function>array_values</function> example $array = array ("size" => "XL", "color" => "gold"); array_values ($array); // returns array ("XL", "gold") @@ -1554,7 +1554,7 @@ function array_values ($arr) { - <function>Array_walk</function> example + <function>array_walk</function> example $fruits = array ("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple"); @@ -1604,7 +1604,7 @@ array_walk ($fruits, 'test_print'); with. This is used mainly when sorting associative arrays where the actual element order is significant. - <function>Arsort</function> example + <function>arsort</function> example $fruits = array ("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple"); arsort ($fruits); @@ -1664,7 +1664,7 @@ fruits[c] = apple with. This is used mainly when sorting associative arrays where the actual element order is significant. - <function>Asort</function> example + <function>asort</function> example $fruits = array ("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple"); asort ($fruits); @@ -1723,7 +1723,7 @@ fruits[a] = orange - Compact takes a variable number of + compact takes a variable number of parameters. Each parameter can be either a string containing the name of the variable, or an array of variable names. The array can contain other arrays of variable names inside it; @@ -1742,7 +1742,7 @@ fruits[a] = orange - <function>Compact</function> example + <function>compact</function> example $city = "San Francisco"; $state = "CA"; @@ -1789,7 +1789,7 @@ $result = compact ("event", "nothing_here", $location_vars); Returns 0 if the variable is not set or is an empty array. - Count may return 0 for a variable that + count may return 0 for a variable that isn't set, but it may also return 0 for a variable that has been initialized with an empty array. Use isset to test if a variable is set. @@ -1803,7 +1803,7 @@ $result = compact ("event", "nothing_here", $location_vars); - <function>Count</function> example + <function>count</function> example $a[0] = 1; $a[1] = 3; @@ -1909,7 +1909,7 @@ $result = count ($b); - <function>Each</function> examples + <function>each</function> examples $foo = array ("bob", "fred", "jussi", "jouni", "egon", "marliese"); $bar = each ($foo); @@ -1941,7 +1941,7 @@ $bar = each ($foo); - Each is typically used in conjunction with + each is typically used in conjunction with list to traverse an array; for instance, $HTTP_POST_VARS: @@ -1987,7 +1987,7 @@ while (list ($key, $val) = each ($HTTP_POST_VARS)) { - End advances array's + end advances array's internal pointer to the last element, and returns that element. @@ -2107,7 +2107,7 @@ while (list ($key, $val) = each ($HTTP_POST_VARS)) { - <function>Extract</function> example + <function>extract</function> example <?php @@ -2183,7 +2183,7 @@ blue, large, sphere, medium - <function>In_array</function> example + <function>in_array</function> example $os = array ("Mac", "NT", "Irix", "Linux"); if (in_array ("Irix", $os)){ @@ -2194,7 +2194,7 @@ if (in_array ("Irix", $os)){ - <function>In_array</function> with strict example + <function>in_array</function> with strict example - Key returns the index element of the + key returns the index element of the current array position. @@ -2294,7 +2294,7 @@ if (in_array(1.13, $a, TRUE)) Sorts an array by key in reverse order, maintaining key to data correlations. This is useful mainly for associative arrays. - <function>Krsort</function> example + <function>krsort</function> example $fruits = array ("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple"); krsort ($fruits); @@ -2351,7 +2351,7 @@ fruits[a] = orange Sorts an array by key, maintaining key to data correlations. This is useful mainly for associative arrays. - <function>Ksort</function> example + <function>ksort</function> example $fruits = array ("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple"); ksort ($fruits); @@ -2413,7 +2413,7 @@ fruits[d] = lemon but a language construct. list is used to assign a list of variables in one operation. - <function>List</function> example + <function>list</function> example <table> <tr> @@ -2579,7 +2579,7 @@ Array there are no more elements. - Next behaves like + next behaves like current, with one difference. It advances the internal array pointer one place forward before returning the element. That means it returns the next array element and @@ -2655,7 +2655,7 @@ Array - Prev behaves just like + prev behaves just like next, except it rewinds the internal array pointer one place instead of advancing it. @@ -2683,7 +2683,7 @@ Array - Range returns an array of integers from + range returns an array of integers from low to high, inclusive. @@ -2709,11 +2709,11 @@ Array - Reset rewinds array's + reset rewinds array's internal pointer to the first element. - Reset returns the value of the first array + reset returns the value of the first array element. @@ -2743,7 +2743,7 @@ Array This function sorts an array in reverse order (highest to lowest). - <function>Rsort</function> example + <function>rsort</function> example $fruits = array ("lemon", "orange", "banana", "apple"); rsort ($fruits); @@ -2801,7 +2801,7 @@ fruits[3] = apple an array. You must use srand to seed this function. - <function>Shuffle</function> example + <function>shuffle</function> example $numbers = range (1,20); srand ((double)microtime()*1000000); @@ -2860,7 +2860,7 @@ while (list (, $number) = each ($numbers)) { This function sorts an array. Elements will be arranged from lowest to highest when this function has completed. - <function>Sort</function> example + <function>sort</function> example <?php @@ -2988,7 +2988,7 @@ fruits[3] = orange - <function>Uksort</function> example + <function>uksort</function> example function cmp ($a, $b) { if ($a == $b) return 0; @@ -3058,7 +3058,7 @@ while (list ($key, $value) = each ($a)) { - <function>Usort</function> example + <function>usort</function> example function cmp ($a, $b) { if ($a == $b) return 0; @@ -3098,7 +3098,7 @@ while (list ($key, $value) = each ($a)) { - <function>Usort</function> example using multi-dimensional array + <function>usort</function> example using multi-dimensional array function cmp ($a, $b) { diff --git a/functions/aspell.xml b/functions/aspell.xml index 4f3a57d823..6d38850bc9 100644 --- a/functions/aspell.xml +++ b/functions/aspell.xml @@ -38,12 +38,12 @@ - Aspell_new opens up a new dictionary and + aspell_new opens up a new dictionary and returns the dictionary link identifier for use in other aspell functions. - <function>Aspell_new</function> + <function>aspell_new</function> $aspell_link=aspell_new ("english"); @@ -67,12 +67,12 @@ $aspell_link=aspell_new ("english"); - Aspell_check checks the spelling of a word + aspell_check checks the spelling of a word and returns true if the spelling is correct, false if not. - <function>Aspell_check</function> + <function>aspell_check</function> $aspell_link=aspell_new ("english"); if (aspell_check ($aspell_link, "testt")) { @@ -103,13 +103,13 @@ if (aspell_check ($aspell_link, "testt")) { - Aspell_check_raw checks the spelling of a + aspell_check_raw checks the spelling of a word, without changing its case or trying to trim it in any way and returns true if the spelling is correct, false if not. - <function>Aspell_check_raw</function> + <function>aspell_check_raw</function> $aspell_link=aspell_new ("english"); if (aspell_check_raw ($aspell_link, "test")) { @@ -138,12 +138,12 @@ if (aspell_check_raw ($aspell_link, "test")) { - Aspell_suggest returns an array of possible + aspell_suggest returns an array of possible spellings for the given word. - <function>Aspell_suggest</function> + <function>aspell_suggest</function> $aspell_link=aspell_new ("english"); diff --git a/functions/calendar.xml b/functions/calendar.xml index 051b05ed02..23e8551e20 100644 --- a/functions/calendar.xml +++ b/functions/calendar.xml @@ -442,7 +442,7 @@ echo date ("M-d-Y", easter_date(2001)); /* "Apr-15-2001" */ which fall outside the range of UNIX timestamps (i.e. before 1970 or after 2037). - <function>Easter_days</function> example + <function>easter_days</function> example echo easter_days (1999); /* 14, i.e. April 4 */ echo easter_days (1492); /* 32, i.e. April 22 */ diff --git a/functions/com.xml b/functions/com.xml index 17475fe3ee..717e8e2c55 100644 --- a/functions/com.xml +++ b/functions/com.xml @@ -264,7 +264,7 @@ $conn = null; - Com_invoke invokes a method of the COM + com_invoke invokes a method of the COM component referenced by com_object. Returns false on error, returns the diff --git a/functions/datetime.xml b/functions/datetime.xml index 4fb87d816e..6fee87d1f3 100644 --- a/functions/datetime.xml +++ b/functions/datetime.xml @@ -229,7 +229,7 @@ as-is. The "Z" format will always return "0" when using gmdate. - <function>Date</function> example + <function>date</function> example print (date ("l dS of F Y h:i:s A")); print ("July 1, 2000 is on a " . date ("l", mktime(0,0,0,7,1,2000))); @@ -242,7 +242,7 @@ print ("July 1, 2000 is on a " . date ("l", mktime(0,0,0,7,1,2000))); or the past. - <function>Date</function> and <function>mktime</function> + <function>date</function> and <function>mktime</function> example @@ -261,7 +261,7 @@ $nextyear = mktime (0,0,0,date("m"), date("d"), date("Y")+1); like \n from become newlines. - <function>Date</function> Formatting + <function>date</function> Formatting /* Today is March 10th, 2001, 5:16:18 pm */ @@ -442,7 +442,7 @@ echo "$month $mday, $year"; run in Finland (GMT +0200), the first line below prints "Jan 01 1998 00:00:00", while the second prints "Dec 31 1997 22:00:00". - <function>Gmdate</function> example + <function>gmdate</function> example echo date ("M d Y H:i:s", mktime (0,0,0,1,1,1998)); echo gmdate ("M d Y H:i:s", mktime (0,0,0,1,1,1998)); @@ -509,7 +509,7 @@ echo gmdate ("M d Y H:i:s", mktime (0,0,0,1,1,1998)); "Dec 31 1998 20:00:00", while the second prints "Jan 01 1999 01:00:00". - <function>Gmstrftime</function> example + <function>gmstrftime</function> example setlocale ('LC_TIME', 'en_US'); echo strftime ("%b %d %Y %H:%M:%S", mktime (20,0,0,12,31,98))."\n"; @@ -710,12 +710,12 @@ echo "Did nothing in $time seconds"; - Mktime is useful for doing date arithmetic + mktime is useful for doing date arithmetic and validation, as it will automatically calculate the correct value for out-of-range input. For example, each of the following lines produces the string "Jan-01-1998". - <function>Mktime</function> example + <function>mktime</function> example echo date ("M-d-Y", mktime (0,0,0,12,32,1997)); echo date ("M-d-Y", mktime (0,0,0,13,1,1997)); @@ -977,7 +977,7 @@ echo strftime ("Last day in Feb 2000 is: %d", $lastday); - <function>Strftime</function> example + <function>strftime</function> example setlocale ("LC_TIME", "C"); print (strftime ("%A in Finnish is ")); @@ -1048,7 +1048,7 @@ print (strftime ("%A.\n")); date format and will try to parse that format into a UNIX timestamp. - <function>Strtotime</function> examples + <function>strtotime</function> examples echo strtotime ("now") . "\n"; echo strtotime ("10 September 2000") . "\n"; diff --git a/functions/dba.xml b/functions/dba.xml index 26cc41d4ab..b5d0b26081 100644 --- a/functions/dba.xml +++ b/functions/dba.xml @@ -181,7 +181,7 @@ for ($i = 0; $i < count($handle_later); $i++) - Dba_close closes the established database + dba_close closes the established database and frees all resources specified by handle. @@ -190,7 +190,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - Dba_close does not return any value. + dba_close does not return any value. See also: dba_open and @@ -253,7 +253,7 @@ for ($i = 0; $i < count($handle_later); $i++) - Dba_exists checks whether the specified + dba_exists checks whether the specified key exists in the database specified by handle. @@ -265,7 +265,7 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - Dba_exists returns true or false, if the key is found + dba_exists returns true or false, if the key is found or not found, respectively. @@ -291,7 +291,7 @@ for ($i = 0; $i < count($handle_later); $i++) - Dba_fetch fetches the data specified by + dba_fetch fetches the data specified by key from the database specified with handle. @@ -304,7 +304,7 @@ for ($i = 0; $i < count($handle_later); $i++) - Dba_fetch returns the associated string or false, if + dba_fetch returns the associated string or false, if the key/data pair is found or not found, respectively. @@ -329,7 +329,7 @@ for ($i = 0; $i < count($handle_later); $i++) - Dba_firstkey returns the first key of the + dba_firstkey returns the first key of the database specified by handle and resets the internal key pointer. This permits a linear search through the whole database. @@ -339,12 +339,12 @@ for ($i = 0; $i < count($handle_later); $i++) dba_open. - Dba_firstkey returns the key or false + dba_firstkey returns the key or false depending on whether it succeeds or fails, respectively. See also: - Dba_nextkey + dba_nextkey and example 2 in the DBA overview diff --git a/functions/dir.xml b/functions/dir.xml index a8ca29a944..8876f9b5a9 100644 --- a/functions/dir.xml +++ b/functions/dir.xml @@ -75,7 +75,7 @@ the directory that was opened. Three methods are available: read, rewind and close. - <function>Dir</function> Example + <function>dir</function> Example $d = dir("/etc"); echo "Handle: ".$d->handle."<br>\n"; diff --git a/functions/errorfunc.xml b/functions/errorfunc.xml index 270e8c0733..7af49f189e 100644 --- a/functions/errorfunc.xml +++ b/functions/errorfunc.xml @@ -71,7 +71,7 @@ This is the only message type where the fourth parameter, extra_headers is used. This message type uses the same internal function as - Mail does. + mail does. diff --git a/functions/filesystem.xml b/functions/filesystem.xml index 1a69d763a8..edef9faadd 100644 --- a/functions/filesystem.xml +++ b/functions/filesystem.xml @@ -230,7 +230,7 @@ chmod ("/somedir/somefile", 0755); // octal; correct value of mode Makes a copy of a file. Returns true if the copy succeeded, false otherwise. - <function>Copy</function> example + <function>copy</function> example if (!copy($file, $file.'.bak')) { print ("failed to copy $file...<br>\n"); @@ -292,7 +292,7 @@ if (!copy($file, $file.'.bak')) { (/). - <function>Dirname</function> example + <function>dirname</function> example $path = "/etc/passwd"; $file = dirname ($path); // $file is set to "/etc" @@ -513,7 +513,7 @@ $df = disk_total_space("/"); // $df contains the total number of CSV file (allowing for trailing line-end characters). - Fgetcsv returns false on error, including + fgetcsv returns false on error, including end of file. @@ -523,7 +523,7 @@ $df = disk_total_space("/"); // $df contains the total number of - <function>Fgetcsv</function> example - Read and print entire + <function>fgetcsv</function> example - Read and print entire contents of a CSV file @@ -1096,14 +1096,14 @@ $fcontents = join ('', file ('http://www.php.net')); - Flock allows you to perform a simple + flock allows you to perform a simple reader/writer model which can be used on virtually every platform (including most Unices and even Windows). The optional 3rd argument is set to true if the lock would block (EWOULDBLOCK errno condition) - Flock returns true on success and false on + flock returns true on success and false on error (e.g. when a lock could not be acquired). @@ -1231,7 +1231,7 @@ $fcontents = join ('', file ('http://www.php.net')); - <function>Fopen</function> example + <function>fopen</function> example $fp = fopen ("/home/rasmus/file.txt", "r"); $fp = fopen ("/home/rasmus/file.gif", "wb"); @@ -1327,7 +1327,7 @@ $fp = fopen ("c:\\data\\info.txt", "r"); - Fputs is an alias to + fputs is an alias to fwrite, and is identical in every way. Note that the length parameter is optional and if not specified the entire string will be written. @@ -1350,7 +1350,7 @@ $fp = fopen ("c:\\data\\info.txt", "r"); - Fread reads up to + fread reads up to length bytes from the file pointer referenced by fp. Reading stops when length bytes have been read or EOF is @@ -1422,7 +1422,7 @@ fclose ($fd); return the number of assigned values. The optional parameters must be passed by reference. - <function>Fscanf</function> Example + <function>fscanf</function> Example $fp = fopen ("users.txt","r"); while ($userinfo = fscanf ($fp, "%s\t%s\t%s\n")) { @@ -1997,7 +1997,7 @@ if($fp){ - Link creates a hard link. + link creates a hard link. See also the symlink to create soft links, and readlink along with @@ -2025,7 +2025,7 @@ if($fp){ - Linkinfo returns the st_dev field of the + linkinfo returns the st_dev field of the UNIX C stat structure returned by the lstat system call. This function is used to verify if a link (pointed to by path) really exists (using the same method @@ -2339,7 +2339,7 @@ $fp = popen ("/bin/ls", "r"); - Readlink does the same as the readlink C + readlink does the same as the readlink C function and returns the contents of the symbolic link path or 0 in case of error. @@ -2629,7 +2629,7 @@ $real_path = realpath ("../../index.php"); Returns the new temporary filename, or the null string on failure. - <function>Tempnam</function> example + <function>tempnam</function> example $tmpfname = tempnam ("/tmp", "FOO"); @@ -2710,7 +2710,7 @@ $tmpfname = tempnam ("/tmp", "FOO"); Returns true on success and false otherwise. - <function>Touch</function> example + <function>touch</function> example if (touch ($FileName)) { print "$FileName modification time has been @@ -2738,12 +2738,12 @@ if (touch ($FileName)) { - Umask sets PHP's umask to mask & 0777 and + umask sets PHP's umask to mask & 0777 and returns the old umask. When PHP is being used as a server module, the umask is restored when each request is finished. - Umask without arguments simply returns the + umask without arguments simply returns the current umask. diff --git a/functions/ftp.xml b/functions/ftp.xml index dd78c86e9f..d5b98e2f28 100644 --- a/functions/ftp.xml +++ b/functions/ftp.xml @@ -370,7 +370,7 @@ ftp_quit($conn_id); - <function>Ftp_put</function> example + <function>ftp_put</function> example $upload = ftp_put ($conn_id, "$destination_file", "$source_file", FTP_ASCII); diff --git a/functions/funchand.xml b/functions/funchand.xml index ef5f66a7b2..3acf2b65c5 100755 --- a/functions/funchand.xml +++ b/functions/funchand.xml @@ -281,7 +281,7 @@ print_r($sv); Returns the argument which is at the arg_num'th offset into a user-defined function's argument list. Function arguments are counted starting - from zero. Func_get_arg will generate a + from zero. func_get_arg will generate a warning if called from outside of a function definition. @@ -307,7 +307,7 @@ foo (1, 2, 3); - Func_get_arg may be used in conjunction with + func_get_arg may be used in conjunction with func_num_args and func_get_args to allow user-defined functions to accept variable-length argument lists. @@ -338,7 +338,7 @@ foo (1, 2, 3); Returns an array in which each element is the corresponding member of the current user-defined function's argument - list. Func_get_args will generate a warning + list. func_get_args will generate a warning if called from outside of a function definition. @@ -363,7 +363,7 @@ foo (1, 2, 3); - Func_get_args may be used in conjunction + func_get_args may be used in conjunction with func_num_args and func_get_arg to allow user-defined functions to accept variable-length argument lists. @@ -393,7 +393,7 @@ foo (1, 2, 3); Returns the number of arguments passed into the current - user-defined function. Func_num_args will + user-defined function. func_num_args will generate a warning if called from outside of a function definition. @@ -412,7 +412,7 @@ foo (1, 2, 3); // Prints 'Number of arguments: 3' - Func_num_args may be used in conjunction + func_num_args may be used in conjunction with func_get_arg and func_get_args to allow user-defined functions to accept variable-length argument lists. diff --git a/functions/gettext.xml b/functions/gettext.xml index c59e1663a7..af291989ac 100644 --- a/functions/gettext.xml +++ b/functions/gettext.xml @@ -92,7 +92,7 @@ use an underscore character as an alias to this function. - <function>Gettext</function>-check + <function>gettext</function>-check <?php // Set language to German diff --git a/functions/http.xml b/functions/http.xml index ba91addd04..f7896ebfa8 100644 --- a/functions/http.xml +++ b/functions/http.xml @@ -24,7 +24,7 @@ - The Header function is used at the top of an + The header function is used at the top of an HTML file to send raw HTTP header strings. See the HTTP 1.1 Specification for more information on raw http headers. @@ -163,7 +163,7 @@ header ("Pragma: no-cache"); // HTTP/1.0 - Setcookie defines a cookie to be sent along + setcookie defines a cookie to be sent along with the rest of the header information. Cookies must be sent before any other headers are sent (this is a restriction of cookies, not PHP). This requires you to place @@ -212,7 +212,7 @@ header ("Pragma: no-cache"); // HTTP/1.0 Some examples follow how to send cookies: - <function>Setcookie</function> send examples + <function>setcookie</function> send examples setcookie ("TestCookie", "Test Value"); setcookie ("TestCookie", $value,time()+3600); /* expire in 1 hour */ diff --git a/functions/ibase.xml b/functions/ibase.xml index 62f6e31f24..85849963b4 100644 --- a/functions/ibase.xml +++ b/functions/ibase.xml @@ -83,7 +83,7 @@ magic_quotes_sybase = On execution of the script ends, unless it's closed earlier by explicitly calling ibase_close. - <function>Ibase_connect</function> example + <function>ibase_connect</function> example <?php $dbh = ibase_connect ($host, $username, $password); @@ -648,7 +648,7 @@ for ($i=0 ; $i < $coln ; $i++) { - Ibase_num_fields is currently not functional + ibase_num_fields is currently not functional in PHP 4. diff --git a/functions/icap.xml b/functions/icap.xml index 47e482a1a3..0473ae2f1e 100644 --- a/functions/icap.xml +++ b/functions/icap.xml @@ -78,7 +78,7 @@ - Icap_fetch_event fetches an event from the + icap_fetch_event fetches an event from the calendar stream specified by event_id. @@ -186,7 +186,7 @@ datetimes. - Icap_list_events function takes in a + icap_list_events function takes in a beginning datetime and an end datetime for a calendar stream. An array of event id's that are between the given datetimes are returned. @@ -244,7 +244,7 @@ - Icap_store_event Stores an event into + icap_store_event Stores an event into an ICAP calendar. An event object consists of: @@ -340,7 +340,7 @@ - Icap_delete_event deletes the calendar event + icap_delete_event deletes the calendar event specified by the uid. @@ -364,7 +364,7 @@ - Icap_snooze turns on an alarm for a + icap_snooze turns on an alarm for a calendar event specified by the uid. @@ -396,7 +396,7 @@ given datetime. - Icap_list_alarms function takes in a + icap_list_alarms function takes in a datetime for a calendar stream. An array of event id's that has an alarm should be going off at the datetime are returned. diff --git a/functions/imap.xml b/functions/imap.xml index 1ba2247fb9..22a2940ad9 100644 --- a/functions/imap.xml +++ b/functions/imap.xml @@ -537,7 +537,7 @@ imap_close($mbox); - <function>Imap_delete</function> Beispiel + <function>imap_delete</function> Beispiel $mbox = imap_open ("{your.imap.host}INBOX", "username", "password") or die ("can't connect: " . imap_last_error()); diff --git a/functions/info.xml b/functions/info.xml index 50d265ba42..1331f5697b 100644 --- a/functions/info.xml +++ b/functions/info.xml @@ -1192,14 +1192,14 @@ echo "Current PHP version: ".phpversion(); - Php_sapi_name returns a lowercase string which + php_sapi_name returns a lowercase string which describes the type of interface between web server and PHP (Server API, SAPI). In CGI PHP, this string is "cgi", in mod_php for Apache, this string is "apache" and so on. - <function>Php_sapi_name</function> Example + <function>php_sapi_name</function> Example $sapi_type = php_sapi_name(); if ($sapi_type == "cgi") diff --git a/functions/mail.xml b/functions/mail.xml index aed1a425f2..8d5e6f97d4 100644 --- a/functions/mail.xml +++ b/functions/mail.xml @@ -30,7 +30,7 @@ - Mail automatically mails the message + mail automatically mails the message specified in message to the receiver specified in to. Multiple recipients can be specified by putting a comma between each address in diff --git a/functions/math.xml b/functions/math.xml index 81063be84f..375520c15a 100644 --- a/functions/math.xml +++ b/functions/math.xml @@ -268,7 +268,7 @@ base higher than 10 will be represented with the letters a-z, with a meaning 10, b meaning 11 and z meaning 35. - <function>Base_convert</function> + <function>base_convert</function> $binary = base_convert ($hexadecimal, 16, 2); @@ -680,7 +680,7 @@ var_dump(hexdec("a0")); - Min returns the numerically lowest of the + min returns the numerically lowest of the parameter values. @@ -838,7 +838,7 @@ $randval = mt_rand(); - Number_format returns a formatted version of + number_format returns a formatted version of number. This function accepts either one, two or four parameters (not three): diff --git a/functions/mcrypt.xml b/functions/mcrypt.xml index 12aee0811c..d931156eb8 100644 --- a/functions/mcrypt.xml +++ b/functions/mcrypt.xml @@ -382,18 +382,18 @@ mcrypt_generic_end ($td); - Mcrypt_get_cipher_name is used to get the + mcrypt_get_cipher_name is used to get the name of the specified cipher. - Mcrypt_get_cipher_name takes the cipher + mcrypt_get_cipher_name takes the cipher number as an argument (libmcrypt 2.2.x) or takes the cipher name as an argument (libmcrypt 2.4.x) and returns the name of the cipher or false, if the cipher does not exist. - <function>Mcrypt_get_cipher_name</function> Example + <function>mcrypt_get_cipher_name</function> Example <?php $cipher = MCRYPT_TripleDES; @@ -435,11 +435,11 @@ print mcrypt_get_cipher_name ($cipher); second when linked against libmcrypt 2.4.x. - Mcrypt_get_block_size is used to get the + mcrypt_get_block_size is used to get the size of a block of the specified cipher. - Mcrypt_get_block_size takes one or two + mcrypt_get_block_size takes one or two arguments, the cipher and module, and returns the size in bytes. @@ -472,11 +472,11 @@ print mcrypt_get_cipher_name ($cipher); second when linked against libmcrypt 2.4.x. - Mcrypt_get_key_size is used to get the size + mcrypt_get_key_size is used to get the size of a key of the specified cipher. - Mcrypt_get_key_size takes one or two + mcrypt_get_key_size takes one or two arguments, the cipher and module, and returns the size in bytes. @@ -504,7 +504,7 @@ print mcrypt_get_cipher_name ($cipher); - Mcrypt_create_iv is used to create an IV. + mcrypt_create_iv is used to create an IV. mcrypt_create_iv takes two arguments, @@ -520,7 +520,7 @@ print mcrypt_get_cipher_name ($cipher); - <function>Mcrypt_create_iv</function> example + <function>mcrypt_create_iv</function> example <?php $cipher = MCRYPT_TripleDES; @@ -569,7 +569,7 @@ $iv = mcrypt_create_iv ($block_size, MCRYPT_DEV_RANDOM); second when linked against libmcrypt 2.4.x. - Mcrypt_cbc encrypts or decrypts (depending + mcrypt_cbc encrypts or decrypts (depending on mode) the data with cipher and key in CBC cipher mode and returns the resulting string. @@ -634,7 +634,7 @@ $iv = mcrypt_create_iv ($block_size, MCRYPT_DEV_RANDOM); second when linked against libmcrypt 2.4.x. - Mcrypt_cfb encrypts or decrypts (depending + mcrypt_cfb encrypts or decrypts (depending on mode) the data with cipher and key in CFB cipher mode and returns the resulting string. @@ -698,7 +698,7 @@ $iv = mcrypt_create_iv ($block_size, MCRYPT_DEV_RANDOM); second when linked against libmcrypt 2.4.x. - Mcrypt_ecb encrypts or decrypts (depending + mcrypt_ecb encrypts or decrypts (depending on mode) the data with cipher and key in ECB cipher mode and returns the resulting string. @@ -760,7 +760,7 @@ $iv = mcrypt_create_iv ($block_size, MCRYPT_DEV_RANDOM); second when linked against libmcrypt 2.4.x. - Mcrypt_ofb encrypts or decrypts (depending + mcrypt_ofb encrypts or decrypts (depending on mode) the data with cipher and key in OFB cipher mode and returns the resulting string. @@ -809,19 +809,19 @@ $iv = mcrypt_create_iv ($block_size, MCRYPT_DEV_RANDOM); - Mcrypt_list_algorithms is used to get an + mcrypt_list_algorithms is used to get an array of all supported algorithms in the lib_dir. - Mcrypt_list_algorithms takes as optional + mcrypt_list_algorithms takes as optional parameter a directory which specifies the directory where all algorithms are located. If not specifies, the value of the mcrypt.algorithms_dir php.ini directive is used. - <function>Mcrypt_list_algorithms</function> Example + <function>mcrypt_list_algorithms</function> Example <?php $algorithms = mcrypt_list_algorithms ("/usr/local/lib/libmcrypt"); @@ -858,19 +858,19 @@ foreach ($algorithms as $cipher) { - Mcrypt_list_modes is used to get an + mcrypt_list_modes is used to get an array of all supported modes in the lib_dir. - Mcrypt_list_modes takes as optional + mcrypt_list_modes takes as optional parameter a directory which specifies the directory where all modes are located. If not specifies, the value of the mcrypt.modes_dir php.ini directive is used. - <function>Mcrypt_list_modes</function> Example + <function>mcrypt_list_modes</function> Example <?php $modes = mcrypt_list_modes (); @@ -914,7 +914,7 @@ foreach ($modes as $mode) { second when linked against libmcrypt 2.4.x. - Mcrypt_get_iv_size returns the size of + mcrypt_get_iv_size returns the size of the Initialisation Vector (IV) in bytes. On error the function returns FALSE. If the IV is ignored in the specified cipher/mode combination zero is returned. @@ -956,7 +956,7 @@ foreach ($modes as $mode) { - Mcrypt_encrypt encrypts the data + mcrypt_encrypt encrypts the data and returns the encrypted data. @@ -991,7 +991,7 @@ foreach ($modes as $mode) { - <function>Mcrypt_encrypt</function> Example + <function>mcrypt_encrypt</function> Example <?php $iv = mcrypt_create_iv (mcrypt_get_iv_size (MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB), MCRYPT_RAND); @@ -1035,7 +1035,7 @@ echo strlen ($crypttext)."\n"; - Mcrypt_decrypt decrypts the data + mcrypt_decrypt decrypts the data and returns the unencrypted data. @@ -1105,7 +1105,7 @@ echo strlen ($crypttext)."\n"; - <function>Mcrypt_module_open</function> Example + <function>mcrypt_module_open</function> Example <?php $td = mcrypt_module_open (MCRYPT_DES, "", MCRYPT_MODE_ECB, "/usr/lib/mcrypt-modes"); @@ -1198,7 +1198,7 @@ $td = mcrypt_module_open (MCRYPT_DES, "", MCRYPT_MODE_ECB, "/usr/lib/mcrypt-mode - <function>Mdecrypt_generic</function> Example + <function>mdecrypt_generic</function> Example <?php $iv_size = mcrypt_enc_get_iv_size ($td)); diff --git a/functions/mhash.xml b/functions/mhash.xml index 938571924d..46c3bd1d7e 100644 --- a/functions/mhash.xml +++ b/functions/mhash.xml @@ -123,7 +123,7 @@ The hmac is 750c783e6ab0b503eaa86e310a5db738 - Mhash_get_hash_name is used to get the name + mhash_get_hash_name is used to get the name of the specified hash. @@ -133,7 +133,7 @@ The hmac is 750c783e6ab0b503eaa86e310a5db738 - <function>Mhash_get_hash_name</function> Example + <function>mhash_get_hash_name</function> Example <?php $hash = MHASH_MD5; @@ -164,11 +164,11 @@ MD5 - Mhash_get_block_size is used to get the size + mhash_get_block_size is used to get the size of a block of the specified hash. - Mhash_get_block_size takes one argument, the + mhash_get_block_size takes one argument, the hash and returns the size in bytes or false, if the hash does not exist. @@ -189,7 +189,7 @@ MD5 - Mhash_count returns the highest available hash + mhash_count returns the highest available hash id. Hashes are numbered from 0 to this hash id. @@ -228,7 +228,7 @@ for ($i = 0; $i <= $nr; $i++) { - Mhash applies a hash function specified by + mhash applies a hash function specified by hash to the data and returns the resulting hash (also called digest). If the key is specified it will return the resulting HMAC. HMAC is keyed hashing @@ -256,7 +256,7 @@ for ($i = 0; $i <= $nr; $i++) { - Mhash_keygen_s2k generates a key that is + mhash_keygen_s2k generates a key that is bytes long, from a user given password. This is the Salted S2K algorithm as specified in the OpenPGP document (RFC 2440). That algorithm will use the specified diff --git a/functions/misc.xml b/functions/misc.xml index ed4da320b7..befbace657 100644 --- a/functions/misc.xml +++ b/functions/misc.xml @@ -187,7 +187,7 @@ echo Greeting; // outputs "Hello you." - Define returns TRUE + define returns TRUE on success and FALSE if an error occurs. @@ -346,7 +346,7 @@ if ($bad) { - <function>Eval</function> example - simple text merge + <function>eval</function> example - simple text merge <?php @@ -437,7 +437,7 @@ This is a cup with my coffee in it. The following example shows how one might list all available information retrieved about the user's browser. - <function>Get_browser</function> example + <function>get_browser</function> example <?php function list_array ($array) { @@ -687,7 +687,7 @@ http://your.server.com/source/path/to/script.php - Leak leaks the specified amount of memory. + leak leaks the specified amount of memory. This is useful when debugging the memory manager, which @@ -838,7 +838,7 @@ http://your.server.com/source/path/to/script.php - <function>Pack</function> format string + <function>pack</function> format string $binarydata = pack ("nvc*", 0x1234, 0x5678, 65, 66); @@ -943,7 +943,7 @@ $binarydata = pack ("nvc*", 0x1234, 0x5678, 65, 66); - Uniqid returns a prefixed unique identifier + uniqid returns a prefixed unique identifier based on the current time in microseconds. The prefix can be useful for instance if you generate identifiers simultaneously on several hosts that might happen to generate the identifier at the @@ -1000,17 +1000,17 @@ $better_token = md5 (uniqid (rand())); // better, difficult to guess - Unpack from binary string into array + unpack from binary string into array according to format. Returns array containing unpacked elements of binary string. - Unpack works slightly different from Perl as + unpack works slightly different from Perl as the unpacked data is stored in an associative array. To accomplish this you have to name the different format codes and separate them by a slash /. - <function>Unpack</function> format string + <function>unpack</function> format string $array = unpack ("c2chars/nint", $binarydata); diff --git a/functions/msql.xml b/functions/msql.xml index de5f82bb30..03f089c9da 100644 --- a/functions/msql.xml +++ b/functions/msql.xml @@ -855,7 +855,7 @@ - Msql_num_rows returns the number of rows in + msql_num_rows returns the number of rows in a result set. diff --git a/functions/mssql.xml b/functions/mssql.xml index eb87559a1b..55eb8f0543 100644 --- a/functions/mssql.xml +++ b/functions/mssql.xml @@ -21,7 +21,7 @@ Returns: true on success, false on error. - Mssql_close closes the link to a MS SQL + mssql_close closes the link to a MS SQL Server database that's associated with the specified link identifier. If the link identifier isn't specified, the last opened link is assumed. @@ -32,7 +32,7 @@ execution. - Mssql_close will not close persistent links + mssql_close will not close persistent links generated by mssql_pconnect. @@ -68,7 +68,7 @@ on error. - Mssql_connect establishes a connection to a + mssql_connect establishes a connection to a MS SQL server. The servername argument has to be a valid servername that is defined in the 'interfaces' file. @@ -108,7 +108,7 @@ Returns: true on success, false on failure. - Mssql_data_seek moves the internal row + mssql_data_seek moves the internal row pointer of the MS SQL result associated with the specified result identifier to point to the specified row number. The next call to mssql_fetch_row would return that row. @@ -137,7 +137,7 @@ if there are no more rows. - Mssql_fetch_array is an extended version of + mssql_fetch_array is an extended version of mssql_fetch_row. In addition to storing the data in the numeric indices of the result array, it also stores the data in associative indices, using the field names as keys. @@ -175,7 +175,7 @@ Returns an object containing field information. - Mssql_fetch_field can be used in order to + mssql_fetch_field can be used in order to obtain information about fields in a certain query result. If the field offset isn't specified, the next field that wasn't yet retrieved by mssql_fetch_field is retrieved. @@ -230,7 +230,7 @@ row, or false if there are no more rows. - Mssql_fetch_object is similar to + mssql_fetch_object is similar to mssql_fetch_array, with one difference - an object is returned, instead of an array. Indirectly, that means that you can only access the data by the field names, and not by @@ -267,7 +267,7 @@ if there are no more rows. - Mssql_fetch_row fetches one row of data from + mssql_fetch_row fetches one row of data from the result associated with the specified result identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. @@ -507,7 +507,7 @@ - Mssql_num_fields returns the number of + mssql_num_fields returns the number of fields in a result set. @@ -533,7 +533,7 @@ - Mssql_num_rows returns the number of rows in + mssql_num_rows returns the number of rows in a result set. @@ -570,7 +570,7 @@ or false on error. - Mssql_pconnect acts very much like + mssql_pconnect acts very much like mssql_connect with two major differences. @@ -612,7 +612,7 @@ on error. - Mssql_query sends a query to the currently + mssql_query sends a query to the currently active database on the server that's associated with the specified link identifier. If the link identifier isn't specified, the last opened link is assumed. If no link is open, @@ -643,7 +643,7 @@ - Mssql_result returns the contents of one + mssql_result returns the contents of one cell from a MS SQL result set. The field argument can be the field's offset, the field's name or the field's table dot field's name (tablename.fieldname). If the column name has been @@ -687,7 +687,7 @@ Returns: true on success, false on error - Mssql_select_db sets the current active + mssql_select_db sets the current active database on the server that's associated with the specified link identifier. If no link identifier is specified, the last opened link is assumed. If no link is open, the function will try to diff --git a/functions/mysql.xml b/functions/mysql.xml index 7b664d38bd..0a7f313442 100644 --- a/functions/mysql.xml +++ b/functions/mysql.xml @@ -454,7 +454,7 @@ - <function>Mysql_db_name</function> example + <function>mysql_db_name</function> example <?php error_reporting(E_ALL); @@ -739,7 +739,7 @@ select t1.f1 as foo t2.f1 as bar from t1, t2 mysql_fetch_row and mysql_fetch_assoc. - <function>Mysql_fetch_array</function> example + <function>mysql_fetch_array</function> example <?php mysql_connect ($host, $user, $password); @@ -800,7 +800,7 @@ mysql_free_result ($result); mysql_fetch_row and mysql_fetch_array. - <function>Mysql_fetch_assoc</function> + <function>mysql_fetch_assoc</function> <?php mysql_connect ($host, $user, $password); @@ -911,7 +911,7 @@ mysql_free_result ($result); - <function>Mysql_fetch_field</function> + <function>mysql_fetch_field</function> <?php mysql_connect ($host, $user, $password) @@ -1994,7 +1994,7 @@ $result = mysql_query ("SELECT my_col FROM my_tbl") mysql_num_rows function may be used to determine the number of tables in the result pointer. - <function>Mysql_tablename</function> Example + <function>mysql_tablename</function> Example <?php mysql_connect ("localhost:3306"); diff --git a/functions/network.xml b/functions/network.xml index fa08ea1527..c2abf466d5 100644 --- a/functions/network.xml +++ b/functions/network.xml @@ -62,7 +62,7 @@ - Closelog closes the descriptor being used to + closelog closes the descriptor being used to write to the system logger. The use of closelog is optional. @@ -182,7 +182,7 @@ used to set a timeout in seconds for the connect system call. - Fsockopen returns a file pointer which may + fsockopen returns a file pointer which may be used together with the other file functions (such as fgets, fgetss, fputs, fclose, and @@ -210,7 +210,7 @@ switch it to non-blocking mode by using socket_set_blocking. - <function>Fsockopen</function> Example + <function>fsockopen</function> Example $fp = fsockopen ("www.php.net", 80, $errno, $errstr, 30); if (!$fp) { @@ -392,7 +392,7 @@ if (!$fp) { - Getprotobyname returns the protocol number + getprotobyname returns the protocol number associated with the protocol name as per /etc/protocols. @@ -418,7 +418,7 @@ if (!$fp) { - Getprotobynumber returns the protocol name + getprotobynumber returns the protocol name associated with protocol number as per /etc/protocols. @@ -445,7 +445,7 @@ if (!$fp) { - Getservbyname returns the Internet port + getservbyname returns the Internet port which corresponds to service for the specified protocol as per /etc/services. @@ -475,7 +475,7 @@ if (!$fp) { - Getservbyport returns the Internet service + getservbyport returns the Internet service associated with port for the specified protocol as per /etc/services. protocol is either TCP @@ -508,7 +508,7 @@ if (!$fp) { network address from its Internet standard format (dotted string) representation. - <function>Ip2long</function> Example + <function>ip2long</function> Example <?php $ip = gethostbyname("www.php.net"); @@ -582,7 +582,7 @@ echo $out; - Openlog opens a connection to the system + openlog opens a connection to the system logger for a program. The string ident is added to each message. Values for option and facility are given below. @@ -599,7 +599,7 @@ echo $out; - <function>Openlog</function> Options + <function>openlog</function> Options @@ -646,7 +646,7 @@ echo $out;
- <function>Openlog</function> Facilities + <function>openlog</function> Facilities @@ -902,7 +902,7 @@ if(!$fp) { - Syslog generates a log message that will be + syslog generates a log message that will be distributed by the system logger. priority is a combination of the facility and the level, values for which are given in the next section. @@ -913,7 +913,7 @@ if(!$fp) {
- <function>Syslog</function> Priorities (in descending order) + <function>syslog</function> Priorities (in descending order) diff --git a/functions/nis.xml b/functions/nis.xml index 342da0dd89..d26d402868 100644 --- a/functions/nis.xml +++ b/functions/nis.xml @@ -31,7 +31,7 @@ - Yp_get_default_domain returns the default + yp_get_default_domain returns the default domain of the node or FALSE. Can be used as the domain parameter for successive NIS calls. @@ -76,7 +76,7 @@ echo "Default NIS domain is: " . $domain; - Yp_order returns the order number for a map + yp_order returns the order number for a map or FALSE. @@ -117,7 +117,7 @@ echo "Default NIS domain is: " . $domain; - Yp_master returns the machine name of + yp_master returns the machine name of the master NIS server for a map. @@ -157,7 +157,7 @@ echo "Master for this map is: " . $master; - Yp_match returns the value associated with + yp_match returns the value associated with the passed key out of the specified map or FALSE. This key must be exact. @@ -202,7 +202,7 @@ echo "Matched entry is: " . $entry; - Yp_first returns the first key-value + yp_first returns the first key-value pair from the named map in the named domain, otherwise FALSE. @@ -245,7 +245,7 @@ echo "First entry in this map has key " . $key . " and value " . $value; - Yp_next returns the next key-value pair in + yp_next returns the next key-value pair in the named map after the specified key or FALSE. @@ -296,7 +296,7 @@ echo "The next entry after joe has key " . $key - Yp_errno returns the error code of the + yp_errno returns the error code of the previous operation. @@ -348,7 +348,7 @@ echo "The next entry after joe has key " . $key - Yp_err_string returns the error message + yp_err_string returns the error message associated with the previous operation. Useful to indicate what exactly went wrong. diff --git a/functions/pgsql.xml b/functions/pgsql.xml index cfe022bf02..bc16b228f5 100644 --- a/functions/pgsql.xml +++ b/functions/pgsql.xml @@ -147,11 +147,11 @@ - Pg_cmdtuples returns the number of tuples + pg_cmdtuples returns the number of tuples (instances) affected by INSERT, UPDATE, and DELETE queries. If no tuple is affected the function will return 0. - <function>Pg_cmdtuples</function> + <function>pg_cmdtuples</function> <?php $result = pg_exec ($conn, "INSERT INTO publisher VALUES ('Author')"); @@ -373,7 +373,7 @@ $dbconn3 = pg_Connect ("host=sheep port=5432 dbname=mary user=lamb password=baaa if there are no more rows. - Pg_fetch_array is an extended version of + pg_fetch_array is an extended version of pg_fetch_row. In addition to storing the data in the numeric indices of the result array, it also stores the data in associative indices, using the field names as keys. @@ -447,7 +447,7 @@ echo $arr["author"] . " <- array\n"; row, or false if there are no more rows. - Pg_fetch_object is similar to + pg_fetch_object is similar to pg_fetch_array, with one difference - an object is returned, instead of an array. Indirectly, that means that you can only access the data by the field names, and not by @@ -537,7 +537,7 @@ pg_close ($db_conn); if there are no more rows. - Pg_fetch_row fetches one row of data from + pg_fetch_row fetches one row of data from the result associated with the specified result identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. @@ -621,7 +621,7 @@ for ($i=0; $i<$num; $i++) { - Pg_fieldname will return the name of the + pg_fieldname will return the name of the field occupying the given column number in the given PostgreSQL result identifier. Field numbering starts from 0. @@ -643,7 +643,7 @@ for ($i=0; $i<$num; $i++) { - Pg_fieldnum will return the number of the + pg_fieldnum will return the number of the column slot that corresponds to the named field in the given PosgreSQL result identifier. Field numbering starts at 0. This function will return -1 on error. @@ -667,7 +667,7 @@ for ($i=0; $i<$num; $i++) { - Pg_fieldprtlen will return the actual + pg_fieldprtlen will return the actual printed length (number of characters) of a specific value in a PostgreSQL result. Row numbering starts at 0. This function will return -1 on an error. @@ -692,7 +692,7 @@ for ($i=0; $i<$num; $i++) { - Pg_fieldsize will return the internal + pg_fieldsize will return the internal storage size (in bytes) of the field number in the given PostgreSQL result. Field numbering starts at 0. A field size of -1 indicates a variable length field. This function will return @@ -718,7 +718,7 @@ for ($i=0; $i<$num; $i++) { - Pg_fieldtype will return a string containing + pg_fieldtype will return a string containing the type name of the given field in the given PostgreSQL result identifier. Field numbering starts at 0. @@ -739,7 +739,7 @@ for ($i=0; $i<$num; $i++) { - Pg_freeresult only needs to be called if you + pg_freeresult only needs to be called if you are worried about using too much memory while your script is running. All result memory will automatically be freed when the script is finished. But, if you are sure you are not going to @@ -764,7 +764,7 @@ for ($i=0; $i<$num; $i++) { - Pg_getlastoid can be used to retrieve the + pg_getlastoid can be used to retrieve the oid assigned to an inserted tuple if the result identifier is used from the last command sent via pg_exec and was an SQL INSERT. This @@ -792,7 +792,7 @@ for ($i=0; $i<$num; $i++) { - Pg_host will return the host name of the + pg_host will return the host name of the given PostgreSQL connection identifier is connected to. @@ -812,7 +812,7 @@ for ($i=0; $i<$num; $i++) { - Pg_loclose closes an Inversion Large + pg_loclose closes an Inversion Large Object. Fd is a file descriptor for the large object from pg_loopen. @@ -833,7 +833,7 @@ for ($i=0; $i<$num; $i++) { - Pg_locreate creates an Inversion Large + pg_locreate creates an Inversion Large Object and returns the oid of the large object. conn specifies a valid database connection. PostgreSQL access modes INV_READ, INV_WRITE, and @@ -920,7 +920,7 @@ for ($i=0; $i<$num; $i++) { - Pg_loopen open an Inversion Large Object and + pg_loopen open an Inversion Large Object and returns file descriptor of the large object. The file descriptor encapsulates information about the connection. Do not close the connection before closing the large object file descriptor. @@ -971,7 +971,7 @@ for ($i=0; $i<$num; $i++) { - Pg_loreadall reads a large object and + pg_loreadall reads a large object and passes it straight through to the browser after sending all pending headers. Mainly intended for sending binary data like images or sound. @@ -993,7 +993,7 @@ for ($i=0; $i<$num; $i++) { - Pg_lounlink deletes a large object with the + pg_lounlink deletes a large object with the lobjid identifier for that large object. @@ -1014,7 +1014,7 @@ for ($i=0; $i<$num; $i++) { - Pg_lowrite writes at most to a large object + pg_lowrite writes at most to a large object from a variable buf and returns the number of bytes actually written, or false in the case of an error. fd is a file descriptor for the large @@ -1037,7 +1037,7 @@ for ($i=0; $i<$num; $i++) { - Pg_numfields will return the number of + pg_numfields will return the number of fields (columns) in a PostgreSQL result. The argument is a valid result identifier returned by pg_exec. This function will return -1 on error. @@ -1063,7 +1063,7 @@ for ($i=0; $i<$num; $i++) { - Pg_numrows will return the number of rows in a + pg_numrows will return the number of rows in a PostgreSQL result. The argument is a valid result identifier returned by pg_exec. This function will return -1 on error. @@ -1089,7 +1089,7 @@ for ($i=0; $i<$num; $i++) { - Pg_options will return a string containing + pg_options will return a string containing the options specified on the given PostgreSQL connection identifier. @@ -1152,7 +1152,7 @@ for ($i=0; $i<$num; $i++) { - Pg_port will return the port number that the + pg_port will return the port number that the given PostgreSQL connection identifier is connected to. @@ -1225,7 +1225,7 @@ for ($i=0; $i<$num; $i++) { - Pg_result will return values from a result + pg_result will return values from a result identifier produced by pg_Exec. The row_number and fieldname sepcify what cell in the table @@ -1394,7 +1394,7 @@ for ($i=0; $i<$num; $i++) { - Pg_tty will return the tty name that server + pg_tty will return the tty name that server side debugging output is sent to on the given PostgreSQL connection identifier. diff --git a/functions/pspell.xml b/functions/pspell.xml index 0d9329f29c..550e67736f 100644 --- a/functions/pspell.xml +++ b/functions/pspell.xml @@ -31,7 +31,7 @@ - Pspell_add_to_personal adds a word to the personal + pspell_add_to_personal adds a word to the personal wordlist. If you used pspell_new_config with pspell_config_personal to open the dictionary, you can save the wordlist later with @@ -40,7 +40,7 @@ - <function>Pspell_add_to_personal</function> + <function>pspell_add_to_personal</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -70,7 +70,7 @@ pspell_save_wordlist ($pspell_link); - Pspell_add_to_session adds a word to the wordlist + pspell_add_to_session adds a word to the wordlist associated with the current session. It is very similar to pspell_add_to_personal @@ -92,12 +92,12 @@ pspell_save_wordlist ($pspell_link); - Pspell_check checks the spelling of a word + pspell_check checks the spelling of a word and returns true if the spelling is correct, false if not. - <function>Pspell_check</function> + <function>pspell_check</function> $pspell_link = pspell_new ("en"); @@ -126,13 +126,13 @@ if (pspell_check ($pspell_link, "testt")) { - Pspell_clear_session clears the current session. + pspell_clear_session clears the current session. The current wordlist becomes blank, and, for example, if you try to save it with pspell_save_wordlist, nothing happens. - <function>Pspell_add_to_personal</function> + <function>pspell_add_to_personal</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -176,7 +176,7 @@ pspell_save_wordlist ($pspell_link); //"Vlad" will not be saved - Pspell_config_create has a very similar syntax to + pspell_config_create has a very similar syntax to pspell_new. In fact, using pspell_config_create immediatelly followed by pspell_new_config will produce the exact same result. @@ -234,7 +234,7 @@ pspell_save_wordlist ($pspell_link); //"Vlad" will not be saved - <function>Pspell_config_create</function> + <function>pspell_config_create</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -261,14 +261,14 @@ $pspell_link = pspell_new_personal ($pspell_config, "en"); - Pspell_config_ignore should be used on a config + pspell_config_ignore should be used on a config before calling pspell_new_config. This function allows short words to be skipped by the spellchecker. Words less then n characters will be skipped. - <function>Pspell_config_ignore</function> + <function>pspell_config_ignore</function> $pspell_config = pspell_config_create ("en"); pspell_config_ignore($pspell_config, 5); @@ -295,7 +295,7 @@ pspell_check($pspell_link, "abcd"); //will not result in an error - Pspell_config_mode should be used on a config + pspell_config_mode should be used on a config before calling pspell_new_config. This function determines how many suggestions will be returned by pspell_suggest. @@ -323,7 +323,7 @@ pspell_check($pspell_link, "abcd"); //will not result in an error - <function>Pspell_config_mode</function> + <function>pspell_config_mode</function> $pspell_config = pspell_config_create ("en"); pspell_config_mode($pspell_config, PSPELL_FAST); @@ -350,7 +350,7 @@ pspell_check($pspell_link, "thecat"); - Pspell_config_personal should be used on a config + pspell_config_personal should be used on a config before calling pspell_new_config. The personal wordlist will be loaded and used in addition to the standard one after you call pspell_new_config. If the file does not @@ -362,7 +362,7 @@ pspell_check($pspell_link, "thecat"); - <function>Pspell_config_personal</function> + <function>pspell_config_personal</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -389,7 +389,7 @@ pspell_check ($pspell_link, "thecat"); - Pspell_config_repl should be used on a config + pspell_config_repl should be used on a config before calling pspell_new_config. The replacement pairs improve the quality of the spellchecker. When a word is misspelled, and a proper suggestion was not found in the list, @@ -402,7 +402,7 @@ pspell_check ($pspell_link, "thecat"); - <function>Pspell_config_repl</function> + <function>pspell_config_repl</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -430,7 +430,7 @@ pspell_check ($pspell_link, "thecat"); - Pspell_config_runtogether should be used on a config + pspell_config_runtogether should be used on a config before calling pspell_new_config. This function determines whether run-together words will be treated as legal compounds. That is, "thecat" will be a legal compound, @@ -441,7 +441,7 @@ pspell_check ($pspell_link, "thecat"); - <function>Pspell_config_runtogether</function> + <function>pspell_config_runtogether</function> $pspell_config = pspell_config_create ("en"); pspell_config_runtogether ($pspell_config, true); @@ -469,7 +469,7 @@ pspell_check ($pspell_link, "thecat"); - Pspell_config_save_repl should be used on a config + pspell_config_save_repl should be used on a config before calling pspell_new_config. It determines whether pspell_save_wordlist will save the replacement pairs along with the wordlist. Usually there is no need to use @@ -516,7 +516,7 @@ pspell_check ($pspell_link, "thecat"); - Pspell_new opens up a new dictionary and + pspell_new opens up a new dictionary and returns the dictionary link identifier for use in other pspell functions. @@ -584,7 +584,7 @@ pspell_check ($pspell_link, "thecat"); - <function>Pspell_new</function> + <function>pspell_new</function> $pspell_link = pspell_new ("en", "", "", "", (PSPELL_FAST|PSPELL_RUN_TOGETHER)); @@ -609,7 +609,7 @@ $pspell_link = pspell_new ("en", "", "", "", - Pspell_new_config opens up a new dictionary with + pspell_new_config opens up a new dictionary with settings specified in a config, created with with pspell_config_create and modified with pspell_config_* functions. This method provides you @@ -623,7 +623,7 @@ $pspell_link = pspell_new ("en", "", "", "", - <function>Pspell_new_config</function> + <function>pspell_new_config</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -670,7 +670,7 @@ $pspell_link = pspell_new_personal ($pspell_config, "en"); - Pspell_new_personal opens up a new dictionary with + pspell_new_personal opens up a new dictionary with a personal wordlist and returns the dictionary link identifier for use in other pspell functions. The wordlist can be modified and saved with pspell_save_wordlist, if desired. However, the @@ -752,7 +752,7 @@ $pspell_link = pspell_new_personal ($pspell_config, "en"); - <function>Pspell_new_personal</function> + <function>pspell_new_personal</function> $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", "en", "", "", "", PSPELL_FAST|PSPELL_RUN_TOGETHER)); @@ -776,7 +776,7 @@ $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", - Pspell_save_wordlist saves the personal wordlist + pspell_save_wordlist saves the personal wordlist from the current session. The dictionary has to be open with pspell_new_personal, and the location of files to be saved specified with pspell_config_personal and @@ -786,7 +786,7 @@ $pspell_link = pspell_new_personal ("/var/dictionaries/custom.pws", - <function>Pspell_add_to_personal</function> + <function>pspell_add_to_personal</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/tmp/dicts/newdict"); @@ -816,7 +816,7 @@ pspell_save_wordlist ($pspell_link); - Pspell_store_replacement stores a replacement pair for + pspell_store_replacement stores a replacement pair for a word, so that replacement can be returned by pspell_suggest later. In order to be able to take advantage of this function, you have to use @@ -830,7 +830,7 @@ pspell_save_wordlist ($pspell_link); - <function>Pspell_store_replacement</function> + <function>pspell_store_replacement</function> $pspell_config = pspell_config_create ("en"); pspell_config_personal ($pspell_config, "/var/dictionaries/custom.pws"); @@ -860,12 +860,12 @@ pspell_save_wordlist ($pspell_link); - Pspell_suggest returns an array of possible + pspell_suggest returns an array of possible spellings for the given word. - <function>Pspell_suggest</function> + <function>pspell_suggest</function> $pspell_link = pspell_new ("en"); diff --git a/functions/readline.xml b/functions/readline.xml index 6ca876865b..876427577b 100644 --- a/functions/readline.xml +++ b/functions/readline.xml @@ -43,7 +43,7 @@ readline_add_history. - <function>Readline</function> + <function>readline</function> //get 3 commands from user for ($i=0; $i < 3; $i++) { diff --git a/functions/regex.xml b/functions/regex.xml index 3368fd1957..ca40cef8e8 100644 --- a/functions/regex.xml +++ b/functions/regex.xml @@ -317,7 +317,7 @@ echo $string; /* Output: 'This string has 4 words.' */ To split off the first four fields from a line from /etc/passwd: - <function>Split</function> Example + <function>split</function> Example $passwd_list = split (":", $passwd_line, 5); @@ -327,7 +327,7 @@ $passwd_list = split (":", $passwd_line, 5); To parse a date which may be delimited with slashes, dots, or hyphens: - <function>Split</function> Example + <function>split</function> Example $date = "04/30/1973"; // Delimiters may be slash, dot, or hyphen list ($month, $day, $year) = split ('[/.-]', $date); @@ -437,7 +437,7 @@ echo "Month: $month; Day: $day; Year: $year<br>\n"; character's uppercase and lowercase form if applicable, otherwise it contains the original character twice. - <function>Sql_regcase</function> Example + <function>sql_regcase</function> Example echo sql_regcase ("Foo bar"); diff --git a/functions/sem.xml b/functions/sem.xml index 49b608a662..9dd9c8dc5a 100644 --- a/functions/sem.xml +++ b/functions/sem.xml @@ -76,7 +76,7 @@ error. - Sem_get returns an id that can be used to + sem_get returns an id that can be used to access the System V semaphore with the given key. The semaphore is created if necessary using the permission bits specified in perm (defaults to 0666). The number of processes that can @@ -118,7 +118,7 @@ Returns: TRUE on success, FALSE on error. - Sem_acquire blocks (if necessary) until the + sem_acquire blocks (if necessary) until the semaphore can be acquired. A process attempting to acquire a semaphore which it has already acquired will block forever if acquiring the semaphore would cause its max_acquire value to @@ -153,7 +153,7 @@ Returns: TRUE on success, FALSE on error. - Sem_release releases the semaphore if it + sem_release releases the semaphore if it is currently acquired by the calling process, otherwise a warning is generated. @@ -191,7 +191,7 @@ on error. - Sem_remove removes the semaphore + sem_remove removes the semaphore sem_identifier if it has been created by sem_get, otherwise generates a warning. @@ -233,7 +233,7 @@ - Shm_attach returns an id that that can be + shm_attach returns an id that that can be used to access the System V shared memory with the given key, the first call creates the shared memory segment with mem_size (default: sysvshm.init_mem in the - Shm_detach disconnects from the shared + shm_detach disconnects from the shared memory given by the shm_identifier created by shm_attach. Remember, that shared memory still exist in the Unix system and the data is still present. @@ -346,7 +346,7 @@ - Shm_get_var returns the variable with a given + shm_get_var returns the variable with a given variable_key. The variable is still present in the shared memory. diff --git a/functions/strings.xml b/functions/strings.xml index d8fbf9f850..9c2cc04e0a 100644 --- a/functions/strings.xml +++ b/functions/strings.xml @@ -43,7 +43,7 @@ charlist like "\0..\37", which would escape all characters with ASCII code between 0 and 31. - <function>Addcslashes</function> example + <function>addcslashes</function> example $escaped = addcslashes ($not_escaped, "\0..\37!@\177..\377"); @@ -115,7 +115,7 @@ $escaped = addcslashes ($not_escaped, "\0..\37!@\177..\377"); - Chop + chop Remove trailing whitespace @@ -130,7 +130,7 @@ $escaped = addcslashes ($not_escaped, "\0..\37!@\177..\377"); Returns the argument string without trailing whitespace, including newlines. - <function>Chop</function> example + <function>chop</function> example $trimmed = chop ($line); @@ -152,7 +152,7 @@ $trimmed = chop ($line); - Chr + chr Return a specific character @@ -167,7 +167,7 @@ $trimmed = chop ($line); Returns a one-character string containing the character specified by ascii. - <function>Chr</function> example + <function>chr</function> example $str .= chr (27); /* add an escape character at the end of $str */ @@ -211,7 +211,7 @@ $str = sprintf ("The string ends in escape: %c", 27); end (defaults to "\r\n"). It returns the new string leaving the original string untouched. - <function>Chunk_split</function> example + <function>chunk_split</function> example # format $data using RFC 2045 semantics @@ -487,12 +487,12 @@ $new_string = chunk_split (base64_encode($data)); Outputs all parameters. - Echo is not actually a function (it is a + echo is not actually a function (it is a language construct) so you are not required to use parentheses with it. In fact, if you want to pass more than one parameter to echo, you must not enclose the parameters within parentheses. - <function>Echo</function> examples + <function>echo</function> examples <?php echo "Hello World"; @@ -529,7 +529,7 @@ echo ($some_var) ? 'true': 'false'; // changing the statement around - Echo also has a shortcut syntax, where you + echo also has a shortcut syntax, where you can immediately follow the opening tag with an equals sign. @@ -583,7 +583,7 @@ I have <?=$foo?> foo. - <function>Explode</function> example + <function>explode</function> example $pizza = "piece1 piece2 piece3 piece4 piece5 piece6"; $pieces = explode (" ", $pizza); @@ -931,7 +931,7 @@ $new = htmlspecialchars("<a href='test'>Test</a>", ENT_QUOTES); array elements in the same order, with the glue string between each element. - <function>Implode</function> example + <function>implode</function> example $colon_separated = implode (":", $array); @@ -1340,7 +1340,7 @@ echo "</PRE>\n"; - Metaphone + metaphone Calculate the metaphone key of a string @@ -1410,7 +1410,7 @@ echo "</PRE>\n"; - Ord + ord Return ASCII value of character @@ -1426,7 +1426,7 @@ echo "</PRE>\n"; string. This function complements chr. - <function>Ord</function> example + <function>ord</function> example if (ord ($str) == 10) { echo "The first character of \$str is a line feed.\n"; @@ -1629,12 +1629,12 @@ $trimmed = rtrim ($line); The function sscanf is the input analog of - printf. Sscanf reads from + printf. sscanf reads from the string str and interprets it according to the specified format. If only two parameters were passed to this function, the values parsed will be returned as an array. - <function>Sscanf</function> Example + <function>sscanf</function> Example // getting the serial number $serial = sscanf("SN/2350001","SN/%d"); @@ -1647,7 +1647,7 @@ echo "Item $serial was manufactured on: $year-".substr($month,0,3)."-$day\n"; If optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference. - <function>Sscanf</function> - using optional parameters + <function>sscanf</function> - using optional parameters // get author info and generate DocBook entry $auth = "24\tLewis Carroll"; @@ -1988,13 +1988,13 @@ printf($format,$num,$location); Examples - <function>Sprintf</function>: zero-padded integers + <function>sprintf</function>: zero-padded integers $isodate = sprintf ("%04d-%02d-%02d", $year, $month, $day); - <function>Sprintf</function>: formatting currency + <function>sprintf</function>: formatting currency $money1 = 68.75; $money2 = 54.35; @@ -2684,7 +2684,7 @@ if (is_string ($pos) && !$pos) { If needle is not a string, it is converted to an integer and applied as the ordinal value of a character. - <function>Strrchr</function> example + <function>strrchr</function> example // get last directory in $PATH $dir = substr (strrchr ($PATH, ":"), 1); @@ -2722,7 +2722,7 @@ $last = substr (strrchr ($text, 10), 1 ); multiplier has to be greater than 0. - <function>Str_repeat</function> example + <function>str_repeat</function> example echo str_repeat ("-=", 10); @@ -2890,7 +2890,7 @@ $var = strspn ("42 is the answer, what is the question ...", "1234567890"); - <function>Strstr</function> example + <function>strstr</function> example $email = 'sterling@designmultimedia.com'; $domain = strstr ($email, '@'); @@ -2926,7 +2926,7 @@ print $domain; // prints @designmultimedia.com could tokenize this string into its individual words by using the space character as the token. - <function>Strtok</function> example + <function>strtok</function> example $string = "This is an example string"; $tok = strtok ($string," "); @@ -2981,7 +2981,7 @@ while ($tok) { umlaut-A (Ä) will not be converted. - <function>Strtolower</function> example + <function>strtolower</function> example $str = "Mary Had A Little Lamb and She LOVED It So"; $str = strtolower($str); @@ -3018,7 +3018,7 @@ print $str; # Prints mary had a little lamb and she loved it so (ä) will not be converted. - <function>Strtoupper</function> example + <function>strtoupper</function> example $str = "Mary Had A Little Lamb and She LOVED It So"; $str = strtoupper ($str); @@ -3127,7 +3127,7 @@ $bodytag = str_replace ("%body%", "black", "<body text=%body%>"); different lengths, the extra characters in the longer of the two are ignored. - <function>Strtr</function> example + <function>strtr</function> example $addr = strtr($addr, "äåö", "aao"); @@ -3326,7 +3326,7 @@ print substr_count("This is a test", "is"); // prints out 2 - <function>Substr_replace</function> example + <function>substr_replace</function> example <?php $var = 'ABCDEFGH:/MNRPQR/'; @@ -3355,7 +3355,7 @@ echo substr_replace ($var, '', 10, -1) . "<br>\n"; - Substr_replace was added in PHP 4.0. + substr_replace was added in PHP 4.0. @@ -3412,7 +3412,7 @@ echo substr_replace ($var, '', 10, -1) . "<br>\n"; instance, in the default "C" locale characters such as umlaut-a (ä) will not be converted. - <function>Ucfirst</function> example + <function>ucfirst</function> example $text = 'mary had a little lamb and she loved it so.'; $text = ucfirst ($text); // $text is now Mary had a little lamb diff --git a/functions/swf.xml b/functions/swf.xml index 888b48a0f9..1531c233d1 100644 --- a/functions/swf.xml +++ b/functions/swf.xml @@ -1774,7 +1774,7 @@ function swf_savedata ($data) button in the current frame. - <function>Swf_addbuttonrecord</function> function example + <function>swf_addbuttonrecord</function> function example swf_startButton ($objid, TYPE_MENUBUTTON); diff --git a/functions/uodbc.xml b/functions/uodbc.xml index e3661aa36d..9a30623a0e 100644 --- a/functions/uodbc.xml +++ b/functions/uodbc.xml @@ -365,7 +365,7 @@ - Odbc_do will execute a query on the given + odbc_do will execute a query on the given connection. @@ -777,7 +777,7 @@ - Odbc_num_fields will return the number of + 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. @@ -961,7 +961,7 @@ longer than 4096 bytes, the contents is not false on error. - Odbc_result_all will print all rows from a + odbc_result_all will print all rows from a result identifier produced by odbc_exec. The result is printed in HTML table format. With the optional string argument format, additional overall table @@ -1434,7 +1434,7 @@ odbc_execute ($result); - Odbc_foreignkeys retrieves information about + odbc_foreignkeys retrieves information about foreign keys. Returns an ODBC result identifier or false on failure. diff --git a/functions/url.xml b/functions/url.xml index ea1b95ab15..12d0912bbf 100644 --- a/functions/url.xml +++ b/functions/url.xml @@ -16,7 +16,7 @@ - Base64_decode decodes + base64_decode decodes encoded_data and returns the original data. The returned data may be binary. @@ -41,7 +41,7 @@ - Base64_encode returns + base64_encode returns data encoded with base64. This encoding is designed to make binary data survive transport through transport layers that are not 8-bit clean, such as mail bodies. @@ -131,7 +131,7 @@ with character conversions (like some email systems). For example, if you want to include a password in an ftp url: - <function>Rawurlencode</function> example 1 + <function>rawurlencode</function> example 1 echo '<A HREF="ftp://user:', rawurlencode ('foo @+%/'), '@ftp.my.com/x.txt">'; @@ -139,7 +139,7 @@ echo '<A HREF="ftp://user:', rawurlencode ('foo @+%/'), Or, if you pass information in a path info component of the url: - <function>Rawurlencode</function> example 2 + <function>rawurlencode</function> example 2 echo '<A HREF="http://x.com/department_list_script/', rawurlencode ('sales and marketing/Miami'), '">'; @@ -171,7 +171,7 @@ echo '<A HREF="http://x.com/department_list_script/', Decodes any %## encoding in the given string. The decoded string is returned. - <function>Urldecode</function> example + <function>urldecode</function> example $a = split ('&', $QUERY_STRING); $i = 0; @@ -219,7 +219,7 @@ while ($i < count ($a)) { convenient when encoding a string to be used in a query part of an URL, as a convenient way to pass variables to the next page: - <function>Urlencode</function> example + <function>urlencode</function> example echo '<A HREF="mycgi?foo=', urlencode ($userinput), '">'; @@ -240,7 +240,7 @@ echo '<A HREF="mycgi?foo=', urlencode ($userinput), '">'; arg_separator for this. Leave it as &, but simply encode your URLs using htmlentities(urlencode($data)). - <function>Urlencode/htmlentities</function> example + <function>urlencode/htmlentities</function> example echo '<A HREF="mycgi?foo=', htmlentities (urlencode ($userinput) ), '">'; diff --git a/functions/var.xml b/functions/var.xml index f7247789c1..301233de8d 100644 --- a/functions/var.xml +++ b/functions/var.xml @@ -911,7 +911,7 @@ print_r ($a); - Serialize returns a string containing a + serialize returns a string containing a byte-stream representation of value that can be stored anywhere. @@ -921,7 +921,7 @@ print_r ($a); To make the serialized string into a PHP value again, use - unserialize. Serialize + unserialize. serialize handles the types integer, double, string, array (multidimensional) and object. @@ -938,7 +938,7 @@ print_r ($a); - <function>Serialize</function> example + <function>serialize</function> example // $session_data contains a multi-dimensional array with session // information for the current user. We use serialize() to store @@ -1082,7 +1082,7 @@ settype($bar, "string"); // $bar is now "1" (string) - <function>Unserialize</function> example + <function>unserialize</function> example // Here, we use unserialize() to load session data from a database // into $session_data. This example complements the one described @@ -1137,7 +1137,7 @@ if (!odbc_execute ($stmt, &$sqldata) || !odbc_fetch_into ($stmt, &$tmp)) - <function>Unset</function> example + <function>unset</function> example // destroy a single variable unset ($foo); @@ -1250,7 +1250,7 @@ foo(); - Unset is a language construct. + unset is a language construct. diff --git a/functions/yaz.xml b/functions/yaz.xml index 3202b697d5..7d41067387 100644 --- a/functions/yaz.xml +++ b/functions/yaz.xml @@ -185,7 +185,7 @@ if (empty($term) || count($host) == 0) { failure. - Yaz_connect prepares for a connection to a + yaz_connect prepares for a connection to a Z39.50 target. The zurl argument takes the form host[:port][/database]. If port is omitted 210 is used. If database is omitted Default is used. This function is @@ -264,7 +264,7 @@ if (empty($term) || count($host) == 0) { - Yaz_hits returns number of hits for last + yaz_hits returns number of hits for last search. diff --git a/functions/zlib.xml b/functions/zlib.xml index e19bd9cde4..57756cb57b 100644 --- a/functions/zlib.xml +++ b/functions/zlib.xml @@ -290,12 +290,12 @@ print "</pre>\n</h1></body>\n</html>\n"; more information about the strategy parameter.) - Gzopen can be used to read a file which is + gzopen can be used to read a file which is not in gzip format; in this case gzread will directly read from the file without decompression. - Gzopen returns a file pointer to the file + gzopen returns a file pointer to the file opened, after that, everything you read from this file descriptor will be transparently decompressed and what you write gets compressed. @@ -310,7 +310,7 @@ print "</pre>\n</h1></body>\n</html>\n"; - <function>Gzopen</function> Example + <function>gzopen</function> Example $fp = gzopen ("/tmp/file.gz", "r"); @@ -373,7 +373,7 @@ $fp = gzopen ("/tmp/file.gz", "r"); - Gzputs is an alias to + gzputs is an alias to gzwrite, and is identical in every way. @@ -536,7 +536,7 @@ gzclose ($zd); - Gzwrite writes the contents of + gzwrite writes the contents of string to the gz-file stream pointed to by zp. If the length argument is given, writing will stop after @@ -579,7 +579,7 @@ gzclose ($zd); output. - Readgzfile can be used to read a file which + readgzfile can be used to read a file which is not in gzip format; in this case readgzfile will directly read from the file without decompression. diff --git a/language/variables.xml b/language/variables.xml index e91def8e04..2e878cfd0a 100644 --- a/language/variables.xml +++ b/language/variables.xml @@ -920,7 +920,7 @@ echo "$a $hello"; the SetCookie function. Cookies are part of the HTTP header, so the SetCookie function must be called before any output is sent to the browser. This is the same restriction - as for the Header function. Any cookies + as for the header function. Any cookies sent to you from the client will automatically be turned into a PHP variable just like GET and POST method data.