diff --git a/reference/ibase/functions/ibase-add-user.xml b/reference/ibase/functions/ibase-add-user.xml index 4ad71194c0..ae2b395048 100644 --- a/reference/ibase/functions/ibase-add-user.xml +++ b/reference/ibase/functions/ibase-add-user.xml @@ -1,12 +1,13 @@ - + ibase_add_user Add a user to a security database (only for IB6 or later) - - Description + + + &reftitle.description; boolibase_add_user resourceservice_handle @@ -16,7 +17,6 @@ stringmiddle_name stringlast_name - PHP 4 uses server, dba_user_name and @@ -24,13 +24,25 @@ service_handle parameter. &warn.undocumented.func; + + + &reftitle.returnvalues; - See also - ibase_modify_user and - ibase_delete_user. + &return.success; + + + &reftitle.seealso; + + + ibase_modify_user + ibase_delete_user + + + + + ibase_affected_rows Return the number of rows that were affected by the previous query - - Description + + + &reftitle.description; intibase_affected_rows resourcelink_identifier This function returns the number of rows that were affected by the - previous query (INSERT, UPDATE or DELETE) that was - executed from within the transaction context specified by link_identifier. - If link_identifier is a connection resource, its default transaction - is used. - - - See also - ibase_query and - ibase_execute. + previous query (INSERT, UPDATE or DELETE) that was executed from within + the specified transaction context. + + + &reftitle.parameters; + + + + link_identifier + + + A transaction context. If link_identifier is a + connection resource, its default transaction is used. + + + + + + + + + &reftitle.returnvalues; + + Returns the number of rows as an integer. + + + + + &reftitle.seealso; + + + ibase_query + ibase_execute + + + + + ibase_backup Initiates a backup task in the service manager and returns immediately - - Description + + + &reftitle.description; mixedibase_backup resourceservice_handle @@ -19,6 +20,7 @@ &warn.undocumented.func; + - + ibase_blob_add Add data into a newly created blob - - Description + + + &reftitle.description; voidibase_blob_add resourceblob_handle stringdata - ibase_blob_add adds data into a blob - created with ibase_blob_create. - Returns &null; on success or &false; on failure. - - - See also - ibase_blob_cancel, - ibase_blob_close, - ibase_blob_create and - ibase_blob_import. + ibase_blob_add adds data into a blob created with + ibase_blob_create. + + + &reftitle.parameters; + + + + blob_handle + + + A blob handle opened with ibase_blob_create. + + + + + data + + + The data to be added. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + ibase_blob_cancel + ibase_blob_close + ibase_blob_create + ibase_blob_import + + + + - + ibase_blob_cancel Cancel creating blob - - Description + + + &reftitle.description; boolibase_blob_cancel resourceblob_handle - This function will discard a BLOB created by ibase_create_blob - if it has not yet been closed by ibase_blob_close. - &return.success; - - - See also - ibase_blob_close, - ibase_blob_create and - ibase_blob_import. + This function will discard a BLOB if it has not yet been closed by + ibase_blob_close. + + + &reftitle.parameters; + + + + blob_handle + + + A BLOB handle opened with ibase_create_blob. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + ibase_blob_close + ibase_blob_create + ibase_blob_import + + + + - + ibase_blob_close Close blob - - Description + + + &reftitle.description; mixedibase_blob_close resourceblob_handle @@ -15,17 +15,47 @@ This function closes a BLOB that has either been opened for reading by ibase_open_blob or has been opened for writing by - ibase_create_blob. If the BLOB was being read, this function - returns &true; on success, if the BLOB was being written to, this function - returns a string containing the BLOB id that has been assigned to it by the database. - On failure, this function returns &false;. - - - See also - ibase_blob_cancel and - ibase_blob_open. + ibase_create_blob. + + + &reftitle.parameters; + + + + blob_handle + + + A BLOB handle opened with ibase_create_blob or + ibase_open_blob. + + + + + + + + + &reftitle.returnvalues; + + If the BLOB was being read, this function returns &true; on success, if + the BLOB was being written to, this function returns a string containing + the BLOB id that has been assigned to it by the database. On failure, this + function returns &false;. + + + + + &reftitle.seealso; + + + ibase_blob_cancel + ibase_blob_open + + + + - + ibase_blob_create Create a new blob for adding data - - Description + + + &reftitle.description; resourceibase_blob_create resourcelink_identifier - ibase_blob_create creates a new BLOB for - filling with data. It returns a BLOB handle for later use with - ibase_blob_add or &false; on failure. - - - See also - ibase_blob_add, - ibase_blob_cancel, - ibase_blob_close and - ibase_blob_import. + ibase_blob_create creates a new BLOB for filling with + data. + + + &reftitle.parameters; + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + + + + + &reftitle.returnvalues; + + Returns a BLOB handle for later use with + ibase_blob_add or &false; on failure. + + + + + &reftitle.seealso; + + + ibase_blob_add + ibase_blob_cancel + ibase_blob_close + ibase_blob_import + + + + - + ibase_blob_echo Output blob contents to browser - - Description - - boolibase_blob_echo - resourcelink_identifier - stringblob_id - + + + &reftitle.description; boolibase_blob_echo + resourcelink_identifier stringblob_id - This function opens a BLOB for reading and sends its contents directly - to standard output (the browser, in most cases). - &return.success; - - - See also - ibase_blob_open, - ibase_blob_close and - ibase_blob_get. + This function opens a BLOB for reading and sends its contents directly to + standard output (the browser, in most cases). + + + &reftitle.parameters; + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + blob_id + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + ibase_blob_open + ibase_blob_close + ibase_blob_get + + + + - + ibase_blob_get Get len bytes data from open blob - - Description + + + &reftitle.description; stringibase_blob_get resourceblob_handle @@ -16,23 +16,6 @@ This function returns at most len bytes from a BLOB that has been opened for reading by ibase_blob_open. - Returns &false; on failure. - - -BLOB_VALUE); - $blob_hndl = ibase_blob_open($data->BLOB_VALUE); - echo ibase_blob_get($blob_hndl, $blob_data[0]); -?> -]]> - - - Whilst this example doesn't do much more than a 'ibase_blob_echo($data->BLOB_VALUE)' would do, - it does show you how to get information into a $variable to manipulate as you please. @@ -40,13 +23,74 @@ by ibase_blob_create. + + + + &reftitle.parameters; - See also - ibase_blob_open, - ibase_blob_close and - ibase_blob_echo. + + + blob_handle + + + A BLOB handle opened with ibase_blob_open. + + + + + len + + + Size of returned data. + + + + + + + &reftitle.returnvalues; + + Returns at most len bytes from the BLOB, or &false; + on failure. + + + + + &reftitle.examples; + + + <function>ibase_blob_get</function> example + +BLOB_VALUE); +$blob_hndl = ibase_blob_open($data->BLOB_VALUE); +echo ibase_blob_get($blob_hndl, $blob_data[0]); +?> +]]> + + + Whilst this example doesn't do much more than a + 'ibase_blob_echo($data->BLOB_VALUE)' would do, it does show you how to get + information into a $variable to manipulate as you please. + + + + + &reftitle.seealso; + + + ibase_blob_open + ibase_blob_close + ibase_blob_echo + + + + - + ibase_blob_import Create blob, copy file in it, and close it - - Description + + + &reftitle.description; stringibase_blob_import resourcelink_identifier @@ -19,9 +19,44 @@ This function creates a BLOB, reads an entire file into it, closes it and - returns the assigned BLOB id. The file handle is a handle returned by - fopen. Returns &false; on failure. + returns the assigned BLOB id. + + + + &reftitle.parameters; + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + file_handle + + + The file handle is a handle returned by fopen. + + + + + + + + + &reftitle.returnvalues; + + Returns the BLOB id on success, or &false; on error. + + + + + &reftitle.examples; <function>ibase_blob_import</function> example @@ -54,14 +89,20 @@ if ($fd) { + + + + &reftitle.seealso; - See also - ibase_blob_add, - ibase_blob_cancel, - ibase_blob_close and - ibase_blob_create. + + ibase_blob_add + ibase_blob_cancel + ibase_blob_close + ibase_blob_create + + - + ibase_blob_info Return blob length and other useful info - - Description + + + &reftitle.description; arrayibase_blob_info resourcelink_identifier @@ -17,12 +17,45 @@ arrayibase_blob_info stringblob_id + + Returns the BLOB length and other useful information. + + + + + &reftitle.parameters; + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + blob_id + + + A BLOB id. + + + + + + + + + &reftitle.returnvalues; Returns an array containing information about a BLOB. The information returned consists of the length of the BLOB, the number of segments it contains, the size of the largest segment, and whether it is a stream BLOB or a segmented BLOB. + - + ibase_blob_open Open blob for retrieving data parts - - Description + + + &reftitle.description; resourceibase_blob_open resourcelink_identifier @@ -18,17 +18,54 @@ stringblob_id - ibase_blob_open opens an existing BLOB for - reading. It returns a BLOB handle for later use with - ibase_blob_get or &false; on failure. - - - See also - ibase_blob_close, - ibase_blob_echo and - ibase_blob_get. + Opens an existing BLOB for reading. + + + &reftitle.parameters; + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + blob_id + + + A BLOB id. + + + + + + + + + &reftitle.returnvalues; + + Returns a BLOB handle for later use with + ibase_blob_get or &false; on failure. + + + + + &reftitle.seealso; + + + ibase_blob_close + ibase_blob_echo + ibase_blob_get + + + + - + ibase_close Close a connection to an InterBase database - - Description + + + &reftitle.description; boolibase_close resourceconnection_id @@ -15,16 +15,46 @@ Closes the link to an InterBase database that's associated with a connection id returned from ibase_connect. - If the connection id is omitted, the last opened link is assumed. Default transaction on link is committed, other transactions are - rolled back. &return.success; - - - See also - ibase_connect and - ibase_pconnect. + rolled back. + + + &reftitle.parameters; + + + + connection_id + + + An InterBase link identifier returned from + ibase_connect. If omitted, the last opened link + is assumed. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + ibase_connect + ibase_pconnect + + + + + ibase_commit_ret Commit a transaction without closing it - - Description + + + &reftitle.description; boolibase_commit_ret resourcelink_or_trans_identifier - If called without an argument, this function commits the default transaction - of the default link. If the argument is a connection identifier, the default - transaction of the corresponding connection will be committed. If the argument - is a transaction identifier, the corresponding transaction will be committed. - The transaction context will be retained, so statements executed from within - this transaction will not be invalidated. + Commits a transaction without closing it. + + + + + &reftitle.parameters; + + + + link_or_trans_identifier + + + If called without an argument, this function commits the default + transaction of the default link. If the argument is a connection + identifier, the default transaction of the corresponding connection + will be committed. If the argument is a transaction identifier, the + corresponding transaction will be committed. The transaction context + will be retained, so statements executed from within this transaction + will not be invalidated. + + + + + + + + + &reftitle.returnvalues; + &return.success; + - + ibase_commit Commit a transaction - - Description + + + &reftitle.description; boolibase_commit resourcelink_or_trans_identifier - If called without an argument, this function commits the default transaction - of the default link. If the argument is a connection identifier, the default - transaction of the corresponding connection will be committed. If the argument - is a transaction identifier, the corresponding transaction will be committed. + Commits a transaction. + + + + + &reftitle.parameters; + + + + link_or_trans_identifier + + + If called without an argument, this function commits the default + transaction of the default link. If the argument is a connection + identifier, the default transaction of the corresponding connection + will be committed. If the argument is a transaction identifier, the + corresponding transaction will be committed. + + + + + + + + + &reftitle.returnvalues; + &return.success; + - + ibase_connect Open a connection to an InterBase database - - Description + + + &reftitle.description; resourceibase_connect stringdatabase @@ -21,80 +21,177 @@ Establishes a connection to an InterBase server. - The database argument - has to be a valid path to database file on the server it resides on. - If the server is not local, it must be prefixed with either - 'hostname:' (TCP/IP), '//hostname/' (NetBEUI) or 'hostname@' (IPX/SPX), - depending on the connection protocol used. username - and password can also - be specified with PHP configuration directives ibase.default_user and - ibase.default_password. charset is the default - character set for a database. buffers is the number - of database buffers to allocate for the server-side cache. If 0 or omitted, - server chooses its own default. dialect selects - the default SQL dialect for any statement executed within a connection, - and it defaults to the highest one supported by client libraries. - In case a second call is made to - ibase_connect with the same arguments, no new link - will be established, but instead, the link identifier of the already opened - link will be returned. 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 - ibase_close. + In case a second call is made to ibase_connect with + the same arguments, no new link will be established, but instead, the link + identifier of the already opened link will be returned. 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 ibase_close. + + + + + &reftitle.parameters; + + + + database + + + The database argument has to be a valid path to + database file on the server it resides on. If the server is not local, + it must be prefixed with either 'hostname:' (TCP/IP), '//hostname/' + (NetBEUI) or 'hostname@' (IPX/SPX), depending on the connection + protocol used. + + + + + username + + + The user name. Can be set with the + ibase.default_user &php.ini; directive. + + + + + password + + + The password for username. Can be set with the + ibase.default_password &php.ini; directive. + + + + + charset + + + charset is the default character set for a + database. + + + + + buffers + + + buffers is the number of database buffers to + allocate for the server-side cache. If 0 or omitted, server chooses + its own default. + + + + + dialect + + + dialect selects the default SQL dialect for any + statement executed within a connection, and it defaults to the highest + one supported by client libraries. Functional only with InterBase 6 + and up. + + + + + role + + + Functional only with InterBase 5 and up. + + + + + sync + + + + + + + + + + + &reftitle.returnvalues; + + Returns an InterBase link identifier on success, or &false; on error. + + + + + &reftitle.errors; + + If you get some error like "arithmetic exception, numeric overflow, or + string truncation. Cannot transliterate character between character sets" + (this occurs when you try use some character with accents) when using this + and after ibase_query you must set the character set + (i.e. ISO8859_1 or your current character set). + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.0.0 + + The buffers, dialect + and role parameters were added + + + + + + + + + + &reftitle.examples; + <function>ibase_connect</function> example email, "\n"; - } - ibase_free_result($sth); - ibase_close($dbh); +$dbh = ibase_connect($host, $username, $password); +$stmt = 'SELECT * FROM tblname'; +$sth = ibase_query($dbh, $stmt); +while ($row = ibase_fetch_object($sth)) { + echo $row->email, "\n"; +} +ibase_free_result($sth); +ibase_close($dbh); ?> ]]> - - - The optional buffers parameter was added in - PHP 4.0.0. - - - - - The optional dialect parameter was added in PHP - 4.0.0 and is functional only with InterBase 6 and up. - - - - - The optional role parameter was added in PHP - 4.0.0 and is functional only with InterBase 5 and up. - - - - - If you get some error like "arithmetic exception, numeric overflow, - or string truncation. Cannot transliterate character between character - sets" (this occurs when you try use some character with accents) - when using this and after ibase_query you must - set the character set (i.e. ISO8859_1 or your current character set). - - + + + + &reftitle.seealso; - See also - ibase_pconnect and - ibase_close. + + ibase_pconnect + ibase_close + + + ibase_db_info Request statistics about a database - - Description + + + &reftitle.description; stringibase_db_info resourceservice_handle @@ -18,6 +19,7 @@ &warn.undocumented.func; + + ibase_delete_user Delete a user from a security database (only for IB6 or later) - - Description + + + &reftitle.description; boolibase_delete_user resourceservice_handle @@ -21,12 +22,25 @@ &warn.undocumented.func; + + + + &reftitle.returnvalues; - See also - ibase_add_user and - ibase_modify_user. + &return.success; + + + &reftitle.seealso; + + + ibase_add_user + ibase_modify_user + + + + + ibase_drop_db Drops a database - - Description + + + &reftitle.description; boolibase_drop_db resourceconnection @@ -14,14 +15,43 @@ This functions drops a database that was opened by either ibase_connect or ibase_pconnect. The database is closed and deleted from the server. - &return.success; - - - See also - ibase_connect and - ibase_pconnect. + + + &reftitle.parameters; + + + + connection + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + ibase_connect + ibase_pconnect + + + + + ibase_errcode Return an error code - - Description + + + &reftitle.description; intibase_errcode Returns the error code that resulted from the most recent InterBase function - call. Returns &false; if no error occurred. - - - See also - ibase_errmsg. + call. + + + &reftitle.returnvalues; + + Returns the error code as an integer, or &false; if no error occured. + + + + + &reftitle.seealso; + + + ibase_errmsg + + + + - + ibase_errmsg Return error messages - - Description + + + &reftitle.description; stringibase_errmsg Returns the error message that resulted from the most recent InterBase function - call. Returns &false; if no error occurred. + call. + + + + &reftitle.returnvalues; - See also - ibase_errcode. + Returns the error message as a string, or &false; if no error occured. + + + &reftitle.seealso; + + + ibase_errcode + + + + - + ibase_execute Execute a previously prepared query - - Description + + + &reftitle.description; resourceibase_execute resourcequery @@ -15,17 +15,65 @@ mixed... - Execute a query prepared by ibase_prepare. If - the query raises an error, returns &false;. If it is successful and - there is a (possibly empty) result set (such as with a SELECT query), - returns a result identifier. If the query was successful and there were - no results, returns &true;. + Execute a query prepared by ibase_prepare. This is a lot more effective than using ibase_query if you are repeating a same kind of query several times with only some parameters changing. + + + + &reftitle.parameters; + + + + query + + + An InterBase query prepared by ibase_prepare. + + + + + bind_arg + + + + + + + ... + + + + + + + + + + + &reftitle.returnvalues; + + If the query raises an error, returns &false;. If it is successful and + there is a (possibly empty) result set (such as with a SELECT query), + returns a result identifier. If the query was successful and there were + no results, returns &true;. + + + + In PHP 5.0.0 and up, this function returns the number of rows affected by + the query (if > 0 and applicable to the statement type). A query that + succeeded, but did not affect any rows (e.g. an UPDATE of a non-existent + record) will return &true;. + + + + + + &reftitle.examples; <function>ibase_execute</function> example @@ -52,18 +100,17 @@ foreach ($updates as $baz => $bar) { - - - In PHP 5.0.0 and up, this function returns the number of rows affected by - the query (if > 0 and applicable to the statement type). A query that succeeded, - but did not affect any rows (e.g. an UPDATE of a non-existent record) will return - &true;. - - + + + + &reftitle.seealso; - See also ibase_query. + + ibase_query + + + ibase_fetch_assoc Fetch a result row from a query as an associative array - - Description + + + &reftitle.description; arrayibase_fetch_assoc resourceresult intfetch_flag - ibase_fetch_assoc returns an associative array - that corresponds to the fetched row. Subsequent calls will return - the next row in the result set, or &false; if there are no more - rows. + Fetch a result row from a query as an associative array. ibase_fetch_assoc fetches one row of data from the @@ -26,18 +24,56 @@ the result with numeric indices by using ibase_fetch_row or use alias names in your query. + + + + &reftitle.parameters; - fetch_flag is a combination of the constants IBASE_TEXT and IBASE_UNIXTIME - ORed together. Passing IBASE_TEXT will cause this function to return BLOB contents - instead of BLOB ids. Passing IBASE_UNIXTIME will cause this function to return - date/time values as Unix timestamps instead of as formatted strings. - - - See also - ibase_fetch_row and - ibase_fetch_object. + + + result + + + The result handle. + + + + + fetch_flag + + + fetch_flag is a combination of the constants + IBASE_TEXT and IBASE_UNIXTIME + ORed together. Passing IBASE_TEXT will cause this + function to return BLOB contents instead of BLOB ids. Passing + IBASE_UNIXTIME will cause this function to return + date/time values as Unix timestamps instead of as formatted strings. + + + + + + + &reftitle.returnvalues; + + Returns an associative array that corresponds to the fetched row. + Subsequent calls will return the next row in the result set, or &false; if + there are no more rows. + + + + + &reftitle.seealso; + + + ibase_fetch_row + ibase_fetch_object + + + + - + ibase_fetch_object Get an object from a InterBase database - - Description + + + &reftitle.description; objectibase_fetch_object resourceresult_id intfetch_flag - Fetches a row as a pseudo-object from a - result_id obtained either by - ibase_query or - ibase_execute. - - -email . "\n"; - } - ibase_close($dbh); -?> -]]> - - + Fetches a row as a pseudo-object from a given result identifier. Subsequent calls to ibase_fetch_object - return the next row in the result set, or &false; if there are no - more rows. - - - fetch_flag is a combination of the constants IBASE_TEXT and IBASE_UNIXTIME - ORed together. Passing IBASE_TEXT will cause this function to return BLOB contents - instead of BLOB ids. Passing IBASE_UNIXTIME will cause this function to return - date/time values as Unix timestamps instead of as formatted strings. - - - See also - ibase_fetch_row and - ibase_fetch_assoc. + return the next row in the result set. + + + &reftitle.parameters; + + + + result_id + + + An InterBase result identifier obtained either by + ibase_query or ibase_execute. + + + + + fetch_flag + + + fetch_flag is a combination of the constants + IBASE_TEXT and IBASE_UNIXTIME + ORed together. Passing IBASE_TEXT will cause this + function to return BLOB contents instead of BLOB ids. Passing + IBASE_UNIXTIME will cause this function to return + date/time values as Unix timestamps instead of as formatted strings. + + + + + + + + + &reftitle.returnvalues; + + Returns an object with the next row information, or &false; if there are + no more rows. + + + + + &reftitle.examples; + + + <function>ibase_fetch_object</function> example + +email . "\n"; +} +ibase_close($dbh); +?> +]]> + + + + + + + &reftitle.seealso; + + + ibase_fetch_row + ibase_fetch_assoc + + + + - + ibase_fetch_row Fetch a row from an InterBase database - - Description + + + &reftitle.description; arrayibase_fetch_row resourceresult_identifier intfetch_flag - Returns an array that corresponds to the fetched row, or &false; - if there are no more rows. - - - ibase_fetch_row fetches one row of data from - the result associated with the specified - result_identifier. The row is returned as - an array. Each result column is stored in an array offset, - starting at offset 0. + ibase_fetch_row fetches one row of data from the + given result set. Subsequent calls to ibase_fetch_row return the next row in the result set, or &false; if there are no more rows. + + + + &reftitle.parameters; - fetch_flag is a combination of the constants IBASE_TEXT and IBASE_UNIXTIME - ORed together. Passing IBASE_TEXT will cause this function to return BLOB contents - instead of BLOB ids. Passing IBASE_UNIXTIME will cause this function to return - date/time values as Unix timestamps instead of as formatted strings. - - - See also - ibase_fetch_assoc and - ibase_fetch_object. + + + result_identifier + + + An InterBase result identifier. + + + + + fetch_flag + + + fetch_flag is a combination of the constants + IBASE_TEXT and IBASE_UNIXTIME + ORed together. Passing IBASE_TEXT will cause this + function to return BLOB contents instead of BLOB ids. Passing + IBASE_UNIXTIME will cause this function to return + date/time values as Unix timestamps instead of as formatted strings. + + + + + + + &reftitle.returnvalues; + + Returns an array that corresponds to the fetched row, or &false; if there + are no more rows. Each result column is stored in an array offset, + starting at offset 0. + + + + + &reftitle.seealso; + + + ibase_fetch_assoc + ibase_fetch_object + + + + - + ibase_field_info Get information about a field - - Description + + + &reftitle.description; arrayibase_field_info resourceresult @@ -15,33 +15,77 @@ Returns an array with information about a field after a select - query has been run. The array is in the form of name, alias, - relation, length, type. + query has been run. + + + + &reftitle.parameters; - + + + result + + + An InterBase result identifier. + + + + + field_number + + + Field offset. + + + + + + + + + &reftitle.returnvalues; + + Returns an array with the following keys: name, + alias, relation, + length and type. + + + + + &reftitle.examples; + + + <function>ibase_field_info</function> example ]]> - - - - See also: ibase_num_fields. + + + + &reftitle.seealso; + + + ibase_num_fields + + + + + ibase_free_event_handler Cancels a registered event handler - - Description + + + &reftitle.description; boolibase_free_event_handler resourceevent This function causes the registered event handler specified by - event to be cancelled. The callback function - will no longer be called for the events it was registered to handle. - &return.success; - - - See also - ibase_set_event_handler. + event to be cancelled. The callback function will + no longer be called for the events it was registered to handle. + + + &reftitle.parameters; + + + + event + + + An event resource, created by + ibase_set_event_handler. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + ibase_set_event_handler + + + + - + ibase_free_query Free memory allocated by a prepared query - - Description + + + &reftitle.description; boolibase_free_query resourcequery - - Free a query prepared by ibase_prepare. - &return.success; - + + Frees a prepared query. + + + + &reftitle.parameters; + + + + query + + + A query prepared with ibase_prepare. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + - + ibase_free_result Free a result set - - Description + + + &reftitle.description; boolibase_free_result resourceresult_identifier - - Frees a result set that has been created by - ibase_query or ibase_execute. - &return.success; - + + Frees a result set. + + + + &reftitle.parameters; + + + + result_identifier + + + A result set created by ibase_query or + ibase_execute. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + ibase_gen_id Increments the named generator and returns its new value - - Description + + + &reftitle.description; mixedibase_gen_id stringgenerator @@ -16,11 +17,16 @@ &warn.undocumented.func; + + + + + &reftitle.returnvalues; Returns new generator value as integer, or as string if the value is too big. - + + ibase_maintain_db Execute a maintenance command on the database server - - Description + + + &reftitle.description; boolibase_maintain_db resourceservice_handle @@ -18,6 +19,14 @@ &warn.undocumented.func; + + + &reftitle.returnvalues; + + &return.success; + + + + ibase_modify_user Modify a user to a security database (only for IB6 or later) - - Description + + + &reftitle.description; boolibase_modify_user resourceservice_handle @@ -16,21 +17,32 @@ stringmiddle_name stringlast_name - + &warn.undocumented.func; PHP 4 uses server, dba_user_name and dba_user_password instead of service_handle parameter. - &warn.undocumented.func; + + + &reftitle.returnvalues; - See also - ibase_add_user and - ibase_delete_user. + &return.success; + + + &reftitle.seealso; + + + ibase_add_user + ibase_delete_user + + + + + ibase_name_result Assigns a name to a result set - - Description + + + &reftitle.description; boolibase_name_result resourceresult @@ -15,30 +16,73 @@ This function assigns a name to a result set. This name can be used later in UPDATE|DELETE ... WHERE CURRENT OF name statements. + + + + + &reftitle.parameters; + + + + result + + + An InterBase result set. + + + + + name + + + Tbe name to be assigned. + + + + + + + + + &reftitle.returnvalues; + &return.success; - + + + + + &reftitle.examples; + + + <function>ibase_name_result</function> example ]]> - - - - See also - ibase_prepare and - ibase_execute. + + + + &reftitle.seealso; + + + ibase_prepare + ibase_execute + + + + - + ibase_num_fields Get the number of fields in a result set - - Description + + + &reftitle.description; intibase_num_fields resourceresult_id - Returns an integer containing the number of fields in a result - set. - + Get the number of fields in a result set. + + + + + &reftitle.parameters; + + + + result_id + + + An InterBase result identifier. + + + + + + + + + &reftitle.returnvalues; + + Returns the number of fields as an integer. + + + + + &reftitle.examples; + + + <function>ibase_num_fields</function> example ]]> - - - - See also: ibase_field_info. + + + + &reftitle.seealso; + + + ibase_field_info + + + + + ibase_num_params Return the number of parameters in a prepared query - - Description + + + &reftitle.description; intibase_num_params resourcequery @@ -16,12 +17,41 @@ by query. This is the number of binding arguments that must be present when calling ibase_execute. + + + + &reftitle.parameters; - See also - ibase_prepare and - ibase_param_info. + + + query + + + The prepared query handle. + + + + + + + &reftitle.returnvalues; + + Returns the number of parameters as an integer. + + + + + &reftitle.seealso; + + + ibase_prepare + ibase_param_info + + + + + ibase_param_info Return information about a parameter in a prepared query - - Description + + + &reftitle.description; arrayibase_param_info resourcequery @@ -14,15 +15,53 @@ Returns an array with information about a parameter after a - query has been prepared. The array is in the form of name, alias, - relation, length, type. - - - See also - ibase_field_info and - ibase_num_params. + query has been prepared. + + + &reftitle.parameters; + + + + query + + + An InterBase prepared query handle. + + + + + param_number + + + Parameter offset. + + + + + + + + + &reftitle.returnvalues; + + Returns an array with the following keys: name, + alias, relation, + length and type. + + + + + &reftitle.seealso; + + + ibase_field_info + ibase_num_params + + + + - + ibase_pconnect Open a persistent connection to an InterBase database - - Description + + + &reftitle.description; resourceibase_pconnect stringdatabase @@ -19,42 +19,152 @@ stringrole intsync + + Opens a persistent connection to an InterBase database. + ibase_pconnect acts very much like ibase_connect with two major differences. - First, when connecting, the function will first try to find a - (persistent) link that's already opened with the same parameters. - If one is found, an identifier for it will be returned instead of - opening a new connection. Second, the connection to the InterBase - server will not be closed when the execution of the script ends. - Instead, the link will remain open for future use - (ibase_close will not close links established - by ibase_pconnect). This type of link is + + + First, when connecting, the function will first try to find a (persistent) + link that's already opened with the same parameters. If one is found, an + identifier for it will be returned instead of opening a new connection. + + + Second, the connection to the InterBase server will not be closed when the + execution of the script ends. Instead, the link will remain open for + future use (ibase_close will not close links + established by ibase_pconnect). This type of link is therefore called 'persistent'. - - - buffers was added in PHP 4.0.0. - - - - - dialect was added in PHP 4.0.0. It is - functional only with InterBase 6 and versions higher than that. - - - - - role was added in PHP 4.0.0. It is - functional only with InterBase 5 and versions higher than that. - - + + + + &reftitle.parameters; - See also ibase_close and - ibase_connect for the meaning of - parameters passed to this function. They are exactly the same. + + + database + + + The database argument has to be a valid path to + database file on the server it resides on. If the server is not local, + it must be prefixed with either 'hostname:' (TCP/IP), '//hostname/' + (NetBEUI) or 'hostname@' (IPX/SPX), depending on the connection + protocol used. + + + + + username + + + The user name. Can be set with the + ibase.default_user &php.ini; directive. + + + + + password + + + The password for username. Can be set with the + ibase.default_password &php.ini; directive. + + + + + charset + + + charset is the default character set for a + database. + + + + + buffers + + + buffers is the number of database buffers to + allocate for the server-side cache. If 0 or omitted, server chooses + its own default. + + + + + dialect + + + dialect selects the default SQL dialect for any + statement executed within a connection, and it defaults to the highest + one supported by client libraries. Functional only with InterBase 6 + and up. + + + + + role + + + Functional only with InterBase 5 and up. + + + + + sync + + + + + + + + + &reftitle.returnvalues; + + Returns an InterBase link identifier on success, or &false; on error. + + + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.0.0 + + The buffers, dialect + and role parameters were added + + + + + + + + + + &reftitle.seealso; + + + ibase_close + ibase_connect + + + + - + ibase_prepare Prepare a query for later binding of parameter placeholders and execution - - Description + + + &reftitle.description; resourceibase_prepare stringquery @@ -24,10 +24,34 @@ stringquery - Prepare a query for later binding of parameter placeholders and - execution (via ibase_execute). + Prepare a query for later binding of parameter placeholders and execution + (via ibase_execute). + + + &reftitle.parameters; + + + + query + + + An InterBase query. + + + + + + + + + &reftitle.returnvalues; + + Returns a prepared query handle, or &false; on error. + + + - + ibase_query Execute a query on an InterBase database - - Description + + + &reftitle.description; resourceibase_query resourcelink_identifier @@ -15,11 +15,73 @@ intbind_args - Performs a query on an InterBase database. If the query raises an error, - returns &false;. If it is successful and there is a (possibly empty) - result set (such as with a SELECT query), returns a result identifier. If - the query was successful and there were no results, returns &true;. + Performs a query on an InterBase database. + + + + &reftitle.parameters; + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + query + + + An InterBase query. + + + + + bind_args + + + + + + + + + + + &reftitle.returnvalues; + + If the query raises an error, returns &false;. If it is successful and + there is a (possibly empty) result set (such as with a SELECT query), + returns a result identifier. If the query was successful and there were + no results, returns &true;. + + + + In PHP 5.0.0 and up, this function will return the number of rows + affected by the query for INSERT, UPDATE and DELETE statements. In order + to retain backward compatibility, it will return &true; for these + statements if the query succeeded without affecting any rows. + + + + + + &reftitle.errors; + + If you get some error like "arithmetic exception, numeric overflow, or + string truncation. Cannot transliterate character between character sets" + (this occurs when you try use some character with accents) when using this + and after ibase_query you must set the character set + (i.e. ISO8859_1 or your current character set). + + + + + &reftitle.examples; <function>ibase_query</function> example @@ -27,42 +89,32 @@ ]]> - - - In PHP 5.0.0 and up, this function will return the number of rows affected by - the query for INSERT, UPDATE and DELETE statements. In order to retain backward - compatibility, it will return &true; for these statements if the query succeeded - without affecting any rows. - - - - - If you get some error like "arithmetic exception, numeric overflow, - or string truncation. Cannot transliterate character between character - sets" (this occurs when you try use some character with accents) - when using this and after ibase_query you must - set the character set (i.e. ISO8859_1 or your current character set). - - + + + + &reftitle.seealso; - See also ibase_errmsg, - ibase_fetch_row, - ibase_fetch_object, and - ibase_free_result. + + ibase_errmsg + ibase_fetch_row + ibase_fetch_object + ibase_free_result + + + ibase_restore Initiates a restore task in the service manager and returns immediately - - Description + + + &reftitle.description; mixedibase_restore resourceservice_handle @@ -19,6 +20,7 @@ &warn.undocumented.func; + + ibase_rollback_ret Roll back a transaction without closing it - - Description + + + &reftitle.description; boolibase_rollback_ret resourcelink_or_trans_identifier - If called without an argument, this function rolls back the default transaction - of the default link. If the argument is a connection identifier, the default - transaction of the corresponding connection will be rolled back. If the argument - is a transaction identifier, the corresponding transaction will be rolled back. - The transaction context will be retained, so statements executed from within - this transaction will not be invalidated. + Rolls back a transaction without closing it. + + + + + &reftitle.parameters; + + + + link_or_trans_identifier + + + If called without an argument, this function rolls back the default + transaction of the default link. If the argument is a connection + identifier, the default transaction of the corresponding connection + will be rolled back. If the argument is a transaction identifier, the + corresponding transaction will be rolled back. The transaction context + will be retained, so statements executed from within this transaction + will not be invalidated. + + + + + + + + + &reftitle.returnvalues; + &return.success; + - + ibase_rollback Roll back a transaction - - Description + + + &reftitle.description; boolibase_rollback resourcelink_or_trans_identifier - If called without an argument, this function rolls back the default transaction - of the default link. If the argument is a connection identifier, the default - transaction of the corresponding connection will be rolled back. If the argument - is a transaction identifier, the corresponding transaction will be rolled back. + Rolls back a transaction. + + + + + &reftitle.parameters; + + + + link_or_trans_identifier + + + If called without an argument, this function rolls back the default + transaction of the default link. If the argument is a connection + identifier, the default transaction of the corresponding connection + will be rolled back. If the argument is a transaction identifier, the + corresponding transaction will be rolled back. + + + + + + + + + &reftitle.returnvalues; + &return.success; + + ibase_server_info Request information about a database server - - Description + + + &reftitle.description; stringibase_server_info resourceservice_handle @@ -16,6 +17,7 @@ &warn.undocumented.func; + + ibase_service_attach Connect to the service manager - - Description + + + &reftitle.description; resourceibase_service_attach stringhost @@ -17,6 +18,7 @@ &warn.undocumented.func; + + ibase_service_detach Disconnect from the service manager - - Description + + + &reftitle.description; boolibase_service_detach resourceservice_handle @@ -15,6 +16,14 @@ &warn.undocumented.func; + + + &reftitle.returnvalues; + + &return.success; + + + + ibase_set_event_handler Register a callback function to be called when events are posted - - Description + + + &reftitle.description; resourceibase_set_event_handler callbackevent_handler @@ -23,24 +24,79 @@ string... - This function registers a PHP user function as event handler for the specified - events. The callback is called with the event name and the link resource as arguments - whenever one of the specified events is posted by the database. The callback must - return &false; if the event handler should be canceled. Any other return value is ignored. - This function accepts up to 15 event arguments. + This function registers a PHP user function as event handler for the + specified events. + + + + &reftitle.parameters; - + + + event_handler + + + The callback is called with the event name and the link resource as + arguments whenever one of the specified events is posted by the + database. + + + The callback must return &false; if the event handler should be + canceled. Any other return value is ignored. This function accepts up + to 15 event arguments. + + + + + event_name1 + + + An event name. + + + + + event_name2 + + + + + + + ... + + + + + + + + + + + &reftitle.returnvalues; + + The return value is an event resource. This resource can be used to free + the event handler using ibase_free_event_handler. + + + + + &reftitle.examples; + + + <function>ibase_set_event_handler</function> example ]]> - - - - The return value is an event resource. This resource can be used to free the event handler - using ibase_free_event_handler. - - - See also - ibase_free_event_handler and - ibase_wait_event. + + + + &reftitle.seealso; + + + ibase_free_event_handler + ibase_wait_event + + + + - + ibase_timefmt Sets the format of timestamp, date and time type columns returned from queries - - Description + + + &reftitle.description; - intibase_timefmt + boolibase_timefmt stringformat intcolumntype - Sets the format of timestamp, date or time type columns returned - from queries. Internally, the columns are formatted by c-function - strftime(), so refer to its documentation regarding to the format - of the string. columntype is one of the - constants IBASE_TIMESTAMP, IBASE_DATE and IBASE_TIME. If omitted, - defaults to IBASE_TIMESTAMP for backwards compatibility. - - - - - -]]> - - + Sets the format of timestamp, date or time type columns returned from + queries. You can set defaults for these formats with the PHP configuration - directives ibase.timestampformat, ibase.dateformat and ibase.timeformat. + directives ibase.timestampformat, + ibase.dateformat and + ibase.timeformat. - This function has been removed from PHP 5, use ini_set instead. + This function has been removed from PHP 5, use + ini_set instead. + + + &reftitle.parameters; + + + + format + + + Internally, the columns are formatted by c-function strftime(), so + refer to its documentation regarding to the format of the string. + + + + + columntype + + + columntype is one of the constants + IBASE_TIMESTAMP, IBASE_DATE + and IBASE_TIME. If omitted, defaults to + IBASE_TIMESTAMP for backwards compatibility. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + + <function>ibase_timefmt</function> example + + +]]> + + + + + - + ibase_trans Begin a transaction - - Description + + + &reftitle.description; resourceibase_trans inttrans_args @@ -16,12 +16,6 @@ Begins a transaction. - - trans_args can be a combination of - IBASE_READ, IBASE_WRITE, IBASE_COMMITTED, IBASE_CONSISTENCY, - IBASE_CONCURRENCY, IBASE_REC_VERSION, IBASE_REC_NO_VERSION, - IBASE_WAIT and IBASE_NOWAIT. - The behaviour of this function has been changed in PHP 5.0.0. The first call @@ -48,6 +42,48 @@ + + + &reftitle.parameters; + + + + trans_args + + + trans_args can be a combination of + IBASE_READ, + IBASE_WRITE, + IBASE_COMMITTED, + IBASE_CONSISTENCY, + IBASE_CONCURRENCY, + IBASE_REC_VERSION, + IBASE_REC_NO_VERSION, + IBASE_WAIT and + IBASE_NOWAIT. + + + + + link_identifier + + + An InterBase link identifier. If omitted, the last opened link is + assumed. + + + + + + + + + &reftitle.returnvalues; + + Returns a transaction handle, or &false; on error. + + + + ibase_wait_event Wait for an event to be posted by the database - - Description + + + &reftitle.description; stringibase_wait_event stringevent_name1 @@ -25,12 +26,55 @@ is posted by the database. The name of the event that was posted is returned. This function accepts up to 15 event arguments. + + + + &reftitle.parameters; - See also - ibase_set_event_handler and - ibase_free_event_handler. + + + event_name1 + + + The event name. + + + + + event_name2 + + + + + + + ... + + + + + + + + + &reftitle.returnvalues; + + Returns the name of the event that was posted. + + + + + &reftitle.seealso; + + + ibase_set_event_handler + ibase_free_event_handler + + + +