Class SqlserverStatement

Statement class meant to be used by an Sqlserver driver

Namespace: Cake\Database\Statement

Constants

string

FETCH_TYPE_ASSOC ¶
```
'assoc'
```
Used to designate that an associated array be returned in a result when calling fetch methods
string

FETCH_TYPE_NUM ¶
```
'num'
```
Used to designate that numeric indexes be returned in a result when calling fetch methods
string

FETCH_TYPE_OBJ ¶
```
'obj'
```
Used to designate that a stdClass object be returned in a result when calling fetch methods

Property Summary

$_driver protected

Cake\Database\DriverInterface

Reference to the driver object associated to this statement.
$_hasExecuted protected

bool

Whether this statement has already been executed
$_statement protected

PDOStatement

PDOStatement instance
$queryString public @property-read

string

Method Summary

__construct() public

Constructor
__get() public

Magic getter to return PDOStatement::$queryString as read-only.
bind() public

Binds a set of values to statement object with corresponding type.
bindValue() public

Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.
cast() public

Converts a give value to a suitable database value based on type and return relevant internal statement type
closeCursor() public

Closes a cursor in the database, freeing up any resources and memory allocated to it. In most cases you don't need to call this method, as it is automatically called after fetching all results from the result set.
columnCount() public

Returns the number of columns this statement's results will contain.
count() public

Statements can be passed as argument for count() to return the number for affected rows from last execution.
errorCode() public

Returns the error code for the last error that occurred when executing this statement.
errorInfo() public

Returns the error information for the last error that occurred when executing this statement.
execute() public

Executes the statement by sending the SQL query to the database. It can optionally take an array or arguments to be bound to the query variables. Please note that binding parameters from this method will not perform any custom type conversion as it would normally happen when calling bindValue.
fetch() public

Returns the next row for the result set after executing this statement. Rows can be fetched to contain columns as names or positions. If no rows are left in result set, this method will return false
fetchAll() public

Returns an array with all rows resulting from executing this statement
fetchAssoc() public

Returns the next row in a result set as an associative array. Calling this function is the same as calling $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). If no results are found an empty array is returned.
fetchColumn() public

Returns the value of the result at position.
getInnerStatement() public

Returns the statement object that was decorated by this class.
getIterator() public

Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
lastInsertId() public

Returns the latest primary inserted using this statement.
matchTypes() public

Matches columns to corresponding types
rowCount() public

Returns the number of rows affected by this SQL statement.

Method Detail

__construct() ¶ public

__construct(PDOStatement $statement, Cake\Database\DriverInterface $driver)

Constructor

Parameters

PDOStatement $statement: Original statement to be decorated.
Cake\Database\DriverInterface $driver: Driver instance.

__get() ¶ public

__get(string $property): string|null

Magic getter to return PDOStatement::$queryString as read-only.

Parameters

string $property: internal property to get

Returns

string|null

bind() ¶ public

bind(array $params, array $types): void

Binds a set of values to statement object with corresponding type.

Parameters

array $params: list of values to be bound
array $types: list of types to be used, keys should match those in $params

Returns

void

bindValue() ¶ public

bindValue(string|int $column, mixed $value, string|int|null $type = 'string'): void

Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.

The SQL Server PDO driver requires that binary parameters be bound with the SQLSRV_ENCODING_BINARY attribute. This overrides the PDOStatement::bindValue method in order to bind binary columns using the required attribute.

Parameters

string|int $column: name or param position to be bound
mixed $value: The value to bind to variable in query
string|int|null $type optional: PDO type or name of configured Type class

Returns

void

cast() ¶ public

cast(mixed $value, Cake\Database\TypeInterface|string|int $type = 'string'): array

Converts a give value to a suitable database value based on type and return relevant internal statement type

Parameters

mixed $value: The value to cast
Cake\Database\TypeInterface|string|int $type optional: The type name or type instance to use.

Returns

array

closeCursor() ¶ public

closeCursor(): void

Closes a cursor in the database, freeing up any resources and memory allocated to it. In most cases you don't need to call this method, as it is automatically called after fetching all results from the result set.

Returns

void

columnCount() ¶ public

columnCount(): int

Returns the number of columns this statement's results will contain.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Returns

int

count() ¶ public

count(): int

Statements can be passed as argument for count() to return the number for affected rows from last execution.

Returns

int

errorCode() ¶ public

errorCode(): string|int

Returns the error code for the last error that occurred when executing this statement.

Returns

string|int

errorInfo() ¶ public

errorInfo(): array

