572 lines
18 KiB
PHP
Executable File
572 lines
18 KiB
PHP
Executable File
<?php
|
|
|
|
namespace Safe;
|
|
|
|
use Safe\Exceptions\SqlsrvException;
|
|
|
|
/**
|
|
* The transaction begun by sqlsrv_begin_transaction includes
|
|
* all statements that were executed after the call to
|
|
* sqlsrv_begin_transaction and before calls to
|
|
* sqlsrv_rollback or sqlsrv_commit.
|
|
* Explicit transactions should be started and committed or rolled back using
|
|
* these functions instead of executing SQL statements that begin and commit/roll
|
|
* back transactions. For more information, see
|
|
* SQLSRV Transactions.
|
|
*
|
|
* @param resource $conn The connection resource returned by a call to sqlsrv_connect.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_begin_transaction($conn): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_begin_transaction($conn);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Cancels a statement. Any results associated with the statement that have not
|
|
* been consumed are deleted. After sqlsrv_cancel has been
|
|
* called, the specified statement can be re-executed if it was created with
|
|
* sqlsrv_prepare. Calling sqlsrv_cancel
|
|
* is not necessary if all the results associated with the statement have been
|
|
* consumed.
|
|
*
|
|
* @param resource $stmt The statement resource to be cancelled.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_cancel($stmt): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_cancel($stmt);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns information about the client and specified connection
|
|
*
|
|
* @param resource $conn The connection about which information is returned.
|
|
* @return array Returns an associative array with keys described in the table below.
|
|
*
|
|
* Array returned by sqlsrv_client_info
|
|
*
|
|
*
|
|
*
|
|
* Key
|
|
* Description
|
|
*
|
|
*
|
|
*
|
|
*
|
|
* DriverDllName
|
|
* SQLNCLI10.DLL
|
|
*
|
|
*
|
|
* DriverODBCVer
|
|
* ODBC version (xx.yy)
|
|
*
|
|
*
|
|
* DriverVer
|
|
* SQL Server Native Client DLL version (10.5.xxx)
|
|
*
|
|
*
|
|
* ExtensionVer
|
|
* php_sqlsrv.dll version (2.0.xxx.x)
|
|
*
|
|
*
|
|
*
|
|
*
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_client_info($conn): array
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_client_info($conn);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Closes an open connection and releases resourses associated with the connection.
|
|
*
|
|
* @param resource $conn The connection to be closed.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_close($conn): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_close($conn);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Commits a transaction that was begun with sqlsrv_begin_transaction.
|
|
* The connection is returned to auto-commit mode after sqlsrv_commit
|
|
* is called. The transaction that is committed includes all statements that were
|
|
* executed after the call to sqlsrv_begin_transaction.
|
|
* Explicit transactions should be started and committed or rolled back using these
|
|
* functions instead of executing SQL statements that begin and commit/roll back
|
|
* transactions. For more information, see
|
|
* SQLSRV Transactions.
|
|
*
|
|
* @param resource $conn The connection on which the transaction is to be committed.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_commit($conn): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_commit($conn);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Changes the driver error handling and logging configurations.
|
|
*
|
|
* @param string $setting The name of the setting to set. The possible values are
|
|
* "WarningsReturnAsErrors", "LogSubsystems", and "LogSeverity".
|
|
* @param mixed $value The value of the specified setting. The following table shows possible values:
|
|
*
|
|
* Error and Logging Setting Options
|
|
*
|
|
*
|
|
*
|
|
* Setting
|
|
* Options
|
|
*
|
|
*
|
|
*
|
|
*
|
|
* WarningsReturnAsErrors
|
|
* 1 (TRUE) or 0 (FALSE)
|
|
*
|
|
*
|
|
* LogSubsystems
|
|
* SQLSRV_LOG_SYSTEM_ALL (-1)
|
|
* SQLSRV_LOG_SYSTEM_CONN (2)
|
|
* SQLSRV_LOG_SYSTEM_INIT (1)
|
|
* SQLSRV_LOG_SYSTEM_OFF (0)
|
|
* SQLSRV_LOG_SYSTEM_STMT (4)
|
|
* SQLSRV_LOG_SYSTEM_UTIL (8)
|
|
*
|
|
*
|
|
* LogSeverity
|
|
* SQLSRV_LOG_SEVERITY_ALL (-1)
|
|
* SQLSRV_LOG_SEVERITY_ERROR (1)
|
|
* SQLSRV_LOG_SEVERITY_NOTICE (4)
|
|
* SQLSRV_LOG_SEVERITY_WARNING (2)
|
|
*
|
|
*
|
|
*
|
|
*
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_configure(string $setting, $value): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_configure($setting, $value);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Executes a statement prepared with sqlsrv_prepare. This
|
|
* function is ideal for executing a prepared statement multiple times with
|
|
* different parameter values.
|
|
*
|
|
* @param resource $stmt A statement resource returned by sqlsrv_prepare.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_execute($stmt): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_execute($stmt);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Returns the next available row of data as an associative array, a numeric
|
|
* array, or both (the default).
|
|
*
|
|
* @param resource $stmt A statement resource returned by sqlsrv_query or sqlsrv_prepare.
|
|
* @param int $fetchType A predefined constant specifying the type of array to return. Possible
|
|
* values are SQLSRV_FETCH_ASSOC,
|
|
* SQLSRV_FETCH_NUMERIC, and
|
|
* SQLSRV_FETCH_BOTH (the default).
|
|
*
|
|
* A fetch type of SQLSRV_FETCH_ASSOC should not be used when consuming a
|
|
* result set with multiple columns of the same name.
|
|
* @param int $row Specifies the row to access in a result set that uses a scrollable cursor.
|
|
* Possible values are SQLSRV_SCROLL_NEXT,
|
|
* SQLSRV_SCROLL_PRIOR, SQLSRV_SCROLL_FIRST,
|
|
* SQLSRV_SCROLL_LAST, SQLSRV_SCROLL_ABSOLUTE and,
|
|
* SQLSRV_SCROLL_RELATIVE (the default). When this parameter
|
|
* is specified, the fetchType must be explicitly defined.
|
|
* @param int $offset Specifies the row to be accessed if the row parameter is set to
|
|
* SQLSRV_SCROLL_ABSOLUTE or
|
|
* SQLSRV_SCROLL_RELATIVE. Note that the first row in
|
|
* a result set has index 0.
|
|
* @return array|null Returns an array on success, NULL if there are no more rows to return, and
|
|
* FALSE if an error occurs.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_fetch_array($stmt, ?int $fetchType = null, ?int $row = null, ?int $offset = null): ?array
|
|
{
|
|
error_clear_last();
|
|
if ($offset !== null) {
|
|
$safeResult = \sqlsrv_fetch_array($stmt, $fetchType, $row, $offset);
|
|
} elseif ($row !== null) {
|
|
$safeResult = \sqlsrv_fetch_array($stmt, $fetchType, $row);
|
|
} elseif ($fetchType !== null) {
|
|
$safeResult = \sqlsrv_fetch_array($stmt, $fetchType);
|
|
} else {
|
|
$safeResult = \sqlsrv_fetch_array($stmt);
|
|
}
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Retrieves the next row of data in a result set as an instance of the specified
|
|
* class with properties that match the row field names and values that correspond
|
|
* to the row field values.
|
|
*
|
|
* @param resource $stmt A statement resource created by sqlsrv_query or
|
|
* sqlsrv_execute.
|
|
* @param string $className The name of the class to instantiate. If no class name is specified,
|
|
* stdClass is instantiated.
|
|
* @param array $ctorParams Values passed to the constructor of the specified class. If the constructor
|
|
* of the specified class takes parameters, the ctorParams array must be
|
|
* supplied.
|
|
* @param int $row The row to be accessed. This parameter can only be used if the specified
|
|
* statement was prepared with a scrollable cursor. In that case, this parameter
|
|
* can take on one of the following values:
|
|
*
|
|
* SQLSRV_SCROLL_NEXT
|
|
* SQLSRV_SCROLL_PRIOR
|
|
* SQLSRV_SCROLL_FIRST
|
|
* SQLSRV_SCROLL_LAST
|
|
* SQLSRV_SCROLL_ABSOLUTE
|
|
* SQLSRV_SCROLL_RELATIVE
|
|
*
|
|
* @param int $offset Specifies the row to be accessed if the row parameter is set to
|
|
* SQLSRV_SCROLL_ABSOLUTE or
|
|
* SQLSRV_SCROLL_RELATIVE. Note that the first row in
|
|
* a result set has index 0.
|
|
* @return null|object Returns an object on success, NULL if there are no more rows to return,
|
|
* and FALSE if an error occurs or if the specified class does not exist.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_fetch_object($stmt, ?string $className = null, ?array $ctorParams = null, ?int $row = null, ?int $offset = null): ?object
|
|
{
|
|
error_clear_last();
|
|
if ($offset !== null) {
|
|
$safeResult = \sqlsrv_fetch_object($stmt, $className, $ctorParams, $row, $offset);
|
|
} elseif ($row !== null) {
|
|
$safeResult = \sqlsrv_fetch_object($stmt, $className, $ctorParams, $row);
|
|
} elseif ($ctorParams !== null) {
|
|
$safeResult = \sqlsrv_fetch_object($stmt, $className, $ctorParams);
|
|
} elseif ($className !== null) {
|
|
$safeResult = \sqlsrv_fetch_object($stmt, $className);
|
|
} else {
|
|
$safeResult = \sqlsrv_fetch_object($stmt);
|
|
}
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Makes the next row in a result set available for reading. Use
|
|
* sqlsrv_get_field to read the fields of the row.
|
|
*
|
|
* @param resource $stmt A statement resource created by executing sqlsrv_query
|
|
* or sqlsrv_execute.
|
|
* @param int $row The row to be accessed. This parameter can only be used if the specified
|
|
* statement was prepared with a scrollable cursor. In that case, this parameter
|
|
* can take on one of the following values:
|
|
*
|
|
* SQLSRV_SCROLL_NEXT
|
|
* SQLSRV_SCROLL_PRIOR
|
|
* SQLSRV_SCROLL_FIRST
|
|
* SQLSRV_SCROLL_LAST
|
|
* SQLSRV_SCROLL_ABSOLUTE
|
|
* SQLSRV_SCROLL_RELATIVE
|
|
*
|
|
* @param int $offset Specifies the row to be accessed if the row parameter is set to
|
|
* SQLSRV_SCROLL_ABSOLUTE or
|
|
* SQLSRV_SCROLL_RELATIVE. Note that the first row in
|
|
* a result set has index 0.
|
|
* @return bool|null Returns TRUE if the next row of a result set was successfully retrieved,
|
|
* FALSE if an error occurs, and NULL if there are no more rows in the result set.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_fetch($stmt, ?int $row = null, ?int $offset = null): ?bool
|
|
{
|
|
error_clear_last();
|
|
if ($offset !== null) {
|
|
$safeResult = \sqlsrv_fetch($stmt, $row, $offset);
|
|
} elseif ($row !== null) {
|
|
$safeResult = \sqlsrv_fetch($stmt, $row);
|
|
} else {
|
|
$safeResult = \sqlsrv_fetch($stmt);
|
|
}
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Frees all resources for the specified statement. The statement cannot be used
|
|
* after sqlsrv_free_stmt has been called on it. If
|
|
* sqlsrv_free_stmt is called on an in-progress statement
|
|
* that alters server state, statement execution is terminated and the statement
|
|
* is rolled back.
|
|
*
|
|
* @param resource $stmt The statement for which resources are freed.
|
|
* Note that NULL is a valid parameter value. This allows the function to be
|
|
* called multiple times in a script.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_free_stmt($stmt): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_free_stmt($stmt);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Gets field data from the currently selected row. Fields must be accessed in
|
|
* order. Field indices start at 0.
|
|
*
|
|
* @param resource $stmt A statement resource returned by sqlsrv_query or
|
|
* sqlsrv_execute.
|
|
* @param int $fieldIndex The index of the field to be retrieved. Field indices start at 0. Fields
|
|
* must be accessed in order. i.e. If you access field index 1, then field
|
|
* index 0 will not be available.
|
|
* @param int $getAsType The PHP data type for the returned field data. If this parameter is not
|
|
* set, the field data will be returned as its default PHP data type.
|
|
* For information about default PHP data types, see
|
|
* Default PHP Data Types
|
|
* in the Microsoft SQLSRV documentation.
|
|
* @return mixed Returns data from the specified field on success.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_get_field($stmt, int $fieldIndex, ?int $getAsType = null)
|
|
{
|
|
error_clear_last();
|
|
if ($getAsType !== null) {
|
|
$safeResult = \sqlsrv_get_field($stmt, $fieldIndex, $getAsType);
|
|
} else {
|
|
$safeResult = \sqlsrv_get_field($stmt, $fieldIndex);
|
|
}
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Makes the next result of the specified statement active. Results include result
|
|
* sets, row counts, and output parameters.
|
|
*
|
|
* @param resource $stmt The statement on which the next result is being called.
|
|
* @return bool|null Returns TRUE if the next result was successfully retrieved, FALSE if an error
|
|
* occurred, and NULL if there are no more results to retrieve.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_next_result($stmt): ?bool
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_next_result($stmt);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Retrieves the number of fields (columns) on a statement.
|
|
*
|
|
* @param resource $stmt The statement for which the number of fields is returned.
|
|
* sqlsrv_num_fields can be called on a statement before
|
|
* or after statement execution.
|
|
* @return int Returns the number of fields on success.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_num_fields($stmt): int
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_num_fields($stmt);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Retrieves the number of rows in a result set. This function requires that the
|
|
* statement resource be created with a static or keyset cursor. For more information,
|
|
* see sqlsrv_query, sqlsrv_prepare,
|
|
* or Specifying a Cursor Type and Selecting Rows
|
|
* in the Microsoft SQLSRV documentation.
|
|
*
|
|
* @param resource $stmt The statement for which the row count is returned. The statement resource
|
|
* must be created with a static or keyset cursor. For more information, see
|
|
* sqlsrv_query, sqlsrv_prepare, or
|
|
* Specifying a Cursor Type and Selecting Rows
|
|
* in the Microsoft SQLSRV documentation.
|
|
* @return int Returns the number of rows retrieved on success.
|
|
* If a forward cursor (the default) or dynamic cursor is used, FALSE is returned.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_num_rows($stmt): int
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_num_rows($stmt);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Prepares a query for execution. This function is ideal for preparing a query
|
|
* that will be executed multiple times with different parameter values.
|
|
*
|
|
* @param resource $conn A connection resource returned by sqlsrv_connect.
|
|
* @param string $sql The string that defines the query to be prepared and executed.
|
|
* @param array $params An array specifying parameter information when executing a parameterized
|
|
* query. Array elements can be any of the following:
|
|
*
|
|
* A literal value
|
|
* A PHP variable
|
|
* An array with this structure:
|
|
* array($value [, $direction [, $phpType [, $sqlType]]])
|
|
*
|
|
* The following table describes the elements in the array structure above:
|
|
* @param array $options An array specifying query property options. The supported keys are described
|
|
* in the following table:
|
|
* @return mixed Returns a statement resource on success.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_prepare($conn, string $sql, ?array $params = null, ?array $options = null)
|
|
{
|
|
error_clear_last();
|
|
if ($options !== null) {
|
|
$safeResult = \sqlsrv_prepare($conn, $sql, $params, $options);
|
|
} elseif ($params !== null) {
|
|
$safeResult = \sqlsrv_prepare($conn, $sql, $params);
|
|
} else {
|
|
$safeResult = \sqlsrv_prepare($conn, $sql);
|
|
}
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Prepares and executes a query.
|
|
*
|
|
* @param resource $conn A connection resource returned by sqlsrv_connect.
|
|
* @param string $sql The string that defines the query to be prepared and executed.
|
|
* @param array $params An array specifying parameter information when executing a parameterized query.
|
|
* Array elements can be any of the following:
|
|
*
|
|
* A literal value
|
|
* A PHP variable
|
|
* An array with this structure:
|
|
* array($value [, $direction [, $phpType [, $sqlType]]])
|
|
*
|
|
* The following table describes the elements in the array structure above:
|
|
* @param array $options An array specifying query property options. The supported keys are described
|
|
* in the following table:
|
|
* @return mixed Returns a statement resource on success.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_query($conn, string $sql, ?array $params = null, ?array $options = null)
|
|
{
|
|
error_clear_last();
|
|
if ($options !== null) {
|
|
$safeResult = \sqlsrv_query($conn, $sql, $params, $options);
|
|
} elseif ($params !== null) {
|
|
$safeResult = \sqlsrv_query($conn, $sql, $params);
|
|
} else {
|
|
$safeResult = \sqlsrv_query($conn, $sql);
|
|
}
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
return $safeResult;
|
|
}
|
|
|
|
|
|
/**
|
|
* Rolls back a transaction that was begun with sqlsrv_begin_transaction
|
|
* and returns the connection to auto-commit mode.
|
|
*
|
|
* @param resource $conn The connection resource returned by a call to sqlsrv_connect.
|
|
* @throws SqlsrvException
|
|
*
|
|
*/
|
|
function sqlsrv_rollback($conn): void
|
|
{
|
|
error_clear_last();
|
|
$safeResult = \sqlsrv_rollback($conn);
|
|
if ($safeResult === false) {
|
|
throw SqlsrvException::createFromPhpError();
|
|
}
|
|
}
|