CVS update: phpdoc/functions

Date: Saturday June 19, 1999 @ 18:12 Author: jim Update of /repository/phpdoc/functions In directory php:/tmp/cvs-serv2941/functions Modified Files: fdf.sgml hw.sgml ifx.sgml mcrypt.sgml oci8.sgml oracle.sgml pdf.sgml pgsql.sgml strings.sgml uodbc.sgml Log Message: More cleanups. Index: phpdoc/functions/fdf.sgml diff -u phpdoc/functions/fdf.sgml:1.1.1.1 phpdoc/functions/fdf.sgml:1.2 --- phpdoc/functions/fdf.sgml:1.1.1.1 Sun Jun 6 14:51:00 1999 +++ phpdoc/functions/fdf.sgml Sat Jun 19 18:12:06 1999 @@ -7,7 +7,7 @@ <simpara> This is a first attempt to implement Forms Data Format (FDF) support - in php3. It is recommended to read the documentation at + in PHP. It is recommended to read the documentation at <ulink url="http://beta1.adobe.com/ada/acrosdk/forms.html">http://beta1.adobe.com/ada/acrosdk/forms.html</ulink> for a better understanding. </partintro> Index: phpdoc/functions/hw.sgml diff -u phpdoc/functions/hw.sgml:1.3 phpdoc/functions/hw.sgml:1.4 --- phpdoc/functions/hw.sgml:1.3 Wed Jun 16 06:29:53 1999 +++ phpdoc/functions/hw.sgml Sat Jun 19 18:12:06 1999 @@ -39,7 +39,7 @@ <para> Each object record has native a string representation with each name/value - pair separated by a newline. The PHP3 Hyperwave module also knows + pair separated by a newline. The Hyperwave extension also knows a second representation which is an associated array with the attribute name being the key. Multilingual attribute values itself form another associated array with the key being the language @@ -91,13 +91,13 @@ This can only be prevented by selecting reasonable object names. <para> Having made this decision a second problem arises. How do you - involve php3? The URL http://host/my_object will not call any - php3 script unless you tell your web server to rewrite it to + involve PHP? The URL http://host/my_object will not call any + PHP script unless you tell your web server to rewrite it to e.g. 'http://host/php3_script/my_object' and the script 'php3_script' evaluates the $PATH_INFO variable and retrieves the object with name 'my_object' from the Hyperwave server. Their is just one little drawback which can be fixed easily. Rewriting any URL would not allow - any access to other document on the web server. A php3 script for + any access to other document on the web server. A PHP script for 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 @@ -105,36 +105,35 @@ <para> Based on the above mechanism links are insert into documents. <para> - It gets more complicated if php3 is not run as a module/CGI script - but as a standalone application e.g. to dump the content of the - Hyperwave server on a CD-ROM. In such a case it makes sense to + 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 + the Hyperwave server on a CD-ROM. In such a case it makes sense to 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. <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 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 provided for communication with the server. Those - two disappeared when Hyperwave was commercialised. As a - replacement a so called wavemaster was provided. The wavemaster - is like a protocol converter from <abbrev>HTTP</abbrev> to - <abbrev>HG-CSP</abbrev>. The idea is to do all the - administration of the database and visualisation of documents by - a web interface. The wavemaster implements a set of placeholders - for certain actions to customise the interface. This set of - placeholders is called the <abbrev>PLACE</abbrev> Language. - <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. + 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 + 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 + provided for communication with the server. Those two disappeared + when Hyperwave was commercialised. As a replacement a so called + wavemaster was provided. The wavemaster is like a protocol converter + from <abbrev>HTTP</abbrev> to <abbrev>HG-CSP</abbrev>. The idea is + to do all the administration of the database and visualisation of + documents by a web interface. The wavemaster implements a set of + placeholders for certain actions to customise the interface. This + set of placeholders is called the <abbrev>PLACE</abbrev> Language. + <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. <para> - Adding Hyperwave support to PHP3 should fill in the gap of a + 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 @@ -168,7 +167,7 @@ depended (like the title, keyword, description) will form an associated array with the key set to the language abbreviation. All other multiple attributes will form an - indexed array. php3 functions never return object arrays. + indexed array. PHP functions never return object arrays. </simpara></listitem> <listitem><simpara> hw_document: This is a complete new data type which holds the @@ -224,18 +223,18 @@ <sect1 id="hw-apache"> <title>Integration with Apache</title> <para> - The Hyperwave module is best used when PHP3 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. + 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. <para> - Since PHP3 with Hyperwave support build into apache is intended - to replace the native Hyperwave solution based on wavemaster I - will assume that the apache server will only serve as a Hyperwave + Since PHP with Hyperwave support built into Apache is intended + to replace the native Hyperwave solution based on Wavemaster I + will assume that the Apache server will only serve as a Hyperwave web interface. This is not necessary but it simplifies the configuration. The concept is quite simple. First of all you - need a PHP3 script which evaluates the <envar>PATH_INFO</envar> + 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> @@ -244,7 +243,7 @@ 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 + 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 return the object. The rewriting rule is quite easy: @@ -772,18 +771,16 @@ <para> Returns a remote document. Remote documents in Hyperwave notation are documents retrieved from an external source. Common remote - documents are for example external web pages or queries in a database. - In order to be able to access external sources throught remote documents - Hyperwave introduces the HGI (Hyperwave Gateway Interface) which - is similar to the CGI. Currently, only ftp, http-servers and some - databases can be accessed by the HGI. + documents are for example external web pages or queries in + a database. In order to be able to access external sources + throught remote documents Hyperwave introduces the HGI (Hyperwave + Gateway Interface) which is similar to the CGI. Currently, only + ftp, http-servers and some databases can be accessed by the HGI. Calling <function>hw_GetRemote</function> returns the document from - the external source. - If you want to use this function you should be very familiar with HGIs. - You should also consider to use php3 instead of Hyperwave to access - external - sources. Adding database support by a Hyperwave gateway should be more - difficult than doing it in php3. + 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. <para> See also <function>hw_GetRemoteChildren</function>. </refsect1> @@ -816,10 +813,10 @@ do not have a valid object ID. How exactely such an object record looks like is up to the HGI. If you want to use this function you should be very familiar with HGIs. - You should also consider to use php3 instead of Hyperwave to access + 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 php3. + difficult than doing it in PHP. <para> See also <function>hw_GetRemote</function>. </refsect1> Index: phpdoc/functions/ifx.sgml diff -u phpdoc/functions/ifx.sgml:1.1.1.1 phpdoc/functions/ifx.sgml:1.2 --- phpdoc/functions/ifx.sgml:1.1.1.1 Sun Jun 6 14:50:46 1999 +++ phpdoc/functions/ifx.sgml Sat Jun 19 18:12:06 1999 @@ -80,7 +80,7 @@ </para><para> If you set ifx_text/byteasvarchar to 1, you can use TEXT and BYTE columns in select queries just like normal (but rather long) VARCHAR fields. - Since all strings are "counted" in PHP3, this remains "binary safe". + Since all strings are "counted" in PHP, this remains "binary safe". It is up to you to handle this correctly. The returned data can contain anything, you are responsible for the contents. </para><para> Index: phpdoc/functions/mcrypt.sgml diff -u phpdoc/functions/mcrypt.sgml:1.1.1.1 phpdoc/functions/mcrypt.sgml:1.2 --- phpdoc/functions/mcrypt.sgml:1.1.1.1 Sun Jun 6 14:50:41 1999 +++ phpdoc/functions/mcrypt.sgml Sat Jun 19 18:12:06 1999 @@ -77,9 +77,10 @@ MCRYPT_ciphername. <para> - Here is a short list of ciphers which are currently supported by - PHP3/mcrypt. If a cipher is not listed here, but is listed by mcrypt as - supported, you can safely assume that this documentation is outdated. + Here is a short list of ciphers which are currently supported by the + mcrypt extension. If a cipher is not listed here, but is listed by + mcrypt as supported, you can safely assume that this documentation + is outdated. <itemizedlist> Index: phpdoc/functions/oci8.sgml diff -u phpdoc/functions/oci8.sgml:1.1.1.1 phpdoc/functions/oci8.sgml:1.2 --- phpdoc/functions/oci8.sgml:1.1.1.1 Sun Jun 6 14:50:53 1999 +++ phpdoc/functions/oci8.sgml Sat Jun 19 18:12:06 1999 @@ -4,14 +4,14 @@ <titleabbrev>OCI8</titleabbrev> <partintro> <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 driver. + 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. <simpara> - This driver is more flexible that the normal PHP3 Ora_ driver. It supports - binding of global and local PHP3 variables to Oracle placeholders, has - full LOB, FILE and ROWID support and allows you to use user-supplied define - variables. + 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. </partintro> <!-- Index: phpdoc/functions/oracle.sgml diff -u phpdoc/functions/oracle.sgml:1.1.1.1 phpdoc/functions/oracle.sgml:1.2 --- phpdoc/functions/oracle.sgml:1.1.1.1 Sun Jun 6 14:50:53 1999 +++ phpdoc/functions/oracle.sgml Sat Jun 19 18:12:06 1999 @@ -213,7 +213,7 @@ <title>Description</title> <funcsynopsis> <funcdef>string <function>Ora_Error</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> + <paramdef>int <parameter>cursor_or_connection</parameter></paramdef> </funcsynopsis> <para> Returns an error message of the form @@ -221,20 +221,18 @@ where <replaceable>XXX</replaceable> is where the error comes from and <replaceable>NNNNN</replaceable> identifies the error message. + <note> + <para>Support for connection ids was added in 3.0.4.</para> + </note> <para> - The <parameter>cursor</parameter> parameter can as of PHP 3. 0.6 - also be a connection id. - <para> On UNIX versions of Oracle, you can find details about an error - message like this: - <computeroutput> -<prompt>$</prompt> <userinput>oerr ora 00001</userinput> -00001, 00000, "unique constraint (%s.%s) violated" -// *Cause: An update or insert 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> + message like this: <computeroutput> +<prompt>$</prompt> <userinput>oerr ora <replaceable>00001</replaceable></userinput> 00001, 00000, +"unique constraint (%s.%s) violated" // *Cause: An update or insert +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> </refsect1> </refentry> @@ -249,15 +247,15 @@ <title>Description</title> <funcsynopsis> <funcdef>int <function>Ora_ErrorCode</function></funcdef> - <paramdef>int <parameter>cursor</parameter></paramdef> + <paramdef>int <parameter>cursor_or_connection</parameter></paramdef> </funcsynopsis> <para> Returns the numeric error code of the last executed statement on - the specified cursor. + the specified cursor or connection. <comment>FIXME: should possible values be listed?</comment> - <para> - The <parameter>cursor</parameter> parameter can as of PHP 3. 0.6 - also be a connection id. + <note> + <para>Support for connection ids was added in 3.0.4.</para> + </note> </refsect1> </refentry> Index: phpdoc/functions/pdf.sgml diff -u phpdoc/functions/pdf.sgml:1.3 phpdoc/functions/pdf.sgml:1.4 --- phpdoc/functions/pdf.sgml:1.3 Thu Jun 17 14:26:24 1999 +++ phpdoc/functions/pdf.sgml Sat Jun 19 18:12:06 1999 @@ -90,7 +90,7 @@ $fp = fopen("test.pdf", "w"); $info = PDF_get_info(); pdf_set_info_author($info, "Uwe Steinmann"); -PDF_set_info_title($info, "Test for PHP3 wrapper of PDFlib 0.6"); +PDF_set_info_title($info, "Test for PHP wrapper of PDFlib 0.6"); PDF_set_info_author($info, "Name of Author"); pdf_set_info_creator($info, "See Author"); pdf_set_info_subject($info, "Testing"); @@ -135,7 +135,7 @@ $fp = fopen("test.pdf", "w"); $pdf = PDF_open($fp); pdf_set_info_author($pdf, "Uwe Steinmann"); -PDF_set_info_title($pdf, "Test for PHP3 wrapper of PDFlib 2.0"); +PDF_set_info_title($pdf, "Test for PHP wrapper of PDFlib 2.0"); PDF_set_info_author($pdf, "Name of Author"); pdf_set_info_creator($pdf, "See Author"); pdf_set_info_subject($pdf, "Testing"); @@ -1686,9 +1686,9 @@ <simpara> Unfortunately pdflib does not make a copy of the string, which forces - PHP3 to allocate the memory. Currently this piece of memory is not + PHP to allocate the memory. Currently this piece of memory is not been freed by any PDF function but will be taken care of by the - PHP3 memory manager. + PHP memory manager. </refsect1> </refentry> Index: phpdoc/functions/pgsql.sgml diff -u phpdoc/functions/pgsql.sgml:1.3 phpdoc/functions/pgsql.sgml:1.4 --- phpdoc/functions/pgsql.sgml:1.3 Tue Jun 15 16:59:47 1999 +++ phpdoc/functions/pgsql.sgml Sat Jun 19 18:12:06 1999 @@ -236,10 +236,10 @@ return value of this function is an index to be used to access the results from other PostgreSQL functions. <note><simpara> - PHP2 returned 1 if the query was not expected to return data + PHP/FI returned 1 if the query was not expected to return data (inserts or updates, for example) and greater than 1 even on selects that did not return anything. No such assumption can be - made in PHP3. + made in PHP. </simpara></note> </refsect1> </refentry> Index: phpdoc/functions/strings.sgml diff -u phpdoc/functions/strings.sgml:1.4 phpdoc/functions/strings.sgml:1.5 --- phpdoc/functions/strings.sgml:1.4 Fri Jun 18 18:10:07 1999 +++ phpdoc/functions/strings.sgml Sat Jun 19 18:12:06 1999 @@ -344,7 +344,7 @@ &lt;/head> &lt;!-- parsing stops here --> </programlisting></example> - (pay attention to line endings - PHP3 uses a native function to parse + (pay attention to line endings - PHP uses a native function to parse the input, so a Mac file won't work on Unix). <para> @@ -358,7 +358,7 @@ <para> Setting <parameter>use_include_path</parameter> to 1 will result - in PHP3 trying to open the file along the standard include path. + in PHP trying to open the file along the standard include path. </refsect1> </refentry> Index: phpdoc/functions/uodbc.sgml diff -u phpdoc/functions/uodbc.sgml:1.1.1.1 phpdoc/functions/uodbc.sgml:1.2 --- phpdoc/functions/uodbc.sgml:1.1.1.1 Sun Jun 6 14:50:57 1999 +++ phpdoc/functions/uodbc.sgml Sat Jun 19 18:12:06 1999 @@ -604,9 +604,8 @@ </simpara></note> <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 PHP3 - FAQ. + <function>odbc_connect</function> function. For more information + on persistent connections, refer to the PHP FAQ. </refsect1> </refentry>