update lock clucknut

vendor/thecodingmachine/safe/generated/8.1/ibase.php

@@ -5,10 +5,7 @@
 use Safe\Exceptions\IbaseException;
 
 /**
- * This function will discard a BLOB if it has not yet been closed by
- * fbird_blob_close.
- *
- * @param resource $blob_handle A BLOB handle opened with fbird_blob_create.
+ * @param resource $blob_handle
  * @throws IbaseException
  *
  */
@@ -23,14 +20,12 @@ function fbird_blob_cancel($blob_handle): void
 
 
 /**
- *
- *
- * @param resource $service_handle The handle on the database server service.
- * @param string $user_name The login name of the new database user.
- * @param string $password The password of the new user.
- * @param string $first_name The first name of the new database user.
- * @param string $middle_name The middle name of the new database user.
- * @param string $last_name The last name of the new database user.
+ * @param resource $service_handle
+ * @param string $user_name
+ * @param string $password
+ * @param string $first_name
+ * @param string $middle_name
+ * @param string $last_name
  * @throws IbaseException
  *
  */
@@ -53,29 +48,12 @@ function ibase_add_user($service_handle, string $user_name, string $password, ?s
 
 
 /**
- * This function passes the arguments to the (remote) database server. There it starts a new backup process. Therefore you
- * won't get any responses.
- *
- * @param resource $service_handle A previously opened connection to the database server.
- * @param string $source_db The absolute file path to the database on the database server. You can also use a database alias.
- * @param string $dest_file The path to the backup file on the database server.
- * @param int $options Additional options to pass to the database server for backup.
- * The options parameter can be a combination
- * of the following constants:
- * IBASE_BKP_IGNORE_CHECKSUMS,
- * IBASE_BKP_IGNORE_LIMBO,
- * IBASE_BKP_METADATA_ONLY,
- * IBASE_BKP_NO_GARBAGE_COLLECT,
- * IBASE_BKP_OLD_DESCRIPTIONS,
- * IBASE_BKP_NON_TRANSPORTABLE or
- * IBASE_BKP_CONVERT.
- * Read the section about  for further information.
- * @param bool $verbose Since the backup process is done on the database server, you don't have any chance
- * to get its output. This argument is useless.
- * @return mixed Returns TRUE on success.
- *
- * Since the backup process is done on the (remote) server, this function just passes the arguments to it.
- * While the arguments are legal, you won't get FALSE.
+ * @param resource $service_handle
+ * @param string $source_db
+ * @param string $dest_file
+ * @param int $options
+ * @param bool $verbose
+ * @return mixed
  * @throws IbaseException
  *
  */
@@ -91,10 +69,7 @@ function ibase_backup($service_handle, string $source_db, string $dest_file, int
 
 
 /**
- * This function will discard a BLOB if it has not yet been closed by
- * ibase_blob_close.
- *
- * @param resource $blob_handle A BLOB handle opened with ibase_blob_create.
+ * @param resource $blob_handle
  * @throws IbaseException
  *
  */
@@ -109,13 +84,8 @@ function ibase_blob_cancel($blob_handle): void
 
 
 /**
- * ibase_blob_create creates a new BLOB for filling with
- * data.
- *
- * @param null|resource $link_identifier An InterBase link identifier. If omitted, the last opened link is
- * assumed.
- * @return resource Returns a BLOB handle for later use with
- * ibase_blob_add.
+ * @param null|resource $link_identifier
+ * @return resource
  * @throws IbaseException
  *
  */
@@ -135,12 +105,9 @@ function ibase_blob_create($link_identifier = null)
 
 
 /**
- * This function returns at most len bytes from a BLOB
- * that has been opened for reading by ibase_blob_open.
- *
- * @param resource $blob_handle A BLOB handle opened with ibase_blob_open.
- * @param int $len Size of returned data.
- * @return string Returns at most len bytes from the BLOB.
+ * @param resource $blob_handle
+ * @param int $len
+ * @return string
  * @throws IbaseException
  *
  */
@@ -156,14 +123,7 @@ function ibase_blob_get($blob_handle, int $len): string
 
 
 /**
- * Closes the link to an InterBase database that's associated with
- * a connection id returned from ibase_connect.
- * Default transaction on link is committed, other transactions are
- * rolled back.
- *
- * @param null|resource $connection_id An InterBase link identifier returned from
- * ibase_connect. If omitted, the last opened link
- * is assumed.
+ * @param null|resource $connection_id
  * @throws IbaseException
  *
  */
@@ -182,15 +142,7 @@ function ibase_close($connection_id = null): void
 
 
 /**
- * Commits a transaction without closing it.
- *
- * @param null|resource $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.
+ * @param null|resource $link_or_trans_identifier
  * @throws IbaseException
  *
  */
@@ -209,13 +161,7 @@ function ibase_commit_ret($link_or_trans_identifier = null): void
 
 
 /**
- * Commits a transaction.
- *
- * @param null|resource $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.
+ * @param null|resource $link_or_trans_identifier
  * @throws IbaseException
  *
  */
@@ -234,35 +180,15 @@ function ibase_commit($link_or_trans_identifier = null): void
 
 
 /**
- * Establishes a connection to an Firebird/InterBase server.
- *
- * 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.
- *
- * @param string $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/port:'
- * (TCP/IP with interbase server on custom TCP port), '//hostname/'
- * (NetBEUI), depending on the connection
- * protocol used.
- * @param string $username The user name. Can be set with the
- * ibase.default_user php.ini directive.
- * @param string $password The password for username. Can be set with the
- * ibase.default_password php.ini directive.
- * @param string $charset charset is the default character set for a
- * database.
- * @param int $buffers buffers is the number of database buffers to
- * allocate for the server-side cache. If 0 or omitted, server chooses
- * its own default.
- * @param int $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.
- * @param string $role Functional only with InterBase 5 and up.
+ * @param string $database
+ * @param string $username
+ * @param string $password
+ * @param string $charset
+ * @param int $buffers
+ * @param int $dialect
+ * @param string $role
  * @param int $sync
- * @return resource Returns an Firebird/InterBase link identifier on success.
+ * @return resource
  * @throws IbaseException
  *
  */
@@ -296,10 +222,8 @@ function ibase_connect(?string $database = null, ?string $username = null, ?stri
 
 
 /**
- *
- *
- * @param resource $service_handle The handle on the database server service.
- * @param string $user_name The login name of the user you want to delete from the database.
+ * @param resource $service_handle
+ * @param string $user_name
  * @throws IbaseException
  *
  */
@@ -314,11 +238,7 @@ function ibase_delete_user($service_handle, string $user_name): void
 
 
 /**
- * This functions drops a database that was opened by either ibase_connect
- * or ibase_pconnect. The database is closed and deleted from the server.
- *
- * @param null|resource $connection An InterBase link identifier. If omitted, the last opened link is
- * assumed.
+ * @param null|resource $connection
  * @throws IbaseException
  *
  */
@@ -337,12 +257,7 @@ function ibase_drop_db($connection = null): void
 
 
 /**
- * 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.
- *
- * @param resource $event An event resource, created by
- * ibase_set_event_handler.
+ * @param resource $event
  * @throws IbaseException
  *
  */
@@ -357,9 +272,7 @@ function ibase_free_event_handler($event): void
 
 
 /**
- * Frees a prepared query.
- *
- * @param resource $query A query prepared with ibase_prepare.
+ * @param resource $query
  * @throws IbaseException
  *
  */
@@ -374,10 +287,7 @@ function ibase_free_query($query): void
 
 
 /**
- * Frees a result set.
- *
- * @param resource $result_identifier A result set created by ibase_query or
- * ibase_execute.
+ * @param resource $result_identifier
  * @throws IbaseException
  *
  */
@@ -392,8 +302,6 @@ function ibase_free_result($result_identifier): void
 
 
 /**
- *
- *
  * @param resource $service_handle
  * @param string $db
  * @param int $action
@@ -412,14 +320,12 @@ function ibase_maintain_db($service_handle, string $db, int $action, int $argume
 
 
 /**
- *
- *
- * @param resource $service_handle The handle on the database server service.
- * @param string $user_name The login name of the database user to modify.
- * @param string $password The user's new password.
- * @param string $first_name The user's new first name.
- * @param string $middle_name The user's new middle name.
- * @param string $last_name The user's new last name.
+ * @param resource $service_handle
+ * @param string $user_name
+ * @param string $password
+ * @param string $first_name
+ * @param string $middle_name
+ * @param string $last_name
  * @throws IbaseException
  *
  */
@@ -442,11 +348,8 @@ function ibase_modify_user($service_handle, string $user_name, string $password,
 
 
 /**
- * This function assigns a name to a result set. This name can be used later in
- * UPDATE|DELETE ... WHERE CURRENT OF name statements.
- *
- * @param resource $result An InterBase result set.
- * @param string $name The name to be assigned.
+ * @param resource $result
+ * @param string $name
  * @throws IbaseException
  *
  */
@@ -461,42 +364,15 @@ function ibase_name_result($result, string $name): void
 
 
 /**
- * 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
- * therefore called 'persistent'.
- *
- * @param string $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.
- * @param string $username The user name. Can be set with the
- * ibase.default_user php.ini directive.
- * @param string $password The password for username. Can be set with the
- * ibase.default_password php.ini directive.
- * @param string $charset charset is the default character set for a
- * database.
- * @param int $buffers buffers is the number of database buffers to
- * allocate for the server-side cache. If 0 or omitted, server chooses
- * its own default.
- * @param int $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.
- * @param string $role Functional only with InterBase 5 and up.
+ * @param string $database
+ * @param string $username
+ * @param string $password
+ * @param string $charset
+ * @param int $buffers
+ * @param int $dialect
+ * @param string $role
  * @param int $sync
- * @return resource Returns an InterBase link identifier on success.
+ * @return resource
  * @throws IbaseException
  *
  */
@@ -530,32 +406,12 @@ function ibase_pconnect(?string $database = null, ?string $username = null, ?str
 
 
 /**
- * This function passes the arguments to the (remote) database server. There it starts a new restore process. Therefore you
- * won't get any responses.
- *
- * @param resource $service_handle A previously opened connection to the database server.
- * @param string $source_file The absolute path on the server where the backup file is located.
- * @param string $dest_db The path to create the new database on the server. You can also use database alias.
- * @param int $options Additional options to pass to the database server for restore.
- * The options parameter can be a combination
- * of the following constants:
- * IBASE_RES_DEACTIVATE_IDX,
- * IBASE_RES_NO_SHADOW,
- * IBASE_RES_NO_VALIDITY,
- * IBASE_RES_ONE_AT_A_TIME,
- * IBASE_RES_REPLACE,
- * IBASE_RES_CREATE,
- * IBASE_RES_USE_ALL_SPACE,
- * IBASE_PRP_PAGE_BUFFERS,
- * IBASE_PRP_SWEEP_INTERVAL,
- * IBASE_RES_CREATE.
- * Read the section about  for further information.
- * @param bool $verbose Since the restore process is done on the database server, you don't have any chance
- * to get its output. This argument is useless.
- * @return mixed Returns TRUE on success.
- *
- * Since the restore process is done on the (remote) server, this function just passes the arguments to it.
- * While the arguments are legal, you won't get FALSE.
+ * @param resource $service_handle
+ * @param string $source_file
+ * @param string $dest_db
+ * @param int $options
+ * @param bool $verbose
+ * @return mixed
  * @throws IbaseException
  *
  */
@@ -571,15 +427,7 @@ function ibase_restore($service_handle, string $source_file, string $dest_db, in
 
 
 /**
- * Rolls back a transaction without closing it.
- *
- * @param null|resource $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.
+ * @param null|resource $link_or_trans_identifier
  * @throws IbaseException
  *
  */
@@ -598,13 +446,7 @@ function ibase_rollback_ret($link_or_trans_identifier = null): void
 
 
 /**
- * Rolls back a transaction.
- *
- * @param null|resource $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.
+ * @param null|resource $link_or_trans_identifier
  * @throws IbaseException
  *
  */
@@ -623,13 +465,10 @@ function ibase_rollback($link_or_trans_identifier = null): void
 
 
 /**
- *
- *
- * @param string $host The name or ip address of the database host. You can define the port by adding
- * '/' and port number. If no port is specified, port 3050 will be used.
- * @param string $dba_username The name of any valid user.
- * @param string $dba_password The user's password.
- * @return resource Returns a Interbase / Firebird link identifier on success.
+ * @param string $host
+ * @param string $dba_username
+ * @param string $dba_password
+ * @return resource
  * @throws IbaseException
  *
  */
@@ -645,9 +484,7 @@ function ibase_service_attach(string $host, string $dba_username, string $dba_pa
 
 
 /**
- *
- *
- * @param resource $service_handle A previously created connection to the database server.
+ * @param resource $service_handle
  * @throws IbaseException
  *
  */