From d449d9903f9a5fe905a638dbe8d76d5b4cd5d5e3 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Tue, 6 Feb 2007 01:46:48 +0000 Subject: [PATCH] ref.oracle: switch to new style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229089 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/oracle/functions/ora-bind.xml | 137 +++++++++++++++--- reference/oracle/functions/ora-close.xml | 31 +++- reference/oracle/functions/ora-columnname.xml | 44 +++++- reference/oracle/functions/ora-columnsize.xml | 44 +++++- reference/oracle/functions/ora-columntype.xml | 45 +++++- reference/oracle/functions/ora-commit.xml | 51 +++++-- reference/oracle/functions/ora-commitoff.xml | 46 ++++-- reference/oracle/functions/ora-commiton.xml | 44 ++++-- reference/oracle/functions/ora-do.xml | 58 ++++++-- reference/oracle/functions/ora-error.xml | 79 ++++++++-- reference/oracle/functions/ora-errorcode.xml | 60 +++++++- reference/oracle/functions/ora-exec.xml | 57 ++++++-- reference/oracle/functions/ora-fetch-into.xml | 78 ++++++++-- reference/oracle/functions/ora-fetch.xml | 44 +++++- reference/oracle/functions/ora-getcolumn.xml | 36 ++++- reference/oracle/functions/ora-logoff.xml | 51 +++++-- reference/oracle/functions/ora-logon.xml | 41 +++++- reference/oracle/functions/ora-numcols.xml | 52 +++++-- reference/oracle/functions/ora-numrows.xml | 33 ++++- reference/oracle/functions/ora-open.xml | 28 +++- reference/oracle/functions/ora-parse.xml | 63 ++++++-- reference/oracle/functions/ora-plogon.xml | 55 +++++-- reference/oracle/functions/ora-rollback.xml | 41 ++++-- 23 files changed, 1005 insertions(+), 213 deletions(-) diff --git a/reference/oracle/functions/ora-bind.xml b/reference/oracle/functions/ora-bind.xml index 08a0a516df..e1d58520a9 100644 --- a/reference/oracle/functions/ora-bind.xml +++ b/reference/oracle/functions/ora-bind.xml @@ -1,40 +1,142 @@ - - + ora_bind Binds a PHP variable to an Oracle parameter - - Description + + + &reftitle.description; boolora_bind resourcecursor - stringPHP_variable_name - stringSQL_parameter_name + stringphpvar + stringsqlparam 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. + Binds the named PHP variable with a SQL parameter. + + 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. + + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + phpvar + + + The PHP variable to be bound. + + + + + sqlparam + + + The SQL parameter. Must be in the form :name. + + + + + length + + + + + + + type + + + Defines the type of the parameter. It defaults to + ORA_BIND_INOUT. Possible values are listed below: + + + + + Constant + Value + + + + + ORA_BIND_INOUT + 0 + + + ORA_BIND_IN + 1 + + + ORA_BIND_OUT + 2 + + + + + + + + + + + + + &reftitle.returnvalues; &return.success; Details about the error can be retrieved using the ora_error and ora_errorcode functions. + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 3.0.1 + + The constants for the type were added. + In previous versions, you should use the numerical values. + + + + + + + + + + &reftitle.examples; - 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 @@ -53,6 +155,7 @@ + - + ora_close Closes an Oracle cursor - - Description + + + &reftitle.description; boolora_close resourcecursor - This function closes a data cursor opened with - ora_open. + Closes a data cursor. + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + + + + + &reftitle.returnvalues; &return.success; Details about the error can be retrieved using the ora_error and ora_errorcode diff --git a/reference/oracle/functions/ora-columnname.xml b/reference/oracle/functions/ora-columnname.xml index 33ff436343..41164040ca 100644 --- a/reference/oracle/functions/ora-columnname.xml +++ b/reference/oracle/functions/ora-columnname.xml @@ -1,23 +1,51 @@ - - + ora_columnname Gets the name of an Oracle result column - - Description + + + &reftitle.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. + Returns the name of the column on the cursor. + + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + column + + + The column number. First is 0. + + + + + + + + + &reftitle.returnvalues; + + Returns the name as a string. The returned name is in all uppercase letters. diff --git a/reference/oracle/functions/ora-columnsize.xml b/reference/oracle/functions/ora-columnsize.xml index ff19ea602f..51bb4fc7ec 100644 --- a/reference/oracle/functions/ora-columnsize.xml +++ b/reference/oracle/functions/ora-columnsize.xml @@ -1,22 +1,52 @@ - - + ora_columnsize Returns the size of an Oracle result column - - Description + + + &reftitle.description; intora_columnsize resourcecursor intcolumn - Returns the size of the Oracle column - column on the cursor - cursor. Column 0 is the first column. + Returns the size of a column on the + cursor. + + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + column + + + The column number. First is 0. + + + + + + + + + &reftitle.returnvalues; + + Returns the size as an integer, or &false; on error. diff --git a/reference/oracle/functions/ora-columntype.xml b/reference/oracle/functions/ora-columntype.xml index d840d1c38f..a632314608 100644 --- a/reference/oracle/functions/ora-columntype.xml +++ b/reference/oracle/functions/ora-columntype.xml @@ -1,23 +1,52 @@ - - + ora_columntype Gets the type of an Oracle result column - - Description + + + &reftitle.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: + Returns the Oracle data type name of the column on + the cursor. + + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + column + + + The column number. First is 0. + + + + + + + + + &reftitle.returnvalues; + + The returned type will be one of the following strings: "VARCHAR2" "VARCHAR" diff --git a/reference/oracle/functions/ora-commit.xml b/reference/oracle/functions/ora-commit.xml index 0c7893e10b..e48b19de50 100644 --- a/reference/oracle/functions/ora-commit.xml +++ b/reference/oracle/functions/ora-commit.xml @@ -1,33 +1,62 @@ - - + ora_commit Commit an Oracle transaction - - Description + + + &reftitle.description; boolora_commit - resourceconn + resourceconnection - 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. + 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. + + + + + &reftitle.parameters; + + + + connection + + + A connection identifier, opened with ora_logon. + + + + + + + + + &reftitle.returnvalues; &return.success; Details about the error can be retrieved using the ora_error and ora_errorcode functions. + + + + &reftitle.seealso; - See also - ora_commiton and - ora_commitoff. + + ora_commiton + ora_commitoff + + - + ora_commitoff Disable automatic commit - - Description + + + &reftitle.description; boolora_commitoff - resourceconn + resourceconnection - This function turns off automatic commit after each - ora_exec on the given connection. + Turns off automatic commit after each ora_exec on the + given connection. + + + + &reftitle.parameters; + + + + connection + + + A connection identifier, opened with ora_logon. + + + + + + + + + &reftitle.returnvalues; &return.success; Details about the error can be retrieved using the ora_error and ora_errorcode functions. + + + + &reftitle.seealso; - See also - ora_commiton and - ora_commit. + + ora_commiton + ora_commit + + - + ora_commiton Enable automatic commit - - Description + + + &reftitle.description; boolora_commiton resourceconn - This function turns on automatic commit after each - ora_exec on the given connection. + Turns on automatic commit after each ora_exec on the + given connection. + + + + &reftitle.parameters; + + + + conn + + + A connection identifier, opened with ora_logon. + + + + + + + + + &reftitle.returnvalues; &return.success; Details about the error can be retrieved using the ora_error and ora_errorcode functions. + + + + &reftitle.seealso; - See also - ora_commitoff and - ora_commit. + + ora_commitoff + ora_commit + + - + ora_do Parse, Exec, Fetch - - Description + + + &reftitle.description; resourceora_do - resourceconn + resourceconnection 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. + Parse and execute a statement, then fetch the first result row. + + This function is a quick combination of ora_parse, + ora_exec and ora_fetch. + + + + + &reftitle.parameters; + + + + connection + + + A connection identifier, opened with ora_logon. + + + + + query + + + The SQL statement. + + + + + + + + + &reftitle.returnvalues; 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. + + + + &reftitle.seealso; - See also ora_parse,ora_exec, - and ora_fetch. + + ora_parse + ora_exec + ora_fetch + + - + ora_error Gets an Oracle error message - - Description + + + &reftitle.description; stringora_error resourcecursor_or_connection + + Returns the error message of the last executed statement on the + specified cursor or connection. + + + + + &reftitle.parameters; + + + + cursor_or_connection + + + An Oracle cursor or connection identifier. + + + + + + + + + &reftitle.returnvalues; Returns an error message of the form XXX-NNNNN @@ -19,25 +43,58 @@ from and NNNNN identifies the error message. + + + + &reftitle.changelog; - - Support for connection ids was added in 3.0.4. - + + + + + &Version; + &Description; + + + + + 3.0.4 + + Support for connection identifiers was added. + + + + + + + + + &reftitle.examples; On Unix versions of Oracle, you can find details about an error message like this: - -$ oerr ora -00001 00001, 00000, + + + oerr ora 00001 +]]> + + &example.outputs.similar; + + +]]> + + + - + ora_errorcode Gets an Oracle error code - - Description + + + &reftitle.description; intora_errorcode resourcecursor_or_connection @@ -15,12 +15,56 @@ 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. - + + + &reftitle.parameters; + + + + cursor_or_connection + + + An Oracle cursor or connection identifier. + + + + + + + + + &reftitle.returnvalues; + + Returns the error code, as an integer. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 3.0.4 + + Support for connection identifiers was added. + + + + + + + + - + ora_exec Execute a parsed statement on an Oracle cursor - - Description + + + &reftitle.description; boolora_exec resourcecursor - ora_exec execute the parsed statement - cursor, already parsed by ora_parse. + Executes the parsed statement cursor. - - &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. - + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, already parsed by ora_parse. + + + + + + + + + &reftitle.returnvalues; + + &return.success; Details about the error can be retrieved using the + ora_error and ora_errorcode + functions. + + + + + &reftitle.seealso; + + + ora_parse + ora_fetch + ora_do + + + + - + ora_fetch_into Fetch a row into the specified result array - - Description + + + &reftitle.description; intora_fetch_into resourcecursor @@ -15,15 +15,56 @@ 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. + Fetches a row of data into an array. + + + + &reftitle.parameters; - Returns the number of columns fetched. + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + result + + + An array passed by reference. It will be filled with the fetched + values. + + + + + flags + + + There are two possible flags. + If ORA_FETCHINTO_NULLS 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. + + + + + + + + &reftitle.returnvalues; + + Returns the number of columns fetched, or &false; on error. + + + + + &reftitle.examples; <function>ora_fetch_into</function> @@ -42,11 +83,20 @@ echo $results['MyColumn']; - - See also ora_parse,ora_exec, - ora_fetch, and ora_do. - + + + &reftitle.seealso; + + + ora_parse + ora_exec + ora_fetch + ora_do + + + + - + ora_fetch Fetch a row of data from a cursor - - Description + + + &reftitle.description; boolora_fetch resourcecursor @@ -15,6 +15,26 @@ Retrieves a row of data from the specified cursor. + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + + + + + &reftitle.returnvalues; Returns &true; (a row was fetched) or &false; (no more rows, or an error occurred). If an error occurred, details can be retrieved @@ -22,11 +42,19 @@ ora_errorcode functions. If there was no error, ora_errorcode will return 0. - - See also ora_parse,ora_exec, - and ora_do. - + + + &reftitle.seealso; + + + ora_parse + ora_exec + ora_do + + + + - + ora_getcolumn Get data from a fetched column - - Description + + + &reftitle.description; stringora_getcolumn resourcecursor @@ -16,6 +16,34 @@ Fetches the data for a column or function result. + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + column + + + The column number, as an integer. + + + + + + + + + &reftitle.returnvalues; Returns the column data. If an error occurs, &false; is returned and ora_errorcode diff --git a/reference/oracle/functions/ora-logoff.xml b/reference/oracle/functions/ora-logoff.xml index 8cd1c82152..730f0baa53 100644 --- a/reference/oracle/functions/ora-logoff.xml +++ b/reference/oracle/functions/ora-logoff.xml @@ -1,13 +1,13 @@ - - + ora_logoff Close an Oracle connection - - Description + + + &reftitle.description; boolora_logoff resourceconnection @@ -15,15 +15,42 @@ 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. - + + + &reftitle.parameters; + + + + connection + + + A connection identifier, opened with ora_logon. + + + + + + + + + &reftitle.returnvalues; + + &return.success; Details about the error can be retrieved using the + ora_error and ora_errorcode + functions. + + + + + &reftitle.seealso; + + + ora_logon + + + + - + ora_logon Open an Oracle connection - - Description + + + &reftitle.description; resourceora_logon stringuser stringpassword - Establishes a connection between PHP and an Oracle database with the - given username user and password password. + Establishes a connection between PHP and an Oracle database. Connections can be made using SQL*Net @@ -37,8 +36,36 @@ $conn = Ora_Logon("user@TNSNAME", "pass"); environment. For server modules, you should set it in the server's environment before starting the server. + + + + &reftitle.parameters; - Returns a connection index on success, or &false; on failure. + + + user + + + The user name. + + + + + password + + + The password associated with user. + + + + + + + + + &reftitle.returnvalues; + + Returns a connection identifier on success, or &false; on failure. Details about the error can be retrieved using the ora_error and ora_errorcode functions. diff --git a/reference/oracle/functions/ora-numcols.xml b/reference/oracle/functions/ora-numcols.xml index ad9b8c87e8..caffe06266 100644 --- a/reference/oracle/functions/ora-numcols.xml +++ b/reference/oracle/functions/ora-numcols.xml @@ -1,26 +1,58 @@ - - + ora_numcols Returns the number of columns - - Description + + + &reftitle.description; intora_numcols resourcecursor - ora_numcols returns the number of columns in a result. - Only returns meaningful values after an parse/exec/fetch sequence. + Returns the number of columns in a result. It only returns meaningful + values after a parse/exec/fetch sequence. - - See also ora_parse,ora_exec, - ora_fetch, and ora_do. - + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + + + + + &reftitle.returnvalues; + + Returns the number of columns as an integer, or &false; on error. + + + + + &reftitle.seealso; + + + ora_parse + ora_exec + ora_fetch + ora_do + + + + - + ora_numrows Returns the number of rows - - Description + + + &reftitle.description; intora_numrows resourcecursor - ora_numrows returns the number of rows in a result. + Returns the number of rows in a result. + + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + + + + + &reftitle.returnvalues; + + Returns the number of rows as an integer, or &false; on error. diff --git a/reference/oracle/functions/ora-open.xml b/reference/oracle/functions/ora-open.xml index 2ef6ddc111..08d355f533 100644 --- a/reference/oracle/functions/ora-open.xml +++ b/reference/oracle/functions/ora-open.xml @@ -1,13 +1,13 @@ - - + ora_open Opens an Oracle cursor - - Description + + + &reftitle.description; resourceora_open resourceconnection @@ -15,6 +15,26 @@ Opens an Oracle cursor associated with connection. + + + + &reftitle.parameters; + + + + connection + + + A connection identifier, opened with ora_logon. + + + + + + + + + &reftitle.returnvalues; Returns a cursor index or &false; on failure. Details about the error can be retrieved using the ora_error diff --git a/reference/oracle/functions/ora-parse.xml b/reference/oracle/functions/ora-parse.xml index fdd975a376..c3faae27d6 100644 --- a/reference/oracle/functions/ora-parse.xml +++ b/reference/oracle/functions/ora-parse.xml @@ -1,13 +1,13 @@ - - + ora_parse Parse an SQL statement with Oracle - - Description + + + &reftitle.description; boolora_parse resourcecursor @@ -15,17 +15,60 @@ intdefer - This function parses an SQL statement or a PL/SQL block and - associates it with the given cursor. + Parses an SQL statement or a PL/SQL block and associates it with the given + cursor. + + + + &reftitle.parameters; + + + + cursor + + + An Oracle cursor, opened with ora_open. + + + + + sql_statement + + + The SQL statement, or PL/SQL block. + + + + + defer + + + + + + + + + + + &reftitle.returnvalues; &return.success; - - See also ora_exec, - ora_fetch, and ora_do. - + + + &reftitle.seealso; + + + ora_exec + ora_fetch + ora_do + + + + - + ora_plogon Open a persistent Oracle connection - - Description + + + &reftitle.description; resourceora_plogon stringuser stringpassword - Establishes a persistent connection between PHP and an Oracle database with - the username user and password password. + Establishes a persistent connection between PHP and an Oracle database/ - - See also ora_logon. - + + + &reftitle.parameters; + + + + user + + + The user name. + + + + + password + + + The password associated with user. + + + + + + + + + &reftitle.returnvalues; + + Returns a persistent connection identifier, or &false; on error. + + + + + &reftitle.seealso; + + + ora_logon + + + + - + ora_rollback Rolls back a transaction - - Description + + + &reftitle.description; boolora_rollback resourceconnection - This function undoes an Oracle transaction. (See - ora_commit for the definition of a - transaction.) + Rollbacks an Oracle transaction. - &return.success; Details about the error - can be retrieved using the ora_error and - ora_errorcode functions. + See ora_commit for the definition of a transaction. + + + + + &reftitle.parameters; + + + + connection + + + A connection identifier, opened with ora_logon. + + + + + + + + + &reftitle.returnvalues; + + &return.success; Details about the error can be retrieved using the + ora_error and ora_errorcode + functions.