Returns the error information for the last error that occurred when executing this statement.

Returns

array

execute() ¶ public

execute(array|null $params = null): bool

Executes the statement by sending the SQL query to the database. It can optionally take an array or arguments to be bound to the query variables. Please note that binding parameters from this method will not perform any custom type conversion as it would normally happen when calling bindValue.

Parameters

array|null $params optional: list of values to be bound to query

Returns

bool

fetch() ¶ public

fetch(string|int $type = parent::FETCH_TYPE_NUM): mixed

Returns the next row for the result set after executing this statement. Rows can be fetched to contain columns as names or positions. If no rows are left in result set, this method will return false

Example:

 $statement = $connection->prepare('SELECT id, title from articles');
 $statement->execute();
 print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']

Parameters

string|int $type optional: 'num' for positional columns, assoc for named columns

Returns

mixed

fetchAll() ¶ public

fetchAll(string|int $type = parent::FETCH_TYPE_NUM): array|false

Returns an array with all rows resulting from executing this statement

Example:

 $statement = $connection->prepare('SELECT id, title from articles');
 $statement->execute();
 print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]

Parameters

string|int $type optional: num for fetching columns as positional keys or assoc for column names as keys

Returns

array|false

fetchAssoc() ¶ public

fetchAssoc(): array

Returns the next row in a result set as an associative array. Calling this function is the same as calling $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). If no results are found an empty array is returned.

Returns

array

fetchColumn() ¶ public

fetchColumn(int $position): mixed

Returns the value of the result at position.

Parameters

int $position: The numeric position of the column to retrieve in the result

Returns

mixed

getInnerStatement() ¶ public

getInnerStatement(): Cake\Database\StatementInterface

Returns the statement object that was decorated by this class.

Returns

Cake\Database\StatementInterface

getIterator() ¶ public

getIterator(): Cake\Database\StatementInterface

Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
  //do stuff
}

Returns

Cake\Database\StatementInterface

lastInsertId() ¶ public

lastInsertId(string|null $table = null, string|null $column = null): string|int

Returns the latest primary inserted using this statement.

Parameters

string|null $table optional: table name or sequence to get last insert value from
string|null $column optional: the name of the column representing the primary key

Returns

string|int

matchTypes() ¶ public

matchTypes(array $columns, array $types): array

Matches columns to corresponding types

Both $columns and $types should either be numeric based or string key based at the same time.

Parameters

array $columns: list or associative array of columns and parameters to be bound with types
array $types: list or associative array of types

Returns

array

rowCount() ¶ public

rowCount(): int

Returns the number of rows affected by this SQL statement.

Example:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Returns

int

Property Detail

`$_driver` ¶ protected

Reference to the driver object associated to this statement.

Type

Cake\Database\DriverInterface

`$_hasExecuted` ¶ protected

Whether this statement has already been executed

Type

bool

`$_statement` ¶ protected

PDOStatement instance

Type

PDOStatement

`$queryString` ¶ public @property-read

Type

string

Namespaces

Class SqlserverStatement

Constants

Property Summary

Method Summary

__construct() public

__get() public

bind() public

bindValue() public

cast() public

closeCursor() public

columnCount() public

count() public

errorCode() public

errorInfo() public

execute() public

fetch() public

fetchAll() public

fetchAssoc() public

fetchColumn() public

getInnerStatement() public

getIterator() public

lastInsertId() public

matchTypes() public

rowCount() public

Method Detail

__construct() ¶ public

Parameters

__get() ¶ public

Parameters

Returns

bind() ¶ public

Parameters

Returns

bindValue() ¶ public

Parameters

Returns

cast() ¶ public

Parameters

Returns

closeCursor() ¶ public

Returns

columnCount() ¶ public

Example:

Returns

count() ¶ public

Returns

errorCode() ¶ public

Returns

errorInfo() ¶ public

Returns

execute() ¶ public

Parameters

Returns

fetch() ¶ public

Example:

Parameters

Returns

fetchAll() ¶ public

Example:

Parameters

Returns

fetchAssoc() ¶ public

Returns

fetchColumn() ¶ public

Parameters

Returns

getInnerStatement() ¶ public

Returns

getIterator() ¶ public

Example:

Returns

lastInsertId() ¶ public

Parameters

Returns

matchTypes() ¶ public

Parameters

Returns

rowCount() ¶ public

Example:

`$_driver` ¶ protected

`$_hasExecuted` ¶ protected

`$_statement` ¶ protected

`$queryString` ¶ public @property-read