diff --git a/reference/ibase/functions/ibase-add-user.xml b/reference/ibase/functions/ibase-add-user.xml index 52529b1751..4ad71194c0 100644 --- a/reference/ibase/functions/ibase-add-user.xml +++ b/reference/ibase/functions/ibase-add-user.xml @@ -1,39 +1,37 @@ - - - - ibase_add_user - - Add a user to a security database (only for IB6 or later) - - - - Description - - boolibase_add_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - + + + + ibase_add_user + Add a user to a security database (only for IB6 or later) + + + Description + + boolibase_add_user + resourceservice_handle + stringuser_name + stringpassword + stringfirst_name + stringmiddle_name + stringlast_name + - - PHP 4 uses server, - dba_user_name and - dba_user_password instead of - service_handle parameter. - - &warn.undocumented.func; + + PHP 4 uses server, + dba_user_name and + dba_user_password instead of + service_handle parameter. + + &warn.undocumented.func; - - See also - ibase_modify_user and - ibase_delete_user. - - - + + See also + ibase_modify_user and + ibase_delete_user. + + + - - - ibase_affected_rows - - Return the number of rows that were affected by the previous query - - - - 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. - - - + + + + ibase_affected_rows + Return the number of rows that were affected by the previous query + + + 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. + + + - - - ibase_backup - - Initiates a backup task in the service manager and returns immediately - - - - Description - - mixedibase_backup - resourceservice_handle - stringsource_db - stringdest_file - intoptions - boolverbose - + + + + ibase_backup + Initiates a backup task in the service manager and returns immediately + + + Description + + mixedibase_backup + resourceservice_handle + stringsource_db + stringdest_file + intoptions + boolverbose + - &warn.undocumented.func; + &warn.undocumented.func; - - + + + - - - ibase_blob_add - - Add data into a newly created blob - - - - 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 + Add data into a newly created blob + + + 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_cancel - - Cancel creating blob - - - - 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. - - - + + + ibase_blob_cancel + Cancel creating blob + + + 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. + + + + - - - ibase_blob_close - - Close blob - - - - Description - - mixedibase_blob_close - resourceblob_handle - - - 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_blob_close + Close blob + + + Description + + mixedibase_blob_close + resourceblob_handle + + + 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_blob_create - - Create a new blob for adding data - - - - 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 + Create a new blob for adding data + + + 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_echo - - Output blob contents to browser - - - - Description - - boolibase_blob_echo - resourcelink_identifier - stringblob_id - - - boolibase_blob_echo - 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. - - - + + + ibase_blob_echo + Output blob contents to browser + + + Description + + boolibase_blob_echo + resourcelink_identifier + stringblob_id + + + boolibase_blob_echo + 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. + + + + - - - ibase_blob_get - - Get len bytes data from open blob - - - - Description - - stringibase_blob_get - resourceblob_handle - intlen - - - This function returns at most len bytes from a BLOB - that has been opened for reading by ibase_blob_open. - Returns &false; on failure. - - + + + ibase_blob_get + Get len bytes data from open blob + + + Description + + stringibase_blob_get + resourceblob_handle + intlen + + + This function returns at most len bytes from a BLOB + that has been opened for reading by ibase_blob_open. + Returns &false; on failure. + + ]]> - - - 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. - - - - It is not possible to read from a BLOB that has been opened for writing - by ibase_blob_create. - - - - See also - ibase_blob_open, - ibase_blob_close and - ibase_blob_echo. - - - + + + 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. + + + + It is not possible to read from a BLOB that has been opened for writing + by ibase_blob_create. + + + + See also + ibase_blob_open, + ibase_blob_close and + ibase_blob_echo. + + + + - - - ibase_blob_import - - Create blob, copy file in it, and close it - - - - Description - - stringibase_blob_import - resourcelink_identifier - resourcefile_handle - - - stringibase_blob_import - resourcefile_handle - - - 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. - - - - <function>ibase_blob_import</function> example - + + + ibase_blob_import + Create blob, copy file in it, and close it + + + Description + + stringibase_blob_import + resourcelink_identifier + resourcefile_handle + + + stringibase_blob_import + resourcefile_handle + + + 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. + + + + <function>ibase_blob_import</function> example + ]]> - - - - - See also - ibase_blob_add, - ibase_blob_cancel, - ibase_blob_close and - ibase_blob_create. - - - + + + + + See also + ibase_blob_add, + ibase_blob_cancel, + ibase_blob_close and + ibase_blob_create. + + + + - - - ibase_blob_info - - Return blob length and other useful info - - - - Description - - arrayibase_blob_info - resourcelink_identifier - stringblob_id - - - arrayibase_blob_info - stringblob_id - - - 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_info + Return blob length and other useful info + + + Description + + arrayibase_blob_info + resourcelink_identifier + stringblob_id + + + arrayibase_blob_info + stringblob_id + + + 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 - - resourceibase_blob_open - resourcelink_identifier - stringblob_id - - - resourceibase_blob_open - 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. - - - + + + ibase_blob_open + Open blob for retrieving data parts + + + Description + + resourceibase_blob_open + resourcelink_identifier + stringblob_id + + + resourceibase_blob_open + 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. + + + + - - - ibase_close - - Close a connection to an InterBase database - - - - Description - - boolibase_close - resourceconnection_id - - - 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. - - - + + + ibase_close + Close a connection to an InterBase database + + + Description + + boolibase_close + resourceconnection_id + + + 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. + + + - - - ibase_commit_ret - Commit a transaction without closing it - - - 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. - &return.success; - - - + + + + ibase_commit_ret + Commit a transaction without closing it + + + 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. + &return.success; + + + + - - - ibase_commit - Commit a transaction - - - 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. - &return.success; - - - + + + ibase_commit + Commit a transaction + + + 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. + &return.success; + + + + - - - ibase_connect - - Open a connection to an InterBase database - - - - Description - - resourceibase_connect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - 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. - - <function>ibase_connect</function> example - + + + ibase_connect + Open a connection to an InterBase database + + + Description + + resourceibase_connect + stringdatabase + stringusername + stringpassword + stringcharset + intbuffers + intdialect + stringrole + intsync + + + 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. + + <function>ibase_connect</function> example + ]]> - - - - - - 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). - - - - See also - ibase_pconnect and - ibase_close. - - - + + + + + + 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). + + + + See also + ibase_pconnect and + ibase_close. + + + - - - ibase_db_info - - Request statistics about a database - - - - Description - - stringibase_db_info - resourceservice_handle - stringdb - intaction - intargument - + + + + ibase_db_info + Request statistics about a database + + + Description + + stringibase_db_info + resourceservice_handle + stringdb + intaction + intargument + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - ibase_delete_user - - Delete a user from a security database (only for IB6 or later) - - - - Description - - boolibase_delete_user - resourceservice_handle - stringuser_name - + + + + ibase_delete_user + Delete a user from a security database (only for IB6 or later) + + + Description + + boolibase_delete_user + resourceservice_handle + stringuser_name + - - PHP 4 uses server, - dba_user_name and - dba_user_password instead of - service_handle parameter. - - &warn.undocumented.func; + + PHP 4 uses server, + dba_user_name and + dba_user_password instead of + service_handle parameter. + + &warn.undocumented.func; - - See also - ibase_add_user and - ibase_modify_user. - - - + + See also + ibase_add_user and + ibase_modify_user. + + + - - - ibase_drop_db - - Drops a database - - - - Description - - boolibase_drop_db - resourceconnection - - - 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. - - - + + + + ibase_drop_db + Drops a database + + + Description + + boolibase_drop_db + resourceconnection + + + 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. + + + - - - ibase_errcode - - Return an error code - - - - 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. - - - + + + + ibase_errcode + Return an error code + + + 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. + + + + - - - ibase_errmsg - - Return error messages - - - - Description - - stringibase_errmsg - - - - Returns the error message that resulted from the most recent InterBase function - call. Returns &false; if no error occurred. - - - See also - ibase_errcode. - - - + + + ibase_errmsg + Return error messages + + + Description + + stringibase_errmsg + + + + Returns the error message that resulted from the most recent InterBase function + call. Returns &false; if no error occurred. + + + See also + ibase_errcode. + + + + - - - ibase_execute - Execute a previously prepared query - - - Description - - resourceibase_execute - resourcequery - mixedbind_arg - 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;. - - - 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. - - - - <function>ibase_execute</function> example - + + + ibase_execute + Execute a previously prepared query + + + Description + + resourceibase_execute + resourcequery + mixedbind_arg + 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;. + + + 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. + + + + <function>ibase_execute</function> example + 'Eric', @@ -49,22 +49,22 @@ 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;. - - - - See also ibase_query. - - - + + + + + + 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;. + + + + See also ibase_query. + + + - - - ibase_fetch_assoc - - Fetch a result row from a query as an associative array - - - - 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. - - - ibase_fetch_assoc fetches one row of data from the - result. If two or more columns of the result - have the same field names, the last column will take precedence. To - access the other column(s) of the same name, you either need to access - the result with numeric indices by using - ibase_fetch_row or use alias names in your query. - - - 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. - - - + + + + ibase_fetch_assoc + Fetch a result row from a query as an associative array + + + 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. + + + ibase_fetch_assoc fetches one row of data from the + result. If two or more columns of the result + have the same field names, the last column will take precedence. To + access the other column(s) of the same name, you either need to access + the result with numeric indices by using + ibase_fetch_row or use alias names in your query. + + + 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. + + + + - - - ibase_fetch_object - Get an object from a InterBase database - - - 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. - - + + + ibase_fetch_object + Get an object from a InterBase database + + + 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. + + ]]> - - - - - 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. - - - + + + + + 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. + + + + - - - ibase_fetch_row - Fetch a row from an InterBase database - - - 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. - - - Subsequent calls to ibase_fetch_row - 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_assoc and - ibase_fetch_object. - - - + + + ibase_fetch_row + Fetch a row from an InterBase database + + + 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. + + + Subsequent calls to ibase_fetch_row + 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_assoc and + ibase_fetch_object. + + + + - - - ibase_field_info - - Get information about a field - - - - Description - - arrayibase_field_info - resourceresult - intfield_number - - - 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. - - - - + + + ibase_field_info + Get information about a field + + + Description + + arrayibase_field_info + resourceresult + intfield_number + + + 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. + + + + ]]> - - - - - See also: ibase_num_fields. - - - + + + + + See also: ibase_num_fields. + + + - - - ibase_free_event_handler - - Cancels a registered event handler - - - - 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. - - - + + + + ibase_free_event_handler + Cancels a registered event handler + + + 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. + + + + - - - ibase_free_query - - Free memory allocated by a prepared query - - - - Description - - boolibase_free_query - resourcequery - - - Free a query prepared by ibase_prepare. - &return.success; - - - + + + ibase_free_query + Free memory allocated by a prepared query + + + Description + + boolibase_free_query + resourcequery + + + Free a query prepared by ibase_prepare. + &return.success; + + + + - - - ibase_free_result - Free a result set - - - Description - - boolibase_free_result - resourceresult_identifier - - - Frees a result set that has been created by - ibase_query or ibase_execute. - &return.success; - - - + + + ibase_free_result + Free a result set + + + Description + + boolibase_free_result + resourceresult_identifier + + + Frees a result set that has been created by + ibase_query or ibase_execute. + &return.success; + + + + - - - ibase_gen_id - - Increments the named generator and returns its new value - - - - Description - - mixedibase_gen_id - stringgenerator - intincrement - resourcelink_identifier - + + + ibase_gen_id + Increments the named generator and returns its new value + + + Description + + mixedibase_gen_id + stringgenerator + intincrement + resourcelink_identifier + - &warn.undocumented.func; - - Returns new generator value as integer, or as string if the value is too big. - + &warn.undocumented.func; + + 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 - - boolibase_maintain_db - resourceservice_handle - stringdb - intaction - intargument - + + + + ibase_maintain_db + Execute a maintenance command on the database server + + + Description + + boolibase_maintain_db + resourceservice_handle + stringdb + intaction + intargument + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - ibase_modify_user - - Modify a user to a security database (only for IB6 or later) - - - - Description - - boolibase_modify_user - resourceservice_handle - stringuser_name - stringpassword - stringfirst_name - stringmiddle_name - stringlast_name - + + + + ibase_modify_user + Modify a user to a security database (only for IB6 or later) + + + Description + + boolibase_modify_user + resourceservice_handle + stringuser_name + stringpassword + stringfirst_name + stringmiddle_name + stringlast_name + - - PHP 4 uses server, - dba_user_name and - dba_user_password instead of - service_handle parameter. - - &warn.undocumented.func; + + PHP 4 uses server, + dba_user_name and + dba_user_password instead of + service_handle parameter. + + &warn.undocumented.func; - - See also - ibase_add_user and - ibase_delete_user. - - - + + See also + ibase_add_user and + ibase_delete_user. + + + - - - ibase_name_result - - Assigns a name to a result set - - - - Description - - boolibase_name_result - resourceresult - stringname - - - This function assigns a name to a result set. This name can be used later in - UPDATE|DELETE ... WHERE CURRENT OF name statements. - &return.success; - - + + + + ibase_name_result + Assigns a name to a result set + + + Description + + boolibase_name_result + resourceresult + stringname + + + This function assigns a name to a result set. This name can be used later in + UPDATE|DELETE ... WHERE CURRENT OF name statements. + &return.success; + + ]]> - - - - - See also - ibase_prepare and - ibase_execute. - - - + + + + + See also + ibase_prepare and + ibase_execute. + + + + - - - ibase_num_fields - - Get the number of fields in a result set - - - - Description - - intibase_num_fields - resourceresult_id - - - Returns an integer containing the number of fields in a result - set. - - + + + ibase_num_fields + Get the number of fields in a result set + + + Description + + intibase_num_fields + resourceresult_id + + + Returns an integer containing the number of fields in a result + set. + + ]]> - - - - - See also: ibase_field_info. - - - + + + + + See also: ibase_field_info. + + + - - - ibase_num_params - - Return the number of parameters in a prepared query - - - - Description - - intibase_num_params - resourcequery - - - This function returns the number of parameters in the prepared query specified - by query. This is the number of binding arguments that - must be present when calling ibase_execute. - - - See also - ibase_prepare and - ibase_param_info. - - - + + + + ibase_num_params + Return the number of parameters in a prepared query + + + Description + + intibase_num_params + resourcequery + + + This function returns the number of parameters in the prepared query specified + by query. This is the number of binding arguments that + must be present when calling ibase_execute. + + + See also + ibase_prepare and + ibase_param_info. + + + - - - ibase_param_info - - Return information about a parameter in a prepared query - - - - Description - - arrayibase_param_info - resourcequery - intparam_number - - - 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. - - - + + + + ibase_param_info + Return information about a parameter in a prepared query + + + Description + + arrayibase_param_info + resourcequery + intparam_number + + + 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. + + + + - - - ibase_pconnect - - Open a persistent connection to an InterBase database - - - - Description - - resourceibase_pconnect - stringdatabase - stringusername - stringpassword - stringcharset - intbuffers - intdialect - stringrole - intsync - - - 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 - 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. - - - - See also ibase_close and - ibase_connect for the meaning of - parameters passed to this function. They are exactly the same. - - - + + + ibase_pconnect + Open a persistent connection to an InterBase database + + + Description + + resourceibase_pconnect + stringdatabase + stringusername + stringpassword + stringcharset + intbuffers + intdialect + stringrole + intsync + + + 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 + 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. + + + + See also ibase_close and + ibase_connect for the meaning of + parameters passed to this function. They are exactly the same. + + + + - - - ibase_prepare - - Prepare a query for later binding of parameter placeholders and - execution - - - - Description - - resourceibase_prepare - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringquery - - - resourceibase_prepare - resourcelink_identifier - stringtrans - stringquery - - - Prepare a query for later binding of parameter placeholders and - execution (via ibase_execute). - - - + + + ibase_prepare + Prepare a query for later binding of parameter placeholders and execution + + + Description + + resourceibase_prepare + stringquery + + + resourceibase_prepare + resourcelink_identifier + stringquery + + + resourceibase_prepare + resourcelink_identifier + stringtrans + stringquery + + + Prepare a query for later binding of parameter placeholders and + execution (via ibase_execute). + + + + - - - ibase_query - Execute a query on an InterBase database - - - Description - - resourceibase_query - resourcelink_identifier - stringquery - 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;. - - - - <function>ibase_query</function> example - + + + ibase_query + Execute a query on an InterBase database + + + Description + + resourceibase_query + resourcelink_identifier + stringquery + 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;. + + + + <function>ibase_query</function> example + ]]> - - - - - - 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). - - - - See also ibase_errmsg, - ibase_fetch_row, - ibase_fetch_object, and - ibase_free_result. - - - + + + + + + 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). + + + + See also ibase_errmsg, + ibase_fetch_row, + ibase_fetch_object, and + ibase_free_result. + + + - - - ibase_restore - - Initiates a restore task in the service manager and returns immediately - - - - Description - - mixedibase_restore - resourceservice_handle - stringsource_file - stringdest_db - intoptions - boolverbose - + + + + ibase_restore + Initiates a restore task in the service manager and returns immediately + + + Description + + mixedibase_restore + resourceservice_handle + stringsource_file + stringdest_db + intoptions + boolverbose + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - ibase_rollback_ret - Roll back a transaction without closing it - - - 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. - &return.success; - - - + + + + ibase_rollback_ret + Roll back a transaction without closing it + + + 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. + &return.success; + + + + - - - ibase_rollback - Roll back a transaction - - - 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. - &return.success; - - - + + + ibase_rollback + Roll back a transaction + + + 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. + &return.success; + + + - - - ibase_server_info - - Request information about a database server - - - - Description - - stringibase_server_info - resourceservice_handle - intaction - + + + + ibase_server_info + Request information about a database server + + + Description + + stringibase_server_info + resourceservice_handle + intaction + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - ibase_service_attach - - Connect to the service manager - - - - Description - - resourceibase_service_attach - stringhost - stringdba_username - stringdba_password - + + + + ibase_service_attach + Connect to the service manager + + + Description + + resourceibase_service_attach + stringhost + stringdba_username + stringdba_password + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - ibase_service_detach - - Disconnect from the service manager - - - - Description - - boolibase_service_detach - resourceservice_handle - + + + + ibase_service_detach + Disconnect from the service manager + + + Description + + boolibase_service_detach + resourceservice_handle + - &warn.undocumented.func; + &warn.undocumented.func; - - + + - - - ibase_set_event_handler - - Register a callback function to be called when events are posted - - - - Description - - resourceibase_set_event_handler - callbackevent_handler - stringevent_name1 - stringevent_name2 - string... - - - resourceibase_set_event_handler - resourceconnection - callbackevent_handler - stringevent_name1 - stringevent_name2 - 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. - - - - + + + + ibase_set_event_handler + Register a callback function to be called when events are posted + + + Description + + resourceibase_set_event_handler + callbackevent_handler + stringevent_name1 + stringevent_name2 + string... + + + resourceibase_set_event_handler + resourceconnection + callbackevent_handler + stringevent_name1 + stringevent_name2 + 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. + + + + ]]> - - - - - 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. - - - + + + + + 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. + + + + - - - ibase_timefmt - - Sets the format of timestamp, date and time type columns returned from queries - - - - Description - - intibase_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. - - - - + + + ibase_timefmt + Sets the format of timestamp, date and time type columns returned from queries + + + Description + + intibase_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. + + + + ]]> - - - - - You can set defaults for these formats with the PHP configuration - directives ibase.timestampformat, ibase.dateformat and ibase.timeformat. - - - - This function has been removed from PHP 5, use ini_set instead. - - - - + + + + + You can set defaults for these formats with the PHP configuration + directives ibase.timestampformat, ibase.dateformat and ibase.timeformat. + + + + This function has been removed from PHP 5, use ini_set instead. + + + + + - - - ibase_trans - Begin a transaction - - - Description - - resourceibase_trans - inttrans_args - resourcelink_identifier - - - 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 - to ibase_trans will not return the default transaction - of a connection. All transactions started by ibase_trans - will be rolled back at the end of the script if they were not committed or - rolled back by either ibase_commit or - ibase_rollback. - - - - - In PHP 5.0.0. and up, this function will accept multiple trans_args - and link_identifier arguments. This allows transactions - over multiple database connections, which are committed using a 2-phase commit - algorithm. This means you can rely on the updates to either succeed in every - database, or fail in every database. It does NOT mean you can use tables from - different databases in the same query! - - - If you use transactions over multiple databases, you will have to specify both - the link_id and transaction_id - in calls to ibase_query and ibase_prepare. - - - - + + + ibase_trans + Begin a transaction + + + Description + + resourceibase_trans + inttrans_args + resourcelink_identifier + + + 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 + to ibase_trans will not return the default transaction + of a connection. All transactions started by ibase_trans + will be rolled back at the end of the script if they were not committed or + rolled back by either ibase_commit or + ibase_rollback. + + + + + In PHP 5.0.0. and up, this function will accept multiple trans_args + and link_identifier arguments. This allows transactions + over multiple database connections, which are committed using a 2-phase commit + algorithm. This means you can rely on the updates to either succeed in every + database, or fail in every database. It does NOT mean you can use tables from + different databases in the same query! + + + If you use transactions over multiple databases, you will have to specify both + the link_id and transaction_id + in calls to ibase_query and ibase_prepare. + + + + - - - ibase_wait_event - - Wait for an event to be posted by the database - - - - Description - - stringibase_wait_event - stringevent_name1 - stringevent_name2 - string... - - - stringibase_wait_event - resourceconnection - stringevent_name1 - stringevent_name2 - string... - - - This function suspends execution of the script until one of the specified events - is posted by the database. The name of the event that was posted is returned. This - function accepts up to 15 event arguments. - - - See also - ibase_set_event_handler and - ibase_free_event_handler. - - - + + + + ibase_wait_event + Wait for an event to be posted by the database + + + Description + + stringibase_wait_event + stringevent_name1 + stringevent_name2 + string... + + + stringibase_wait_event + resourceconnection + stringevent_name1 + stringevent_name2 + string... + + + This function suspends execution of the script until one of the specified events + is posted by the database. The name of the event that was posted is returned. This + function accepts up to 15 event arguments. + + + See also + ibase_set_event_handler and + ibase_free_event_handler. + + +