CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.6 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.6
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
      • Driver
      • Exception
      • Expression
      • Log
      • Query
      • Retry
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Interface StatementInterface

Represents a database statement. Concrete implementations can either use PDOStatement or a native driver

Namespace: Cake\Database

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

  • $queryString public @property-read
    string

Method Summary

  • 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.

  • 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

  • fetchColumn() public

    Returns the value of the result at position.

  • lastInsertId() public

    Returns the latest primary inserted using this statement

  • rowCount() public

    Returns the number of rows affected by this SQL statement

Method Detail

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.

It is not allowed to combine positional and named variables in the same statement

Examples:

$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');
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

name of configured Type class, or PDO type constant.

Returns
void

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 = '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, or PDO fetch mode constants.

Returns
mixed

fetchAll() ¶ public

fetchAll(string|int $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

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

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

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

$queryString ¶ public @property-read

Type
string
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs