From 8cdd8ed9a4800c3a9089dcfbf9195726921bf563 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Tue, 6 Feb 2007 01:46:33 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229088 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/oracle/functions/ora-bind.xml | 86 +++++++++---------- reference/oracle/functions/ora-close.xml | 46 +++++----- reference/oracle/functions/ora-columnname.xml | 42 ++++----- reference/oracle/functions/ora-columnsize.xml | 40 ++++----- reference/oracle/functions/ora-columntype.xml | 64 +++++++------- reference/oracle/functions/ora-commit.xml | 58 ++++++------- reference/oracle/functions/ora-commitoff.xml | 56 ++++++------ reference/oracle/functions/ora-commiton.xml | 56 ++++++------ reference/oracle/functions/ora-do.xml | 58 ++++++------- reference/oracle/functions/ora-error.xml | 64 +++++++------- reference/oracle/functions/ora-errorcode.xml | 44 +++++----- reference/oracle/functions/ora-exec.xml | 54 ++++++------ reference/oracle/functions/ora-fetch-into.xml | 74 ++++++++-------- reference/oracle/functions/ora-fetch.xml | 56 ++++++------ reference/oracle/functions/ora-getcolumn.xml | 52 +++++------ reference/oracle/functions/ora-logoff.xml | 50 +++++------ reference/oracle/functions/ora-logon.xml | 80 ++++++++--------- reference/oracle/functions/ora-numcols.xml | 44 +++++----- reference/oracle/functions/ora-numrows.xml | 34 ++++---- reference/oracle/functions/ora-open.xml | 44 +++++----- reference/oracle/functions/ora-parse.xml | 54 ++++++------ reference/oracle/functions/ora-plogon.xml | 46 +++++----- reference/oracle/functions/ora-rollback.xml | 48 +++++------ 23 files changed, 624 insertions(+), 626 deletions(-) diff --git a/reference/oracle/functions/ora-bind.xml b/reference/oracle/functions/ora-bind.xml index 02671c8efb..08a0a516df 100644 --- a/reference/oracle/functions/ora-bind.xml +++ b/reference/oracle/functions/ora-bind.xml @@ -1,43 +1,43 @@ - + - - - ora_bind - Binds a PHP variable to an Oracle parameter - - - Description - - boolora_bind - resourcecursor - stringPHP_variable_name - stringSQL_parameter_name - intlength - inttype - - - This function binds the named PHP variable with a SQL parameter. - The SQL parameter must be in the form ":name". With the optional - 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. - - - &return.success; Details about the error can be retrieved using the - ora_error and ora_errorcode - functions. - - - ora_bind must be called after ora_parse - and before ora_exec. Input values can be given - by assignment to the bound PHP variables, after calling - ora_exec the bound PHP variables contain the output - values if available. - - <function>ora_bind</function> example - + + + ora_bind + Binds a PHP variable to an Oracle parameter + + + Description + + boolora_bind + resourcecursor + stringPHP_variable_name + stringSQL_parameter_name + intlength + inttype + + + This function binds the named PHP variable with a SQL parameter. + The SQL parameter must be in the form ":name". With the optional + 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. + + + &return.success; Details about the error can be retrieved using the + ora_error and ora_errorcode + functions. + + + ora_bind must be called after ora_parse + and before ora_exec. Input values can be given + by assignment to the bound PHP variables, after calling + ora_exec the bound PHP variables contain the output + values if available. + + <function>ora_bind</function> example + Out: $output
In: $input"; ?> ]]> - - - - - + + + + + + - - - ora_close - Closes an Oracle cursor - - - Description - - boolora_close - resourcecursor - - - This function closes a data cursor opened with - ora_open. - - - &return.success; Details about the error can be retrieved using the - ora_error and ora_errorcode - functions. - - - + + + ora_close + Closes an Oracle cursor + + + Description + + boolora_close + resourcecursor + + + This function closes a data cursor opened with + ora_open. + + + &return.success; Details about the error can be retrieved using the + ora_error and ora_errorcode + functions. + + + + - - - ora_columnname - Gets the name of an Oracle result column - - - Description - - stringora_columnname - resourcecursor - intcolumn - - - Returns the name of the field/column - column on the cursor - cursor. The returned name is in all - uppercase letters. Column 0 is the first column. - - - + + + ora_columnname + Gets the name of an Oracle result column + + + Description + + stringora_columnname + resourcecursor + intcolumn + + + Returns the name of the field/column + column on the cursor + cursor. The returned name is in all + uppercase letters. Column 0 is the first column. + + + + - - - ora_columnsize - Returns the size of an Oracle result column - - - Description - - intora_columnsize - resourcecursor - intcolumn - - - Returns the size of the Oracle column - column on the cursor - cursor. Column 0 is the first column. - - - + + + ora_columnsize + Returns the size of an Oracle result column + + + Description + + intora_columnsize + resourcecursor + intcolumn + + + Returns the size of the Oracle column + column on the cursor + cursor. Column 0 is the first column. + + + + - - - ora_columntype - Gets the type of an Oracle result column - - - Description - - stringora_columntype - resourcecursor - intcolumn - - - Returns the Oracle data type name of the field/column - column on the cursor - cursor. Column 0 is the first column. The returned - type will be one of the following: - - "VARCHAR2" - "VARCHAR" - "CHAR" - "NUMBER" - "LONG" - "LONG RAW" - "ROWID" - "DATE" - "CURSOR" - - - - + + + ora_columntype + Gets the type of an Oracle result column + + + Description + + stringora_columntype + resourcecursor + intcolumn + + + Returns the Oracle data type name of the field/column + column on the cursor + cursor. Column 0 is the first column. The returned + type will be one of the following: + + "VARCHAR2" + "VARCHAR" + "CHAR" + "NUMBER" + "LONG" + "LONG RAW" + "ROWID" + "DATE" + "CURSOR" + + + + + - - - ora_commit - Commit an Oracle transaction - - - Description - - boolora_commit - resourceconn - - - 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. - - - &return.success; Details about the - error can be retrieved using the ora_error - and ora_errorcode functions. - - - See also - ora_commiton and - ora_commitoff. - - - + + + ora_commit + Commit an Oracle transaction + + + Description + + boolora_commit + resourceconn + + + 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. + + + &return.success; Details about the + error can be retrieved using the ora_error + and ora_errorcode functions. + + + See also + ora_commiton and + ora_commitoff. + + + + - - - ora_commitoff - Disable automatic commit - - - Description - - boolora_commitoff - resourceconn - - - This function turns off automatic commit after each - ora_exec on the given connection. - - - &return.success; Details about the error - can be retrieved using the ora_error and - ora_errorcode functions. - - - See also - ora_commiton and - ora_commit. - - - + + + ora_commitoff + Disable automatic commit + + + Description + + boolora_commitoff + resourceconn + + + This function turns off automatic commit after each + ora_exec on the given connection. + + + &return.success; Details about the error + can be retrieved using the ora_error and + ora_errorcode functions. + + + See also + ora_commiton and + ora_commit. + + + + - - - ora_commiton - Enable automatic commit - - - Description - - boolora_commiton - resourceconn - - - This function turns on automatic commit after each - ora_exec on the given connection. - - - &return.success; Details about the error - can be retrieved using the ora_error and - ora_errorcode functions. - - - See also - ora_commitoff and - ora_commit. - - - + + + ora_commiton + Enable automatic commit + + + Description + + boolora_commiton + resourceconn + + + This function turns on automatic commit after each + ora_exec on the given connection. + + + &return.success; Details about the error + can be retrieved using the ora_error and + ora_errorcode functions. + + + See also + ora_commitoff and + ora_commit. + + + + - - - ora_do - Parse, Exec, Fetch - - - Description - - resourceora_do - resourceconn - stringquery - - - ora_do is quick combination of ora_parse, - ora_exec and ora_fetch. - It will parse and execute a statement, then fetch the first result row. - - - This function returns a cursor index or &false; on failure. Details - about the error can be retrieved using the ora_error - and ora_errorcode functions. - - - See also ora_parse,ora_exec, - and ora_fetch. - - - + + + ora_do + Parse, Exec, Fetch + + + Description + + resourceora_do + resourceconn + stringquery + + + ora_do is quick combination of ora_parse, + ora_exec and ora_fetch. + It will parse and execute a statement, then fetch the first result row. + + + This function returns a cursor index or &false; on failure. Details + about the error can be retrieved using the ora_error + and ora_errorcode functions. + + + See also ora_parse,ora_exec, + and ora_fetch. + + + + - - - ora_error - Gets an Oracle error message - - - Description - - stringora_error - resourcecursor_or_connection - - - Returns an error message of the form - XXX-NNNNN - where XXX is where the error comes - from and NNNNN identifies the error - message. - - - - Support for connection ids was added in 3.0.4. - - - - On Unix versions of Oracle, you can find details about an error - message like this: - + + + ora_error + Gets an Oracle error message + + + Description + + stringora_error + resourcecursor_or_connection + + + Returns an error message of the form + XXX-NNNNN + where XXX is where the error comes + from and NNNNN identifies the error + message. + + + + Support for connection ids was added in 3.0.4. + + + + On Unix versions of Oracle, you can find details about an error + message like this: + $ oerr ora 00001 00001, 00000, "unique constraint (%s.%s) violated" // *Cause: An update or insert @@ -35,10 +35,10 @@ 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 - - - - + + + + + - - - ora_errorcode - Gets an Oracle error code - - - Description - - intora_errorcode - resourcecursor_or_connection - - - Returns the numeric error code of the last executed statement on - the specified cursor or connection. - - - Support for connection ids was added in 3.0.4. - - - - + + + ora_errorcode + Gets an Oracle error code + + + Description + + intora_errorcode + resourcecursor_or_connection + + + Returns the numeric error code of the last executed statement on + the specified cursor or connection. + + + Support for connection ids was added in 3.0.4. + + + + + - - - ora_exec - Execute a parsed statement on an Oracle cursor - - - Description - - boolora_exec - resourcecursor - - - ora_exec execute the parsed statement - cursor, already parsed by ora_parse. - - - &return.success; Details about the error - can be retrieved using the ora_error and - ora_errorcode functions. - - - See also ora_parse, - ora_fetch, and ora_do. - - - + + + ora_exec + Execute a parsed statement on an Oracle cursor + + + Description + + boolora_exec + resourcecursor + + + ora_exec execute the parsed statement + cursor, already parsed by ora_parse. + + + &return.success; Details about the error + can be retrieved using the ora_error and + ora_errorcode functions. + + + See also ora_parse, + ora_fetch, and ora_do. + + + + - - - ora_fetch_into - Fetch a row into the specified result array - - - Description - - intora_fetch_into - resourcecursor - arrayresult - intflags - - - Fetches a row of data into an array. The flags - has two flag values: if the ORA_FETCHINTO_NULLS - flag is set, columns with NULL values are set - in the array; and if the ORA_FETCHINTO_ASSOC - flag is set, an associative array is created. - - - Returns the number of columns fetched. - - - - <function>ora_fetch_into</function> - + + + ora_fetch_into + Fetch a row into the specified result array + + + Description + + intora_fetch_into + resourcecursor + arrayresult + intflags + + + Fetches a row of data into an array. The flags + has two flag values: if the ORA_FETCHINTO_NULLS + flag is set, columns with NULL values are set + in the array; and if the ORA_FETCHINTO_ASSOC + flag is set, an associative array is created. + + + Returns the number of columns fetched. + + + + <function>ora_fetch_into</function> + ]]> - - - - - See also ora_parse,ora_exec, - ora_fetch, and ora_do. - - - + + + + + See also ora_parse,ora_exec, + ora_fetch, and ora_do. + + + + - - - ora_fetch - Fetch a row of data from a cursor - - - Description - - boolora_fetch - resourcecursor - - - Retrieves a row of data from the specified cursor. - - - Returns &true; (a row was fetched) or &false; (no more rows, or an - error occurred). If an error occurred, details can be retrieved - using the ora_error and - ora_errorcode functions. If there was no - error, ora_errorcode will return 0. - - - See also ora_parse,ora_exec, - and ora_do. - - - + + + ora_fetch + Fetch a row of data from a cursor + + + Description + + boolora_fetch + resourcecursor + + + Retrieves a row of data from the specified cursor. + + + Returns &true; (a row was fetched) or &false; (no more rows, or an + error occurred). If an error occurred, details can be retrieved + using the ora_error and + ora_errorcode functions. If there was no + error, ora_errorcode will return 0. + + + See also ora_parse,ora_exec, + and ora_do. + + + + - - - ora_getcolumn - Get data from a fetched column - - - Description - - stringora_getcolumn - resourcecursor - intcolumn - - - Fetches the data for a column or function result. - - - Returns the column data. If an error occurs, &false; is returned - and ora_errorcode - will return a non-zero value. Note, however, that a test for &false; - 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"). - - - + + + ora_getcolumn + Get data from a fetched column + + + Description + + stringora_getcolumn + resourcecursor + intcolumn + + + Fetches the data for a column or function result. + + + Returns the column data. If an error occurs, &false; is returned + and ora_errorcode + will return a non-zero value. Note, however, that a test for &false; + 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"). + + + + - - - ora_logoff - Close an Oracle connection - - - Description - - boolora_logoff - resourceconnection - - - Logs out the user and disconnects from the server. - - - &return.success; Details about the error - can be retrieved using the ora_error and - ora_errorcode functions. - - - See also ora_logon. - - - + + + ora_logoff + Close an Oracle connection + + + Description + + boolora_logoff + resourceconnection + + + Logs out the user and disconnects from the server. + + + &return.success; Details about the error + can be retrieved using the ora_error and + ora_errorcode functions. + + + See also ora_logon. + + + + - - - ora_logon - Open an Oracle connection - - - Description - - resourceora_logon - stringuser - stringpassword - - - Establishes a connection between PHP and an Oracle database with the - given username user and password password. - - - Connections can be made using SQL*Net - by supplying the TNS name to - user like this: - - + + + ora_logon + Open an Oracle connection + + + Description + + resourceora_logon + stringuser + stringpassword + + + Establishes a connection between PHP and an Oracle database with the + given username user and password password. + + + Connections can be made using SQL*Net + by supplying the TNS name to + user like this: + + ]]> - - - - - If you have character data with non-ASCII characters, you should - make sure that NLS_LANG is set in your - environment. For server modules, you should set it in the - server's environment before starting the server. - - - Returns a connection index on success, or &false; on failure. - Details about the error can be retrieved using the - ora_error and ora_errorcode - functions. - - - + + + + + If you have character data with non-ASCII characters, you should + make sure that NLS_LANG is set in your + environment. For server modules, you should set it in the + server's environment before starting the server. + + + Returns a connection index on success, or &false; on failure. + Details about the error can be retrieved using the + ora_error and ora_errorcode + functions. + + + + - - - ora_numcols - Returns the number of columns - - - Description - - intora_numcols - resourcecursor - - - ora_numcols returns the number of columns in a result. - Only returns meaningful values after an parse/exec/fetch sequence. - - - See also ora_parse,ora_exec, - ora_fetch, and ora_do. - - - + + + ora_numcols + Returns the number of columns + + + Description + + intora_numcols + resourcecursor + + + ora_numcols returns the number of columns in a result. + Only returns meaningful values after an parse/exec/fetch sequence. + + + See also ora_parse,ora_exec, + ora_fetch, and ora_do. + + + + - - - ora_numrows - Returns the number of rows - - - Description - - intora_numrows - resourcecursor - - - ora_numrows returns the number of rows in a result. - - - + + + ora_numrows + Returns the number of rows + + + Description + + intora_numrows + resourcecursor + + + ora_numrows returns the number of rows in a result. + + + + - - - ora_open - Opens an Oracle cursor - - - Description - - resourceora_open - resourceconnection - - - Opens an Oracle cursor associated with connection. - - - Returns a cursor index or &false; on failure. Details about the - error can be retrieved using the ora_error - and ora_errorcode functions. - - - + + + ora_open + Opens an Oracle cursor + + + Description + + resourceora_open + resourceconnection + + + Opens an Oracle cursor associated with connection. + + + Returns a cursor index or &false; on failure. Details about the + error can be retrieved using the ora_error + and ora_errorcode functions. + + + + - - - ora_parse - Parse an SQL statement with Oracle - - - Description - - boolora_parse - resourcecursor - stringsql_statement - intdefer - - - This function parses an SQL statement or a PL/SQL block and - associates it with the given cursor. - - - &return.success; - - - See also ora_exec, - ora_fetch, and ora_do. - - - + + + ora_parse + Parse an SQL statement with Oracle + + + Description + + boolora_parse + resourcecursor + stringsql_statement + intdefer + + + This function parses an SQL statement or a PL/SQL block and + associates it with the given cursor. + + + &return.success; + + + See also ora_exec, + ora_fetch, and ora_do. + + + + - - - ora_plogon - - Open a persistent Oracle connection - - - - Description - - resourceora_plogon - stringuser - stringpassword - - - Establishes a persistent connection between PHP and an Oracle database with - the username user and password password. - - - See also ora_logon. - - - + + + ora_plogon + Open a persistent Oracle connection + + + Description + + resourceora_plogon + stringuser + stringpassword + + + Establishes a persistent connection between PHP and an Oracle database with + the username user and password password. + + + See also ora_logon. + + + + - - - ora_rollback - Rolls back a transaction - - - Description - - boolora_rollback - resourceconnection - - - This function undoes an Oracle transaction. (See - ora_commit for the definition of a - transaction.) - - - &return.success; Details about the error - can be retrieved using the ora_error and - ora_errorcode functions. - - - + + + ora_rollback + Rolls back a transaction + + + Description + + boolora_rollback + resourceconnection + + + This function undoes an Oracle transaction. (See + ora_commit for the definition of a + transaction.) + + + &return.success; Details about the error + can be retrieved using the ora_error and + ora_errorcode functions. + + +