cvs: /phpdoc/functions adabas.sgml apache.sgml array.sgml aspell.sgml bc.sgml calendar.sgml cpdf.sgml datetime.sgml dba.sgml dbase.sgml dbm.sgml
dir.sgml exec.sgml fdf.sgml filepro.sgml filesystem.sgml ftp.sgml http.sgml hw.sgml ibase.sgml icap.sgml ifx.sgml image.sgml imap.sgml info.sgml
ldap.sgml mail.sgml math.sgml mcal.sgml mcrypt.sgml mhash.sgml misc.sgml msql.sgml mssql.sgml mysql.sgml network.sgml nis.sgml oci8.sgml oracle.sgml
pcre.sgml pdf.sgml pgsql.sgml posix.sgml regex.sgml sem.sgml session.sgml snmp.sgml solid.sgml strings.sgml sybase.sgml uodbc.sgml url.sgml var.sgml
vmailmgr.sgml wddx.sgml xml.sgml zlib.sgml

cslawi Wed Oct 20 18:41:45 1999 EDT Modified files: /phpdoc/functions adabas.sgml apache.sgml array.sgml aspell.sgml bc.sgml calendar.sgml cpdf.sgml datetime.sgml dba.sgml dbase.sgml dbm.sgml dir.sgml exec.sgml fdf.sgml filepro.sgml filesystem.sgml ftp.sgml http.sgml hw.sgml ibase.sgml icap.sgml ifx.sgml image.sgml imap.sgml info.sgml ldap.sgml mail.sgml math.sgml mcal.sgml mcrypt.sgml mhash.sgml misc.sgml msql.sgml mssql.sgml mysql.sgml network.sgml nis.sgml oci8.sgml oracle.sgml pcre.sgml pdf.sgml pgsql.sgml posix.sgml regex.sgml sem.sgml session.sgml snmp.sgml solid.sgml strings.sgml sybase.sgml uodbc.sgml url.sgml var.sgml vmailmgr.sgml wddx.sgml xml.sgml zlib.sgml Log: Normalized according to the DocBook 3.1 DTD. This mostly just adds closing tags and attribute quotes, but lets a stock 3.1 install compile the PHP docs. It still compiles with DocBook 3.0, as well. Index: phpdoc/functions/adabas.sgml diff -u phpdoc/functions/adabas.sgml:1.2 phpdoc/functions/adabas.sgml:1.3 --- phpdoc/functions/adabas.sgml:1.2 Sat Jun 19 23:04:55 1999 +++ phpdoc/functions/adabas.sgml Wed Oct 20 18:41:42 1999 @@ -5,7 +5,7 @@ <partintro> <para> The Adabas D functions are deprecated, you probably want to use the - <link linkend="ref.odbc">Unified ODBC functions</link> instead. + <link linkend="ref.odbc">Unified ODBC functions</link> instead.</para> </partintro> <refentry id="function.ada-afetch"> @@ -15,7 +15,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_fetch_into</function> + <para>See <function>odbc_fetch_into</function></para> </refsect1> </refentry> @@ -27,7 +27,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_autocommit</function>. + <para>See <function>odbc_autocommit</function>.</para> </refsect1> </refentry> @@ -39,7 +39,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_close</function>. + <para>See <function>odbc_close</function>.</para> </refsect1> </refentry> @@ -51,7 +51,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_commit</function> + <para>See <function>odbc_commit</function></para> </refsect1> </refentry> @@ -63,7 +63,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_connect</function>. + <para>See <function>odbc_connect</function>.</para> </refsect1> </refentry> @@ -75,7 +75,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_exec</function> or <function>odbc_do</function>. + <para>See <function>odbc_exec</function> or <function>odbc_do</function>.</para> </refsect1> </refentry> @@ -87,7 +87,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_fetch_row</function>. + <para>See <function>odbc_fetch_row</function>.</para> </refsect1> </refentry> @@ -99,7 +99,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para> See <function>odbc_field_name</function>. + <para> See <function>odbc_field_name</function>.</para> </refsect1> </refentry> @@ -111,7 +111,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para> See <function>odbc_field_num</function>. + <para> See <function>odbc_field_num</function>.</para> </refsect1> </refentry> @@ -123,7 +123,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_field_type</function>. + <para>See <function>odbc_field_type</function>.</para> </refsect1> </refentry> @@ -135,7 +135,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_free_result</function>. + <para>See <function>odbc_free_result</function>.</para> </refsect1> </refentry> @@ -147,7 +147,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_num_fields</function>. + <para>See <function>odbc_num_fields</function>.</para> </refsect1> </refentry> @@ -159,7 +159,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_num_rows</function>. + <para>See <function>odbc_num_rows</function>.</para> </refsect1> </refentry> @@ -171,7 +171,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_result</function>. + <para>See <function>odbc_result</function>.</para> </refsect1> </refentry> @@ -183,7 +183,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_result_all</function>. + <para>See <function>odbc_result_all</function>.</para> </refsect1> </refentry> @@ -195,7 +195,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_rollback</function>. + <para>See <function>odbc_rollback</function>.</para> </refsect1> </refentry> @@ -218,5 +218,3 @@ sgml-local-ecat-files:nil End: --> - - Index: phpdoc/functions/apache.sgml diff -u phpdoc/functions/apache.sgml:1.6 phpdoc/functions/apache.sgml:1.7 --- phpdoc/functions/apache.sgml:1.6 Thu Sep 9 15:40:53 1999 +++ phpdoc/functions/apache.sgml Wed Oct 20 18:41:42 1999 @@ -70,7 +70,7 @@ <literal>note_name</literal>. If called with two arguments, it sets the value of note <literal>note_name</literal> to <literal>note_value</literal> and returns the previous value of - note <literal>note_name</literal>. + note <literal>note_name</literal>.</para> </refsect1> </refentry> @@ -111,7 +111,7 @@ <function>getallheaders</function> is currently only supported when PHP runs as an <productname>Apache</productname> module. </simpara> - </note> + </note></para> </refsect1> </refentry> @@ -136,7 +136,7 @@ generate a Content-type header. For PHP files, you need to use <function>include</function> or <function>require</function>; <function>virtual</function> cannot be used to include a - document which is itself a PHP file.. + document which is itself a PHP file..</para> </refsect1> </refentry> Index: phpdoc/functions/array.sgml diff -u phpdoc/functions/array.sgml:1.25 phpdoc/functions/array.sgml:1.26 --- phpdoc/functions/array.sgml:1.25 Fri Oct 1 15:04:08 1999 +++ phpdoc/functions/array.sgml Wed Oct 20 18:41:42 1999 @@ -24,7 +24,7 @@ <function>array</function> is a language construct used to represent literal arrays, and not a regular function. </para> - </note> + </note></para> <para> The following example demonstrates how to create a @@ -40,11 +40,11 @@ "numbers" => array(1, 2, 3, 4, 5, 6), "holes" => array("first", 5 => "second", "third") ); -</programlisting></example> +</programlisting></example></para> <para> See also: - <function>list</function>. + <function>list</function>.</para> </refsect1> </refentry> @@ -63,7 +63,7 @@ <para> <function>array_count_values</function> returns an array using the values of the <parameter>input</parameter> array as keys and their frequency in - <parameter>input</parameter> as values. + <parameter>input</parameter> as values.</para> <para> <example> @@ -76,8 +76,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -98,12 +98,12 @@ <para> <function>array_keys</function> returns the keys, numeric and - string, from the <parameter>input</parameter> array. + string, from the <parameter>input</parameter> array.</para> <para> If the optional <parameter>search_value</parameter> is specified, then only the keys for that value are returned. Otherwise, all - the keys from the <parameter>input</parameter> are returned. + the keys from the <parameter>input</parameter> are returned.</para> <para> <example> @@ -115,15 +115,15 @@ $array = array(1, 100, 2, 100); array_keys($array, 100); // returns array(0, 2) </programlisting> - </example> + </example></para> <para> See also <function>array_values</function>. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -146,13 +146,13 @@ <para> <function>array_merge</function> 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. + the end of the previous one. It returns the resulting array.</para> <para> If the input arrays had the same string keys, then the later value for that key will overwrite previous one. If, however, the arrays have the same numeric key, this does not happen since the - values are appended. + values are appended.</para> <para> <example> @@ -164,13 +164,13 @@ </programlisting> <para> Resulting array will be array("color" => "green", 2, 4, "a", - "b", "shape" => "trapezoid"). + "b", "shape" => "trapezoid").</para> </example> <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -189,7 +189,7 @@ <para> <function>array_pop</function> pops and returns the last value of the <parameter>array</parameter>, shortening the - <parameter>array</parameter> by one element. + <parameter>array</parameter> by one element.</para> <para> <example> @@ -200,8 +200,8 @@ </programlisting> <para> After this, $stack has only 2 elements: "orange" and "apple", - and $fruit has "raspberry". - </example> + and $fruit has "raspberry".</para> + </example></para> <para> See also <function>array_push</function>, @@ -210,8 +210,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -240,10 +240,10 @@ <programlisting> $array[] = $var; </programlisting> - repeated for each <parameter>var</parameter>. + repeated for each <parameter>var</parameter>.</para> <para> - Returns the new number of elements in the array. + Returns the new number of elements in the array.</para> <para> <example> @@ -254,7 +254,7 @@ </programlisting> </example> This example would result in $stack having 4 elements: 1, 2, "+", - and 3. + and 3.</para> <para> See also: @@ -264,8 +264,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -282,7 +282,7 @@ </funcsynopsis> <para> - <function>array_reverse</function> takes input <parameter>array</parameter> and returns a new array with the order of the elements reversed. + <function>array_reverse</function> takes input <parameter>array</parameter> and returns a new array with the order of the elements reversed.</para> <para> <example> @@ -296,8 +296,8 @@ <note> <para> - This function was added in PHP 4.0 Beta 3. - </note> + This function was added in PHP 4.0 Beta 3.</para> + </note></para> </refsect1> </refentry> @@ -317,7 +317,7 @@ <function>array_shift</function> shifts the first value of the <parameter>array</parameter> off and returns it, shortening the <parameter>array</parameter> by one element and moving everything - down. + down.</para> <para> <example> @@ -328,7 +328,7 @@ </programlisting> </example> This would result in $args having one element "-f" left, and $opt - being "-v". + being "-v".</para> <para> See also <function>array_unshift</function>, @@ -337,8 +337,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -364,13 +364,13 @@ <function>array_slice</function> returns a sequence of elements from the <parameter>array</parameter> specified by the <parameter>offset</parameter> and <parameter>length</parameter> - parameters. + parameters.</para> <para> If <parameter>offset</parameter> is positive, the sequence will start at that offset in the <parameter>array</parameter>. If <parameter>offset</parameter> is negative, the sequence will - start that far from the end of the <parameter>array</parameter>. + start that far from the end of the <parameter>array</parameter>.</para> <para> If <parameter>length</parameter> is given and is positive, then @@ -379,7 +379,7 @@ sequence will stop that many elements from the end of the array. If it is omitted, then the sequence will have everything from <parameter>offset</parameter> up until the end of the - <parameter>array</parameter>. + <parameter>array</parameter>.</para> <para> <example> @@ -392,15 +392,15 @@ $output = array_slice($input, -2, 1); // returns "d" $output = array_slice($input, 0, 3); // returns "a", "b", and "c" </programlisting> - </example> + </example></para> <para> See also <function>array_splice</function>. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -431,14 +431,14 @@ <parameter>length</parameter> from the <parameter>input</parameter> array, and replaces them with the elements of the <parameter>replacement</parameter> array, if - supplied. + supplied.</para> <para> If <parameter>offset</parameter> is positive then the start of removed portion is at that offset from the beginning of the <parameter>input</parameter> array. If <parameter>offset</parameter> is negative then it starts that far - from the end of the <parameter>input</parameter> array. + from the end of the <parameter>input</parameter> array.</para> <para> If <parameter>length</parameter> is omitted, removes everything @@ -451,7 +451,7 @@ <parameter>offset</parameter> to the end of the array when <parameter>replacement</parameter> is also specified, use <literal>count($input)</literal> for - <parameter>length</parameter>. + <parameter>length</parameter>.</para> <para> If <parameter>replacement</parameter> array is specified, then @@ -462,7 +462,7 @@ array are inserted in the place specified by the <parameter>offset</parameter>. Tip: if the replacement is just one element it is not necessary to put <literal>array()</literal> - around it, unless the element is an array itself. + around it, unless the element is an array itself.</para> <para> The following equivalences hold: @@ -472,10 +472,10 @@ array_shift($input) array_splice($input, 0, 1) array_unshift($input, $x, $y) array_splice($input, 0, 0, array($x, $y)) $a[$x] = $y array_splice($input, $x, 1, $y) - </programlisting> + </programlisting></para> <para> - Returns the array consisting of removed elements. + Returns the array consisting of removed elements.</para> <para> <example> @@ -491,15 +491,15 @@ // $input is now array("red", "green", // "blue", "black", "maroon") </programlisting> - </example> + </example></para> <para> See also <function>array_slice</function>. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -524,11 +524,11 @@ <function>array_unshift</function> prepends passed elements to the front of the <parameter>array</parameter>. Note that the list of elements is prepended as a whole, so that the prepended - elements stay in the same order. + elements stay in the same order.</para> <para> Returns the new number of elements in the - <parameter>array</parameter>. + <parameter>array</parameter>.</para> <para> <example> @@ -539,7 +539,7 @@ </programlisting> </example> This would result in $queue having 5 elements: "p4", "p5", "p6", - "p1", and "p3". + "p1", and "p3".</para> <para> See also <function>array_shift</function>, @@ -548,8 +548,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -567,7 +567,7 @@ <para> <function>array_values</function> returns all the values from the - <parameter>input</parameter> array. + <parameter>input</parameter> array.</para> <para> <example> @@ -580,8 +580,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -616,7 +616,7 @@ <function>array_walk</function> calls <parameter>func</parameter>. These warnings may be suppressed by prepending the '@' sign to the <function>array_walk</function> - call, or by using <function>error_reporting</function>. + call, or by using <function>error_reporting</function>.</simpara> <note> <para> @@ -630,7 +630,7 @@ <note> <para> - Passing the key and userdata to <parameter>func</parameter> was added in 4.0. + Passing the key and userdata to <parameter>func</parameter> was added in 4.0.</para> </note> <para> @@ -651,10 +651,10 @@ array_walk( $fruits, 'test_alter', 'fruit' ); array_walk( $fruits, 'test_print' ); </programlisting> - </example> + </example></para> <simpara> - See also <function>each</function> and <function>list</function>. + See also <function>each</function> and <function>list</function>.</simpara> </refsect1> </refentry> @@ -694,10 +694,10 @@ fruits[c] = apple </computeroutput> The fruits have been sorted in reverse alphabetical order, and - the index associated with each element has been maintained. + the index associated with each element has been maintained.</para> <para> See also: <function>asort</function>, <function>rsort</function>, - <function>ksort</function>, and <function>sort</function>. + <function>ksort</function>, and <function>sort</function>.</para> </refsect1> </refentry> @@ -734,10 +734,10 @@ fruits[a] = orange </computeroutput> The fruits have been sorted in alphabetical order, and the index - associated with each element has been maintained. + associated with each element has been maintained.</para> <para> See also <function>arsort</function>, <function>rsort</function>, - <function>ksort</function>, and <function>sort</function>. + <function>ksort</function>, and <function>sort</function>.</para> </refsect1> </refentry> @@ -762,7 +762,7 @@ 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; - <function>compact</function> handles it recursively. + <function>compact</function> handles it recursively.</para> <para> For each of these, <function>compact</function> looks for a @@ -770,7 +770,7 @@ to the output array such that the variable name becomes the key and the contents of the variable become the value for that key. In short, it does the opposite of <function>extract</function>. - It returns the output array with all the variables added to it. + It returns the output array with all the variables added to it.</para> <para> <example> @@ -787,16 +787,16 @@ <para> After this, $result will be array("event" => "SIGGRAPH", "city" - => "San Francisco", "state" => "CA"). - </example> + => "San Francisco", "state" => "CA").</para> + </example></para> <para> See also <function>extract</function>. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -814,9 +814,9 @@ <para> Returns the number of elements in <parameter>var</parameter>, which is typically an array (since anything else will have one - element). + element).</para> <para> - Returns 1 if the variable is not an array. + Returns 1 if the variable is not an array.</para> <para> Returns 0 if the variable is not set. <warning> @@ -826,11 +826,11 @@ initialized with an empty array. Use <function>isset</function> to test if a variable is set. </para> - </warning> + </warning></para> <para> See also: <function>sizeof</function>, <function>isset</function>, and - <function>is_array</function>. + <function>is_array</function>.</para> </refsect1> </refentry> @@ -848,7 +848,7 @@ <para> Every array has an internal pointer to its "current" element, which is initialized to the first element inserted into the - array. + array.</para> <para> The <function>current</function> function simply returns the @@ -864,13 +864,13 @@ at the end of the list in such an array using <function>current</function>. To properly traverse an array that may contain empty elements, use the <function>each</function> - function. - </warning> + function.</para> + </warning></para> <para> See also: <function>end</function>, <function>next</function>, - <function>prev</function> and <function>reset</function>. + <function>prev</function> and <function>reset</function>.</para> </refsect1> </refentry> @@ -897,11 +897,11 @@ <emphasis>value</emphasis>. Elements <emphasis>0</emphasis> and <emphasis>key</emphasis> contain the key name of the array element, and <emphasis>1</emphasis> and - <emphasis>value</emphasis> contain the data. + <emphasis>value</emphasis> contain the data.</para> <para> If the internal pointer for the array points past the end of the - array contents, <function>each</function> returns false. + array contents, <function>each</function> returns false.</para> <para> <example> @@ -916,29 +916,29 @@ pairs: <itemizedlist spacing="compact"> - <listitem><simpara>0 => 0 - <listitem><simpara>1 => 'bob' - <listitem><simpara>key => 0 - <listitem><simpara>value => 'bob' + <listitem><simpara>0 => 0</simpara></listitem> + <listitem><simpara>1 => 'bob'</simpara></listitem> + <listitem><simpara>key => 0</simpara></listitem> + <listitem><simpara>value => 'bob'</simpara></listitem> </itemizedlist> <programlisting> $foo = array( "Robert" => "Bob", "Seppo" => "Sepi" ); $bar = each( $foo ); - </programlisting> + </programlisting></para> <para> <literal>$bar</literal> now contains the following key/value pairs: <itemizedlist spacing="compact"> - <listitem><simpara>0 => 'Robert' - <listitem><simpara>1 => 'Bob' - <listitem><simpara>key => 'Robert' - <listitem><simpara>value => 'Bob' - </itemizedlist> + <listitem><simpara>0 => 'Robert'</simpara></listitem> + <listitem><simpara>1 => 'Bob'</simpara></listitem> + <listitem><simpara>key => 'Robert'</simpara></listitem> + <listitem><simpara>value => 'Bob'</simpara></listitem> + </itemizedlist></para> - </example> + </example></para> <para> <function>each</function> is typically used in conjunction with @@ -955,17 +955,17 @@ echo "$key => $val&lt;br&gt;"; } </programlisting> - </example> + </example></para> <para> After <function>each</function> has executed, the array cursor will be left on the next element of the array, or on the last - element if it hits the end of the array. + element if it hits the end of the array.</para> <para> See also <function>key</function>, <function>list</function>, <function>current</function>, <function>reset</function>, - <function>next</function>, and <function>prev</function>. + <function>next</function>, and <function>prev</function>.</para> </refsect1> </refentry> @@ -986,14 +986,14 @@ </funcsynopsis> <para> <function>end</function> advances <parameter>array</parameter>'s - internal pointer to the last element. + internal pointer to the last element.</para> <para> See also: <function>current</function>, <function>each</function>, <function>end</function>, <function>next</function>, and - <function>reset</function>. + <function>reset</function>.</para> </refsect1> </refentry> @@ -1023,7 +1023,7 @@ names and values as variable values. For each key/value pair it will create a variable in the current symbol table, subject to <parameter>extract_type</parameter> and - <parameter>prefix</parameter> parameters. + <parameter>prefix</parameter> parameters.</para> <para> <function>extract</function> checks for colissions with existing variables. The way collisions are treated is determined by @@ -1062,22 +1062,22 @@ </simpara> </listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If <parameter>extract_type</parameter> is not specified, it is - assumed to be EXTR_OVERWRITE. + assumed to be EXTR_OVERWRITE.</para> <para> Note that <parameter>prefix</parameter> is only required if <parameter>extract_type</parameter> is EXTR_PREFIX_SAME or - EXTR_PREFIX_ALL. + EXTR_PREFIX_ALL.</para> <para> <function>extract</function> checks each key to see if it constitues a valid variable name, and if it does only then does - it proceed to import it. + it proceed to import it.</para> <para> A possible use for extract is to import into symbol table variables contained in an associative array returned by - <function>wddx_deserialize</function>. + <function>wddx_deserialize</function>.</para> <para> <example> <title>extract example</title> @@ -1096,13 +1096,13 @@ ?> </programlisting> - </example> + </example></para> <para> The above example will produce: <programlisting> blue, large, sphere, medium - </programlisting> + </programlisting></para> <para> The $size wasn't overwritten, becaus we specified @@ -1110,7 +1110,7 @@ If EXTR_SKIP was specified, then $wddx_size wouldn't even have been created. EXTR_OVERWRITE would have cause $size to have value "medium", and EXTR_PREFIX_ALL would result in new - variables being named $wddx_color, $wddx_size, and $wddx_shape. + variables being named $wddx_color, $wddx_size, and $wddx_shape.</para> </refsect1> </refentry> @@ -1130,7 +1130,7 @@ <para> Searches <parameter>haystack</parameter> for <parameter>needle</parameter> and returns true if it is found in - the array, false otherwise. + the array, false otherwise.</para> <para> <example> @@ -1144,8 +1144,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -1162,11 +1162,11 @@ </funcsynopsis> <para> <function>key</function> returns the index element of the - current array position. + current array position.</para> <para> See also: <function>current</function>, - <function>next</function> + <function>next</function></para> </refsect1> </refentry> @@ -1201,11 +1201,11 @@ fruits[c] = apple fruits[b] = banana fruits[a] = orange -</computeroutput> +</computeroutput></para> <simpara> See also <function>asort</function>, <function>arsort</function>, <function>ksort</function> - <function>sort</function>, and <function>rsort</function>. + <function>sort</function>, and <function>rsort</function>.</simpara> </refsect1> </refentry> @@ -1243,11 +1243,11 @@ fruits[b] = banana fruits[c] = apple fruits[d] = lemon -</computeroutput> +</computeroutput></para> <simpara> See also <function>asort</function>, <function>arsort</function>, - <function>sort</function>, and <function>rsort</function>. + <function>sort</function>, and <function>rsort</function>.</simpara> </refsect1> </refentry> @@ -1290,10 +1290,10 @@ } ?>&lt;/table> -</programlisting></example> +</programlisting></example></para> <para> - See also: <function>each</function>, <function>array</function>. + See also: <function>each</function>, <function>array</function>.</para> </refsect1> </refentry> @@ -1312,7 +1312,7 @@ </funcsynopsis> <para> Returns the array element in the next place that's pointed by the - internal array pointer, or false if there are no more elements. + internal array pointer, or false if there are no more elements.</para> <para> <function>next</function> behaves like <function>current</function>, with one difference. It advances @@ -1328,12 +1328,12 @@ an array which may contain empty elements see the <function>each</function> function. </para> - </warning> + </warning></para> <para> See also: <function>current</function>, <function>end</function> - <function>prev</function> and <function>reset</function> + <function>prev</function> and <function>reset</function></para> </refsect1> </refentry> @@ -1349,11 +1349,11 @@ <paramdef>array <parameter>array</parameter></paramdef> </funcsynopsis> <simpara> - This is an alias for <function>current</function>. + This is an alias for <function>current</function>.</simpara> <para> See also: <function>end</function>, <function>next</function>, - <function>prev</function> and <function>reset</function>. + <function>prev</function> and <function>reset</function>.</para> </refsect1> </refentry> @@ -1380,17 +1380,17 @@ an array which may contain empty elements see the <function>each</function> function. </para> - </warning> + </warning></para> <para> <function>prev</function> behaves just like <function>next</function>, except it rewinds the internal array - pointer one place instead of advancing it. + pointer one place instead of advancing it.</para> <para> See also: <function>current</function>, <function>end</function> - <function>next</function> and <function>reset</function> + <function>next</function> and <function>reset</function></para> </refsect1> </refentry> @@ -1411,9 +1411,9 @@ <para> <function>range</function> returns an array of integers from <parameter>low</parameter> to <parameter>high</parameter>, - inclusive. + inclusive.</para> <para> - See <function>shuffle</function> for an example of its use. + See <function>shuffle</function> for an example of its use.</para> </refsect1> </refentry> @@ -1432,17 +1432,17 @@ </funcsynopsis> <para> <function>reset</function> rewinds <parameter>array</parameter>'s - internal pointer to the first element. + internal pointer to the first element.</para> <para> <function>reset</function> returns the value of the first array - element. + element.</para> <para> See also: <function>current</function>, <function>each</function>, <function>next</function>, <function>prev</function>, and - <function>reset</function>. + <function>reset</function>.</para> </refsect1> </refentry> @@ -1479,7 +1479,7 @@ fruits[3] = apple </computeroutput> - The fruits have been sorted in reverse alphabetical order. + The fruits have been sorted in reverse alphabetical order.</para> <para> See also: @@ -1487,7 +1487,7 @@ <function>asort</function>, <function>ksort</function>, <function>sort</function>, and - <function>usort</function>. + <function>usort</function>.</para> </refsect1> </refentry> @@ -1514,11 +1514,11 @@ while (list(,$number) = each($numbers)) { echo "$number "; } -</programlisting></example> +</programlisting></example></para> <para> See also <function>arsort</function>, <function>asort</function>, <function>ksort</function>, <function>rsort</function>, - <function>sort</function> and <function>usort</function>. + <function>sort</function> and <function>usort</function>.</para> </refsect1> </refentry> @@ -1534,10 +1534,10 @@ <paramdef>array <parameter>array</parameter></paramdef> </funcsynopsis> <para> - Returns the number of elements in the array. + Returns the number of elements in the array.</para> <para> See also: - <function>count</function> + <function>count</function></para> </refsect1> </refentry> @@ -1571,14 +1571,14 @@ fruits[2] = lemon fruits[3] = orange </computeroutput> - The fruits have been sorted in alphabetical order. + The fruits have been sorted in alphabetical order.</para> <para> See also: <function>arsort</function>, <function>asort</function>, <function>ksort</function>, <function>rsort</function>, and - <function>usort</function>. + <function>usort</function>.</para> </refsect1> </refentry> @@ -1602,7 +1602,7 @@ 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. + is user-defined.</para> </refsect1> </refentry> @@ -1647,7 +1647,7 @@ 10: ten 4: four 3: three - </computeroutput> + </computeroutput></para> <para> See also: @@ -1656,7 +1656,7 @@ <function>uasort</function>, <function>ksort</function>, <function>rsort</function>, and - <function>sort</function>. + <function>sort</function>.</para> </refsect1> </refentry> @@ -1679,7 +1679,7 @@ This function will sort an array by its values using a user-supplied comparison function. If the array you wish to sort needs to be sorted by some non-trivial criteria, you should use - this function. + this function.</para> <para> The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to @@ -1721,13 +1721,13 @@ Solaris systems) may cause PHP to crash if the comparison function does not return consistent values. </para> - </warning> + </warning></para> <para> See also: <function>arsort</function>, <function>asort</function>, <function>ksort</function>, <function>rsort</function> and - <function>sort</function>. + <function>sort</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/aspell.sgml diff -u phpdoc/functions/aspell.sgml:1.2 phpdoc/functions/aspell.sgml:1.3 --- phpdoc/functions/aspell.sgml:1.2 Sat Jun 19 23:04:55 1999 +++ phpdoc/functions/aspell.sgml Wed Oct 20 18:41:42 1999 @@ -4,11 +4,10 @@ <partintro> <simpara> The <function>aspell</function> functions allows you to check the - spelling on a word and offer suggestions. + spelling on a word and offer suggestions.</simpara> <simpara> - You need the aspell library, available from: <ulink - url="http://metalab.unc.edu/kevina/aspell/">http://metalab.unc.edu/kevina/aspell/</ulink> + You need the aspell library, available from: <ulink url="http://metalab.unc.edu/kevina/aspell/">http://metalab.unc.edu/kevina/aspell/</ulink></simpara> </partintro> @@ -27,14 +26,14 @@ <simpara> <function>aspell_new</function> opens up a new dictionary and returns the dictionary link identifier for use in other aspell - functions. + functions.</simpara> <para> <example> <title>aspell_new</title> <programlisting> $aspell_link=aspell_new("english"); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -53,7 +52,7 @@ </funcsynopsis> <simpara> <function>aspell_check</function> checks the spelling of a word - and returns true if the spelling is correct, false if not. + and returns true if the spelling is correct, false if not.</simpara> <para> <example> <title>aspell_check</title> @@ -65,7 +64,7 @@ echo "Sorry, wrong spelling"; } </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -86,7 +85,7 @@ <simpara> <function>aspell_check_raw</function> 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. + and returns true if the spelling is correct, false if not.</simpara> <para> <example> <title>aspell_check_raw</title> @@ -98,7 +97,7 @@ echo "Sorry, wrong spelling"; } </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -117,7 +116,7 @@ </funcsynopsis> <simpara> <function>aspell_suggest</function> returns an array of possible - spellings for the given word. + spellings for the given word.</simpara> <para> <example> <title>aspell_suggest</title> @@ -132,7 +131,7 @@ } } </programlisting> - </example> + </example></para> </refsect1> </refentry> Index: phpdoc/functions/bc.sgml diff -u phpdoc/functions/bc.sgml:1.2 phpdoc/functions/bc.sgml:1.3 --- phpdoc/functions/bc.sgml:1.2 Sat Jun 19 23:04:55 1999 +++ phpdoc/functions/bc.sgml Wed Oct 20 18:41:42 1999 @@ -5,7 +5,7 @@ <partintro> <simpara> These functions are only available if PHP was configured with - <option role="configure">--enable-bcmath</option>. + <option role="configure">--enable-bcmath</option>.</simpara> </partintro> <refentry id="function.bcadd"> @@ -27,9 +27,9 @@ <parameter>right operand</parameter> and returns the sum in a string. The optional <parameter>scale</parameter> parameter is used to set the number of digits after the decimal - place in the result. + place in the result.</para> <para> - See also <function>bcsub</function>. + See also <function>bcsub</function>.</para> </refsect1> </refentry> @@ -56,7 +56,7 @@ two operands are equal. If the <parameter>left operand</parameter> is larger than the <parameter>right operand</parameter> the return value is +1 and if the <parameter>left operand</parameter> is less than - the <parameter>right operand</parameter> the return value is -1. + the <parameter>right operand</parameter> the return value is -1.</para> </refsect1> </refentry> @@ -78,10 +78,10 @@ Divides the <parameter>left operand</parameter> by the <parameter>right operand</parameter> and returns the result. The optional <parameter>scale</parameter> sets the number of digits after the decimal - place in the result. + place in the result.</para> <para> - See also <function>bcmul</function>. + See also <function>bcmul</function>.</para> </refsect1> </refentry> @@ -100,9 +100,9 @@ </funcsynopsis> <para> Get the modulus of the <parameter>left operand</parameter> using - <parameter>modulus</parameter>. + <parameter>modulus</parameter>.</para> <para> - See also <function>bcdiv</function>. + See also <function>bcdiv</function>.</para> </refsect1> </refentry> @@ -123,10 +123,10 @@ Multiply the <parameter>left operand</parameter> by the <parameter>right operand</parameter> and returns the result. The optional <parameter>scale</parameter> sets the number of digits after the decimal - place in the result. + place in the result.</para> <para> - See also <function>bcdiv</function>. + See also <function>bcdiv</function>.</para> </refsect1> </refentry> @@ -146,9 +146,9 @@ <para> Raise <parameter>x</parameter> to the power <parameter>y</parameter>. The <parameter>scale</parameter> can be used to set the number of digits - after the decimal place in the result. + after the decimal place in the result.</para> <para> - See also <function>bcsqrt</function>. + See also <function>bcsqrt</function>.</para> </refsect1> </refentry> @@ -165,7 +165,7 @@ </funcsynopsis> <para> This function sets the default scale parameter for all subsequent bc math functions - that do not explicitly specify a scale parameter. + that do not explicitly specify a scale parameter.</para> </refsect1> </refentry> @@ -184,9 +184,9 @@ <para> Return the square root of the <parameter>operand</parameter>. The optional <parameter>scale</parameter> parameter sets the number of - digits after the decimal place in the result. + digits after the decimal place in the result.</para> <para> - See also <function>bcpow</function>. + See also <function>bcpow</function>.</para> </refsect1> </refentry> @@ -209,9 +209,9 @@ <parameter>left operand</parameter> and returns the result in a string. The optional <parameter>scale</parameter> parameter is used to set the number of digits after the decimal - place in the result. + place in the result.</para> <para> - See also <function>bcadd</function>. + See also <function>bcadd</function>.</para> </refsect1> </refentry> </reference> Index: phpdoc/functions/calendar.sgml diff -u phpdoc/functions/calendar.sgml:1.3 phpdoc/functions/calendar.sgml:1.4 --- phpdoc/functions/calendar.sgml:1.3 Sun Jun 20 13:15:59 1999 +++ phpdoc/functions/calendar.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.calendar"> <title>Calendar functions</title> <titleabbrev>Calendar</titleabbrev> @@ -18,10 +17,9 @@ 4000bc). To convert between calendar systems, you must first convert to Julian Day Count, then to the calendar system of your choice. Julian Day Count is very different from the Julian - Calendar! For more information on calendar systems visit <ulink - url="http://genealogy.org/~scottlee/cal-overview.html">http://genealogy.org/~scottlee/cal-overview.html</ulink>. + Calendar! For more information on calendar systems visit <ulink url="http://genealogy.org/~scottlee/cal-overview.html">http://genealogy.org/~scottlee/cal-overview.html</ulink>. Excerpts from this page are included in these instructions, and - are in quotes. + are in quotes.</para> </partintro> <refentry id="function.jdtogregorian"> @@ -37,7 +35,7 @@ </funcsynopsis> <para> Converts Julian Day Count to a string containing the - Gregorian date in the format of "month/day/year" + Gregorian date in the format of "month/day/year"</para> </refsect1> </refentry> @@ -56,7 +54,7 @@ <paramdef>int <parameter>year</parameter></paramdef> </funcsynopsis> <para> - Valid Range for Gregorian Calendar 4714 B.C. to 9999 A.D. + Valid Range for Gregorian Calendar 4714 B.C. to 9999 A.D.</para> <para> Although this software can handle dates all the way back to 4714 B.C., such use may not be meaningful. The Gregorian @@ -69,7 +67,7 @@ <example> <title>Calendar functions</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $jd = GregorianToJD(10,11,1970); echo("$jd\n"); @@ -77,7 +75,7 @@ echo("$gregorian\n"); ?> </programlisting> -</example> +</example></para> </refsect1> </refentry> @@ -96,7 +94,7 @@ </funcsynopsis> <para> Converts Julian Day Count to a string containing the Julian - Calendar Date in the format of "month/day/year". + Calendar Date in the format of "month/day/year".</para> </refsect1> </refentry> @@ -115,7 +113,7 @@ <paramdef>int <parameter>year</parameter></paramdef> </funcsynopsis> <para> - Valid Range for Julian Calendar 4713 B.C. to 9999 A.D. + Valid Range for Julian Calendar 4713 B.C. to 9999 A.D.</para> <para> Although this software can handle dates all the way back to 4713 B.C., such use may not be meaningful. The calendar was @@ -123,7 +121,7 @@ at least 8 A.D., and perhaps as late at the 4th century. Also, the beginning of a year varied from one culture to another - not all accepted January as the first - month. + month.</para> </refsect1> </refentry> @@ -140,7 +138,7 @@ <paramdef>int <parameter>julianday</parameter></paramdef> </funcsynopsis> <para> - Converts a Julian Day Count the the Jewish Calendar. + Converts a Julian Day Count the the Jewish Calendar.</para> </refsect1> </refentry> @@ -161,12 +159,12 @@ <para> Valid Range Although this software can handle dates all the way back to the year 1 (3761 B.C.), such use may not be - meaningful. + meaningful.</para> <para> The Jewish calendar has been in use for several thousand years, but in the early days there was no formula to determine the start of a month. A new month was started when - the new moon was first observed. + the new moon was first observed.</para> </refsect1> </refentry> @@ -186,7 +184,7 @@ </funcsynopsis> <para> Converts a Julian Day Count to the French Republican - Calendar. + Calendar.</para> </refsect1> </refentry> @@ -206,12 +204,12 @@ </funcsynopsis> <para> Converts a date from the French Republican Calendar to a - Julian Day Count + Julian Day Count</para> <para> These routines only convert dates in years 1 through 14 (Gregorian dates 22 September 1792 through 22 September 1806). This more than covers the period when the calendar was - in use. + in use.</para> </refsect1> </refentry> @@ -270,7 +268,7 @@ </row> </tbody> </tgroup> - </table> + </table></para> </refsect1> </refentry> @@ -315,7 +313,7 @@ </row> </tbody> </tgroup> - </table> + </table></para> </refsect1> </refentry> Index: phpdoc/functions/cpdf.sgml diff -u phpdoc/functions/cpdf.sgml:1.9 phpdoc/functions/cpdf.sgml:1.10 --- phpdoc/functions/cpdf.sgml:1.9 Thu Jul 1 16:23:46 1999 +++ phpdoc/functions/cpdf.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.cpdf"> <title>ClibPDF functions</title> <titleabbrev>ClibPDF</titleabbrev> @@ -16,13 +15,13 @@ This may have changed with the new version 2.0 of pdflib. A simple benchmark (the pdfclock.c example from pdflib 2.0 turned into a php script) actually show no difference in speed at all. The file size - is also similar if compression is turned off. + is also similar if compression is turned off.</simpara> <simpara> This documentation should be read with the ClibPDF manual since it explains much of the library in much more detail. Once you understand the manual of ClibPDF you should be able to start using the library - with PHP. + with PHP.</simpara> <simpara> Many functions in the native ClibPDF and the PHP module, as @@ -35,21 +34,21 @@ cannot oversee what the consequences in a multi threaded environment are. According to the author of ClibPDF this will change in one of the next releases (current version when this was written is 1.10). - If you need this functionality use the pdflib module. + If you need this functionality use the pdflib module.</simpara> <simpara> One big advantage of ClibPDF over pdflib is the possibility to create the pdf document completely in memory without using temporary files. It also provides the ability to pass coordinates in a predefined unit length. This is a handy feature but can be simulated with - <function>pdf_translate</function>. + <function>pdf_translate</function>.</simpara> <simpara> Most of the functions are fairly easy to use. The most difficult part is probably creating a very simple PDF document at all. The following example should help you get started. It creates a document with one page. The page contains the text "Times-Roman" in an - outlined 30pt font. The text is underlined. + outlined 30pt font. The text is underlined.</simpara> <example> <title>Simple ClibPDF Example</title> @@ -75,7 +74,7 @@ <simpara> The pdflib distribution contains a more complex example which creates a series of pages with an analog clock. Here is that example converted - into PHP using the ClibPDF extension: + into PHP using the ClibPDF extension:</simpara> <example> <title>pdfclock example from pdflib 2.0 distribution</title> @@ -184,12 +183,12 @@ </funcsynopsis> <para> The <function>cpdf_set_creator</function> function sets the - creator of a pdf document. + creator of a pdf document.</para> <para> See also <function>cpdf_set_subject</function>, <function>cpdf_set_title</function>, - <function>cpdf_set_keywords</function>. + <function>cpdf_set_keywords</function>.</para> </refsect1> </refentry> @@ -207,12 +206,12 @@ </funcsynopsis> <para> The <function>cpdf_set_title</function> function sets the - title of a pdf document. + title of a pdf document.</para> <para> See also <function>cpdf_set_subject</function>, <function>cpdf_set_creator</function>, - <function>cpdf_set_keywords</function>. + <function>cpdf_set_keywords</function>.</para> </refsect1> </refentry> @@ -230,12 +229,12 @@ </funcsynopsis> <para> The <function>cpdf_set_subject</function> function sets the - subject of a pdf document. + subject of a pdf document.</para> <para> See also <function>cpdf_set_title</function>, <function>cpdf_set_creator</function>, - <function>cpdf_set_keywords</function>. + <function>cpdf_set_keywords</function>.</para> </refsect1> </refentry> @@ -253,12 +252,12 @@ </funcsynopsis> <para> The <function>cpdf_set_keywords</function> function sets the - keywords of a pdf document. + keywords of a pdf document.</para> <para> See also <function>cpdf_set_title</function>, <function>cpdf_set_creator</function>, - <function>cpdf_set_subject</function>. + <function>cpdf_set_subject</function>.</para> </refsect1> </refentry> @@ -294,11 +293,11 @@ way ClibPDF outputs to stdout does not work with apache. You can solve this problem by skipping the filename and using <function>cpdf_output_buffer</function> to output the pdf document. - </simpara></note> + </simpara></note></para> <para> See also <function>cpdf_close</function>, - <function>cpdf_output_buffer</function>. + <function>cpdf_output_buffer</function>.</para> </refsect1> </refentry> @@ -318,10 +317,10 @@ The <function>cpdf_close</function> function closes the pdf document. This should be the last function even after <function>cpdf_finalize</function>, <function>cpdf_output_buffer</function> - and <function>cpdf_save_to_file</function>. + and <function>cpdf_save_to_file</function>.</para> <para> - See also <function>cpdf_open</function>. + See also <function>cpdf_open</function>.</para> </refsect1> </refentry> @@ -352,10 +351,10 @@ <parameter>unit</parameter> sets the unit for the koordinate system. The value should be the number of postscript points per unit. Since one inch is equal to 72 points, a value of 72 would set the unit - to one inch. The default is also 72. + to one inch. The default is also 72.</para> <para> - See also <function>cpdf_set_current_page</function>. + See also <function>cpdf_set_current_page</function>.</para> </refsect1> </refentry> @@ -376,10 +375,10 @@ The <function>cpdf_finalize_page</function> function ends the page with page number <parameter>page number</parameter>. This function is only for saving memory. A finalized page takes - less memory but cannot be modified anymore. + less memory but cannot be modified anymore.</para> <para> - See also <function>cpdf_page_init</function>. + See also <function>cpdf_page_init</function>.</para> </refsect1> </refentry> @@ -397,10 +396,10 @@ </funcsynopsis> <para> The <function>cpdf_finalize</function> function ends the document. - You still have to call <function>cpdf_close</function>. + You still have to call <function>cpdf_close</function>.</para> <para> - See also <function>cpdf_close</function>. + See also <function>cpdf_close</function>.</para> </refsect1> </refentry> @@ -420,10 +419,10 @@ The <function>cpdf_output_buffer</function> function outputs the pdf document to stdout. The document has to be created in memory which is the case if <function>cpdf_open</function> has been called with - no filename parameter. + no filename parameter.</para> <para> - See also <function>cpdf_open</function>. + See also <function>cpdf_open</function>.</para> </refsect1> </refentry> @@ -444,11 +443,11 @@ The <function>cpdf_save_to_file</function> function outputs the pdf document into a file if it has been created in memory. This function is not needed if the pdf document has been open - by specifying a filename as a parameter of <function>cpdf_open</function>. + by specifying a filename as a parameter of <function>cpdf_open</function>.</para> <para> See also <function>cpdf_output_buffer</function>, - <function>cpdf_open</function>. + <function>cpdf_open</function>.</para> </refsect1> </refentry> @@ -468,10 +467,10 @@ <para> The <function>cpdf_set_current_page</function> function set the page on which all operations are performed. One can switch between pages - until a page is finished with <function>cpdf_finalize_page</function>. + until a page is finished with <function>cpdf_finalize_page</function>.</para> <para> - See also <function>cpdf_finalize_page</function>. + See also <function>cpdf_finalize_page</function>.</para> </refsect1> </refentry> @@ -498,10 +497,10 @@ cpdf_set_font($pdf, 16, "Helvetica", 4); cpdf_text($pdf, 100, 100, "Some text"); cpdf_end_text($pdf) ?> -</programlisting></example> +</programlisting></example></para> <para> - See also <function>cpdf_end_text</function>. + See also <function>cpdf_end_text</function>.</para> </refsect1> </refentry> @@ -528,10 +527,10 @@ cpdf_set_font($pdf, 16, "Helvetica", 4); cpdf_text($pdf, 100, 100, "Some text"); cpdf_end_text($pdf) ?> -</programlisting></example> +</programlisting></example></para> <para> - See also <function>cpdf_begin_text</function>. + See also <function>cpdf_begin_text</function>.</para> </refsect1> </refentry> @@ -550,12 +549,12 @@ </funcsynopsis> <para> The <function>cpdf_show</function> function outputs the - string in <parameter>text</parameter> at the current position. + string in <parameter>text</parameter> at the current position.</para> <para> See also <function>cpdf_text</function>, <function>cpdf_begin_text</function>, - <function>cpdf_end_text</function>. + <function>cpdf_end_text</function>.</para> </refsect1> </refentry> @@ -585,10 +584,10 @@ <note> <simpara>The function <function>cpdf_show_xy</function> is identical - to <function>cpdf_text</function> without the optional parameters.</simpara></note> + to <function>cpdf_text</function> without the optional parameters.</simpara></note></para> <para> - See also <function>cpdf_text</function>. + See also <function>cpdf_text</function>.</para> </refsect1> </refentry> @@ -621,10 +620,10 @@ The optional parameter <parameter>orientation</parameter> is the rotation of the text in degree. The optional parameter <parameter>alignmode</parameter> determines how the text is align. - See the ClibPDF documentation for possible values. + See the ClibPDF documentation for possible values.</para> <para> - See also <function>cpdf_show_xy</function>. + See also <function>cpdf_show_xy</function>.</para> </refsect1> </refentry> @@ -650,7 +649,7 @@ The last parameter <parameter>encoding</parameter> can take the following values: 2 = macroman, 3 = macexpert, 4 = winansi. - Any other value selects the font's buildin encoding. + Any other value selects the font's buildin encoding.</para> </refsect1> </refentry> @@ -670,10 +669,10 @@ <para> The <function>cpdf_set_leading</function> function sets the distance between text lines. This will be used if text is output by - <function>cpdf_continue_text</function>. + <function>cpdf_continue_text</function>.</para> <para> - See also <function>cpdf_continue_text</function>. + See also <function>cpdf_continue_text</function>.</para> </refsect1> </refentry> @@ -696,7 +695,7 @@ are 0=fill text, 1=stroke text, 2=fill and stroke text, 3=invisible, 4=fill text and add it to cliping path, 5=stroke text and add it to clipping path, 6=fill and stroke text and add - it to cliping path, 7=add it to clipping path. + it to cliping path, 7=add it to clipping path.</para> </refsect1> </refentry> @@ -714,7 +713,7 @@ </funcsynopsis> <para> The <function>cpdf_set_horiz_scaling</function> function sets the - horizontal scaling to <parameter>scale</parameter> percent. + horizontal scaling to <parameter>scale</parameter> percent.</para> </refsect1> </refentry> @@ -732,7 +731,7 @@ </funcsynopsis> <para> The <function>cpdf_set_text_rise</function> function sets the - text rising to <parameter>value</parameter> units. + text rising to <parameter>value</parameter> units.</para> </refsect1> </refentry> @@ -751,7 +750,7 @@ <para> The <function>cpdf_set_text_matrix</function> function sets a matrix which describes a transformation applied on the current - text font. + text font.</para> </refsect1> </refentry> @@ -772,17 +771,17 @@ <para> The <function>cpdf_set_text_pos</function> function sets the position of text for the next <function>cpdf_show</function> - function call. + function call.</para> <para> The last optional parameter <parameter>mode</parameter> determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> See also <function>cpdf_show</function>, - <function>cpdf_text</function>. + <function>cpdf_text</function>.</para> </refsect1> </refentry> @@ -800,10 +799,10 @@ </funcsynopsis> <para> The <function>cpdf_set_char_spacing</function> function sets the - spacing between characters. + spacing between characters.</para> <para> See also <function>cpdf_set_word_spacing</function>, - <function>cpdf_set_leading</function>. + <function>cpdf_set_leading</function>.</para> </refsect1> </refentry> @@ -822,11 +821,11 @@ </funcsynopsis> <para> The <function>cpdf_set_word_spacing</function> function sets the - spacing between words. + spacing between words.</para> <para> See also <function>cpdf_set_char_spacing</function>, - <function>cpdf_set_leading</function>. + <function>cpdf_set_leading</function>.</para> </refsect1> </refentry> @@ -845,13 +844,13 @@ </funcsynopsis> <para> The <function>cpdf_continue_text</function> function outputs the - string in <parameter>text</parameter> in the next line. + string in <parameter>text</parameter> in the next line.</para> <para> See also <function>cpdf_show_xy</function>, <function>cpdf_text</function>, <function>cpdf_set_leading</function>, - <function>cpdf_set_text_pos</function>. + <function>cpdf_set_text_pos</function>.</para> </refsect1> </refentry> @@ -871,10 +870,10 @@ <para> The <function>cpdf_stringwidth</function> function returns the width of the string in <parameter>text</parameter>. It requires - a font to be set before. + a font to be set before.</para> <para> - See also <function>cpdf_set_font</function>. + See also <function>cpdf_set_font</function>.</para> </refsect1> </refentry> @@ -894,10 +893,10 @@ The <function>cpdf_save</function> function saves the current enviroment. It works like the postscript command gsave. Very useful if you want to translate or rotate an object without effecting - other objects. + other objects.</para> <para> - See also <function>cpdf_restore</function>. + See also <function>cpdf_restore</function>.</para> </refsect1> </refentry> @@ -926,10 +925,10 @@ &lt;?php cpdf_save($pdf); // do all kinds of rotations, transformations, ... cpdf_restore($pdf) ?> -</programlisting></example> +</programlisting></example></para> <para> - See also <function>cpdf_save</function>. + See also <function>cpdf_save</function>.</para> </refsect1> </refentry> @@ -951,12 +950,12 @@ <para> The <function>cpdf_translate</function> function set the origin of coordinate system to the point (<parameter>x-koor</parameter>, - <parameter>y-koor</parameter>). + <parameter>y-koor</parameter>).</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> </refsect1> </refentry> @@ -976,7 +975,7 @@ </funcsynopsis> <para> The <function>cpdf_scale</function> function set the scaling factor - in both directions. + in both directions.</para> </refsect1> </refentry> @@ -995,7 +994,7 @@ </funcsynopsis> <para> The <function>cpdf_rotate</function> function set the rotation in - degress to <parameter>angle</parameter>. + degress to <parameter>angle</parameter>.</para> </refsect1> </refentry> @@ -1014,7 +1013,7 @@ </funcsynopsis> <para> The <function>cpdf_setflat</function> function set the flatness to - a value between 0 and 100. + a value between 0 and 100.</para> </refsect1> </refentry> @@ -1033,7 +1032,7 @@ </funcsynopsis> <para> The <function>cpdf_setlinejoin</function> function set the linejoin - parameter between a value of 0 and 2. 0 = miter, 1 = round, 2 = bevel. + parameter between a value of 0 and 2. 0 = miter, 1 = round, 2 = bevel.</para> </refsect1> </refentry> @@ -1053,7 +1052,7 @@ <para> The <function>cpdf_setlinecap</function> function set the linecap parameter between a value of 0 and 2. 0 = butt end, 1 = round, - 2 = projecting square. + 2 = projecting square.</para> </refsect1> </refentry> @@ -1072,7 +1071,7 @@ </funcsynopsis> <para> The <function>cpdf_setmiterlimit</function> function set the miter limit - to a value greater or equal than 1. + to a value greater or equal than 1.</para> </refsect1> </refentry> @@ -1091,7 +1090,7 @@ </funcsynopsis> <para> The <function>cpdf_setlinewidth</function> function set the line width - to <parameter>width</parameter>. + to <parameter>width</parameter>.</para> </refsect1> </refentry> @@ -1112,7 +1111,7 @@ <para> The <function>cpdf_setdash</function> function set the dash pattern <parameter>white</parameter> white units and <parameter>black</parameter> - black units. If both are 0 a solid line is set. + black units. If both are 0 a solid line is set.</para> </refsect1> </refentry> @@ -1134,12 +1133,12 @@ <para> The <function>cpdf_moveto</function> function set the current point to the coordinates <parameter>x-koor</parameter> and - <parameter>y-koor</parameter>. + <parameter>y-koor</parameter>.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> </refsect1> </refentry> @@ -1161,15 +1160,15 @@ <para> The <function>cpdf_rmoveto</function> function set the current point relative to the coordinates <parameter>x-koor</parameter> and - <parameter>y-koor</parameter>. + <parameter>y-koor</parameter>.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> - See also <function>cpdf_moveto</function>. + See also <function>cpdf_moveto</function>.</para> </refsect1> </refentry> @@ -1197,18 +1196,18 @@ (<parameter>x3</parameter>, <parameter>y3</parameter>) using (<parameter>x1</parameter>, <parameter>y1</parameter>) and (<parameter>x2</parameter>, <parameter>y2</parameter>) as control - points. + points.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> See also <function>cpdf_moveto</function>, <function>cpdf_rmoveto</function>, <function>cpdf_rlineto</function>, - <function>cpdf_lineto</function>. + <function>cpdf_lineto</function>.</para> </refsect1> </refentry> @@ -1230,17 +1229,17 @@ <para> The <function>cpdf_lineto</function> function draws a line from the current point to the point with coordinates - (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). + (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>).</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> See also <function>cpdf_moveto</function>, <function>cpdf_rmoveto</function>, - <function>cpdf_curveto</function>. + <function>cpdf_curveto</function>.</para> </refsect1> </refentry> @@ -1262,17 +1261,17 @@ <para> The <function>cpdf_rlineto</function> function draws a line from the current point to the relative point with coordinates - (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). + (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>).</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> See also <function>cpdf_moveto</function>, <function>cpdf_rmoveto</function>, - <function>cpdf_curveto</function>. + <function>cpdf_curveto</function>.</para> </refsect1> </refentry> @@ -1296,15 +1295,15 @@ The <function>cpdf_circle</function> function draws a circle with center at point (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>) - and radius <parameter>radius</parameter>. + and radius <parameter>radius</parameter>.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> - See also <function>cpdf_arc</function>. + See also <function>cpdf_arc</function>.</para> </refsect1> </refentry> @@ -1332,15 +1331,15 @@ (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>) and radius <parameter>radius</parameter>, starting at angle <parameter>start</parameter> and ending at angle - <parameter>end</parameter>. + <parameter>end</parameter>.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> - See also <function>cpdf_circle</function>. + See also <function>cpdf_circle</function>.</para> </refsect1> </refentry> @@ -1366,12 +1365,12 @@ its lower left corner at point (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). This width is set to <parameter>widgth</parameter>. - This height is set to <parameter>height</parameter>. + This height is set to <parameter>height</parameter>.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> </refsect1> </refentry> @@ -1389,7 +1388,7 @@ </funcsynopsis> <para> The <function>cpdf_closepath</function> function closes the - current path. + current path.</para> </refsect1> </refentry> @@ -1407,11 +1406,11 @@ </funcsynopsis> <para> The <function>cpdf_stroke</function> function draws a line along - current path. + current path.</para> <para> See also <function>cpdf_closepath</function>, - <function>cpdf_closepath_stroke</function>. + <function>cpdf_closepath_stroke</function>.</para> </refsect1> </refentry> @@ -1430,11 +1429,11 @@ <para> The <function>cpdf_closepath_stroke</function> function is a combination of <function>cpdf_closepath</function> and - <function>cpdf_stroke</function>. Than clears the path. + <function>cpdf_stroke</function>. Than clears the path.</para> <para> See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>. + <function>cpdf_stroke</function>.</para> </refsect1> </refentry> @@ -1452,7 +1451,7 @@ </funcsynopsis> <para> The <function>cpdf_fill</function> function fills the interior of - the current path with the current fill color. + the current path with the current fill color.</para> <para> See also <function>cpdf_closepath</function>, @@ -1460,7 +1459,7 @@ <function>cpdf_setgray_fill</function>, <function>cpdf_setgray</function>, <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1478,7 +1477,7 @@ </funcsynopsis> <para> The <function>cpdf_fill_stroke</function> function fills the interior of - the current path with the current fill color and draws current path. + the current path with the current fill color and draws current path.</para> <para> See also <function>cpdf_closepath</function>, @@ -1487,7 +1486,7 @@ <function>cpdf_setgray_fill</function>, <function>cpdf_setgray</function>, <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1506,7 +1505,7 @@ <para> The <function>cpdf_closepath_fill_stroke</function> function closes, fills the interior of - the current path with the current fill color and draws current path. + the current path with the current fill color and draws current path.</para> <para> See also <function>cpdf_closepath</function>, @@ -1515,7 +1514,7 @@ <function>cpdf_setgray_fill</function>, <function>cpdf_setgray</function>, <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1533,7 +1532,7 @@ </funcsynopsis> <para> The <function>cpdf_clip</function> function clips all drawing - to the current path. + to the current path.</para> </refsect1> </refentry> @@ -1552,10 +1551,10 @@ </funcsynopsis> <para> The <function>cpdf_setgray_fill</function> function sets the current - gray value to fill a path. + gray value to fill a path.</para> <para> - See also <function>cpdf_setrgbcolor_fill</function>. + See also <function>cpdf_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1574,10 +1573,10 @@ </funcsynopsis> <para> The <function>cpdf_setgray_stroke</function> function sets the current - drawing color to the given gray value. + drawing color to the given gray value.</para> <para> - See also <function>cpdf_setrgbcolor_stroke</function>. + See also <function>cpdf_setrgbcolor_stroke</function>.</para> </refsect1> </refentry> @@ -1596,11 +1595,11 @@ </funcsynopsis> <para> The <function>cpdf_setgray_stroke</function> function sets the current - drawing and filling color to the given gray value. + drawing and filling color to the given gray value.</para> <para> See also <function>cpdf_setrgbcolor_stroke</function>, - <function>cpdf_setrgbcolor_fill</function>. + <function>cpdf_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1621,11 +1620,11 @@ </funcsynopsis> <para> The <function>cpdf_setrgbcolor_fill</function> function sets the current - rgb color value to fill a path. + rgb color value to fill a path.</para> <para> See also <function>cpdf_setrgbcolor_stroke</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1646,11 +1645,11 @@ </funcsynopsis> <para> The <function>cpdf_setrgbcolor_stroke</function> function sets the current - drawing color to the given rgb color value. + drawing color to the given rgb color value.</para> <para> See also <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1671,11 +1670,11 @@ </funcsynopsis> <para> The <function>cpdf_setrgbcolor_stroke</function> function sets the current - drawing and filling color to the given rgb color value. + drawing and filling color to the given rgb color value.</para> <para> See also <function>cpdf_setrgbcolor_stroke</function>, - <function>cpdf_setrgbcolor_fill</function>. + <function>cpdf_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1712,8 +1711,8 @@ cpdf_close($cpdf); ?> </programlisting> - <para> - </example> + <para></para> + </example></para> </refsect1> </refentry> @@ -1732,7 +1731,7 @@ </funcsynopsis> <para> The <function>cpdf_set_page_animation</function> function set the - transition between following pages. + transition between following pages.</para> <para> The value of <parameter>transition</parameter> @@ -1762,11 +1761,11 @@ <member> 7 for the old page is simply replaced by the new page (default) </member> - </simplelist> + </simplelist></para> <para> The value of <parameter>duration</parameter> is the number of seconds - between page flipping. + between page flipping.</para> </refsect1> </refentry> @@ -1795,14 +1794,14 @@ in the file with the name <parameter>file name</parameter>. The format of the image has to be jpeg. The image is placed on the current page at position (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). - The image is rotated by <parameter>angle</parameter> degres. + The image is rotated by <parameter>angle</parameter> degres.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> - See also <function>cpdf_place_inline_image</function>, + See also <function>cpdf_place_inline_image</function>,</para> </refsect1> </refentry> @@ -1829,14 +1828,14 @@ created with the php image functions on the page at postion (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). The image can be scaled at the same - time. + time.</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> <para> - See also <function>cpdf_import_jpeg</function>, + See also <function>cpdf_import_jpeg</function>,</para> </refsect1> </refentry> @@ -1862,12 +1861,12 @@ The <function>cpdf_add_annotation</function> adds a note with the lower left corner at (<parameter>llx</parameter>, <parameter>lly</parameter>) and the upper right corner at - (<parameter>urx</parameter>, <parameter>ury</parameter>). + (<parameter>urx</parameter>, <parameter>ury</parameter>).</para> <para> The last optional parameter determines the unit length. If is 0 or omitted the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + are measured in postscript points disregarding the current unit.</para> </refsect1> </refentry> Index: phpdoc/functions/datetime.sgml diff -u phpdoc/functions/datetime.sgml:1.12 phpdoc/functions/datetime.sgml:1.13 --- phpdoc/functions/datetime.sgml:1.12 Sun Sep 5 23:22:00 1999 +++ phpdoc/functions/datetime.sgml Wed Oct 20 18:41:42 1999 @@ -55,7 +55,7 @@ <para> Returns a string formatted according to the given format string using the given <parameter>timestamp</parameter> or the current - local time if no timestamp is given. + local time if no timestamp is given.</para> <para> The following characters are recognized in the format string: @@ -95,7 +95,7 @@ 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))); </programlisting> - </example> + </example></para> <para> It is possible to use <function>date</function> and <function>mktime</function> together to find dates in the future @@ -320,7 +320,7 @@ a regular UNIX mktime() call and which does not lend itself well to leaving out parameters from right to left (see below). It is a common error to mix these values up - in a script. + in a script.</para> <para> Returns the Unix timestamp corresponding to the arguments given. This timestamp is a long integer containing the number of @@ -377,7 +377,7 @@ using the given <parameter>timestamp</parameter> or the current local time if no timestamp is given. Month and weekday names and other language dependent strings respect the current locale - set with <function>setlocale</function>. + set with <function>setlocale</function>.</para> <para> The following conversion specifiers are recognized in the format string: @@ -420,7 +420,7 @@ </programlisting> </example> This example works if you have the respective locales installed - in your system. + in your system.</para> <para> See also <function>setlocale</function> and Index: phpdoc/functions/dba.sgml diff -u phpdoc/functions/dba.sgml:1.6 phpdoc/functions/dba.sgml:1.7 --- phpdoc/functions/dba.sgml:1.6 Tue Jun 22 17:49:39 1999 +++ phpdoc/functions/dba.sgml Wed Oct 20 18:41:42 1999 @@ -1,24 +1,24 @@ - <reference id="ref.dba"> + <reference> <title>Database (dbm-style) abstraction layer functions</title> <titleabbrev>dba</titleabbrev> <partintro> <para> These functions build the foundation for accessing Berkeley DB style - databases. + databases.</para> <para> This is a general abstraction layer for several file-based databases. As such, functionality is limited to a subset of features modern databases - such as <ulink url="&url.sleepycat;">Sleepycat Software's DB2</ulink> + such as <ulink url="">Sleepycat Software's DB2</ulink> support. (This is not to be confused with IBM's DB2 software, which is - supported through the <link linkend="ref.odbc">ODBC functions</link>.) + supported through the <link linkend="ref.odbc">ODBC functions</link>.)</para> <para> The behaviour of various aspects depend on the implementation of the underlying database. Functions such as <function>dba_optimize</function> and <function>dba_sync</function> will do what they promise for one - database and will do nothing for others. + database and will do nothing for others.</para> <para> The following handlers are supported: @@ -28,28 +28,28 @@ dbm is the oldest (original) type of Berkeley DB style databases. You should avoid it, if possible. We do not support the compatibility functions built into DB2 and gdbm, because they are only compatible on - the source code level, but cannot handle the original dbm format. + the source code level, but cannot handle the original dbm format.</simpara></listitem> <listitem><simpara> ndbm is a newer type and more flexible than dbm. It still has most of the - arbitrary limits of dbm (therefore it is deprecated). + arbitrary limits of dbm (therefore it is deprecated).</simpara></listitem> <listitem><simpara> - gdbm is the <ulink url="&url.gdbm;">GNU database manager</ulink>. + gdbm is the <ulink url="">GNU database manager</ulink>.</simpara></listitem> <listitem><simpara> - db2 is <ulink url="&url.sleepycat;">Sleepycat Software's DB2</ulink>. It + db2 is <ulink url="">Sleepycat Software's DB2</ulink>. It is described as "a programmatic toolkit that provides high-performance built-in database support for both standalone and client/server - applications." + applications."</simpara></listitem> <listitem><simpara> cdb is "a fast, reliable, lightweight package for creating and reading constant databases." It is from the author of qmail and can be found - <ulink url="&url.cdb;">here</ulink>. Since it is constant, we support - only reading operations. + <ulink url="">here</ulink>. Since it is constant, we support + only reading operations.</simpara></listitem> - </itemizedlist> + </itemizedlist></para> <para> <example> @@ -73,22 +73,22 @@ dba_close($id); ?&gt; -</programlisting></example> +</programlisting></example></para> <para> DBA is binary safe and does not have any arbitrary limits. It inherits all - limits set by the underlying database implementation. + limits set by the underlying database implementation.</para> <para> All file-based databases must provide a way of setting the file mode of a new created database, if that is possible at all. The file mode is commonly passed as the fourth argument to <function>dba_open</function> or - <function>dba_popen</function>. + <function>dba_popen</function>.</para> <para> You can access all entries of a database in a linear way by using the <function>dba_firstkey</function> and <function>dba_nextkey</function> - functions. You may not change the database while traversing it. + functions. You may not change the database while traversing it.</para> <para> <example> @@ -111,11 +111,13 @@ dba_delete($handle_later[$i], $id); ?&gt; -</programlisting></example> + </programlisting> + </example> + </para> </partintro> - <refentry id="function.dba-close"> + <refentry> <refnamediv> <refname>dba_close</refname> <refpurpose>Close database</refpurpose> @@ -129,24 +131,25 @@ <para> <function>dba_close</function> closes the established database and frees - all resources specified by <parameter>handle</parameter>. + all resources specified by <parameter>handle</parameter>.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> - <function>dba_close</function> does not return any value. + <function>dba_close</function> does not return any value.</para> <para> See also: <function>dba_open</function> <function>dba_popen</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-delete"> + <refentry> <refnamediv> <refname>dba_delete</refname> <refpurpose>Delete entry specified by key</refpurpose> @@ -162,18 +165,18 @@ <para> <function>dba_delete</function> deletes the entry specified by <parameter>key</parameter> from the database specified with - <parameter>handle</parameter>. + <parameter>handle</parameter>.</para> <para> - <parameter>key</parameter> is the key of the entry which is deleted. + <parameter>key</parameter> is the key of the entry which is deleted.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_delete</function> returns true or false, if the entry is - deleted or not deleted, respectively. + deleted or not deleted, respectively.</para> <para> See also: @@ -181,11 +184,12 @@ <function>dba_fetch</function> <function>dba_insert</function> <function>dba_replace</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-exists"> + <refentry> <refnamediv> <refname>dba_exists</refname> <refpurpose>Check whether key exists</refpurpose> @@ -201,18 +205,18 @@ <para> <function>dba_exists</function> checks whether the specified <parameter>key</parameter> exists in the database specified by - <parameter>handle</parameter>. + <parameter>handle</parameter>.</para> <para> - <parameter>key</parameter> is the key the check is performed for. + <parameter>key</parameter> is the key the check is performed for.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_exists</function> returns true or false, if the key is found - or not found, respectively. + or not found, respectively.</para> <para> See also: @@ -220,11 +224,12 @@ <function>dba_delete</function> <function>dba_insert</function> <function>dba_replace</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-fetch"> + <refentry> <refnamediv> <refname>dba_fetch</refname> <refpurpose>Fetch data specified by key</refpurpose> @@ -240,18 +245,18 @@ <para> <function>dba_fetch</function> fetches the data specified by <parameter>key</parameter> from the database specified with - <parameter>handle</parameter>. + <parameter>handle</parameter>.</para> <para> - <parameter>key</parameter> is the key the data is specified by. + <parameter>key</parameter> is the key the data is specified by.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_fetch</function> returns the associated string or false, if - the key/data pair is found or not found, respectively. + the key/data pair is found or not found, respectively.</para> <para> See also: @@ -259,11 +264,12 @@ <function>dba_delete</function> <function>dba_insert</function> <function>dba_replace</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-firstkey"> + <refentry> <refnamediv> <refname>dba_firstkey</refname> <refpurpose>Fetch first key</refpurpose> @@ -278,24 +284,25 @@ <para> <function>dba_firstkey</function> returns the first key of the database specified by <parameter>handle</parameter> and resets the internal key - pointer. This permits a linear search through the whole database. + pointer. This permits a linear search through the whole database.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_firstkey</function> returns the key or false depending on - whether it succeeds or fails, respectively. + whether it succeeds or fails, respectively.</para> <para> See also: <function>dba_nextkey</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-insert"> + <refentry> <refnamediv> <refname>dba_insert</refname> <refpurpose>Insert entry</refpurpose> @@ -313,21 +320,21 @@ <function>dba_insert</function> inserts the entry described with <parameter>key</parameter> and <parameter>value</parameter> into the database specified by <parameter>handle</parameter>. It fails, if an entry - with the same <parameter>key</parameter> already exists. + with the same <parameter>key</parameter> already exists.</para> <para> - <parameter>key</parameter> is the key of the entry to be inserted. + <parameter>key</parameter> is the key of the entry to be inserted.</para> <para> - <parameter>value</parameter> is the value to be inserted. + <parameter>value</parameter> is the value to be inserted.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_insert</function> returns true or false, depending on - whether it succeeds of fails, respectively. + whether it succeeds of fails, respectively.</para> <para> See also: @@ -335,11 +342,12 @@ <function>dba_delete</function> <function>dba_fetch</function> <function>dba_replace</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-nextkey"> + <refentry> <refnamediv> <refname>dba_nextkey</refname> <refpurpose>Fetch next key</refpurpose> @@ -354,24 +362,25 @@ <para> <function>dba_nextkey</function> returns the next key of the database specified by <parameter>handle</parameter> and increments the internal - key pointer. + key pointer.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_nextkey</function> returns the key or false depending on - whether it succeeds or fails, respectively. + whether it succeeds or fails, respectively.</para> <para> See also: <function>dba_firstkey</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-popen"> + <refentry> <refnamediv> <refname>dba_popen</refname> <refpurpose>Open database persistently</refpurpose> @@ -389,36 +398,37 @@ <para> <function>dba_popen</function> establishes a persistent database instance for <parameter>path</parameter> with <parameter>mode</parameter> using - <parameter>handler</parameter>. + <parameter>handler</parameter>.</para> <para> - <parameter>path</parameter> is commonly a regular path in your filesystem. + <parameter>path</parameter> is commonly a regular path in your filesystem.</para> <para> <parameter>mode</parameter> is "r" for read access, "w" for read/write access to an already existing database, "c" for read/write access and database creation if it doesn't currently exist, and "n" for - create, truncate and read/write access. + create, truncate and read/write access.</para> <para> <parameter>handler</parameter> is the name of the handler which shall be used for accessing <parameter>path</parameter>. It is passed all optional parameters given to <function>dba_popen</function> and can act on behalf - of them. + of them.</para> <para> <function>dba_popen</function> returns a positive handler id or false, in - the case the open is successful or fails, respectively. + the case the open is successful or fails, respectively.</para> <para> See also: <function>dba_open</function> <function>dba_close</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-open"> + <refentry> <refnamediv> <refname>dba_open</refname> <refpurpose>Open database</refpurpose> @@ -436,36 +446,37 @@ <para> <function>dba_open</function> establishes a database instance for <parameter>path</parameter> with <parameter>mode</parameter> using - <parameter>handler</parameter>. + <parameter>handler</parameter>.</para> <para> - <parameter>path</parameter> is commonly a regular path in your filesystem. + <parameter>path</parameter> is commonly a regular path in your filesystem.</para> <para> <parameter>mode</parameter> is "r" for read access, "w" for read/write access to an already existing database, "c" for read/write access and database creation if it doesn't currently exist, and "n" for - create, truncate and read/write access. + create, truncate and read/write access.</para> <para> <parameter>handler</parameter> is the name of the handler which shall be used for accessing <parameter>path</parameter>. It is passed all optional parameters given to <function>dba_open</function> and can act on behalf of - them. + them.</para> <para> <function>dba_open</function> returns a positive handler id or false, in - the case the open is successful or fails, respectively. + the case the open is successful or fails, respectively.</para> <para> See also: <function>dba_popen</function> <function>dba_close</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-optimize"> + <refentry> <refnamediv> <refname>dba_optimize</refname> <refpurpose>Optimize database</refpurpose> @@ -479,24 +490,25 @@ <para> <function>dba_optimize</function> optimizes the underlying database - specified by <parameter>handle</parameter>. + specified by <parameter>handle</parameter>.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_optimize</function> returns true or false, if the - optimization succeeds or fails, respectively. + optimization succeeds or fails, respectively.</para> <para> See also: <function>dba_sync</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-replace"> + <refentry> <refnamediv> <refname>dba_replace</refname> <refpurpose>Replace or insert entry</refpurpose> @@ -513,21 +525,21 @@ <para> <function>dba_replace</function> replaces or inserts the entry described with <parameter>key</parameter> and <parameter>value</parameter> into the - database specified by <parameter>handle</parameter>. + database specified by <parameter>handle</parameter>.</para> <para> - <parameter>key</parameter> is the key of the entry to be inserted. + <parameter>key</parameter> is the key of the entry to be inserted.</para> <para> - <parameter>value</parameter> is the value to be inserted. + <parameter>value</parameter> is the value to be inserted.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_replace</function> returns true or false, depending on - whether it succeeds of fails, respectively. + whether it succeeds of fails, respectively.</para> <para> See also: @@ -535,11 +547,12 @@ <function>dba_delete</function> <function>dba_fetch</function> <function>dba_insert</function> + </para> </refsect1> </refentry> - <refentry id="function.dba-sync"> + <refentry> <refnamediv> <refname>dba_sync</refname> <refpurpose>Synchronize database</refpurpose> @@ -554,20 +567,38 @@ <para> <function>dba_sync</function> synchronizes the database specified by <parameter>handle</parameter>. This will probably trigger a physical write - to disk, if supported. + to disk, if supported.</para> <para> <parameter>handle</parameter> is a database handle returned by - <function>dba_open</function>. + <function>dba_open</function>.</para> <para> <function>dba_sync</function> returns true or false, if the - synchronization succeeds or fails, respectively. + synchronization succeeds or fails, respectively.</para> <para> See also: <function>dba_optimize</function> + </para> </refsect1> </refentry> </reference> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> Index: phpdoc/functions/dbase.sgml diff -u phpdoc/functions/dbase.sgml:1.4 phpdoc/functions/dbase.sgml:1.5 --- phpdoc/functions/dbase.sgml:1.4 Sat Jul 31 20:50:37 1999 +++ phpdoc/functions/dbase.sgml Wed Oct 20 18:41:42 1999 @@ -5,11 +5,11 @@ <partintro> <simpara> These functions allow you to access records stored in dBase-format - (dbf) databases. + (dbf) databases.</simpara> <simpara> There is no support for indexes or memo fields. There is no support for locking, too. Two concurrent webserver processes modifying the - same dBase file will very likely ruin your database. + same dBase file will very likely ruin your database.</simpara> <simpara> Unlike SQL databases, dBase "databases" cannot change the database definition afterwards. Once the file is created, the database @@ -17,7 +17,7 @@ otherwise organize your data. dBase files are simple sequential files of fixed length records. Records are appended to the end of the file and delete records are kept until you call - <function>dbase_pack()</function>. + <function>dbase_pack()</function>.</simpara> <simpara> We recommend that you do not use dBase files as your production database. Choose any real SQL server instead; MySQL or Postgres @@ -25,7 +25,7 @@ to import and export data to and from your web database, since the file format is commonly understood with Windows spreadsheets and organizers. Import and export of data is about all that - dBase support is good for. + dBase support is good for.</simpara> </partintro> <refentry id="function.dbase-create"> @@ -44,46 +44,46 @@ The <parameter>fields</parameter> parameter is an array of arrays, each array describing the format of one field in the database. Each field consists of a name, a character - indicating the field type, a length, and a precision. + indicating the field type, a length, and a precision.</para> <para> The types of fields available are: <variablelist> <varlistentry> <term>L</term> <listitem><simpara> - Boolean. These do not have a length or precision. + Boolean. These do not have a length or precision.</simpara></listitem> </varlistentry> <varlistentry> <term>M</term> <listitem><simpara> Memo. (Note that these aren't supported by PHP.) - These do not have a length or precision. + These do not have a length or precision.</simpara></listitem> </varlistentry> <varlistentry> <term>D</term> <listitem><simpara> Date (stored as YYYYMMDD). These do not have a length - or precision. + or precision.</simpara></listitem> </varlistentry> <varlistentry> <term>N</term> <listitem><simpara> Number. These have both a length and a precision (the - number of digits after the decimal point). + number of digits after the decimal point).</simpara></listitem> </varlistentry> <varlistentry> <term>C</term> <listitem><simpara> - String. + String.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If the database is successfully created, a dbase_identifier is returned, otherwise false is returned. <example> <title>Creating a dBase database file</title> -<programlisting role=php> +<programlisting role="php"> // "database" name $dbname = "/tmp/test.dbf"; @@ -102,7 +102,7 @@ print "&lt;strong>Error!&lt;/strong>"; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -121,10 +121,10 @@ <para> The flags correspond to those for the open() system call. (Typically 0 means read-only, 1 means write-only, and 2 - means read and write.) + means read and write.)</para> <para> Returns a dbase_identifier for the opened database, or - false if the database couldn't be opened. + false if the database couldn't be opened.</para> </refsect1> </refentry> @@ -140,7 +140,7 @@ <paramdef>int <parameter>dbase_identifier</parameter></paramdef> </funcsynopsis> <para> - Closes the database associated with <parameter>dbase_identifier</parameter>. + Closes the database associated with <parameter>dbase_identifier</parameter>.</para> </refsect1> </refentry> @@ -157,7 +157,7 @@ </funcsynopsis> <para> Packs the specified database (permanently deleting all records - marked for deletion using <function>dbase_delete_record</function>. + marked for deletion using <function>dbase_delete_record</function>.</para> </refsect1> </refentry> @@ -177,7 +177,7 @@ Adds the data in the <parameter>record </parameter>to the database. If the number of items in the supplied record isn't equal to the number of fields in the database, the operation - will fail and false will be returned. + will fail and false will be returned.</para> </refsect1> </refentry> @@ -199,12 +199,12 @@ <parameter>record_number</parameter> with the data in the <parameter>record</parameter> in the database. If the number of items in the supplied record is not equal to the number of fields in the database, - the operation will fail and false will be returned. + the operation will fail and false will be returned.</simpara> <simpara> <parameter>dbase_record_number</parameter> is an integer which spans from 1 to the number of records in the database (as returned by - <function>dbase_numrecords</function>). + <function>dbase_numrecords</function>).</simpara> </refsect1> </refentry> @@ -223,7 +223,7 @@ <para> Marks <parameter>record</parameter> to be deleted from the database. To actually remove the record from the database, you must - also call <function>dbase_pack</function>. + also call <function>dbase_pack</function>.</para> </refsect1> </refentry> @@ -243,10 +243,10 @@ Returns the data from <parameter>record</parameter> in an array. The array is indexed starting at 0, and includes an associative member named 'deleted' which is set to 1 if the record has - been marked for deletion (see <function>dbase_delete_record</function>. + been marked for deletion (see <function>dbase_delete_record</function>.</para> <para> Each field is converted to the appropriate PHP type. (Dates - are left as strings.) + are left as strings.)</para> </refsect1> </refentry> @@ -266,10 +266,10 @@ Returns the data from <parameter>record</parameter> in an associative array. The array also includes an associative member named 'deleted' which is set to 1 if the record has been marked - for deletion (see <function>dbase_delete_record</function>. + for deletion (see <function>dbase_delete_record</function>.</para> <para> Each field is converted to the appropriate PHP type. (Dates - are left as strings.) + are left as strings.)</para> </refsect1> </refentry> @@ -296,7 +296,7 @@ for ($i=0; $i &lt; $nf; $i++) { print $rec[$i]."&lt;br>\n"; } -</programlisting></example> +</programlisting></example></para> </refsect1> </refentry> @@ -314,7 +314,7 @@ <para> Returns the number of records (rows) in the specified database. Record numbers are between 1 and dbase_numrecords($db), - while field numbers are between 0 and dbase_numfields($db)-1. + while field numbers are between 0 and dbase_numfields($db)-1.</para> </refsect1> </refentry> Index: phpdoc/functions/dbm.sgml diff -u phpdoc/functions/dbm.sgml:1.2 phpdoc/functions/dbm.sgml:1.3 --- phpdoc/functions/dbm.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/dbm.sgml Wed Oct 20 18:41:42 1999 @@ -8,11 +8,11 @@ database. This type of database (supported by the Berkeley db, gdbm, and some system libraries, as well as a built-in flatfile library) stores key/value pairs (as opposed to the full-blown - records supported by relational databases). + records supported by relational databases).</simpara> <para> <example> <title>dbm example</title> - <programlisting role=php> + <programlisting role="php"> $dbm = dbmopen("lastseen", "w"); if (dbmexists($dbm, $userid)) { $last_seen = dbmfetch($dbm, $userid); @@ -44,10 +44,10 @@ for read-only, new (implies read-write, and most likely will truncate an already-existing database of the same name), create (implies read-write, and will not truncate an already-existing database of the same name) - and read-write respectively. + and read-write respectively.</para> <para> Returns an identifer to be passed to the other dbm functions on success, - or false on failure. + or false on failure.</para> <para> If ndbm support is used, ndbm will actually create filename.dir and filename.pag files. gdbm only uses one file, as does the internal flat-file @@ -56,7 +56,7 @@ library itself. PHP does not delete the .lck files it creates. It uses these files simply as fixed inodes on which to do the file locking. For more information on dbm files, see your Unix man pages, or obtain GNU's gdbm from - <filename role=url>ftp://prep.ai.mit.edu/pub/gnu</filename>. + <filename role="url">ftp://prep.ai.mit.edu/pub/gnu</filename>.</para> </refsect1> </refentry> @@ -72,7 +72,7 @@ <paramdef>int <parameter>dbm_identifier</parameter></paramdef> </funcsynopsis> <para> - Unlocks and closes the specified database. + Unlocks and closes the specified database.</para> </refsect1> </refentry> @@ -89,7 +89,7 @@ <paramdef>string <parameter>key</parameter></paramdef> </funcsynopsis> <para> - Returns true if there is a value associated with the <parameter>key</parameter>. + Returns true if there is a value associated with the <parameter>key</parameter>.</para> </refsect1> </refentry> @@ -106,7 +106,7 @@ <paramdef>string <parameter>key</parameter></paramdef> </funcsynopsis> <para> - Returns the value associated with <parameter>key</parameter>. + Returns the value associated with <parameter>key</parameter>.</para> </refsect1> </refentry> @@ -124,11 +124,11 @@ <paramdef>string <parameter>value</parameter></paramdef> </funcsynopsis> <para> - Adds the value to the database with the specified key. + Adds the value to the database with the specified key.</para> <para> Returns -1 if the database was opened read-only, 0 if the insert was successful, and 1 if the specified key already exists. (To replace - the value, use <function>dbmreplace</function>.) + the value, use <function>dbmreplace</function>.)</para> </refsect1> </refentry> @@ -146,10 +146,10 @@ <paramdef>string <parameter>value</parameter></paramdef> </funcsynopsis> <para> - Replaces the value for the specified key in the database. + Replaces the value for the specified key in the database.</para> <para> This will also add the key to the database if it didn't already - exist. + exist.</para> </refsect1> </refentry> @@ -166,9 +166,9 @@ <paramdef>string <parameter>key</parameter></paramdef> </funcsynopsis> <para> - Deletes the value for <parameter>key</parameter> in the database. + Deletes the value for <parameter>key</parameter> in the database.</para> <para> - Returns false if the key didn't exist in the database. + Returns false if the key didn't exist in the database.</para> </refsect1> </refentry> @@ -186,7 +186,7 @@ <para> Returns the first key in the database. Note that no particular order is guaranteed since the database may be built using a hash-table, - which doesn't guarantee any ordering. + which doesn't guarantee any ordering.</para> </refsect1> </refentry> @@ -216,7 +216,7 @@ $key = dbmnextkey($dbm_id, $key); } </programlisting> - </example> + </example></para> </refsect1> </refentry> Index: phpdoc/functions/dir.sgml diff -u phpdoc/functions/dir.sgml:1.2 phpdoc/functions/dir.sgml:1.3 --- phpdoc/functions/dir.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/dir.sgml Wed Oct 20 18:41:42 1999 @@ -16,7 +16,7 @@ <para> Changes PHP's current directory to <parameter>directory</parameter>. Returns FALSE if unable to - change directory, TRUE otherwise. + change directory, TRUE otherwise.</para> </refsect1> </refentry> @@ -43,7 +43,7 @@ available: read, rewind and close. <example><title>Dir() Example</title> -<programlisting role=php> +<programlisting role="php"> $d = dir("/etc"); echo "Handle: ".$d->handle."&lt;br>\n"; echo "Path: ".$d->path."&lt;br>\n"; @@ -51,7 +51,7 @@ echo $entry."&lt;br>\n"; } $d->close(); - </programlisting></example> + </programlisting></example></para> </refsect1> </refentry> @@ -70,7 +70,7 @@ <para> Closes the directory stream indicated by <parameter>dir_handle</parameter>. The stream must have previously - been opened by <function>opendir</function>. + been opened by <function>opendir</function>.</para> </refsect1> </refentry> @@ -119,7 +119,7 @@ closedir($handle); ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -138,7 +138,7 @@ <para> Resets the directory stream indicated by - <parameter>dir_handle</parameter> to the beginning of the directory. + <parameter>dir_handle</parameter> to the beginning of the directory.</para> </refsect1> Index: phpdoc/functions/exec.sgml diff -u phpdoc/functions/exec.sgml:1.2 phpdoc/functions/exec.sgml:1.3 --- phpdoc/functions/exec.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/exec.sgml Wed Oct 20 18:41:42 1999 @@ -18,13 +18,13 @@ might be used to trick a shell command into executing arbitrary commands. This function should be used to make sure that any data coming from user input is escaped before this data is passed to the <function>exec</function> or <function>system</function> - functions. A standard use would be: + functions. A standard use would be:</para> <para> <informalexample> <programlisting> system(EscapeShellCmd($cmd)) </programlisting> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -47,24 +47,24 @@ output anything. It simply returns the last line from the result of the command. If you need to execute a command and have all the data from the command passed directly back without any interference, use the <function>PassThru</function> - function. + function.</para> <para> If the <parameter>array</parameter> argument is present, then the specified array will be filled with every line of output from the command. Note that if the array already contains some elements, <function>exec</function> will append to the end of the array. If you do not want the function to append elements, call <function>unset</function> on the array before - passing it to <function>exec</function>. + passing it to <function>exec</function>.</para> <para> If the <parameter>return_var</parameter> argument is present along with the <parameter>array</parameter> argument, then the return status of the executed command will be written to this - variable. + variable.</para> <para> Note that if you are going to allow data coming from user input to be passed to this function, then you should be using <function>EscapeShellCmd</function> - to make sure that users cannot trick the system into executing arbitrary commands. + to make sure that users cannot trick the system into executing arbitrary commands.</para> <para> See also <function>system</function>, <function>PassThru</function>, - <function>popen</function> and <function>EscapeShellCmd</function>. + <function>popen</function> and <function>EscapeShellCmd</function>.</para> </refsect1> </refentry> @@ -84,18 +84,18 @@ <function>System</function> is just like the C version of the function in that it executes the given <parameter>command</parameter> and outputs the result. If a variable is provided as the second argument, then the return status code of the executed command - will be written to this variable. + will be written to this variable.</para> <para> Note, that if you are going to allow data coming from user input to be passed to this function, then you should be using the <function>EscapeShellCmd</function> function - to make sure that users cannot trick the system into executing arbitrary commands. + to make sure that users cannot trick the system into executing arbitrary commands.</para> <para> The <function>System</function> call also tries to automatically flush the web server's output - buffer after each line of output if PHP is running as a server module. + buffer after each line of output if PHP is running as a server module.</para> <para> If you need to execute a command and have all the data from the command passed directly back without any interference, use the <function>PassThru</function> - function. See also the <function>exec</function> and <function>popen</function> functions. + function. See also the <function>exec</function> and <function>popen</function> functions.</para> </refsect1> </refentry> @@ -124,9 +124,9 @@ pbmplus utilities that can output an image stream directly. By setting the content-type to <emphasis>image/gif</emphasis> and then calling a pbmplus program to output a gif, you can create - PHP scripts that output images directly. + PHP scripts that output images directly.</para> <para> - See also <function>exec</function> and <function>fpassthru</function>. + See also <function>exec</function> and <function>fpassthru</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/fdf.sgml diff -u phpdoc/functions/fdf.sgml:1.6 phpdoc/functions/fdf.sgml:1.7 --- phpdoc/functions/fdf.sgml:1.6 Wed Sep 22 05:06:07 1999 +++ phpdoc/functions/fdf.sgml Wed Oct 20 18:41:42 1999 @@ -6,9 +6,8 @@ <simpara> Forms Data Format (FDF) is a format for handling - forms within PDF documents. You should read the documentation at <ulink - url="http://partners.adobe.com/asn/developer/acrosdk/forms.html">http://partners.adobe.com/asn/developer/acrosdk/forms.html</ulink> - for more information on what FDF is and how it is used in general. + forms within PDF documents. You should read the documentation at <ulink url="http://partners.adobe.com/asn/developer/acrosdk/forms.html">http://partners.adobe.com/asn/developer/acrosdk/forms.html</ulink> + for more information on what FDF is and how it is used in general.</simpara> <note><simpara> Currently Adobe only provides a libc5 compatible version for Linux. Tests @@ -40,11 +39,11 @@ browser with MimeType application/vnd.fdf. The Acrobat reader plugin of your browser recognizes the MimeType, reads the associated PDF form and - fills in the data from the FDF document. + fills in the data from the FDF document.</simpara> <simpara> - The following examples shows just the evaluation of form data. - <simpara> + The following examples shows just the evaluation of form data.</simpara> + <simpara></simpara> <example> <title>Evaluating a FDF document</title> <programlisting> @@ -104,7 +103,7 @@ by using <function>fopen</function> and writing the content of HTTP_FDF_DATA with <function>fwrite</function> into it. A mechanism like for HTML form data where for each input - field a variable is created does not exist. + field a variable is created does not exist.</para> <para> <example> @@ -122,10 +121,10 @@ fdf_close($fdf); ?> </programlisting> - </example> + </example></para> <para> - See also <function>fdf_close</function>. + See also <function>fdf_close</function>.</para> </refsect1> </refentry> @@ -142,10 +141,10 @@ <paramdef>int <parameter>fdf_document</parameter></paramdef> </funcsynopsis> <para> - The <function>fdf_close</function> function closes the FDF document. + The <function>fdf_close</function> function closes the FDF document.</para> <para> - See also <function>fdf_open</function>. + See also <function>fdf_open</function>.</para> </refsect1> </refentry> @@ -164,7 +163,7 @@ <para> The <function>fdf_create</function> creates a new FDF document. This function is needed if one would like to - populate input fields in a PDF document with data. + populate input fields in a PDF document with data.</para> <para> <example> <title>Populating a PDF document</title> @@ -182,12 +181,12 @@ unlink("outtest.fdf"); ?> </programlisting> - </example> + </example></para> <para> See also <function>fdf_close</function>, <function>fdf_save</function>, - <function>fdf_open</function>. + <function>fdf_open</function>.</para> </refsect1> </refentry> @@ -210,11 +209,11 @@ the parameter <parameter>filename</parameter> is '.'. This does not work if PHP is used as an apache module. In such a case one will have to write to a file and use e.g. - <function>fpassthru</function>. to output it. + <function>fpassthru</function>. to output it.</para> <para> See also <function>fdf_close</function> and example for - <function>fdf_create</function>. + <function>fdf_create</function>.</para> </refsect1> </refentry> @@ -233,10 +232,10 @@ </funcsynopsis> <para> The <function>fdf_get_value</function> function returns the - value of a field. + value of a field.</para> <para> - See also <function>fdf_set_value</function>. + See also <function>fdf_set_value</function>.</para> </refsect1> </refentry> @@ -259,10 +258,10 @@ The <function>fdf_set_value</function> function sets the value of a field. The last parameter determines if the field value is to be converted to a PDF Name (<parameter>isName</parameter> = 1) - or set to a PDF String (<parameter>isName</parameter> = 0). + or set to a PDF String (<parameter>isName</parameter> = 0).</para> <para> - See also <function>fdf_get_value</function>. + See also <function>fdf_get_value</function>.</para> </refsect1> </refentry> @@ -283,11 +282,11 @@ The <function>fdf_next_field_name</function> function returns the name of the field after the field in <parameter>fieldname</parameter> or the field name of the first field - if the second paramter is NULL. + if the second paramter is NULL.</para> <para> See also <function>fdf_set_field</function>, - <function>fdf_get_field</function>. + <function>fdf_get_field</function>.</para> </refsect1> </refentry> @@ -311,7 +310,7 @@ The <function>fdf_set_ap</function> function sets the appearance of a field (i.e. the value of the /AP key). The possible values of <parameter>face</parameter> - are 1=FDFNormalAP, 2=FDFRolloverAP, 3=FDFDownAP. + are 1=FDFNormalAP, 2=FDFRolloverAP, 3=FDFDownAP.</para> </refsect1> </refentry> @@ -330,10 +329,10 @@ </funcsynopsis> <para> The <function>fdf_set_status</function> sets the value - of the /STATUS key. + of the /STATUS key.</para> <para> - See also <function>fdf_get_status</function>. + See also <function>fdf_get_status</function>.</para> </refsect1> </refentry> @@ -351,10 +350,10 @@ </funcsynopsis> <para> The <function>fdf_get_status</function> returns the value - of the /STATUS key. + of the /STATUS key.</para> <para> - See also <function>fdf_set_status</function>. + See also <function>fdf_set_status</function>.</para> </refsect1> </refentry> @@ -375,11 +374,11 @@ The <function>fdf_set_file</function> sets the value of the /F key. The /F key is just a reference to a PDF form which is to be populated with data. - In a web environment it is a URL (e.g. http:/testfdf/resultlabel.pdf). + In a web environment it is a URL (e.g. http:/testfdf/resultlabel.pdf).</para> <para> See also <function>fdf_get_file</function> and example for - <function>fdf_create</function>. + <function>fdf_create</function>.</para> </refsect1> </refentry> @@ -397,10 +396,10 @@ </funcsynopsis> <para> The <function>fdf_set_file</function> returns the value - of the /F key. + of the /F key.</para> <para> - See also <function>fdf_set_file</function>. + See also <function>fdf_set_file</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/filepro.sgml diff -u phpdoc/functions/filepro.sgml:1.2 phpdoc/functions/filepro.sgml:1.3 --- phpdoc/functions/filepro.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/filepro.sgml Wed Oct 20 18:41:42 1999 @@ -2,11 +2,10 @@ <title>filePro functions</title> <partintro> <simpara> - These functions allow read-only access to data stored in filePro databases. + These functions allow read-only access to data stored in filePro databases.</simpara> <simpara> filePro is a registered trademark of Fiserv, Inc. You can find more - information about filePro at <ulink - url="&url.filepro;">&url.filepro;</ulink>. + information about filePro at <ulink url="&url.filepro;">&url.filepro;</ulink>.</simpara> </partintro> <refentry id="function.filepro"> @@ -22,10 +21,10 @@ </funcsynopsis> <para> This reads and verifies the map file, storing the field count - and info. + and info.</para> <para> No locking is done, so you should avoid modifying your filePro - database while it may be opened in PHP. + database while it may be opened in PHP.</para> </refsect1> </refentry> @@ -41,7 +40,7 @@ <paramdef>int <parameter>field_number</parameter></paramdef> </funcsynopsis> <para> - Returns the name of the field corresponding to <parameter>field_number</parameter>. + Returns the name of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> </refentry> @@ -57,7 +56,7 @@ <paramdef>int <parameter>field_number</parameter></paramdef> </funcsynopsis> <para> - Returns the edit type of the field corresponding to <parameter>field_number</parameter>. + Returns the edit type of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> </refentry> @@ -73,7 +72,7 @@ <paramdef>int <parameter>field_number</parameter></paramdef> </funcsynopsis> <para> - Returns the width of the field corresponding to <parameter>field_number</parameter>. + Returns the width of the field corresponding to <parameter>field_number</parameter>.</para> </refsect1> </refentry> @@ -90,7 +89,7 @@ <paramdef>int <parameter>field_number</parameter></paramdef> </funcsynopsis> <para> - Returns the data from the specified location in the database. + Returns the data from the specified location in the database.</para> </refsect1> </refentry> @@ -107,9 +106,9 @@ </funcsynopsis> <para> Returns the number of fields (columns) in the opened filePro - database. + database.</para> <para> - See also <function>filepro</function>. + See also <function>filepro</function>.</para> </refsect1> </refentry> @@ -125,9 +124,9 @@ <void> </funcsynopsis> <para> - Returns the number of rows in the opened filePro database. + Returns the number of rows in the opened filePro database.</para> <para> - See also <function>filepro</function>. + See also <function>filepro</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/filesystem.sgml diff -u phpdoc/functions/filesystem.sgml:1.8 phpdoc/functions/filesystem.sgml:1.9 --- phpdoc/functions/filesystem.sgml:1.8 Thu Sep 23 04:49:02 1999 +++ phpdoc/functions/filesystem.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.filesystem"> <title>Filesystem functions</title> <titleabbrev>Filesystem</titleabbrev> @@ -16,23 +15,23 @@ </funcsynopsis> <para> Given a string containing a path to a file, this function will - return the base name of the file. + return the base name of the file.</para> <para> On Windows, both slash (<literal>/</literal>) and backslash (<literal>\</literal>) are used as path separator character. In other environments, it is the forward slash - (<literal>/</literal>). + (<literal>/</literal>).</para> <para> <example><title><function>basename</function> example</title> <programlisting> $path = "/home/httpd/html/index.php3"; $file = basename($path); // $file is set to "index.php3" </programlisting> - </example> + </example></para> <para> See also: - <function>dirname</function> + <function>dirname</function></para> </refsect1> </refentry> @@ -53,13 +52,13 @@ Attempts to change the group of the file filename to group. Only the superuser may change the group of a file arbitrarily; other users may change the group of a file to any group of which that - user is a member. + user is a member.</para> <para> - Returns true on success; otherwise returns false. + Returns true on success; otherwise returns false.</para> <para> - On Windows, does nothing and returns true. + On Windows, does nothing and returns true.</para> <para> - See also <function>chown</function> and <function>chmod</function>. + See also <function>chown</function> and <function>chmod</function>.</para> </refsect1> </refentry> @@ -79,7 +78,7 @@ <para> Attempts to change the mode of the file specified by <parameter>filename</parameter> to that given in - <parameter>mode</parameter>. + <parameter>mode</parameter>.</para> <para> Note that <parameter>mode</parameter> is not automatically @@ -91,13 +90,13 @@ chmod( "/somedir/somefile", 755 ); // decimal; probably incorrect chmod( "/somedir/somefile", 0755 ); // octal; correct value of mode </programlisting> - </informalexample> + </informalexample></para> <para> - Returns true on success and false otherwise. + Returns true on success and false otherwise.</para> <para> - See also <function>chown</function> and <function>chgrp</function>. + See also <function>chown</function> and <function>chgrp</function>.</para> </refsect1> </refentry> @@ -116,17 +115,17 @@ </funcsynopsis> <para> Attempts to change the owner of the file filename to user - user. Only the superuser may change the owner of a file. + user. Only the superuser may change the owner of a file.</para> <para> Returns true on success; otherwise returns false. <note> <simpara>On Windows, does nothing and returns true.</simpara> - </note> + </note></para> <para> - See also <function>chown</function> and <function>chmod</function>. + See also <function>chown</function> and <function>chmod</function>.</para> </refsect1> </refentry> @@ -151,9 +150,9 @@ such call using the same filename. If you wish to force a new status check, for instance if the file is being checked many times and may change or disappear, use this function to clear the - results of the last call from memory. + results of the last call from memory.</para> <para> - This value is only cached for the lifetime of a single request. + This value is only cached for the lifetime of a single request.</para> <para> Affected functions include <function>stat</function>, @@ -173,7 +172,7 @@ <function>fileowner</function>, <function>filesize</function>, <function>filetype</function>, and - <function>fileperms</function>. + <function>fileperms</function>.</para> </refsect1> </refentry> @@ -200,11 +199,11 @@ print("failed to copy $file...&lt;br>\n"); } </programlisting> - </example> + </example></para> <para> See also: - <function>rename</function> + <function>rename</function></para> </refsect1> </refentry> @@ -222,11 +221,11 @@ <para> This is a dummy manual entry to satisfy those people who are looking for <function>unlink</function> or - <function>unset</function> in the wrong place. + <function>unset</function> in the wrong place.</para> <para> See also: <function>unlink</function> to delete files, <function>unset</function> - to delete variables. + to delete variables.</para> </refsect1> </refentry> @@ -243,23 +242,23 @@ </funcsynopsis> <para> Given a string containing a path to a file, this function will - return the name of the directory. + return the name of the directory.</para> <para> On Windows, both slash (<literal>/</literal>) and backslash (<literal>\</literal>) are used as path separator character. In other environments, it is the forward slash - (<literal>/</literal>). + (<literal>/</literal>).</para> <para> <example><title><function>dirname</function> example</title> <programlisting> $path = "/etc/passwd"; $file = dirname($path); // $file is set to "/etc" </programlisting> - </example> + </example></para> <para> See also: - <function>basename</function> + <function>basename</function></para> </refsect1> </refentry> @@ -277,13 +276,13 @@ <para> Given a string containing a directory, this function will return the number of bytes available on the corresponding - disk. + disk.</para> <para> <example><title><function>diskfreespace</function> example</title> <programlisting> $df = diskfreespace("/"); // $df contains the number of bytes available on "/" </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -300,15 +299,15 @@ <paramdef>int <parameter>fp</parameter></paramdef> </funcsynopsis> <para> - The file pointed to by fp is closed. + The file pointed to by fp is closed.</para> <para> - Returns true on success and false on failure. + Returns true on success and false on failure.</para> <para> The file pointer must be valid, and must point to a file successfully opened by <function>fopen</function> or - <function>fsockopen</function>. + <function>fsockopen</function>.</para> </refsect1> </refentry> @@ -327,12 +326,12 @@ </funcsynopsis> <para> Returns true if the file pointer is at EOF or an error occurs; - otherwise returns false. + otherwise returns false.</para> <para> The file pointer must be valid, and must point to a file successfully opened by <function>fopen</function>, - <function>popen</function>, or <function>fsockopen</function>. + <function>popen</function>, or <function>fsockopen</function>.</para> </refsect1> </refentry> @@ -352,15 +351,15 @@ <para> Returns a string containing a single character read from the file pointed to by fp. Returns FALSE on EOF (as does - <function>feof</function>). + <function>feof</function>).</para> <para> The file pointer must be valid, and must point to a file successfully opened by <function>fopen</function>, - <function>popen</function>, or <function>fsockopen</function>. + <function>popen</function>, or <function>fsockopen</function>.</para> <para> See also <function>fread</function>, <function>fopen</function>, <function>popen</function>, <function>fsockopen</function>, and - <function>fgets</function>. + <function>fgets</function>.</para> </refsect1> </refentry> @@ -382,18 +381,18 @@ Similar to fgets() except that fgetcsv() parses the line it reads for fields in CSV format and returns an array containing the fields read. The field delimiter is a comma, unless you specifiy another - delimiter with the optional third parameter. + delimiter with the optional third parameter.</simpara> <simpara> fp must be a valid file pointer to a file successfully opened by - <function>fopen</function>, <function>popen</function>, or <function>fsockopen</function> + <function>fopen</function>, <function>popen</function>, or <function>fsockopen</function></simpara> <simpara> length must be greater than the longest line to be found in the CSV - file (allowing for trailing line-end characters). + file (allowing for trailing line-end characters).</simpara> <simpara> - fgetcsv() returns false on error, including end of file. + fgetcsv() returns false on error, including end of file.</simpara> <simpara> NB A blank line in a CSV file will be returned as an array comprising - just one single null field, and will not be treated as an error. + just one single null field, and will not be treated as an error.</simpara> <example> <title>fgetcsv() example - Read and print entire contents of a CSV file</title> @@ -430,36 +429,36 @@ Returns a string of up to length - 1 bytes read from the file pointed to by fp. Reading ends when length - 1 bytes have been read, on a newline (which is included in the return value), or - on EOF (whichever comes first). + on EOF (whichever comes first).</para> <para> - If an error occurs, returns false. + If an error occurs, returns false.</para> <para> - Common Pitfalls: + Common Pitfalls:</para> <simpara> People used to the 'C' semantics of fgets should note the difference - in how EOF is returned. + in how EOF is returned.</simpara> <simpara> The file pointer must be valid, and must point to a file successfully opened by <function>fopen</function>, - <function>popen</function>, or <function>fsockopen</function>. + <function>popen</function>, or <function>fsockopen</function>.</simpara> <para> A simple example follows: <example> <title>Reading a file line by line</title> - <programlisting role=php> + <programlisting role="php"> $fd = fopen("/tmp/inputfile.txt", "r"); while (!feof($fd)) { $buffer = fgets($fd, 4096); echo $buffer; } fclose($fd); -</programlisting></example> +</programlisting></example></para> <para> See also <function>fread</function>, <function>fopen</function>, <function>popen</function>, - <function>fgetc</function>, and <function>fsockopen</function>. + <function>fgetc</function>, and <function>fsockopen</function>.</para> </refsect1> </refentry> @@ -481,20 +480,20 @@ <para> Identical to <function>fgets</function>, except that fgetss attempts to strip any HTML and PHP tags from - the text it reads. + the text it reads.</para> <para> You can use the optional third parameter to specify tags which should not be stripped. <note> <para> - <parameter>allowable_tags</parameter> was added in PHP 3.0.13, PHP4B3. - </note> + <parameter>allowable_tags</parameter> was added in PHP 3.0.13, PHP4B3.</para> + </note></para> <para> See also <function>fgets</function>, <function>fopen</function>, <function>fsockopen</function>, <function>popen</function>, - and <function>strip_tags</function>. + and <function>strip_tags</function>.</para> </refsect1> </refentry> @@ -516,16 +515,15 @@ <para> Identical to <function>readfile</function>, except that <function>file</function> returns the file in an array. Each element of the array corresponds - to a line in the file, with the newline still attached. + to a line in the file, with the newline still attached.</para> <para> You can use the optional second parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. + you want to search for the file in the <link linkend="ini.include-path">include_path</link>, too.</para> <para> See also <function>readfile</function>, - <function>fopen</function>, and <function>popen</function>. + <function>fopen</function>, and <function>popen</function>.</para> </refsect1> </refentry> @@ -545,11 +543,11 @@ <simpara> Returns true if the file specified by - <parameter>filename</parameter> exists; false otherwise. + <parameter>filename</parameter> exists; false otherwise.</simpara> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -567,10 +565,10 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> Returns the time the file was last accessed, or false in case - of an error. + of an error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -588,10 +586,10 @@ </funcsynopsis> <para> Returns the time the file was last changed, or false in case of - an error. + an error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -609,10 +607,10 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> Returns the group ID of the owner of the file, or false in case of an - error. + error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -631,10 +629,10 @@ </funcsynopsis> <para> Returns the inode number of the file, or false in case of an - error. + error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -653,10 +651,10 @@ </funcsynopsis> <para> Returns the time the file was last modified, or false in case of - an error. + an error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -673,11 +671,11 @@ <funcdef>int <function>fileowner</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> -<para> Returns the user ID of the owner of the file, or false in case of an +<para> Returns the user ID of the owner of the file, or false in case of an</para> <para> The results of this function are cached. See <function>clearstatcache</function> for more details. - error. + error.</para> </refsect1> </refentry> @@ -695,10 +693,10 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Returns the permissions on the file, or false in case of an error. + Returns the permissions on the file, or false in case of an error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -715,10 +713,10 @@ <funcdef>int <function>filesize</function></funcdef> <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> -<para> Returns the size of the file, or false in case of an error. +<para> Returns the size of the file, or false in case of an error.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -738,11 +736,11 @@ <para> Returns the type of the file. Possible values are fifo, char, dir, block, link, file, and - unknown. - <para> Returns false if an error occurs. + unknown.</para> + <para> Returns false if an error occurs.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -762,30 +760,30 @@ <simpara> PHP supports a portable way of locking complete files in an advisory way (which means all accessing programs have to use the same way of locking - or it will not work). + or it will not work).</simpara> <simpara> <function>flock</function> operates on <parameter>fp</parameter> which must be an open file pointer. <parameter>operation</parameter> is one of - the following values: + the following values:</simpara> <para> <itemizedlist> <listitem><simpara> To acquire a shared lock (reader), set <parameter>operation</parameter> - to 1. + to 1.</simpara></listitem> <listitem><simpara> To acquire an exclusive lock (writer), set - <parameter>operation</parameter> to 2. + <parameter>operation</parameter> to 2.</simpara></listitem> <listitem><simpara> To release a lock (shared or exclusive), set - <parameter>operation</parameter> to 3. + <parameter>operation</parameter> to 3.</simpara></listitem> <listitem><simpara> If you don't want <function>flock</function> to block while locking, - add 4 to <parameter>operation</parameter>. + add 4 to <parameter>operation</parameter>.</simpara></listitem> </itemizedlist> </para> @@ -793,11 +791,11 @@ <simpara> <function>flock</function> allows you to perform a simple reader/writer model which can be used on virtually every platform (including most - Unices and even Windows). + Unices and even Windows).</simpara> <simpara> <function>flock</function> returns true on success and false on error - (e.g. when a lock could not be acquired). + (e.g. when a lock could not be acquired).</simpara> </refsect1> </refentry> @@ -818,61 +816,60 @@ <simpara> If <parameter>filename</parameter> begins with "http://" (not case sensitive), an HTTP 1.0 connection is opened to the specified server and a file - pointer is returned to the beginning of the text of the response. + pointer is returned to the beginning of the text of the response.</simpara> <simpara> Does not handle HTTP redirects, so you must include trailing - slashes on directories. + slashes on directories.</simpara> <simpara> If <parameter>filename</parameter> begins with "ftp://" (not case sensitive), an ftp connection to the specified server is opened and a pointer to the requested file is returned. If the server does not support passive mode ftp, this will fail. You can open files for either - reading and writing via ftp (but not both simultaneously). + reading and writing via ftp (but not both simultaneously).</simpara> <simpara> If <parameter>filename</parameter> begins with anything else, the file will be opened from the filesystem, and a file pointer to - the file opened is returned. + the file opened is returned.</simpara> <simpara> - If the open fails, the function returns false. + If the open fails, the function returns false.</simpara> <para> <parameter>mode</parameter> may be any of the following: <itemizedlist> <listitem><simpara>'r' - Open for reading only; place the file - pointer at the beginning of the file. + pointer at the beginning of the file.</simpara></listitem> <listitem><simpara> 'r+' - Open for reading and writing; place the file pointer at - the beginning of the file. + the beginning of the file.</simpara></listitem> <listitem><simpara> 'w' - Open for writing only; place the file pointer at the beginning of the file and truncate the file to zero length. - If the file does not exist, attempt to create it. + If the file does not exist, attempt to create it.</simpara></listitem> <listitem><simpara> 'w+' - Open for reading and writing; place the file pointer at the beginning of the file and truncate the file to zero length. - If the file does not exist, attempt to create it. + If the file does not exist, attempt to create it.</simpara></listitem> <listitem><simpara> 'a' - Open for writing only; place the file pointer at the end - of the file. If the file does not exist, attempt to create it. + of the file. If the file does not exist, attempt to create it.</simpara></listitem> <listitem><simpara> 'a+' - Open for reading and writing; place the file pointer at the end of the file. If the file does not exist, attempt to - create it. + create it.</simpara></listitem> </itemizedlist> As well, <parameter>mode</parameter> may contain the letter 'b'. This is useful only on systems which differentiate between binary and text files (i.e., it's useless on Unix). If not - needed, this will be ignored. + needed, this will be ignored.</para> <para> You can use the optional third parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. + you want to search for the file in the <link linkend="ini.include-path">include_path</link>, too.</para> <para> <example> @@ -881,24 +878,24 @@ $fp = fopen("/home/rasmus/file.txt", "r"); $fp = fopen("http://www.php.net/", "r"); $fp = fopen("ftp://user:password@example.com/", "w"); -</programlisting></example> +</programlisting></example></para> <simpara> If you are experiencing problems with reading and writing to files and you're using the server module version of PHP, remember to make sure that the files and directories you're using are - accessible to the server process. + accessible to the server process.</simpara> <para> On the Windows platform, be careful to escape any backslashes used in the path to the file, or use forward slashes. <informalexample><programlisting> $fp = fopen("c:\\data\\info.txt", "r"); -</programlisting></informalexample> +</programlisting></informalexample></para> <simpara> See also <function>fclose</function>, - <function>fsockopen</function>, and <function>popen</function>. + <function>fsockopen</function>, and <function>popen</function>.</simpara> </refsect1> </refentry> @@ -917,26 +914,26 @@ </funcsynopsis> <simpara> Reads to EOF on the given file pointer and writes the results to - standard output. + standard output.</simpara> <simpara> - If an error occurs, <function>fpassthru</function> returns false. + If an error occurs, <function>fpassthru</function> returns false.</simpara> <simpara> The file pointer must be valid, and must point to a file successfully opened by <function>fopen</function>, <function>popen</function>, or <function>fsockopen</function>. The file is closed when <function>fpassthru</function> is done reading it (leaving - <parameter>fp</parameter> useless). + <parameter>fp</parameter> useless).</simpara> <simpara> If you just want to dump the contents of a file to stdout you may want to use the <function>readfile</function>, which - saves you the <function>fopen</function> call. + saves you the <function>fopen</function> call.</simpara> <simpara> See also <function>readfile</function>, <function>fopen</function>, - <function>popen</function>, and <function>fsockopen</function> + <function>popen</function>, and <function>fsockopen</function></simpara> </refsect1> </refentry> @@ -959,7 +956,7 @@ <function>fputs</function> is an alias to <function>fwrite</function>, and is identical in every way. Note that the <parameter>length</parameter> parameter is optional and if not specified the - entire string will be written. + entire string will be written.</para> </refsect1> </refentry> @@ -982,7 +979,7 @@ <parameter>length</parameter> bytes from the file pointer referenced by <parameter>fp</parameter>. Reading stops when <parameter>length</parameter> bytes have been read or EOF is - reached, whichever comes first. + reached, whichever comes first.</simpara> <para> <informalexample> @@ -993,13 +990,13 @@ $contents = fread( $fd, filesize( $filename ) ); fclose( $fd ); </programlisting> - </informalexample> + </informalexample></para> <simpara> See also <function>fwrite</function>, <function>fopen</function>, <function>fsockopen</function>, <function>popen</function>, <function>fgets</function>, <function>fgetss</function>, - <function>file</function>, and <function>fpassthru</function>. + <function>file</function>, and <function>fpassthru</function>.</simpara> </refsect1> </refentry> @@ -1019,19 +1016,19 @@ <para> Sets the file position indicator for the file referenced by fp to offset bytes into the file stream. Equivalent to calling (in C) - <literal>fseek( fp, offset, SEEK_SET )</literal>. + <literal>fseek( fp, offset, SEEK_SET )</literal>.</para> <para> Upon success, returns 0; otherwise, returns -1. Note that seeking - past EOF is not considered an error. + past EOF is not considered an error.</para> <para> May not be used on file pointers returned by <function>fopen</function> - if they use the "http://" or "ftp://" formats. + if they use the "http://" or "ftp://" formats.</para> <para> See also <function>ftell</function> and - <function>rewind</function>. + <function>rewind</function>.</para> </refsect1> </refentry> @@ -1050,19 +1047,19 @@ </funcsynopsis> <para> Returns the position of the file pointer referenced by fp; i.e., - its offset into the file stream. + its offset into the file stream.</para> <para> - If an error occurs, returns false. + If an error occurs, returns false.</para> <para> The file pointer must be valid, and must point to a file successfully opened by <function>fopen</function> or - <function>popen</function>. + <function>popen</function>.</para> <para> See also <function>fopen</function>, <function>popen</function>, <function>fseek</function> and - <function>rewind</function>. + <function>rewind</function>.</para> </refsect1> </refentry> @@ -1087,19 +1084,18 @@ argument is given, writing will stop after <parameter>length</parameter> bytes have been written or the end of <parameter>string</parameter> is reached, whichever comes - first. + first.</simpara> <simpara> Note that if the <parameter>length</parameter> argument is given, - then the <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> + then the <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> configuration option will be ignored and no slashes will be - stripped from <parameter>string</parameter>. + stripped from <parameter>string</parameter>.</simpara> <simpara> See also <function>fread</function>, <function>fopen</function>, <function>fsockopen</function>, <function>popen</function>, and - <function>fputs</function>. + <function>fputs</function>.</simpara> </refsect1> </refentry> @@ -1119,18 +1115,18 @@ <function>set_file_buffer</function> sets the buffering for write operations on the given filepointer <parameter>fp</parameter> to <parameter>buffer</parameter> bytes. If <parameter>buffer</parameter> - is 0 then write operations are unbuffered. + is 0 then write operations are unbuffered.</simpara> <simpara> The function returns 0 on success, or EOF if the request cannot - be honored. + be honored.</simpara> <simpara> Note that the default for any fopen with calling set_file_buffer - is 8K. + is 8K.</simpara> <simpara> - See also <function>fopen</function>. + See also <function>fopen</function>.</simpara> </refsect1> </refentry> @@ -1146,12 +1142,12 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Returns true if the filename exists and is a directory. + Returns true if the filename exists and is a directory.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> <para> - See also <function>is_file</function> and <function>is_link</function>. + See also <function>is_file</function> and <function>is_link</function>.</para> </refsect1> </refentry> @@ -1167,12 +1163,12 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Returns true if the filename exists and is executable. + Returns true if the filename exists and is executable.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> <para> - See also <function>is_file</function> and <function>is_link</function>. + See also <function>is_file</function> and <function>is_link</function>.</para> </refsect1> </refentry> @@ -1188,12 +1184,12 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Returns true if the filename exists and is a regular file. + Returns true if the filename exists and is a regular file.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> <para> - See also <function>is_dir</function> and <function>is_link</function>. + See also <function>is_dir</function> and <function>is_link</function>.</para> </refsect1> </refentry> @@ -1209,12 +1205,12 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Returns true if the filename exists and is a symbolic link. + Returns true if the filename exists and is a symbolic link.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> <para> - See also <function>is_dir</function> and <function>is_file</function>. + See also <function>is_dir</function> and <function>is_file</function>.</para> </refsect1> </refentry> @@ -1230,16 +1226,16 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Returns true if the filename exists and is readable. + Returns true if the filename exists and is readable.</para> <para> Keep in mind that PHP may be accessing the file as the user id that the web server runs as (often 'nobody'). Safe mode - limitations are not taken into account. + limitations are not taken into account.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> <para> - See also <function>is_writeable</function>. + See also <function>is_writeable</function>.</para> </refsect1> </refentry> @@ -1257,16 +1253,16 @@ <para> Returns true if the filename exists and is writeable. The filename argument may be a directory name allowing you to check if a - directory is writeable. + directory is writeable.</para> <para> Keep in mind that PHP may be accessing the file as the user id that the web server runs as (often 'nobody'). Safe mode - limitations are not taken into account. + limitations are not taken into account.</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> <para> - See also <function>is_readable</function>. + See also <function>is_readable</function>.</para> </refsect1> </refentry> @@ -1284,10 +1280,10 @@ <paramdef>string <parameter>link</parameter></paramdef> </funcsynopsis> <para> - <function>Link</function> creates a hard link. + <function>Link</function> creates a hard link.</para> <para> See also the <function>symlink</function> to create soft links, - and <function>readlink</function> along with <function>linkinfo</function>. + and <function>readlink</function> along with <function>linkinfo</function>.</para> </refsect1> </refentry> @@ -1307,10 +1303,10 @@ stat structure returned by the lstat system call. This function is used to verify if a link (pointed to by <parameter>path</parameter>) really exists (using the same method as the S_ISLNK macro defined in stat.h). - Returns 0 or FALSE in case of error. + Returns 0 or FALSE in case of error.</para> <para> See also <function>symlink</function>, <function>link</function>, - and <function>readlink</function>. + and <function>readlink</function>.</para> </refsect1> </refentry> @@ -1328,20 +1324,20 @@ <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Attempts to create the directory specified by pathname. + Attempts to create the directory specified by pathname.</para> <para> Note that you probably want to specify the mode as an octal number, which means it should have a leading zero. <informalexample><programlisting> mkdir("/path/to/my/dir", 0700); -</programlisting></informalexample> +</programlisting></informalexample></para> <para> - Returns true on success and false on failure. + Returns true on success and false on failure.</para> <para> - See also <function>rmdir</function>. + See also <function>rmdir</function>.</para> </refsect1> </refentry> @@ -1358,12 +1354,12 @@ <funcdef>int <function>pclose</function></funcdef> <paramdef>int <parameter>fp</parameter></paramdef> </funcsynopsis> -<para> Closes a file pointer to a pipe opened by <function>popen</function>. +<para> Closes a file pointer to a pipe opened by <function>popen</function>.</para> <para> The file pointer must be valid, and must have been returned by a - successful call to <function>popen</function>. - <para> Returns the termination status of the process that was run. + successful call to <function>popen</function>.</para> + <para> Returns the termination status of the process that was run.</para> <para> - See also <function>popen</function>. + See also <function>popen</function>.</para> </refsect1> </refentry> @@ -1382,25 +1378,25 @@ <paramdef>string <parameter>mode</parameter></paramdef> </funcsynopsis> <para> Opens a pipe to a process executed by forking the command - given by command. + given by command.</para> <para> Returns a file pointer identical to that returned by <function>fopen</function>, except that it is unidirectional (may only be used for reading or writing) and must be closed with <function>pclose</function>. This pointer may be used with <function>fgets</function>, <function>fgetss</function>, and - <function>fputs</function>. + <function>fputs</function>.</para> <para> - If an error occurs, returns false. + If an error occurs, returns false.</para> <para> <informalexample> <programlisting> $fp = popen( "/bin/ls", "r" ); - </programlisting></informalexample> + </programlisting></informalexample></para> <para> - See also <function>pclose</function>. + See also <function>pclose</function>.</para> </refsect1> </refentry> @@ -1419,36 +1415,35 @@ <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> - Reads a file and writes it to standard output. + Reads a file and writes it to standard output.</para> <para> Returns the number of bytes read from the file. If an error occurs, false is returned and unless the function was called as - @readfile, an error message is printed. + @readfile, an error message is printed.</para> <para> If <parameter>filename</parameter> begins with "http://" (not case sensitive), an HTTP 1.0 connection is opened to the specified server and the text of the response is written to - standard output. + standard output.</para> <para> Does not handle HTTP redirects, so you must include trailing - slashes on directories. + slashes on directories.</para> <para> If <parameter>filename</parameter> begins with "ftp://" (not case sensitive), an ftp connection to the specified server is opened and the requested file is written to standard output. If the server - does not support passive mode ftp, this will fail. + does not support passive mode ftp, this will fail.</para> <para> If <parameter>filename</parameter> begins with neither of these strings, the file will be opened from the filesystem and - its contents written to standard output. + its contents written to standard output.</para> <para> You can use the optional second parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. + you want to search for the file in the <link linkend="ini.include-path">include_path</link>, too.</para> <para> See also <function>fpassthru</function>, <function>file</function>, <function>fopen</function>, <function>include</function>, - <function>require</function>, and <function>virtual</function>. + <function>require</function>, and <function>virtual</function>.</para> </refsect1> </refentry> @@ -1466,10 +1461,10 @@ </funcsynopsis> <para> <function>Readlink</function> does the same as the readlink C function - and returns the contents of the symbolic link path or 0 in case of error. + and returns the contents of the symbolic link path or 0 in case of error.</para> <para> See also <function>symlink</function>, - <function>readlink</function> and <function>linkinfo</function>. + <function>readlink</function> and <function>linkinfo</function>.</para> </refsect1> </refentry> @@ -1485,8 +1480,8 @@ <paramdef>string <parameter>oldname</parameter></paramdef> <paramdef>string <parameter>newname</parameter></paramdef> </funcsynopsis> - <para> Attempts to rename <parameter>oldname</parameter> to <parameter>newname</parameter>. - <para> Returns true on success and false on failure. + <para> Attempts to rename <parameter>oldname</parameter> to <parameter>newname</parameter>.</para> + <para> Returns true on success and false on failure.</para> </refsect1> </refentry> @@ -1504,12 +1499,12 @@ <paramdef>int <parameter>fp</parameter></paramdef> </funcsynopsis> <para> Sets the file position indicator for fp to the - beginning of the file stream. - <para> If an error occurs, returns 0. + beginning of the file stream.</para> + <para> If an error occurs, returns 0.</para> <para> The file pointer must be valid, and must point to a file - successfully opened by <function>fopen</function>. + successfully opened by <function>fopen</function>.</para> <para> - See also <function>fseek</function> and <function>ftell</function>. + See also <function>fseek</function> and <function>ftell</function>.</para> </refsect1> </refentry> @@ -1528,10 +1523,10 @@ </funcsynopsis> <para> Attempts to remove the directory named by pathname. The directory must be empty, and the relevant permissions must permit - this. - <para> If an error occurs, returns 0. + this.</para> + <para> If an error occurs, returns 0.</para> <para> - See also <function>mkdir</function>. + See also <function>mkdir</function>.</para> </refsect1> </refentry> @@ -1549,7 +1544,7 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Gathers the statistics of the file named by filename. + Gathers the statistics of the file named by filename.</para> <para> Returns an array with the statistics of the file with the following elements: @@ -1569,10 +1564,10 @@ <listitem><simpara>number of blocks allocated</simpara></listitem> </orderedlist> * - only valid on systems supporting the st_blksize type--other - systems (i.e. Windows) return -1 + systems (i.e. Windows) return -1</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -1594,7 +1589,7 @@ This function is identical to the <function>stat</function> function except that if the <parameter>filename</parameter> parameter is a symbolic link, the status of the symbolic link is returned, not - the status of the file pointed to by the symbolic link. + the status of the file pointed to by the symbolic link.</para> <para> Returns an array with the statistics of the file with the following elements: @@ -1613,10 +1608,10 @@ <listitem><simpara>number of blocks allocated</simpara></listitem> </orderedlist> * - only valid on systems supporting the st_blksize type--other - systems (i.e. Windows) return -1 + systems (i.e. Windows) return -1</para> <para> The results of this function are cached. See - <function>clearstatcache</function> for more details. + <function>clearstatcache</function> for more details.</para> </refsect1> </refentry> @@ -1637,11 +1632,11 @@ <para> <function>symlink</function> creates a symbolic link from the existing <parameter>target</parameter> with - the specified name <parameter>link</parameter>. + the specified name <parameter>link</parameter>.</para> <para> See also <function>link</function> to create hard links, and <function>readlink</function> along with - <function>linkinfo</function>. + <function>linkinfo</function>.</para> </refsect1> </refentry> @@ -1661,7 +1656,7 @@ <para> Creates a unique temporary filename in the specified directory. If the directory does not exist, <function>tempnam</function> - may generate a filename in the system's temporary directory. + may generate a filename in the system's temporary directory.</para> <para> The behaviour of the <function>tempnam</function> function is @@ -1670,7 +1665,7 @@ TMPDIR environment variable has precedence, while SVR4 will always use your <parameter>dir</parameter> parameter if the directory it points to exists. Consult your system documentation on the - tempnam(3) function if in doubt. + tempnam(3) function if in doubt.</para> <para> Returns the new temporary filename, or the null string on @@ -1679,7 +1674,7 @@ <example><title>tempnam() example</title> <programlisting> $tmpfname = tempnam( "/tmp", "FOO" ); -</programlisting></example> +</programlisting></example></para> </refsect1> </refentry> @@ -1700,13 +1695,13 @@ <para> Attempts to set the modification time of the file named by filename to the value given by time. If the option time is not - given, uses the present time. + given, uses the present time.</para> <para> - If the file does not exist, it is created. + If the file does not exist, it is created.</para> <para> - Returns true on success and false otherwise. + Returns true on success and false otherwise.</para> </refsect1> </refentry> @@ -1725,9 +1720,9 @@ <para> <function>Umask</function> 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. + when each request is finished.</para> <para> - <function>Umask</function> without arguments simply returns the current umask. + <function>Umask</function> without arguments simply returns the current umask.</para> </refsect1> </refentry> @@ -1743,11 +1738,11 @@ <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> - Deletes <parameter>filename</parameter>. Similar to the Unix C unlink() function. + Deletes <parameter>filename</parameter>. Similar to the Unix C unlink() function.</para> <para> - Returns 0 or FALSE on an error. + Returns 0 or FALSE on an error.</para> <para> - See also <function>rmdir</function> for removing directories. + See also <function>rmdir</function> for removing directories.</para> </refsect1> </refentry> Index: phpdoc/functions/ftp.sgml diff -u phpdoc/functions/ftp.sgml:1.8 phpdoc/functions/ftp.sgml:1.9 --- phpdoc/functions/ftp.sgml:1.8 Mon Oct 4 14:38:42 1999 +++ phpdoc/functions/ftp.sgml Wed Oct 20 18:41:42 1999 @@ -4,13 +4,13 @@ <partintro> <para> - FTP stands for File Transfer Protocol. + FTP stands for File Transfer Protocol.</para> <para> The following constants are defined when using the FTP module: FTP_ASCII, and - FTP_BINARY. + FTP_BINARY.</para> </partintro> @@ -28,12 +28,12 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns a FTP stream on success, false on error. + Returns a FTP stream on success, false on error.</para> <para> <function>ftp_connect</function> opens up a FTP connection to the specified <parameter>host</parameter>. The <parameter>port</parameter> parameter specifies an alternate port to connect to. If it is - omitted or zero, then the default FTP port, 21, will be used. + omitted or zero, then the default FTP port, 21, will be used.</para> </refsect1> </refentry> @@ -41,7 +41,7 @@ <refentry id="function.ftp-login"> <refnamediv> <refname>ftp_login</refname> - <refpurpose>Logs in a FTP connection</refpurpose> + <refpurpose>Logs in an FTP connection</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -52,9 +52,9 @@ <paramdef>string <parameter>password</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> - Logs in the given FTP stream. + Logs in the given FTP stream.</para> </refsect1> </refentry> @@ -70,7 +70,7 @@ <paramdef>int <parameter>ftp_stream</parameter></paramdef> </funcsynopsis> <para> - Returns the current directory, or false on error. + Returns the current directory, or false on error.</para> </refsect1> </refentry> @@ -86,9 +86,9 @@ <paramdef>int <parameter>ftp_stream</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> - Changes to the parent directory. + Changes to the parent directory.</para> </refsect1> </refentry> @@ -105,9 +105,9 @@ <paramdef>string <parameter>directory</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> - Changes to the specified <parameter>directory</parameter>. + Changes to the specified <parameter>directory</parameter>.</para> </refsect1> </refentry> @@ -124,9 +124,9 @@ <paramdef>string <parameter>directory</parameter></paramdef> </funcsynopsis> <para> - Returns the newly created directory name on success, false on error. + Returns the newly created directory name on success, false on error.</para> <para> - Creates the specified <parameter>directory</parameter>. + Creates the specified <parameter>directory</parameter>.</para> </refsect1> </refentry> @@ -143,9 +143,9 @@ <paramdef>string <parameter>directory</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> - Removes the specified <parameter>directory</parameter>. + Removes the specified <parameter>directory</parameter>.</para> </refsect1> </refentry> @@ -162,7 +162,7 @@ <paramdef>string <parameter>directory</parameter></paramdef> </funcsynopsis> <para> - Returns an array of filenames on success, false on error. + Returns an array of filenames on success, false on error.</para> </refsect1> </refentry> @@ -185,7 +185,7 @@ and returns the result as an array. Each array element corresponds to one line of text. The output is not parsed in any way. The system type identifier returned by <function>ftp_systype</function> - can be used to determine how the results should be interpreted. + can be used to determine how the results should be interpreted.</para> </refsect1> </refentry> @@ -203,7 +203,7 @@ <paramdef>int <parameter>ftp_stream</parameter></paramdef> </funcsynopsis> <para> - Returns the remote system type, or false on error. + Returns the remote system type, or false on error.</para> </refsect1> </refentry> @@ -220,13 +220,13 @@ <paramdef>int <parameter>pasv</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_pasv</function> turns on passive mode if the <parameter>pasv</parameter> parameter is true (it turns off passive mode if <parameter>pasv</parameter> is false.) In passive mode, data connections are initiated by the client, - rather than by the server. + rather than by the server.</para> </refsect1> </refentry> @@ -245,12 +245,12 @@ <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_get</function> retrieves <parameter>remote_file</parameter> from the FTP server, and saves it to <parameter>local_file</parameter> locally. The transfer <parameter>mode</parameter> specified must - be either FTP_ASCII or FTP_BINARY. + be either FTP_ASCII or FTP_BINARY.</para> </refsect1> </refentry> @@ -270,12 +270,12 @@ <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_fget</function> retrieves <parameter>remote_file</parameter> from the FTP server, and writes it to the given file pointer, <parameter>fp</parameter>. The transfer <parameter>mode</parameter> - specified must be either FTP_ASCII or FTP_BINARY. + specified must be either FTP_ASCII or FTP_BINARY.</para> </refsect1> </refentry> @@ -294,12 +294,12 @@ <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_put</function> stores <parameter>local_file</parameter> on the FTP server, as <parameter>remote_file</parameter>. The transfer <parameter>mode</parameter> specified must be either FTP_ASCII or - FTP_BINARY. + FTP_BINARY.</para> </refsect1> </refentry> @@ -318,13 +318,13 @@ <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_fput</function> uploads the data from the file pointer <parameter>fp</parameter> until end of file. The results are stored in <parameter>remote_file</parameter> on the FTP server. The transfer <parameter>mode</parameter> specified must be either FTP_ASCII or - FTP_BINARY. + FTP_BINARY.</para> </refsect1> </refentry> @@ -341,11 +341,11 @@ <paramdef>string <parameter>remote_file</parameter></paramdef> </funcsynopsis> <para> - Returns the file size on success, or -1 on error. + Returns the file size on success, or -1 on error.</para> <para> <function>ftp_size</function> returns the size of a file. If an error occurs, of if the file does not exist, -1 is returned. Not - all servers support this feature. + all servers support this feature.</para> </refsect1> </refentry> @@ -362,12 +362,12 @@ <paramdef>string <parameter>remote_file</parameter></paramdef> </funcsynopsis> <para> - Returns a UNIX timestamp on success, or -1 on error. + Returns a UNIX timestamp on success, or -1 on error.</para> <para> <function>ftp_mdtm</function> checks the last-modified time for a file, and returns it as a UNIX timestamp. If an error occurs, or the file does not exist, -1 is returned. Note that not all servers - support this feature. + support this feature.</para> </refsect1> </refentry> @@ -385,10 +385,10 @@ <paramdef>string <parameter>to</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_rename</function> renames the file specified - by <parameter>from</parameter> to the new name <parameter>to</parameter> + by <parameter>from</parameter> to the new name <parameter>to</parameter></para> </refsect1> </refentry> @@ -405,10 +405,10 @@ <paramdef>string <parameter>path</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ftp_delete</function> deletes the file specified by - <paramter>path</paramter> from the FTP server. + <parameter>path</parameter> from the FTP server.</para> </refsect1> </refentry> @@ -424,10 +424,11 @@ <paramdef>int <parameter>ftp_stream</parameter></paramdef> </funcsynopsis> <para> - <function>ftp_connect</function> closes <parameter>ftp_stream</parameter>. + <function>ftp_connect</function> closes <parameter>ftp_stream</parameter>.</para> </refsect1> </refentry> +</reference> <!-- Keep this comment at the end of the file Local variables: mode: sgml Index: phpdoc/functions/http.sgml diff -u phpdoc/functions/http.sgml:1.5 phpdoc/functions/http.sgml:1.6 --- phpdoc/functions/http.sgml:1.5 Thu Aug 19 17:14:21 1999 +++ phpdoc/functions/http.sgml Wed Oct 20 18:41:42 1999 @@ -5,7 +5,7 @@ <partintro> <simpara> These functions let you manipulate the output sent back to the - remote browser right down to the HTTP protocol level. + remote browser right down to the HTTP protocol level.</simpara> </partintro> <refentry id="function.header"> @@ -29,25 +29,25 @@ output is sent either by normal HTML tags or from PHP. It is a very common error to read code with <function>include</function> or with auto_prepend and have spaces or empty lines in this code that force - output before <function>header</function> is called. + output before <function>header</function> is called.</para> <para> - <informalexample><programlisting role=php> + <informalexample><programlisting role="php"> header("Location: http://www.php.net"); /* Redirect browser to PHP web site */ exit; /* Make sure that code below does not get executed when we redirect. */ -</programlisting></informalexample> +</programlisting></informalexample></para> <para> PHP scripts often generate dynamic HTML that must not be cached by the client browser or any proxy caches between the server and the client browser. Many proxies and clients can be forced to disable caching with - <informalexample><programlisting role=php> + <informalexample><programlisting role="php"> header("Expires: Mon, 26 Jul 1997 05:00:00 GMT"); // Date in the past header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT"); // always modified header("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1 header("Pragma: no-cache"); // HTTP/1.0 -</programlisting></informalexample> +</programlisting></informalexample></para> </refsect1> </refentry> @@ -73,7 +73,7 @@ <emphasis>before</emphasis> any other headers are sent (this is a restriction of cookies, not PHP). This requires you to place calls to this function before any <literal>&lt;html></literal> or - <literal>&lt;head></literal> tags. + <literal>&lt;head></literal> tags.</para> <para> All the arguments except the <parameter>name</parameter> argument are @@ -87,30 +87,30 @@ argument is a regular Unix time integer as returned by the <function>time</function> or <function>mktime</function> functions. The <parameter>secure</parameter> indicates that the cookie should - only be transmitted over a secure HTTPS connection. + only be transmitted over a secure HTTPS connection.</para> <para> - Common Pitfalls: + Common Pitfalls:</para> <simpara> Cookies will not become visible until the next loading of a page that - the cookie should be visable for. + the cookie should be visable for.</simpara> <simpara> Multiple calls to <function>setcookie</function> in the same script will be performed in the reverse order. If you are trying to delete one cookie before inserting another you should put the insert before - the delete. + the delete.</simpara> <para> Some examples follow: <example> <title><function>setcookie</function> examples</title> - <programlisting role=php> + <programlisting role="php"> setcookie("TestCookie","Test Value"); setcookie("TestCookie",$value,time()+3600); /* expire in 1 hour */ setcookie("TestCookie",$value,time()+3600,"/~rasmus/",".utoronto.ca",1); -</programlisting></example> +</programlisting></example></para> <para> Note that the value portion of the cookie will automatically be @@ -119,24 +119,24 @@ name as the cookie name. To see the contents of our test cookie in a script, simply use one of the following examples: -<informalexample><programlisting role=php> +<informalexample><programlisting role="php"> echo $TestCookie; echo $HTTP_COOKIE_VARS["TestCookie"]; -</programlisting></informalexample> +</programlisting></informalexample></para> <para> For more information on cookies, see Netscape's cookie - specification at <ulink url="&spec.cookies;">&spec.cookies;</ulink>. + specification at <ulink url="&spec.cookies;">&spec.cookies;</ulink>.</para> <simpara> Microsoft Internet Explorer 4 with Service Pack 1 applied does not correctly deal with cookies that have their path parameter - set. + set.</simpara> <simpara> Netscape Communicator 4.05 and Microsoft Internet Explorer 3.x appear to handle cookies incorrectly when the path and time - are not set. + are not set.</simpara> </refsect1> </refentry> Index: phpdoc/functions/hw.sgml diff -u phpdoc/functions/hw.sgml:1.9 phpdoc/functions/hw.sgml:1.10 --- phpdoc/functions/hw.sgml:1.9 Wed Sep 1 02:24:14 1999 +++ phpdoc/functions/hw.sgml Wed Oct 20 18:41:42 1999 @@ -7,15 +7,13 @@ <sect1 id="hw-intro"> <title>Introduction</title> <para> - <productname>Hyperwave</productname> has been developed at <ulink - url="http://www.iicm.edu">IICM</ulink> in Graz. It started with + <productname>Hyperwave</productname> has been developed at <ulink url="http://www.iicm.edu">IICM</ulink> in Graz. It started with the name <acronym>Hyper-G</acronym> and changed to Hyperwave when - it was commercialised (If I remember properly it was in 1996). + it was commercialised (If I remember properly it was in 1996).</para> <para> Hyperwave is not free software. The current version, 4.1, is - available at <ulink - url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. A - time limited version can be ordered for free (30 days). + available at <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. A + time limited version can be ordered for free (30 days).</para> <para> Hyperwave is an information system similar to a database (<acronym>HIS</acronym>, Hyperwave Information Server). Its focus @@ -35,7 +33,7 @@ e.g. 'en:Title in English' or 'ge:Titel in deutsch'. Other attributes like a description or keywords are potential candidates. You may also replace the language abbreviation by any other string as long - as it separated by colon from the rest of the attribute value. + as it separated by colon from the rest of the attribute value.</para> <para> Each object record has native a string representation with each name/value @@ -46,7 +44,7 @@ abbreviation. Actually any multiple attribute forms an associated array with the string left to the colon in the attribute value being the key. (This is not fully implemented. Only the attributes - Title, Description and Keyword are treated properly yet.) + Title, Description and Keyword are treated properly yet.)</para> <para> Besides the documents, all hyper links contained in a document are stored as object records as well. Hyper links which @@ -63,7 +61,7 @@ is pointing to changes its name, the link can easily be modified accordingly. The document containing the link is not affected at all. You may even add a link to a document without modifying - the document itself. + the document itself.</para> <para> Saying that <function>hw_pipedocument</function> and <function>hw_gettext</function> do the link insertion automatically @@ -88,7 +86,7 @@ An object with name 'parent/my_object' could be the child of 'my_object' in the Hyperwave hierarchy, though in a web namespace it appears to be just the opposite and the user might get confused. - This can only be prevented by selecting reasonable object names. + This can only be prevented by selecting reasonable object names.</para> <para> Having made this decision a second problem arises. How do you involve PHP? The URL http://host/my_object will not call any @@ -101,9 +99,9 @@ searching in the Hyperwave server would be impossible. Therefore you will need at least a second rewriting rule to exclude certain URLS like all e.g. starting with http://host/Hyperwave. This is - basically sharing of a namespace by the web and Hyperwave server. + basically sharing of a namespace by the web and Hyperwave server.</para> <para> - Based on the above mechanism links are insert into documents. + Based on the above mechanism links are insert into documents.</para> <para> It gets more complicated if PHP is not run as a server module or CGI script but as a standalone application e.g. to dump the content of @@ -111,11 +109,10 @@ retain the Hyperwave hierarchy and map in onto the file system. This conflicts with the object names if they reflect its own hierarchy (e.g. by choosing names including '/'). Therefore '/' has to be - replaced by another character, e.g. '_'. to be continued. + replaced by another character, e.g. '_'. to be continued.</para> <para> The network protocol to communicate - with the Hyperwave server is called <ulink - url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> (Hyper-G + with the Hyperwave server is called <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> (Hyper-G Client/Server Protocol). It is based on messages to initiate certain actions, e.g. get object record. In early versions of the Hyperwave Server two native clients (Harmony, Amadeus) were @@ -130,14 +127,14 @@ <abbrev>PLACE</abbrev> lacks a lot of features of a real programming language and any extension to it only enlarges the list of placeholders. This has led to the use of JavaScript which IMO does - not make life easier. + not make life easier.</para> <para> Adding Hyperwave support to PHP should fill in the gap of a missing programming language for interface customisation. It implements all the messages as defined by the <abbrev>HG-CSP</abbrev> but also provides more powerful commands - to e.g. retrieve complete documents. + to e.g. retrieve complete documents.</para> <para> Hyperwave has its own terminology to name certain pieces of @@ -174,7 +171,7 @@ actual document, e.g. HTML, PDF etc. It is somewhat optimised for HTML documents but may be used for any format. </simpara></listitem> - </itemizedlist> + </itemizedlist></para> <para> Several functions which return an array of object records do also @@ -186,38 +183,38 @@ <term>Hidden</term> <listitem><simpara> Number of object records with attribute PresentationHints - set to Hidden. + set to Hidden.</simpara></listitem> </varlistentry> <varlistentry> <term>CollectionHead</term> <listitem><simpara> Number of object records with attribute - PresentationHints set to CollectionHead. + PresentationHints set to CollectionHead.</simpara></listitem> </varlistentry> <varlistentry> <term>FullCollectionHead</term> <listitem><simpara> Number of object records with attribute - PresentationHints set to FullCollectionHead. + PresentationHints set to FullCollectionHead.</simpara></listitem> </varlistentry> <varlistentry> <term>CollectionHeadNr</term> <listitem><simpara> Index in array of object records with - attribute PresentationHints set to CollectionHead. + attribute PresentationHints set to CollectionHead.</simpara></listitem> </varlistentry> <varlistentry> <term>FullCollectionHeadNr</term> <listitem><simpara> Index in array of object records with - attribute PresentationHints set to FullCollectionHead. + attribute PresentationHints set to FullCollectionHead.</simpara></listitem> </varlistentry> <varlistentry> <term>Total</term> <listitem><simpara> - Total: Number of object records. + Total: Number of object records.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> </sect1> <sect1 id="hw-apache"> @@ -226,7 +223,7 @@ The Hyperwave extension is best used when PHP is compiled as an Apache module. In such a case the underlying Hyperwave server can be hidden from users almost completely if Apache uses its rewriting - engine. The following instructions will explain this. + engine. The following instructions will explain this.</para> <para> Since PHP with Hyperwave support built into Apache is intended @@ -236,16 +233,14 @@ configuration. The concept is quite simple. First of all you need a PHP script which evaluates the <envar>PATH_INFO</envar> variable and treats its value as the name of a Hyperwave - object. Let's call this script 'Hyperwave'. The URL <systemitem - role="url">http://your.hostname/Hyperwave/name_of_object</systemitem> + object. Let's call this script 'Hyperwave'. The URL <systemitem role="url">http://your.hostname/Hyperwave/name_of_object</systemitem> would than return the Hyperwave object with the name 'name_of_object'. Depending on the type of the object the script has to react accordingly. If it is a collection, it will probably return a list of children. If it is a document it will return the mime type and the content. A slight improvement can be achieved if the Apache rewriting engine is used. From the users point of - view it would be more straight forward if the URL <systemitem - role=url>http://your.hostname/name_of_object</systemitem> would + view it would be more straight forward if the URL <systemitem role="url">http://your.hostname/name_of_object</systemitem> would return the object. The rewriting rule is quite easy: <informalexample><programlisting role="apache-conf"> @@ -262,8 +257,7 @@ RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L] </programlisting></informalexample> - This will reserve the directory <filename - class="directory">/usr/local/apache/htdocs/hw</filename> for + This will reserve the directory <filename class="directory">/usr/local/apache/htdocs/hw</filename> for additional scripts and other files. Just make sure this rule is evaluated before the one above. There is just a little drawback: all Hyperwave objects whose name starts with 'hw/' will be @@ -281,18 +275,18 @@ <itemizedlist> <listitem><simpara> - to return the object itself + to return the object itself</simpara></listitem> <listitem><simpara> - to allow searching + to allow searching</simpara></listitem> <listitem><simpara> - to identify yourself + to identify yourself</simpara></listitem> <listitem><simpara> - to set your profile + to set your profile</simpara></listitem> <listitem><simpara> one for each additional function like to show the object attributes, to show information about users, - to show the status of the server, etc. - </itemizedlist> + to show the status of the server, etc.</simpara></listitem> + </itemizedlist></para> </sect1> <sect1 id="hw-todo"> @@ -313,7 +307,7 @@ <listitem><simpara>Conversion form object record into object array needs to handle any multiple attribute. </simpara></listitem> - </itemizedlist> + </itemizedlist></para> </sect1> </partintro> @@ -331,9 +325,9 @@ <para> Converts an <parameter>object_array</parameter> into an object record. Multiple attributes like 'Title' in different languages are treated - properly. + properly.</para> <para> - See also <function>hw_objrec2array</function>. + See also <function>hw_objrec2array</function>.</para> </refsect1> </refentry> @@ -353,7 +347,7 @@ Returns an array of object ids. Each id belongs to a child of the collection with ID <parameter>objectID</parameter>. - The array contains all children both documents and collections. + The array contains all children both documents and collections.</para> </refsect1> </refentry> @@ -373,7 +367,7 @@ Returns an array of object records. Each object record belongs to a child of the collection with ID <parameter>objectID</parameter>. - The array contains all children both documents and collections. + The array contains all children both documents and collections.</para> </refsect1> </refentry> @@ -391,7 +385,7 @@ <para> Returns false if connection is not a valid connection index, otherwise true. Closes down the connection to a Hyperwave server - with the given connection index. + with the given connection index.</para> </refsect1> </refentry> @@ -420,9 +414,9 @@ This function returns a connection index that is needed by other Hyperwave functions. You can have multiple connections open at once. Keep in mind, that the password - is not encrypted. + is not encrypted.</para> <para> - See also <function>hw_pConnect</function>. + See also <function>hw_pConnect</function>.</para> </refsect1> </refentry> @@ -442,11 +436,11 @@ <para> Copies the objects with object ids as specified in the second parameter to the collection - with the id <parameter>destination id</parameter>. + with the id <parameter>destination id</parameter>.</para> <para> - The value return is the number of copied objects. + The value return is the number of copied objects.</para> <para> - See also <function>hw_mv</function>. + See also <function>hw_mv</function>.</para> </refsect1> </refentry> @@ -464,11 +458,11 @@ </funcsynopsis> <para> Deletes the object with the given object id in the second - parameter. It will delete all instances of the object. + parameter. It will delete all instances of the object.</para> <para> - Returns TRUE if no error occurs otherwise FALSE. + Returns TRUE if no error occurs otherwise FALSE.</para> <para> - See also <function>hw_mv</function>. + See also <function>hw_mv</function>.</para> </refsect1> </refentry> @@ -486,7 +480,7 @@ </funcsynopsis> <para> Returns an th object id of the document to - which <parameter>anchorID</parameter> belongs. + which <parameter>anchorID</parameter> belongs.</para> </refsect1> </refentry> @@ -504,7 +498,7 @@ </funcsynopsis> <para> Returns an th object record of the document to - which <parameter>anchorID</parameter> belongs. + which <parameter>anchorID</parameter> belongs.</para> </refsect1> </refentry> @@ -520,10 +514,10 @@ <paramdef>int <parameter>hw_document</parameter></paramdef> </funcsynopsis> <para> - Returns the object record of the document. + Returns the object record of the document.</para> <para> See also <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>. + <function>hw_DocumentSize</function>.</para> </refsect1> </refentry> @@ -540,10 +534,10 @@ </funcsynopsis> <para> Returns the BODY tag of the document. If the document is an HTML - document the BODY tag should be printed before the document. + document the BODY tag should be printed before the document.</para> <para> See also <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>. + <function>hw_DocumentSize</function>.</para> </refsect1> </refentry> @@ -561,11 +555,11 @@ <para> 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. + from the HEAD and BODY tag is in the stored in the object record.</para> <para> See also <function>hw_DocumentAttributes</function>, <function>hw_DocumentSize</function>, - <function>hw_DocumentSetContent</function>. + <function>hw_DocumentSetContent</function>.</para> </refsect1> </refentry> @@ -588,11 +582,11 @@ If you provide this information in the content of the document too, the Hyperwave server will change the object record accordingly when the document is inserted. Probably not a very good idea. - If this functions fails the document will retain its old content. + If this functions fails the document will retain its old content.</para> <para> See also <function>hw_DocumentAttributes</function>, <function>hw_DocumentSize</function>, - <function>hw_DocumentContent</function>. + <function>hw_DocumentContent</function>.</para> </refsect1> </refentry> @@ -608,10 +602,10 @@ <paramdef>int <parameter>hw_document</parameter></paramdef> </funcsynopsis> <para> - Returns the size in bytes of the document. + Returns the size in bytes of the document.</para> <para> See also <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentAttributes</function>. + <function>hw_DocumentAttributes</function>.</para> </refsect1> </refentry> @@ -629,7 +623,7 @@ <para> Returns a string containing the last error message or 'No Error'. If false is returned, this function failed. - The message relates to the last command. + The message relates to the last command.</para> </refsect1> </refentry> @@ -651,14 +645,14 @@ is edited. This function will only works for pure text documents. It will not open a special data connection and therefore blocks the - control connection during the transfer. + control connection during the transfer.</para> <para> See also <function>hw_PipeDocument</function>, <function>hw_FreeDocument</function>, <function>hw_DocumentBodyTag</function>, <function>hw_DocumentSize</function>, <function>hw_OutputDocument</function>, - <function>hw_GetText</function>. + <function>hw_GetText</function>.</para> </refsect1> </refentry> @@ -675,7 +669,7 @@ </funcsynopsis> <para> Returns the last error number. If the return value is 0 no error has - occurred. The error relates to the last command. + occurred. The error relates to the last command.</para> </refsect1> </refentry> @@ -691,7 +685,7 @@ <paramdef>int <parameter>hw_document</parameter></paramdef> </funcsynopsis> <para> - Frees the memory occupied by the Hyperwave document. + Frees the memory occupied by the Hyperwave document.</para> </refsect1> </refentry> @@ -709,7 +703,7 @@ </funcsynopsis> <para> Returns an indexed array of object ids. Each object id belongs to - a parent of the object with ID <parameter>objectID</parameter>. + a parent of the object with ID <parameter>objectID</parameter>.</para> </refsect1> </refentry> @@ -729,7 +723,7 @@ Returns an indexed array of object records plus an associated array with statistical information about the object records. The associated array is the last entry of the returned array. Each object record belongs to - a parent of the object with ID <parameter>objectID</parameter>. + a parent of the object with ID <parameter>objectID</parameter>.</para> </refsect1> </refentry> @@ -749,10 +743,10 @@ Returns an array of object ids. Each object ID belongs to a child collection of the collection with ID <parameter>objectID</parameter>. The function will not - return child documents. + return child documents.</para> <para> See also <function>hw_GetChildren</function>, - <function>hw_GetChildDocColl</function>. + <function>hw_GetChildDocColl</function>.</para> </refsect1> </refentry> @@ -772,10 +766,10 @@ Returns an array of object records. Each object records belongs to a child collection of the collection with ID <parameter>objectID</parameter>. The function will not return - child documents. + child documents.</para> <para> See also <function>hw_ChildrenObj</function>, - <function>hw_GetChildDocCollObj</function>. + <function>hw_GetChildDocCollObj</function>.</para> </refsect1> </refentry> @@ -803,9 +797,9 @@ the external source. If you want to use this function you should be very familiar with HGIs. You should also consider to use PHP instead of Hyperwave to access external sources. Adding database support - by a Hyperwave gateway should be more difficult than doing it in PHP. + by a Hyperwave gateway should be more difficult than doing it in PHP.</para> <para> - See also <function>hw_GetRemoteChildren</function>. + See also <function>hw_GetRemoteChildren</function>.</para> </refsect1> </refentry> @@ -839,9 +833,9 @@ You should also consider to use PHP instead of Hyperwave to access external sources. Adding database support by a Hyperwave gateway should be more - difficult than doing it in PHP. + difficult than doing it in PHP.</para> <para> - See also <function>hw_GetRemote</function>. + See also <function>hw_GetRemote</function>.</para> </refsect1> </refentry> @@ -860,9 +854,9 @@ <para> Returns the object records of all anchors pointing to the object with ID <parameter>objectID</parameter>. The object can either be a document - or an anchor of type destination. + or an anchor of type destination.</para> <para> - See also <function>hw_GetAnchors</function>. + See also <function>hw_GetAnchors</function>.</para> </refsect1> </refentry> @@ -884,31 +878,31 @@ <parameter>objectID</parameter> if the second parameter is an integer. If the second parameter is an array of integer the function will return an array of object records. In such a case the last - parameter is also evaluated which is a query string. + parameter is also evaluated which is a query string.</para> <para> - The query string has the following syntax: + The query string has the following syntax:</para> <simpara> - &lt;expr> ::= "(" &lt;expr> ")" | <simpara> - "!" &lt;expr> | /* NOT */<simpara> - &lt;expr> "||" &lt;expr> | /* OR */<simpara> - &lt;expr> "&amp;&amp;" &lt;expr> | /* AND */<simpara> - &lt;attribute> &lt;operator> &lt;value><simpara> - - &lt;attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */<simpara> - - &lt;operator> ::= "=" | /* equal */<simpara> - "&lt;" | /* less than (string compare) */<simpara> - ">" | /* greater than (string compare) */<simpara> - "~" /* regular expression matching */<simpara> + &lt;expr> ::= "(" &lt;expr> ")" |</simpara> <simpara> + "!" &lt;expr> | /* NOT */</simpara><simpara> + &lt;expr> "||" &lt;expr> | /* OR */</simpara><simpara> + &lt;expr> "&amp;&amp;" &lt;expr> | /* AND */</simpara><simpara> + &lt;attribute> &lt;operator> &lt;value></simpara><simpara> + + &lt;attribute> ::= /* any attribute name (Title, Author, DocumentType ...) */</simpara><simpara> + + &lt;operator> ::= "=" | /* equal */</simpara><simpara> + "&lt;" | /* less than (string compare) */</simpara><simpara> + ">" | /* greater than (string compare) */</simpara><simpara> + "~" /* regular expression matching */</simpara><simpara></simpara> <para> The query allows to further select certain objects from the list of given objects. Unlike the other query functions, this query may use not indexed attributes. How many object records are returned depends on the query and if access to - the object is allowed. + the object is allowed.</para> <para> See also <function>hw_GetAndLock</function>, - <function>hw_GetObjectByQuery</function>. + <function>hw_GetObjectByQuery</function>.</para> </refsect1> </refentry> @@ -928,10 +922,10 @@ Returns the object record for the object with ID <parameter>objectID</parameter>. It will also lock the object, so other users cannot access - it until it is unlocked. + it until it is unlocked.</para> <para> See also <function>hw_Unlock</function>, - <function>hw_GetObject</function>. + <function>hw_GetObject</function>.</para> </refsect1> </refentry> @@ -971,7 +965,7 @@ All links will have the prefix '/my_script.php3/'. If you do not want this you can set the optional parameter <parameter>rootID/prefix</parameter> to any prefix which - is used instead. Is this case it has to be a string. + is used instead. Is this case it has to be a string.</para> <para> If <parameter>rootID/prefix</parameter> is an integer and unequal to 0 the link is constructed from all the names @@ -983,17 +977,17 @@ located at 'a-b-d-source' the resulting HTML link would be: &lt;A HREF="../c/internet_movie">. This is useful if you want to download the whole server content onto disk and map - the document hierachy onto the file system. + the document hierachy onto the file system.</para> <para> This function will only work for pure text documents. It will not open a special data connection and therefore blocks the - control connection during the transfer. + control connection during the transfer.</para> <para> See also <function>hw_PipeDocument</function>, <function>hw_FreeDocument</function>, <function>hw_DocumentBodyTag</function>, <function>hw_DocumentSize</function>, - <function>hw_OutputDocument</function>. + <function>hw_OutputDocument</function>.</para> </refsect1> </refentry> @@ -1014,11 +1008,11 @@ Searches for objects on the whole server and returns an array of object ids. The maximum number of matches is limited to <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited.</para> <para> - The query will only work with indexed attributes. + The query will only work with indexed attributes.</para> <para> - See also <function>hw_GetObjectByQueryObj</function>. + See also <function>hw_GetObjectByQueryObj</function>.</para> </refsect1> </refentry> @@ -1039,11 +1033,11 @@ Searches for objects on the whole server and returns an array of object records. The maximum number of matches is limited to <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited.</para> <para> - The query will only work with indexed attributes. + The query will only work with indexed attributes.</para> <para> - See also <function>hw_GetObjectByQuery</function>. + See also <function>hw_GetObjectByQuery</function>.</para> </refsect1> </refentry> @@ -1067,11 +1061,11 @@ object ids. The maximum number of matches is limited to <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited.</para> <para> - The query will only work with indexed attributes. + The query will only work with indexed attributes.</para> <para> - See also <function>hw_GetObjectByQueryCollObj</function>. + See also <function>hw_GetObjectByQueryCollObj</function>.</para> </refsect1> </refentry> @@ -1095,11 +1089,11 @@ object records. The maximum number of matches is limited to <parameter>max_hits</parameter>. If <parameter>max_hits</parameter> - is set to -1 the maximum number of matches is unlimited. + is set to -1 the maximum number of matches is unlimited.</para> <para> - The query will only work with indexed attributes. + The query will only work with indexed attributes.</para> <para> - See also <function>hw_GetObjectByQueryColl</function>. + See also <function>hw_GetObjectByQueryColl</function>.</para> </refsect1> </refentry> @@ -1116,10 +1110,10 @@ <paramdef>int <parameter>objectID</parameter></paramdef> </funcsynopsis> <para> - Returns array of object ids for child documents of a collection. + Returns array of object ids for child documents of a collection.</para> <para> See also <function>hw_GetChildren</function>, - <function>hw_GetChildColl</function>. + <function>hw_GetChildColl</function>.</para> </refsect1> </refentry> @@ -1136,10 +1130,10 @@ <paramdef>int <parameter>objectID</parameter></paramdef> </funcsynopsis> <para> - Returns an array of object records for child documents of a collection. + Returns an array of object records for child documents of a collection.</para> <para> See also <function>hw_ChildrenObj</function>, - <function>hw_GetChildCollObj</function>. + <function>hw_GetChildCollObj</function>.</para> </refsect1> </refentry> @@ -1157,7 +1151,7 @@ </funcsynopsis> <para> Returns an array of object ids with anchors of the document - with object ID <parameter>objectID</parameter>. + with object ID <parameter>objectID</parameter>.</para> </refsect1> </refentry> @@ -1175,7 +1169,7 @@ </funcsynopsis> <para> Returns an array of object records with anchors of the document - with object ID <parameter>objectID</parameter>. + with object ID <parameter>objectID</parameter>.</para> </refsect1> </refentry> @@ -1200,12 +1194,12 @@ If the destination id is 0 the objects will be unlinked from the source collection. If this is the last instance of that object it will be deleted. If you want to delete all instances - at once, use <function>hw_deleteobject</function>. + at once, use <function>hw_deleteobject</function>.</para> <para> - The value return is the number of moved objects. + The value return is the number of moved objects.</para> <para> See also <function>hw_cp</function>, - <function>hw_deleteobject</function>. + <function>hw_deleteobject</function>.</para> </refsect1> </refentry> @@ -1226,9 +1220,9 @@ <parameter>password</parameter>. Identification is only valid for the current session. I do not thing this function will be needed very often. In most cases it will - be easier to identify with the opening of the connection. + be easier to identify with the opening of the connection.</para> <para> - See also <function>hw_Connect</function>. + See also <function>hw_Connect</function>.</para> </refsect1> </refentry> @@ -1258,8 +1252,8 @@ set of collections that have one or more objects of this subset as children are returned as an array. This option allows a client to, e.g., highlight the part of the collection hierarchy that contains - the matches of a previous query, in a graphical overview. - <para> + the matches of a previous query, in a graphical overview.</para> + <para></para> </refsect1> </refentry> @@ -1278,7 +1272,7 @@ Returns information about the current connection. The returned string has the following format: &lt;Serverstring&gt;, &lt;Host&gt;, &lt;Port&gt;, &lt;Username&gt;, &lt;Port of Client&gt;, - &lt;Byte swapping&gt; + &lt;Byte swapping&gt;</para> </refsect1> </refentry> @@ -1298,7 +1292,7 @@ <para> Inserts a new collection with attributes as in <parameter>object_array</parameter> into - collection with object ID <parameter>objectID</parameter>. + collection with object ID <parameter>objectID</parameter>.</para> </refsect1> </refentry> @@ -1323,10 +1317,10 @@ an object record only or an object record and a pure ascii text in <parameter>text</parameter> if <parameter>text</parameter> is given. If you want to insert a general document of any kind use - <function>hw_insertdocument</function> instead. + <function>hw_insertdocument</function> instead.</para> <para> See also <function>hw_InsertDocument</function>, - <function>hw_InsColl</function>. + <function>hw_InsColl</function>.</para> </refsect1> </refentry> @@ -1351,9 +1345,9 @@ the object record of the new document contains at least the attributes: Type, DocumentType, Title and Name. Possibly you also want to set the MimeType. The functions returns the - object id of the new document or false. + object id of the new document or false.</para> <para> - See also <function>hw_PipeDocument</function>. + See also <function>hw_PipeDocument</function>.</para> </refsect1> </refentry> @@ -1373,17 +1367,17 @@ <para> Inserts an object into the server. The object can be any valid hyperwave object. See the HG-CSP documentation - for a detailed information on how the parameters have to be. + for a detailed information on how the parameters have to be.</para> <para> Note: If you want to insert an Anchor, the attribute Position has always been set either to a start/end value or to 'invisible'. Invisible positions are needed if the annotation - has no correspondig link in the annotation text. + has no correspondig link in the annotation text.</para> <para> See also <function>hw_PipeDocument</function>, <function>hw_InsertDocument</function>, <function>hw_InsDoc</function>, - <function>hw_InsColl</function>. + <function>hw_InsColl</function>.</para> </refsect1> </refentry> @@ -1412,14 +1406,14 @@ to add. In order to modify an attribute one will have to remove the old one and add a new one. <function>hw_modifyobject</function> will always remove the attributes before it adds attributes unless - the value of the attribute to remove is not a string or array. + the value of the attribute to remove is not a string or array.</para> <para> The last parameter determines if the modification is performed recursively. 1 means recurive modification. If some of the objects cannot be modified they will be skiped without notice. <function>hw_error</function> may not indicate an error though - some of the objects could not be modified. + some of the objects could not be modified.</para> <para> The keys of both arrays are the attributes name. The value of each @@ -1437,7 +1431,7 @@ removed which would fail since it doesn't exist. The following addition of a new value for that attribute would also fail. Setting the value for that attribute to e.g. 0 would not even try to remove it and - the addition will work. + the addition will work.</para> <para> If you would like to change the attribute 'Name' with the current @@ -1466,7 +1460,7 @@ $addarr = array("Name" => "articles"); $hw_modifyobject($connect, $objid, $remarr, $addarr); </programlisting> - </example> + </example></para> <para> <note> <simpara> @@ -1474,7 +1468,7 @@ ways. Either by providing the attributes value in its native form 'language':'title' or by providing an array with elements for each language as described above. The above example would - than be: + than be:</simpara> </note> <example> <title>modifying Title attribute</title> @@ -1511,7 +1505,7 @@ <note> <simpara> If you need to delete all attributes with a certain name you - will have to pass an empty string as the attribute value. + will have to pass an empty string as the attribute value.</simpara> </note> <note><simpara> Only the attributes 'Title', 'Description' and 'Keyword' will @@ -1528,9 +1522,9 @@ You may not suround this function by calls to <function>hw_getandlock</function> and <function>hw_unlock</function>. <function>hw_modifyobject</function> does this internally. - </simpara></note> + </simpara></note></para> <para> - Returns TRUE if no error occurs otherwise FALSE. + Returns TRUE if no error occurs otherwise FALSE.</para> </refsect1> </refentry> @@ -1553,13 +1547,13 @@ <parameter>object_record</parameter>. The length of the <parameter>document_data</parameter> has to passed in <parameter>document_size</parameter>This function does not - insert the document into the Hyperwave server. + insert the document into the Hyperwave server.</para> <para> See also <function>hw_FreeDocument</function>, <function>hw_DocumentSize</function>, <function>hw_DocumentBodyTag</function>, <function>hw_OutputDocument</function>, - <function>hw_InsertDocument</function>. + <function>hw_InsertDocument</function>.</para> </refsect1> </refentry> @@ -1582,9 +1576,9 @@ attribute value. Currently only the attributes 'Title', 'Description' and 'Keyword' are treated properly. Other multiple attributes form an index array. Currently only the attribute 'Group' is handled - properly. + properly.</para> <para> - See also <function>hw_array2objrec</function>. + See also <function>hw_array2objrec</function>.</para> </refsect1> </refentry> @@ -1600,7 +1594,7 @@ <paramdef>int <parameter>hw_document</parameter></paramdef> </funcsynopsis> <para> - Prints the document without the BODY tag. + Prints the document without the BODY tag.</para> </refsect1> </refentry> @@ -1628,9 +1622,9 @@ the server will be done. It is similar to identify as user anonymous. This function returns a connection index that is needed by other Hyperwave functions. You can have - multiple persistent connections open at once. + multiple persistent connections open at once.</para> <para> - See also <function>hw_Connect</function>. + See also <function>hw_Connect</function>.</para> </refsect1> </refentry> @@ -1651,13 +1645,13 @@ <parameter>objectID</parameter>. If the document has anchors which can be inserted, they will have been inserted already. The document will be transfered via a special data connection which - does not block the control connection. + does not block the control connection.</para> <para> See also <function>hw_GetText</function> for more on link insertion, <function>hw_FreeDocument</function>, <function>hw_DocumentSize</function>, <function>hw_DocumentBodyTag</function>, - <function>hw_OutputDocument</function>. + <function>hw_OutputDocument</function>.</para> </refsect1> </refentry> @@ -1675,7 +1669,7 @@ <para> Returns the object ID of the hyperroot collection. Currently this is always 0. The child collection of the hyperroot is the root - collection of the connected server. + collection of the connected server.</para> </refsect1> </refentry> @@ -1692,9 +1686,9 @@ <paramdef>int <parameter>objectID</parameter></paramdef> </funcsynopsis> <para> - Unlocks a document, so other users regain access. + Unlocks a document, so other users regain access.</para> <para> - See also <function>hw_GetAndLock</function>. + See also <function>hw_GetAndLock</function>.</para> </refsect1> </refentry> @@ -1713,7 +1707,7 @@ Returns an array of users currently logged into the Hyperwave server. Each entry in this array is an array itself containing the elements id, name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' - is 1 if this entry belongs to the user who initianted the request. + is 1 if this entry belongs to the user who initianted the request.</para> </refsect1> </refentry> @@ -1729,7 +1723,7 @@ <paramdef>int <parameter>connection</parameter></paramdef> </funcsynopsis> <para> - Returns the username of the connection. + Returns the username of the connection.</para> </refsect1> </refentry> Index: phpdoc/functions/ibase.sgml diff -u phpdoc/functions/ibase.sgml:1.2 phpdoc/functions/ibase.sgml:1.3 --- phpdoc/functions/ibase.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/ibase.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.ibase"> <title>InterBase functions</title> <titleabbrev>InterBase</titleabbrev> Index: phpdoc/functions/icap.sgml diff -u phpdoc/functions/icap.sgml:1.3 phpdoc/functions/icap.sgml:1.4 --- phpdoc/functions/icap.sgml:1.3 Mon Aug 23 16:57:04 1999 +++ phpdoc/functions/icap.sgml Wed Oct 20 18:41:42 1999 @@ -6,9 +6,8 @@ <simpara> To get these functions to work, you have to compile PHP with <option role="configure">--with-icap</option>. That requires the - icap library to be installed. Grab the latest version from <ulink - url="http://icap.chek.com/">http://icap.chek.com/</ulink> and - compile and install it. + icap library to be installed. Grab the latest version from <ulink url="http://icap.chek.com/">http://icap.chek.com/</ulink> and + compile and install it.</simpara> </partintro> <refentry id="function.icap-open"> @@ -26,13 +25,13 @@ <paramdef>string<parameter>options</parameter></paramdef> </funcsynopsis> <para> - Returns an ICAP stream on success, false on error. + Returns an ICAP stream on success, false on error.</para> <para> <function>icap_open</function> opens up an ICAP connection to the specified <parameter>calendar</parameter> store. If the optional <parameter>options</parameter> is specified, passes the - <parameter>options</parameter> to that mailbox also. - <para> + <parameter>options</parameter> to that mailbox also.</para> + <para></para> </refsect1> </refentry> @@ -50,7 +49,7 @@ <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> - Closes the given icap stream. + Closes the given icap stream.</para> </refsect1> </refentry> @@ -69,45 +68,45 @@ </funcsynopsis> <para> <function>icap_fetch_event</function> fetches an event from the - calendar stream specified by <parameter>id</parameter>. + calendar stream specified by <parameter>id</parameter>.</para> <para> Returns an event object consisting of: <itemizedlist> <listitem><simpara> - int id - ID of that event. + int id - ID of that event.</simpara></listitem> <listitem><simpara> - int public - TRUE if the event if public, FALSE if it is private. + int public - TRUE if the event if public, FALSE if it is private.</simpara></listitem> <listitem><simpara> - string category - Category string of the event. + string category - Category string of the event.</simpara></listitem> <listitem><simpara> - string title - Title string of the event. + string title - Title string of the event.</simpara></listitem> <listitem><simpara> - string description - Description string of the event. + string description - Description string of the event.</simpara></listitem> <listitem><simpara> int alarm - number of minutes before the event to send an - alarm/reminder. + alarm/reminder.</simpara></listitem> <listitem><simpara> - object start - Object containing a datetime entry. + object start - Object containing a datetime entry.</simpara></listitem> <listitem><simpara> - object end - Object containing a datetime entry. + object end - Object containing a datetime entry.</simpara></listitem> </itemizedlist> All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> - int year - year + int year - year</simpara></listitem> <listitem><simpara> - int month - month + int month - month</simpara></listitem> <listitem><simpara> - int mday - day of month + int mday - day of month</simpara></listitem> <listitem><simpara> - int hour - hour + int hour - hour</simpara></listitem> <listitem><simpara> - int min - minutes + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - seconds - </itemizedlist> + int sec - seconds</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -131,29 +130,29 @@ </funcsynopsis> <para> Returns an array of event ID's that are between the two given - datetimes. + datetimes.</para> <para> <function>icap_list_events</function> 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. + returned.</para> <para> All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> - int year - year + int year - year</simpara></listitem> <listitem><simpara> - int month - month + int month - month</simpara></listitem> <listitem><simpara> - int mday - day of month + int mday - day of month</simpara></listitem> <listitem><simpara> - int hour - hour + int hour - hour</simpara></listitem> <listitem><simpara> - int min - minutes + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - seconds - </itemizedlist> + int sec - seconds</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -177,42 +176,42 @@ <itemizedlist> <listitem><simpara> - int public - 1 if public, 0 if private; + int public - 1 if public, 0 if private;</simpara></listitem> <listitem><simpara> - string caegory - Category string of the event. + string caegory - Category string of the event.</simpara></listitem> <listitem><simpara> - string title - Title string of the event. + string title - Title string of the event.</simpara></listitem> <listitem><simpara> - string description - Description string of the event. + string description - Description string of the event.</simpara></listitem> <listitem><simpara> - int alarm - Number of minutes before the event to sned out an alarm. + int alarm - Number of minutes before the event to sned out an alarm.</simpara></listitem> <listitem><simpara> - datetime start - datetime object of the start of the event. + datetime start - datetime object of the start of the event.</simpara></listitem> <listitem><simpara> - datetime end - datetime object of the end of the event. - </itemizedlist> + datetime end - datetime object of the end of the event.</simpara></listitem> + </itemizedlist></para> <para> All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> - int year - year + int year - year</simpara></listitem> <listitem><simpara> - int month - month + int month - month</simpara></listitem> <listitem><simpara> - int mday - day of month + int mday - day of month</simpara></listitem> <listitem><simpara> - int hour - hour + int hour - hour</simpara></listitem> <listitem><simpara> - int min - minutes + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - seconds - </itemizedlist> + int sec - seconds</simpara></listitem> + </itemizedlist></para> <para> - Returns true on success and false on error. - <para> + Returns true on success and false on error.</para> + <para></para> </refsect1> </refentry> @@ -230,9 +229,9 @@ </funcsynopsis> <para> <function>icap_delete_event</function> deletes the calendar event - specified by the uid. + specified by the uid.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -249,9 +248,9 @@ </funcsynopsis> <para> <function>icap_snooze</function> turns off an alarm for a - calendar event specified by the uid. + calendar event specified by the uid.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -272,27 +271,27 @@ </funcsynopsis> <para> Returns an array of event ID's that has an alarm going off at the - given datetime. + given datetime.</para> <para> <function>icap_list_alarms</function> 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. + an alarm should be going off at the datetime are returned.</para> <para> All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> - int year - year + int year - year</simpara></listitem> <listitem><simpara> - int month - month + int month - month</simpara></listitem> <listitem><simpara> - int mday - day of month + int mday - day of month</simpara></listitem> <listitem><simpara> - int hour - hour + int hour - hour</simpara></listitem> <listitem><simpara> - int min - minutes + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - seconds - </itemizedlist> + int sec - seconds</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> Index: phpdoc/functions/ifx.sgml diff -u phpdoc/functions/ifx.sgml:1.4 phpdoc/functions/ifx.sgml:1.5 --- phpdoc/functions/ifx.sgml:1.4 Sat Jul 31 20:37:07 1999 +++ phpdoc/functions/ifx.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.ifx"> <title>Informix functions</title> <titleabbrev>Informix</titleabbrev> @@ -162,7 +161,7 @@ <programlisting role="php3"> $conn_id = ifx_pconnect (mydb@ol_srv1, "imyself", "mypassword"); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -184,27 +183,27 @@ </funcsynopsis> <para> Returns: A positive Informix persistent link identifier on success, - or false on error + or false on error</para> <para> <function>ifx_pconnect</function> acts very much like - <function>ifx_connect</function> with two major differences. + <function>ifx_connect</function> with two major differences.</para> <para> This function behaves exactly like <function>ifx_connect</function> when PHP is not running as an Apache module. First, when connecting, the function would first try to find a (persistent) link that's already open with the same host, username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. + will be returned instead of opening a new connection.</para> <para> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<function>ifx_close</function> will not - close links established by <function>ifx_pconnect</function>). + close links established by <function>ifx_pconnect</function>).</para> <para> - This type of links is therefore called 'persistent'. + This type of links is therefore called 'persistent'.</para> <para> See also: - <function>ifx_connect</function>. + <function>ifx_connect</function>.</para> </refsect1> </refentry> @@ -221,19 +220,19 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns: always true. + Returns: always true.</para> <para> <function>ifx_close</function> closes the link to an Informix database that's associated with the specified link identifier. If the link identifier isn't specified, the last opened link is - assumed. + assumed.</para> <para> Note that this isn't usually necessary, as non-persistent open links are automatically closed at the end of the script's - execution. + execution.</para> <para> <function>ifx_close</function> will not close persistent links - generated by <function>ifx_pconnect</function>. + generated by <function>ifx_pconnect</function>.</para> <para> See also: <function>ifx_connect</function>, and <function>ifx_pconnect</function>. @@ -244,7 +243,7 @@ ... some queries and stuff ... ifx_close($conn_id); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -324,7 +323,7 @@ </example> <example> <title>Insert some values into the "catalog" table</title> - <programlisting role=php3> + <programlisting role="php3"> // create blob id's for a byte and text column $textid = ifx_create_blob(0, 0, "Text column in memory"); $byteid = ifx_create_blob(1, 0, "Byte column in memory"); @@ -341,7 +340,7 @@ // free result id ifx_free_result($res_id); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -391,7 +390,7 @@ (integer value). You can get the value of the blob as a string or file with the blob functions (see below). </para><para> - See also: <function>ifx_do</function>. + See also: <function>ifx_do</function>.</para> </refsect1> </refentry> @@ -417,7 +416,7 @@ <function>ifx_affected_rows</function> for non-select statements for retrieval by <function>ifx_affected_rows</function> </para><para> - See also: <function>ifx_prepare</function>. There is a example. + See also: <function>ifx_prepare</function>. There is a example.</para> </refsect1> </refentry> @@ -1263,4 +1262,3 @@ sgml-local-ecat-files:nil End: --> - Index: phpdoc/functions/image.sgml diff -u phpdoc/functions/image.sgml:1.5 phpdoc/functions/image.sgml:1.6 --- phpdoc/functions/image.sgml:1.5 Mon Sep 6 00:22:22 1999 +++ phpdoc/functions/image.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.image"> <title>Image functions</title> <titleabbrev>Graphics</titleabbrev> @@ -6,9 +5,8 @@ <partintro> <simpara> You can use the image functions in PHP to get the size of JPEG, GIF, and - PNG images, and if you have the GD library (available at <ulink - url="&url.gd;">&url.gd;</ulink>) you will also be able to create and - manipulate images. + PNG images, and if you have the GD library (available at <ulink url="&url.gd;">&url.gd;</ulink>) you will also be able to create and + manipulate images.</simpara> </partintro> <refentry id="function.getimagesize"> @@ -29,7 +27,7 @@ <acronym>PNG</acronym> image file and return the dimensions along with the file type and a height/width text string to be used inside a normal <acronym>HTML</acronym> <sgmltag>IMG</sgmltag> - tag. + tag.</para> <para> Returns an array with 4 elements. Index 0 contains the width of @@ -42,15 +40,14 @@ <programlisting> &lt;?php $size = GetImageSize("img/flag.jpg"); ?> &lt;IMG SRC="img/flag.jpg" &lt;?php echo $size[3]; ?>> -</programlisting></example> +</programlisting></example></para> <para> The optional <parameter>imageinfo</parameter> parameter allows you to extract some extended information from the image file. Currently this will return the diffrent <acronym>JPG</acronym> APP markers in an associative Array. Some Programs use these APP markers to embedd text - information in images. A very common one in to embed IPTC <ulink - url="&url.iptc;">&url.iptc;</ulink> information in the APP13 marker. You + information in images. A very common one in to embed IPTC <ulink url="&url.iptc;">&url.iptc;</ulink> information in the APP13 marker. You can use the <function>iptcparse</function> function to parse the binary APP13 marker into something readable. <example> @@ -67,7 +64,7 @@ <note><simpara> This function does not require the GD image library. - </simpara></note> + </simpara></note></para> </refsect1> </refentry> @@ -95,7 +92,7 @@ 0,0) in the image represented by im. w and h specifies the ellipse's width and height respectively while the start and end points are specified in degrees indicated by the s and e - arguments. + arguments.</para> </refsect1> </refentry> @@ -121,9 +118,9 @@ identified by <parameter>id</parameter> with its upper-left at <parameter>x</parameter>,<parameter>y</parameter> (top left is 0,0) with the color <parameter>col</parameter>. If font is 1, 2, 3, 4 or 5, a built-in font is - used (with higher numbers corresponding to larger fonts). + used (with higher numbers corresponding to larger fonts).</para> <para> - See also <function>imageloadfont</function>. + See also <function>imageloadfont</function>.</para> </refsect1> </refentry> @@ -147,8 +144,8 @@ <para> ImageCharUp draws the character c vertically in the image identified by im at coordinates x, y (top left is 0, 0) with the color col. - If font is 1, 2, 3, 4 or 5, a built-in font is used. - <para> See also <function>imageloadfont</function>. + If font is 1, 2, 3, 4 or 5, a built-in font is used.</para> + <para> See also <function>imageloadfont</function>.</para> </refsect1> </refentry> @@ -174,7 +171,7 @@ <informalexample><programlisting> $white = ImageColorAllocate($im, 255,255,255); $black = ImageColorAllocate($im, 0,0,0); -</programlisting></informalexample> +</programlisting></informalexample></para> </refsect1> </refentry> @@ -193,10 +190,10 @@ </funcsynopsis> <para> Returns the index of the color of the pixel at the - specified location in the image. + specified location in the image.</para> <para> See also <function>imagecolorset</function> and - <function>imagecolorsforindex</function>. + <function>imagecolorsforindex</function>.</para> </refsect1> </refentry> @@ -216,13 +213,13 @@ </funcsynopsis> <para> Returns the index of the color in the palette of the image - which is "closest" to the specified RGB value. + which is "closest" to the specified RGB value.</para> <para> The "distance" between the desired color and each color in the palette is calculated as if the RGB values represented points in three-dimensional - space. + space.</para> <para> - See also <function>imagecolorexact</function>. + See also <function>imagecolorexact</function>.</para> </refsect1> </refentry> @@ -241,11 +238,11 @@ <paramdef>int <parameter>blue</parameter></paramdef> </funcsynopsis> <para> - Returns the index of the specified color in the palette of the image. + Returns the index of the specified color in the palette of the image.</para> <para> - If the color does not exist in the image's palette, -1 is returned. + If the color does not exist in the image's palette, -1 is returned.</para> <para> - See also <function>imagecolorclosest</function>. + See also <function>imagecolorclosest</function>.</para> </refsect1> </refentry> @@ -265,9 +262,9 @@ </funcsynopsis> <para> This function is guaranteed to return a color index for a requested color, either the exact color - or the closest possible alternative. + or the closest possible alternative.</para> <para> - See also <function>imagecolorclosest</function>. + See also <function>imagecolorclosest</function>.</para> </refsect1> </refentry> @@ -290,9 +287,9 @@ This sets the specified index in the palette to the specified color. This is useful for creating flood-fill-like effects in paletted images without the overhead of performing the actual - flood-fill. + flood-fill.</para> <para> - See also <function>imagecolorat</function>. + See also <function>imagecolorat</function>.</para> </refsect1> </refentry> @@ -310,10 +307,10 @@ </funcsynopsis> <para> This returns an associative array with red, green, and blue keys - that contain the appropriate values for the specified color index. + that contain the appropriate values for the specified color index.</para> <para> See also <function>imagecolorat</function> and - <function>imagecolorexact</function>. + <function>imagecolorexact</function>.</para> </refsect1> </refentry> @@ -329,10 +326,10 @@ <paramdef>int <parameter>im</parameter></paramdef> </funcsynopsis> <para> - This returns the number of colors in the specified image's palette. + This returns the number of colors in the specified image's palette.</para> <para> See also <function>imagecolorat</function> and - <function>imagecolorsforindex</function>. + <function>imagecolorsforindex</function>.</para> </refsect1> </refentry> @@ -352,10 +349,10 @@ ImageColorTransparent sets the transparent color in the im image to col. im is the image identifier returned by <function>imagecreate</function> and col is a color identifier returned by - <function>imagecolorallocate</function>. + <function>imagecolorallocate</function>.</para> <para> The identifier of the new (or current, if none is specified) transparent - color is returned. + color is returned.</para> </refsect1> </refentry> @@ -389,7 +386,7 @@ upper left corner. This function can be used to copy regions within the same image (if <parameter>dst_im</parameter> is the same as <parameter>src_im</parameter>) but if the regions overlap - the results will be unpredictable. + the results will be unpredictable.</para> </refsect1> </refentry> @@ -406,7 +403,7 @@ <paramdef>int <parameter>y_size</parameter></paramdef> </funcsynopsis> <para> ImageCreate returns an image identifier representing a blank image - of size x_size by y_size. + of size x_size by y_size.</para> </refsect1> </refentry> @@ -423,7 +420,7 @@ </funcsynopsis> <para> <function>imagecreatefromgif</function> returns an image identifier - representing the image obtained from the given filename. + representing the image obtained from the given filename.</para> <para> <function>imagecreatefromgif</function> returns an empty string on failure. It also outputs an error message, which unfortunately @@ -431,7 +428,7 @@ following example will produce an error GIF: <example> <title>Example to handle an error during creation (courtesy vic@zymsys.com )</title> - <programlisting role=php> + <programlisting role="php"> function LoadGif($imgname) { $im = @imagecreatefromgif($imgname); /* Attempt to open */ @@ -449,8 +446,8 @@ <para> Since all GIF support was removed from the GD library in version 1.6, this function is not available if you are using that version of the - GD library. - </note> + GD library.</para> + </note></para> </refsect1> </refentry> @@ -473,8 +470,8 @@ <para> ImageLine draws a dashed line from x1,y1 to x2,y2 (top left is 0,0) in image im of color - col. - <para> See also <function>imageline</function>. + col.</para> + <para> See also <function>imageline</function>.</para> </refsect1> </refentry> @@ -491,7 +488,7 @@ </funcsynopsis> <para> ImageDestroy frees any memory associated with image im. im is the image identifier returned by the <function>imagecreate</function> - function. + function.</para> </refsect1> </refentry> @@ -509,7 +506,7 @@ <paramdef>int <parameter>y</parameter></paramdef> <paramdef>int <parameter>col</parameter></paramdef> </funcsynopsis> -<para> ImageFill performs a flood fill starting at coordinate x, y (top left is 0,0) with color col in the image im. +<para> ImageFill performs a flood fill starting at coordinate x, y (top left is 0,0) with color col in the image im.</para> </refsect1> </refentry> @@ -531,7 +528,7 @@ polygon's vertices, ie. points[0] = x0, points[1] = y0, points[2] = x1, points[3] = y1, etc. num_points is the - total number of vertices. + total number of vertices.</para> </refsect1> </refentry> @@ -554,7 +551,7 @@ <para> ImageFilledRectangle creates a filled rectangle of color col in image im starting at upper left coordinates x1, y1 and ending at bottom right coordinates x2, y2. 0, 0 is the - top left corner of the image. + top left corner of the image.</para> </refsect1> </refentry> @@ -577,7 +574,7 @@ defined by border. The starting point for the fill is x,y (top left is 0,0) and the region is filled with color - col. + col.</para> </refsect1> </refentry> @@ -593,10 +590,10 @@ <paramdef>int <parameter>font</parameter></paramdef> </funcsynopsis> <para> - Returns the pixel height of a character in the specified font. + Returns the pixel height of a character in the specified font.</para> <para> See also <function>imagefontwidth</function> and - <function>imageloadfont</function>. + <function>imageloadfont</function>.</para> </refsect1> </refentry> @@ -611,8 +608,8 @@ <funcdef>int <function>imagefontwidth</function></funcdef> <paramdef>int <parameter>font</parameter></paramdef> </funcsynopsis> -<para> Returns the pixel width of a character in font. - <para> See also <function>imagefontheight</function> and <function>imageloadfont</function>. +<para> Returns the pixel width of a character in font.</para> + <para> See also <function>imagefontheight</function> and <function>imageloadfont</function>.</para> </refsect1> </refentry> @@ -632,11 +629,11 @@ <function>imagegif</function> creates the GIF file in filename from the image <parameter>im</parameter>. The <parameter>im</parameter> argument is the return from the <function>imagecreate</function> - function. + function.</para> <para> The image format will be GIF87a unless the image has been made transparent with <function>imagecolortransparent</function>, in - which case the image format will be GIF89a. + which case the image format will be GIF89a.</para> <para> The filename argument is optional, and if left off, the raw image stream will be output directly. By sending an image/gif content-type @@ -646,8 +643,8 @@ <para> Since all GIF support was removed from the GD library in version 1.6, this function is not available if you are using that version of the - GD library. - </note> + GD library.</para> + </note></para> </refsect1> </refentry> @@ -667,9 +664,9 @@ <para> <function>ImageInterlace</function> turns the interlace bit on or off. If interlace is 1 the im image will be interlaced, and if interlace - is 0 the interlace bit is turned off. + is 0 the interlace bit is turned off.</para> <para> - This functions returns whether the interlace bit is set for the image. + This functions returns whether the interlace bit is set for the image.</para> </refsect1> </refentry> @@ -692,8 +689,8 @@ <para> ImageLine draws a line from x1,y1 to x2,y2 (top left is 0,0) in image im of color - col. - <para> See also <function>imagecreate</function> and <function>imagecolorallocate</function>. + col.</para> + <para> See also <function>imagecreate</function> and <function>imagecolorallocate</function>.</para> </refsect1> </refentry> @@ -711,12 +708,12 @@ <para> ImageLoadFont loads a user-defined bitmap font and returns an identifier for the font (that is always greater than 5, so it will - not conflict with the built-in fonts). + not conflict with the built-in fonts).</para> <para> The font file format is currently binary and architecture dependent. This means you should generate the font files on the - same type of CPU as the machine you are running PHP on. + same type of CPU as the machine you are running PHP on.</para> <para> <table> @@ -763,11 +760,11 @@ </tbody> </tgroup> - </table> + </table></para> <para> See also <function>ImageFontWidth</function> and - <function>ImageFontHeight</function>. + <function>ImageFontHeight</function>.</para> </refsect1> </refentry> @@ -788,8 +785,8 @@ </funcsynopsis> <para> ImagePolygon creates a polygon in image id. points is a PHP array containing the polygon's vertices, ie. points[0] = x0, points[1] = y0, - points[2] = x1, points[3] = y1, etc. num_points is the total number of vertices. - <para> See also <function>imagecreate</function>. + points[2] = x1, points[3] = y1, etc. num_points is the total number of vertices.</para> + <para> See also <function>imagecreate</function>.</para> </refsect1> </refentry> @@ -810,26 +807,26 @@ <paramdef>float <parameter>angle</parameter></paramdef> </funcsynopsis> <para> - <parameter>size</parameter> is expressed in pixels. + <parameter>size</parameter> is expressed in pixels.</para> <para> <parameter>space</parameter> allows you to change the default value of a space in a font. - This amount is added to the normal value and can also be negative. + This amount is added to the normal value and can also be negative.</para> <para> <parameter>tightness</parameter> allows you to control the amount of white space - between characters. This amount is added to the normal character width and can also be negative. + between characters. This amount is added to the normal character width and can also be negative.</para> <para> - <parameter>angle</parameter> is in degrees. + <parameter>angle</parameter> is in degrees.</para> <para> Parameters <parameter>space</parameter> and <parameter>tightness</parameter> - are expressed in character space units, where 1 unit is 1/1000th of an em-square. + are expressed in character space units, where 1 unit is 1/1000th of an em-square.</para> <para> Parameters <parameter>space</parameter>, <parameter>tightness</parameter> and - <parameter>angle</parameter> are optional. + <parameter>angle</parameter> are optional.</para> <para> The bounding box is calculated using information available from character metrics, and unfortunately tends to differ slightly from the results achieved by actually rasterizing the text. If the angle is 0 degrees, you can expect the text to need - 1 pixel more to every direction. + 1 pixel more to every direction.</para> <para> This function returns an array containing the following elements: <informaltable> @@ -853,9 +850,9 @@ </row> </tbody> </tgroup> - </informaltable> + </informaltable></para> <para> - See also <function>imagepstext</function>. + See also <function>imagepstext</function>.</para> </refsect1> </refentry> @@ -911,13 +908,13 @@ character positions above 127, you'll definitely want to change this if you use an other language than english. The exact format of this file is described in T1libs documentation. T1lib comes with two ready-to-use files, - IsoLatin1.enc and IsoLatin2.enc. + IsoLatin1.enc and IsoLatin2.enc.</para> <para> If you find yourself using this function all the time, a much better way to define the encoding is to set ps.default_encoding in the <link linkend="configuration.file">configuration file</link> to point to the right encoding file and all fonts you load will - automatically have the right encoding. + automatically have the right encoding.</para> </refsect1> </refentry> @@ -933,14 +930,14 @@ <paramdef>int <parameter>fontindex</parameter></paramdef> </funcsynopsis> <para> - See also <function>imagepsloadfont</function>. + See also <function>imagepsloadfont</function>.</para> </refsect1> </refentry> <refentry id="function.imagepsloadfont"> <refnamediv> <refname>ImagePSLoadFont</refname> - <refpurpose>load a PostScript Type 1 from file</refpurpose> + <refpurpose>load a PostScript Type 1 font from file</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -951,9 +948,9 @@ <para> In the case everything went right, a valid font index will be returned and can be used for further purposes. Otherwise the function returns false and - prints a message describing what went wrong. + prints a message describing what went wrong.</para> <para> - See also <function>imagepsfreefont</function>. + See also <function>imagepsfreefont</function>.</para> </refsect1> </refentry> @@ -984,14 +981,14 @@ <optional>antialias_steps</optional></parameter></paramdef> </funcsynopsis> <para> - <parameter>size</parameter> is expressed in pixels. + <parameter>size</parameter> is expressed in pixels.</para> <para> <parameter>foreground</parameter> is the color in which the text will be painted. <parameter>background</parameter> is the color to which the text will try to fade in with antialiasing. No pixels with the color <parameter>background</parameter> are actually painted, so the background image does not need to be of - solid color. + solid color.</para> <para> The coordinates given by <parameter>x</parameter>, <parameter>y</parameter> will define the origin (or reference @@ -1000,31 +997,31 @@ <function>ImageString</function>, where x, y define the upper-right corner of the first character. Refer to PostScipt documentation about fonts and their measuring system if you have - trouble understanding how this works. + trouble understanding how this works.</para> <para> <parameter>space</parameter> allows you to change the default value of a space in a font. This amount is added to the normal - value and can also be negative. + value and can also be negative.</para> <para> <parameter>tightness</parameter> allows you to control the amount of white space between characters. This amount is added to the - normal character width and can also be negative. + normal character width and can also be negative.</para> <para> - <parameter>angle</parameter> is in degrees. + <parameter>angle</parameter> is in degrees.</para> <para> <parameter>antialias_steps</parameter> allows you to control the number of colours used for antialiasing text. Allowed values are 4 and 16. The higher value is recommended for text sizes lower than 20, where the effect in text quality is quite visible. With - bigger sizes, use 4. It's less computationally intensive. + bigger sizes, use 4. It's less computationally intensive.</para> <para> Parameters <parameter>space</parameter> and <parameter>tightness</parameter> are expressed in character space - units, where 1 unit is 1/1000th of an em-square. + units, where 1 unit is 1/1000th of an em-square.</para> <para> Parameters <parameter>space</parameter>, <parameter>tightness</parameter>, <parameter>angle</parameter> - and <parameter>antialias</parameter> are optional. + and <parameter>antialias</parameter> are optional.</para> <para> This function returns an array containing the following elements: <informaltable> @@ -1048,9 +1045,9 @@ </row> </tbody> </tgroup> - </informaltable> + </informaltable></para> <para> - See also <function>imagepsbbox</function>. + See also <function>imagepsbbox</function>.</para> </refsect1> </refentry> @@ -1072,7 +1069,7 @@ </funcsynopsis> <para> ImageRectangle creates a rectangle of color col in image im starting at upper left coordinate x1,y1 and ending at bottom right coordinate x2,y2. 0,0 is the top - left corner of the image. + left corner of the image.</para> </refsect1> </refentry> @@ -1092,8 +1089,8 @@ </funcsynopsis> <para> ImageSetPixel draws a pixel at x,y (top left is 0,0) in image im - of color col. - <para> See also <function>imagecreate</function> and <function>imagecolorallocate</function>. + of color col.</para> + <para> See also <function>imagecreate</function> and <function>imagecolorallocate</function>.</para> </refsect1> </refentry> @@ -1115,8 +1112,8 @@ </funcsynopsis> <para> ImageString draws the string s in the image identified by im at coordinates x,y (top left is 0,0) in color col. If - font is 1, 2, 3, 4 or 5, a built-in font is used. - <para> See also <function>imageloadfont</function>. + font is 1, 2, 3, 4 or 5, a built-in font is used.</para> + <para> See also <function>imageloadfont</function>.</para> </refsect1> </refentry> @@ -1139,8 +1136,8 @@ <para> ImageStringUp draws the string s vertically in the image identified by im at coordinates x,y (top left is 0,0) in color col. - If font is 1, 2, 3, 4 or 5, a built-in font is used. - <para> See also <function>imageloadfont</function>. + If font is 1, 2, 3, 4 or 5, a built-in font is used.</para> + <para> See also <function>imageloadfont</function>.</para> </refsect1> </refentry> @@ -1156,8 +1153,8 @@ <paramdef>int <parameter>im</parameter></paramdef> </funcsynopsis> <para> ImageSX returns the width of the image identified by - im. - <para> See also <function>imagecreate</function> and <function>imagesy</function>. + im.</para> + <para> See also <function>imagecreate</function> and <function>imagesy</function>.</para> </refsect1> </refentry> @@ -1173,9 +1170,9 @@ <paramdef>int <parameter>im</parameter></paramdef> </funcsynopsis> <para> - ImageSY returns the height of the image identified by im. + ImageSY returns the height of the image identified by im.</para> <para>See also <function>imagecreate</function> and - <function>imagesx</function>. + <function>imagesx</function>.</para> </refsect1> </refentry> @@ -1199,21 +1196,21 @@ <variablelist> <varlistentry> <term><parameter>text</parameter></term> - <listitem><simpara>The string to be measured. + <listitem><simpara>The string to be measured.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>size</parameter></term> - <listitem><simpara>The font size. + <listitem><simpara>The font size.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>fontfile</parameter></term> <listitem><simpara>The name of the TrueType font file. (Can - also be an URL.) + also be an URL.)</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>angle</parameter></term> <listitem><simpara>Angle in degrees in which - <parameter>text</parameter> will be measured. + <parameter>text</parameter> will be measured.</simpara></listitem> </varlistentry> </variablelist> @@ -1261,18 +1258,18 @@ </informaltable> The points are relative to the <emphasis>text</emphasis> regardless of the angle, so "upper left" means in the top - left-hand corner seeing the text horizontallty. + left-hand corner seeing the text horizontallty.</para> <para> - This function requires both the GD library and the Freetype library. + This function requires both the GD library and the Freetype library.</para> <para> - See also <function>ImageTTFText</function>. + See also <function>ImageTTFText</function>.</para> </refsect1> </refentry> <refentry id="function.imagettftext"> <refnamediv> <refname>ImageTTFText</refname> - <refpurpose>write text to the image using a TrueType fonts</refpurpose> + <refpurpose>write text to the image using TrueType fonts</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -1293,36 +1290,36 @@ coordinates <parameter>x,y</parameter> (top left is 0,0), at an angle of <parameter>angle</parameter> in color <parameter>col</parameter>, using the TrueType font file - identified by <parameter>fontfile</parameter>. + identified by <parameter>fontfile</parameter>.</para> <para> The coordinates given by <parameter>x</parameter>,<parameter>y</parameter> will define the basepoint of the first character (roughly the lower-left corner of the character). This is different from the <function>ImageString</function>, where x,y define the - upper-right corner of the first character. + upper-right corner of the first character.</para> <para> <parameter>angle</parameter> is in degrees, with 0 degrees being left-to-right reading text (3 o'clock direction), and higher values representing a counter-clockwise rotation. (i.e., a value - of 90 would result in bottom-to-top reading text). + of 90 would result in bottom-to-top reading text).</para> <para> <parameter>fontfile</parameter> is the path to the TrueType font - you wish to use. + you wish to use.</para> <para> <parameter>text</parameter> is the text string which may include UTF-8 character sequences (of the form: &amp;#123; ) to access - characters in a font beyond the first 255. + characters in a font beyond the first 255.</para> <para> <parameter>col</parameter> is the color index. Using the negative - of a color index has the effect of turning off antialiasing. + of a color index has the effect of turning off antialiasing.</para> <para> <function>ImageTTFText</function> returns an array with 8 elements representing four points making the bounding box of the text. The order of the points is upper left, upper right, lower right, lower left. The points are relative to the text regardless of the angle, so "upper left" means in the top - left-hand corner when you see the text horizontallty. + left-hand corner when you see the text horizontallty.</para> <para> This example script will produce a black GIF 400x30 pixels, with the words "Testing..." in white in the font Arial. @@ -1338,13 +1335,12 @@ ImageGif($im); ImageDestroy($im); ?&gt; -</programlisting></example> +</programlisting></example></para> <para> - This function requires both the GD library and the <ulink - url="&url.freetype;">FreeType</ulink> library. + This function requires both the GD library and the <ulink url="&url.freetype;">FreeType</ulink> library.</para> <para> - See also <function>ImageTTFBBox</function>. + See also <function>ImageTTFBBox</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/imap.sgml diff -u phpdoc/functions/imap.sgml:1.5 phpdoc/functions/imap.sgml:1.6 --- phpdoc/functions/imap.sgml:1.5 Thu Aug 19 01:25:33 1999 +++ phpdoc/functions/imap.sgml Wed Oct 20 18:41:42 1999 @@ -6,12 +6,11 @@ <simpara> To get these functions to work, you have to compile PHP with <option role="configure">--with-imap</option>. That requires the c-client library to be - installed. Grab the latest version from <ulink - url="ftp://ftp.cac.washington.edu/imap/">ftp://ftp.cac.washington.edu/imap/</ulink> + installed. Grab the latest version from <ulink url="ftp://ftp.cac.washington.edu/imap/">ftp://ftp.cac.washington.edu/imap/</ulink> and compile it. Then copy c-client/c-client.a to /usr/local/lib or some other directory on your link path and copy c-client/rfc822.h, mail.h and linkage.h to /usr/local/include or some other directory - in your include path. + in your include path.</simpara> </partintro> <refentry id="function.imap-append"> @@ -29,16 +28,16 @@ <paramdef>string<parameter>flags</parameter></paramdef> </funcsynopsis> <para> - Returns true on sucess, false on error. + Returns true on sucess, false on error.</para> <para> <function>imap_append</function> appends a string message to the specified mailbox <parameter>mbox</parameter>. If the optional <parameter>flags</parameter> is specified, writes the - <parameter>flags</parameter> to that mailbox also. + <parameter>flags</parameter> to that mailbox also.</para> <para> When talking to the Cyrus IMAP server, you must use "\r\n" as your end-of-line terminator instead of "\n" or the operation will - fail. + fail.</para> </refsect1> </refentry> @@ -55,7 +54,7 @@ </funcsynopsis> <para> <function>imap_base64</function> function decodes BASE-64 encoded - text. The decoded message is returned as a string. + text. The decoded message is returned as a string.</para> </refsect1> </refentry> @@ -80,13 +79,13 @@ with one or more of the following: <itemizedlist> <listitem><simpara> - FT_UID - The msgno is a UID + FT_UID - The msgno is a UID</simpara></listitem> <listitem><simpara> - FT_PEEK - Do not set the \Seen flag if not already set + FT_PEEK - Do not set the \Seen flag if not already set</simpara></listitem> <listitem><simpara> FT_INTERNAL - The return string is in internal format, will - not canonicalize to CRLF. - </itemizedlist> + not canonicalize to CRLF.</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -104,11 +103,11 @@ </funcsynopsis> <para> Returns information about the current mailbox. Returns FALSE on - failure. + failure.</para> <para> The <function>imap_check</function> function checks the current mailbox status on the server and returns the information in an - object with following properties. + object with following properties.</para> <para> <informalexample> <literallayout> @@ -118,7 +117,7 @@ Nmsgs : number of messages Recent : number of recent messages </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -139,7 +138,7 @@ <para> Close the imap stream. Takes an optional <parameter>flag</parameter> CL_EXPUNGE, which will silently - expunge the mailbox before closing. + expunge the mailbox before closing.</para> </refsect1> </refentry> @@ -157,9 +156,9 @@ </funcsynopsis> <para> <function>imap_createmailbox</function> creates a new mailbox - specified by <parameter>mbox</parameter>. + specified by <parameter>mbox</parameter>.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -177,12 +176,12 @@ <paramdef>int <parameter>msg_number</parameter></paramdef> </funcsynopsis> <para> - Returns true. + Returns true.</para> <para> <function>imap_delete</function> function marks message pointed by <parameter>msg_number</parameter> for deletion. Actual deletion of the messages is done by - <function>imap_expunge</function>. + <function>imap_expunge</function>.</para> </refsect1> </refentry> @@ -201,9 +200,9 @@ </funcsynopsis> <para> <function>imap_deletemailbox</function> deletes the specified - mailbox. + mailbox.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -221,9 +220,9 @@ </funcsynopsis> <para> <function>imap_expunge</function> deletes all the messages marked - for deletion by <function>imap_delete</function>. + for deletion by <function>imap_delete</function>.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -248,19 +247,19 @@ of the specified messages as a text string and returns that text string. The section specification is a string of integers delimited by period which index into a body part list as per the - IMAP4 specification. Body parts are not decoded by this function. + IMAP4 specification. Body parts are not decoded by this function.</para> <para> The options for <function>imap_fetchbody </function>e a bitmask with one or more of the following <itemizedlist> <listitem><simpara> - FT_UID - The msgono is a UID + FT_UID - The msgono is a UID</simpara></listitem> <listitem><simpara> - FT_PEEK - Do not set the \Seen flag if not already set + FT_PEEK - Do not set the \Seen flag if not already set</simpara></listitem> <listitem><simpara> FT_UID - The return string is in "internal" format, without - any attempt to canonicalize CRLF - </itemizedlist> + any attempt to canonicalize CRLF</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -280,7 +279,7 @@ <para> This function causes a fetch of all the structured information for the given <parameter>msg_number</parameter>. The returned - value is an object with following elements. + value is an object with following elements.</para> <para> <informalexample> @@ -288,7 +287,7 @@ type, encoding, ifsubtype, subtype, ifdescription, description, ifid, id, lines, bytes, ifparameters </literallayout> - </informalexample> + </informalexample></para> <para> It also returns an array of objects called parameters[]. This object has following properties. @@ -299,7 +298,7 @@ </literallayout> </informalexample> In case of multipart, it also returns an array of objects of all - the properties, called parts[]. + the properties, called parts[].</para> </refsect1> </refentry> @@ -320,7 +319,7 @@ <paramdef>int <parameter>defaulthost</parameter></paramdef> </funcsynopsis> <para> - This function returns an object of various header elements + This function returns an object of various header elements</para> <para> <informalexample> <literallayout> @@ -393,7 +392,7 @@ fetchfrom (from line formatted to fit <parameter>fromlength</parameter> characters) fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters) </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -410,7 +409,7 @@ </funcsynopsis> <para> Returns an array of string formatted with header info. One - element per mail message. + element per mail message.</para> </refsect1> </refentry> @@ -429,7 +428,7 @@ <paramdef>string <parameter>pat</parameter></paramdef> </funcsynopsis> <para> - Returns an array containing the names of the mailboxes. + Returns an array containing the names of the mailboxes.</para> </refsect1> </refentry> @@ -457,20 +456,20 @@ is a bitmask that can be tested against: <itemizedlist> <listitem><simpara> - LATT_NOINFERIORS - This mailbox has no "children" (there are no mailboxes below this one) + LATT_NOINFERIORS - This mailbox has no "children" (there are no mailboxes below this one)</simpara></listitem> <listitem><simpara> - LATT_NOSELECT - This is only a container, not a mailbox - you cannot open it. + LATT_NOSELECT - This is only a container, not a mailbox - you cannot open it.</simpara></listitem> <listitem><simpara> - LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD. + LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD.</simpara></listitem> <listitem><simpara> - LATT_UNMARKED - This mailbox is not marked. Only used by UW-IMAPD. - </itemizedlist> + LATT_UNMARKED - This mailbox is not marked. Only used by UW-IMAPD.</simpara></listitem> + </itemizedlist></para> <para> <parameter>ref</parameter> should normally be just the IMAP server, in the form: {imap_server:imap_port}, and <parameter>pattern</parameter> specifies where in the mailbox hierarchy to start searching. If you want all mailboxes, pass - <parameter>pattern</parameter> as an empty string. + <parameter>pattern</parameter> as an empty string.</para> <para> There are two special characters you can pass as part of the <parameter>pattern</parameter>: '*' and '%'. '*' means to return @@ -480,7 +479,7 @@ <parameter>pattern</parameter> parameter will return only the top level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that - directory. + directory.</para> </refsect1> </refentry> @@ -503,7 +502,7 @@ subscribed. The <parameter>ref</parameter> and <parameter>pattern</parameter> arguments specify the base location to search from and the pattern the mailbox name must - match. + match.</para> </refsect1> </refentry> @@ -524,7 +523,7 @@ <para> This function is identical to <function>imap_getmailboxes</function>, except that it only - returns mailboxes that the user is subscribed to. + returns mailboxes that the user is subscribed to.</para> </refsect1> </refentry> @@ -544,20 +543,20 @@ <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> <para> Copies mail messages specified by <parameter>msglist</parameter> to specified mailbox. <parameter>msglist</parameter> is a range - not just message numbers. + not just message numbers.</para> <para> flags is a bitmask of one or more of <itemizedlist> <listitem><simpara> - CP_UID - the sequence numbers contain UIDS + CP_UID - the sequence numbers contain UIDS</simpara></listitem> <listitem><simpara> CP_MOVE - Delete the messages from the current mailbox after - copying - </itemizedlist> + copying</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -578,9 +577,9 @@ <para> Moves mail messages specified by <parameter>msglist</parameter> to specified mailbox. <parameter>msglist</parameter> is a range - not just message numbers. + not just message numbers.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -598,7 +597,7 @@ <paramdef>int <parameter>stream_id</parameter></paramdef> </funcsynopsis> <para> - Return the number of messages in the current mailbox. + Return the number of messages in the current mailbox.</para> </refsect1> </refentry> @@ -616,8 +615,8 @@ <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> - Returns the number of recent messages in the current mailbox. - <para> + Returns the number of recent messages in the current mailbox.</para> + <para></para> </refsect1> </refentry> @@ -642,7 +641,7 @@ servers. To connect to an IMAP server running on port 143 on the local machine, do the following: <informalexample> - <programlisting role=php> + <programlisting role="php"> $mbox = imap_open("{localhost:143}INBOX","user_id","password"); </programlisting> </informalexample> @@ -664,20 +663,20 @@ </informalexample> To connect to a remote server replace "localhost" with the name - or the IP address of the server you want to connect to. + or the IP address of the server you want to connect to.</para> <para> The options are a bit mask with one or more of the following: <itemizedlist> <listitem><simpara> - OP_READONLY - Open mailbox read-only + OP_READONLY - Open mailbox read-only</simpara></listitem> <listitem><simpara> - OP_ANONYMOUS - Dont use or update a .newsrc for news + OP_ANONYMOUS - Dont use or update a .newsrc for news</simpara></listitem> <listitem><simpara> OP_HALFOPEN - For IMAP and NNTP names, open a connection but - dont open a mailbox + dont open a mailbox</simpara></listitem> <listitem><simpara> - CL_EXPUNGE - Expunge mailbox automatically upon mailbox close - </itemizedlist> + CL_EXPUNGE - Expunge mailbox automatically upon mailbox close</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -694,12 +693,12 @@ <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> - Returns true if the stream is still alive, false otherwise. + Returns true if the stream is still alive, false otherwise.</para> <para> <function>imap_ping</function> function pings the stream to see it is still active. It may discover new mail; this is the preferred method for a periodic "new mail check" as well as a - "keep alive" for servers which have inactivity timeout. + "keep alive" for servers which have inactivity timeout.</para> </refsect1> </refentry> @@ -718,9 +717,9 @@ <paramdef>string <parameter>new_mbox</parameter></paramdef> </funcsynopsis> <para> - This function renames on old mailbox to new mailbox. + This function renames on old mailbox to new mailbox.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -740,22 +739,22 @@ <parameter><optional>flags</optional></parameter></paramdef> </funcsynopsis> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> <para> - This function reopens the specified stream to new mailbox. + This function reopens the specified stream to new mailbox.</para> <para> The options are a bit mask with one or more of the following: <itemizedlist> <listitem><simpara> - OP_READONLY - Open mailbox read-only + OP_READONLY - Open mailbox read-only</simpara></listitem> <listitem><simpara> - OP_ANONYMOUS - Dont use or update a .newsrc for news + OP_ANONYMOUS - Dont use or update a .newsrc for news</simpara></listitem> <listitem><simpara> OP_HALFOPEN - For IMAP and NNTP names, open a connection but - dont open a mailbox + dont open a mailbox</simpara></listitem> <listitem><simpara> - CL_EXPUNGE - Expunge mailbox automatically upon mailbox close - </itemizedlist> + CL_EXPUNGE - Expunge mailbox automatically upon mailbox close</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -773,9 +772,9 @@ <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> - Subscribe to a new mailbox. + Subscribe to a new mailbox.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -794,9 +793,9 @@ </funcsynopsis> <para> This function removes the deletion flag for a specified message, - which is set by <function>imap_delete</function>. + which is set by <function>imap_delete</function>.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -814,9 +813,9 @@ <paramdef>string <parameter>mbox</parameter></paramdef> </funcsynopsis> <para> - Unsubscribe from a specified mailbox. + Unsubscribe from a specified mailbox.</para> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> </refsect1> </refentry> @@ -833,9 +832,9 @@ <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> - Convert a quoted-printable string to an 8 bit string + Convert a quoted-printable string to an 8 bit string</para> <para> - Returns an 8 bit (binary) string + Returns an 8 bit (binary) string</para> </refsect1> </refentry> @@ -851,9 +850,9 @@ <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> - Convert an 8bit string to a quoted-printable string. + Convert an 8bit string to a quoted-printable string.</para> <para> - Returns a quoted-printable string + Returns a quoted-printable string</para> </refsect1> </refentry> @@ -869,9 +868,9 @@ <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> - Convert an 8bit string to a base64 string. + Convert an 8bit string to a base64 string.</para> <para> - Returns a base64 string + Returns a base64 string</para> </refsect1> </refentry> @@ -890,7 +889,7 @@ </funcsynopsis> <para> Returns an array containing the names of the mailboxes that have - <parameter>string</parameter> in the text of the mailbox. + <parameter>string</parameter> in the text of the mailbox.</para> </refsect1> </refentry> @@ -906,11 +905,11 @@ <paramdef>int <parameter>imap_stream</parameter></paramdef> </funcsynopsis> <para> - Returns information about the current mailbox. Returns FALSE on failure. + Returns information about the current mailbox. Returns FALSE on failure.</para> <para> The <function>imap_mailboxmsginfo</function> function checks the current mailbox status on the server and returns the information - in an object with following properties. + in an object with following properties.</para> <para> <informalexample> <literallayout> @@ -922,7 +921,7 @@ Unread : number of unread messages Size : mailbox size </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -943,7 +942,7 @@ </funcsynopsis> <para> Returns a properly formatted email address given the mailbox, - host, and personal info. + host, and personal info.</para> </refsect1> </refentry> @@ -961,7 +960,7 @@ </funcsynopsis> <para> This function parses the address tring and for each address, - returns an array of objects. The 4 objects are: + returns an array of objects. The 4 objects are:</para> <para> <informalexample> <literallayout> @@ -970,7 +969,7 @@ personal - the personal name adl - at domain source route </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -990,7 +989,7 @@ </funcsynopsis> <para> This function causes a store to add the specified flag to the - flags set for the messages in the specified sequence. + flags set for the messages in the specified sequence.</para> <para> The options are a bit mask with one or more of the following: <informalexample> @@ -998,7 +997,7 @@ ST_UID The sequence argument contains UIDs instead of sequence numbers </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -1018,7 +1017,7 @@ </funcsynopsis> <para> This function causes a store to delete the specified flag to the - flags set for the messages in the specified sequence. + flags set for the messages in the specified sequence.</para> <para> The options are a bit mask with one or more of the following: <informalexample> @@ -1026,7 +1025,7 @@ ST_UID The sequence argument contains UIDs instead of sequence numbers </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -1046,9 +1045,9 @@ </funcsynopsis> <para> Returns an array of message numbers sorted by the given - parameters + parameters</para> <para> - Rev is 1 for reverse-sorting. + Rev is 1 for reverse-sorting.</para> <para> Criteria can be one (and only one) of the following: <informalexample> @@ -1061,7 +1060,7 @@ SORTCC mailbox in first cc address SORTSIZE size of message in octets </literallayout> - </informalexample> + </informalexample></para> <para> The flags are a bitmask of one or more of the following: <informalexample> @@ -1069,7 +1068,7 @@ SE_UID Return UIDs instead of sequence numbers SE_NOPREFETCH Don't prefetch searched messages. </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -1090,7 +1089,7 @@ <para> This function causes a fetch of the complete, unfiltered RFC 822 format header of the specified message as a text string and - returns that text string. + returns that text string.</para> <para> The options are: <informalexample> @@ -1105,7 +1104,7 @@ desired (e.g. in a "save to local file" operation) </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -1124,7 +1123,7 @@ </funcsynopsis> <para> This function returns the UID for the given message sequence - number. It is the inverse of <function>imap_msgno</function>. + number. It is the inverse of <function>imap_msgno</function>.</para> </refsect1> </refentry> @@ -1143,7 +1142,7 @@ </funcsynopsis> <para> This function returns the message sequence number for the given - UID. It is the inverse of <function>imap_uid</function>. + UID. It is the inverse of <function>imap_uid</function>.</para> </refsect1> </refentry> @@ -1169,63 +1168,63 @@ quoted. <itemizedlist> <listitem><simpara> - ALL - return all messages matching the rest of the criteria + ALL - return all messages matching the rest of the criteria</simpara></listitem> <listitem><simpara> - ANSWERED - match messages with the \\ANSWERED flag set + ANSWERED - match messages with the \\ANSWERED flag set</simpara></listitem> <listitem><simpara> - BCC "string" - match messages with "string" in the Bcc: field + BCC "string" - match messages with "string" in the Bcc: field</simpara></listitem> <listitem><simpara> - BEFORE "date" - match messages with Date: before "date" + BEFORE "date" - match messages with Date: before "date"</simpara></listitem> <listitem><simpara> - BODY "string" - match messages with "string" in the body of the message + BODY "string" - match messages with "string" in the body of the message</simpara></listitem> <listitem><simpara> - CC "string" - match messages with "string" in the Cc: field + CC "string" - match messages with "string" in the Cc: field</simpara></listitem> <listitem><simpara> - DELETED - match deleted messages + DELETED - match deleted messages</simpara></listitem> <listitem><simpara> - FLAGGED - match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set + FLAGGED - match messages with the \\FLAGGED (sometimes referred to as Important or Urgent) flag set</simpara></listitem> <listitem><simpara> - FROM "string" - match messages with "string" in the From: field + FROM "string" - match messages with "string" in the From: field</simpara></listitem> <listitem><simpara> - KEYWORD "string" - match messages with "string" as a keyword + KEYWORD "string" - match messages with "string" as a keyword</simpara></listitem> <listitem><simpara> - NEW - match new messages + NEW - match new messages</simpara></listitem> <listitem><simpara> - OLD - match old messages + OLD - match old messages</simpara></listitem> <listitem><simpara> - ON "date" - match messages with Date: matching "date" + ON "date" - match messages with Date: matching "date"</simpara></listitem> <listitem><simpara> - RECENT - match messages with the \\RECENT flag set + RECENT - match messages with the \\RECENT flag set</simpara></listitem> <listitem><simpara> - SEEN - match messages that have been read (the \\SEEN flag is set) + SEEN - match messages that have been read (the \\SEEN flag is set)</simpara></listitem> <listitem><simpara> - SINCE "date" - match messages with Date: after "date" + SINCE "date" - match messages with Date: after "date"</simpara></listitem> <listitem><simpara> - SUBJECT "string" - match messages with "string" in the Subject: + SUBJECT "string" - match messages with "string" in the Subject:</simpara></listitem> <listitem><simpara> - TEXT "string" - match messages with text "string" + TEXT "string" - match messages with text "string"</simpara></listitem> <listitem><simpara> - TO "string" - match messages with "string" in the To: + TO "string" - match messages with "string" in the To:</simpara></listitem> <listitem><simpara> - UNANSWERED - match messages that have not been answered + UNANSWERED - match messages that have not been answered</simpara></listitem> <listitem><simpara> - UNDELETED - match messages that are not deleted + UNDELETED - match messages that are not deleted</simpara></listitem> <listitem><simpara> - UNFLAGGED - match messages that are not flagged + UNFLAGGED - match messages that are not flagged</simpara></listitem> <listitem><simpara> - UNKEYWORD "string" - match messages that do not have the keyword "string" + UNKEYWORD "string" - match messages that do not have the keyword "string"</simpara></listitem> <listitem><simpara> - UNSEEN - match messages which have not been read yet - </itemizedlist> + UNSEEN - match messages which have not been read yet</simpara></listitem> + </itemizedlist></para> <para> For example, to match all unanswered messages sent by Mom, you'd use: "UNANSWERED FROM mom". Searches appear to be case insensitive. This list of criteria is from a reading of the UW c-client source code and may be uncomplete or - inaccurate. Searcher beware. + inaccurate. Searcher beware.</para> <para> Valid values for flags are SE_UID, which causes the returned - array to contain UIDs instead of messages sequence numbers. + array to contain UIDs instead of messages sequence numbers.</para> </refsect1> </refentry> @@ -1246,7 +1245,7 @@ message that occurred on the current page. The error stack is untouched; calling <function>imap_last_error</function> subsequently, with no intervening errors, will return the same - error. + error.</para> </refsect1> </refentry> @@ -1267,7 +1266,7 @@ generated since the last <function>imap_errors</function> call, or the beginning of the page. When <function>imap_errors</function> is called, the error stack is - subsequently cleared. + subsequently cleared.</para> </refsect1> </refentry> @@ -1289,7 +1288,7 @@ or the beginning of the page. When <function>imap_alerts</function> is called, the alert stack is subsequently cleared. The IMAP specification requires that these - messages be passed to the user. + messages be passed to the user.</para> </refsect1> </refentry> @@ -1311,21 +1310,21 @@ This function returns an object containing status information. Valid flags are: <itemizedlist> <listitem><simpara> - SA_MESSAGES - set status->messages to the number of messages in the mailbox + SA_MESSAGES - set status->messages to the number of messages in the mailbox</simpara></listitem> <listitem><simpara> - SA_RECENT - set status->recent to the number of recent messages in the mailbox + SA_RECENT - set status->recent to the number of recent messages in the mailbox</simpara></listitem> <listitem><simpara> - SA_UNSEEN - set status->unseen to the number of unseen (new) messages in the mailbox + SA_UNSEEN - set status->unseen to the number of unseen (new) messages in the mailbox</simpara></listitem> <listitem><simpara> - SA_UIDNEXT - set status->uidnext to the next uid to be used in the mailbox + SA_UIDNEXT - set status->uidnext to the next uid to be used in the mailbox</simpara></listitem> <listitem><simpara> - SA_UIDVALIDITY - set status->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid + SA_UIDVALIDITY - set status->uidvalidity to a constant that changes when uids for the mailbox may no longer be valid</simpara></listitem> <listitem><simpara> - SA_ALL - set all of the above - </itemizedlist> + SA_ALL - set all of the above</simpara></listitem> + </itemizedlist></para> <para> status->flags is also set, which contains a bitmask which can be - checked against any of the above constants. + checked against any of the above constants.</para> </refsect1> </refentry> Index: phpdoc/functions/info.sgml diff -u phpdoc/functions/info.sgml:1.6 phpdoc/functions/info.sgml:1.7 --- phpdoc/functions/info.sgml:1.6 Sun Sep 5 23:22:00 1999 +++ phpdoc/functions/info.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.info"> <title>PHP options & information</title> <titleabbrev>PHP options/info</titleabbrev> @@ -33,8 +32,7 @@ <entry> <parameter>message</parameter> is sent to PHP's system logger, using the Operating System's system logging - mechanism or a file, depending on what the <link - linkend="ini.error-log">error_log</link> configuration + mechanism or a file, depending on what the <link linkend="ini.error-log">error_log</link> configuration directive is set to. </entry> </row> @@ -70,11 +68,11 @@ </row> </tbody> </tgroup> - </table> + </table></para> <para> <example> <title><function>error_log</function> examples</title> - <programlisting role=php> + <programlisting role="php"> // Send notification through the server log if we can not // connect to the database. if (!Ora_Logon($username, $password)) { @@ -92,7 +90,7 @@ error_log("You messed up!", 2, "loghost"); error_log("You messed up!", 3, "/var/tmp/my-errors.log"); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -147,7 +145,7 @@ </row> </tbody> </tgroup> - </table> + </table></para> </refsect1> </refentry> @@ -165,13 +163,13 @@ <simpara> Returns true if the extension identified by <parameter>name</parameter> is loaded. You can see the names of various extensions by using - <function>phpinfo</function>. + <function>phpinfo</function>.</simpara> <para> See also <function>phpinfo</function>. <note> <para> - This function was added in 3.0.10. - </note> + This function was added in 3.0.10.</para> + </note></para> </refsect1> </refentry> @@ -194,16 +192,15 @@ <informalexample><programlisting> $ip = getenv("REMOTE_ADDR"); // get the ip number of the user - </programlisting></informalexample> + </programlisting></informalexample></para> <para> You can see a list of all the environmental variables by using <function>phpinfo</function>. You can find out what many of them mean by taking a look at the <ulink url="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI - specification</ulink>, specifically the <ulink - url="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">page on environmental - variables</ulink>. + specification</ulink>, specifically the <ulink url="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">page on environmental + variables</ulink>.</para> </refsect1> </refentry> @@ -223,18 +220,17 @@ <simpara> Returns the current value of the PHP configuration variable specified by <parameter>varname</parameter>, or false if an error - occurs. + occurs.</simpara> <simpara> It will not return configuration information set when the PHP was compiled, or read from an Apache configuration file (using the - php3_configuration_option directives). + php3_configuration_option directives).</simpara> <simpara> - To check whether the system is using a <link - linkend="configuration.file">configuration file</link>, + To check whether the system is using a <link linkend="configuration.file">configuration file</link>, try retrieving the value of the cfg_file_path configuration - setting. If this is available, a configuration file is being used. + setting. If this is available, a configuration file is being used.</simpara> </refsect1> </refentry> @@ -251,12 +247,12 @@ </funcsynopsis> <simpara> - Returns the name of the owner of the current PHP script. + Returns the name of the owner of the current PHP script.</simpara> <simpara> See also <function>getmyuid</function>, <function>getmypid</function>, <function>getmyinode</function>, - and <function>getlastmod</function>. + and <function>getlastmod</function>.</simpara> </refsect1> </refentry> @@ -276,11 +272,11 @@ <simpara> Returns the current active configuration setting of <link linkend="ini.magic-quotes-gpc">magic_quotes_gpc</link>. - (0 for off, 1 for on) + (0 for off, 1 for on)</simpara> <simpara> See also <function>get_magic_quotes_runtime</function>, - <function>set_magic_quotes_runtime</function>. + <function>set_magic_quotes_runtime</function>.</simpara> </refsect1> </refentry> @@ -299,11 +295,11 @@ <simpara> Returns the current active configuration setting of <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. - (0 for off, 1 for on) + (0 for off, 1 for on)</simpara> <simpara> See also <function>get_magic_quotes_gpc</function>, - <function>set_magic_quotes_runtime</function>. + <function>set_magic_quotes_runtime</function>.</simpara> </refsect1> </refentry> @@ -331,14 +327,14 @@ // outputs e.g. 'Last modified: March 04 1998 20:43:59.' echo "Last modified: ".date( "F d Y H:i:s.", getlastmod() ); </programlisting> - </example> + </example></para> <para> See alse <function>date</function>, <function>getmyuid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and - <function>getmypid</function>. + <function>getmypid</function>.</para> </refsect1> </refentry> @@ -356,13 +352,13 @@ </funcsynopsis> <para> - Returns the current script's inode, or false on error. + Returns the current script's inode, or false on error.</para> <para> See also <function>getmyuid</function>, <function>get_current_user</function>, <function>getmypid</function>, and - <function>getlastmod</function>. + <function>getlastmod</function>.</para> </refsect1> </refentry> @@ -380,17 +376,17 @@ </funcsynopsis> <para> - Returns the current PHP process ID, or false on error. + Returns the current PHP process ID, or false on error.</para> <para> Note that when running as a server module, separate invocations - of the script are not guaranteed to have distinct pids. + of the script are not guaranteed to have distinct pids.</para> <para> See also <function>getmyuid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and - <function>getlastmod</function>. + <function>getlastmod</function>.</para> </refsect1> </refentry> @@ -408,13 +404,13 @@ </funcsynopsis> <simpara> - Returns the user ID of the current script, or false on error. + Returns the user ID of the current script, or false on error.</simpara> <simpara> See also <function>getmypid</function>, <function>get_current_user</function>, <function>getmyinode</function>, and - <function>getlastmod</function>. + <function>getlastmod</function>.</simpara> </refsect1> </refentry> @@ -471,10 +467,10 @@ extensions, the PHP version, server information and environment (if compiled as a module), the PHP environment, OS version information, paths, master and local values of configuration - options, HTTP headers, and the GNU Public License. + options, HTTP headers, and the GNU Public License.</para> <para> - See also <function>phpversion</function>. + See also <function>phpversion</function>.</para> </refsect1> </refentry> @@ -501,10 +497,10 @@ // prints e.g. 'Current PHP version: 3.0rel-dev' echo "Current PHP version: ".phpversion(); </programlisting> - </example> + </example></para> <para> - See also <function>phpinfo</function>. + See also <function>phpinfo</function>.</para> </refsect1> </refentry> @@ -522,14 +518,14 @@ </funcsynopsis> <para> - Adds <parameter>setting</parameter> to the environment. + Adds <parameter>setting</parameter> to the environment.</para> <para> <example> <title>Setting an Environment Variable</title> <programlisting> putenv("UNIQID=$uniqid"); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -549,11 +545,11 @@ <simpara> Set the current active configuration setting of <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link>. - (0 for off, 1 for on) + (0 for off, 1 for on)</simpara> <simpara> See also <function>get_magic_quotes_gpc</function>, - <function>get_magic_quotes_runtime</function>. + <function>get_magic_quotes_runtime</function>.</simpara> </refsect1> </refentry> @@ -573,14 +569,14 @@ reached, the script returns a fatal error. The default limit is 30 seconds or, if it exists, the max_execution_time value defined in the <link linkend="configuration.file">configuration file</link>. - If seconds is set to zero, no time limit is imposed. + If seconds is set to zero, no time limit is imposed.</simpara> <simpara> When called, <function>set_time_limit</function> restarts the timeout counter from zero. In other words, if the timeout is the default 30 seconds, and 25 seconds into script execution a call such as set_time_limit(20) is made, the script will run for a total of - 45 seconds before timing out. + 45 seconds before timing out.</simpara> </refsect1> </refentry> Index: phpdoc/functions/ldap.sgml diff -u phpdoc/functions/ldap.sgml:1.5 phpdoc/functions/ldap.sgml:1.6 --- phpdoc/functions/ldap.sgml:1.5 Sun Sep 12 13:48:39 1999 +++ phpdoc/functions/ldap.sgml Wed Oct 20 18:41:42 1999 @@ -65,7 +65,7 @@ <example> <title>LDAP search example</title> -<programlisting role=php> +<programlisting role="php"> &lt;?php // basic sequence with LDAP is connect, bind, search, interpret search // result, close connection @@ -138,7 +138,7 @@ password for anything else) </para> </listitem> - </itemizedlist> + </itemizedlist></para> <para> The typical sequence of LDAP calls you will make in an @@ -152,7 +152,7 @@ and display the results | ldap_close() // "logout" -</literallayout> +</literallayout></para> </sect2> @@ -227,7 +227,7 @@ </informalexample> <example> <title>Complete example with authenticated bind</title> -<programlisting role=php> +<programlisting role="php"> &lt;?php $ds=ldap_connect("localhost"); // assuming the LDAP server is on this host @@ -268,12 +268,12 @@ <paramdef>array <parameter>entry</parameter></paramdef> </funcsynopsis> <para> - returns true on success and false on error. + returns true on success and false on error.</para> <para> This function adds attribute(s) to the specified dn. It performs the modification at the attribute level as opposed to the object level. Object-level additions are done by the - <function>ldap_add</function> function. + <function>ldap_add</function> function.</para> </refsect1> </refentry> @@ -291,12 +291,12 @@ <paramdef>array <parameter>entry</parameter></paramdef> </funcsynopsis> <para> - returns true on success and false on error. + returns true on success and false on error.</para> <para> This function removes attribute(s) from the specified dn. It performs the modification at the attribute level as opposed to the object level. Object-level deletions are done by the - <function>ldap_del</function> function. + <function>ldap_del</function> function.</para> </refsect1> </refentry> @@ -314,12 +314,12 @@ <paramdef>array <parameter>entry</parameter></paramdef> </funcsynopsis> <para> - returns true on success and false on error. + returns true on success and false on error.</para> <para> This function replaces attribute(s) from the specified dn. It performs the modification at the attribute level as opposed to the object level. Object-level modifications are done by the - <function>ldap_modify</function> function. + <function>ldap_modify</function> function.</para> </refsect1> </refentry> @@ -338,11 +338,11 @@ </funcsynopsis> <para> Binds to the LDAP directory with specified RDN and - password. Returns true on success and false on error. + password. Returns true on success and false on error.</para> <para> <function>ldap_bind</function> does a bind operation on the directory. bind_rdn and bind_password are optional. If not - specified, anonymous bind is attempted. + specified, anonymous bind is attempted.</para> </refsect1> </refentry> @@ -359,16 +359,16 @@ <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> <function>ldap_close</function> closes the link to the LDAP server that's associated with the specified - <parameter>link_identifier</parameter>. + <parameter>link_identifier</parameter>.</para> <para> This call is internally identical to <function>ldap_unbind</function>. The LDAP API uses the call <function>ldap_unbind</function>, so perhaps you should use this - in preference to <function>ldap_close</function>. + in preference to <function>ldap_close</function>.</para> </refsect1> </refentry> @@ -387,7 +387,7 @@ </funcsynopsis> <para> Returns a positive LDAP link identifier on success, or false on - error. + error.</para> <para> <function>ldap_connect</function> establishes a connection to a LDAP server on a specified <parameter>hostname</parameter> and @@ -395,7 +395,7 @@ no arguments are specified then the link identifier of the already opened link will be returned. If only <parameter>hostname</parameter> is specified, then the port - defaults to 389. + defaults to 389.</para> </refsect1> </refentry> @@ -413,12 +413,12 @@ <paramdef>int <parameter>result_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns number of entries in the result or false on error. + Returns number of entries in the result or false on error.</para> <para> <function>ldap_count_entries</function> returns the number of entries stored in the result of previous search operations. <parameter>result_identifier</parameter> identifies - the internal ldap result. + the internal ldap result.</para> </refsect1> </refentry> @@ -436,10 +436,10 @@ <paramdef>string <parameter>dn</parameter></paramdef> </funcsynopsis> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> <para> <function>ldap_delete</function> function delete a particular - entry in LDAP directory specified by dn. + entry in LDAP directory specified by dn.</para> </refsect1> </refentry> @@ -457,7 +457,7 @@ </funcsynopsis> <para> <function>ldap_dn2ufn</function> function is used to turn a DN - into a more user-friendly form, stripping off type names. + into a more user-friendly form, stripping off type names.</para> </refsect1> </refentry> @@ -484,7 +484,7 @@ are returned with only values or their attributes as well. To get RDNs with the attributes (i.e. in attribute=value format) set <parameter>with_attrib</parameter> to 0 and to get only values - set it to 1. + set it to 1.</para> </refsect1> </refentry> @@ -504,7 +504,7 @@ </funcsynopsis> <para> Returns the first attribute in the entry on success and false on - error. + error.</para> <para> Similar to reading entries, attributes are also read one by one from a particular entry. @@ -515,9 +515,9 @@ <parameter>ber_identifier</parameter> is the identifier to internal memory location pointer. It is passed by reference. The same <parameter>ber_identifier</parameter> is passed to the - ldap_next_attribute() function, which modifies that pointer. + ldap_next_attribute() function, which modifies that pointer.</para> <para> - see also <function>ldap_get_attributes</function> + see also <function>ldap_get_attributes</function></para> </refsect1> </refentry> @@ -536,7 +536,7 @@ </funcsynopsis> <para> Returns the result entry identifier for the first entry on - success and false on error. + success and false on error.</para> <para> Entries in the LDAP result are read sequentially using the <function>ldap_first_entry</function> and @@ -545,9 +545,9 @@ entry identifier for first entry in the result. This entry identifier is then supplied to <function>lap_next_entry</function> routine to get successive - entries from the result. + entries from the result.</para> <para> - see also <function>ldap_get_entries</function>. + see also <function>ldap_get_entries</function>.</para> </refsect1> </refentry> @@ -564,18 +564,18 @@ <paramdef>int <parameter>result_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> <para> <function>ldap_free_result</function> frees up the memory allocated internally to store the result and pointed by the <parameter>result_identifier</parameter>. All result memory will - be automatically freed when the script terminates. + be automatically freed when the script terminates.</para> <para> Typically all the memory allocated for the ldap result gets freed at the end of the script. In case the script is making successive searches which return large result sets, <function>ldap_free_result</function> could be called to keep the - runtime memory usage by the script low. + runtime memory usage by the script low.</para> </refsect1> </refentry> @@ -595,12 +595,12 @@ </funcsynopsis> <para> Returns a complete entry information in a multi-dimensional array - on success and false on error. + on success and false on error.</para> <para> <function>ldap_get_attributes</function> function is used to simplify reading the attributes and values from an entry in the search result. The return value is a multi-dimensional array of - attributes and values. + attributes and values.</para> <para> Having located a specific entry in the directory, you can find out what information is held for that entry by using this @@ -608,7 +608,7 @@ directory entries and/or where you do not know the structure of the directory entries. In many applications you will be searching for a specific attribute such as an email address or a surname, - and won't care what other data is held. + and won't care what other data is held.</para> <para> <informalexample><literallayout> return_value["count"] = number of attributes in the entry @@ -623,7 +623,7 @@ <example> <title>Show the list of attributes held for a particular directory entry </title> -<programlisting role=php> +<programlisting role="php"> // $ds is the link identifier for the directory // $sr is a valid search result from a prior call to @@ -638,11 +638,11 @@ for ($i=0; $i<$attrs["count"]; $i++) echo $attrs[$i]."&lt;br>"; </programlisting> -</example> +</example></para> <para> see also <function>ldap_first_attribute</function> and - <function>ldap_next_attribute</function> + <function>ldap_next_attribute</function></para> </refsect1> </refentry> @@ -661,10 +661,10 @@ <paramdef>int <parameter>result_entry_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns the DN of the result entry and false on error. + Returns the DN of the result entry and false on error.</para> <para> <function>ldap_get_dn</function> function is used to find out the - DN of an entry in the result. + DN of an entry in the result.</para> </refsect1> </refentry> @@ -683,14 +683,14 @@ </funcsynopsis> <para> Returns a complete result information in a multi-dimenasional - array on success and false on error. + array on success and false on error.</para> <para> <function>ldap_get_entries</function> function is used to simplify reading multiple entries from the result and then reading the attributes and multiple values. The entire information is returned by one function call in a multi-dimensional array. The structure of the array is as - follows. + follows.</para> <para> The attribute index is converted to lowercase. (Attributes are case-insensitive for directory servers, but not when used as @@ -710,11 +710,11 @@ attribute in ith entry return_value[i]["attribute"][j] = jth value of attribute in ith entry </literallayout> - </informalexample> + </informalexample></para> <para> see also <function>ldap_first_entry</function> and - <function>ldap_next_entry</function> + <function>ldap_next_entry</function></para> </refsect1> </refentry> @@ -734,7 +734,7 @@ </funcsynopsis> <para> Returns an array of values for the attribute on success and false - on error. + on error.</para> <para> <function>ldap_get_values</function> function is used to read all the values of the attribute in the entry in the result. entry is @@ -742,16 +742,16 @@ <parameter>result_entry_identifier</parameter>. The number of values can be found by indexing "count" in the resultant array. Individual values are accessed by integer index in the - array. The first index is 0. + array. The first index is 0.</para> <para> This call needs a <parameter>result_entry_identifier</parameter>, so needs to be preceded by one of the ldap search calls and one - of the calls to get an individual entry. + of the calls to get an individual entry.</para> <para> You application will either be hard coded to look for certain attributes (such as "surname" or "mail") or you will have to use the <function>ldap_get_attributes</function> call to work out - what attributes exist for a given entry. + what attributes exist for a given entry.</para> <para> LDAP allows more than one entry for an attribute, so it can, for example, store a number of email addresses for one person's @@ -768,7 +768,7 @@ <example> <title>List all values of the "mail" attribute for a directory entry </title> -<programlisting role=php> +<programlisting role="php"> // $ds is a valid link identifier for a directory server // $sr is a valid search result from a prior call to @@ -784,7 +784,7 @@ for ($i=0; $i &lt; $values["count"]; $i++) echo $values[$i]."&lt;br>"; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -805,7 +805,7 @@ </funcsynopsis> <para> Returns an array of values for the attribute on success and false - on error. + on error.</para> <para> <function>ldap_get_values_len</function> function is used to read all the values of the attribute in the entry in the result. entry is @@ -813,11 +813,11 @@ <parameter>result_entry_identifier</parameter>. The number of values can be found by indexing "count" in the resultant array. Individual values are accessed by integer index in the - array. The first index is 0. + array. The first index is 0.</para> <para> This function is used exactly like <function>ldap_get_values</function> except that it handles - binary data and not string data. + binary data and not string data.</para> </refsect1> </refentry> @@ -838,15 +838,15 @@ <parameter><optional>attributes</optional></parameter></paramdef> </funcsynopsis> <para> - Returns a search result identifier or false on error. + Returns a search result identifier or false on error.</para> <para> <function>ldap_list</function> performs the search for a specified - filter on the directory with the scope LDAP_SCOPE_ONELEVEL. + filter on the directory with the scope LDAP_SCOPE_ONELEVEL.</para> <para> LDAP_SCOPE_ONELEVEL means that the search should only return information that is at the level immediately below the base dn given in the call. (Equivalent to typing "ls" and getting a list - of files and folders in the current working directory.) + of files and folders in the current working directory.)</para> <para> This call takes an optional fourth parameter which is an array of the attributes required. See <function>ldap_search</function> @@ -855,7 +855,7 @@ <example> <title>Produce a list of all organizational units of an organization </title> -<programlisting role=php3> +<programlisting role="php3"> // $ds is a valid link identifier for a directory server $basedn = "o=My Company, c=US"; @@ -868,7 +868,7 @@ for ($i=0; $i<$info["count"]; $i++) echo $info[$i]["ou"][0] ; </programlisting> -</example> +</example></para> </refsect1> </refentry> @@ -887,11 +887,11 @@ <paramdef>array <parameter>entry</parameter></paramdef> </funcsynopsis> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> <para> <function>ldap_modify</function> function is used to modify the existing entries in the LDAP directory. The structure of the - entry is same as in <function>ldap_add</function>. + entry is same as in <function>ldap_add</function>.</para> </refsect1> </refentry> @@ -911,7 +911,7 @@ </funcsynopsis> <para> Returns the next attribute in an entry on success and false on - error. + error.</para> <para> <function>ldap_next_attribute</function> is called to retrieve the attributes in an entry. The internal state of the pointer is @@ -919,9 +919,9 @@ passed by reference to the function. The first call to <function>ldap_next_attribute</function> is made with the <parameter>result_entry_identifier</parameter> returned from - <function>ldap_first_attribute</function>. + <function>ldap_first_attribute</function>.</para> <para> - see also <function>ldap_get_attributes</function> + see also <function>ldap_get_attributes</function></para> </refsect1> </refentry> @@ -942,7 +942,7 @@ Returns entry identifier for the next entry in the result whose entries are being read starting with <function>ldap_first_entry</function>. If there are no more - entries in the result then it returns false. + entries in the result then it returns false.</para> <para> <function>ldap_next_entry</function> function is used to retrieve the entries stored in the result. Successive calls to the @@ -950,9 +950,9 @@ till there are no more entries. The first call to <function>ldap_next_entry</function> is made after the call to <function>ldap_first_entry</function> with the result_identifier - as returned from the <function>ldap_first_entry</function>. + as returned from the <function>ldap_first_entry</function>.</para> <para> - see also <function>ldap_get_entries</function> + see also <function>ldap_get_entries</function></para> </refsect1> </refentry> @@ -970,25 +970,25 @@ <paramdef>string <parameter>base_dn</parameter></paramdef> <paramdef>string <parameter>filter</parameter></paramdef> <paramdef>array - <parameter><optional>attributes</optional</parameter></paramdef> + <parameter><optional>attributes</optional></parameter></paramdef> </funcsynopsis> <para> - Returns a search result identifier or false on error. + Returns a search result identifier or false on error.</para> <para> <function>ldap_read</function> performs the search for a specified filter on the directory with the scope LDAP_SCOPE_BASE. So it is equivalent to reading an entry from the - directory. + directory.</para> <para> An empty filter is not allowed. If you want to retrieve absolutely all information for this entry, use a filter of "objectClass=*". If you know which entry types are used on the directory server, you might use an appropriate filter such as - "objectClass=inetOrgPerson". + "objectClass=inetOrgPerson".</para> <para> This call takes an optional fourth parameter which is an array of the attributes required. See <function>ldap_search</function> - notes. + notes.</para> </refsect1> </refentry> @@ -1009,35 +1009,35 @@ <parameter><optional>attributes</optional></parameter></paramdef> </funcsynopsis> <para> - Returns a search result identifier or false on error. + Returns a search result identifier or false on error.</para> <para> <function>ldap_search</function> performs the search for a specified filter on the directory with the scope of LDAP_SCOPE_SUBTREE. This is equivalent to searching the entire directory. <parameter>base_dn</parameter> specifies the base DN - for the directory. + for the directory.</para> <para> There is a optional fourth parameter, that can be added to restrict the attributes and values returned by the server to just those required. This is much more efficient than the default action (which is to return all attributes and their associated values). The use of the fourth parameter should therefore be - considered good practice. + considered good practice.</para> <para> The fourth parameter is a standard PHP string array of the required attributes, eg array("mail","sn","cn") Note that the "dn" is always returned irrespective of which attributes types - are requested. + are requested.</para> <para> Note too that some directory server hosts will be configured to return no more than a preset number of entries. If this occurs, the server will indicate that it has only returned a partial - results set. + results set.</para> <para> The search filter can be simple or advanced, using boolean operators in the format described in the LDAP doumentation (see the <ulink url="&url.ldap.netscape;">Netscape Directory SDK</ulink> - for full information on filters). + for full information on filters).</para> <para> The example below retrieves the organizational unit, surname, given name and email address for all people in "My Company" where @@ -1047,7 +1047,7 @@ <example> <title>LDAP search</title> -<programlisting role=php> +<programlisting role="php"> // $ds is a valid link identifier for a directory server // $person is all or part of a person's name, eg "Jo" @@ -1062,7 +1062,7 @@ print $info["count"]." entries returned&lt;p>"; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -1080,10 +1080,10 @@ <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns true on success and false on error. + Returns true on success and false on error.</para> <para> <function>ldap_unbind</function> function unbinds from the LDAP - directory. + directory.</para> </refsect1> </refentry> @@ -1101,13 +1101,13 @@ <paramdef>int <parameter>errno</parameter></paramdef> </funcsynopsis> <para> - returns string error message. + returns string error message.</para> <para> This function returns the string error message explaining the error number errno. While LDAP errno numbers are standardized, different libraries return different or even localized textual error messages. Never check for a specific error message text, - but always use an error number to check. + but always use an error number to check.</para> <para> see also <function>ldap_errno</function> and <function>ldap_error</function>. @@ -1121,7 +1121,7 @@ } ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -1140,12 +1140,12 @@ </funcsynopsis> <para> return the LDAP error number of the last LDAP command for this - link. + link.</para> <para> This function returns the standardized error number returned by the last LDAP command for the given link identifier. This number can be converted into a textual error message using - <function>ldap_err2str</function>. + <function>ldap_err2str</function>.</para> <para> Unless you lower your warning level in your php3.ini sufficiently or prefix your LDAP commands with @ (at) characters to suppress @@ -1170,10 +1170,10 @@ printf("%d matching entries.&lt;br>\n", $info["count"]); ?> </programlisting> - </example> + </example></para> <para> see also <function>ldap_err2str</function> and - <function>ldap_error</function>. + <function>ldap_error</function>.</para> </refsect1> </refentry> @@ -1191,23 +1191,23 @@ <paramdef>int <parameter>link_id</parameter></paramdef> </funcsynopsis> <para> - returns string error message. + returns string error message.</para> <para> This function returns the string error message explaining the error generated by the last LDAP command for the given link identifier. While LDAP errno numbers are standardized, different libraries return different or even localized textual error messages. Never check for a specific error message text, but - always use an error number to check. + always use an error number to check.</para> <para> Unless you lower your warning level in your <filename>php3.ini</filename> sufficiently or prefix your LDAP commands with <literal>@</literal> (at) characters to suppress warning output, the errors generated will also show up in your - HTML output. + HTML output.</para> <para> see also <function>ldap_err2str</function> and - <function>ldap_errno</function>. + <function>ldap_errno</function>.</para> </refsect1> </refentry> </reference> Index: phpdoc/functions/mail.sgml diff -u phpdoc/functions/mail.sgml:1.3 phpdoc/functions/mail.sgml:1.4 --- phpdoc/functions/mail.sgml:1.3 Fri Jul 9 15:41:12 1999 +++ phpdoc/functions/mail.sgml Wed Oct 20 18:41:42 1999 @@ -3,7 +3,7 @@ <titleabbrev>Mail</titleabbrev> <partintro> <simpara> - The <function>mail</function> function allows you to send mail. + The <function>mail</function> function allows you to send mail.</simpara> </partintro> @@ -25,18 +25,18 @@ <function>Mail</function> automatically mails the message specified in <parameter>message</parameter> to the receiver specified in <parameter>to</parameter>. Multiple recipients can be specified by - putting a comma between each address in <parameter>to</parameter>. + putting a comma between each address in <parameter>to</parameter>.</simpara> <para> <example> <title>Sending mail.</title> <programlisting> mail("rasmus@lerdorf.on.ca", "My Subject", "Line 1\nLine 2\nLine 3"); </programlisting> - </example> + </example></para> <simpara> If a fourth string argument is passed, this string is inserted at the end of the header. This is typically used to add extra - headers. Multiple extra headers are separated with a newline. + headers. Multiple extra headers are separated with a newline.</simpara> <para> <example> <title>Sending mail with extra headers.</title> @@ -44,7 +44,7 @@ mail("nobody@aol.com", "the subject", $message, "From: webmaster@$SERVER_NAME\nReply-To: webmaster@$SERVER_NAME\nX-Mailer: PHP/" . phpversion()); </programlisting> - </example> + </example></para> </refsect1> </refentry> Index: phpdoc/functions/math.sgml diff -u phpdoc/functions/math.sgml:1.2 phpdoc/functions/math.sgml:1.3 --- phpdoc/functions/math.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/math.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.math"> <title>Mathematical functions</title> <titleabbrev>Math.</titleabbrev> @@ -9,8 +8,7 @@ <para> These math functions will only handle values within the range of the long and double types on your computer. If you need to - handle bigger numbers, take a look at the <link - linkend="ref.bc">arbitrary precision math functions</link>. + handle bigger numbers, take a look at the <link linkend="ref.bc">arbitrary precision math functions</link>. </para> <sect2> <title>Math constants</title> @@ -54,7 +52,7 @@ </funcsynopsis> <para> Returns the absolute value of number. If the argument number is - float, return type is also float, otherwise it is int. + float, return type is also float, otherwise it is int.</para> </refsect1> </refentry> @@ -72,10 +70,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the arc cosine of arg in radians. + Returns the arc cosine of arg in radians.</para> <para> - See also <function>asin</function> and <function>atan</function>. + See also <function>asin</function> and <function>atan</function>.</para> </refsect1> </refentry> @@ -93,10 +91,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the arc sine of arg in radians. + Returns the arc sine of arg in radians.</para> <para> - See also <function>acos</function> and <function>atan</function>. + See also <function>acos</function> and <function>atan</function>.</para> </refsect1> </refentry> @@ -114,10 +112,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the arc tangent of arg in radians. + Returns the arc tangent of arg in radians.</para> <para> - See also <function>acos</function> and <function>atan</function>. + See also <function>acos</function> and <function>atan</function>.</para> </refsect1> </refentry> @@ -137,11 +135,11 @@ </funcsynopsis> <simpara> This function calculates the arc tangent of the two variables x and y. It is similar to calculating the - arc tangent of y / x, except that the signs of both arguments are used to determine the quadrant of the result. + arc tangent of y / x, except that the signs of both arguments are used to determine the quadrant of the result.</simpara> <simpara> - The function returns the result in radians, which is between -PI and PI (inclusive). + The function returns the result in radians, which is between -PI and PI (inclusive).</simpara> <para> - See also <function>acos</function> and <function>atan</function>. + See also <function>acos</function> and <function>atan</function>.</para> </refsect1> </refentry> @@ -171,10 +169,10 @@ with a meaning 10, b meaning 11 and z meaning 36. <example> <title>base_convert()</title> - <programlisting role=php> + <programlisting role="php"> $binary = base_convert($hexadecimal, 16, 2); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -192,16 +190,16 @@ </funcsynopsis> <para> Returns the decimal equivalent of the binary number represented by - the binary_string argument. + the binary_string argument.</para> <para> OctDec converts a binary number to a decimal number. The largest number that can be converted is 31 bits of 1's or 2147483647 in - decimal. + decimal.</para> <para> See also the <function>decbin</function> - function. + function.</para> </refsect1> </refentry> @@ -221,15 +219,15 @@ <simpara> Returns the next highest integer value from <parameter>number</parameter>. Using <function>ceil</function> - on integers is absolutely a waste of time. + on integers is absolutely a waste of time.</simpara> <simpara> NOTE: PHP/FI 2's <function>ceil</function> returned a float. Use: <literal>$new = (double)ceil($number);</literal> to - get the old behaviour. + get the old behaviour.</simpara> <simpara> - See also <function>floor</function> and <function>round</function>. + See also <function>floor</function> and <function>round</function>.</simpara> </refsect1> </refentry> @@ -247,10 +245,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the cosine of arg in radians. + Returns the cosine of arg in radians.</para> <para> - See also <function>sin</function> and <function>tan</function>. + See also <function>sin</function> and <function>tan</function>.</para> </refsect1> </refentry> @@ -270,11 +268,11 @@ <para> Returns a string containing a binary representation of the given number argument. The largest number that can be converted is - 2147483647 in decimal resulting to a string of 31 1's. + 2147483647 in decimal resulting to a string of 31 1's.</para> <para> See also the <function>bindec</function> - function. + function.</para> </refsect1> </refentry> @@ -294,11 +292,11 @@ <para> Returns a string containing a hexadecimal representation of the given number argument. The largest number that can - be converted is 2147483647 in decimal resulting to "7fffffff". + be converted is 2147483647 in decimal resulting to "7fffffff".</para> <para> See also the <function>hexdec</function> - function. + function.</para> </refsect1> </refentry> @@ -318,7 +316,7 @@ <para> Returns a string containing an octal representation of the given number argument. The largest number that can be converted is - 2147483647 in decimal resulting to "17777777777". See also <function>octdec</function>. + 2147483647 in decimal resulting to "17777777777". See also <function>octdec</function>.</para> </refsect1> </refentry> @@ -336,10 +334,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns e raised to the power of <parameter>arg</parameter>. + Returns e raised to the power of <parameter>arg</parameter>.</para> <para> - See also <function>pow</function>. + See also <function>pow</function>.</para> </refsect1> </refentry> @@ -359,15 +357,15 @@ <simpara> Returns the next lowest integer value from <parameter>number</parameter>. Using <function>floor</function> - on integers is absolutely a waste of time. + on integers is absolutely a waste of time.</simpara> <simpara> NOTE: PHP/FI 2's <function>floor</function> returned a float. Use: <literal>$new = (double)floor($number);</literal> to - get the old behaviour. + get the old behaviour.</simpara> <simpara> - See also <function>ceil</function> and <function>round</function>. + See also <function>ceil</function> and <function>round</function>.</simpara> </refsect1> </refentry> @@ -386,14 +384,14 @@ <simpara> Returns the maximum value that can be returned by a call to - <function>rand</function>. + <function>rand</function>.</simpara> <simpara> See also <function>rand</function>, <function>srand</function> <function>mt_rand</function>, <function>mt_srand</function> and - <function>mt_getrandmax</function>. + <function>mt_getrandmax</function>.</simpara> </refsect1> </refentry> @@ -414,11 +412,11 @@ Returns the decimal equivalent of the hexadecimal number represented by the hex_string argument. HexDec converts a hexadecimal string to a decimal number. The largest number that - can be converted is 7fffffff or 2147483647 in decimal. + can be converted is 7fffffff or 2147483647 in decimal.</para> <para> See also the <function>dechex</function> - function. + function.</para> </refsect1> </refentry> @@ -436,7 +434,7 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the natural logarithm of arg. + Returns the natural logarithm of arg.</para> </refsect1> </refentry> @@ -454,7 +452,7 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the base-10 logarithm of arg. + Returns the base-10 logarithm of arg.</para> </refsect1> </refentry> @@ -475,20 +473,20 @@ </funcsynopsis> <para> <function>max</function> returns the numerically highest of the - parameter values. + parameter values.</para> <para> If the first parameter is an array, <function>max</function> returns the highest value in that array. If the first parameter is an integer, string or double, you need at least two parameters and <function>max</function> returns the biggest of these values. - You can compare an unlimited number of values. + You can compare an unlimited number of values.</para> <para> If one or more of the values is a double, all the values will be treated as doubles, and a double is returned. If none of the values is a double, all of them will be treated as integers, and - an integer is returned. + an integer is returned.</para> </refsect1> </refentry> @@ -508,18 +506,18 @@ </funcsynopsis> <para> <function>min</function> returns the numerically lowest of the - parameter values. + parameter values.</para> <para> If the first parameter is an array, <function>min</function> returns the lowest value in that array. If the first parameter is an integer, string or double, you need at least two parameters and <function>min</function> returns the lowest of these values. - You can compare an unlimited number of values. + You can compare an unlimited number of values.</para> <para> If one or more of the values is a double, all the values will be treated as doubles, and a double is returned. If none of the values is a double, all of them will be treated as integers, and - an integer is returned. + an integer is returned.</para> </refsect1> </refentry> @@ -545,26 +543,24 @@ known characteristics, the Mersenne Twister, which will produce random numbers that should be suitable for cryptographic purposes and is four times faster than what the average libc provides. The - Homepage of the Mersenne Twister can be found at <ulink - url="http://www.math.keio.ac.jp/~matumoto/emt.html">http://www.math.keio.ac.jp/~matumoto/emt.html</ulink>, + Homepage of the Mersenne Twister can be found at <ulink url="http://www.math.keio.ac.jp/~matumoto/emt.html">http://www.math.keio.ac.jp/~matumoto/emt.html</ulink>, and an optimized version of the MT source is available from - <ulink - url="http://www.scp.syr.edu/~marc/hawk/twister.html">http://www.scp.syr.edu/~marc/hawk/twister.html</ulink>. + <ulink url="http://www.scp.syr.edu/~marc/hawk/twister.html">http://www.scp.syr.edu/~marc/hawk/twister.html</ulink>.</simpara> <simpara> If called without the optional min,max arguments <function>mt_rand</function> returns a pseudo-random value between 0 and RAND_MAX. If you want a random number between 5 - and 15 (inclusive), for example, use mt_rand(5,15). + and 15 (inclusive), for example, use mt_rand(5,15).</simpara> <simpara> Remember to seed the random number generator before use with - <function>mt_srand</function>. + <function>mt_srand</function>.</simpara> <simpara> See also <function>mt_srand</function>, <function>mt_getrandmax</function>, <function>srand</function>, <function>rand</function> and - <function>getrandmax</function>. + <function>getrandmax</function>.</simpara> </refsect1> </refentry> @@ -590,14 +586,14 @@ mt_srand((double)microtime()*1000000); $randval = mt_rand(); </programlisting> - </informalexample> + </informalexample></para> <simpara> See also <function>mt_rand</function>, <function>mt_getrandmax</function>, <function>srand</function>, <function>rand</function> and - <function>getrandmax</function>. + <function>getrandmax</function>.</simpara> </refsect1> </refentry> @@ -616,14 +612,14 @@ <simpara> Returns the maximum value that can be returned by a call to - <function>mt_rand</function>. + <function>mt_rand</function>.</simpara> <simpara> See also <function>mt_rand</function>, <function>mt_srand</function> <function>rand</function>, <function>srand</function> and - <function>getrandmax</function>. + <function>getrandmax</function>.</simpara> </refsect1> </refentry> @@ -685,10 +681,10 @@ represented by the octal_string argument. OctDec converts an octal string to a decimal number. The largest number that can be converted is 17777777777 or 2147483647 in - decimal. + decimal.</para> <para> - See also <function>decoct</function>. + See also <function>decoct</function>.</para> </refsect1> </refentry> @@ -706,7 +702,7 @@ </funcsynopsis> <simpara> - Returns an approximation of pi. + Returns an approximation of pi.</simpara> </refsect1> </refentry> @@ -725,9 +721,9 @@ <paramdef>float <parameter>exp</parameter></paramdef> </funcsynopsis> <para> - Returns base raised to the power of exp. + Returns base raised to the power of exp.</para> - <para> See also <function>exp</function>. + <para> See also <function>exp</function>.</para> </refsect1> </refentry> @@ -749,17 +745,17 @@ <simpara> If called without the optional min,max arguments rand() returns a pseudo-random value between 0 and RAND_MAX. If you want a random - number between 5 and 15 (inclusive), for example, use rand(5,15). + number between 5 and 15 (inclusive), for example, use rand(5,15).</simpara> <simpara> Remember to seed the random number generator before use with - <function>srand</function>. + <function>srand</function>.</simpara> <simpara> See also <function>srand</function>, <function>getrandmax</function>, <function>mt_rand</function>, <function>mt_srand</function> and - <function>mt_getrandmax</function>. + <function>mt_getrandmax</function>.</simpara> </refsect1> </refentry> @@ -786,10 +782,10 @@ $foo = round( 3.5 ); // $foo == 4.0 $foo = round( 3.6 ); // $foo == 4.0 </programlisting> - </informalexample> + </informalexample></para> <simpara> - See also <function>ceil</function> and <function>floor</function>. + See also <function>ceil</function> and <function>floor</function>.</simpara> </refsect1> </refentry> @@ -807,10 +803,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the sine of arg in radians. + Returns the sine of arg in radians.</para> <para> - See also <function>cos</function> and <function>tan</function>. + See also <function>cos</function> and <function>tan</function>.</para> </refsect1> </refentry> @@ -829,7 +825,7 @@ </funcsynopsis> <para> - Returns the square root of arg. + Returns the square root of arg.</para> </refsect1> </refentry> @@ -857,14 +853,14 @@ srand((double)microtime()*1000000); $randval = rand(); </programlisting> - </informalexample> + </informalexample></para> <simpara> See also <function>rand</function>, <function>getrandmax</function>, <function>mt_rand</function>, <function>mt_srand</function> and - <function>mt_getrandmax</function>. + <function>mt_getrandmax</function>.</simpara> </refsect1> </refentry> @@ -882,10 +878,10 @@ <paramdef>float <parameter>arg</parameter></paramdef> </funcsynopsis> <para> - Returns the tangent of arg in radians. + Returns the tangent of arg in radians.</para> <para> - See also <function>sin</function> and <function>cos</function>. + See also <function>sin</function> and <function>cos</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/mcal.sgml diff -u phpdoc/functions/mcal.sgml:1.5 phpdoc/functions/mcal.sgml:1.6 --- phpdoc/functions/mcal.sgml:1.5 Sun Sep 12 04:56:58 1999 +++ phpdoc/functions/mcal.sgml Wed Oct 20 18:41:42 1999 @@ -4,34 +4,33 @@ <partintro> <para> - MCAL stands for Modular Calendar Access Library. + MCAL stands for Modular Calendar Access Library.</para> <para> Libmcal is a C library for accessing calendars. It's written to be very modular, with plugable drivers. MCAL is the calendar - equivalent of the IMAP module for mailboxes. + equivalent of the IMAP module for mailboxes.</para> <para> With mcal support, a calendar stream can be opened much like the mailbox stream with the IMAP support. Calendars can be local file stores, remote ICAP servers, or other formats that are supported - by the mcal library. + by the mcal library.</para> <para> Calendar events can be pulled up, queried, and stored. There is - also support for calendar triggers (alarms) and reoccuring events. + also support for calendar triggers (alarms) and reoccuring events.</para> <para> With libmcal, central calendar servers can be accessed and used, removing the need for any specific database or local file - programming. + programming.</para> <para> To get these functions to work, you have to compile PHP with <option role="configure">--with-mcal</option>. That requires the - mcal library to be installed. Grab the latest version from <ulink - url="http://mcal.chek.com/">http://mcal.chek.com/</ulink> and - compile and install it. + mcal library to be installed. Grab the latest version from <ulink url="http://mcal.chek.com/">http://mcal.chek.com/</ulink> and + compile and install it.</para> <para> The following constants are defined when using the MCAL module: @@ -61,7 +60,7 @@ unique for each stream. This alleviates the need to pass around large objects between functions. There are convenience functions for setting, initializing, and retrieving the event structure - values. + values.</para> </partintro> @@ -80,14 +79,14 @@ <paramdef>string <parameter>options</parameter></paramdef> </funcsynopsis> <para> - Returns an MCAL stream on success, false on error. + Returns an MCAL stream on success, false on error.</para> <para> <function>mcal_open</function> opens up an MCAL connection to the specified <parameter>calendar</parameter> store. If the optional <parameter>options</parameter> is specified, passes the <parameter>options</parameter> to that mailbox also. The streams - internal event structure is also initialized upon connection. - <para> + internal event structure is also initialized upon connection.</para> + <para></para> </refsect1> </refentry> @@ -105,7 +104,7 @@ <paramdef>int <parameter>flags</parameter></paramdef> </funcsynopsis> <para> - Closes the given mcal stream. + Closes the given mcal stream.</para> </refsect1> </refentry> @@ -126,56 +125,56 @@ </funcsynopsis> <para> <function>mcal_fetch_event</function> fetches an event from the - calendar stream specified by <parameter>id</parameter>. + calendar stream specified by <parameter>id</parameter>.</para> <para> Returns an event object consisting of: <itemizedlist> <listitem><simpara> - int id - ID of that event. + int id - ID of that event.</simpara></listitem> <listitem><simpara> int public - TRUE if the event if public, FALSE if it is - private. + private.</simpara></listitem> <listitem><simpara> - string category - Category string of the event. + string category - Category string of the event.</simpara></listitem> <listitem><simpara> - string title - Title string of the event. + string title - Title string of the event.</simpara></listitem> <listitem><simpara> - string description - Description string of the event. + string description - Description string of the event.</simpara></listitem> <listitem><simpara> int alarm - number of minutes before the event to send an - alarm/reminder. + alarm/reminder.</simpara></listitem> <listitem><simpara> - object start - Object containing a datetime entry. + object start - Object containing a datetime entry.</simpara></listitem> <listitem><simpara> - object end - Object containing a datetime entry. + object end - Object containing a datetime entry.</simpara></listitem> <listitem><simpara> - int recur_type - recurrence type + int recur_type - recurrence type</simpara></listitem> <listitem><simpara> - int recur_interval - recurrence interval + int recur_interval - recurrence interval</simpara></listitem> <listitem><simpara> - datetime recur_endate - recurrence end date + datetime recur_endate - recurrence end date</simpara></listitem> <listitem><simpara> - int recur_data - recurrence data + int recur_data - recurrence data</simpara></listitem> </itemizedlist> All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> - int year - year + int year - year</simpara></listitem> <listitem><simpara> - int month - month + int month - month</simpara></listitem> <listitem><simpara> - int mday - day of month + int mday - day of month</simpara></listitem> <listitem><simpara> - int hour - hour + int hour - hour</simpara></listitem> <listitem><simpara> - int min - minutes + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - seconds + int sec - seconds</simpara></listitem> <listitem><simpara> - int alarm - minutes before event to send an alarm - </itemizedlist> + int alarm - minutes before event to send an alarm</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -214,12 +213,12 @@ <para> Returns an array of event ID's that are between the start and end dates, or if just a stream is given, uses the start and end dates - in the global event structure. + in the global event structure.</para> <para> <function>mcal_list_events</function> function takes in an optional beginning date and an end date for a calendar stream. An array of event id's that are between the given dates or the - internal event dates are returned. + internal event dates are returned.</para> </refsect1> </refentry> @@ -237,10 +236,10 @@ </funcsynopsis> <para> <function>mcal_store_event</function> Stores the global event - into an MCAL calendar for the given stream. + into an MCAL calendar for the given stream.</para> <para> - Returns true on success and false on error. - <para> + Returns true on success and false on error.</para> + <para></para> </refsect1> </refentry> @@ -258,9 +257,9 @@ </funcsynopsis> <para> <function>mcal_delete_event</function> deletes the calendar event - specified by the uid. + specified by the uid.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -277,9 +276,9 @@ </funcsynopsis> <para> <function>mcal_snooze</function> turns off an alarm for a - calendar event specified by the uid. + calendar event specified by the uid.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -318,12 +317,12 @@ <para> Returns an array of event ID's that has an alarm going off between the start and end dates, or if just a stream is given, - uses the start and end dates in the global event structure. + uses the start and end dates in the global event structure.</para> <para> <function>mcal_list_events</function> function takes in an optional beginning date and an end date for a calendar stream. An array of event id's that are between the given dates or the - internal event dates are returned. + internal event dates are returned.</para> </refsect1> </refentry> @@ -343,9 +342,9 @@ <para> <function>mcal_event_init</function> initializes a streams global event structure. this effectively sets all elements of the - structure to 0, or the default settings. + structure to 0, or the default settings.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -365,9 +364,9 @@ </funcsynopsis> <para> <function>mcal_event_set_category</function> sets the streams - global event structure's category to the given string. + global event structure's category to the given string.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -387,9 +386,9 @@ </funcsynopsis> <para> <function>mcal_event_set_title</function> sets the streams global - event structure's title to the given string. + event structure's title to the given string.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -411,9 +410,9 @@ </funcsynopsis> <para> <function>mcal_event_set_description</function> sets the streams - global event structure's description to the given string. + global event structure's description to the given string.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -454,9 +453,9 @@ </funcsynopsis> <para> <function>mcal_event_set_start</function> sets the streams global - event structure's start date and time to the given values. + event structure's start date and time to the given values.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -497,9 +496,9 @@ </funcsynopsis> <para> <function>mcal_event_set_end</function> sets the streams global - event structure's end date and time to the given values. + event structure's end date and time to the given values.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -519,9 +518,9 @@ </funcsynopsis> <para> <function>mcal_event_set_alarm</function> sets the streams global - event structure's alarm to the given minutes before the event. + event structure's alarm to the given minutes before the event.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -542,9 +541,9 @@ <para> <function>mcal_event_set_class</function> sets the streams global event structure's class to the given value. The class is either 0 - for public, or 1 for private. + for public, or 1 for private.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -564,7 +563,7 @@ </funcsynopsis> <para> <function>mcal_is_leap_year</function> returns 1 if the given - year is a leap year, 1 if not. + year is a leap year, 1 if not.</para> </refsect1> </refentry> @@ -585,7 +584,7 @@ <para> <function>mcal_days_in_month</function> Returns the number of days in the given month, taking into account if the given year is - a leap year or not. + a leap year or not.</para> </refsect1> </refentry> @@ -606,7 +605,7 @@ </funcsynopsis> <para> <function>mcal_date_valid</function> Returns true if the given - year, month and day is a valid date, false if not. + year, month and day is a valid date, false if not.</para> </refsect1> </refentry> @@ -627,7 +626,7 @@ </funcsynopsis> <para> <function>mcal_time_valid</function> Returns true if the given - hour, minutes and seconds is a valid time, false if not. + hour, minutes and seconds is a valid time, false if not.</para> </refsect1> </refentry> @@ -648,9 +647,9 @@ </funcsynopsis> <para> <function>mcal_day_of_week</function> returns the day of the week - of the given date + of the given date</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -671,9 +670,9 @@ </funcsynopsis> <para> <function>mcal_day_of_year</function> returns the day of the year - of the given date + of the given date</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -695,7 +694,7 @@ </funcsynopsis> <para> <function>mcal_date_compare</function> Compares the two given - dates, returns &lt;0, 0, >0 if a&lt;b, a==b, a>b respectively + dates, returns &lt;0, 0, >0 if a&lt;b, a==b, a>b respectively</para> </refsect1> </refentry> @@ -717,9 +716,9 @@ filled with the next date the event occurs, on or after the supplied date. Returns empty date field if event does not occur or something is invalid. Uses weekstart to determine what day is - considered the beginning of the week. + considered the beginning of the week.</para> <para> - Returns true. + Returns true.</para> </refsect1> </refentry> @@ -748,7 +747,7 @@ <para> <function>mcal_event_set_recur_daily</function> sets the streams global event structure's recurrence to the given value to be - reoccuring on a daily basis, ending at the given date. + reoccuring on a daily basis, ending at the given date.</para> </refsect1> </refentry> @@ -778,7 +777,7 @@ <para> <function>mcal_event_set_recur_weekly</function> sets the streams global event structure's recurrence to the given value to be - reoccuring on a weekly basis, ending at the given date. + reoccuring on a weekly basis, ending at the given date.</para> </refsect1> </refentry> @@ -808,7 +807,7 @@ <function>mcal_event_set_recur_monthly_mday</function> sets the streams global event structure's recurrence to the given value to be reoccuring on a monthly by month day basis, ending at the - given date. + given date.</para> </refsect1> </refentry> @@ -838,7 +837,7 @@ <function>mcal_event_set_recur_monthly_wday</function> sets the streams global event structure's recurrence to the given value to be reoccuring on a monthly by week basis, ending at the given - date. + date.</para> </refsect1> </refentry> @@ -867,7 +866,7 @@ <para> <function>mcal_event_set_recur_yearly</function> sets the streams global event structure's recurrence to the given value to be - reoccuring on a yearly basis,ending at the given date . + reoccuring on a yearly basis,ending at the given date .</para> </refsect1> </refentry> @@ -893,55 +892,55 @@ <itemizedlist> <listitem><simpara> - int id - ID of that event. + int id - ID of that event.</simpara></listitem> <listitem><simpara> int public - TRUE if the event if public, FALSE if it is - private. + private.</simpara></listitem> <listitem><simpara> - string category - Category string of the event. + string category - Category string of the event.</simpara></listitem> <listitem><simpara> - string title - Title string of the event. + string title - Title string of the event.</simpara></listitem> <listitem><simpara> - string description - Description string of the event. + string description - Description string of the event.</simpara></listitem> <listitem><simpara> int alarm - number of minutes before the event to send an - alarm/reminder. + alarm/reminder.</simpara></listitem> <listitem><simpara> - object start - Object containing a datetime entry. + object start - Object containing a datetime entry.</simpara></listitem> <listitem><simpara> - object end - Object containing a datetime entry. + object end - Object containing a datetime entry.</simpara></listitem> <listitem><simpara> - int recur_type - recurrence type + int recur_type - recurrence type</simpara></listitem> <listitem><simpara> - int recur_interval - recurrence interval + int recur_interval - recurrence interval</simpara></listitem> <listitem><simpara> - datetime recur_endate - recurrence end date + datetime recur_endate - recurrence end date</simpara></listitem> <listitem><simpara> - int recur_data - recurrence data + int recur_data - recurrence data</simpara></listitem> </itemizedlist> All datetime entries consist of an object that contains: <itemizedlist> <listitem><simpara> - int year - year + int year - year</simpara></listitem> <listitem><simpara> - int month - month + int month - month</simpara></listitem> <listitem><simpara> - int mday - day of month + int mday - day of month</simpara></listitem> <listitem><simpara> - int hour - hour + int hour - hour</simpara></listitem> <listitem><simpara> - int min - minutes + int min - minutes</simpara></listitem> <listitem><simpara> - int sec - seconds + int sec - seconds</simpara></listitem> <listitem><simpara> - int alarm - minutes before event to send an alarm - </itemizedlist> + int alarm - minutes before event to send an alarm</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> - +</reference> <!-- Keep this comment at the end of the file Local variables: Index: phpdoc/functions/mcrypt.sgml diff -u phpdoc/functions/mcrypt.sgml:1.3 phpdoc/functions/mcrypt.sgml:1.4 --- phpdoc/functions/mcrypt.sgml:1.3 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/mcrypt.sgml Wed Oct 20 18:41:42 1999 @@ -4,21 +4,19 @@ <partintro> <para> - These functions work using <ulink url="&url.mcrypt;">mcrypt</ulink>. + These functions work using <ulink url="&url.mcrypt;">mcrypt</ulink>.</para> <para> This is an interface to the mcrypt library, which supports a wide variety of block algorithms such as DES, TripleDES, Blowfish (default), 3-WAY, SAFER-SK64, SAFER-SK128, TWOFISH, TEA, RC2 and GOST in CBC, OFB, CFB and ECB cipher modes. Additionally, it - supports RC6 and IDEA which are considered "non-free". + supports RC6 and IDEA which are considered "non-free".</para> <para> - To use it, download libmcrypt-x.x.tar.gz from <ulink - url="&url.mcrypt;">here</ulink> and follow the included - installation instructions. You need to compile PHP with the <option - role="configure">--with-mcrypt</option> parameter to enable this - extension. + To use it, download libmcrypt-x.x.tar.gz from <ulink url="&url.mcrypt;">here</ulink> and follow the included + installation instructions. You need to compile PHP with the <option role="configure">--with-mcrypt</option> parameter to enable this + extension.</para> <para> mcrypt can be used to encrypt and decrypt using the above @@ -41,7 +39,7 @@ </example> This example will give you the encrypted data as a string in - $encrypted_data. + $encrypted_data.</para> <para> mcrypt can operate in four cipher modes (CBC, OFB, CFB, and ECB). We will @@ -52,29 +50,29 @@ <listitem><simpara> ECB (electronic codebook) is suitable for random data, such as encrypting other keys. Since data there is short and random, the disadvantages of - ECB have a favorable negative effect. + ECB have a favorable negative effect.</simpara></listitem> <listitem><simpara> CBC (cipher block chaining) is especially suitable for encrypting files - where the security is increased over ECB significantly. + where the security is increased over ECB significantly.</simpara></listitem> <listitem><simpara> CFB (cipher feedback) is the best mode for encrypting byte streams where - single bytes must be encrypted. + single bytes must be encrypted.</simpara></listitem> <listitem><simpara> OFB (output feedback) is comparable to CFB, but can be used in - applications where error propagation cannot be tolerated. - </itemizedlist> + applications where error propagation cannot be tolerated.</simpara></listitem> + </itemizedlist></para> <para> PHP does not support encrypting/decrypting bit streams currently. As of - now, PHP only supports handling of strings. + now, PHP only supports handling of strings.</para> <para> For a complete list of supported ciphers, see the defines at the end of mcrypt.h. The general rule is that you can access the cipher from PHP with - MCRYPT_ciphername. + MCRYPT_ciphername.</para> <para> Here is a short list of ciphers which are currently supported by the @@ -85,43 +83,43 @@ <itemizedlist> <listitem><simpara> - MCRYPT_BLOWFISH + MCRYPT_BLOWFISH</simpara></listitem> <listitem><simpara> - MCRYPT_DES + MCRYPT_DES</simpara></listitem> <listitem><simpara> - MCRYPT_TripleDES + MCRYPT_TripleDES</simpara></listitem> <listitem><simpara> - MCRYPT_ThreeWAY + MCRYPT_ThreeWAY</simpara></listitem> <listitem><simpara> - MCRYPT_GOST + MCRYPT_GOST</simpara></listitem> <listitem><simpara> - MCRYPT_CRYPT + MCRYPT_CRYPT</simpara></listitem> <listitem><simpara> - MCRYPT_DES_COMPAT + MCRYPT_DES_COMPAT</simpara></listitem> <listitem><simpara> - MCRYPT_SAFER64 + MCRYPT_SAFER64</simpara></listitem> <listitem><simpara> - MCRYPT_SAFER128 + MCRYPT_SAFER128</simpara></listitem> <listitem><simpara> - MCRYPT_CAST128 + MCRYPT_CAST128</simpara></listitem> <listitem><simpara> - MCRYPT_TEAN + MCRYPT_TEAN</simpara></listitem> <listitem><simpara> - MCRYPT_RC2 + MCRYPT_RC2</simpara></listitem> <listitem><simpara> - MCRYPT_TWOFISH (for older mcrypt 2.x versions) + MCRYPT_TWOFISH (for older mcrypt 2.x versions)</simpara></listitem> <listitem><simpara> - MCRYPT_TWOFISH128 (TWOFISHxxx are available in newer 2.x versions) + MCRYPT_TWOFISH128 (TWOFISHxxx are available in newer 2.x versions)</simpara></listitem> <listitem><simpara> - MCRYPT_TWOFISH192 + MCRYPT_TWOFISH192</simpara></listitem> <listitem><simpara> - MCRYPT_TWOFISH256 + MCRYPT_TWOFISH256</simpara></listitem> <listitem><simpara> - MCRYPT_RC6 + MCRYPT_RC6</simpara></listitem> <listitem><simpara> - MCRYPT_IDEA + MCRYPT_IDEA</simpara></listitem> - </itemizedlist> + </itemizedlist></para> <para> You must (in CFB and OFB mode) or can (in CBC mode) supply an @@ -131,7 +129,7 @@ under which the data is stored (e.g. the MD5 key of the filename). Alternatively, you can transmit the IV together with the encrypted data (see chapter 9.3 of &book.applied.cryptography; for a discussion of this - topic). + topic).</para> </partintro> @@ -149,12 +147,12 @@ <para> <function>mcrypt_get_cipher_name</function> is used to get the name of the - specified cipher. + specified cipher.</para> <para> <function>mcrypt_get_cipher_name</function> takes the cipher number as an argument and returns the name of the cipher or false, if the cipher does - not exist. + not exist.</para> <para> <example> @@ -166,13 +164,13 @@ print mcrypt_get_cipher_name($cipher); ?&gt; </programlisting> - </example> + </example></para> <para> The above example will produce: <programlisting> TripleDES - </programlisting> + </programlisting></para> </refsect1> </refentry> @@ -191,14 +189,14 @@ <para> <function>mcrypt_get_block_size</function> is used to get the size of a - block of the specified <parameter>cipher</parameter>. + block of the specified <parameter>cipher</parameter>.</para> <para> <function>mcrypt_get_block_size</function> takes one argument, the - <parameter>cipher</parameter> and returns the size in bytes. + <parameter>cipher</parameter> and returns the size in bytes.</para> <para> - See also: <function>mcrypt_get_key_size</function> + See also: <function>mcrypt_get_key_size</function></para> </refsect1> </refentry> @@ -217,14 +215,14 @@ <para> <function>mcrypt_get_key_size</function> is used to get the size of a key - of the specified <parameter>cipher</parameter>. + of the specified <parameter>cipher</parameter>.</para> <para> <function>mcrypt_get_key_size</function> takes one argument, the - <parameter>cipher</parameter> and returns the size in bytes. + <parameter>cipher</parameter> and returns the size in bytes.</para> <para> - See also: <function>mcrypt_get_block_size</function> + See also: <function>mcrypt_get_block_size</function></para> </refsect1> </refentry> @@ -244,18 +242,18 @@ </funcsynopsis> <para> - <function>mcrypt_create_iv</function> is used to create an IV. + <function>mcrypt_create_iv</function> is used to create an IV.</para> <para> <function>mcrypt_create_iv</function> takes two arguments, <parameter>size</parameter> determines the size of the IV, - <parameter>source</parameter> specifies the source of the IV. + <parameter>source</parameter> specifies the source of the IV.</para> <para> The source can be MCRYPT_RAND (system random number generator), MCRYPT_DEV_RANDOM (read data from /dev/random) and MCRYPT_DEV_URANDOM (read data from /dev/urandom). If you use MCRYPT_RAND, make sure to call - srand() before to initialize the random number generator. + srand() before to initialize the random number generator.</para> <para> <example> @@ -267,7 +265,7 @@ $iv = mcrypt_create_iv($block_size, MCRYPT_DEV_RANDOM); ?&gt; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -292,30 +290,30 @@ <function>mcrypt_cbc</function> encrypts or decrypts (depending on <parameter>mode</parameter>) the <parameter>data</parameter> with <parameter>cipher</parameter> and <parameter>key</parameter> in CBC cipher - mode and returns the resulting string. + mode and returns the resulting string.</para> <para> - <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants. + <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants.</para> <para> <parameter>key</parameter> is the key supplied to the algorithm. It must - be kept secret. + be kept secret.</para> <para> <parameter>data</parameter> is the data which shall be - encrypted/decrypted. + encrypted/decrypted.</para> <para> - <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT. + <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT.</para> <para> - <parameter>iv</parameter> is the optional initialization vector. + <parameter>iv</parameter> is the optional initialization vector.</para> <para> See also: <function>mcrypt_cfb</function>, <function>mcrypt_ecb</function>, - <function>mcrypt_ofb</function> + <function>mcrypt_ofb</function></para> </refsect1> </refentry> @@ -340,30 +338,30 @@ <function>mcrypt_cfb</function> encrypts or decrypts (depending on <parameter>mode</parameter>) the <parameter>data</parameter> with <parameter>cipher</parameter> and <parameter>key</parameter> in CFB cipher - mode and returns the resulting string. + mode and returns the resulting string.</para> <para> - <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants. + <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants.</para> <para> <parameter>key</parameter> is the key supplied to the algorithm. It must - be kept secret. + be kept secret.</para> <para> <parameter>data</parameter> is the data which shall be - encrypted/decrypted. + encrypted/decrypted.</para> <para> - <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT. + <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT.</para> <para> - <parameter>iv</parameter> is the initialization vector. + <parameter>iv</parameter> is the initialization vector.</para> <para> See also: <function>mcrypt_cbc</function>, <function>mcrypt_ecb</function>, - <function>mcrypt_ofb</function> + <function>mcrypt_ofb</function></para> </refsect1> </refentry> @@ -387,27 +385,27 @@ <function>mcrypt_ecb</function> encrypts or decrypts (depending on <parameter>mode</parameter>) the <parameter>data</parameter> with <parameter>cipher</parameter> and <parameter>key</parameter> in ECB cipher - mode and returns the resulting string. + mode and returns the resulting string.</para> <para> - <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants. + <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants.</para> <para> <parameter>key</parameter> is the key supplied to the algorithm. It must - be kept secret. + be kept secret.</para> <para> <parameter>data</parameter> is the data which shall be - encrypted/decrypted. + encrypted/decrypted.</para> <para> - <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT. + <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT.</para> <para> See also: <function>mcrypt_cbc</function>, <function>mcrypt_cfb</function>, - <function>mcrypt_ofb</function> + <function>mcrypt_ofb</function></para> </refsect1> </refentry> @@ -432,30 +430,30 @@ <function>mcrypt_ofb</function> encrypts or decrypts (depending on <parameter>mode</parameter>) the <parameter>data</parameter> with <parameter>cipher</parameter> and <parameter>key</parameter> in OFB cipher - mode and returns the resulting string. + mode and returns the resulting string.</para> <para> - <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants. + <parameter>cipher</parameter> is one of the MCRYPT_ciphername constants.</para> <para> <parameter>key</parameter> is the key supplied to the algorithm. It must - be kept secret. + be kept secret.</para> <para> <parameter>data</parameter> is the data which shall be - encrypted/decrypted. + encrypted/decrypted.</para> <para> - <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT. + <parameter>mode</parameter> is MCRYPT_ENCRYPT or MCRYPT_DECRYPT.</para> <para> - <parameter>iv</parameter> is the initialization vector. + <parameter>iv</parameter> is the initialization vector.</para> <para> See also: <function>mcrypt_cbc</function>, <function>mcrypt_cfb</function>, - <function>mcrypt_ecb</function> + <function>mcrypt_ecb</function></para> </refsect1> </refentry> Index: phpdoc/functions/mhash.sgml diff -u phpdoc/functions/mhash.sgml:1.4 phpdoc/functions/mhash.sgml:1.5 --- phpdoc/functions/mhash.sgml:1.4 Thu Jul 29 15:51:52 1999 +++ phpdoc/functions/mhash.sgml Wed Oct 20 18:41:42 1999 @@ -4,22 +4,19 @@ <partintro> <para> - These functions are intended to work with <ulink - url="&url.mhash;">mhash</ulink>. + These functions are intended to work with <ulink url="&url.mhash;">mhash</ulink>.</para> <para> This is an interface to the mhash library. mhash supports a wide variety of - hash algorithms such as MD5, SHA1, GOST, and many others. + hash algorithms such as MD5, SHA1, GOST, and many others.</para> <para> - To use it, download the mhash distribution from <ulink - url="&url.mhash;">its web site</ulink> and follow the included - installation instructions. You need to compile PHP with the <option - role="configure">--with-mhash</option> parameter to enable this - extension. + To use it, download the mhash distribution from <ulink url="&url.mhash;">its web site</ulink> and follow the included + installation instructions. You need to compile PHP with the <option role="configure">--with-mhash</option> parameter to enable this + extension.</para> <para> - mhash can be used to create checksums, message digests, and more. + mhash can be used to create checksums, message digests, and more.</para> <para> <example> @@ -44,7 +41,7 @@ For a complete list of supported hashes, refer to the documentation of mhash. The general rule is that you can access the hash algorithm from PHP with MHASH_HASHNAME. For example, to access HAVAL you use the PHP constant - MHASH_HAVAL. + MHASH_HAVAL.</para> <para> Here is a list of hashes which are currently supported by mhash. If a @@ -54,27 +51,27 @@ <itemizedlist> <listitem><simpara> - MHASH_MD5 + MHASH_MD5</simpara></listitem> <listitem><simpara> - MHASH_SHA1 + MHASH_SHA1</simpara></listitem> <listitem><simpara> - MHASH_HAVAL + MHASH_HAVAL</simpara></listitem> <listitem><simpara> - MHASH_RIPEMD160 + MHASH_RIPEMD160</simpara></listitem> <listitem><simpara> - MHASH_RIPEMD128 + MHASH_RIPEMD128</simpara></listitem> <listitem><simpara> - MHASH_SNEFRU + MHASH_SNEFRU</simpara></listitem> <listitem><simpara> - MHASH_TIGER + MHASH_TIGER</simpara></listitem> <listitem><simpara> - MHASH_GOST + MHASH_GOST</simpara></listitem> <listitem><simpara> - MHASH_CRC32 + MHASH_CRC32</simpara></listitem> <listitem><simpara> - MHASH_CRC32B + MHASH_CRC32B</simpara></listitem> - </itemizedlist> + </itemizedlist></para> </partintro> @@ -92,11 +89,11 @@ <para> <function>mhash_get_hash_name</function> is used to get the name of the - specified hash. + specified hash.</para> <para> <function>mhash_get_hash_name</function> takes the hash id as an argument - and returns the name of the hash or false, if the hash does not exist. + and returns the name of the hash or false, if the hash does not exist.</para> <para> <example> @@ -113,7 +110,7 @@ The above example will print out: <programlisting> MD5 - </programlisting> + </programlisting></para> </refsect1> </refentry> @@ -132,12 +129,12 @@ <para> <function>mhash_get_block_size</function> is used to get the size of a - block of the specified <parameter>hash</parameter>. + block of the specified <parameter>hash</parameter>.</para> <para> <function>mhash_get_block_size</function> takes one argument, the <parameter>hash</parameter> and returns the size in bytes or false, if - the <parameter>hash</parameter> does not exist. + the <parameter>hash</parameter> does not exist.</para> </refsect1> </refentry> @@ -156,7 +153,7 @@ <para> <function>mhash_count</function> returns the highest available hash - id. Hashes are numbered from 0 to this hash id. + id. Hashes are numbered from 0 to this hash id.</para> <para> <example> @@ -173,7 +170,7 @@ } ?&gt; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -194,7 +191,7 @@ <para> <function>mhash</function> applies a hash function specified by <parameter>hash</parameter> to the <parameter>data</parameter> and - returns the resulting hash (also called digest). + returns the resulting hash (also called digest).</para> </refsect1> </refentry> Index: phpdoc/functions/misc.sgml diff -u phpdoc/functions/misc.sgml:1.9 phpdoc/functions/misc.sgml:1.10 --- phpdoc/functions/misc.sgml:1.9 Tue Sep 21 19:01:36 1999 +++ phpdoc/functions/misc.sgml Wed Oct 20 18:41:42 1999 @@ -5,7 +5,7 @@ <partintro> <para> These functions were placed here because none of the other - categories seemed to fit. + categories seemed to fit.</para> </partintro> <refentry id="function.connection-aborted"> @@ -20,8 +20,7 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <simpara> - Returns true if client disconnected. See the <link - linkend="features.connection-handling">Connection Handling</link> + Returns true if client disconnected. See the <link linkend="features.connection-handling">Connection Handling</link> description in the <link linkend="features">Features </link> chapter for a complete explanation. </simpara> @@ -40,10 +39,8 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <simpara> - Returns the connection status bitfield. See the <link - linkend="features.connection-handling">Connection - Handling</link> description in the <link - linkend="features">Features</link> chapter for a complete + Returns the connection status bitfield. See the <link linkend="features.connection-handling">Connection + Handling</link> description in the <link linkend="features">Features</link> chapter for a complete explanation. </simpara> </refsect1> @@ -61,8 +58,7 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <simpara> - Returns true if script timed out. See the <link - linkend="features.connection-handling">Connection Handling</link> + Returns true if script timed out. See the <link linkend="features.connection-handling">Connection Handling</link> description in the <link linkend="features">Features</link> chapter for a complete explanation. </simpara> @@ -108,11 +104,11 @@ Constants may only evaluate to scalar values. </simpara> </listitem> - </itemizedlist> + </itemizedlist></para> <para> The name of the constant is given by <parameter>name</parameter>; - the value is given by <parameter>value</parameter>. + the value is given by <parameter>value</parameter>.</para> <para> The optional third parameter @@ -120,7 +116,7 @@ value <emphasis>1</emphasis> is given, then the constant will be defined case-insensitive. The default behaviour is case-sensitive; i.e. CONSTANT and Constant represent different - values. + values.</para> <para> <example> @@ -131,15 +127,14 @@ echo CONSTANT; // outputs "Hello world." ?&gt; </programlisting> - </example> + </example></para> <para> <function>define</function> returns TRUE on success and FALSE if - an error occurs. + an error occurs.</para> <para> - See also <function>defined</function> and the section on <link - linkend="language.constants">Constants</link>. + See also <function>defined</function> and the section on <link linkend="language.constants">Constants</link>.</para> </refsect1> </refentry> @@ -158,11 +153,10 @@ <para> Returns TRUE if the named constant given by - <parameter>name</parameter> has been defined, false otherwise. + <parameter>name</parameter> has been defined, false otherwise.</para> <para> - See also <function>define</function> and the section on <link - linkend="language.constants">Constants</link>. + See also <function>define</function> and the section on <link linkend="language.constants">Constants</link>.</para> </refsect1> </refentry> @@ -180,7 +174,7 @@ </funcsynopsis> <simpara> This language construct outputs a message and terminates parsing - of the script. It does not return. + of the script. It does not return.</simpara> <para> <example> <title>die example</title> @@ -191,7 +185,7 @@ or die "unable to open file ($filename)"; ?&gt; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -211,7 +205,7 @@ <function>eval</function> evaluates the string given in <parameter>code_str</parameter> as PHP code. Among other things, this can be useful for storing code in a database text field for - later execution. + later execution.</simpara> <simpara> There are some factors to keep in mind when using @@ -219,12 +213,12 @@ be valid PHP code, including things like terminating statements with a semicolon so the parser doesn't die on the line after the <function>eval</function>, and properly escaping things in - <parameter>code_str</parameter>. + <parameter>code_str</parameter>.</simpara> <simpara> Also remember that variables given values under <function>eval</function> will retain these values in the main - script afterwards. + script afterwards.</simpara> <para> <example> @@ -239,14 +233,14 @@ echo $str; ?&gt; </programlisting> - </example> + </example></para> <para> The above example will show: <programlisting> This is a $string with my $name in it. This is a cup with my coffee in it. - </programlisting> + </programlisting></para> </refsect1> </refentry> @@ -264,7 +258,7 @@ </funcsynopsis> <simpara> This language construct terminates parsing of the script. It - does not return. + does not return.</simpara> </refsect1> </refentry> @@ -374,8 +368,7 @@ </programlisting> <simpara> - In order for this to work, your <link - linkend="ini.sect.browscap">browscap</link> configuration file + In order for this to work, your <link linkend="ini.sect.browscap">browscap</link> configuration file setting must point to the correct location of the <filename>browscap.ini</filename> file. </simpara> @@ -383,8 +376,7 @@ <simpara> For more information (including locations from which you may obtain a <filename>browscap.ini</filename> file), check the PHP - FAQ at <ulink - url="&url.php.faq;">http://www.php.net/FAQ.html</ulink>. + FAQ at <ulink url="&url.php.faq;">http://www.php.net/FAQ.html</ulink>. </simpara> <note> @@ -436,7 +428,7 @@ This function parses a binary IPTC block into its single tags. It returns an array using the tagmarker as an index and the value as the value. It returns false on error or if no IPTC data was - found. See <function>GetImageSize</function> for a sample. + found. See <function>GetImageSize</function> for a sample.</simpara> </refsect1> </refentry> @@ -452,10 +444,10 @@ <paramdef>int <parameter>bytes</parameter></paramdef> </funcsynopsis> <simpara> - <function>Leak</function> leaks the specified amount of memory. + <function>Leak</function> leaks the specified amount of memory.</simpara> <simpara> This is useful when debugging the memory manager, which automatically - cleans up "leaked" memory when each request is completed. + cleans up "leaked" memory when each request is completed.</simpara> </refsect1> </refentry> @@ -473,7 +465,7 @@ </funcsynopsis> <para> Pack given arguments into binary string according to - <parameter>format</parameter>. Returns binary string containing data. + <parameter>format</parameter>. Returns binary string containing data.</para> <para> The idea to this function was taken from Perl and all formatting @@ -518,25 +510,25 @@ <example> <title>pack format string</title> - <programlisting role=php> + <programlisting role="php"> $binarydata = pack("nvc*", 0x1234, 0x5678, 65, 66); </programlisting> <para> The resulting binary string will be 6 bytes long and contain - the byte sequence 0x12, 0x34, 0x78, 0x56, 0x41, 0x42. - </example> + the byte sequence 0x12, 0x34, 0x78, 0x56, 0x41, 0x42.</para> + </example></para> <para> Note that the distinction between signed and unsigned values only affects the function <function>unpack</function>, where as function <function>pack</function> gives the same result for - signed and unsigned format codes. + signed and unsigned format codes.</para> <para> Also note that PHP internally stores integral values as signed values of a machine dependant size. If you give it an unsigned integral value too large to be stored that way it is converted to - a double which often yields an undesired result. + a double which often yields an undesired result.</para> </refsect1> </refentry> @@ -554,12 +546,12 @@ </funcsynopsis> <simpara> Registers the function named by <parameter>func</parameter> to be - executed when script processing is complete. + executed when script processing is complete.</simpara> <para> - Common Pitfalls: + Common Pitfalls:</para> <simpara> Since no output is allowed to the browser in this function, you will be - unable to debug it using statements such as print or echo. + unable to debug it using statements such as print or echo.</simpara> </refsect1> </refentry> @@ -577,21 +569,21 @@ <simpara> <function>serialize</function> returns a string containing a byte-stream representation of <parameter>value</parameter> that - can be stored anywhere. + can be stored anywhere.</simpara> <simpara> This is useful for storing or passing PHP values around without - losing their type and structure. + losing their type and structure.</simpara> <simpara> To make the serialized string into a PHP value again, use <function>unserialize</function>. <function>serialize</function> handles the types <type>integer</type>, <type>double</type>, <type>string</type>, <type>array</type> (multidimensional) and <type>object</type> (object properties will be serialized, but - methods are lost). + methods are lost).</simpara> <para> <example> <title>serialize example</title> - <programlisting role=php> + <programlisting role="php"> // $session_data contains a multi-dimensional array with session // information for the current user. We use serialize() to store // it in a database at the end of the request. @@ -608,7 +600,7 @@ } } </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -625,9 +617,9 @@ </funcsynopsis> <simpara> The sleep function delays program execution for the given number - of <parameter>seconds</parameter>. + of <parameter>seconds</parameter>.</simpara> <simpara> - See also <function>usleep</function>. + See also <function>usleep</function>.</simpara> </refsect1> </refentry> @@ -666,7 +658,7 @@ <note> <simpara> The <parameter>lcg</parameter> parameter is only available in - PHP 4 and PHP 3.0.13 and later. + PHP 4 and PHP 3.0.13 and later. </simpara> </note> @@ -677,10 +669,10 @@ <informalexample><programlisting> $token = md5(uniqid("")); // no random portion $better_token = md5(uniqid(rand())); // better, difficult to guess -</programlisting></informalexample> +</programlisting></informalexample></para> <simpara> This will create a 32 character identifier (a 128 bit hex number) - that is extremely difficult to predict. + that is extremely difficult to predict.</simpara> </refsect1> </refentry> @@ -699,7 +691,7 @@ <para> Unpack from binary string into array according to <parameter>format</parameter>. Returns array containing unpacked - elements of binary string. + elements of binary string.</para> <para> Unpack works slightly different from Perl as the unpacked data is @@ -708,23 +700,23 @@ <example> <title>unpack format string</title> - <programlisting role=php> + <programlisting role="php"> $array = unpack("c2chars/nint", $binarydata); </programlisting> <para> The resulting array will contain the entries "chars1", - "chars2" and "int". - </example> + "chars2" and "int".</para> + </example></para> <para> For an explanation of the format codes see also: - <function>pack</function> + <function>pack</function></para> <para> Note that PHP internally stores integral values as signed. If you unpack a large unsigned long and it is of the same size as PHP internally stored values the result will be a negative number - even though unsigned unpacking was specified. + even though unsigned unpacking was specified.</para> </refsect1> </refentry> @@ -747,11 +739,11 @@ be an <type>integer</type>, <type>double</type>, <type>string</type>, <type>array</type> or <type>object</type>. If an object was serialized, its methods are not preserved in the - returned value. + returned value.</simpara> <para> <example> <title>unserialize example</title> - <programlisting role=php> + <programlisting role="php"> // Here, we use unserialize() to load session data from a database // into $session_data. This example complements the one described // with <function>serialize</function>. @@ -771,7 +763,7 @@ } } </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -788,9 +780,9 @@ </funcsynopsis> <simpara> The sleep function delays program execution for the given number - of <parameter>micro_seconds</parameter>. + of <parameter>micro_seconds</parameter>.</simpara> <simpara> - See also <function>sleep</function>. + See also <function>sleep</function>.</simpara> </refsect1> </refentry> Index: phpdoc/functions/msql.sgml diff -u phpdoc/functions/msql.sgml:1.4 phpdoc/functions/msql.sgml:1.5 --- phpdoc/functions/msql.sgml:1.4 Mon Jul 19 16:17:53 1999 +++ phpdoc/functions/msql.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.msql"> <title>mSQL functions</title> <titleabbrev>mSQL</titleabbrev> @@ -18,14 +17,14 @@ </funcsynopsis> <para> Returns a positive mSQL query identifier to the query result, or - false on error. + false on error.</para> <para> <function>msql</function> selects a database and executes a query on it. If the optional link identifier isn't specified, the function will try to find an open link to the mSQL server and if no such link is found it'll try to create one as if <function>msql_connect</function> was called with no arguments - (see <function>msql_connect</function>). + (see <function>msql_connect</function>).</para> </refsect1> </refentry> @@ -44,10 +43,10 @@ <para> Returns number of affected ("touched") rows by a specific query (i.e. the number of rows returned by a SELECT, the number of rows - modified by an update, or the number of rows removed by a delete). + modified by an update, or the number of rows removed by a delete).</para> <para> See also: - <function>msql_query</function> + <function>msql_query</function></para> </refsect1> </refentry> @@ -64,22 +63,22 @@ <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> msql_close() closes the link to a mSQL database that's associated with the specified link identifier. If the link identifier isn't - specified, the last opened link is assumed. + specified, the last opened link is assumed.</para> <para> Note that this isn't usually necessary, as non-persistent open links are automatically closed at the end of the script's - execution. + execution.</para> <para> msql_close() will not close persistent links generated by - <function>msql_pconnect</function>. + <function>msql_pconnect</function>.</para> <para> See also: <function>msql_connect</function> and - <function>msql_pconnect</function>. + <function>msql_pconnect</function>.</para> </refsect1> </refentry> @@ -97,23 +96,23 @@ </funcsynopsis> <para> Returns a positive mSQL link identifier on success, or false on - error. + error.</para> <para> msql_connect() establishes a connection to a mSQL server. The hostname argument is optional, and if it's missing, localhost is - assumed. + assumed.</para> <para> In case a second call is made to msql_connect() with the same arguments, no new link will be established, but instead, the link - identifier of the already opened link will be returned. + identifier of the already opened link will be returned.</para> <para> The link to the server will be closed as soon as the execution of the script ends, unless it's closed earlier by explicitly calling - <function>msql_close</function>. + <function>msql_close</function>.</para> <para> See also <function>msql_pconnect</function>, - <function>msql_close</function>. + <function>msql_close</function>.</para> </refsect1> </refentry> @@ -133,10 +132,10 @@ </funcsynopsis> <para> msql_create_db() attempts to create a new database on the server - associated with the specified link identifier. + associated with the specified link identifier.</para> <para> See also: - <function>msql_drop_db</function>. + <function>msql_drop_db</function>.</para> </refsect1> </refentry> @@ -155,7 +154,7 @@ </parameter></paramdef> </funcsynopsis> <para> - Identical to <function>msql_create_db</function>. + Identical to <function>msql_create_db</function>.</para> </refsect1> </refentry> @@ -174,15 +173,15 @@ <paramdef>int <parameter>row_number</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on failure. + Returns true on success, false on failure.</para> <para> msql_data_seek() moves the internal row pointer of the mSQL result associated with the specified query identifier to pointer to the specifyed row number. The next call to - <function>msql_fetch_row</function> would return that row. + <function>msql_fetch_row</function> would return that row.</para> <para> See also: - <function>msql_fetch_row</function>. + <function>msql_fetch_row</function>.</para> </refsect1> </refentry> @@ -204,7 +203,7 @@ in position <parameter>i</parameter> of the result pointer returned from the <function>msql_listdbs</function> function. The <function>msql_numrows</function> function can be used to - determine how many database names are available. + determine how many database names are available.</para> </refsect1> </refentry> @@ -221,13 +220,13 @@ <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on failure. + Returns true on success, false on failure.</para> <para> msql_drop_db() attempts to drop (remove) an entire database from - the server associated with the specified link identifier. + the server associated with the specified link identifier.</para> <para> See also: - <function>msql_create_db</function>. + <function>msql_create_db</function>.</para> </refsect1> </refentry> @@ -257,7 +256,7 @@ <para> Errors coming back from the mSQL database backend no longer issue warnings. Instead, use these functions to retrieve the - error string. + error string.</para> </refsect1> </refentry> @@ -278,27 +277,27 @@ </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false if - there are no more rows. + there are no more rows.</para> <para> <function>msql_fetch_array</function> is an extended version of <function>msql_fetch_row</function>. 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. + the data in associative indices, using the field names as keys.</para> <para> The second optional argument <parameter>result_type</parameter> in <function>msql_fetch_array</function> is a constant and can - take the following values: MSQL_ASSOC, MSQL_NUM, and MYSQL_BOTH. + take the following values: MSQL_ASSOC, MSQL_NUM, and MYSQL_BOTH.</para> <para> Be careful if you are retrieving results from a query that may return a record that contains only one field that has a value of - 0 (or an empty string, or NULL). + 0 (or an empty string, or NULL).</para> <para> An important thing to note is that using <function>msql_fetch_array</function> is NOT significantly slower than using <function>msql_fetch_row</function>, while it provides - a significant added value. + a significant added value.</para> <para> - For further details, also see <function>msql_fetch_row</function> + For further details, also see <function>msql_fetch_row</function></para> </refsect1> </refentry> @@ -315,12 +314,12 @@ <paramdef>int <parameter>field_offset</parameter></paramdef> </funcsynopsis> <para> - Returns an object containing field information + Returns an object containing field information</para> <para> msql_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 retreived by - msql_fetch_field() is retreived. + msql_fetch_field() is retreived.</para> <para> The properties of the object are: <itemizedlist> @@ -335,10 +334,10 @@ key</simpara></listitem> <listitem><simpara>type - the type of the column</simpara></listitem> - </itemizedlist> + </itemizedlist></para> <para> See also - <function>msql_field_seek</function>. + <function>msql_field_seek</function>.</para> </refsect1> </refentry> @@ -360,25 +359,25 @@ </funcsynopsis> <para> Returns an object with properties that correspond to the fetched - row, or false if there are no more rows. + row, or false if there are no more rows.</para> <para> <function>msql_fetch_object</function> is similar to <function>msql_fetch_array</function>, 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 - their offsets (numbers are illegal property names). + their offsets (numbers are illegal property names).</para> <para> The optional second argument <parameter>result_type</parameter> in <function>msql_fetch_array</function> is a constant and can - take the following values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH. + take the following values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH.</para> <para> Speed-wise, the function is identical to <function>msql_fetch_array</function>, and almost as quick as <function>msql_fetch_row</function> (the difference is - insignificant). + insignificant).</para> <para> See also: <function>msql_fetch_array</function> and - <function>msql_fetch_row</function>. + <function>msql_fetch_row</function>.</para> </refsect1> </refentry> @@ -396,20 +395,20 @@ </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false if - there are no more rows. + there are no more rows.</para> <para> msql_fetch_row() fetches one row of data from the result associated with the specified query identifier. The row is returned as an array. Each result column is stored in an array - offset, starting at offset 0. + offset, starting at offset 0.</para> <para> Subsequent call to msql_fetch_row() would return the next row in - the result set, or false if there are no more rows. + the result set, or false if there are no more rows.</para> <para> See also: <function>msql_fetch_array</function>, <function>msql_fetch_object</function>, <function>msql_data_seek</function>, and - <function>msql_result</function>. + <function>msql_result</function>.</para> </refsect1> </refentry> @@ -432,7 +431,7 @@ <parameter>field</parameter> is the field index. <literal>msql_fieldname($result, 2);</literal> will return the name of the second field in the result associated with the result - identifier. + identifier.</para> </refsect1> </refentry> @@ -452,10 +451,10 @@ <para> Seeks to the specified field offset. If the next call to <function>msql_fetch_field</function> won't include a field - offset, this field would be returned. + offset, this field would be returned.</para> <para> See also: - <function>msql_fetch_field</function>. + <function>msql_fetch_field</function>.</para> </refsect1> </refentry> @@ -474,7 +473,7 @@ </funcsynopsis> <para> Returns the name of the table <parameter>field</parameter> was - fetched from. + fetched from.</para> </refsect1> </refentry> @@ -495,7 +494,7 @@ msql_fieldtype() is similar to the <function>msql_fieldname</function> function. The arguments are identical, but the field type is returned. This will be one of - "int", "string" or "real". + "int", "string" or "real".</para> </refsect1> </refentry> @@ -515,7 +514,7 @@ <para> msql_fieldflags() returns the field flags of the specified field. Currently this is either, "not null", "primary key", a - combination of the two or "" (an empty string). + combination of the two or "" (an empty string).</para> </refsect1> </refentry> @@ -533,7 +532,7 @@ <paramdef>int <parameter>i</parameter></paramdef> </funcsynopsis> <para> - msql_fieldlen() returns the length of the specified field. + msql_fieldlen() returns the length of the specified field.</para> </refsect1> </refentry> @@ -554,7 +553,7 @@ with <parameter>query_identifier</parameter>. When PHP completes a request, this memory is freed automatically, so you only need to call this function when you want to make sure you don't use too - much memory while the script is running. + much memory while the script is running.</para> </refsect1> </refentry> @@ -567,7 +566,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>msql_free_result</function> + <para>See <function>msql_free_result</function></para> </refsect1> </refentry> @@ -596,9 +595,9 @@ <literal>-1</literal> if a error occurs. A string describing the error will be placed in <literal>$phperrmsg</literal>, and unless the function was called as <literal>@msql_list_fields()</literal> - then this error string will also be printed out. + then this error string will also be printed out.</para> <para> - See also <function>msql_error</function>. + See also <function>msql_error</function>.</para> </refsect1> </refentry> @@ -611,7 +610,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>msql_list_fields</function>. + <para>See <function>msql_list_fields</function>.</para> </refsect1> </refentry> @@ -631,7 +630,7 @@ <function>msql_list_dbs</function> will return a result pointer containing the databases available from the current msql daemon. Use the <function>msql_dbname</function> function to - traverse this result pointer. + traverse this result pointer.</para> </refsect1> </refentry> @@ -644,7 +643,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>msql_list_dbs</function>. + <para>See <function>msql_list_dbs</function>.</para> </refsect1> </refentry> @@ -665,7 +664,7 @@ result pointer much like the <function>msql</function> function. The <function>msql_tablename</function> function should be used to extract the actual table names from the result - pointer. + pointer.</para> </refsect1> </refentry> @@ -678,7 +677,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>msql_list_tables</function>. + <para>See <function>msql_list_tables</function>.</para> </refsect1> </refentry> @@ -695,13 +694,13 @@ <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> - msql_num_fields() returns the number of fields in a result set. + msql_num_fields() returns the number of fields in a result set.</para> <para> See also: <function>msql</function>, <function>msql_query</function>, <function>msql_fetch_field</function>, and - <function>msql_num_rows</function>. + <function>msql_num_rows</function>.</para> </refsect1> </refentry> @@ -719,12 +718,12 @@ <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> - msql_num_rows() returns the number of rows in a result set. + msql_num_rows() returns the number of rows in a result set.</para> <para> See also: <function>msql</function>, <function>msql_query</function>, and - <function>msql_fetch_row</function>. + <function>msql_fetch_row</function>.</para> </refsect1> </refentry> @@ -741,7 +740,7 @@ <paramdef>int <parameter>query_identifier</parameter></paramdef> </funcsynopsis> <para> - Identical to <function>msql_num_fields</function>. + Identical to <function>msql_num_fields</function>.</para> </refsect1> </refentry> @@ -759,7 +758,7 @@ <void> </funcsynopsis> <para> - Identical to <function>msql_num_rows</function>. + Identical to <function>msql_num_rows</function>.</para> </refsect1> </refentry> @@ -778,22 +777,22 @@ </funcsynopsis> <para> Returns a positive mSQL persistent link identifier on success, or - false on error. + false on error.</para> <para> msql_pconnect() acts very much like - <function>msql_connect</function> with two major differences. + <function>msql_connect</function> with two major differences.</para> <para> First, when connecting, the function would first try to find a (persistent) link that's already open with the same host. If one is found, an identifier for it will be returned instead of - opening a new connection. + opening a new connection.</para> <para> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<function>msql_close</function> will - not close links established by msql_pconnect()). + not close links established by msql_pconnect()).</para> <para> - This type of links is therefore called 'persistent'. + This type of links is therefore called 'persistent'.</para> </refsect1> </refentry> @@ -816,14 +815,14 @@ specified link identifier. If the link identifier isn't specified, the last opened link is assumed. If no link is open, the function tries to establish a link as if - <function>msql_connect</function> was called, and use it. + <function>msql_connect</function> was called, and use it.</para> <para> - Returns a positive mSQL query identifier on success, or false on error. + Returns a positive mSQL query identifier on success, or false on error.</para> <para> See also: <function>msql</function>, <function>msql_select_db</function>, and - <function>msql_connect</function>. + <function>msql_connect</function>.</para> </refsect1> </refentry> @@ -835,7 +834,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>sql_regcase</function>. + <para>See <function>sql_regcase</function>.</para> </refsect1> </refentry> @@ -855,14 +854,14 @@ </funcsynopsis> <para> Returns the contents of the cell at the row and offset in the - specified mSQL result set. + specified mSQL result set.</para> <para> msql_result() returns the contents of one cell from a mSQL result set. The field argument can be the field's offset, or the field's name, or the field's table dot field's name (fieldname.tablename). If the column name has been aliased ('select foo as bar from...'), use the alias instead of the column - name. + name.</para> <para> When working on large result sets, you should consider using one of the functions that fetch an entire row (specified @@ -870,12 +869,12 @@ in one function call, they're MUCH quicker than msql_result(). Also, note that specifying a numeric offset for the field argument is much quicker than specifying a fieldname or tablename.fieldname - argument. + argument.</para> <para> Recommended high-performance alternatives: <function>msql_fetch_row</function>, <function>msql_fetch_array</function>, and - <function>msql_fetch_object</function>. + <function>msql_fetch_object</function>.</para> </refsect1> </refentry> @@ -893,21 +892,21 @@ <paramdef>int <parameter>link_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns true on success, false on error. + Returns true on success, false on error.</para> <para> msql_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 establish a link as if - msql_connect() was called, and use it. + msql_connect() was called, and use it.</para> <para> Every subsequent call to <function>msql_query</function> will be - made on the active database. + made on the active database.</para> <para> See also: <function>msql_connect</function>, <function>msql_pconnect</function>, and - <function>msql_query</function>. + <function>msql_query</function>.</para> </refsect1> </refentry> @@ -920,7 +919,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>msql_select_db</function>. + <para>See <function>msql_select_db</function>.</para> </refsect1> </refentry> @@ -948,7 +947,7 @@ <example> <title>msql_tablename() example</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php msql_connect ("localhost"); $result = msql_list_tables("wisconsin"); @@ -961,7 +960,7 @@ ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> Index: phpdoc/functions/mssql.sgml diff -u phpdoc/functions/mssql.sgml:1.3 phpdoc/functions/mssql.sgml:1.4 --- phpdoc/functions/mssql.sgml:1.3 Wed Jul 14 15:50:31 1999 +++ phpdoc/functions/mssql.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.mssql"> <title>Microsoft SQL Server functions</title> <titleabbrev>MS SQL Server</titleabbrev> @@ -114,7 +113,7 @@ <para> An important thing to note is that using mssql_fetch_array() is NOT significantly slower than using mssql_fetch_row(), while it - provides a significant added value. + provides a significant added value.</para> <para> For further details, also see <function>mssql_fetch_row</function> @@ -187,7 +186,7 @@ <function>mssql_fetch_array</function>, 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 - their offsets (numbers are illegal property names). + their offsets (numbers are illegal property names).</para> <para> Speed-wise, the function is identical to <function>mssql_fetch_array</function>, and almost as quick as @@ -249,10 +248,10 @@ <para> Seeks to the specified field offset. If the next call to <function>mssql_fetch_field</function> won't include a field - offset, this field would be returned. - <para> + offset, this field would be returned.</para> + <para></para> <para> - See also: <function>mssql_fetch_field</function>. + See also: <function>mssql_fetch_field</function>.</para> </refsect1> </refentry> @@ -340,22 +339,22 @@ </funcsynopsis> <para> Returns: A positive MS SQL persistent link identifier on success, - or false on error + or false on error</para> <para> mssql_pconnect() acts very much like - <function>mssql_connect</function> with two major differences. + <function>mssql_connect</function> with two major differences.</para> <para> First, when connecting, the function would first try to find a (persistent) link that's already open with the same host, username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. + will be returned instead of opening a new connection.</para> <para> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<function>mssql_close</function> will not - close links established by <literal>mssql_pconnect()</literal>). + close links established by <literal>mssql_pconnect()</literal>).</para> <para> - This type of links is therefore called 'persistent'. + This type of links is therefore called 'persistent'.</para> </refsect1> </refentry> @@ -464,8 +463,8 @@ </para> </refsect1> </refentry> - +</reference> <!-- Keep this comment at the end of the file Local variables: Index: phpdoc/functions/mysql.sgml diff -u phpdoc/functions/mysql.sgml:1.13 phpdoc/functions/mysql.sgml:1.14 --- phpdoc/functions/mysql.sgml:1.13 Mon Sep 6 15:21:30 1999 +++ phpdoc/functions/mysql.sgml Wed Oct 20 18:41:42 1999 @@ -1,13 +1,11 @@ - <reference id="ref.mysql"> <title>MySQL functions</title> <titleabbrev>MySQL</titleabbrev> <partintro> <simpara> - These functions allow you to access MySQL database servers. + These functions allow you to access MySQL database servers.</simpara> <simpara> - More information about MySQL can be found at <ulink - url="http://www.mysql.com/">http://www.mysql.com/</ulink>. + More information about MySQL can be found at <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink>.</simpara> </partintro> <refentry id="function.mysql-affected-rows"> @@ -27,15 +25,15 @@ <function>mysql_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query on the server associated with the specified link identifier. If the - link identifier isn't specified, the last opened link is assumed. + link identifier isn't specified, the last opened link is assumed.</para> <para> If the last query was a DELETE query with no WHERE clause, all of the records will have been deleted from the table but this - function will return zero. + function will return zero.</para> <para> This command is not effective for SELECT statements, only on statements which modify records. To retrieve the number of rows - returned from a SELECT, use <function>mysql_num_rows</function>. + returned from a SELECT, use <function>mysql_num_rows</function>.</para> </refsect1> </refentry> @@ -52,22 +50,22 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns: true on success, false on error + Returns: true on success, false on error</para> <para> <function>mysql_close</function> closes the link to a MySQL database that's associated with the specified link identifier. If the link identifier isn't specified, the last opened link is - assumed. + assumed.</para> <para> Note that this isn't usually necessary, as non-persistent open links are automatically closed at the end of the script's - execution. + execution.</para> <para> <function>mysql_close</function> will not close persistent links - generated by <function>mysql_pconnect</function>. + generated by <function>mysql_pconnect</function>.</para> <para> See also: <function>mysql_connect</function>, and - <function>mysql_pconnect</function>. + <function>mysql_pconnect</function>.</para> </refsect1> </refentry> @@ -95,35 +93,35 @@ </funcsynopsis> <para> Returns: A positive MySQL link identifier on success, or false on - error. + error.</para> <para> <function>mysql_connect</function> establishes a connection to a MySQL server. All of the arguments are optional, and if they're missing, defaults are assumed ('localhost', user name of the user - that owns the server process, empty password). + that owns the server process, empty password).</para> <para> The hostname string can also include a port number. eg. &quot;hostname:port&quot; or a path to a socket eg. &quot;:/path/to/socket&quot; for the localhost. <note> <para> - Support for &quot;:port&quot; wass added in 3.0B4. + Support for &quot;:port&quot; wass added in 3.0B4.</para> <para> Support for the &quot;:/path/to/socket&quot; was added in - 3.0.10. - </note> + 3.0.10.</para> + </note></para> <para> In case a second call is made to <function>mysql_connect</function> with the same arguments, no new link will be established, but instead, the link identifier of - the already opened link will be returned. + the already opened link will be returned.</para> <para> The link to the server will be closed as soon as the execution of the script ends, unless it's closed earlier by explicitly calling - <function>mysql_close</function>. + <function>mysql_close</function>.</para> <para> See also <function>mysql_pconnect</function>, and - <function>mysql_close</function>. + <function>mysql_close</function>.</para> </refsect1> </refentry> @@ -143,11 +141,11 @@ <para> <function>mysql_create_db</function> attempts to create a new database on the server associated with the specified link - identifier. + identifier.</para> <para> See also: <function>mysql_drop_db</function>. For downwards compatibility <function>mysql_createdb</function> can also be - used. + used.</para> </refsect1> </refentry> @@ -164,14 +162,14 @@ <paramdef>int <parameter>row_number</parameter></paramdef> </funcsynopsis> <para> - Returns: true on success, false on failure + Returns: true on success, false on failure</para> <para> <function>mysql_data_seek</function> moves the internal row pointer of the MySQL result associated with the specified result identifier to point to the specified row number. The next call - to <function>mysql_fetch_row</function> would return that row. + to <function>mysql_fetch_row</function> would return that row.</para> <para> - <parameter>Row_number</parameter> starts at 0. + <parameter>Row_number</parameter> starts at 0.</para> </refsect1> </refentry> @@ -192,17 +190,17 @@ </funcsynopsis> <para> Returns: A positive MySQL result identifier to the query result, - or false on error. + or false on error.</para> <para> <function>mysql_db_query</function> selects a database and executes a query on it. If the optional link identifier isn't specified, the function will try to find an open link to the MySQL server and if no such link is found it'll try to create one as if <function>mysql_connect</function> was called with no - arguments + arguments</para> <para> See also <function>mysql_connect</function>. For downwards - compatibility <function>mysql</function> can also be used. + compatibility <function>mysql</function> can also be used.</para> </refsect1> </refentry> @@ -221,14 +219,14 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns: true on success, false on failure. + Returns: true on success, false on failure.</para> <para> <function>mysql_drop_db</function> attempts to drop (remove) an entire database from the server associated with the specified - link identifier. + link identifier.</para> <para> See also: <function>mysql_create_db</function>. For downward - compatibility <function>mysql_dropdb</function> can also be used. + compatibility <function>mysql_dropdb</function> can also be used.</para> </refsect1> </refentry> @@ -252,7 +250,7 @@ error number. <informalexample> - <programlisting role=php> + <programlisting role="php"> &lt;?php mysql_connect("marliesle"); echo mysql_errno().": ".mysql_error()."&lt;BR>"; @@ -262,10 +260,10 @@ echo mysql_errno().": ".mysql_error()."&lt;BR>"; ?> </programlisting> - </informalexample> + </informalexample></para> <para> - See also: <function>mysql_error</function> + See also: <function>mysql_error</function></para> </refsect1> </refentry> @@ -288,7 +286,7 @@ error string. <informalexample> - <programlisting role=php> + <programlisting role="php"> &lt;?php mysql_connect("marliesle"); echo mysql_errno().": ".mysql_error()."&lt;BR>"; @@ -298,10 +296,10 @@ echo mysql_errno().": ".mysql_error()."&lt;BR>"; ?> </programlisting> - </informalexample> + </informalexample></para> <para> - See also: <function>mysql_errno</function> + See also: <function>mysql_errno</function></para> </refsect1> </refentry> @@ -321,12 +319,12 @@ </funcsynopsis> <para> Returns an array that corresponds to the fetched row, or false - if there are no more rows. + if there are no more rows.</para> <para> <function>mysql_fetch_array</function> is an extended version of <function>mysql_fetch_row</function>. 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. + the data in associative indices, using the field names as keys.</para> <para> If two or more columns of the result have the same field names, the last column will take precedence. To access the other column(s) @@ -334,23 +332,23 @@ make an alias for the column. <informalexample><programlisting> select t1.f1 as foo t2.f1 as bar from t1, t2 -</programlisting></informalexample> +</programlisting></informalexample></para> <para> An important thing to note is that using <function>mysql_fetch_array</function> is NOT significantly slower than using <function>mysql_fetch_row</function>, while it - provides a significant added value. + provides a significant added value.</para> <para> The optional second argument <parameter>result_type</parameter> in <function>mysql_fetch_array</function> is a constant and can take - the following values: MYSQL_ASSOC, MYSQL_NUM, and MYSQL_BOTH. + the following values: MYSQL_ASSOC, MYSQL_NUM, and MYSQL_BOTH.</para> <para> For further details, also see <function>mysql_fetch_row</function> </para> <example> <title>mysql fetch array</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php mysql_connect($host,$user,$password); $result = mysql_db_query("database","select * from table"); @@ -381,12 +379,12 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns an object containing field information. + Returns an object containing field information.</para> <para> <function>mysql_fetch_field</function> 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 <function>mysql_fetch_field</function> is retrieved. + retrieved by <function>mysql_fetch_field</function> is retrieved.</para> <para> The properties of the object are: @@ -427,10 +425,10 @@ <listitem><simpara> zerofill - 1 if the column is zero-filled </simpara></listitem> - </itemizedlist> + </itemizedlist></para> <para> - See also <function>mysql_field_seek</function> + See also <function>mysql_field_seek</function></para> </refsect1> </refentry> @@ -449,16 +447,16 @@ <para> Returns: An array that corresponds to the lengths of each field in the last row fetched by <function>mysql_fetch_row</function>, - or false on error. + or false on error.</para> <para> <function>mysql_fetch_lengths</function> stores the lengths of each result column in the last row returned by <function>mysql_fetch_row</function>, <function>mysql_fetch_array</function>, and <function>mysql_fetch_object</function> in an array, starting at - offset 0. + offset 0.</para> <para> - See also: <function>mysql_fetch_row</function>. + See also: <function>mysql_fetch_row</function>.</para> </refsect1> </refentry> @@ -476,17 +474,17 @@ </funcsynopsis> <para> Returns an object with properties that correspond to the fetched - row, or false if there are no more rows. + row, or false if there are no more rows.</para> <para> <function>mysql_fetch_object</function> is similar to <function>mysql_fetch_array</function>, 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 - their offsets (numbers are illegal property names). + their offsets (numbers are illegal property names).</para> <para> The optional argument <parameter>result_typ</parameter> is a constant and can take the following values: MYSQL_ASSOC, - MYSQL_NUM, and MYSQL_BOTH. + MYSQL_NUM, and MYSQL_BOTH.</para> <para> Speed-wise, the function is identical to <function>mysql_fetch_array</function>, and almost as quick as @@ -494,7 +492,7 @@ insignificant). <example> <title>mysql fetch object</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php mysql_connect($host,$user,$password); $result = mysql_db_query("database","select * from table"); @@ -505,10 +503,10 @@ mysql_free_result($result); ?> </programlisting> - </example> + </example></para> <para> See also: <function>mysql_fetch_array</function> and - <function>mysql_fetch_row</function>. + <function>mysql_fetch_row</function>.</para> </refsect1> </refentry> @@ -525,22 +523,22 @@ </funcsynopsis> <para> Returns: An array that corresponds to the fetched row, or false - if there are no more rows. + if there are no more rows.</para> <para> <function>mysql_fetch_row</function> 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. + array offset, starting at offset 0.</para> <para> Subsequent call to <function>mysql_fetch_row</function> would return the next row in the result set, or false if there are no - more rows. + more rows.</para> <para> See also: <function>mysql_fetch_array</function>, <function>mysql_fetch_object</function>, <function>mysql_data_seek</function>, <function>mysql_fetch_lengths</function>, and - <function>mysql_result</function>. + <function>mysql_result</function>.</para> </refsect1> </refentry> @@ -561,13 +559,13 @@ <function>mysql_field_name</function> returns the name of the specified field. Arguments to the function is the result identifier and the field index, ie. - <literal>mysql_field_name($result,2);</literal> + <literal>mysql_field_name($result,2);</literal></para> <para> Will return the name of the second field in the result associated - with the result identifier. + with the result identifier.</para> <para> For downwards compatibility <function>mysql_fieldname</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -587,9 +585,9 @@ <para> Seeks to the specified field offset. If the next call to <function>mysql_fetch_field</function> won't include a field - offset, this field would be returned. + offset, this field would be returned.</para> <para> - See also: <function>mysql_fetch_field</function>. + See also: <function>mysql_fetch_field</function>.</para> </refsect1> </refentry> @@ -608,7 +606,7 @@ </funcsynopsis> <para> Get the table name for field. For downward compatibility - <function>mysql_fieldtable</function> can also be used. + <function>mysql_fieldtable</function> can also be used.</para> </refsect1> </refentry> @@ -635,7 +633,7 @@ <example> <title>mysql field types</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php mysql_connect("localhost:3306"); mysql_select_db("wisconsin"); @@ -657,11 +655,11 @@ mysql_close(); ?> </programlisting> - </example> + </example></para> <para> For downward compatibility <function>mysql_fieldtype</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -684,14 +682,14 @@ <function>mysql_field_flags</function> returns the field flags of the specified field. The flags are reported as a single word per flag separated by a single space, so that you can split the - returned value using <function>explode</function>. + returned value using <function>explode</function>.</para> <para>The following flags are reported, if your version of MySQL is current enough to support them: "not_null", "primary_key", "unique_key", "multiple_key", "blob", "unsigned", "zerofill", - "binary", "enum", "auto_increment", "timestamp". + "binary", "enum", "auto_increment", "timestamp".</para> <para> For downward compatibility <function>mysql_fieldflags</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -732,10 +730,10 @@ <function>mysql_free_result</function> only needs to be called if you are worried about using too much memory while your script is running. All associated result memory for the specified result - identifier will automatically be freed. + identifier will automatically be freed.</para> <para> For downward compatibility <function>mysql_freeresult</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -759,7 +757,7 @@ returned by the last INSERT query performed using the given <parameter>link_identifier</parameter>. If <parameter>link_identifier</parameter> isn't specified, the last - opened link is assumed. + opened link is assumed.</para> </refsect1> </refentry> @@ -785,16 +783,16 @@ <function>mysql_field_flags</function>, <function>mysql_field_len</function>, <function>mysql_field_name</function>, and - <function>mysql_field_type</function>. + <function>mysql_field_type</function>.</para> <para> A result identifier is a positive integer. The function returns -1 if a error occurs. A string describing the error will be placed in <literal>$phperrmsg</literal>, and unless the function was called as <literal>@mysql()</literal> then this error string - will also be printed out. + will also be printed out.</para> <para> For downward compatibility <function>mysql_listfields</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -815,10 +813,10 @@ <function>mysql_list_dbs</function> will return a result pointer containing the databases available from the current mysql daemon. Use the <function>mysql_tablename</function> function to - traverse this result pointer. + traverse this result pointer.</para> <para> For downward compatibility <function>mysql_listdbs</function> can - also be used. + also be used.</para> </refsect1> </refentry> @@ -843,10 +841,10 @@ returns a result pointer much like the <function>mysql_db_query</function> function. The <function>mysql_tablename</function> function should be used to - extract the actual table names from the result pointer. + extract the actual table names from the result pointer.</para> <para> For downward compatibility <function>mysql_listtables</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -864,16 +862,16 @@ </funcsynopsis> <para> <function>mysql_num_fields</function> returns the number of - fields in a result set. + fields in a result set.</para> <para> See also: <function>mysql_db_query</function>, <function>mysql_query</function>, <function>mysql_fetch_field</function>, - <function>mysql_num_rows</function>. + <function>mysql_num_rows</function>.</para> <para> For downward compatibility <function>mysql_numfields</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -891,15 +889,15 @@ </funcsynopsis> <para> <function>mysql_num_rows</function> returns the number of rows in - a result set. + a result set.</para> <para> See also: <function>mysql_db_query</function>, <function>mysql_query</function> and, - <function>mysql_fetch_row</function>. + <function>mysql_fetch_row</function>.</para> <para> For downward compatibility <function>mysql_numrows</function> can - also be used. + also be used.</para> </refsect1> </refentry> @@ -932,38 +930,38 @@ </funcsynopsis> <para> Returns: A positive MySQL persistent link identifier on success, - or false on error + or false on error</para> <para> <function>mysql_pconnect</function> establishes a connection to a MySQL server. All of the arguments are optional, and if they're missing, defaults are assumed ('localhost', user name of the user - that owns the server process, empty password). + that owns the server process, empty password).</para> <para> The hostname string can also include a port number. eg. &quot;hostname:port&quot; or a path to a socket eg. &quot;:/path/to/socket&quot; for the localhost. <note> <para> - Support for &quot;:port&quot; wass added in 3.0B4. + Support for &quot;:port&quot; wass added in 3.0B4.</para> <para> Support for the &quot;:/path/to/socket&quot; was added in - 3.0.10. - </note> + 3.0.10.</para> + </note></para> <para> <function>mysql_pconnect</function> acts very much like - <function>mysql_connect</function> with two major differences. + <function>mysql_connect</function> with two major differences.</para> <para> First, when connecting, the function would first try to find a (persistent) link that's already open with the same host, username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. + will be returned instead of opening a new connection.</para> <para> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<function>mysql_close</function> will not - close links established by <function>mysql_pconnect</function>). + close links established by <function>mysql_pconnect</function>).</para> <para> - This type of links is therefore called 'persistent'. + This type of links is therefore called 'persistent'.</para> </refsect1> </refentry> @@ -988,16 +986,16 @@ <parameter>link_identifier</parameter> isn't specified, the last opened link is assumed. If no link is open, the function tries to establish a link as if <function>mysql_connect</function> was - called with no arguments, and use it. + called with no arguments, and use it.</para> <para> - The query string should not end with a semicolon. + The query string should not end with a semicolon.</para> <para> <function>mysql_query</function> returns TRUE (non-zero) or FALSE to indicate whether or not the query succeeded. A return value of TRUE means that the query was legal and could be executed by the server. It does not indicate anything about the number of rows affected or returned. It is perfectly possible for a query - to succeed but affect no rows or return no rows. + to succeed but affect no rows or return no rows.</para> <para> The following query is syntactically invalid, so <function>mysql_query</function> fails and returns FALSE: @@ -1010,7 +1008,7 @@ or die ("Invalid query"); ?> </programlisting> - </example> + </example></para> <para> The following query is semantically invalid if @@ -1026,12 +1024,12 @@ or die ("Invalid query"); ?> </programlisting> - </example> + </example></para> <para> <function>mysql_query</function> will also fail and return FALSE if you don't have permission to access the table(s) referenced by - the query. + the query.</para> <para> Assuming the query succeeds, you can call <function>mysql_affected_rows</function> to find out how many @@ -1041,14 +1039,14 @@ that you can pass to <function>mysql_result</function>. When you are done with the result set, you can free the resources associated with it by calling - <function>mysql_free_result</function>. + <function>mysql_free_result</function>.</para> <para> See also: <function>mysql_affected_rows</function>, <function>mysql_db_query</function>, <function>mysql_free_result</function>, <function>mysql_result</function>, <function>mysql_select_db</function>, and - <function>mysql_connect</function>. + <function>mysql_connect</function>.</para> </refsect1> </refentry> @@ -1075,7 +1073,7 @@ field's offset, or the field's name, or the field's table dot field's name (fieldname.tablename). If the column name has been aliased ('select foo as bar from...'), use the alias instead of - the column name. + the column name.</para> <para> When working on large result sets, you should consider using one of the functions that fetch an entire row (specified below). As @@ -1083,15 +1081,15 @@ function call, they're MUCH quicker than <function>mysql_result</function>. Also, note that specifying a numeric offset for the field argument is much quicker than - specifying a fieldname or tablename.fieldname argument. + specifying a fieldname or tablename.fieldname argument.</para> <para> Calls <function>mysql_result</function> should not be mixed - with calls to other functions that deal with the result set. + with calls to other functions that deal with the result set.</para> <para> Recommended high-performance alternatives: <function>mysql_fetch_row</function>, <function>mysql_fetch_array</function>, and - <function>mysql_fetch_object</function>. + <function>mysql_fetch_object</function>.</para> </refsect1> </refentry> @@ -1109,24 +1107,24 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns: true on success, false on error + Returns: true on success, false on error</para> <para> <function>mysql_select_db</function> 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 establish a link as if <function>mysql_connect</function> was - called, and use it. + called, and use it.</para> <para> Every subsequent call to <function>mysql_query</function> will be - made on the active database. + made on the active database.</para> <para> See also: <function>mysql_connect</function>, <function>mysql_pconnect</function>, and - <function>mysql_query</function> + <function>mysql_query</function></para> <para> For downward compatibility <function>mysql_selectdb</function> - can also be used. + can also be used.</para> </refsect1> </refentry> @@ -1163,7 +1161,7 @@ $i++; } ?> -</programlisting></example> +</programlisting></example></para> </refsect1> </refentry> Index: phpdoc/functions/network.sgml diff -u phpdoc/functions/network.sgml:1.4 phpdoc/functions/network.sgml:1.5 --- phpdoc/functions/network.sgml:1.4 Mon Sep 6 00:22:22 1999 +++ phpdoc/functions/network.sgml Wed Oct 20 18:41:42 1999 @@ -20,15 +20,15 @@ Searches DNS for records of type <parameter>type</parameter> corresponding to <parameter>host</parameter>. Returns true if any records are found; returns false if no records were found or if - an error occurred. + an error occurred.</simpara> <simpara> <parameter>type</parameter> may be any one of: A, MX, NS, SOA, - PTR, CNAME, or ANY. The default is MX. + PTR, CNAME, or ANY. The default is MX.</simpara> <simpara> <parameter>host</parameter> may either be the IP address in - dotted-quad notation or the host name. + dotted-quad notation or the host name.</simpara> <simpara> See also @@ -36,7 +36,7 @@ <function>gethostbyaddr</function>, <function>gethostbyname</function>, <function>gethostbynamel</function>, and - the named(8) manual page. + the named(8) manual page.</simpara> </refsect1> </refentry> @@ -55,7 +55,7 @@ <para> <function>closelog</function> closes the descriptor being used to write to the system logger. The use of - <function>closelog</function> is optional. + <function>closelog</function> is optional.</para> </refsect1> </refentry> @@ -72,7 +72,7 @@ </funcsynopsis> <para> Disables the internal PHP debugger. The debugger is still under - development. + development.</para> </refsect1> </refentry> @@ -90,7 +90,7 @@ <para> Enables the internal PHP debugger, connecting it to <parameter>address</parameter>. The debugger is still under - development. + development.</para> </refsect1> </refentry> @@ -118,14 +118,14 @@ the Unix domain, <parameter>hostname</parameter> will be used as the path to the socket, <parameter>port</parameter> must be set to 0 in this case. The optional <parameter>timeout</parameter> can be used to set a timeout - in seconds for the connect system call. + in seconds for the connect system call.</para> <para> <function>fsockopen</function> returns a file pointer which may be used together with the other file functions (such as <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, - <function>feof</function>). + <function>feof</function>).</para> <para> If the call fails, it will return false and if the optional @@ -135,11 +135,11 @@ 0 and the function returned false, it is an indication that the error occurred before the connect() call. This is most likely due to a problem initializing the socket. Note that the errno and errstr arguments must be - passed by reference. + passed by reference.</para> <para> Depending on the environment, the Unix domain or the optional connect - timeout may not be available. + timeout may not be available.</para> <para> The socket will by default be opened in blocking mode. You can switch it @@ -160,7 +160,7 @@ </programlisting> </example> - See also: <function>pfsockopen</function> + See also: <function>pfsockopen</function></para> </refsect1> </refentry> @@ -181,10 +181,10 @@ <para> Returns the host name of the Internet host specified by <parameter>ip_address</parameter>. If an error occurs, returns - <parameter>ip_address</parameter>. + <parameter>ip_address</parameter>.</para> <para> - See also <function>gethostbyname</function>. + See also <function>gethostbyname</function>.</para> </refsect1> </refentry> @@ -204,10 +204,10 @@ <para> Returns the IP address of the Internet host specified by - <parameter>hostname</parameter>. + <parameter>hostname</parameter>.</para> <para> - See also <function>gethostbyaddr</function>. + See also <function>gethostbyaddr</function>.</para> </refsect1> </refentry> @@ -227,7 +227,7 @@ <para> Returns a list of IP addresses to which the Internet host - specified by <parameter>hostname</parameter> resolves. + specified by <parameter>hostname</parameter> resolves.</para> <para> See also @@ -235,7 +235,7 @@ <function>gethostbyaddr</function>, <function>checkdnsrr</function>, <function>getmxrr</function>, and - the named(8) manual page. + the named(8) manual page.</para> </refsect1> </refentry> @@ -258,13 +258,13 @@ <simpara> Searches DNS for MX records corresponding to <parameter>hostname</parameter>. Returns true if any records are - found; returns false if no records were found or if an error occurred. + found; returns false if no records were found or if an error occurred.</simpara> <simpara> A list of the MX records found is placed into the array <parameter>mxhosts</parameter>. If the <parameter>weight</parameter> array is given, it will be filled - with the weight information gathered. + with the weight information gathered.</simpara> <simpara> See also @@ -272,7 +272,7 @@ <function>gethostbyname</function>, <function>gethostbynamel</function>, <function>gethostbyaddr</function>, and - the named(8) manual page. + the named(8) manual page.</simpara> </refsect1> </refentry> @@ -301,7 +301,7 @@ case ident will default to <literal>false</literal>. See also <function>syslog</function> and - <function>closelog</function>. + <function>closelog</function>.</para> </refsect1> </refentry> @@ -325,7 +325,7 @@ <para> This function behaves exactly as <function>fsockopen</function> with the difference that the connection is not closed after the script finishes. - It is the persistent version of <function>fsockopen</function>. + It is the persistent version of <function>fsockopen</function>.</para> </refsect1> </refentry> @@ -348,7 +348,7 @@ <function>fgets</function> that read from the socket. In non-blocking mode an fgets() call will always return right away while in blocking mode it will wait for data to become available - on the socket. + on the socket.</para> </refsect1> </refentry> @@ -373,13 +373,13 @@ The remaining argument is the message to send, except that the two characters <literal>%m</literal> will be replaced by the error message string (strerror) corresponding to the present - value of <errortype>errno</errortype>. + value of <errortype>errno</errortype>.</para> <para> More information on the syslog facilities can be found in - the man pages for syslog on Unix machines. + the man pages for syslog on Unix machines.</para> <para> On Windows NT, the syslog service is emulated using the - Event Log. + Event Log.</para> </refsect1> </refentry> Index: phpdoc/functions/nis.sgml diff -u phpdoc/functions/nis.sgml:1.3 phpdoc/functions/nis.sgml:1.4 --- phpdoc/functions/nis.sgml:1.3 Sun Jun 20 03:06:49 1999 +++ phpdoc/functions/nis.sgml Wed Oct 20 18:41:42 1999 @@ -6,15 +6,13 @@ <para> NIS (formerly called Yellow Pages) allows network management of important administrative files (e.g. the password file). For more - information refer to the NIS manpage and <ulink - url="http://www.desy.de/~sieversm/ypdoku/ypdoku/ypdoku.html"> - Introduction to YP/NIS</ulink>. There is also a book called <ulink - url="http://www.oreilly.com/catalog/nfs/noframes.html">Managing - NFS and NIS</ulink> by Hal Stern. + information refer to the NIS manpage and <ulink url="http://www.desy.de/~sieversm/ypdoku/ypdoku/ypdoku.html"> + Introduction to YP/NIS</ulink>. There is also a book called <ulink url="http://www.oreilly.com/catalog/nfs/noframes.html">Managing + NFS and NIS</ulink> by Hal Stern.</para> <para> To get these functions to work, you have to configure PHP with - <option role="configure">--with-yp</option>. + <option role="configure">--with-yp</option>.</para> </partintro> <refentry id="function.yp-get-default-domain"> @@ -32,13 +30,13 @@ <para> <function>yp_get_default_domain</function> returns the default domain of the node or FALSE. Can be used as the domain parameter - for successive NIS calls. + for successive NIS calls.</para> <para> A NIS domain can be described a group of NIS maps. Every host that needs to look up information binds itself to a certain domain. Refer to the documents mentioned at the beginning for - more detailed information. + more detailed information.</para> <para> <example> @@ -54,11 +52,11 @@ echo "Default NIS domain is: " . $domain; ?> </programlisting> - </example> + </example></para> <para> See also: <link linkend="function.yp-errno">yp_errno</link> and - <link linkend="function.yp-err-string">yp_err_string</link> + <link linkend="function.yp-err-string">yp_err_string</link></para> </refsect1> </refentry> @@ -77,7 +75,7 @@ <para> <function>yp_order</function> returns the order number for a map - or FALSE. + or FALSE.</para> <para> <example> @@ -93,13 +91,11 @@ echo "Order number for this map is: " . $order; ?> </programlisting> - </example> + </example></para> <para> See also: <link linkend="function.yp-get-default-domain"> - yp_get_default_domain</link> <link - linkend="function.yp-errno">yp_errno</link> and <link - linkend="function.yp-err-string">yp_err_string</link> + yp_get_default_domain</link> <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link></para> </refsect1> </refentry> @@ -118,7 +114,7 @@ </funcsynopsis> <para> <function>yp_master</function> returns the machine name of - the master NIS server for a map. + the master NIS server for a map.</para> <para> <example> <title>Example for the NIS master</title> @@ -133,13 +129,11 @@ echo "Master for this map is: " . $master; ?> </programlisting> - </example> + </example></para> <para> See also: <link linkend="function.yp-get-default-domain"> - yp_get_default_domain</link> <link - linkend="function.yp-errno">yp_errno</link> and <link - linkend="function.yp-err-string">yp_err_string</link> + yp_get_default_domain</link> <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link></para> </refsect1> </refentry> @@ -160,11 +154,11 @@ <para> <function>yp_match</function> returns the value associated with the passed key out of the specified map or FALSE. This key must - be exact. + be exact.</para> <para> <example> <title>Example for NIS match</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $entry = yp_match($domain, "passwd.byname", "joe"); @@ -175,17 +169,15 @@ echo "Matched entry is: " . $entry; ?> </programlisting> - </example> + </example></para> <para> In this case this could be: joe:##joe:11111:100:Joe - User:/home/j/joe:/usr/local/bin/bash + User:/home/j/joe:/usr/local/bin/bash</para> <para> See also: <link linkend="function.yp-get-default-domain"> - yp_get_default_domain</link> <link - linkend="function.yp-errno">yp_errno</link> and <link - linkend="function.yp-err-string">yp_err_string</link> + yp_get_default_domain</link> <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link></para> </refsect1> </refentry> @@ -206,7 +198,7 @@ <para> <function>yp_first</function> returns the first key-value - pair from the named map in the named domain, otherwise FALSE. + pair from the named map in the named domain, otherwise FALSE.</para> <para> <example> @@ -224,13 +216,11 @@ . " and value " . $entry[$key]; ?> </programlisting> - </example> + </example></para> <para> See also: <link linkend="function.yp-get-default-domain"> - yp_get_default_domain</link> <link - linkend="function.yp-errno">yp_errno</link> and <link - linkend="function.yp-err-string">yp_err_string</link> + yp_get_default_domain</link> <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link></para> </refsect1> </refentry> @@ -251,7 +241,7 @@ </funcsynopsis> <para> <function>yp_next</function> returns the next key-value pair in - the named map after the specified key or FALSE. + the named map after the specified key or FALSE.</para> <para> <example> @@ -270,13 +260,11 @@ . " and value " . $entry[$key]; ?> </programlisting> - </example> + </example></para> <para> See also: <link linkend="function.yp-get-default-domain"> - yp_get_default_domain</link>, <link - linkend="function.yp-errno">yp_errno</link> and <link - linkend="function.yp-err-string">yp_err_string</link> + yp_get_default_domain</link>, <link linkend="function.yp-errno">yp_errno</link> and <link linkend="function.yp-err-string">yp_err_string</link></para> </refsect1> </refentry> @@ -293,9 +281,9 @@ </funcsynopsis> <para> <function>yp_errno</function> returns the error code of the - previous operation. + previous operation.</para> <para> - Possible errors are: + Possible errors are:</para> <para> <simplelist> <member>1 args to function are bad</member> @@ -314,10 +302,10 @@ <member>14 yp version mismatch</member> <member>15 access violation</member> <member>16 database busy</member> - </simplelist> + </simplelist></para> <para> See also: <link linkend="function.yp-err-string"> - yp_err_string</link> + yp_err_string</link></para> </refsect1> </refentry> @@ -337,7 +325,7 @@ <para> <function>yp_err_string</function> returns the error message associated with the previous operation. Useful to indicate what - exactly went wrong. + exactly went wrong.</para> <para> <example> @@ -347,9 +335,9 @@ echo "Error: " . yp_err_string(); ?> </programlisting> - </example> + </example></para> <para> - See also: <link linkend="function.yp-errno"> yp_errno</link> + See also: <link linkend="function.yp-errno"> yp_errno</link></para> </refsect1> </refentry> Index: phpdoc/functions/oci8.sgml diff -u phpdoc/functions/oci8.sgml:1.10 phpdoc/functions/oci8.sgml:1.11 --- phpdoc/functions/oci8.sgml:1.10 Sat Sep 4 06:25:23 1999 +++ phpdoc/functions/oci8.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.oci8"> <title>Oracle 8 functions</title> <titleabbrev>OCI8</titleabbrev> @@ -6,12 +5,12 @@ <simpara> These functions allow you to access Oracle8 and Oracle7 databases. It uses the Oracle8 Call-Interface (OCI8). You will need the Oracle8 client - libraries to use this extension. + libraries to use this extension.</simpara> <simpara> This extension is more flexible than the standard Oracle extension. It supports binding of global and local PHP variables to Oracle placeholders, has full LOB, FILE and ROWID support - and allows you to use user-supplied define variables. + and allows you to use user-supplied define variables.</simpara> </partintro> <!-- @@ -308,10 +307,10 @@ drop_table($c1); print "&lt;/PRE>&lt;/HTML>"; -?></programlisting></example> +?></programlisting></example></para> <simpara> See also <function>OCIPLogon</function> and - <function>OCINLogon</function>. + <function>OCINLogon</function>.</simpara> </refsect1> </refentry> @@ -340,8 +339,8 @@ </para> <simpara> See also <function>OCILogon</function> and - <function>OCINLogon</function>. - </refsect1> + <function>OCINLogon</function>.</simpara> + </refsect1></refentry> <refentry id="function.ocinlogon"> <refnamediv> @@ -458,11 +457,11 @@ drop_table($c1); print "&lt;/PRE>&lt;/HTML>"; -?></programlisting></example> +?></programlisting></example></para> <simpara> See also <function>OCILogon</function> and - <function>OCIPLogon</function>. - </refsect1> + <function>OCIPLogon</function>.</simpara> + </refsect1></refentry> <refentry id="function.ocilogoff"> <refnamediv> @@ -639,7 +638,7 @@ <para> <function>OCIRowCounts</function> returns the number of rows affected for eg update-statements. This funtions will not tell you the number - of rows that a select will return! + of rows that a select will return!</para> <para> <example> <title>OCIRowCount</title> @@ -661,7 +660,7 @@ OCIFreeStatement($stmt); OCILogOff($conn); print "&lt;/PRE>&lt;/HTML>"; -?> </programlisting></example> +?> </programlisting></example></para> </refsect1> </refentry> @@ -916,10 +915,10 @@ OCILogoff($conn); print "&lt;/PRE>"; print "&lt;/HTML>\n"; -?> </programlisting></example> +?> </programlisting></example></para> <simpara> See also <function>OCINumCols</function>, <function>OCIColumnName</function>, - and <function>OCIColumnSize</function>. + and <function>OCIColumnSize</function>.</simpara> </refsect1> </refentry> @@ -942,7 +941,7 @@ $conn = OCILogon("scott","tiger"); print "Server Version: " . OCIServerVersion($conn); OCILogOff($conn); -?></programlisting></example> +?></programlisting></example></para> </refsect1> </refentry> @@ -961,17 +960,17 @@ <para> <function>OCIStatementType</function> returns on of the following values: <orderedlist> - <listitem><simpara> "SELECT" - <listitem><simpara> "UPDATE" - <listitem><simpara> "DELETE" - <listitem><simpara> "INSERT" - <listitem><simpara> "CREATE" - <listitem><simpara> "DROP" - <listitem><simpara> "ALTER" - <listitem><simpara> "BEGIN" - <listitem><simpara> "DECLARE" - <listitem><simpara> "UNKNOWN" - </orderedlist> + <listitem><simpara> "SELECT"</simpara></listitem> + <listitem><simpara> "UPDATE"</simpara></listitem> + <listitem><simpara> "DELETE"</simpara></listitem> + <listitem><simpara> "INSERT"</simpara></listitem> + <listitem><simpara> "CREATE"</simpara></listitem> + <listitem><simpara> "DROP"</simpara></listitem> + <listitem><simpara> "ALTER"</simpara></listitem> + <listitem><simpara> "BEGIN"</simpara></listitem> + <listitem><simpara> "DECLARE"</simpara></listitem> + <listitem><simpara> "UNKNOWN"</simpara></listitem> + </orderedlist></para> <para> <example> <title>Code examples</title> @@ -989,7 +988,7 @@ OCILogoff($conn); print "&lt;/PRE>&lt;/HTML>"; ?> -</programlisting></example> +</programlisting></example></para> </refsect1> </refentry> @@ -1031,7 +1030,7 @@ OCIFreeCursor($stmt); OCIFreeStatement($curs); OCILogoff($conn); -?></programlisting></example> +?></programlisting></example></para> <para> <example> @@ -1069,7 +1068,7 @@ print "&lt;/BODY>&lt;/HTML>"; OCIFreeStatement($stmt); OCILogoff($conn); -?></programlisting></example> +?></programlisting></example></para> </refsect1> </refentry> @@ -1124,7 +1123,7 @@ </funcsynopsis> <simpara> <function>OCIColumnName</function> returns the name of the column - corresponding to the column number (1-based) that is passed in. + corresponding to the column number (1-based) that is passed in.</simpara> <para> <example> @@ -1156,10 +1155,10 @@ OCILogoff($conn); print "&lt;/PRE>"; print "&lt;/HTML>\n"; -?> </programlisting></example> +?> </programlisting></example></para> <simpara> See also <function>OCINumCols</function>, <function>OCIColumnType</function>, - and <function>OCIColumnSize</function>. + and <function>OCIColumnSize</function>.</simpara> </refsect1> </refentry> @@ -1177,7 +1176,7 @@ </funcsynopsis> <simpara> <function>OCIColumnType</function> returns the data type of the column - corresponding to the column number (1-based) that is passed in. + corresponding to the column number (1-based) that is passed in.</simpara> <para> <example> @@ -1209,10 +1208,10 @@ OCILogoff($conn); print "&lt;/PRE>"; print "&lt;/HTML>\n"; -?> </programlisting></example> +?> </programlisting></example></para> <simpara> See also <function>OCINumCols</function>, <function>OCIColumnName</function>, - and <function>OCIColumnSize</function>. + and <function>OCIColumnSize</function>.</simpara> </refsect1> </refentry> @@ -1232,7 +1231,7 @@ <function>OCIParse</function> parses the <parameter>query</parameter> using <parameter>conn</parameter>. It returns true if the query is valid, false if not. The <parameter>query</parameter> can be any valid - SQL statement. + SQL statement.</simpara> </refsect1> </refentry> <refentry id="function.ocierror"> @@ -1251,7 +1250,7 @@ <simpara> <function>OCIError</function> returns the last error found. If the optional <parameter>stmt|conn</parameter> is not provided, the last error encountered - is returned. If no error is found, <function>OCIError</function> returns false. + is returned. If no error is found, <function>OCIError</function> returns false.</simpara> </refsect1> </refentry> <refentry id="function.ociinternaldebug"> @@ -1267,7 +1266,7 @@ </funcsynopsis> <simpara> <function>OCIInternalDebug</function> enables internal debug output. Set <parameter>onoff</parameter> - to 0 to turn debug output off, 1 to turn it on. + to 0 to turn debug output off, 1 to turn it on.</simpara> </refsect1> </refentry> </reference> Index: phpdoc/functions/oracle.sgml diff -u phpdoc/functions/oracle.sgml:1.2 phpdoc/functions/oracle.sgml:1.3 --- phpdoc/functions/oracle.sgml:1.2 Sat Jun 19 18:12:06 1999 +++ phpdoc/functions/oracle.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.oracle"> <title>Oracle functions</title> <titleabbrev>Oracle</titleabbrev> @@ -22,7 +21,7 @@ Returns true if the bind succeeds, otherwise false. Details about the error can be retrieved using the <function>ora_error</function> and - <function>ora_errorcode</function> functions. + <function>ora_errorcode</function> functions.</para> <para> This function binds the named PHP variable with a SQL parameter. @@ -30,7 +29,7 @@ type parameter, you can define whether the SQL parameter is an in/out (0, default), in (1) or out (2) parameter. As of PHP 3.0.1, you can use the constants ORA_BIND_INOUT, ORA_BIND_IN and - ORA_BIND_OUT instead of the numbers. + ORA_BIND_OUT instead of the numbers.</para> <para> ora_bind must be called after <function>ora_parse</function> and @@ -40,7 +39,7 @@ values if available. <informalexample> - <programlisting role=php> + <programlisting role="php"> &lt;?php ora_parse($curs, "declare tmp INTEGER; begin tmp := :in; :out := tmp; :x := 7.77; end;"); ora_bind($curs, "result", ":x", $len, 2); @@ -51,7 +50,7 @@ echo "Result: $result&lt;BR>Out: $output&lt;BR>In: $input"; ?> </programlisting> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -71,11 +70,11 @@ Returns true if the close succeeds, otherwise false. Details about the error can be retrieved using the <function>ora_error</function> and - <function>ora_errorcode</function> functions. + <function>ora_errorcode</function> functions.</para> <para> This function closes a data cursor opened with - <function>ora_open</function>. + <function>ora_open</function>.</para> </refsect1> </refentry> @@ -97,7 +96,7 @@ Returns the name of the field/column <parameter>column</parameter> on the cursor <parameter>cursor</parameter>. The returned name is in all - uppercase letters. + uppercase letters.</para> </refsect1> </refentry> @@ -129,7 +128,7 @@ <member><literal>"ROWID"</literal></member> <member><literal>"DATE"</literal></member> <member><literal>"CURSOR"</literal></member> - </simplelist> + </simplelist></para> </refsect1> </refentry> @@ -150,7 +149,7 @@ and <function>ora_errorcode</function> functions. This function commits an Oracle transaction. A transaction is defined as all the changes on a given connection since the last commit/rollback, - autocommit was turned off or when the connection was established. + autocommit was turned off or when the connection was established.</para> </refsect1> </refentry> @@ -170,11 +169,11 @@ <para> Returns true on success, false on error. Details about the error can be retrieved using the <function>ora_error</function> and - <function>ora_errorcode</function> functions. + <function>ora_errorcode</function> functions.</para> <para> This function turns off automatic commit after each - <function>ora_exec</function>. + <function>ora_exec</function>.</para> </refsect1> </refentry> @@ -193,12 +192,12 @@ </funcsynopsis> <para> This function turns on automatic commit after each - <function>ora_exec</function> on the given connection. + <function>ora_exec</function> on the given connection.</para> <para> Returns true on success, false on error. Details about the error can be retrieved using the <function>ora_error</function> and - <function>ora_errorcode</function> functions. + <function>ora_errorcode</function> functions.</para> </refsect1> </refentry> @@ -223,7 +222,7 @@ message. <note> <para>Support for connection ids was added in 3.0.4.</para> - </note> + </note></para> <para> On UNIX versions of Oracle, you can find details about an error message like this: <computeroutput> @@ -232,7 +231,7 @@ statement attempted to insert a duplicate key // For Trusted ORACLE configured in DBMS MAC mode, you may see // this message if a duplicate entry exists at a different level. // *Action: Either -remove the unique restriction or do not insert the key </computeroutput> +remove the unique restriction or do not insert the key </computeroutput></para> </refsect1> </refentry> @@ -255,7 +254,7 @@ <comment>FIXME: should possible values be listed?</comment> <note> <para>Support for connection ids was added in 3.0.4.</para> - </note> + </note></para> </refsect1> </refentry> @@ -275,7 +274,7 @@ <para> Returns true on success, false on error. Details about the error can be retrieved using the <function>ora_error</function> and - <function>ora_errorcode</function> functions. + <function>ora_errorcode</function> functions.</para> </refsect1> </refentry> @@ -298,7 +297,7 @@ using the <function>ora_error</function> and <function>ora_errorcode</function> functions. If there was no error, <function>ora_errorcode</function> will return 0. - Retrieves a row of data from the specified cursor. + Retrieves a row of data from the specified cursor.</para> </refsect1> </refentry> @@ -323,7 +322,7 @@ on the results from this function may be true in cases where there is not error as well (NULL result, empty string, the number 0, the string "0"). Fetches the data for a column or function - result. + result.</para> </refsect1> </refentry> @@ -344,7 +343,7 @@ Returns true on success, False on error. Details about the error can be retrieved using the <function>ora_error</function> and <function>ora_errorcode</function> functions. Logs out the user and disconnects from the - server. + server.</para> </refsect1> </refentry> @@ -364,28 +363,28 @@ </funcsynopsis> <para> Establishes a connection between PHP and an Oracle database with the - given username and password. + given username and password.</para> <para> Connections can be made using <productname>SQL*Net</productname> by supplying the <acronym>TNS</acronym> name to <parameter>user</parameter> like this: <informalexample> - <programlisting role=php> + <programlisting role="php"> $conn = Ora_Logon("user<emphasis>@TNSNAME</emphasis>", "pass"); </programlisting> - </informalexample> + </informalexample></para> <para> If you have character data with non-ASCII characters, you should make sure that <envar>NLS_LANG</envar> is set in your environment. For server modules, you should set it in the - server's environment before starting the server. + server's environment before starting the server.</para> <para> Returns a connection index on success, or false on failure. Details about the error can be retrieved using the <function>ora_error</function> and <function>ora_errorcode</function> - functions. + functions.</para> </refsect1> </refentry> @@ -408,7 +407,7 @@ <para> Returns a cursor index or False on failure. Details about the error can be retrieved using the <function>ora_error</function> and <function>ora_errorcode</function> - functions. + functions.</para> </refsect1> </refentry> @@ -430,7 +429,7 @@ <para> This function parses an SQL statement or a PL/SQL block and associates it with the given cursor. Returns 0 on success or -1 on - error. + error.</para> </refsect1> </refentry> @@ -450,12 +449,12 @@ <para> This function undoes an Oracle transaction. (See <function>ora_commit</function> for the definition of a - transaction.) + transaction.)</para> <para> Returns true on success, false on error. Details about the error can be retrieved using the <function>ora_error</function> and - <function>ora_errorcode</function> functions. + <function>ora_errorcode</function> functions.</para> </refsect1> </refentry> Index: phpdoc/functions/pcre.sgml diff -u phpdoc/functions/pcre.sgml:1.9 phpdoc/functions/pcre.sgml:1.10 --- phpdoc/functions/pcre.sgml:1.9 Fri Oct 1 15:04:08 1999 +++ phpdoc/functions/pcre.sgml Wed Oct 20 18:41:42 1999 @@ -9,33 +9,33 @@ forward slash (/), for example. Any character can be used for delimiter as long as it's not alphanumeric or backslash (\). If the delimiter character has to be used in the expression itself, - it needs to be escaped by backslash. + it needs to be escaped by backslash.</para> <para> The ending delimiter may be followed by various modifiers that affect the matching. - See <link linkend="pcre.pattern.modifiers">Pattern Modifiers</link>. + See <link linkend="pcre.pattern.modifiers">Pattern Modifiers</link>.</para> <para> <example> <title>Examples of valid patterns</title> <itemizedlist> - <listitem><simpara>/<\/\w+>/</listitem> - <listitem><simpara>|(\d{3})-\d+|Sm</listitem> - <listitem><simpara>/^(?i)php[34]/</listitem> + <listitem><simpara>/<\/\w+>/</simpara></listitem> + <listitem><simpara>|(\d{3})-\d+|Sm</simpara></listitem> + <listitem><simpara>/^(?i)php[34]/</simpara></listitem> </itemizedlist> - </example> + </example></para> <para> <example> <title>Examples of invalid patterns</title> <itemizedlist> - <listitem><simpara>/href='(.*)' - missing ending delimiter</listitem> - <listitem><simpara>/\w+\s*\w+/J - unknown modifier 'J'</listitem> - <listitem><simpara>1-\d3-\d3-\d4| - missing starting delimiter + <listitem><simpara>/href='(.*)' - missing ending delimiter</simpara></listitem> + <listitem><simpara>/\w+\s*\w+/J - unknown modifier 'J'</simpara></listitem> + <listitem><simpara>1-\d3-\d3-\d4| - missing starting delimiter</simpara> </listitem> </itemizedlist> - </example> + </example></para> </partintro> <refentry id="function.preg-match"> @@ -53,18 +53,18 @@ </funcsynopsis> <para> Searches <parameter>subject</parameter> for a match to the regular - expression given in <parameter>pattern</parameter>. + expression given in <parameter>pattern</parameter>.</para> <para> If <parameter>matches</parameter> is provided, then it is filled with the results of search. $matches[0] will contain the text that match the full pattern, $matches[1] will have the text that matched - the first captured parenthesized subpattern, and so on. + the first captured parenthesized subpattern, and so on.</para> <para> Returns true if a match for <parameter>pattern</parameter> was found in the subject string, or false if not match was found - or an error occurred. + or an error occurred.</para> <para> <example> @@ -79,7 +79,7 @@ See also <function>preg_match_all</function>, <function>preg_replace</function>, and - <function>preg_split</function>. + <function>preg_split</function>.</para> </refsect1> </refentry> @@ -101,11 +101,11 @@ Searches <parameter>subject</parameter> for all matches to the regular expression given in <parameter>pattern</parameter> and puts them in <parameter>matches</parameter> in the order specified by - <parameter>order</parameter>. + <parameter>order</parameter>.</para> <para> After the first match is found, the subsequent searches are continued - on from end of the last match. + on from end of the last match.</para> <para> <parameter>order</parameter> can be one of two things: @@ -135,7 +135,7 @@ </informalexample> So, $out[0] contains array of strings that matched full pattern, - and $out[1] contains array of strings enclosed by tags. + and $out[1] contains array of strings enclosed by tags.</para> </listitem> </varlistentry> <varlistentry> @@ -165,18 +165,18 @@ In this case, $matches[0] is the first set of matches, and $matches[0][0] has text matched by full pattern, $matches[0][1] has text matched by first subpattern and so on. Similarly, - $matches[1] is the second set of matches, etc. + $matches[1] is the second set of matches, etc.</para> </listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If <parameter>order</parameter> is not specified, it is assumed - to be PREG_PATTERN_ORDER. + to be PREG_PATTERN_ORDER.</para> <para> Returns the number of full pattern matches, or false if - no match is found or an error occurred. + no match is found or an error occurred.</para> <para> <example> @@ -185,12 +185,12 @@ preg_match_all("/\(? (\d{3})? \)? (?(1) [\-\s] ) \d{3}-\d{4}/x", "Call 555-1212 or 1-800-555-1212", $phones); </programlisting> - </example> + </example></para> <simpara> See also <function>preg_match</function>, <function>preg_replace</function>, - and <function>preg_split</function>. + and <function>preg_split</function>.</simpara> </refsect1> </refentry> @@ -210,7 +210,7 @@ <para> Searches <parameter>subject</parameter> for matches to <parameter> pattern</parameter> and replaces them with <parameter>replacement - </parameter>. + </parameter>.</para> <para> <parameter>replacement</parameter> may contain references of the form @@ -220,19 +220,19 @@ </replaceable>can be from 0 to 99, and <literal>\\0</literal> refers to the text matched by the whole pattern. Opening parentheses are counted from left to right (starting from 1) to obtain the number - of the capturing subpattern. + of the capturing subpattern.</para> <para> If no matches are found in <parameter>subject</parameter>, then - it will be returned unchanged. + it will be returned unchanged.</para> <para> - Every parameter to <function>preg_replace</function> can be an array. + Every parameter to <function>preg_replace</function> can be an array.</para> <para> If <parameter>subject</parameter> is an array, then the search and replace is performed on every entry of <parameter>subject</parameter>, - and the return value is an array as well. + and the return value is an array as well.</para> <para> If <parameter>pattern</parameter> and <parameter>replacement</parameter> @@ -244,7 +244,7 @@ </parameter> is an array and <parameter>replacement</parameter> is a string; then this replacement string is used for every value of <parameter>pattern</parameter>. The converse would not make sense, - though. + though.</para> <para> <literal>/e</literal> modifier makes @@ -256,8 +256,8 @@ the line containing <function>preg_replace</function>. <note> <para> - This modifier was added in PHP 4.0. - </note> + This modifier was added in PHP 4.0.</para> + </note></para> <para> <example> @@ -282,13 +282,13 @@ </programlisting> <para> - This would capitalize all HTML tags in the input text. - </example> + This would capitalize all HTML tags in the input text.</para> + </example></para> <para> See also <function>preg_match</function>, <function>preg_match_all</function>, and - <function>preg_split</function>. + <function>preg_split</function>.</para> </refsect1> </refentry> @@ -309,21 +309,21 @@ <note> <para> - Parameter <parameter>flags</parameter> was added in PHP Beta 3. + Parameter <parameter>flags</parameter> was added in PHP Beta 3.</para> </note> <para> Returns an array containing substrings of <parameter>subject</parameter> split along boundaries matched by - <parameter>pattern</parameter>. + <parameter>pattern</parameter>.</para> <para> If <parameter>limit</parameter> is specified, then only substrings - up to <parameter>limit</parameter> are returned. + up to <parameter>limit</parameter> are returned.</para> <para> If flags is PREG_SPLIT_NO_EMPTY then only non-empty pieces will - be by <function>preg_split</function>. + be by <function>preg_split</function>.</para> <para> <example> @@ -335,7 +335,7 @@ See also <function>preg_match</function>, <function>preg_match_all</function>, and - <function>preg_replace</function>. + <function>preg_replace</function>.</para> </refsect1> </refentry> @@ -356,7 +356,7 @@ and puts a backslash in front of every character that is part of the regular expression syntax. This is useful if you have a run-time string that you need to match in some text and the - string may contain special regex characters. + string may contain special regex characters.</para> <para> The special regular expression characters are: @@ -364,8 +364,8 @@ <note> <para> - This function was added in PHP 3.0.9. - </note> + This function was added in PHP 3.0.9.</para> + </note></para> </refsect1> </refentry> @@ -385,7 +385,7 @@ <para> <function>preg_grep</function> returns the array consisting of the elements of the <parameter>input</parameter> array that match - the given <parameter>pattern</parameter>. + the given <parameter>pattern</parameter>.</para> <para> <example> @@ -397,8 +397,8 @@ <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -412,7 +412,7 @@ <title>Description</title> <para> The current possible PCRE modifiers are listed below. The names in - parentheses refer to internal PCRE names for these modifiers. + parentheses refer to internal PCRE names for these modifiers.</para> <para> <blockquote> @@ -422,7 +422,7 @@ <listitem> <simpara> If this modifier is set, letters in the pattern match both - upper and lower case letters. + upper and lower case letters.</simpara> </listitem> </varlistentry> @@ -437,7 +437,7 @@ line" metacharacter ($) matches only at the end of the string, or before a terminating newline (unless <emphasis>E</emphasis> modifier is set). This is the same as - Perl. + Perl.</simpara> <simpara> When this modifier is set, the "start of line" and "end of @@ -446,7 +446,7 @@ well as at the very start and end. This is equivalent to Perl's /m modifier. If there are no "\n" characters in a subject string, or no occurrences of ^ or $ in a pattern, - setting this modifier has no effect. + setting this modifier has no effect.</simpara> </listitem> </varlistentry> @@ -459,7 +459,7 @@ newlines are excluded. This modifier is equivalent to Perl's /s modifier. A negative class such as [^a] always matches a newline character, independent of the setting of this - modifier. + modifier.</simpara> </listitem> </varlistentry> @@ -477,7 +477,7 @@ to data characters. Whitespace characters may never appear within special character sequences in a pattern, for example within the sequence (?( which introduces a conditional - subpattern. + subpattern.</simpara> </listitem> </varlistentry> @@ -488,14 +488,14 @@ If this modifier is set, <function>preg_replace</function> does normal substitution of \\ references in the replacement string, evaluates it as PHP code, and uses the - result for replacing the search string. + result for replacing the search string.</simpara> <simpara> - Only <function>preg_replace</function> uses this modifier; it is ignored by other PCRE functions. + Only <function>preg_replace</function> uses this modifier; it is ignored by other PCRE functions.</simpara> <note> <para> - This modifier was added in PHP 4.0. + This modifier was added in PHP 4.0.</para> </note> </listitem> </varlistentry> @@ -509,7 +509,7 @@ start of the string which is being searched (the "subject string"). This effect can also be achieved by appropriate constructs in the pattern itself, which is the only way to - do it in Perl. + do it in Perl.</simpara> </listitem> </varlistentry> @@ -523,7 +523,7 @@ character if it is a newline (but not before any other newlines). This modifier is ignored if <emphasis>m</emphasis> modifier is set. There is no equivalent to this modifier in - Perl. + Perl.</simpara> </listitem> </varlistentry> @@ -536,7 +536,7 @@ the time taken for matching. If this modifier is set, then this extra analysis is performed. At present, studying a pattern is useful only for non-anchored patterns that do not - have a single fixed starting character. + have a single fixed starting character.</simpara> </listitem> </varlistentry> @@ -547,7 +547,7 @@ This modifier inverts the "greediness" of the quantifiers so that they are not greedy by default, but become greedy if followed by "?". It is not compatible with Perl. It can also - be set by a (?U) modifier setting within the pattern. + be set by a (?U) modifier setting within the pattern.</simpara> </listitem> </varlistentry> @@ -562,11 +562,11 @@ expansion. By default, as in Perl, a backslash followed by a letter with no special meaning is treated as a literal. There are at present no other features controlled by this - modifier. + modifier.</simpara> </listitem> </varlistentry> </variablelist> - </blockquote> + </blockquote></para> </refsect1> </refentry> @@ -582,7 +582,7 @@ expression pattern matching using the same syntax and semantics as Perl 5, with just a few differences (see below). The current implementation corresponds to Perl 5.005. - </literallayout> + </literallayout></refsect1> <refsect1> <title>Differences From Perl</title> Index: phpdoc/functions/pdf.sgml diff -u phpdoc/functions/pdf.sgml:1.11 phpdoc/functions/pdf.sgml:1.12 --- phpdoc/functions/pdf.sgml:1.11 Tue Sep 14 09:40:16 1999 +++ phpdoc/functions/pdf.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.pdf"> <title>PDF functions</title> <titleabbrev>PDF</titleabbrev> @@ -7,8 +6,7 @@ <simpara> You can use the PDF functions in PHP to create PDF files if you - have the PDF library by Thomas Merz (available at <ulink url = - "http://www.pdflib.com/pdflib/index.html">http://www.pdflib.com/pdflib/index.html</ulink>). + have the PDF library by Thomas Merz (available at <ulink url="http://www.pdflib.com/pdflib/index.html">http://www.pdflib.com/pdflib/index.html</ulink>). Please consult the excelent documentation for pdflib shipped with the source distribution of pdflib. It provides a very good overview of what pdflib capable of doing. @@ -18,13 +16,13 @@ or Postscript to efficiently use this module. All lengths and coordinates are measured in Postscript points. There are generally 72 PostScript points to an inch, but this - depends on the output resolution. + depends on the output resolution.</simpara> <simpara> There is another PHP module for pdf document creation based on FastIO's ClibPDF. It has a slightly different API. Check the <link linkend="ref.cpdf">ClibPDF functions</link> section for - details. + details.</simpara> <simpara> Currently all versions of pdflib are supported. It @@ -33,7 +31,7 @@ version. Unfortunately, the changes of the pdflib API in 2.x compared to 0.6 have been so severe that even some PHP functions had to be altered. Here - is a list of changes: + is a list of changes:</simpara> <itemizedlist> <listitem> @@ -63,7 +61,7 @@ There were some more changes with the release 2.01 of pdflib which should be covered by PHP. Some functions are not required anymore (e.g. <function>pdf_put_image</function>). You will get a warning so - don't be shocked. + don't be shocked.</simpara> <simpara> The pdf module introduces two new types of variables (if pdflib 2.x @@ -74,17 +72,17 @@ almost all functions need it as its first parameter. <parameter>pdfinfo</parameter> contains meta data about the PDF document. It has to be set before <function>pdf_open</function> is - called. + called.</simpara> <note><simpara>The following is only true for pdflib 0.6. Read the pdflib - manual for newer version</note> + manual for newer version</simpara></note> <simpara> In order to output text into a PDF document you will need to provide the afm file for each font. Afm files contain font metrics for a Postscript font. By default these afm files are searched for in a directory named 'fonts' relative to the directory where the PHP script is located. (Again, this was true for pdflib 0.6, newer - versions do not not neccessarily need the afm files.) + versions do not not neccessarily need the afm files.)</simpara> <simpara> Most of the functions are fairly easy to use. The most difficult part @@ -92,7 +90,7 @@ example should help to get started. It uses the PHP functions for pdflib 0.6. It creates the file test.pdf with one page. The page contains the text "Times-Roman" in an - outlined 30pt font. The text is also underlined. + outlined 30pt font. The text is also underlined.</simpara> <example> <title>Creating a PDF document with pdflib 0.6</title> <programlisting> @@ -164,7 +162,7 @@ ?> </programlisting> <para> - The PHP script getpdf.php3 is the same as above. + The PHP script getpdf.php3 is the same as above.</para> </example> The pdflib distribution contains a more complex example which @@ -274,8 +272,8 @@ fpassthru($fp); fclose($fp); ?> - </programlisting> - </example> + </programlisting></para> + </example></para> </partintro> <refentry id="function.pdf-get-info"> @@ -297,14 +295,14 @@ <note><simpara> This functions is not available if pdflib 2.0 support is activated. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_set_info_creator</function>, <function>PDF_set_info_author</function>, <function>PDF_set_info_keywords</function>, <function>PDF_set_info_title</function>, - <function>PDF_set_info_subject</function>. + <function>PDF_set_info_subject</function>.</para> </refsect1> </refentry> @@ -336,13 +334,13 @@ is activated. The first parameter has to be the identifier of the pdf document as returned by <function>pdf_open</function>. Consequently, <function>pdf_open</function> has to be called before this function. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_get_info</function>, <function>PDF_set_info_keywords</function>, <function>PDF_set_info_title</function>, - <function>PDF_set_info_subject</function>. + <function>PDF_set_info_subject</function>.</para> </refsect1> </refentry> @@ -375,14 +373,14 @@ is activated. The first parameter has to be the identifier of the pdf document as returned by <function>pdf_open</function>. Consequently, <function>pdf_open</function> has to be called before this function. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_get_info</function>, <function>PDF_set_info_creator</function>, <function>PDF_set_info_author</function>, <function>PDF_set_info_keywords</function>, - <function>PDF_set_info_subject</function>. + <function>PDF_set_info_subject</function>.</para> </refsect1> </refentry> @@ -415,14 +413,14 @@ is activated. The first parameter has to be the identifier of the pdf document as returned by <function>pdf_open</function>. Consequently, <function>pdf_open</function> has to be called before this function. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_get_info</function>, <function>PDF_set_info_creator</function>, <function>PDF_set_info_author</function>, <function>PDF_set_info_title</function>, - <function>PDF_set_info_keywords</function>. + <function>PDF_set_info_keywords</function>.</para> </refsect1> </refentry> @@ -455,14 +453,14 @@ is activated. The first parameter has to be the identifier of the pdf document as returned by <function>pdf_open</function>. Consequently, <function>pdf_open</function> has to be called before this function. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_get_info</function>, <function>PDF_set_info_creator</function>, <function>PDF_set_info_author</function>, <function>PDF_set_info_title</function>, - <function>PDF_set_info_subject</function>. + <function>PDF_set_info_subject</function>.</para> </refsect1> </refentry> @@ -495,14 +493,14 @@ is activated. The first parameter has to be the identifier of the pdf document as returned by <function>pdf_open</function>. Consequently, <function>pdf_open</function> has to be called before this function. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_get_info</function>, <function>PDF_set_info_creator</function>, <function>PDF_set_info_keywords</function>, <function>PDF_set_info_title</function>, - <function>PDF_set_info_subject</function>. + <function>PDF_set_info_subject</function>.</para> </refsect1> </refentry> @@ -536,12 +534,12 @@ <note><simpara> This function does not allow the second parameter if pdflib 2.0 support is activated. - </simpara></note> + </simpara></note></para> <para> See also <function>fopen</function>, <function>PDF_get_info</function>, - <function>PDF_close</function>. + <function>PDF_close</function>.</para> </refsect1> </refentry> @@ -573,11 +571,11 @@ <note><simpara> This function works properly without any patches to pdflib if pdflib 2.0 support is activated. - </simpara></note> + </simpara></note></para> <para> See also <function>PDF_open</function>, - <function>fclose</function>. + <function>fclose</function>.</para> </refsect1> </refentry> @@ -598,10 +596,10 @@ <para> The <function>PDF_begin_page</function> function starts a new page with height <parameter>height</parameter> and width - <parameter>width</parameter>. + <parameter>width</parameter>.</para> <para> - See also <function>PDF_end_page</function>. + See also <function>PDF_end_page</function>.</para> </refsect1> </refentry> @@ -619,10 +617,10 @@ </funcsynopsis> <para> The <function>PDF_end_page</function> function ends a page. - Once a page is ended it cannot be modified anymore. + Once a page is ended it cannot be modified anymore.</para> <para> - See also <function>PDF_begin_page</function>. + See also <function>PDF_begin_page</function>.</para> </refsect1> </refentry> @@ -642,12 +640,12 @@ <para> The <function>PDF_show</function> function outputs the string <parameter>text</parameter> at the current position - using the current font. + using the current font.</para> <para> See also <function>PDF_show_xy</function>, <function>PDF_set_text_pos</function>, - <function>PDF_set_font</function>. + <function>PDF_set_font</function>.</para> </refsect1> </refentry> @@ -669,10 +667,10 @@ <para> The <function>PDF_show_xy</function> function outputs the string <parameter>text</parameter> at position - (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). + (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>).</para> <para> - See also <function>PDF_show</function>. + See also <function>PDF_show</function>.</para> </refsect1> </refentry> @@ -706,7 +704,7 @@ <note><simpara> This function does not need the afm files for winansi encoding if pdflib 2.0 support is activated. - </simpara></note> + </simpara></note></para> </refsect1> </refentry> @@ -726,10 +724,10 @@ <para> The <function>PDF_set_leading</function> function sets the distance between text lines. This will be used if text is output by - <function>PDF_continue_text</function>. + <function>PDF_continue_text</function>.</para> <para> - See also <function>PDF_continue_text</function>. + See also <function>PDF_continue_text</function>.</para> </refsect1> </refentry> @@ -752,7 +750,7 @@ are 0=fill text, 1=stroke text, 2=fill and stroke text, 3=invisible, 4=fill text and add it to cliping path, 5=stroke text and add it to clipping path, 6=fill and stroke text and add - it to cliping path, 7=add it to clipping path. + it to cliping path, 7=add it to clipping path.</para> </refsect1> </refentry> @@ -770,7 +768,7 @@ </funcsynopsis> <para> The <function>PDF_set_horiz_scaling</function> function sets the - horizontal scaling to <parameter>scale</parameter> percent. + horizontal scaling to <parameter>scale</parameter> percent.</para> </refsect1> </refentry> @@ -788,7 +786,7 @@ </funcsynopsis> <para> The <function>PDF_set_text_rise</function> function sets the - text rising to <parameter>value</parameter> points. + text rising to <parameter>value</parameter> points.</para> </refsect1> </refentry> @@ -807,7 +805,7 @@ <para> The <function>PDF_set_text_matrix</function> function sets a matrix which describes a transformation applied on the current - text font. The matrix has to passed as an array with six elements. + text font. The matrix has to passed as an array with six elements.</para> </refsect1> </refentry> @@ -827,10 +825,10 @@ <para> The <function>PDF_set_text_pos</function> function sets the position of text for the next <function>pdf_show</function> - function call. + function call.</para> <para> See also <function>PDF_show</function>, - <function>PDF_show_xy</function>. + <function>PDF_show_xy</function>.</para> </refsect1> </refentry> @@ -848,10 +846,10 @@ </funcsynopsis> <para> The <function>PDF_set_char_spacing</function> function sets the - spacing between characters. + spacing between characters.</para> <para> See also <function>PDF_set_word_spacing</function>, - <function>PDF_set_leading</function>. + <function>PDF_set_leading</function>.</para> </refsect1> </refentry> @@ -870,11 +868,11 @@ </funcsynopsis> <para> The <function>PDF_set_word_spacing</function> function sets the - spacing between words. + spacing between words.</para> <para> See also <function>PDF_set_char_spacing</function>, - <function>PDF_set_leading</function>. + <function>PDF_set_leading</function>.</para> </refsect1> </refentry> @@ -895,12 +893,12 @@ The <function>PDF_continue_text</function> function outputs the string in <parameter>text</parameter> in the next line. The distance between the lines can be set with - <function>PDF_set_leading</function>. + <function>PDF_set_leading</function>.</para> <para> See also <function>PDF_show_xy</function>, <function>PDF_set_leading</function>, - <function>PDF_set_text_pos</function>. + <function>PDF_set_text_pos</function>.</para> </refsect1> </refentry> @@ -920,10 +918,10 @@ <para> The <function>PDF_stringwidth</function> function returns the width of the string in <parameter>text</parameter>. It requires - a font to be set before. + a font to be set before.</para> <para> - See also <function>PDF_set_font</function>. + See also <function>PDF_set_font</function>.</para> </refsect1> </refentry> @@ -944,10 +942,10 @@ environment. It works like the postscript command gsave. Very useful if you want to translate or rotate an object without effecting other objects. <function>PDF_save</function> should always be - followed by <function>PDF_restore</function>. + followed by <function>PDF_restore</function>.</para> <para> - See also <function>PDF_restore</function>. + See also <function>PDF_restore</function>.</para> </refsect1> </refentry> @@ -976,10 +974,10 @@ &lt;?php PDF_save($pdf); // do all kinds of rotations, transformations, ... PDF_restore($pdf) ?> -</programlisting></example> +</programlisting></example></para> <para> - See also <function>PDF_save</function>. + See also <function>PDF_save</function>.</para> </refsect1> </refentry> @@ -1017,7 +1015,7 @@ PDF_lineto($pdf, 100, 100); PDF_stroke($pdf); ?> -</programlisting></example> +</programlisting></example></para> </refsect1> </refentry> @@ -1048,7 +1046,7 @@ PDF_lineto($pdf, 1, 1); PDF_stroke($pdf); ?> -</programlisting></example> +</programlisting></example></para> </refsect1> </refentry> @@ -1067,7 +1065,7 @@ </funcsynopsis> <para> The <function>PDF_rotate</function> function set the rotation in - degress to <parameter>angle</parameter>. + degress to <parameter>angle</parameter>.</para> </refsect1> </refentry> @@ -1086,7 +1084,7 @@ </funcsynopsis> <para> The <function>PDF_setflat</function> function set the flatness to - a value between 0 and 100. + a value between 0 and 100.</para> </refsect1> </refentry> @@ -1105,7 +1103,7 @@ </funcsynopsis> <para> The <function>PDF_setlinejoin</function> function set the linejoin - parameter between a value of 0 and 2. + parameter between a value of 0 and 2.</para> </refsect1> </refentry> @@ -1124,7 +1122,7 @@ </funcsynopsis> <para> The <function>PDF_setlinecap</function> function set the linecap - parameter between a value of 0 and 2. + parameter between a value of 0 and 2.</para> </refsect1> </refentry> @@ -1143,7 +1141,7 @@ </funcsynopsis> <para> The <function>PDF_setmiterlimit</function> function set the miter limit - to a value greater of equal than 1. + to a value greater of equal than 1.</para> </refsect1> </refentry> @@ -1162,7 +1160,7 @@ </funcsynopsis> <para> The <function>PDF_setlinewidth</function> function set the line width - to <parameter>width</parameter>. + to <parameter>width</parameter>.</para> </refsect1> </refentry> @@ -1183,7 +1181,7 @@ <para> The <function>PDF_setdash</function> function set the dash pattern <parameter>white</parameter> white points and <parameter>black</parameter> - black points. If both are 0 a solid line is set. + black points. If both are 0 a solid line is set.</para> </refsect1> </refentry> @@ -1204,7 +1202,7 @@ <para> The <function>PDF_moveto</function> function set the current point to the coordinates <parameter>x-koor</parameter> and - <parameter>y-koor</parameter>. + <parameter>y-koor</parameter>.</para> </refsect1> </refentry> @@ -1232,12 +1230,12 @@ (<parameter>x3</parameter>, <parameter>y3</parameter>) using (<parameter>x1</parameter>, <parameter>y1</parameter>) and (<parameter>x2</parameter>, <parameter>y2</parameter>) as control - points. + points.</para> <para> See also <function>PDF_moveto</function>, <function>PDF_lineto</function>, - <function>PDF_stroke</function>. + <function>PDF_stroke</function>.</para> </refsect1> </refentry> @@ -1258,12 +1256,12 @@ <para> The <function>PDF_lineto</function> function draws a line from the current point to the point with coordinates - (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). + (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>).</para> <para> See also <function>PDF_moveto</function>, <function>PDF_curveto</function>, - <function>PDF_stroke</function>. + <function>PDF_stroke</function>.</para> </refsect1> </refentry> @@ -1286,11 +1284,11 @@ The <function>PDF_circle</function> function draws a circle with center at point (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>) - and radius <parameter>radius</parameter>. + and radius <parameter>radius</parameter>.</para> <para> See also <function>PDF_arc</function>, - <function>PDF_stroke</function>. + <function>PDF_stroke</function>.</para> </refsect1> </refentry> @@ -1317,11 +1315,11 @@ (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>) and radius <parameter>radius</parameter>, starting at angle <parameter>start</parameter> and ending at angle - <parameter>end</parameter>. + <parameter>end</parameter>.</para> <para> See also <function>PDF_circle</function>, - <function>PDF_stroke</function>. + <function>PDF_stroke</function>.</para> </refsect1> </refentry> @@ -1346,10 +1344,10 @@ its lower left corner at point (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>). This width is set to <parameter>widgth</parameter>. - This height is set to <parameter>height</parameter>. + This height is set to <parameter>height</parameter>.</para> <para> - See also <function>PDF_stroke</function>. + See also <function>PDF_stroke</function>.</para> </refsect1> </refentry> @@ -1369,7 +1367,7 @@ current path. This means, it draws a line from current point to the point where the first line was started. Many functions like <function>PDF_moveto</function>, <function>PDF_circle</function> - and <function>PDF_rect</function> start a new path. + and <function>PDF_rect</function> start a new path.</para> </refsect1> </refentry> @@ -1388,11 +1386,11 @@ <para> The <function>PDF_stroke</function> function draws a line along current path. The current path is the sum of all line drawing. - Without this function the line would not be drawn. + Without this function the line would not be drawn.</para> <para> See also <function>PDF_closepath</function>, - <function>PDF_closepath_stroke</function>. + <function>PDF_closepath_stroke</function>.</para> </refsect1> </refentry> @@ -1411,11 +1409,11 @@ <para> The <function>PDF_closepath_stroke</function> function is a combination of <function>PDF_closepath</function> and - <function>PDF_stroke</function>. Than clears the path. + <function>PDF_stroke</function>. Than clears the path.</para> <para> See also <function>PDF_closepath</function>, - <function>PDF_stroke</function>. + <function>PDF_stroke</function>.</para> </refsect1> </refentry> @@ -1433,7 +1431,7 @@ </funcsynopsis> <para> The <function>PDF_fill</function> function fills the interior of - the current path with the current fill color. + the current path with the current fill color.</para> <para> See also <function>PDF_closepath</function>, @@ -1441,7 +1439,7 @@ <function>PDF_setgray_fill</function>, <function>PDF_setgray</function>, <function>PDF_setrgbcolor_fill</function>, - <function>PDF_setrgbcolor</function>. + <function>PDF_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1459,7 +1457,7 @@ </funcsynopsis> <para> The <function>PDF_fill_stroke</function> function fills the interior of - the current path with the current fill color and draws current path. + the current path with the current fill color and draws current path.</para> <para> See also <function>PDF_closepath</function>, @@ -1468,7 +1466,7 @@ <function>PDF_setgray_fill</function>, <function>PDF_setgray</function>, <function>PDF_setrgbcolor_fill</function>, - <function>PDF_setrgbcolor</function>. + <function>PDF_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1487,7 +1485,7 @@ <para> The <function>PDF_closepath_fill_stroke</function> function closes, fills the interior of - the current path with the current fill color and draws current path. + the current path with the current fill color and draws current path.</para> <para> See also <function>PDF_closepath</function>, @@ -1496,7 +1494,7 @@ <function>PDF_setgray_fill</function>, <function>PDF_setgray</function>, <function>PDF_setrgbcolor_fill</function>, - <function>PDF_setrgbcolor</function>. + <function>PDF_setrgbcolor</function>.</para> </refsect1> </refentry> @@ -1514,10 +1512,10 @@ </funcsynopsis> <para> The <function>PDF_endpath</function> function ends - the current path but does not close it. + the current path but does not close it.</para> <para> - See also <function>PDF_closepath</function>. + See also <function>PDF_closepath</function>.</para> </refsect1> </refentry> @@ -1535,7 +1533,7 @@ </funcsynopsis> <para> The <function>PDF_clip</function> function clips all drawing - to the current path. + to the current path.</para> </refsect1> </refentry> @@ -1554,10 +1552,10 @@ </funcsynopsis> <para> The <function>PDF_setgray_fill</function> function sets the current - gray value to fill a path. + gray value to fill a path.</para> <para> - See also <function>PDF_setrgbcolor_fill</function>. + See also <function>PDF_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1576,10 +1574,10 @@ </funcsynopsis> <para> The <function>PDF_setgray_stroke</function> function sets the current - drawing color to the given gray value. + drawing color to the given gray value.</para> <para> - See also <function>PDF_setrgbcolor_stroke</function>. + See also <function>PDF_setrgbcolor_stroke</function>.</para> </refsect1> </refentry> @@ -1598,11 +1596,11 @@ </funcsynopsis> <para> The <function>PDF_setgray_stroke</function> function sets the current - drawing and filling color to the given gray value. + drawing and filling color to the given gray value.</para> <para> See also <function>PDF_setrgbcolor_stroke</function>, - <function>PDF_setrgbcolor_fill</function>. + <function>PDF_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1623,10 +1621,10 @@ </funcsynopsis> <para> The <function>PDF_setrgbcolor_fill</function> function sets the current - rgb color value to fill a path. + rgb color value to fill a path.</para> <para> - See also <function>PDF_setrgbcolor_fill</function>. + See also <function>PDF_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1647,10 +1645,10 @@ </funcsynopsis> <para> The <function>PDF_setrgbcolor_stroke</function> function sets the current - drawing color to the given rgb color value. + drawing color to the given rgb color value.</para> <para> - See also <function>PDF_setrgbcolor_stroke</function>. + See also <function>PDF_setrgbcolor_stroke</function>.</para> </refsect1> </refentry> @@ -1671,11 +1669,11 @@ </funcsynopsis> <para> The <function>PDF_setrgbcolor_stroke</function> function sets the current - drawing and filling color to the given rgb color value. + drawing and filling color to the given rgb color value.</para> <para> See also <function>PDF_setrgbcolor_stroke</function>, - <function>PDF_setrgbcolor_fill</function>. + <function>PDF_setrgbcolor_fill</function>.</para> </refsect1> </refentry> @@ -1694,13 +1692,13 @@ </funcsynopsis> <para> The <function>PDF_add_outline</function> function adds a bookmark - with text <parameter>text</parameter> that points to the current page. + with text <parameter>text</parameter> that points to the current page.</para> <simpara> Unfortunately pdflib does not make a copy of the string, which forces PHP to allocate the memory. Currently this piece of memory is not been freed by any PDF function but it will be taken care of by the - PHP memory manager. + PHP memory manager.</simpara> </refsect1> </refentry> @@ -1747,9 +1745,9 @@ <member> 7 for the old page is simply replaced by the new page (default) </member> - </simplelist> + </simplelist></para> <para> - See also <function>PDF_set_duration</function>. + See also <function>PDF_set_duration</function>.</para> </refsect1> </refentry> @@ -1767,9 +1765,9 @@ </funcsynopsis> <para> The <function>PDF_set_duration</function> function set the duration - between following pages in seconds. + between following pages in seconds.</para> <para> - See also <function>PDF_set_transition</function>. + See also <function>PDF_set_transition</function>.</para> </refsect1> </refentry> @@ -1800,7 +1798,7 @@ pdf_close_image($pdf, $im); ?> </programlisting> - </example> + </example></para> <para> See also <function>PDF_close_image</function>, @@ -1808,7 +1806,7 @@ <function>PDF_open_memory_image</function>, <function>PDF_execute_image</function>, <function>PDF_place_image</function>, - <function>PDF_put_image</function>. + <function>PDF_put_image</function>.</para> </refsect1> </refentry> @@ -1843,7 +1841,7 @@ pdf_close_image($pdf, $pim); ?> </programlisting> - </example> + </example></para> <para> See also <function>PDF_close_image</function>, @@ -1851,7 +1849,7 @@ <function>PDF_open_gif</function>, <function>PDF_execute_image</function>, <function>PDF_place_image</function>, - <function>PDF_put_image</function>. + <function>PDF_put_image</function>.</para> </refsect1> </refentry> @@ -1871,14 +1869,14 @@ The <function>PDF_open_jpeg</function> function opens an image stored in the file with the name <parameter>filename</parameter>. The format of the image has to be jpeg. The function returns a pdf - image identifier. + image identifier.</para> <para> See also <function>PDF_close_image</function>, <function>PDF_open_gif</function>, <function>PDF_open_memory_image</function>, <function>PDF_execute_image</function>, <function>PDF_place_image</function>, - <function>PDF_put_image</function>. + <function>PDF_put_image</function>.</para> </refsect1> </refentry> @@ -1896,11 +1894,11 @@ <para> The <function>PDF_close_image</function> function closes an image which has been opened with any of the <function>PDF_open_xxx</function> - functions. + functions.</para> <para> See also <function>PDF_open_jpeg</function>, <function>PDF_open_gif</function>, - <function>PDF_open_memory_image</function>. + <function>PDF_open_memory_image</function>.</para> </refsect1> </refentry> @@ -1923,9 +1921,9 @@ The <function>PDF_place_image</function> function places an image on the page at postion (<parameter>x-koor</parameter>, <parameter>x-koor</parameter>). The image can be scaled at the same - time. + time.</para> <para> - See also <function>PDF_put_image</function>. + See also <function>PDF_put_image</function>.</para> </refsect1> </refentry> @@ -1952,12 +1950,12 @@ larger images (several kb) if they show up more than once in the document. <note><simpara>This function has become meaningless with version - 2.01 of pdflib. It will just output a warning. - </note> + 2.01 of pdflib. It will just output a warning.</simpara> + </note></para> <para> See also <function>PDF_put_image</function>, <function>PDF_place_image</function>, - <function>PDF_execute_image</function>. + <function>PDF_execute_image</function>.</para> </refsect1> </refentry> @@ -1979,12 +1977,12 @@ <para> The PDF_execute_image function displays an image that has been put in the PDF file with the <function>PDF_put_image</function> - function on the current page at the given coordinates. + function on the current page at the given coordinates.</para> <para> The image can be scaled while displaying it. A scale of 1.0 will show the image in the original size. <note><simpara>This function has become meaningless with version - 2.01 of pdflib. It will just output a warning. + 2.01 of pdflib. It will just output a warning.</simpara> </note> <example> @@ -2001,7 +1999,7 @@ pdf_close_image($pdf, $pim); ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -2027,7 +2025,7 @@ The <function>pdf_add_annotation</function> adds a note with the lower left corner at (<parameter>llx</parameter>, <parameter>lly</parameter>) and the upper right corner at - (<parameter>urx</parameter>, <parameter>ury</parameter>). + (<parameter>urx</parameter>, <parameter>ury</parameter>).</para> </refsect1> </refentry> Index: phpdoc/functions/pgsql.sgml diff -u phpdoc/functions/pgsql.sgml:1.9 phpdoc/functions/pgsql.sgml:1.10 --- phpdoc/functions/pgsql.sgml:1.9 Mon Sep 6 09:29:28 1999 +++ phpdoc/functions/pgsql.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.pgsql"> <title>PostgreSQL functions</title> <titleabbrev>PostgreSQL</titleabbrev> @@ -11,11 +10,10 @@ becoming available in some commercial databases. It provides SQL92/SQL3 language support, transaction integrity, and type extensibility. PostgreSQL is a public-domain, open source - descendant of this original Berkeley code. + descendant of this original Berkeley code.</para> <para> PostgreSQL is available without cost. The current version is - available at <ulink - url="http://www.postgresql.org/">www.PostgreSQL.org</ulink>. + available at <ulink url="http://www.postgresql.org/">www.PostgreSQL.org</ulink>.</para> <para> Since version 6.3 (03/02/1998) PostgreSQL use unix domain sockets, a table is given to this new possibilities. This socket will be @@ -57,11 +55,11 @@ </row> </tbody> </tgroup> - </table> + </table></para> <para> One can also establish a connection with the following command: - <command>$conn = pg_Connect("host=localhost port=5432 dbname=chris");</command> + <command>$conn = pg_Connect("host=localhost port=5432 dbname=chris");</command></para> <para> To use the large object (lo) interface, it is necessary to enclose it within a transaction block. A transaction block starts with a @@ -72,7 +70,7 @@ <example> <title>Using Large Objects</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $database = pg_Connect ("", "", "", "", "jacarta"); pg_exec ($database, "begin"); @@ -86,7 +84,7 @@ pg_exec ($database, "end") ?> </programlisting> - </example> + </example></para> </partintro> @@ -105,7 +103,7 @@ <para> Returns false if connection is not a valid connection index, true otherwise. Closes down the connection to a PostgreSQL database - associated with the given connection index. + associated with the given connection index.</para> </refsect1> </refentry> @@ -128,14 +126,14 @@ <example> <title>pg_cmdtuples</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $result = pg_exec($conn, "INSERT INTO verlag VALUES ('Autor')"); $cmdtuples = pg_cmdtuples($result); echo $cmdtuples . " <- cmdtuples affected."; ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -162,16 +160,16 @@ including the port number. The options and tty arguments are optional and can be left out. This function returns a connection index that is needed by other PostgreSQL functions. You can have - multiple connections open at once. + multiple connections open at once.</para> <para> A connection can also established with the following command: <command>$conn = pg_connect("dbname=marliese port=5432");</command> Other parameters besides <parameter>dbname</parameter> and <parameter>port</parameter> are <parameter>host</parameter>, <parameter>tty</parameter>, <parameter>options</parameter>, - <parameter>user</parameter> and <parameter>password</parameter>. + <parameter>user</parameter> and <parameter>password</parameter>.</para> <para> - See also <function>pg_pConnect</function>. + See also <function>pg_pConnect</function>.</para> </refsect1> </refentry> @@ -189,7 +187,7 @@ <para> Returns the name of the database that the given PostgreSQL connection index is connected to, or false if connection is not a - valid connection index. + valid connection index.</para> </refsect1> </refentry> @@ -210,7 +208,7 @@ pg_errormessage() function if an error occured on the last database action for which a valid connection exists, this function will return a string containing the error message - generated by the backend server. + generated by the backend server.</para> </refsect1> </refentry> @@ -241,7 +239,7 @@ (inserts or updates, for example) and greater than 1 even on selects that did not return anything. No such assumption can be made in PHP. - </simpara></note> + </simpara></note></para> </refsect1> </refentry> @@ -262,32 +260,32 @@ </funcsynopsis> <para> Returns: An array that corresponds to the fetched row, or false - if there are no more rows. + if there are no more rows.</para> <para> <function>pg_fetch_array</function> is an extended version of <function>pg_fetch_row</function>. 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. + the data in associative indices, using the field names as keys.</para> <para> The third optional argument <parameter>result_type</parameter> in <function>pg_fetch_array</function> is a constant and can take the following values: PGSQL_ASSOC, PGSQL_NUM, and PGSQL_BOTH. <note> <para> - <parameter>Result_type</parameter> was added in PHP 4.0. - </note> + <parameter>Result_type</parameter> was added in PHP 4.0.</para> + </note></para> <para> An important thing to note is that using <function>pg_fetch_array</function> is NOT significantly slower than using <function>pg_fetch_row</function>, while it - provides a significant added value. + provides a significant added value.</para> <para> For further details, also see <function>pg_fetch_row</function> </para> <example> <title>PostgreSQL fetch array</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $conn = pg_pconnect("","","","","publisher"); if (!$conn) { @@ -330,32 +328,32 @@ </funcsynopsis> <para> Returns: An object with properties that correspond to the fetched - row, or false if there are no more rows. + row, or false if there are no more rows.</para> <para> <function>pg_fetch_object</function> is similar to <function>pg_fetch_array</function>, 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 - their offsets (numbers are illegal property names). + their offsets (numbers are illegal property names).</para> <para> The third optional argument <parameter>result_type</parameter> in <function>pg_fetch_object</function> is a constant and can take the following values: PGSQL_ASSOC, PGSQL_NUM, and PGSQL_BOTH. <note> <para> - <parameter>Result_type</parameter> was added in PHP 4.0. - </note> + <parameter>Result_type</parameter> was added in PHP 4.0.</para> + </note></para> <para> Speed-wise, the function is identical to <function>pg_fetch_array</function>, and almost as quick as <function>pg_fetch_row</function> (the difference is - insignificant). + insignificant).</para> <para> See also: <function>pg_fetch_array</function> and <function>pg_fetch_row</function>. <example> <title>Postgres fetch object</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $database = "verlag"; $db_conn = pg_connect ("localhost", "5432", "", "", $database); @@ -394,7 +392,7 @@ pg_close ($db_conn); ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -413,16 +411,16 @@ </funcsynopsis> <para> Returns: An array that corresponds to the fetched row, or false - if there are no more rows. + if there are no more rows.</para> <para> <function>pg_fetch_row</function> 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. + array offset, starting at offset 0.</para> <para> Subsequent call to <function>pg_fetch_row</function> would return the next row in the result set, or false if there are no - more rows. + more rows.</para> <para> See also: <function>pg_fetch_array</function>, <function>pg_fetch_object</function>, @@ -430,7 +428,7 @@ <example> <title>Postgres fetch row</title> - <programlisting role=php> + <programlisting role="php"> &lt;?php $conn = pg_pconnect("","","","","publisher"); if (!$conn) { @@ -454,7 +452,7 @@ echo $row[1] . " <- row\n"; ?> </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -476,7 +474,7 @@ Test if a field is NULL or not. Returns 0 if the field in the given row is not NULL. Returns 1 if the field in the given row is NULL. Field can be specified as number or fieldname. Row - numbering starts at 0. + numbering starts at 0.</para> </refsect1> </refentry> @@ -495,7 +493,7 @@ <para> 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. + Field numbering starts from 0.</para> </refsect1> </refentry> @@ -515,7 +513,7 @@ 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. + return -1 on error.</para> </refsect1> </refentry> @@ -535,7 +533,7 @@ <para> 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. + numbering starts at 0. This function will return -1 on an error.</para> </refsect1> </refentry> @@ -556,7 +554,7 @@ 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 - false on error. + false on error.</para> </refsect1> </refentry> @@ -576,7 +574,7 @@ <para> 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. + numbering starts at 0.</para> </refsect1> </refentry> @@ -598,7 +596,7 @@ script is finished. But, if you are sure you are not going to need the result data anymore in a script, you may call <function>pg_FreeResult</function> with the result identifier as - an argument and the associated result memory will be freed. + an argument and the associated result memory will be freed.</para> </refsect1> </refentry> @@ -620,7 +618,7 @@ and was an SQL INSERT. This function will return a positive integer if there was a valid Oid. It will return -1 if an error occured or the last command sent via <function>pg_Exec</function> - was not an INSERT. + was not an INSERT.</para> </refsect1> </refentry> @@ -637,7 +635,7 @@ </funcsynopsis> <para> pg_Host() will return the host name of the given PostgreSQL - connection identifier is connected to. + connection identifier is connected to.</para> </refsect1> </refentry> @@ -655,7 +653,7 @@ <para> <function>pg_loclose</function> closes an Inversion Large Object. <parameter>fd</parameter> is a file descriptor for the large - object from <function>pg_loopen</function>. + object from <function>pg_loopen</function>.</para> </refsect1> </refentry> @@ -677,7 +675,7 @@ PostgreSQL access modes INV_READ, INV_WRITE, and INV_ARCHIVE are not supported, the object is created always with both read and write access. INV_ARCHIVE has been removed from PostgreSQL itself (version - 6.3 and above). + 6.3 and above).</para> </refsect1> </refentry> @@ -700,7 +698,7 @@ encapsulates information about the connection. Do not close the connection before closing the large object file descriptor. <parameter>objoid</parameter> specifies a valid large object oid - and <parameter>mode</parameter> can be either "r", "w", or "rw". + and <parameter>mode</parameter> can be either "r", "w", or "rw".</para> </refsect1> </refentry> @@ -722,7 +720,7 @@ returns it as a string. <parameter>fd</parameter> specifies a valid large object file descriptor and<parameter>len</parameter> specifies the maximum - allowable size of the large object segment. + allowable size of the large object segment.</para> </refsect1> </refentry> @@ -740,7 +738,7 @@ <para> <function>pg_loreadall</function> 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. + headers. Mainly intended for sending binary data like images or sound.</para> </refsect1> </refentry> @@ -758,7 +756,7 @@ </funcsynopsis> <para> <function>pg_lounlink</function> deletes a large object with the - <parameter>lobjid</parameter> identifier for that large object. + <parameter>lobjid</parameter> identifier for that large object.</para> </refsect1> </refentry> @@ -779,7 +777,7 @@ from a variable <parameter>buf</parameter> and returns the number of bytes actually written, or false in the case of an error. <parameter>fd</parameter> is a file descriptor for the large - object from <function>pg_loopen</function>. + object from <function>pg_loopen</function>.</para> </refsect1> </refentry> @@ -798,7 +796,7 @@ pg_NumFields() will return the number of fields (columns) in a PostgreSQL result. The argument is a valid result identifier returned by <function>pg_Exec</function>. This function will - return -1 on error. + return -1 on error.</para> </refsect1> </refentry> @@ -817,7 +815,7 @@ <function>pg_NumRows</function> will return the number of rows in a PostgreSQL result. The argument is a valid result identifier returned by <function>pg_Exec</function>. This function will - return -1 on error. + return -1 on error.</para> </refsect1> </refentry> @@ -834,7 +832,7 @@ </funcsynopsis> <para> pg_Options() will return a string containing the options - specified on the given PostgreSQL connection identifier. + specified on the given PostgreSQL connection identifier.</para> </refsect1> </refentry> @@ -861,14 +859,14 @@ optional and can be left out. This function returns a connection index that is needed by other PostgreSQL functions. You can have multiple persistent connections open at once. See also - <function>pg_Connect</function>. + <function>pg_Connect</function>.</para> <para> A connection can also established with the following command: <command>$conn = pg_pconnect("dbname=marliese port=5432");</command> Other parameters besides <parameter>dbname</parameter> and <parameter>port</parameter> are <parameter>host</parameter>, <parameter>tty</parameter>, <parameter>options</parameter>, - <parameter>user</parameter> and <parameter>password</parameter>. + <parameter>user</parameter> and <parameter>password</parameter>.</para> </refsect1> </refentry> @@ -886,7 +884,7 @@ </funcsynopsis> <para> pg_Port() will return the port number that the given PostgreSQL - connection identifier is connected to. + connection identifier is connected to.</para> </refsect1> </refentry> @@ -910,7 +908,7 @@ <parameter>fieldname</parameter> sepcify what cell in the table of results to return. Row numbering starts from 0. Instead of naming the field, you may use the field index as an unquoted - number. Field indices start from 0. + number. Field indices start from 0.</para> <para> PostgreSQL has many built in types and only the basic ones are directly supported here. All forms of integer, boolean and oid @@ -918,7 +916,7 @@ real types are returned as double values. All other types, including arrays are returned as strings formatted in the same default PostgreSQL manner that you would see in the - <command>psql</command> program. + <command>psql</command> program.</para> </refsect1> </refentry> @@ -935,7 +933,7 @@ </funcsynopsis> <para> pg_tty() will return the tty name that server side debugging - output is sent to on the given PostgreSQL connection identifier. + output is sent to on the given PostgreSQL connection identifier.</para> </refsect1> </refentry> Index: phpdoc/functions/posix.sgml diff -u phpdoc/functions/posix.sgml:1.3 phpdoc/functions/posix.sgml:1.4 --- phpdoc/functions/posix.sgml:1.3 Tue Sep 14 12:58:30 1999 +++ phpdoc/functions/posix.sgml Wed Oct 20 18:41:42 1999 @@ -1,5 +1,3 @@ - <!-- $Id: posix.sgml,v 1.3 1999/09/14 16:58:30 kk Exp $ --> - <reference id="ref.posix"> <title>POSIX functions</title> <titleabbrev>POSIX</titleabbrev> @@ -21,17 +19,17 @@ <funcsynopsis> <funcdef>bool <function>posix_kill</function></funcdef> <paramdef>int <parameter>pid</parameter></paramdef> - <paramdef>int <parameter>sig</parameter</paramdef> + <paramdef>int <parameter>sig</parameter></paramdef> </funcsynopsis> <para> Send the signal <parameter>sig</parameter> to the process with the process identifier <parameter>pid</parameter>. - Returns FALSE, if unable to send the signal, TRUE otherwise. + Returns FALSE, if unable to send the signal, TRUE otherwise.</para> <para> See also the kill(2) manual page of your POSIX system, which contains additional information about negative process identifiers, the special pid 0, the special pid -1, and the - signal number 0. + signal number 0.</para> </refsect1> </refentry> @@ -47,7 +45,7 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Return the process identifier of the current process. + Return the process identifier of the current process.</para> </refsect1> </refentry> @@ -64,7 +62,7 @@ </funcsynopsis> <para> Return the process identifier of parent process of the current - process. + process.</para> </refsect1> </refentry> @@ -84,7 +82,7 @@ <para> Return the numeric real user ID of the current process. See also <function>posix_getpwuid</function> for information on how to - convert this into a useable username. + convert this into a useable username.</para> </refsect1> </refentry> @@ -104,7 +102,7 @@ <para> Return the numeric effective user ID of the current process. See also <function>posix_getpwuid</function> for information on how - to convert this into a useable username. + to convert this into a useable username.</para> </refsect1> </refentry> @@ -124,7 +122,7 @@ <para> Return the numeric real group ID of the current process. See also <function>posix_getgrgid</function> for information on how to - convert this into a useable group name. + convert this into a useable group name.</para> </refsect1> </refentry> @@ -144,7 +142,7 @@ <para> Return the numeric effective group ID of the current process. See also <function>posix_getgrgid</function> for information on how - to convert this into a useable group name. + to convert this into a useable group name.</para> </refsect1> </refentry> @@ -164,10 +162,10 @@ <para> Set the real user ID of the current process. This is a privileged function and you need appropriate privileges (usually root) on - your system to be able to perform this function. + your system to be able to perform this function.</para> <para> Returns TRUE on success, FALSE otherwise. See also - <function>posix_setgid</function>. + <function>posix_setgid</function>.</para> </refsect1> </refentry> @@ -190,9 +188,9 @@ root) on your system to be able to perform this function. The appropriate order of function calls is <function>posix_setgid</function> first, - <function>posix_setuid</function> last. + <function>posix_setuid</function> last.</para> <para> - Returns TRUE on success, FALSE otherwise. + Returns TRUE on success, FALSE otherwise.</para> </refsect1> </refentry> @@ -213,7 +211,7 @@ Returns an array of integers containing the numeric group ids of the group set of the current process. See also <function>posix_getgrgid</function> for information on how to - convert this into useable group names. + convert this into useable group names.</para> </refsect1> </refentry> @@ -231,7 +229,7 @@ <para> Returns the login name of the user owning the current process. See <function>posix_getpwnam</function> for information how to - get more information about this user. + get more information about this user.</para> </refsect1> </refentry> @@ -251,7 +249,7 @@ <para> Return the process group identifier of the current process. See POSIX.1 and the getpgrp(2) manual page on your POSIX system for - more information on process groups. + more information on process groups.</para> </refsect1> </refentry> @@ -270,7 +268,7 @@ Make the current process a session leader. See POSIX.1 and the setsid(2) manual page on your POSIX system for more informations on process groups and job control. Returns - the session id. + the session id.</para> </refsect1> </refentry> @@ -291,7 +289,7 @@ group <parameter>pgid</parameter>. See POSIX.1 and the setsid(2) manual page on your POSIX system for more informations on process groups and job control. Returns - TRUE on success, FALSE otherwise. + TRUE on success, FALSE otherwise.</para> </refsect1> </refentry> @@ -308,11 +306,11 @@ </funcsynopsis> <para> Returns the process group identifier of the process - <parameter>pid</parameter>. + <parameter>pid</parameter>.</para> <para> This is not a POSIX function, but is common on BSD and System V systems. If your system does not support this function at system - level, this PHP function will always return FALSE. + level, this PHP function will always return FALSE.</para> </refsect1> </refentry> @@ -330,11 +328,11 @@ <para> Return the sid of the process <parameter>pid</parameter>. If <parameter>pid</parameter> is 0, the sid of the - current process is returned. + current process is returned.</para> <para> This is not a POSIX function, but is common on System V systems. If your system does not support this function at system - level, this PHP function will always return FALSE. + level, this PHP function will always return FALSE.</para> </refsect1> </refentry> @@ -369,11 +367,11 @@ <listitem><simpara> machine - system architecture (e.g. i586) </simpara></listitem> - </itemizedlist> + </itemizedlist></para> <para> Posix requires that you must not make any assumptions about the format of the values, e.g. you cannot rely on three digit version - numbers or anything else returned by this function. + numbers or anything else returned by this function.</para> </refsect1> </refentry> @@ -408,7 +406,7 @@ <listitem><simpara> cstime - system time used by current process and children. </simpara></listitem> - </itemizedlist> + </itemizedlist></para> </refsect1> </refentry> @@ -424,7 +422,7 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written.</para> </refsect1> </refentry> @@ -440,7 +438,7 @@ <paramdef>int <parameter>fd</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written.</para> </refsect1> </refentry> @@ -458,7 +456,7 @@ <paramdef>int <parameter>fd</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written.</para> </refsect1> </refentry> @@ -474,7 +472,7 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Needs to be written ASAP. + Needs to be written ASAP.</para> </refsect1> </refentry> @@ -493,7 +491,7 @@ <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Needs to be written ASAP.. + Needs to be written ASAP..</para> </refsect1> </refentry> @@ -509,7 +507,7 @@ <paramdef>string <parameter>name</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written.</para> </refsect1> </refentry> @@ -525,7 +523,7 @@ <paramdef>int <parameter>gid</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written.</para> </refsect1> </refentry> @@ -541,7 +539,7 @@ <paramdef>string <parameter>name</parameter></paramdef> </funcsynopsis> <para> - Needs to be written ASAP. + Needs to be written ASAP.</para> </refsect1> </refentry> @@ -557,7 +555,7 @@ <paramdef>int <parameter>uid</parameter></paramdef> </funcsynopsis> <para> - Needs to be written ASAP. + Needs to be written ASAP.</para> </refsect1> </refentry> @@ -573,7 +571,7 @@ <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Needs to be written ASAP. + Needs to be written ASAP.</para> </refsect1> </refentry> Index: phpdoc/functions/regex.sgml diff -u phpdoc/functions/regex.sgml:1.3 phpdoc/functions/regex.sgml:1.4 --- phpdoc/functions/regex.sgml:1.3 Mon Jun 21 18:12:43 1999 +++ phpdoc/functions/regex.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.regex"> <title>Regular expression functions</title> <titleabbrev>Regexps</titleabbrev> @@ -9,19 +8,19 @@ <itemizedlist> <listitem> - <simpara><function>ereg</function> + <simpara><function>ereg</function></simpara> </listitem> <listitem> - <simpara><function>ereg_replace</function> + <simpara><function>ereg_replace</function></simpara> </listitem> <listitem> - <simpara><function>eregi</function> + <simpara><function>eregi</function></simpara> </listitem> <listitem> - <simpara><function>eregi_replace</function> + <simpara><function>eregi_replace</function></simpara> </listitem> <listitem> - <simpara><function>split</function> + <simpara><function>split</function></simpara> </listitem> </itemizedlist> @@ -31,7 +30,7 @@ regular expressions see the regex man pages included in the regex directory in the PHP distribution. - <!-- Should add discussion of PCRE functions here. --> + <!-- Should add discussion of PCRE functions here. --></para> <para> <example> @@ -68,7 +67,7 @@ /* Get rid of any carriage return characters in $string. */ </programlisting> - </example> + </example></para> </partintro> @@ -87,7 +86,7 @@ </funcsynopsis> <simpara> Searchs <parameter>string</parameter> for matches to the regular expression - given in <parameter>pattern</parameter>. + given in <parameter>pattern</parameter>.</simpara> <simpara> If matches are found for parenthesized substrings of @@ -97,14 +96,14 @@ <parameter>regs</parameter>. $regs[1] will contain the substring which starts at the first left parenthesis; $regs[2] will contain the substring starting at the second, and so on. $regs[0] will - contain a copy of <parameter>string</parameter>. + contain a copy of <parameter>string</parameter>.</simpara> <para> - Searching is case sensitive. + Searching is case sensitive.</para> <para> Returns true if a match for pattern was found in string, or false - if no matches were found or an error occurred. + if no matches were found or an error occurred.</para> <para> The following code snippet takes a date in ISO format (YYYY-MM-DD) @@ -117,10 +116,10 @@ } else { echo "Invalid date format: $date"; } -</programlisting></example> +</programlisting></example></para> <para> - See also <function>eregi</function>, <function>ereg_replace</function>, and <function>eregi_replace</function>. + See also <function>eregi</function>, <function>ereg_replace</function>, and <function>eregi_replace</function>.</para> </refsect1> </refentry> @@ -142,12 +141,12 @@ <para> This function scans <parameter>string</parameter> for matches to <parameter>pattern</parameter>, then replaces the matched text - with <parameter>replacement</parameter>. + with <parameter>replacement</parameter>.</para> <para> The modified string is returned. (Which may mean that the original string is returned if there are no matches to be - replaced.) + replaced.)</para> <para> If <parameter>pattern</parameter> contains parenthesized @@ -158,11 +157,11 @@ substring; <literal>\\0</literal> will produce the entire contents of string. Up to nine substrings may be used. Parentheses may be nested, in which case they are counted by the - opening parenthesis. + opening parenthesis.</para> <para> If no matches are found in <parameter>string</parameter>, then - <parameter>string</parameter> will be returned unchanged. + <parameter>string</parameter> will be returned unchanged.</para> <para> For example, the following code snippet @@ -175,11 +174,11 @@ echo ereg_replace( "( )is", "\\1was", $string ); echo ereg_replace( "(( )is)", "\\2was", $string ); </programlisting> - </example> + </example></para> <para> See also <function>ereg</function>, <function>eregi</function>, - and <function>eregi_replace</function>. + and <function>eregi_replace</function>.</para> </refsect1> </refentry> @@ -199,10 +198,10 @@ </funcsynopsis> <para> This function is identical to <function>ereg</function> save that this ignores - case distinction when matching alphabetic characters. + case distinction when matching alphabetic characters.</para> <para> - See also <function>ereg</function>, <function>ereg_replace</function>, and <function>eregi_replace</function>. + See also <function>ereg</function>, <function>ereg_replace</function>, and <function>eregi_replace</function>.</para> </refsect1> </refentry> @@ -223,10 +222,10 @@ </funcsynopsis> <para> This function is identical to <function>ereg_replace</function> save that - this ignores case distinction when matching alphabetic characters. + this ignores case distinction when matching alphabetic characters.</para> <para> - See also <function>ereg</function>, <function>eregi</function>, and <function>ereg_replace</function>. + See also <function>ereg</function>, <function>eregi</function>, and <function>ereg_replace</function>.</para> </refsect1> </refentry> @@ -248,7 +247,7 @@ <para> Returns an array of strings, each of which is a substring of string formed by splitting it on boundaries formed - by <parameter>pattern</parameter>. If an error occurs, returns false. + by <parameter>pattern</parameter>. If an error occurs, returns false.</para> <para> To get the first five fields from a line from @@ -257,11 +256,11 @@ <title>split() example</title> <programlisting> $passwd_list = split( ":", $passwd_line, 5 ); -</programlisting></example> +</programlisting></example></para> <para> - Note that <parameter>pattern</parameter> is case-sensitive. + Note that <parameter>pattern</parameter> is case-sensitive.</para> <para> - See also: <function>explode</function> and <function>implode</function>. + See also: <function>explode</function> and <function>implode</function>.</para> </refsect1> </refentry> @@ -291,11 +290,11 @@ echo sql_regcase( "Foo bar" ); </programlisting></example> - prints <screen>[Ff][Oo][Oo][ ][Bb][Aa][Rr]</screen>. + prints <screen>[Ff][Oo][Oo][ ][Bb][Aa][Rr]</screen>.</para> <para> This can be used to achieve case insensitive pattern matching in - products which support only case sensitive regular expressions. + products which support only case sensitive regular expressions.</para> </refsect1> </refentry> Index: phpdoc/functions/sem.sgml diff -u phpdoc/functions/sem.sgml:1.3 phpdoc/functions/sem.sgml:1.4 --- phpdoc/functions/sem.sgml:1.3 Sat Jul 31 20:37:07 1999 +++ phpdoc/functions/sem.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.sem"> <title>Semaphore and shared memory functions</title> <titleabbrev>Semaphore</titleabbrev> @@ -7,7 +6,7 @@ This module provides semaphore functions using System V semaphores. Semaphores may be used to provide exclusive access to resources on the current machine, or to limit the number of processes that - may simultaneously use a resource. + may simultaneously use a resource.</para> <para> This module provides also shared memory functions using System V shared memory. Shared memory may be used to provide access to @@ -41,7 +40,7 @@ </row> </tbody> </tgroup> - </table> + </table></para> </partintro> @@ -62,7 +61,7 @@ </funcsynopsis> <para> Returns: A positive semaphore identifier on success, or false on - error. + error.</para> <para> <function>sem_get</function> returns an id that can be used to access the System V semaphore with the given key. The semaphore @@ -70,14 +69,14 @@ perm (defaults to 0666). The number of processes that can acquire the semaphore simultaneously is set to max_acquire (defaults to 1). Actually this value is set only if the process - finds it is the only process currently attached to the semaphore. + finds it is the only process currently attached to the semaphore.</para> <para> A second call to <function>sem_get</function> for the same key will return a different semaphore identifier, but both - identifiers access the same underlying semaphore. + identifiers access the same underlying semaphore.</para> <para> See also: <function>sem_acquire</function> and - <function>sem_release</function>. + <function>sem_release</function>.</para> </refsect1> </refentry> @@ -93,20 +92,20 @@ <paramdef>int <parameter>sem_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns: true on success, false on error + Returns: true on success, false on error</para> <para> <function>sem_acquire</function> 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 - be exceeded. + be exceeded.</para> <para> After processing a request, any semaphores acquired by the process but not explicitly released will be released automatically - and a warning will be generated. + and a warning will be generated.</para> <para> See also: <function>sem_get</function> and - <function>sem_release</function>. + <function>sem_release</function>.</para> </refsect1> </refentry> @@ -122,17 +121,17 @@ <paramdef>int <parameter>sem_identifier</parameter></paramdef> </funcsynopsis> <para> - Returns: true on success, false on error + Returns: true on success, false on error</para> <para> <function>sem_release</function> releases the semaphore if it is currently acquired by the calling process, otherwise - a warning is generated. + a warning is generated.</para> <para> After releasing the semaphore, <function>sem_acquire</function> - may be called to re-acquire it. + may be called to re-acquire it.</para> <para> See also: <function>sem_get</function> and - <function>sem_acquire</function>. + <function>sem_acquire</function>.</para> </refsect1> </refentry> @@ -155,15 +154,14 @@ <function>shm_attach</function> 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 <link - linkend="configuration.file">configuration file</link>, otherwise - 10000 bytes) and the optional perm-bits (default: 0666). + segment with mem_size (default: sysvshm.init_mem in the <link linkend="configuration.file">configuration file</link>, otherwise + 10000 bytes) and the optional perm-bits (default: 0666).</para> <para> A second call to <function>shm_attach</function> for the same <parameter>key</parameter> will return a different shared memory identifier, but both identifiers access the same underlying shared memory. <parameter>memsize</parameter> and - <parameter>perm</parameter> will be ignored. + <parameter>perm</parameter> will be ignored.</para> </refsect1> </refentry> @@ -182,7 +180,7 @@ <function>shm_detach</function> disconnects from the shared memory given by the <parameter>shm_identifier</parameter> created by <function>shm_attach</function>. Remember, that shared memory - still exist in the Unix system and the data is still present. + still exist in the Unix system and the data is still present.</para> </refsect1> </refentry> @@ -199,7 +197,7 @@ </funcsynopsis> <para> Removes shared memory from Unix systems. All data will be - destroyed. + destroyed.</para> </refsect1> </refentry> @@ -220,7 +218,7 @@ <para> Inserts or updates a <parameter>variable</parameter> with a given <parameter>variable_key</parameter>. All variable-types (double, - int, string, array) are supported. + int, string, array) are supported.</para> </refsect1> </refentry> @@ -240,7 +238,7 @@ <para> <function>shm_get_var</function> returns the variable with a given <parameter>variable_key</parameter>. The variable is still present - in the shared memory. + in the shared memory.</para> </refsect1> </refentry> @@ -259,10 +257,11 @@ </funcsynopsis> <para> Removes a variable with a given <parameter>variable_key</parameter> - and frees the occupied memory. + and frees the occupied memory.</para> </refsect1> </refentry> +</reference> <!-- Keep this comment at the end of the file Local variables: Index: phpdoc/functions/session.sgml diff -u phpdoc/functions/session.sgml:1.7 phpdoc/functions/session.sgml:1.8 --- phpdoc/functions/session.sgml:1.7 Tue Sep 21 04:55:27 1999 +++ phpdoc/functions/session.sgml Wed Oct 20 18:41:42 1999 @@ -5,12 +5,12 @@ <para> Session support in PHP consists of a way to preserve certain data across subsequent accesses. This enables you to build more customized - applications and increase the appeal of your web site. + applications and increase the appeal of your web site.</para> <para> A visitor accessing your web site is assigned an unique id, the so-called session id. This is either stored in a cookie on the user side or is - propagated in the URL. + propagated in the URL.</para> <para> The session support allows you to register arbitrary numbers of variables to @@ -19,28 +19,28 @@ (explicitly through <function>session_start</function> or implicitly through <function>session_register</function>) whether a specific session id has been sent with the request. If this is the case, the prior - saved environment is recreated. + saved environment is recreated.</para> <para> All registered variables are serialized after the request finishes. Registered variables which are undefined are marked as being not defined. On subsequent accesses, these are not defined by the session module unless - the user defines them later. + the user defines them later.</para> <para> There are two methods to propagate a session id: <itemizedlist> <listitem><simpara> - Cookies + Cookies</simpara></listitem> <listitem><simpara> - URL parameter - </itemizedlist> + URL parameter</simpara></listitem> + </itemizedlist></para> <para> The session module supports both methods. Cookies are optimal, but since they are not reliable (clients are not bound to accept them), we cannot - rely on them. The second method embeds the session id directly into URLs. + rely on them. The second method embeds the session id directly into URLs.</para> <para> PHP is capable of doing this transparently when compiled with @@ -49,7 +49,7 @@ Alternatively, you can use the constant <literal>SID</literal> which is defined, if the client did not send the appropiate cookie. <literal>SID</literal> is either of the form - <literal>session_name=session_id</literal> or is an empty string. + <literal>session_name=session_id</literal> or is an empty string.</para> <para> The following example demonstrates how to register a variable, and how to @@ -74,11 +74,11 @@ ?&gt; To continue, &lt;A HREF="nextpage.php?&lt;?=SID?&gt;"&gt;click here&lt;/A&gt; -</programlisting></example> +</programlisting></example></para> <para> The <literal>&lt;?=SID?&gt;</literal> is not necessary, if - <literal>--enable-trans-sid</literal> was used to compile PHP. + <literal>--enable-trans-sid</literal> was used to compile PHP.</para> <para> The session management system supports a number of configuration options @@ -88,28 +88,28 @@ <listitem><simpara> <literal>session.save_handler</literal> defines the name of the handler which is used for storing and retrieving data associated with a session. - Defaults to <literal>files</literal>. + Defaults to <literal>files</literal>.</simpara></listitem> <listitem><simpara> <literal>session.save_path</literal> defines the argument which is passed to the save handler. If you choose the default files handler, this is the path where the files are created. Defaults to - <literal>/tmp</literal>. + <literal>/tmp</literal>.</simpara></listitem> <listitem><simpara> <literal>session.name</literal> specifies the name of the session which is used as cookie name. It should only contain alphanumeric characters. - Defaults to <literal>PHPSESSID</literal>. + Defaults to <literal>PHPSESSID</literal>.</simpara></listitem> <listitem><simpara> <literal>session.auto_start</literal> specifies whether the session module start a session automatically on request startup. Defaults to - <literal>0</literal> (disabled). + <literal>0</literal> (disabled).</simpara></listitem> <listitem><simpara> <literal>session.lifetime</literal> specifies the lifetime of the cookie in seconds which is sent to the browser. The value 0 means "until the - browser is closed." Defaults to <literal>0</literal>. + browser is closed." Defaults to <literal>0</literal>.</simpara></listitem> <listitem><simpara> <literal>session.serialize_handler</literal> defines the name of the @@ -117,42 +117,42 @@ internal format (name <literal>php</literal>) and WDDX is supported (name <literal>wddx</literal>). WDDX is only available, if PHP is compiled with <link linkend="ref.wddx">WDDX support</link>. Defaults to - <literal>php</literal>. + <literal>php</literal>.</simpara></listitem> <listitem><simpara> <literal>session.gc_probability</literal> specifies the probability that the gc (garbage collection) routine is started on each request in - percent. Defaults to <literal>1</literal>. + percent. Defaults to <literal>1</literal>.</simpara></listitem> <listitem><simpara> <literal>session.gc_maxlifetime</literal> specifies the number of - seconds after which data will be seen as 'garbage' and cleaned up. + seconds after which data will be seen as 'garbage' and cleaned up.</simpara></listitem> <listitem><simpara> <literal>session.extern_referer_check</literal> determines whether session ids referred to by external sites will be eliminated. If session ids are propagated using the URL method, users not knowing about the impact might publish session ids. This can lead to security problems - which this check tries to defeat. Defaults to <literal>0</literal>. + which this check tries to defeat. Defaults to <literal>0</literal>.</simpara></listitem> <listitem><simpara> <literal>session.entropy_file</literal> gives a path to an external resource (file) which will be used as an additional entropy source in the session id creation process. Examples are <literal>/dev/random</literal> or <literal>/dev/urandom</literal> which are available on many Unix - systems. + systems.</simpara></listitem> <listitem><simpara> <literal>session.entropy_length</literal> specifies the number of bytes which will be read from the file specified above. Defaults to - <literal>0</literal> (disabled). + <literal>0</literal> (disabled).</simpara></listitem> </itemizedlist> <note> <para> - Session handling was added in PHP 4.0. - </note> + Session handling was added in PHP 4.0.</para> + </note></para> </partintro> <refentry id="function.session-start"> @@ -169,12 +169,12 @@ <simpara> <function>session_start</function> creates a session (or resumes the current one based on the session id being passed via a GET - variable or a cookie). + variable or a cookie).</simpara> <simpara> - This function always returns true. + This function always returns true.</simpara> <note> <para> - This function was added in PHP 4.0. + This function was added in PHP 4.0.</para> </note> </refsect1> </refentry> @@ -192,12 +192,12 @@ </funcsynopsis> <simpara> <function>session_destroy</function> destroys all of the data - associated with the current session. + associated with the current session.</simpara> <simpara> - This function always returns true. + This function always returns true.</simpara> <note> <para> - This function was added in PHP 4.0. + This function was added in PHP 4.0.</para> </note> </refsect1> </refentry> @@ -231,8 +231,8 @@ </example> <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -253,8 +253,8 @@ module will be used instead. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -278,12 +278,12 @@ On some operating systems, you may want to specify a path on a filesystem that handles lots of small files efficiently. For example, on Linux, reiserfs may provide better performance than - ext2fs. + ext2fs.</para> </note> <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -301,18 +301,18 @@ <para> <function>session_id</function> returns the session id for the current session. If <parameter>id</parameter> is specified, it will replace - the current session id. + the current session id.</para> <para> directory used to save session data. If <parameter>path</parameter> - is specified, the path to which data is saved will be changed. + is specified, the path to which data is saved will be changed.</para> <para> The constant <systemitem>SID</systemitem> can also be used to retrieve the current name and session id as a string suitable for adding to URLs. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -329,14 +329,14 @@ </funcsynopsis> <para> <function>session_register</function> registers the global variable - named <parameter>name</parameter> with the current session. + named <parameter>name</parameter> with the current session.</para> <para> This function returns true when the variable is successfully registered with the session. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -354,14 +354,14 @@ <para> <function>session_unregister</function> unregisters (forgets) the global variable named <parameter>name</parameter> from the - current session. + current session.</para> <para> This function returns true when the variable is successfully unregistered from the session. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -382,8 +382,8 @@ in the current session. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -404,8 +404,8 @@ session. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -425,8 +425,8 @@ contents of the current session encoded within. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> Index: phpdoc/functions/snmp.sgml diff -u phpdoc/functions/snmp.sgml:1.4 phpdoc/functions/snmp.sgml:1.5 --- phpdoc/functions/snmp.sgml:1.4 Tue Jul 13 16:41:26 1999 +++ phpdoc/functions/snmp.sgml Wed Oct 20 18:41:42 1999 @@ -4,15 +4,14 @@ <partintro> <simpara> - In order to use the SNMP functions on Unix you need to install the <ulink - url="&url.ucd-snmp;">UCD SNMP</ulink> package. On Windows these functions - are only available on NT and not on Win95/98. + In order to use the SNMP functions on Unix you need to install the <ulink url="&url.ucd-snmp;">UCD SNMP</ulink> package. On Windows these functions + are only available on NT and not on Win95/98.</simpara> <simpara> Important: In order to use the UCD SNMP package, you need to define NO_ZEROLENGTH_COMMUNITY to 1 before compiling it. After configuring UCD SNMP, edit config.h and search for NO_ZEROLENGTH_COMMUNITY. Uncomment the - #define line. It should look like this afterwards: + #define line. It should look like this afterwards:</simpara> <para> <programlisting> @@ -24,7 +23,7 @@ If you see strange segmentation faults in combination with SNMP commands, you did not follow the above instructions. If you do not want to recompile UCD SNMP, you can compile PHP with the --enable-ucd-snmp-hack switch which - will work around the misfeature. + will work around the misfeature.</simpara> </partintro> @@ -45,21 +44,21 @@ </funcsynopsis> <para> - Returns SNMP object value on success and false on error. + Returns SNMP object value on success and false on error.</para> <para> The <function>snmpget</function> function is used to read the value of an SNMP object specified by the <parameter>object_id</parameter>. SNMP agent is specified by the <parameter>hostname</parameter> and the read community is - specified by the <parameter>community</parameter> parameter. + specified by the <parameter>community</parameter> parameter.</para> <para> <informalexample> <literallayout> $syscontact = snmpget("127.0.0.1", "public", "system.SysContact.0") </literallayout> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -84,14 +83,14 @@ <para> Sets the specified SNMP object value, returning true on success - and false on error. + and false on error.</para> <para> The <function>snmpset</function> function is used to set the value of an SNMP object specified by the <parameter>object_id</parameter>. SNMP agent is specified by the <parameter>hostname</parameter> and the read community is specified - by the <parameter>community</parameter> parameter. + by the <parameter>community</parameter> parameter.</para> </refsect1> </refentry> @@ -116,7 +115,7 @@ <para> Returns an array of SNMP object values starting from the - <function>object_id</function> as root and false on error. + <function>object_id</function> as root and false on error.</para> <para> <function>snmpwalk</function> function is used to read all the @@ -133,7 +132,7 @@ <programlisting role="php"> $a = snmpwalk("127.0.0.1", "public", ""); </programlisting> - </informalexample> + </informalexample></para> <para> Above function call would return all the SNMP objects from the @@ -146,7 +145,7 @@ echo $a[$i]; } </programlisting> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -174,7 +173,7 @@ <para> Returns an associative array with object ids and their respective object value starting from the <parameter>object_id</parameter> - as root and false on error. + as root and false on error.</para> <para> <function>snmpwalkoid</function> function is used to read all @@ -185,7 +184,7 @@ objects tree and all objects under that tree are returned as an array. If <parameter>object_id</parameter> is specified, all the SNMP objects below that <parameter>object_id</parameter> are - returned. + returned.</para> <para> The existence of <function>snmpwalkoid</function> and @@ -196,7 +195,7 @@ <programlisting role="php"> $a = snmpwalkoid("127.0.0.1", "public", ""); </programlisting> - </informalexample> + </informalexample></para> <para> Above function call would return all the SNMP objects from the @@ -209,7 +208,7 @@ echo "$i: $a[$i]&lt;br>\n"; } </programlisting> - </informalexample> + </informalexample></para> </refsect1> </refentry> @@ -236,21 +235,21 @@ <programlisting role="php"> $quickprint = snmp_get_quick_print(); </programlisting> - </informalexample> + </informalexample></para> <para> Above function call would return <systemitem>false</systemitem> if quick_print is on, and <systemitem>true</systemitem> if quick_print - is on. + is on.</para> <para> <function>snmp_get_quick_print</function> is only available when using the UCD SNMP library. This function is not available when using the - Windows SNMP library. + Windows SNMP library.</para> <para> See: <function>snmp_set_quick_print</function> for a full description - of what quick_print does. + of what quick_print does.</para> </refsect1> </refentry> @@ -275,7 +274,7 @@ enabled (default) the UCD SNMP library prints extra information including the type of the value (i.e. IpAddress or OID). Additionally, if quick_print is not enabled, the library prints additional hex values - for all strings of three characters or less. + for all strings of three characters or less.</para> <para> Setting quick_print is often used when using the information returned @@ -290,24 +289,24 @@ $a = snmpget("127.0.0.1", "public", ".1.3.6.1.2.1.2.2.1.9.1"); echo "$a&lt;BR>\n"; </programlisting> - </informalexample> + </informalexample></para> <para> The first value printed might be: 'Timeticks: (0) 0:00:00.00', whereas - with quick_print enabled, just '0:00:00.00' would be printed. + with quick_print enabled, just '0:00:00.00' would be printed.</para> <para> By default the UCD SNMP library returns verbose values, quick_print is - used to return only the value. + used to return only the value.</para> <para> Currently strings are still returned with extra quotes, this will be - corrected in a later release. + corrected in a later release.</para> <para> <function>snmp_set_quick_print</function> is only available when using the UCD SNMP library. This function is not available when using - the Windows SNMP library. + the Windows SNMP library.</para> </refsect1> </refentry> Index: phpdoc/functions/solid.sgml diff -u phpdoc/functions/solid.sgml:1.2 phpdoc/functions/solid.sgml:1.3 --- phpdoc/functions/solid.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/solid.sgml Wed Oct 20 18:41:42 1999 @@ -1,11 +1,10 @@ - <reference id="ref.solid"> <title>Solid functions</title> <titleabbrev>Solid</titleabbrev> <partintro> <para> The Solid functions are deprecated, you probably want to use the - <link linkend="ref.odbc">Unified ODBC functions</link> instead. + <link linkend="ref.odbc">Unified ODBC functions</link> instead.</para> </partintro> <refentry id="function.solid-close"> @@ -15,7 +14,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_close</function>. + <para>See <function>odbc_close</function>.</para> </refsect1> </refentry> @@ -27,7 +26,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_connect</function>. + <para>See <function>odbc_connect</function>.</para> </refsect1> </refentry> @@ -39,7 +38,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_exec</function>. + <para>See <function>odbc_exec</function>.</para> </refsect1> </refentry> @@ -51,7 +50,7 @@ </refnamediv> <refsect1> <title>Descriptio</title> - <para>See <function>odbc_fetch_row</function> + <para>See <function>odbc_fetch_row</function></para> </refsect1> </refentry> @@ -63,7 +62,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_field_name</function>. + <para>See <function>odbc_field_name</function>.</para> </refsect1> </refentry> @@ -75,7 +74,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_field_num</function>. + <para>See <function>odbc_field_num</function>.</para> </refsect1> </refentry> @@ -87,7 +86,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_free_result</function>. + <para>See <function>odbc_free_result</function>.</para> </refsect1> </refentry> @@ -99,7 +98,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_num_fields</function>. + <para>See <function>odbc_num_fields</function>.</para> </refsect1> </refentry> @@ -111,7 +110,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_num_rows</function>. + <para>See <function>odbc_num_rows</function>.</para> </refsect1> </refentry> @@ -123,7 +122,7 @@ </refnamediv> <refsect1> <title>Description</title> - <para>See <function>odbc_result</function>. + <para>See <function>odbc_result</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/strings.sgml diff -u phpdoc/functions/strings.sgml:1.17 phpdoc/functions/strings.sgml:1.18 --- phpdoc/functions/strings.sgml:1.17 Mon Oct 18 15:41:58 1999 +++ phpdoc/functions/strings.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.strings"> <title>String functions</title> <titleabbrev>Strings</titleabbrev> @@ -6,7 +5,7 @@ <simpara> These functions all manipulate strings in various ways. Some more specialized sections can be found in the regular expression and - URL handling sections. + URL handling sections.</simpara> </partintro> <refentry id="function.addcslashes"> @@ -38,15 +37,15 @@ <note> <simpara> - Added in PHP4b3-dev. - </note> + Added in PHP4b3-dev.</simpara> + </note></para> <para> See also <function>stripcslashes</function>, <function>stripslashes</function>, <function>htmlspecialchars</function>, <function>htmlspecialchars</function>, and - <function>quotemeta</function>. + <function>quotemeta</function>.</para> </refsect1> </refentry> @@ -67,12 +66,12 @@ to be quoted in database queries etc. These characters are single quote (<literal>'</literal>), double quote (<literal>"</literal>), backslash (<literal>\</literal>) - and NUL (the null byte). + and NUL (the null byte).</para> <para> See also <function>stripslashes</function>, <function>htmlspecialchars</function>, and - <function>quotemeta</function>. + <function>quotemeta</function>.</para> </refsect1> </refentry> @@ -93,7 +92,7 @@ <para> Returns an ASCII string containing the hexadecimal representation of <parameter>str</parameter>. The conversion is done byte-wise - with the high-nibble first. + with the high-nibble first.</para> </refsect1> </refentry> @@ -115,9 +114,9 @@ <title>chop() example</title> <programlisting> $trimmed = Chop($line); -</programlisting></example> +</programlisting></example></para> <para> - See also <function>trim</function>. + See also <function>trim</function>.</para> </refsect1> </refentry> @@ -147,7 +146,7 @@ This function complements <function>ord</function>. See also <function>sprintf</function> with a format string of - <literal>%c</literal>. + <literal>%c</literal>.</para> </refsect1> </refentry> @@ -169,8 +168,7 @@ </funcsynopsis> <para> Can be used to split a string into smaller chunks which is useful - for e.g. converting <link - linkend="function.base64-encode">base64_encode</link> output to + for e.g. converting <link linkend="function.base64-encode">base64_encode</link> output to match RFC 2045 semantics. It inserts every <parameter>chunklen</parameter> (defaults to 76) chars the string <parameter>end</parameter> (defaults to "\r\n"). It returns the @@ -189,8 +187,8 @@ <note> <para> - This function was added in 3.0.6. - </note> + This function was added in 3.0.6.</para> + </note></para> </refsect1> </refentry> @@ -217,18 +215,18 @@ supported types are: <itemizedlist> <listitem><simpara> - k - koi8-r + k - koi8-r</simpara></listitem> <listitem><simpara> - w - windows-1251 + w - windows-1251</simpara></listitem> <listitem><simpara> - i - iso8859-5 + i - iso8859-5</simpara></listitem> <listitem><simpara> - a - x-cp866 + a - x-cp866</simpara></listitem> <listitem><simpara> - d - x-cp866 + d - x-cp866</simpara></listitem> <listitem><simpara> - m - x-mac-cyrillic - </itemizedlist> + m - x-mac-cyrillic</simpara></listitem> + </itemizedlist></para> </refsect1> </refentry> @@ -252,10 +250,10 @@ standard Unix <abbrev>DES</abbrev> encryption method. Arguments are a string to be encrypted and an optional two-character salt string to base the encryption on. See the Unix man page for your - crypt function for more information. + crypt function for more information.</para> <simpara> If the salt argument is not provided, it will be randomly - generated by PHP. + generated by PHP.</simpara> <simpara> Some operating systems support more than one type of encryption. In fact, sometimes the standard DES encryption is replaced by an @@ -268,14 +266,14 @@ random MD5-compatible salt is generated. PHP sets a constant named CRYPT_SALT_LENGTH which tells you whether a regular 2-character salt applies to your system or the longer 12-char MD5 - salt is applicable. + salt is applicable.</simpara> <simpara> The standard DES encryption <function>crypt</function> contains - the salt as the first two characters of the output. + the salt as the first two characters of the output.</simpara> <simpara> On systems where the crypt() function supports multiple encryption types, the following constants are set to 0 or 1 - depending on whether the given type is available: + depending on whether the given type is available:</simpara> <itemizedlist> <listitem> <simpara> @@ -303,7 +301,7 @@ <simpara> There is no decrypt function, since <function>crypt</function> - uses a one-way algorithm. + uses a one-way algorithm.</simpara> </refsect1> </refentry> @@ -322,7 +320,7 @@ </paramdef> </funcsynopsis> <simpara> - Outputs all parameters. + Outputs all parameters.</simpara> <para> <function>echo</function> is not actually a function (it @@ -347,7 +345,7 @@ See also: <function>print</function>, <function>printf</function>, and - <function>flush</function>. + <function>flush</function>.</simpara> </refsect1> </refentry> @@ -374,11 +372,11 @@ <programlisting> $pizza = "piece1 piece2 piece3 piece4 piece5 piece6"; $pieces = explode(" ", $pizza); -</programlisting></example> +</programlisting></example></para> <para> See also <function>split</function> and - <function>implode</function>. + <function>implode</function>.</para> </refsect1> </refentry> @@ -397,7 +395,7 @@ <simpara> Flushes the output buffers of PHP and whatever backend PHP is using (CGI, a web server, etc.) This effectively tries to push - all the output so far to the user's browser. + all the output so far to the user's browser.</simpara> </refsect1> </refentry> @@ -432,7 +430,7 @@ </programlisting></example> (pay attention to line endings - PHP uses a native function to - parse the input, so a Mac file won't work on Unix). + parse the input, so a Mac file won't work on Unix).</para> <para> The value of the name property becomes the key, the value of the @@ -440,10 +438,10 @@ can easily use standard array functions to traverse it or access single values. Special characters in the value of the name property are substituted with '_', the rest is converted to lower - case. + case.</para> <para> Setting <parameter>use_include_path</parameter> to 1 will result - in PHP trying to open the file along the standard include path. + in PHP trying to open the file along the standard include path.</para> </refsect1> </refentry> @@ -464,12 +462,12 @@ This function is identical to <function>htmlspecialchars</function> in all ways, except that all characters which have HTML entity equivalents are translated - into these entities. + into these entities.</para> <para> - At present, the ISO-8859-1 character set is used. + At present, the ISO-8859-1 character set is used.</para> <para> See also <function>htmlspecialchars</function> and - <function>nl2br</function>. + <function>nl2br</function>.</para> </refsect1> </refentry> @@ -491,36 +489,36 @@ Certain characters have special significance in HTML, and should be represented by HTML entities if they are to preserve their meanings. This function returns a string with these conversions - made. + made.</para> <simpara> This function is useful in preventing user-supplied text from containing HTML markup, such as in a message board or guest book - application. + application.</simpara> <para> At present, the translations that are done are: <itemizedlist> <listitem> <simpara> - '&amp;' (ampersand) becomes '&amp;amp;' + '&amp;' (ampersand) becomes '&amp;amp;'</simpara></listitem> <listitem> <simpara> - '&quot;' (double quote) becomes '&amp;quot;' + '&quot;' (double quote) becomes '&amp;quot;'</simpara></listitem> <listitem> <simpara> - '&lt;' (less than) becomes '&amp;lt;' + '&lt;' (less than) becomes '&amp;lt;'</simpara></listitem> <listitem> <simpara> - '&gt;' (greater than) becomes '&amp;gt;' - </itemizedlist> + '&gt;' (greater than) becomes '&amp;gt;'</simpara></listitem> + </itemizedlist></para> <para> Note that this functions does not translate anything beyond what is listed above. For full entity translation, see - <function>htmlentities</function>. + <function>htmlentities</function>.</para> <para> See also <function>htmlentities</function> and - <function>nl2br</function>. + <function>nl2br</function>.</para> </refsect1> </refentry> @@ -545,11 +543,11 @@ <title>implode() example</title> <programlisting> $colon_separated = implode(":", $array); -</programlisting></example> +</programlisting></example></para> <simpara> See also <function>explode</function>, <function>join</function>, - and <function>split</function>. + and <function>split</function>.</simpara> </refsect1> </refentry> @@ -569,7 +567,7 @@ <simpara> <function>join</function> is an alias to - <function>implode</function>, and is identical in every way. + <function>implode</function>, and is identical in every way.</simpara> </refsect1> </refentry> @@ -590,9 +588,9 @@ <para> This function strips whitespace from the start of a string and - returns the stripped string. + returns the stripped string.</para> <para> - See also <function>chop</function> and <function>trim</function>. + See also <function>chop</function> and <function>trim</function>.</para> </refsect1> </refentry> @@ -612,7 +610,7 @@ <para> Calculates the MD5 hash of <parameter>str</parameter> using the <ulink url="http://ds.internic.net/rfc/rfc1321.txt">RSA Data - Security, Inc. MD5 Message-Digest Algorithm</ulink>. + Security, Inc. MD5 Message-Digest Algorithm</ulink>.</para> </refsect1> </refentry> @@ -629,13 +627,13 @@ <paramdef>string <parameter>str</parameter></paramdef> </funcsynopsis> <para> - Calculates the metaphone key of <parameter>str</parameter>. + Calculates the metaphone key of <parameter>str</parameter>.</para> <para> Similar to <function>soundex</function> metaphone creates the same key for similar sounding words. It's more accurate than <function>soundex</function> as it knows the basic rules of English pronunciation. the metaphone generated keys are of - variable length. + variable length.</para> <para> Metaphone was developed by Lawrence Philips &lt;lphilips@verity.com>. It is described in ["Practical @@ -643,8 +641,8 @@ 1995]. <note> <para> - This function was added in PHP 4.0. - </note> + This function was added in PHP 4.0.</para> + </note></para> </refsect1> </refentry> @@ -663,11 +661,11 @@ <para> Returns <parameter>string</parameter> with '&lt;BR&gt;' inserted - before all newlines. + before all newlines.</para> <para> See also <function>htmlspecialchars</function> and - <function>htmlentities</function>. + <function>htmlentities</function>.</para> </refsect1> </refentry> @@ -693,10 +691,10 @@ if (ord($str) == 10) { echo "The first character of \$str is a line feed.\n"; } -</programlisting></example> +</programlisting></example></para> <simpara> - See also <function>chr</function>. + See also <function>chr</function>.</simpara> </refsect1> </refentry> @@ -715,7 +713,7 @@ <para> Parses <parameter>str</parameter> as if it were the query string - passed via an URL and sets variables in the current scope. + passed via an URL and sets variables in the current scope.</para> <para> <example> @@ -727,7 +725,7 @@ echo $second[0]; /* prints "this works" */ echo $second[1]; /* prints "another" */ </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -743,13 +741,13 @@ <paramdef>string <parameter>arg</parameter></paramdef> </funcsynopsis> <simpara> - Outputs <parameter>arg</parameter>. + Outputs <parameter>arg</parameter>.</simpara> <simpara> See also: <function>echo</function> <function>printf</function> - <function>flush</function> + <function>flush</function></simpara> </refsect1> </refentry> @@ -771,13 +769,13 @@ <simpara> Produces output according to <parameter>format</parameter>, which - is described in the documentation for <function>sprintf</function>. + is described in the documentation for <function>sprintf</function>.</simpara> <simpara> See also: <function>print</function>, <function>sprintf</function>, and - <function>flush</function>. + <function>flush</function>.</simpara> </refsect1> </refentry> @@ -785,7 +783,7 @@ <refentry id="function.quoted-printable-decode"> <refnamediv> <refname>quoted_printable_decode</refname> - <refpurpose>Convert a quoted-printable string to an 8 bit string + <refpurpose>Convert a quoted-printable string to an 8 bit string</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -799,7 +797,7 @@ This function returns an 8-bit binary string corresponding to the decoded quoted printable string. This function is similar to <function>imap_qprint</function>, except this one does not - require the IMAP module to work. + require the IMAP module to work.</simpara> </refsect1> </refentry> @@ -817,14 +815,14 @@ <para> Returns a version of str with a backslash character (<literal>\</literal>) before every character that is among - these: <screen>. \\ + * ? [ ^ ] ( $ )</screen> + these: <screen>. \\ + * ? [ ^ ] ( $ )</screen></para> <simpara> See also <function>addslashes</function>, <function>htmlentities</function>, <function>htmlspecialchars</function>, <function>nl2br</function>, and - <function>stripslashes</function>. + <function>stripslashes</function>.</simpara> </refsect1> </refentry> @@ -845,10 +843,10 @@ (<literal>%</literal>) signs followed by two hex digits have been replaced with literal characters. For example, the string <screen>foo%20bar%40baz</screen> decodes into <screen>foo - bar@baz</screen> + bar@baz</screen></para> <simpara> - See also <function>rawurlencode</function>. + See also <function>rawurlencode</function>.</simpara> </refsect1> </refentry> @@ -887,10 +885,10 @@ <programlisting> echo '&lt;A HREF="http://x.com/department_list_script/', rawurlencode ('sales and marketing/Miami'), '">'; -</programlisting></example> +</programlisting></example></para> <simpara> - See also <function>rawurldecode</function>. + See also <function>rawurldecode</function>.</simpara> </refsect1> </refentry> @@ -944,23 +942,23 @@ <function>strftime</function> </simpara> </listitem> - </itemizedlist> + </itemizedlist></para> <para> If <parameter>locale</parameter> is the empty string <literal>""</literal>, the locale names will be set from the values of environment variables with the same names as the above - categories, or from "LANG". + categories, or from "LANG".</para> <para> If locale is zero or <literal>"0"</literal>, the locale setting - is not affected, only the current setting is returned. + is not affected, only the current setting is returned.</para> <para> Setlocale returns the new current locale, or false if the locale functionality is not implemented in the plattform, the specified locale does not exist or the category name is invalid. - An invalid category name also causes a warning message. + An invalid category name also causes a warning message.</para> </refsect1> </refentry> @@ -987,13 +985,13 @@ stack as in Oliver's pseudo code, but recursive calls which may or may not speed up the whole process. Note also that the complexity of this algorithm is O(N**3) where N is the length of - the longest string. + the longest string.</para> <para> By passing a reference as third argument, <function>similar_text</function> will calculate the similarity in percent for you. It returns the number of matching chars in - both strings. + both strings.</para> </refsect1> </refentry> @@ -1010,17 +1008,17 @@ </funcsynopsis> <para> - Calculates the soundex key of <parameter>str</parameter>. + Calculates the soundex key of <parameter>str</parameter>.</para> <para> Soundex keys have the property that words pronounced similarly produce the same soundex key, and can thus be used to simplify searches in databases where you know the pronunciation but not the spelling. This soundex function returns a string 4 characters - long, starting with a letter. + long, starting with a letter.</para> <para> This particular soundex function is one described by Donald Knuth in "The Art Of Computer Programming, vol. 3: Sorting And - Searching", Addison-Wesley (1973), pp. 391-392. + Searching", Addison-Wesley (1973), pp. 391-392.</para> <para> <example> <title>Soundex Examples</title> @@ -1031,7 +1029,7 @@ soundex("Lloyd") == soundex("Ladd") == 'L300'; soundex("Lukasiewicz") == soundex("Lissajous") == 'L222'; </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -1052,7 +1050,7 @@ <simpara> Returns a string produced according to the formatting string - <parameter>format</parameter>. + <parameter>format</parameter>.</simpara> <simpara> The format string is composed by zero or more directives: @@ -1060,7 +1058,7 @@ copied directly to the result, and <emphasis>conversion specifications</emphasis>, each of which results in fetching its own parameter. This applies to both <function>sprintf</function> - and <function>printf</function>. + and <function>printf</function>.</simpara> <para> Each conversion specification consists of these elements, in @@ -1074,25 +1072,25 @@ <literal>0</literal> (zero character). The default is to pad with spaces. An alternate padding character can be specified by prefixing it with a single quote (<literal>'</literal>). - See the examples below. + See the examples below.</simpara></listitem> <listitem> <simpara> An optional <emphasis>alignment specifier</emphasis> that says if the result should be left-justified or right-justified. The default is right-justified; a <literal>-</literal> - character here will make it left-justified. + character here will make it left-justified.</simpara></listitem> <listitem> <simpara> An optional number, a <emphasis>width specifier</emphasis> that says how many characters (minimum) this conversion should - result in. + result in.</simpara></listitem> <listitem> <simpara> An optional <emphasis>precision specifier</emphasis> that says how many decimal digits should be displayed for floating-point numbers. This option has no effect for other types than double. (Another function useful for formatting numbers is - <function>number_format</function>.) + <function>number_format</function>.)</simpara></listitem> <listitem> <para> A <emphasis>type specifier</emphasis> that says what type the @@ -1138,12 +1136,12 @@ and presented as a hexadecimal number (with uppercase letters). </member> - </simplelist> - </orderedlist> + </simplelist></para></listitem> + </orderedlist></para> <simpara> See also: <function>printf</function> and - <function>number_format</function>. + <function>number_format</function>.</simpara> </refsect1> @@ -1189,12 +1187,12 @@ Returns < 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; > 0 if <parameter>str1</parameter> is greater than <parameter>str2</parameter>, and 0 if they are - equal. + equal.</simpara> <simpara> See also <function>ereg</function>, <function>strcmp</function>, <function>substr</function>, <function>stristr</function>, and - <function>strstr</function>. + <function>strstr</function>.</simpara> </refsect1> </refentry> @@ -1216,7 +1214,7 @@ <para> This function is an alias for <function>strstr</function>, and is - identical in every way. + identical in every way.</para> </refsect1> </refentry> @@ -1237,15 +1235,15 @@ Returns < 0 if <parameter>str1</parameter> is less than <parameter>str2</parameter>; > 0 if <parameter>str1</parameter> is greater than <parameter>str2</parameter>, and 0 if they are - equal. + equal.</simpara> <simpara> - Note that this comparison is case sensitive. + Note that this comparison is case sensitive.</simpara> <simpara> See also <function>ereg</function>, <function>strcasecmp</function>, <function>substr</function>, - <function>stristr</function>, and <function>strstr</function>. + <function>stristr</function>, and <function>strstr</function>.</simpara> </refsect1> </refentry> @@ -1267,10 +1265,10 @@ <simpara> Returns the length of the initial segment of <parameter>str1</parameter> which does <emphasis>not</emphasis> - contain any of the characters in <parameter>str2</parameter>. + contain any of the characters in <parameter>str2</parameter>.</simpara> <simpara> - See also <function>strspn</function>. + See also <function>strspn</function>.</simpara> </refsect1> </refentry> @@ -1291,15 +1289,15 @@ This function tries to strip all HTML and PHP tags from the given string. It errors on the side of caution in case of incomplete or bogus tags. It uses the same tag stripping state machine as - the <function>fgetss</function> function. + the <function>fgetss</function> function.</para> <para> You can use the optional second parameter to specify tags which should not be stripped. <note> <para> - <parameter>allowable_tags</parameter> was added in PHP 3.0.13, PHP4B3. - </note> + <parameter>allowable_tags</parameter> was added in PHP 3.0.13, PHP4B3.</para> + </note></para> </refsect1> </refentry> @@ -1321,10 +1319,10 @@ <note> <simpara> - Added in PHP4b3-dev. - </note> + Added in PHP4b3-dev.</simpara> + </note></para> <simpara> - See also <function>addcslashes</function>. + See also <function>addcslashes</function>.</simpara> </refsect1> </refentry> @@ -1343,10 +1341,10 @@ <para> Returns a string with backslashes stripped off. (<literal>\'</literal> becomes <literal>'</literal> and so on.) - Double backslashes are made into a single backslash. + Double backslashes are made into a single backslash.</para> <simpara> - See also <function>addslashes</function>. + See also <function>addslashes</function>.</simpara> </refsect1> </refentry> @@ -1369,16 +1367,16 @@ Returns all of <parameter>haystack</parameter> from the first occurrence of <parameter>needle</parameter> to the end. <parameter>needle</parameter> and <parameter>haystack</parameter> - are examined in a case-insensitive manner. + are examined in a case-insensitive manner.</para> <para> - If <parameter>needle</parameter> is not found, returns false. + If <parameter>needle</parameter> is not found, returns false.</para> <para> If <parameter>needle</parameter> is not a string, it is converted - to an integer and applied as the ordinal value of a character. + to an integer and applied as the ordinal value of a character.</para> <para> See also <function>strchr</function>, <function>strrchr</function>, <function>substr</function>, and - <function>ereg</function>. + <function>ereg</function>.</para> </refsect1> </refentry> @@ -1394,7 +1392,7 @@ <paramdef>string <parameter>str</parameter></paramdef> </funcsynopsis> <para> - Returns the length of <parameter>string</parameter>. + Returns the length of <parameter>string</parameter>.</para> </refsect1> </refentry> @@ -1421,21 +1419,21 @@ <parameter>haystack</parameter> string. Unlike the <function>strrpos</function>, this function can take a full string as the <parameter>needle</parameter> parameter and the - entire string will be used. + entire string will be used.</para> <para> - If <parameter>needle</parameter> is not found, returns false. + If <parameter>needle</parameter> is not found, returns false.</para> <para> If <parameter>needle</parameter> is not a string, it is converted - to an integer and applied as the ordinal value of a character. + to an integer and applied as the ordinal value of a character.</para> <para> The optional <parameter>offset</parameter> parameter allows you to specify which character in <parameter>haystack</parameter> to start searching. The position returned is still relative to the - the beginning of <parameter>haystack</parameter>. + the beginning of <parameter>haystack</parameter>.</para> <para> See also <function>strrpos</function>, <function>strrchr</function>, <function>substr</function>, - <function>stristr</function>, and <function>strstr</function>. + <function>stristr</function>, and <function>strstr</function>.</para> </refsect1> </refentry> @@ -1457,12 +1455,12 @@ This function returns the portion of <parameter>haystack</parameter> which starts at the last occurrence of <parameter>needle</parameter> and goes until the - end of <parameter>haystack</parameter>. + end of <parameter>haystack</parameter>.</para> <para> - Returns false if <parameter>needle</parameter> is not found. + Returns false if <parameter>needle</parameter> is not found.</para> <para> If <parameter>needle</parameter> contains more than one - character, the first is used. + character, the first is used.</para> <para> If <parameter>needle</parameter> is not a string, it is converted to an integer and applied as the ordinal value of a character. @@ -1477,11 +1475,11 @@ $text = "Line 1\nLine 2\nLine 3"; $last = substr( strrchr( $text, 10 ), 1 ); </programlisting> - </example> + </example></para> <para> See also <function>substr</function>, - <function>stristr</function>, and <function>strstr</function>. + <function>stristr</function>, and <function>strstr</function>.</para> </refsect1> </refentry> @@ -1498,7 +1496,7 @@ <paramdef>string <parameter>string</parameter></paramdef> </funcsynopsis> <para> - Returns <parameter>string</parameter>, reversed. + Returns <parameter>string</parameter>, reversed.</para> </refsect1> </refentry> @@ -1522,16 +1520,16 @@ <parameter>haystack</parameter> string. Note that the needle in this case can only be a single character. If a string is passed as the needle, then only the first character of that string will - be used. + be used.</para> <para> - If <parameter>needle</parameter> is not found, returns false. + If <parameter>needle</parameter> is not found, returns false.</para> <para> If <parameter>needle</parameter> is not a string, it is converted - to an integer and applied as the ordinal value of a character. + to an integer and applied as the ordinal value of a character.</para> <para> See also <function>strpos</function>, <function>strrchr</function>, <function>substr</function>, - <function>stristr</function>, and <function>strstr</function>. + <function>stristr</function>, and <function>strstr</function>.</para> </refsect1> </refentry> @@ -1552,9 +1550,9 @@ <simpara> Returns the length of the initial segment of <parameter>str1</parameter> which consists entirely of characters - in <parameter>str2</parameter>. + in <parameter>str2</parameter>.</simpara> <simpara> - See also <function>strcspn</function>. + See also <function>strcspn</function>.</simpara> </refsect1> </refentry> @@ -1572,16 +1570,16 @@ </funcsynopsis> <para> Returns all of <parameter>haystack</parameter> from the first - occurrence of <parameter>needle</parameter> to the end. + occurrence of <parameter>needle</parameter> to the end.</para> <para> - If <parameter>needle</parameter> is not found, returns false. + If <parameter>needle</parameter> is not found, returns false.</para> <para> If <parameter>needle</parameter> is not a string, it is converted - to an integer and applied as the ordinal value of a character. + to an integer and applied as the ordinal value of a character.</para> <para> See also <function>stristr</function>, <function>strrchr</function>, <function>substr</function>, and - <function>ereg</function>. + <function>ereg</function>.</para> </refsect1> </refentry> @@ -1612,7 +1610,7 @@ $tok = strtok(" "); } </programlisting> - </example> + </example></para> <para> Note that only the first call to strtok uses the string argument. Every subsequent call to strtok only needs the token to use, as @@ -1621,13 +1619,13 @@ string argument again to initialize it. Note that you may put multiple tokens in the token parameter. The string will be tokenized when any one of the characters in the argument are - found. + found.</para> <para> Also be careful that your tokens may be equal to "0". This - evaluates to false in conditional expressions. + evaluates to false in conditional expressions.</para> <para> See also <function>split</function> and - <function>explode</function>. + <function>explode</function>.</para> </refsect1> </refentry> @@ -1644,14 +1642,14 @@ </funcsynopsis> <para> Returns <parameter>string</parameter> with all alphabetic - characters converted to lowercase. + characters converted to lowercase.</para> <para> Note that 'alphabetic' is determined by the current locale. This means that in i.e. the default "C" locale, characters such as - umlaut-A (Ä) will not be converted. + umlaut-A (Ä) will not be converted.</para> <para> See also <function>strtoupper</function> - and <function>ucfirst</function>. + and <function>ucfirst</function>.</para> </refsect1> </refentry> @@ -1669,14 +1667,14 @@ </funcsynopsis> <para> Returns <parameter>string</parameter> with all alphabetic - characters converted to uppercase. + characters converted to uppercase.</para> <para> Note that 'alphabetic' is determined by the current locale. For instance, in the default "C" locale characters such as umlaut-a - (ä) will not be converted. + (ä) will not be converted.</para> <para> See also <function>strtolower</function> - and <function>ucfirst</function>. + and <function>ucfirst</function>.</para> </refsect1> </refentry> @@ -1700,18 +1698,18 @@ <parameter>needle</parameter> in <parameter>haystack</parameter> with the given <parameter>str</parameter>. If you don't need fancy replacing rules, you should always use this function - instead of <function>ereg_replace</function>. + instead of <function>ereg_replace</function>.</para> <para> <example> <title>str_replace() example</title> <programlisting> $bodytag = str_replace("%body%", "black", "&lt;body text=%body%>"); </programlisting> - </example> + </example></para> <para> - This function is binary safe. + This function is binary safe.</para> <para> - See also <function>ereg_replace</function>. + See also <function>ereg_replace</function>.</para> </refsect1> </refentry> @@ -1732,7 +1730,7 @@ This function operates on <parameter>str</parameter>, translating all occurrences of each character in <parameter>from</parameter> to the corresponding character in <parameter>to</parameter> and - returning the result. + returning the result.</para> <para> If <parameter>from</parameter> and <parameter>to</parameter> are different lengths, the extra characters in the longer of the two @@ -1742,9 +1740,9 @@ <programlisting> $addr = strtr($addr, "äåö", "aao"); </programlisting> - </example> + </example></para> <para> - See also <function>ereg_replace</function>. + See also <function>ereg_replace</function>.</para> </refsect1> </refentry> @@ -1766,11 +1764,11 @@ <para> Substr returns the portion of <parameter>string</parameter> specified by the <parameter>start</parameter> and - <parameter>length</parameter> parameters. + <parameter>length</parameter> parameters.</para> <para> If <parameter>start</parameter> is positive, the returned string will start at the <parameter>start</parameter>'th character of - <parameter>string</parameter>. + <parameter>string</parameter>.</para> <para> Examples: <informalexample> @@ -1778,11 +1776,11 @@ $rest = substr("abcdef", 1); // returns "bcdef" $rest = substr("abcdef", 1, 3); // returns "bcd" </programlisting> - </informalexample> + </informalexample></para> <para> If <parameter>start</parameter> is negative, the returned string will start at the <parameter>start</parameter>'th character - from the end of <parameter>string</parameter>. + from the end of <parameter>string</parameter>.</para> <para> Examples: <informalexample> @@ -1791,31 +1789,31 @@ $rest = substr("abcdef", -2); // returns "ef" $rest = substr("abcdef", -3, 1); // returns "d" </programlisting> - </informalexample> + </informalexample></para> <para> If <parameter>length</parameter> is given and is positive, the string returned will end <parameter>length</parameter> characters from <parameter>start</parameter>. If this would result in a string with negative length (because the start is past the end of the string), then the returned string will contain the single - character at <parameter>start</parameter>. + character at <parameter>start</parameter>.</para> <para> If <parameter>length</parameter> is given and is negative, the string returned will end <parameter>length</parameter> characters from the end of <parameter>string</parameter>. If this would result in a string with negative length, then the returned string will contain the single character at - <parameter>start</parameter>. + <parameter>start</parameter>.</para> <para> Examples: <informalexample> <programlisting role="php"> $rest = substr("abcdef", 1, -1); // returns "bcde" </programlisting> - </informalexample> + </informalexample></para> <para> See also <function>strrchr</function> and - <function>ereg</function>. + <function>ereg</function>.</para> </refsect1> </refentry> @@ -1834,10 +1832,10 @@ </funcsynopsis> <para> This function strips whitespace from the start and the end of a - string and returns the stripped string. + string and returns the stripped string.</para> <para> See also <function>chop</function> and - <function>ltrim</function>. + <function>ltrim</function>.</para> </refsect1> </refentry> @@ -1856,14 +1854,14 @@ </funcsynopsis> <para> Capitalizes the first character of <parameter>str</parameter> if - that character is alphabetic. + that character is alphabetic.</para> <para> Note that 'alphabetic' is determined by the current locale. For instance, in the default "C" locale characters such as umlaut-a - (ä) will not be converted. + (ä) will not be converted.</para> <para> See also <function>strtoupper</function> and - <function>strtolower</function>. + <function>strtolower</function>.</para> </refsect1> </refentry> @@ -1882,10 +1880,10 @@ </funcsynopsis> <simpara> Capitalizes the first character of each word in - <parameter>str</parameter> if that character is alphabetic. + <parameter>str</parameter> if that character is alphabetic.</simpara> <para> See also <function>strtoupper</function>, - <function>strtolower</function> and <function>ucfirst</function>. + <function>strtolower</function> and <function>ucfirst</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/sybase.sgml diff -u phpdoc/functions/sybase.sgml:1.3 phpdoc/functions/sybase.sgml:1.4 --- phpdoc/functions/sybase.sgml:1.3 Tue Jun 29 22:47:05 1999 +++ phpdoc/functions/sybase.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.sybase"> <title>Sybase functions</title> <titleabbrev>Sybase</titleabbrev> @@ -16,12 +15,12 @@ </parameter></paramdef> </funcsynopsis> <para> - Returns: The number of affected rows by the last query. + Returns: The number of affected rows by the last query.</para> <para> <function>sybase_affected_rows</function> returns the number of rows affected by the last INSERT, UPDATE or DELETE query on the server associated with the specified link identifier. If the - link identifier isn't specified, the last opened link is assumed. + link identifier isn't specified, the last opened link is assumed.</para> <para> This command is not effective for SELECT statements, only on statements which modify records. To retrieve the number of rows @@ -31,7 +30,7 @@ This function is only available using the CT library interface to Sybase, and not the DB library. </para> - </note> + </note></para> </refsect1> </refentry> @@ -146,7 +145,7 @@ <para> An important thing to note is that using sybase_fetch_array() is NOT significantly slower than using sybase_fetch_row(), while it - provides a significant added value. + provides a significant added value.</para> <para> For further details, also see <function>sybase_fetch_row</function> @@ -219,7 +218,7 @@ <function>sybase_fetch_array</function>, 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 - their offsets (numbers are illegal property names). + their offsets (numbers are illegal property names).</para> <para> Speed-wise, the function is identical to <function>sybase_fetch_array</function>, and almost as quick as @@ -281,10 +280,10 @@ <para> Seeks to the specified field offset. If the next call to <function>sybase_fetch_field</function> won't include a field - offset, this field would be returned. - <para> + offset, this field would be returned.</para> + <para></para> <para> - See also: <function>sybase_fetch_field</function>. + See also: <function>sybase_fetch_field</function>.</para> </refsect1> </refentry> @@ -372,22 +371,22 @@ </funcsynopsis> <para> Returns: A positive Sybase persistent link identifier on success, - or false on error + or false on error</para> <para> sybase_pconnect() acts very much like - <function>sybase_connect</function> with two major differences. + <function>sybase_connect</function> with two major differences.</para> <para> First, when connecting, the function would first try to find a (persistent) link that's already open with the same host, username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. + will be returned instead of opening a new connection.</para> <para> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<function>sybase_close</function> will not - close links established by <literal>sybase_pconnect()</literal>). + close links established by <literal>sybase_pconnect()</literal>).</para> <para> - This type of links is therefore called 'persistent'. + This type of links is therefore called 'persistent'.</para> </refsect1> </refentry> @@ -496,8 +495,8 @@ </para> </refsect1> </refentry> - +</reference> <!-- Keep this comment at the end of the file Local variables: Index: phpdoc/functions/uodbc.sgml diff -u phpdoc/functions/uodbc.sgml:1.3 phpdoc/functions/uodbc.sgml:1.4 --- phpdoc/functions/uodbc.sgml:1.3 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/uodbc.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.odbc"> <title>ODBC functions</title> <titleabbrev>ODBC</titleabbrev> @@ -19,19 +18,19 @@ Without the <parameter>OnOff</parameter> parameter, this function returns auto-commit status for <parameter>connection_id</parameter>. True is returned if - auto-commit is on, false if it is off or an error occurs. + auto-commit is on, false if it is off or an error occurs.</para> <para> If <parameter>OnOff</parameter> is true, auto-commit is enabled, if it is false auto-commit is disabled. Returns <literal>true</literal> on success, <literal>false</literal> on - failure. + failure.</para> <para> By default, auto-commit is on for a connection. Disabling - auto-commit is equivalent with starting a transaction. + auto-commit is equivalent with starting a transaction.</para> <simpara> See also <function>odbc_commit</function> and - <function>odbc_rollback</function>. + <function>odbc_rollback</function>.</simpara> </refsect1> </refentry> @@ -116,11 +115,11 @@ </row> </tbody> </tgroup> - </table> + </table></para> <para> If <function>odbc_fetch_into</function> is used, passthru means - that an empty string is returned for these columns. + that an empty string is returned for these columns.</para> <para> If <parameter>result_id</parameter> is <literal>0</literal>, the @@ -132,7 +131,7 @@ long columns is also affected by <function>odbc_longreadlen</function> </simpara> - </note> + </note></para> </refsect1> </refentry> @@ -157,7 +156,7 @@ This function will fail if there are open transactions on this connection. The connection will remain open in this case. - </simpara></note> + </simpara></note></para> </refsect1> </refentry> @@ -182,7 +181,7 @@ This function will fail if there are open transactions on a connection. This connection will remain open in this case. - </simpara></note> + </simpara></note></para> </refsect1> </refentry> @@ -201,7 +200,7 @@ <para>Returns: <literal>true</literal> on success, <literal>false</literal> on failure. All pending transactions on <parameter>connection_id</parameter> - are committed. + are committed.</para> </refsect1> </refentry> @@ -221,13 +220,13 @@ <paramdef>int <parameter><optional>cursor_type</optional></parameter></paramdef> </funcsynopsis> <para> - Returns an ODBC connection id or 0 (<literal>false</literal>) on error. + Returns an ODBC connection id or 0 (<literal>false</literal>) on error.</para> <simpara> The connection id returned by this functions is needed by other ODBC functions. You can have multiple connections open at once. The optional fourth parameter sets the type of cursor to be used for this connection. This parameter is not normally needed, but - can be useful for working around problems with some ODBC drivers. + can be useful for working around problems with some ODBC drivers.</simpara> <simpara> With some ODBC drivers, executing a complex stored procedure may fail with an error similar to: "Cannot open a cursor on a stored @@ -235,9 +234,9 @@ in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some drivers don't support the optional row_number parameter in <function>odbc_fetch_row</function>. SQL_CUR_USE_ODBC might help - in that case, too. + in that case, too.</simpara> <simpara> - The following constants are defined for cursortype: + The following constants are defined for cursortype:</simpara> <para> <itemizedlist> <listitem><simpara> @@ -252,9 +251,9 @@ <listitem><simpara> SQL_CUR_DEFAULT </simpara></listitem> - </itemizedlist> + </itemizedlist></para> <simpara> - For persistent connections see <function>odbc_pconnect</function>. + For persistent connections see <function>odbc_pconnect</function>.</simpara> </refsect1> </refentry> @@ -270,7 +269,7 @@ <paramdef>int <parameter>result_id</parameter></paramdef> </funcsynopsis> <para> - odbc_cursor will return a cursorname for the given result_id. + odbc_cursor will return a cursorname for the given result_id.</para> </refsect1> </refentry> @@ -287,7 +286,7 @@ <paramdef>string <parameter>query</parameter></paramdef> </funcsynopsis> <para> - odbc_do will execute a query on the given connection + odbc_do will execute a query on the given connection</para> </refsect1> </refentry> @@ -306,17 +305,17 @@ </funcsynopsis> <para> Returns <literal>false</literal> on error. Returns an ODBC - result identifier if the SQL command was executed successfully. + result identifier if the SQL command was executed successfully.</para> <para> <function>odbc_exec</function> will send an SQL statement to the database server specified by <parameter>connection_id</parameter>. This parameter must be a valid identifier returned by <function>odbc_connect</function> or - <function>odbc_pconnect</function>. + <function>odbc_pconnect</function>.</para> <simpara> See also: <function>odbc_prepare</function> and <function>odbc_execute</function> for multiple execution of SQL - statements. + statements.</simpara> </refsect1> </refentry> @@ -339,7 +338,7 @@ <literal>true</literal> on successful execution, <literal>false</literal> otherwise. The array <parameter>arameters_array</parameter> only needs to - be given if you really have parameters in your statement. + be given if you really have parameters in your statement.</para> </refsect1> </refentry> @@ -363,7 +362,7 @@ <parameter>result_array</parameter> must be passed by reference, but it can be of any type since it will be converted to type array. The array will contain the column values starting at array - index 0. + index 0.</para> </refsect1> </refentry> @@ -383,21 +382,21 @@ <para> If <function>odbc_fetch_row</function> was succesful (there was a row), <literal>true</literal> is returned. If there are no more - rows, <literal>false</literal> is returned. + rows, <literal>false</literal> is returned.</para> <para> <function>odbc_fetch_row</function> fetches a row of the data that was returned by <function>odbc_do</function> / <function>odbc_exec</function>. After <function>odbc_fetch_row</function> is called, the fields of that - row can be accessed with <function>odbc_result</function>. + row can be accessed with <function>odbc_result</function>.</para> <para> If <parameter>row_number</parameter> is not specified, <function>odbc_fetch_row</function> will try to fetch the next row in the result set. Calls to <function>odbc_fetch_row</function> with and without - <parameter>row_number</parameter> can be mixed. + <parameter>row_number</parameter> can be mixed.</para> <para> To step through the result more than once, you can call @@ -406,7 +405,7 @@ <function>odbc_fetch_row</function> without <parameter>row_number</parameter> to review the result. If a driver doesn't support fetching rows by number, the - <parameter>row_number</parameter> parameter is ignored. + <parameter>row_number</parameter> parameter is ignored.</para> </refsect1> </refentry> @@ -428,7 +427,7 @@ <function>odbc_field_name</function> will return the name of the field occupying the given column number in the given ODBC result identifier. Field numbering starts at 1. - <literal>false</literal> is returned on error. + <literal>false</literal> is returned on error.</para> </refsect1> </refentry> @@ -471,7 +470,7 @@ <para> <function>odbc_field_type</function> will return the SQL type of the field referecend by number in the given ODBC result - identifier. Field numbering starts at 1. + identifier. Field numbering starts at 1.</para> </refsect1> </refentry> @@ -491,7 +490,7 @@ <para> <function>odbc_field_len</function> will return the length of the field referecend by number in the given ODBC result - identifier. Field numbering starts at 1. + identifier. Field numbering starts at 1.</para> </refsect1> </refentry> @@ -509,7 +508,7 @@ <paramdef>int <parameter>result_id</parameter></paramdef> </funcsynopsis> <para> - Always returns <literal>true</literal>. + Always returns <literal>true</literal>.</para> <para> <function>odbc_free_result</function> only needs to be called if you are worried about using too much memory while your script is @@ -517,14 +516,14 @@ script is finished. But, if you are sure you are not going to need the result data anymore in a script, you may call <function>odbc_free_result</function>, and the memory associated - with <parameter>result_id</parameter> will be freed. + with <parameter>result_id</parameter> will be freed.</para> <para> <note><simpara> If auto-commit is disabled (see <function>odbc_autocommit</function>) and you call <function>odbc_free_result</function> before commiting, all pending transactions are rolled back. - </simpara></note> + </simpara></note></para> </refsect1> </refentry> @@ -569,7 +568,7 @@ <function>odbc_num_fields</function> 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 - <function>odbc_exec</function>. + <function>odbc_exec</function>.</para> </refsect1> </refentry> @@ -596,16 +595,16 @@ <parameter>password</parameter> combination (via <function>odbc_connect</function> and <function>odbc_pconnect</function>) can reuse the persistent - connection. + connection.</para> <para> <note><simpara> Persistent connections have no effect if PHP is used as a CGI program. - </simpara></note> + </simpara></note></para> <para> For information about the optional cursor_type parameter see the <function>odbc_connect</function> function. For more information - on persistent connections, refer to the PHP FAQ. + on persistent connections, refer to the PHP FAQ.</para> </refsect1> </refentry> @@ -622,11 +621,11 @@ <paramdef>string <parameter>query_string</parameter></paramdef> </funcsynopsis> <para> - Returns <literal>false</literal> on error. + Returns <literal>false</literal> on error.</para> <para> Returns an ODBC result identifier if the SQL command was prepared successfully. The result identifier can be used later to execute - the statement with <function>odbc_execute</function>. + the statement with <function>odbc_execute</function>.</para> </refsect1> </refentry> @@ -647,11 +646,11 @@ INSERT, UPDATE and DELETE statements <function>odbc_num_rows</function> returns the number of rows affected. For a SELECT clause this <literal>can</literal> be - the number of rows available. + the number of rows available.</para> <para> Note: Using <function>odbc_num_rows</function> to determine the number of rows available after a SELECT will return -1 with many - drivers. + drivers.</para> </refsect1> </refentry> @@ -668,7 +667,7 @@ <paramdef>mixed <parameter>field</parameter></paramdef> </funcsynopsis> <para> - Returns the contents of the field. + Returns the contents of the field.</para> <para> <parameter>field</parameter> can either be an integer containing the column number of the field you want; or it can be a string @@ -676,7 +675,7 @@ <informalexample><programlisting> $item_3 = odbc_result($Query_ID, 3 ); $item_val = odbc_result($Query_ID, "val"); -</programlisting></informalexample> +</programlisting></informalexample></para> <para> The first call to <function>odbc_result</function> returns the value of the third field in the current record of the query @@ -687,7 +686,7 @@ is less than one or exceeds the number of columns (or fields) in the current record. Similarly, an error occurs if a field with a name that is not one of the fieldnames of the table(s) that - is(are) being queried. + is(are) being queried.</para> <para> Field indices start from 1. Regarding the way binary or @@ -703,7 +702,7 @@ need to have binary data returned, use the SQL function HEX() to retrieve the field in hexadecimal notation. E.g. "SELECT HEX(binary_col) FROM mytable" ---> +--></para> </refsect1> </refentry> @@ -720,14 +719,14 @@ <paramdef>string <parameter><optional>format</optional></parameter></paramdef> </funcsynopsis> <para> - Returns the number of rows in the result or <literal>false</literal> on error. + Returns the number of rows in the result or <literal>false</literal> on error.</para> <para> <function>odbc_result_all</function> will print all rows from a result identifier produced by <function>odbc_exec</function>. The result is printed in HTML table format. With the optional string argument <parameter>format</parameter>, additional overall table - formatting can be done. + formatting can be done.</para> </refsect1> </refentry> @@ -747,7 +746,7 @@ Rolls back all pending statements on <parameter>connection_id</parameter>. Returns <literal>true</literal> on success, <literal>false</literal> on - failure. + failure.</para> </refsect1> </refentry> @@ -776,7 +775,7 @@ programmer and understand the effects the various options will have. You will certainly need a good ODBC reference to explain all the different options and values that can be used. - Different driver versions support different options. + Different driver versions support different options.</para> <para> Because the effects may vary depending on the ODBC driver, use of this function in scripts to be made publicly available is @@ -784,17 +783,17 @@ to this function because they must be set before the connection is established or the query is prepared. However, if on a particular job it can make PHP work so your boss doesn't tell - you to use a commercial product, that's all that really matters. + you to use a commercial product, that's all that really matters.</para> <para> <parameter>Id</parameter> is a connection id or result id on which to change the settings.For SQLSetConnectOption(), this is - a connection id. For SQLSetStmtOption(), this is a result id. + a connection id. For SQLSetStmtOption(), this is a result id.</para> <para> <parameter>function</parameter> is the ODBC function to use. The value should be 1 for SQLSetConnectOption() and 2 for - SQLSetStmtOption(). + SQLSetStmtOption().</para> <para> - Parmeter <parameter>option</parameter> is the option to set. + Parmeter <parameter>option</parameter> is the option to set.</para> <para> Parameter <parameter>param</parameter> is the value for the given <parameter>option</parameter>. @@ -816,7 +815,7 @@ odbc_setoption ($result, 2, 0, 30); odbc_execute ($result); </programlisting> - </example> + </example></para> </refsect1> </refentry> @@ -838,6 +837,3 @@ sgml-local-ecat-files:nil End: --> - - - Index: phpdoc/functions/url.sgml diff -u phpdoc/functions/url.sgml:1.3 phpdoc/functions/url.sgml:1.4 --- phpdoc/functions/url.sgml:1.3 Sun Sep 5 23:22:00 1999 +++ phpdoc/functions/url.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.url"> <title>URL functions</title> <titleabbrev>URLs</titleabbrev> @@ -17,12 +16,12 @@ <para> <function>base64_decode</function> decodes <parameter>encoded_data</parameter> and returns the original - data. The returned data may be binary. + data. The returned data may be binary.</para> <para> See also: <function>base64_encode</function>, - RFC-2045 section 6.8. + RFC-2045 section 6.8.</para> </refsect1> </refentry> @@ -42,17 +41,17 @@ <function>base64_encode</function> returns <parameter>data</parameter> 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. + transport layers that are not 8-bit clean, such as mail bodies.</para> <para> Base64-encoded data takes about 33% more space than the original - data. + data.</para> <para> See also: <function>base64_decode</function>, <function>chunk_split</function>, - RFC-2045 section 6.8. + RFC-2045 section 6.8.</para> </refsect1> </refentry> @@ -72,7 +71,7 @@ This function returns an associative array returning any of the various components of the URL that are present. This includes the "scheme", "host", "port", "user", "pass", "path", "query", and - "fragment". + "fragment".</para> </refsect1> </refentry> @@ -102,7 +101,7 @@ ' is ', htmlspecialchars (urldecode ($b [1])), "&lt;BR>"; $i++; } -</programlisting></example> +</programlisting></example></para> <para> See also <function>urlencode</function></para> @@ -139,7 +138,7 @@ <title>urlencode() example</title> <programlisting> echo '&lt;A HREF="mycgi?foo=', urlencode ($userinput), '">'; -</programlisting></example> +</programlisting></example></para> <para> See also <function>urldecode</function></para> Index: phpdoc/functions/var.sgml diff -u phpdoc/functions/var.sgml:1.4 phpdoc/functions/var.sgml:1.5 --- phpdoc/functions/var.sgml:1.4 Mon Sep 6 00:22:22 1999 +++ phpdoc/functions/var.sgml Wed Oct 20 18:41:42 1999 @@ -15,17 +15,16 @@ </funcsynopsis> <simpara> - Returns the double (floating point) value of <parameter>var</parameter>. + Returns the double (floating point) value of <parameter>var</parameter>.</simpara> <simpara> <parameter>var</parameter> may be any scalar type. You cannot use - <function>doubleval</function> on arrays or objects. + <function>doubleval</function> on arrays or objects.</simpara> <simpara> See also <function>intval</function>, <function>strval</function>, - <function>settype</function> and <link - linkend="language.types.type-juggling">Type juggling</link>. + <function>settype</function> and <link linkend="language.types.type-juggling">Type juggling</link>.</simpara> </refsect1> </refentry> @@ -45,10 +44,10 @@ <simpara> Returns false if <parameter>var</parameter> is set and has a - non-empty or non-zero value; true otherwise. + non-empty or non-zero value; true otherwise.</simpara> <simpara> - See also <function>isset</function> and <function>unset</function>. + See also <function>isset</function> and <function>unset</function>.</simpara> </refsect1> </refentry> @@ -67,21 +66,21 @@ </funcsynopsis> <para> - Returns the type of the PHP variable <parameter>var</parameter>. + Returns the type of the PHP variable <parameter>var</parameter>.</para> <para> Possibles values for the returned string are: <itemizedlist> - <listitem><simpara>"integer" - <listitem><simpara>"double" - <listitem><simpara>"string" - <listitem><simpara>"array" - <listitem><simpara>"object" - <listitem><simpara>"unknown type" - </itemizedlist> + <listitem><simpara>"integer"</simpara></listitem> + <listitem><simpara>"double"</simpara></listitem> + <listitem><simpara>"string"</simpara></listitem> + <listitem><simpara>"array"</simpara></listitem> + <listitem><simpara>"object"</simpara></listitem> + <listitem><simpara>"unknown type"</simpara></listitem> + </itemizedlist></para> <para> - See also <function>settype</function>. + See also <function>settype</function>.</para> </refsect1> </refentry> @@ -103,17 +102,16 @@ <simpara> Returns the integer value of <parameter>var</parameter>, using the specified base for the conversion (the default is - base 10). + base 10).</simpara> <simpara> <parameter>var</parameter> may be any scalar type. You cannot use - <function>intval</function> on arrays or objects. + <function>intval</function> on arrays or objects.</simpara> <simpara> See also <function>doubleval</function>, <function>strval</function>, - <function>settype</function> and <link - linkend="language.types.type-juggling">Type juggling</link>. + <function>settype</function> and <link linkend="language.types.type-juggling">Type juggling</link>.</simpara> </refsect1> </refentry> @@ -132,7 +130,7 @@ <para> Returns true if <parameter>var</parameter> is an array, false - otherwise. + otherwise.</para> <para> See also <function>is_double</function>, @@ -142,7 +140,7 @@ <function>is_real</function>, <function>is_string</function>, <function>is_long</function>, and - <function>is_object</function>. + <function>is_object</function>.</para> </refsect1> </refentry> @@ -162,7 +160,7 @@ <para> Returns true if <parameter>var</parameter> is a double, - false otherwise. + false otherwise.</para> <para> See also <function>is_array</function>, @@ -172,7 +170,7 @@ <function>is_real</function>, <function>is_string</function>, <function>is_long</function>, and - <function>is_object</function>. + <function>is_object</function>.</para> </refsect1> </refentry> @@ -191,7 +189,7 @@ </funcsynopsis> <simpara> - This function is an alias for <function>is_double</function>. + This function is an alias for <function>is_double</function>.</simpara> <simpara> See also <function>is_double</function>, @@ -201,7 +199,7 @@ <function>is_string</function>, <function>is_object</function>, <function>is_array</function>, and - <function>is_long</function>. + <function>is_long</function>.</simpara> </refsect1> </refentry> @@ -220,7 +218,7 @@ </funcsynopsis> <simpara> - This function is an alias for <function>is_long</function>. + This function is an alias for <function>is_long</function>.</simpara> <simpara> See also <function>is_double</function>, @@ -230,7 +228,7 @@ <function>is_real</function>, <function>is_object</function>, <function>is_array</function>, and - <function>is_long</function>. + <function>is_long</function>.</simpara> </refsect1> </refentry> @@ -249,7 +247,7 @@ </funcsynopsis> <simpara> - This function is an alias for <function>is_long</function>. + This function is an alias for <function>is_long</function>.</simpara> <simpara> See also <function>is_double</function>, @@ -259,7 +257,7 @@ <function>is_real</function>, <function>is_object</function>, <function>is_array</function>, and - <function>is_long</function>. + <function>is_long</function>.</simpara> </refsect1> </refentry> @@ -279,7 +277,7 @@ <para> Returns true if <parameter>var</parameter> is an integer (long), - false otherwise. + false otherwise.</para> <para> See also <function>is_double</function>, @@ -289,7 +287,7 @@ <function>is_string</function>, <function>is_object</function>, <function>is_array</function>, and - <function>is_integer</function>. + <function>is_integer</function>.</para> </refsect1> </refentry> @@ -309,7 +307,7 @@ <para> Returns true if <parameter>var</parameter> is an object, false - otherwise. + otherwise.</para> <para> See also <function>is_long</function>, @@ -319,7 +317,7 @@ <function>is_double</function>, <function>is_real</function>, <function>is_string</function>, and - <function>is_array</function>. + <function>is_array</function>.</para> </refsect1> </refentry> @@ -338,7 +336,7 @@ </funcsynopsis> <simpara> - This function is an alias for <function>is_double</function>. + This function is an alias for <function>is_double</function>.</simpara> <simpara> See also <function>is_long</function>, @@ -348,7 +346,7 @@ <function>is_double</function>, <function>is_object</function>, <function>is_string</function>, and - <function>is_array</function>. + <function>is_array</function>.</simpara> </refsect1> </refentry> @@ -368,7 +366,7 @@ <para> Returns true if <parameter>var</parameter> is a string, - false otherwise. + false otherwise.</para> <para> See also <function>is_long</function>, @@ -378,7 +376,7 @@ <function>is_double</function>, <function>is_real</function>, <function>is_object</function>, and - <function>is_array</function>. + <function>is_array</function>.</para> </refsect1> </refentry> @@ -398,7 +396,7 @@ <simpara> Returns true if <parameter>var</parameter> exists; - false otherwise. + false otherwise.</simpara> <para> If a variable has been unset with <function>unset</function>, @@ -408,10 +406,10 @@ echo isset($a); // true unset($a); echo isset($a); // false -</programlisting></informalexample> +</programlisting></informalexample></para> <simpara> - See also <function>empty</function> and <function>unset</function>. + See also <function>empty</function> and <function>unset</function>.</simpara> </refsect1> </refentry> @@ -432,23 +430,23 @@ <para> Set the type of variable <parameter>var</parameter> to - <parameter>type</parameter>. + <parameter>type</parameter>.</para> <para> Possibles values of <parameter>type</parameter> are: <itemizedlist> - <listitem><simpara>"integer" - <listitem><simpara>"double" - <listitem><simpara>"string" - <listitem><simpara>"array" - <listitem><simpara>"object" - </itemizedlist> + <listitem><simpara>"integer"</simpara></listitem> + <listitem><simpara>"double"</simpara></listitem> + <listitem><simpara>"string"</simpara></listitem> + <listitem><simpara>"array"</simpara></listitem> + <listitem><simpara>"object"</simpara></listitem> + </itemizedlist></para> <para> - Returns true if successful; otherwise returns false. + Returns true if successful; otherwise returns false.</para> <para> - See also <function>gettype</function>. + See also <function>gettype</function>.</para> </refsect1> </refentry> @@ -467,17 +465,16 @@ </funcsynopsis> <simpara> - Returns the string value of <parameter>var</parameter>. + Returns the string value of <parameter>var</parameter>.</simpara> <simpara> <parameter>var</parameter> may be any scalar type. You cannot use - <function>strval</function> on arrays or objects. + <function>strval</function> on arrays or objects.</simpara> <simpara> See also <function>doubleval</function>, <function>intval</function>, - <function>settype</function> and <link - linkend="language.types.type-juggling">Type juggling</link>. + <function>settype</function> and <link linkend="language.types.type-juggling">Type juggling</link>.</simpara> </refsect1> </refentry> @@ -497,7 +494,7 @@ <para> <function>unset</function> destroys the specified variable and - returns true. + returns true.</para> <para> <example> @@ -506,10 +503,10 @@ unset( $foo ); unset( $bar['quux'] ); </programlisting> - </example> + </example></para> <para> - See also <function>isset</function> and <function>empty</function>. + See also <function>isset</function> and <function>empty</function>.</para> </refsect1> </refentry> Index: phpdoc/functions/vmailmgr.sgml diff -u phpdoc/functions/vmailmgr.sgml:1.2 phpdoc/functions/vmailmgr.sgml:1.3 --- phpdoc/functions/vmailmgr.sgml:1.2 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/vmailmgr.sgml Wed Oct 20 18:41:42 1999 @@ -1,4 +1,3 @@ - <reference id="ref.vmailmgr"> <title>Vmailmgr functions</title> <titleabbrev>Vmailmgr</titleabbrev> @@ -6,17 +5,17 @@ <partintro> <simpara> These functions require <ulink url="&url.qmail;">qmail</ulink> and the - <ulink url="&url.vmailmgr;">vmailmgr package</ulink> by Bruce Guenter. + <ulink url="&url.vmailmgr;">vmailmgr package</ulink> by Bruce Guenter.</simpara> <simpara> For all functions, the following two variables are defined as: string vdomain the domain name of your virtual domain (vdomain.com) string basepwd the password of the 'real' user that - holds the virtual users + holds the virtual users</simpara> <simpara> Only up to 8 characters are recognized in passwords for virtual - users + users</simpara> <simpara> - Return status for all functions matches response in response.h + Return status for all functions matches response in response.h</simpara> <para> <simplelist> @@ -24,12 +23,12 @@ <member>1 bad</member> <member>2 error</member> <member>3 error connecting</member> - </simplelist> + </simplelist></para> <para> Known problems: <function>vm_deluser</function> does not delete the user directory as it should. <function>vm_addalias</function> - currently does not work correctly. + currently does not work correctly.</para> <para> <informalexample> <programlisting> @@ -39,7 +38,7 @@ $basepwd="password"; ?> </programlisting> - </informalexample> + </informalexample></para> </partintro> @@ -61,7 +60,7 @@ Add a new virtual user with a password. <parameter>newusername</parameter> is the email login name and <parameter>newuserpassword</parameter> the password for - this user. + this user.</simpara> </refsect1> </refentry> @@ -82,7 +81,7 @@ <simpara> Add an alias to a virtual user. <parameter>username</parameter> is the email login name and <parameter>alias</parameter> - is an alias for this vuser. + is an alias for this vuser.</simpara> </refsect1> </refentry> @@ -104,7 +103,7 @@ Changes a virtual users password. <parameter>username</parameter> is the email login name, <parameter>password</parameter> the old password for the vuser, and <parameter>newpassword</parameter> - the new password. + the new password.</simpara> </refsect1> </refentry> @@ -122,7 +121,7 @@ <paramdef>string <parameter>alias</parameter></paramdef> </funcsynopsis> <simpara> - Removes an alias. + Removes an alias.</simpara> </refsect1> </refentry> @@ -139,7 +138,7 @@ <paramdef>string <parameter>username</parameter></paramdef> </funcsynopsis> <simpara> - Removes a virtual user.. + Removes a virtual user..</simpara> </refsect1> </refentry> @@ -162,5 +161,3 @@ sgml-local-ecat-files:nil End: --> - - Index: phpdoc/functions/wddx.sgml diff -u phpdoc/functions/wddx.sgml:1.2 phpdoc/functions/wddx.sgml:1.3 --- phpdoc/functions/wddx.sgml:1.2 Sat Sep 4 06:42:38 1999 +++ phpdoc/functions/wddx.sgml Wed Oct 20 18:41:42 1999 @@ -4,8 +4,7 @@ <partintro> <para> - These functions are intended for work with <ulink - url="&url.wddx;">WDDX</ulink>. + These functions are intended for work with <ulink url="&url.wddx;">WDDX</ulink>.</para> <para> Note that all the functions that serialize variables use the first @@ -21,7 +20,7 @@ print wddx_serialize_value("PHP to WDDX packet example", "PHP packet"); ?&gt; </programlisting> - </example> + </example></para> <para> This example will produce: @@ -48,7 +47,7 @@ print $packet; ?&gt; </programlisting> - </example> + </example></para> <para> This example will produce: @@ -60,7 +59,7 @@ &lt;array length='3'&gt;&lt;string&gt;Austin&lt;/string&gt;&lt;string&gt;Novato&lt;/string&gt; &lt;string&gt;Seattle&lt;/string&gt;&lt;/array&gt;&lt;/var&gt;&lt;/struct&gt;&lt;/data&gt;&lt;/wddxPacket&gt; </programlisting> - </informalexample> + </informalexample></para> </partintro> @@ -84,7 +83,7 @@ WDDX packet from a single given value. It takes the value contained in <parameter>var</parameter>, and an optional <parameter>comment</parameter> string that appears in the packet - header, and returns the WDDX packet. + header, and returns the WDDX packet.</para> </refsect1> </refentry> @@ -106,13 +105,13 @@ <para> <function>wddx_serialize_vars</function> is used to create a WDDX packet with a structure that contains the serialized - representation of the passed variables. + representation of the passed variables.</para> <para> <function>wddx_serialize_vars</function> takes a variable number of arguments, each of which can be either a string naming a variable or an array containing strings naming the variables or - another array, etc. + another array, etc.</para> <para> <example> @@ -128,7 +127,7 @@ print wddx_serialize_vars("a", "b", $clvars); ?&gt; </programlisting> - </example> + </example></para> <para> The above example will produce: @@ -137,7 +136,7 @@ &lt;var name='b'&gt;&lt;number&gt;5.5&lt;/number&gt;&lt;/var&gt;&lt;var name='c'&gt;&lt;array length='3'&gt; &lt;string&gt;blue&lt;/string&gt;&lt;string&gt;orange&lt;/string&gt;&lt;string&gt;violet&lt;/string&gt;&lt;/array&gt;&lt;/var&gt; &lt;var name='d'&gt;&lt;string&gt;colors&lt;/string&gt;&lt;/var&gt;&lt;/struct&gt;&lt;/data&gt;&lt;/wddxPacket&gt; - </programlisting> + </programlisting></para> </refsect1> </refentry> @@ -160,7 +159,7 @@ packet for incremental addition of variables. It takes an optional <parameter>comment</parameter> string and returns a packet ID for use in later functions. It automatically creates a - structure definition inside the packet to contain the variables. + structure definition inside the packet to contain the variables.</para> </refsect1> </refentry> @@ -180,7 +179,7 @@ <para> <function>wddx_packet_end</function> ends the WDDX packet specified by the <parameter>packet_id</parameter> and returns the - string with the packet. + string with the packet.</para> </refsect1> </refentry> @@ -203,7 +202,7 @@ variables and add the result to the packet specified by the <parameter>packet_id</parameter>. The variables to be serialized are specified in exactly the same way as - <function>wddx_serialize_vars</function>. + <function>wddx_serialize_vars</function>.</para> </refsect1> </refentry> @@ -224,7 +223,7 @@ <function>wddx_deserialized</function> takes a <parameter>packet</parameter> string and deserializes it. It returns the result which can be string, number, or array. Note - that structures are deserialized into associative arrays. + that structures are deserialized into associative arrays.</para> </refsect1> </refentry> Index: phpdoc/functions/xml.sgml diff -u phpdoc/functions/xml.sgml:1.6 phpdoc/functions/xml.sgml:1.7 --- phpdoc/functions/xml.sgml:1.6 Fri Sep 17 03:19:28 1999 +++ phpdoc/functions/xml.sgml Wed Oct 20 18:41:42 1999 @@ -11,25 +11,22 @@ XML (eXtensible Markup Language) is a data format for structured document interchange on the Web. It is a standard defined by The World Wide Web consortium (W3C). Information about XML and - related technologies can be found at <ulink - url="http://www.w3.org/XML/">http://www.w3.org/XML/</ulink>. + related technologies can be found at <ulink url="http://www.w3.org/XML/">http://www.w3.org/XML/</ulink>. </para> </sect2> <sect2 id="xml.install"> <title>Installation</title> <para> This extension uses <productname>expat</productname>, which can - be found at <ulink - url="http://www.jclark.com/xml/">http://www.jclark.com/xml/</ulink>. + be found at <ulink url="http://www.jclark.com/xml/">http://www.jclark.com/xml/</ulink>. The Makefile that comes with expat does not build a library by default, you can use this make rule for that: - <programlisting role=makefile> + <programlisting role="makefile"> libexpat.a: $(OBJS) ar -rc $@ $(OBJS) ranlib $@ </programlisting> - A source RPM package of expat can be found at <ulink - url="http://www.guardian.no/~ssb/phpxml.html">http://www.guardian.no/~ssb/phpxml.html</ulink>. + A source RPM package of expat can be found at <ulink url="http://www.guardian.no/~ssb/phpxml.html">http://www.guardian.no/~ssb/phpxml.html</ulink>. </para> <para> Note that if you are using Apache-1.3.7 or later, you already @@ -39,8 +36,7 @@ built into Apache. </para> <para> - On UNIX, run <command>configure</command> with the <option - role="configure">--with-xml</option> option. The + On UNIX, run <command>configure</command> with the <option role="configure">--with-xml</option> option. The <productname>expat</productname> library should be installed somewhere your compiler can find it. If you compile PHP as a module for Apache 1.3.9 or later, PHP will automatically use the bundled @@ -65,11 +61,9 @@ <literal>UTF-16</literal> is not supported. </para> <para> - This extension lets you <link - linkend="function.xml-parser-create">create XML parsers</link> + This extension lets you <link linkend="function.xml-parser-create">create XML parsers</link> and then define <emphasis>handlers</emphasis> for different XML - events. Each XML parser also has a few <link - linkend="function.xml-parser-set-option">parameters</link> you + events. Each XML parser also has a few <link linkend="function.xml-parser-set-option">parameters</link> you can adjust. </para> <para> @@ -139,8 +133,7 @@ <entry> This handler is called when the XML parser finds a reference to an external parsed general entity. This can - be a reference to a file or URL, for example. See <link - linkend="example.xml-external-entity">the external entity + be a reference to a file or URL, for example. See <link linkend="example.xml-external-entity">the external entity example</link> for a demonstration. </entry> </row> @@ -202,8 +195,7 @@ <sect2 id="xml.encoding"> <title>Character Encoding</title> <para> - PHP's XML extension supports the <ulink - url="&url.unicode;">Unicode</ulink> character set through + PHP's XML extension supports the <ulink url="&url.unicode;">Unicode</ulink> character set through different <glossterm>character encoding</glossterm>s. There are two types of character encodings, <glossterm>source encoding</glossterm> and <glossterm>target @@ -211,9 +203,7 @@ document is always encoded with <literal>UTF-8</literal>. </para> <para> - Source encoding is done when an XML document is <link - linkend="function.xml-parse">parsed</link>. Upon <link - linkend="function.xml-parser-create">creating an XML + Source encoding is done when an XML document is <link linkend="function.xml-parse">parsed</link>. Upon <link linkend="function.xml-parser-create">creating an XML parser</link>, a source encoding can be specified (this encoding can not be changed later in the XML parser's lifetime). The supported source encodings are @@ -257,7 +247,7 @@ a document with indentation. <example> <title>Show XML Element Structure</title> - <programlisting role=php> + <programlisting role="php"> $file = "data.xml"; $depth = array(); @@ -304,7 +294,7 @@ tags. Elements not found in the "map array" are ignored. Of course, this example will only work with a specific XML document type. - <programlisting role=php> + <programlisting role="php"> $file = "data.xml"; $map_array = array( "BOLD" => "B", @@ -349,7 +339,7 @@ } } xml_parser_free($xml_parser); -</programlisting> +</programlisting></para> </example> </para> </sect2> @@ -369,7 +359,7 @@ <para> <example> <title>External Entity Example</title> - <programlisting role=php> + <programlisting role="php"> $file = "xmltest.xml"; function trustedFile($file) @@ -498,7 +488,7 @@ <para id="example.xml-xmltest.xml"> <example> <title>xmltest.xml</title> - <programlisting role=xml> + <programlisting role="xml"> &lt;?xml version='1.0'?> &lt;!DOCTYPE chapter SYSTEM "/just/a/test.dtd" [ &lt;!ENTITY plainEntity "FOO entity"> @@ -533,7 +523,7 @@ This file is included from <filename>xmltest.xml</filename>: <example> <title>xmltest2.xml</title> - <programlisting role=xml> + <programlisting role="xml"> &lt;?xml version="1.0"?> &lt;!DOCTYPE foo [ &lt;!ENTITY testEnt "test entity"> @@ -572,7 +562,7 @@ <member><literal>ISO-8859-1</literal> (default)</member> <member><literal>US-ASCII</literal></member> <member><literal>UTF-8</literal></member> - </simplelist> + </simplelist></para> </listitem> </varlistentry> </variablelist> @@ -603,7 +593,7 @@ <parameter>endElementHandler</parameter> are strings containing the names of functions that must exist when <function>xml_parse</function> is called for - <parameter>parser</parameter>. + <parameter>parser</parameter>.</para> <para> The function named by <parameter>startElementHandler</parameter> must accept three parameters: @@ -618,7 +608,7 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> @@ -627,7 +617,7 @@ the name of the element for which this handler is called. If <link linkend="xml.case-folding">case-folding</link> is in effect for this parser, the element name will be in uppercase - letters. + letters.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>attribs</parameter></term> @@ -636,18 +626,17 @@ The third parameter, <parameter>attribs</parameter>, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values - are the attribute values. Attribute names are <link - linkend="xml.case-folding">case-folded</link> on the same + are the attribute values. Attribute names are <link linkend="xml.case-folding">case-folded</link> on the same criteria as element names. Attribute values are - <emphasis>not</emphasis> case-folded. + <emphasis>not</emphasis> case-folded.</simpara> <simpara> The original order of the attributes can be retrieved by walking through <parameter>attribs</parameter> the normal way, using <function>each</function>. The first key in the - array was the first attribute, and so on. + array was the first attribute, and so on.</simpara> </listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> The function named by <parameter>endElementHandler</parameter> must accept two parameters: @@ -661,7 +650,7 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>name</parameter></term> @@ -670,15 +659,15 @@ the name of the element for which this handler is called. If <link linkend="xml.case-folding">case-folding</link> is in effect for this parser, the element name will be in uppercase - letters. + letters.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handlers are set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -702,7 +691,7 @@ <parameter>parser</parameter>. <parameter>handler</parameter> is a string containing the name of a function that must exist when <function>xml_parse</function> is called for - <parameter>parser</parameter>. + <parameter>parser</parameter>.</para> <para> The function named by <parameter>handler</parameter> must accept two parameters: @@ -716,21 +705,21 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> <listitem><simpara> The second parameter, <parameter>data</parameter>, contains - the character data as a string. + the character data as a string.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handler is set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -754,7 +743,7 @@ parser <parameter>parser</parameter>. <parameter>handler</parameter> is a string containing the name of a function that must exist when <function>xml_parse</function> is - called for <parameter>parser</parameter>. + called for <parameter>parser</parameter>.</para> <para> A processing instruction has the following format: <informalexample> @@ -765,7 +754,7 @@ (<literal>?&gt;</literal>) can not be quoted, so this character sequence should not appear in the PHP code you embed with PIs in XML documents. If it does, the rest of the PHP code, as well as - the "real" PI end tag, will be treated as character data. + the "real" PI end tag, will be treated as character data.</para> <para> The function named by <parameter>handler</parameter> must accept three parameters: @@ -780,27 +769,27 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>target</parameter></term> <listitem><simpara> The second parameter, <parameter>target</parameter>, contains - the PI target. + the PI target.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> <listitem><simpara> The third parameter, <parameter>data</parameter>, contains - the PI data. + the PI data.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handler is set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -824,7 +813,7 @@ <parameter>parser</parameter>. <parameter>handler</parameter> is a string containing the name of a function that must exist when <function>xml_parse</function> is called for - <parameter>parser</parameter>. + <parameter>parser</parameter>.</para> <para> The function named by <parameter>handler</parameter> must accept two parameters: @@ -838,7 +827,7 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> @@ -846,15 +835,15 @@ The second parameter, <parameter>data</parameter>, contains the character data. This may be the XML declaration, document type declaration, entities or other data for which - no other handler exists. + no other handler exists.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handler is set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -878,21 +867,16 @@ parser <parameter>parser</parameter>. <parameter>handler</parameter> is a string containing the name of a function that must exist when <function>xml_parse</function> is - called for <parameter>parser</parameter>. + called for <parameter>parser</parameter>.</para> <para> This handler will be called if the XML parser encounters an external entity declaration with an NDATA declaration, like the following: - <programlisting role=xml>&lt;!ENTITY <parameter>name</parameter - > {<parameter>publicId</parameter - > | <parameter>systemId</parameter - >} NDATA <parameter>notationName</parameter - >&gt;</programlisting> + <programlisting role="xml">&lt;!ENTITY <parameter>name</parameter> {<parameter>publicId</parameter> | <parameter>systemId</parameter>} NDATA <parameter>notationName</parameter>&gt;</programlisting></para> <para> - See <ulink - url="&url.rec-xml;#sec-external-ent">section 4.2.2 of the XML 1.0 + See <ulink url="&url.rec-xml;#sec-external-ent">section 4.2.2 of the XML 1.0 spec</ulink> for the definition of notation declared external - entities. + entities.</para> <para> The function named by <parameter>handler</parameter> must accept six parameters: @@ -910,12 +894,12 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>entityName</parameter></term> <listitem><simpara> - The name of the entity that is about to be defined. + The name of the entity that is about to be defined.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>base</parameter></term> @@ -923,31 +907,31 @@ This is the base for resolving the system identifier (<parameter>systemId</parameter>) of the external entity. Currently this parameter will always be set to - an empty string. + an empty string.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>systemId</parameter></term> <listitem><simpara> - System identifier for the external entity. + System identifier for the external entity.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>publicId</parameter></term> <listitem><simpara> - Public identifier for the external entity. + Public identifier for the external entity.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>notationName</parameter></term> <listitem><simpara> Name of the notation of this entity (see - <function>xml_set_notation_decl_handler</function>). + <function>xml_set_notation_decl_handler</function>).</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handler is set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -971,17 +955,13 @@ <parameter>parser</parameter>. <parameter>handler</parameter> is a string containing the name of a function that must exist when <function>xml_parse</function> is called for - <parameter>parser</parameter>. + <parameter>parser</parameter>.</para> <para> A notation declaration is part of the document's DTD and has the following format: - <programlisting role=xml - >&lt;!NOTATION <parameter>name</parameter - > {<parameter>systemId</parameter - > | <parameter>publicId</parameter - >}&gt;</programlisting> + <programlisting role="xml">&lt;!NOTATION <parameter>name</parameter> {<parameter>systemId</parameter> | <parameter>publicId</parameter>}&gt;</programlisting> See <ulink url="&url.rec-xml;#Notations">section 4.7 of the XML - 1.0 spec</ulink> for the definition of notation declarations. + 1.0 spec</ulink> for the definition of notation declarations.</para> <para> The function named by <parameter>handler</parameter> must accept five parameters: @@ -998,13 +978,13 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>notationName</parameter></term> <listitem><simpara> This is the notation's <parameter>name</parameter>, as per - the notation format described above. + the notation format described above.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>base</parameter></term> @@ -1012,25 +992,25 @@ This is the base for resolving the system identifier (<parameter>systemId</parameter>) of the notation declaration. Currently this parameter will always be set to - an empty string. + an empty string.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>systemId</parameter></term> <listitem><simpara> - System identifier of the external notation declaration. + System identifier of the external notation declaration.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>publicId</parameter></term> <listitem><simpara> - Public identifier of the external notation declaration. + Public identifier of the external notation declaration.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handler is set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -1054,14 +1034,13 @@ <parameter>parser</parameter>. <parameter>handler</parameter> is a string containing the name of a function that must exist when <function>xml_parse</function> is called for - <parameter>parser</parameter>. + <parameter>parser</parameter>.</para> <para> The function named by <parameter>handler</parameter> must accept five parameters, and should return an integer value. If the value returned from the handler is false (which it will be if no value is returned), the XML parser will stop parsing and - <function>xml_get_error_code</function> will return <systemitem - class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. + <function>xml_get_error_code</function> will return <systemitem class="constant">XML_ERROR_EXTERNAL_ENTITY_HANDLING</systemitem>. <funcsynopsis> <funcdef>int <replaceable>handler</replaceable></funcdef> @@ -1076,7 +1055,7 @@ <term><parameter>parser</parameter></term> <listitem><simpara> The first parameter, <replaceable>parser</replaceable>, is a - reference to the XML parser calling the handler. + reference to the XML parser calling the handler.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>openEntityNames</parameter></term> @@ -1084,7 +1063,7 @@ The second parameter, <parameter>openEntityNames</parameter>, is a space-separated list of the names of the entities that are open for the parse of this entity (including the name of - the referenced entity). + the referenced entity).</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>base</parameter></term> @@ -1092,13 +1071,13 @@ This is the base for resolving the system identifier (<parameter>systemid</parameter>) of the external entity. Currently this parameter will always be set to an empty - string. + string.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>systemId</parameter></term> <listitem><simpara> The fourth parameter, <parameter>systemId</parameter>, is the - system identifier as specified in the entity declaration. + system identifier as specified in the entity declaration.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>publicId</parameter></term> @@ -1106,15 +1085,15 @@ The fifth parameter, <parameter>publicId</parameter>, is the public identifier as specified in the entity declaration, or an empty string if none was specified; the whitespace in the public - identifier will have been normalized as required by the XML spec. + identifier will have been normalized as required by the XML spec.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> If a handler function is set to an empty string, or - <literal>false</literal>, the handler in question is disabled. + <literal>false</literal>, the handler in question is disabled.</para> <para> True is returned if the handler is set up, false if - <parameter>parser</parameter> is not a parser. + <parameter>parser</parameter> is not a parser.</para> <para> There is currently no support for object/method handlers. </para> @@ -1139,7 +1118,7 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to use. + A reference to the XML parser to use.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>data</parameter></term> @@ -1147,19 +1126,19 @@ Chunk of data to parse. A document may be parsed piece-wise by calling <function>xml_parse</function> several times with new data, as long as the <parameter>isFinal</parameter> - parameter is set and true when the last data is parsed. + parameter is set and true when the last data is parsed.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>isFinal</parameter> (optional)</term> <listitem><simpara> If set and true, <parameter>data</parameter> is the last - piece of data sent in this parse. + piece of data sent in this parse.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> When the XML document is parsed, the handlers for the configured events are called as many times as necessary, after which this - function returns true or false. + function returns true or false.</para> <para> True is returned if the parse was successful, false if it was not successful, or if <parameter>parser</parameter> does not refer to @@ -1189,9 +1168,9 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to get error code from. + A reference to the XML parser to get error code from.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or else it returns one of the error @@ -1217,9 +1196,9 @@ <varlistentry> <term><parameter>code</parameter></term> <listitem><simpara> - An error code from <function>xml_get_error_code</function>. + An error code from <function>xml_get_error_code</function>.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> Returns a string with a textual description of the error code <parameter>code</parameter>, or false if no description was found. @@ -1243,9 +1222,9 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to get line number from. + A reference to the XML parser to get line number from.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or else it returns which line the @@ -1270,9 +1249,9 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to get column number from. + A reference to the XML parser to get column number from.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or else it returns which column on @@ -1299,9 +1278,9 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to get byte index from. + A reference to the XML parser to get byte index from.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or else it returns which byte index @@ -1326,9 +1305,9 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to free. + A reference to the XML parser to free.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or else it frees the parser and @@ -1355,19 +1334,19 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to set an option in. + A reference to the XML parser to set an option in.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>option</parameter></term> <listitem><simpara> - Which option to set. See below. + Which option to set. See below.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>value</parameter></term> <listitem><simpara> - The option's new value. + The option's new value.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or if the option could not be set. @@ -1389,14 +1368,12 @@ <row> <entry>XML_OPTION_CASE_FOLDING</entry> <entry>integer</entry> - <entry>Controls whether <link - linkend="xml.case-folding">case-folding</link> is enabled for + <entry>Controls whether <link linkend="xml.case-folding">case-folding</link> is enabled for this XML parser. Enabled by default.</entry> </row> <row> <entry>XML_OPTION_TARGET_ENCODING</entry> - <entry>string</entry> <entry>Sets which <link - linkend="xml.encoding">target encoding</link> to use in this + <entry>string</entry> <entry>Sets which <link linkend="xml.encoding">target encoding</link> to use in this XML parser. By default, it is set to the same as the source encoding used by <function>xml_parser_create</function>. Supported target encodings are @@ -1428,15 +1405,15 @@ <varlistentry> <term><parameter>parser</parameter></term> <listitem><simpara> - A reference to the XML parser to get an option from. + A reference to the XML parser to get an option from.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>option</parameter></term> <listitem><simpara> Which option to fetch. See - <function>xml_parser_set_option</function> for a list of options. + <function>xml_parser_set_option</function> for a list of options.</simpara></listitem> </varlistentry> - </variablelist> + </variablelist></para> <para> This function returns false if <parameter>parser</parameter> does not refer to a valid parser, or if the option could not be set. Index: phpdoc/functions/zlib.sgml diff -u phpdoc/functions/zlib.sgml:1.7 phpdoc/functions/zlib.sgml:1.8 --- phpdoc/functions/zlib.sgml:1.7 Thu Sep 23 04:49:02 1999 +++ phpdoc/functions/zlib.sgml Wed Oct 20 18:41:42 1999 @@ -3,14 +3,12 @@ <titleabbrev>Zlib</titleabbrev> <partintro> <para> - This module uses the functions of <ulink - url="&url.zlib;">zlib</ulink> by Jean-loup Gailly and Mark Adler to + This module uses the functions of <ulink url="&url.zlib;">zlib</ulink> by Jean-loup Gailly and Mark Adler to transparently read and write gzip (.gz) compressed files. You have to use a zlib version >= 1.0.9 with this module. </para> <para> - This module contains versions of most of the <link - linkend="ref.filesystem">filesystem</link> functions which work + This module contains versions of most of the <link linkend="ref.filesystem">filesystem</link> functions which work with gzip-compressed files (and uncompressed files, too, but not with sockets). </para> @@ -24,7 +22,7 @@ <example> <title>Small Zlib example</title> -<programlisting role=php> +<programlisting role="php"> &lt;?php $filename = tempnam('/tmp', 'zlibtest').'.gz'; print "&lt;html>\n&lt;head>&lt;/head>\n&lt;body>\n&lt;pre>\n"; @@ -50,7 +48,7 @@ print "&lt;pre>\n&lt;/h1>&lt;/body>\n&lt;/html>\n"; ?> </programlisting> - </example> + </example></sect1> </partintro> @@ -66,14 +64,14 @@ <paramdef>int <parameter>zp</parameter></paramdef> </funcsynopsis> <para> - The gz-file pointed to by zp is closed. + The gz-file pointed to by zp is closed.</para> <para> - Returns true on success and false on failure. + Returns true on success and false on failure.</para> <para> The gz-file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> </refsect1> </refentry> @@ -92,11 +90,11 @@ </funcsynopsis> <para> Returns true if the gz-file pointer is at EOF or an error occurs; - otherwise returns false. + otherwise returns false.</para> <para> The gz-file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> </refsect1> </refentry> @@ -115,15 +113,14 @@ <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> Identical to <function>readgzfile</function>, except that gzfile() - returns the file in an array. + returns the file in an array.</para> <para> You can use the optional second parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. + you want to search for the file in the <link linkend="ini.include-path">include_path</link>, too.</para> <para> See also <function>readgzfile</function>, and - <function>gzopen</function>. + <function>gzopen</function>.</para> </refsect1> </refentry> @@ -142,14 +139,14 @@ <para> Returns a string containing a single (uncompressed) character read from the file pointed to by zp. Returns FALSE on EOF (as - does <function>gzeof</function>). + does <function>gzeof</function>).</para> <para> The gz-file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> <para> See also <function>gzopen</function>, and - <function>gzgets</function>. + <function>gzgets</function>.</para> </refsect1> </refentry> @@ -172,15 +169,15 @@ Returns a (uncompressed) string of up to length - 1 bytes read from the file pointed to by fp. Reading ends when length - 1 bytes have been read, on a newline, or on EOF (whichever comes - first). + first).</para> - <para> If an error occurs, returns false. + <para> If an error occurs, returns false.</para> <para> The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> <para> See also <function>gzopen</function>, - <function>gzgetc</function>, and <function>fgets</function>. + <function>gzgetc</function>, and <function>fgets</function>.</para> </refsect1> </refentry> @@ -202,19 +199,19 @@ <para> Identical to <function>gzgets</function>, except that gzgetss attempts to strip any HTML and PHP tags from - the text it reads. + the text it reads.</para> <para> You can use the optional third parameter to specify tags which should not be stripped. <note> <para> - <parameter>allowable_tags</parameter> was added in PHP 3.0.13, PHP4B3. - </note> + <parameter>allowable_tags</parameter> was added in PHP 3.0.13, PHP4B3.</para> + </note></para> <para> See also <function>gzgets</function>, - <function>gzopen</function>, and <function>strip_tags</function>. + <function>gzopen</function>, and <function>strip_tags</function>.</para> </refsect1> </refentry> @@ -239,34 +236,33 @@ can also include a compression level ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman only compression as in "wb1h". (See the description of deflateInit2 in zlib.h for - more information about the strategy parameter.) + more information about the strategy parameter.)</para> <para> Gzopen can be used to read a file which is not in gzip format; in this case <function>gzread</function> will directly read from the - file without decompression. + file without decompression.</para> <para> 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. + transparently decompressed and what you write gets compressed.</para> <para> - If the open fails, the function returns false. + If the open fails, the function returns false.</para> <para> You can use the optional third parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. + you want to search for the file in the <link linkend="ini.include-path">include_path</link>, too.</para> <para><example> <title>gzopen() example</title> <programlisting> $fp = gzopen("/tmp/file.gz", "r"); -</programlisting></example> +</programlisting></example></para> <para> - See also <function>gzclose</function>. + See also <function>gzclose</function>.</para> </refsect1> </refentry> @@ -285,18 +281,18 @@ </funcsynopsis> <para> Reads to EOF on the given gz-file pointer and writes the - (uncompressed) results to standard output. + (uncompressed) results to standard output.</para> <para> - If an error occurs, returns false. + If an error occurs, returns false.</para> <para> The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> <para> The gz-file is closed when <function>gzpassthru</function> is - done reading it (leaving <parameter>zp</parameter> useless). + done reading it (leaving <parameter>zp</parameter> useless).</para> </refsect1> </refentry> @@ -318,7 +314,7 @@ <para> <function>gzputs</function> is an alias to - <function>gzwrite</function>, and is identical in every way. + <function>gzwrite</function>, and is identical in every way.</para> </refsect1> </refentry> @@ -341,7 +337,7 @@ <parameter>length</parameter> bytes from the gz-file pointer referenced by <parameter>zp</parameter>. Reading stops when <parameter>length</parameter> (uncompressed) bytes have been read - or EOF is reached, whichever comes first. + or EOF is reached, whichever comes first.</simpara> <para> <informalexample> @@ -352,12 +348,12 @@ $contents = gzread( $zd, 10000 ); gzclose( $zd ); </programlisting> - </informalexample> + </informalexample></para> <simpara> See also <function>gzwrite</function>, <function>gzopen</function>, <function>gzgets</function>, <function>gzgetss</function>, - <function>gzfile</function>, and <function>gzpassthru</function>. + <function>gzfile</function>, and <function>gzpassthru</function>.</simpara> </refsect1> </refentry> @@ -374,12 +370,12 @@ <paramdef>int <parameter>zp</parameter></paramdef> </funcsynopsis> <para> Sets the file position indicator for zp to the - beginning of the file stream. - <para> If an error occurs, returns 0. + beginning of the file stream.</para> + <para> If an error occurs, returns 0.</para> <para> The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> <para> - See also <function>gzseek</function> and <function>gztell</function>. + See also <function>gzseek</function> and <function>gztell</function>.</para> </refsect1> </refentry> @@ -399,21 +395,21 @@ <para> Sets the file position indicator for the file referenced by zp to offset bytes into the file stream. Equivalent to calling (in C) - <literal>gzseek( zp, offset, SEEK_SET )</literal>. + <literal>gzseek( zp, offset, SEEK_SET )</literal>.</para> <para> If the file is opened for reading, this function is emulated but can be extremely slow. If the file is opened for writing, only forward seeks are supported; gzseek then compresses a sequence of - zeroes up to the new starting position. + zeroes up to the new starting position.</para> <para> Upon success, returns 0; otherwise, returns -1. Note that seeking - past EOF is not considered an error. + past EOF is not considered an error.</para> <para> See also <function>gztell</function> and - <function>gzrewind</function>. + <function>gzrewind</function>.</para> </refsect1> </refentry> @@ -432,17 +428,17 @@ </funcsynopsis> <para> Returns the position of the file pointer referenced by zp; i.e., - its offset into the file stream. + its offset into the file stream.</para> <para> - If an error occurs, returns false. + If an error occurs, returns false.</para> <para> The file pointer must be valid, and must point to a file - successfully opened by <function>gzopen</function>. + successfully opened by <function>gzopen</function>.</para> <para> See also <function>gzopen</function>, - <function>gzseek</function> and <function>gzrewind</function>. + <function>gzseek</function> and <function>gzrewind</function>.</para> </refsect1> </refentry> @@ -467,18 +463,17 @@ argument is given, writing will stop after <parameter>length</parameter> (uncompressed) bytes have been written or the end of <parameter>string</parameter> is reached, - whichever comes first. + whichever comes first.</simpara> <simpara> Note that if the <parameter>length</parameter> argument is given, - then the <link - linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> + then the <link linkend="ini.magic-quotes-runtime">magic_quotes_runtime</link> configuration option will be ignored and no slashes will be - stripped from <parameter>string</parameter>. + stripped from <parameter>string</parameter>.</simpara> <simpara> See also <function>gzread</function>, <function>gzopen</function>, - and <function>gzputs</function>. + and <function>gzputs</function>.</simpara> </refsect1> </refentry> @@ -495,28 +490,27 @@ <paramdef>int <parameter><optional>use_include_path</optional></parameter></paramdef> </funcsynopsis> <para> Reads a file, decompresses it and writes it to standard - output. + output.</para> <para> 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. + file without decompression.</para> <para> Returns the number of (uncompressed) bytes read from the file. If an error occurs, false is returned and unless the - function was called as @readgzfile, an error message is printed. + function was called as @readgzfile, an error message is printed.</para> <para> The file <parameter>filename</parameter> will be opened - from the filesystem and its contents written to standard output. + from the filesystem and its contents written to standard output.</para> <para> You can use the optional second parameter and set it to "1", if - you want to search for the file in the <link - linkend="ini.include-path">include_path</link>, too. + you want to search for the file in the <link linkend="ini.include-path">include_path</link>, too.</para> <para> See also <function>gzpassthru</function>, - <function>gzfile</function>, and <function>gzopen</function>. + <function>gzfile</function>, and <function>gzopen</function>.</para> </refsect1> </refentry>