function StatementWrapperIterator::setFetchMode

Sets the default fetch mode for this statement.

See http://php.net/manual/pdo.constants.php for the definition of the constants used.

Parameters

$mode: One of the \PDO::FETCH_* constants.

$a1: An option depending of the fetch mode specified by $mode:

  • for \PDO::FETCH_COLUMN, the index of the column to fetch
  • for \PDO::FETCH_CLASS, the name of the class to create
  • for \PDO::FETCH_INTO, the object to add the data to

$a2: If $mode is \PDO::FETCH_CLASS, the optional arguments to pass to the constructor.

Overrides StatementInterface::setFetchMode

4 calls to StatementWrapperIterator::setFetchMode()
StatementWrapperIterator::execute in core/lib/Drupal/Core/Database/StatementWrapperIterator.php
Executes a prepared statement.
StatementWrapperIterator::fetchAllAssoc in core/lib/Drupal/Core/Database/StatementWrapperIterator.php
Returns the result set as an associative array keyed by the given field.
StatementWrapperIterator::fetchAllKeyed in core/lib/Drupal/Core/Database/StatementWrapperIterator.php
Returns the entire result set as a single associative array.
StatementWrapperIterator::__construct in core/lib/Drupal/Core/Database/StatementWrapperIterator.php
Constructs a StatementWrapperIterator object.

File

core/lib/Drupal/Core/Database/StatementWrapperIterator.php, line 271

Class

StatementWrapperIterator
StatementInterface iterator implementation.

Namespace

Drupal\Core\Database

Code

public function setFetchMode($mode, $a1 = NULL, $a2 = []) {
    if (!in_array($mode, $this->supportedFetchModes)) {
        @trigger_error('Fetch mode ' . ($this->fetchModeLiterals[$mode] ?? $mode) . ' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. Use supported modes only. See https://www.drupal.org/node/3377999', E_USER_DEPRECATED);
    }
    // Call \PDOStatement::setFetchMode to set fetch mode.
    // \PDOStatement is picky about the number of arguments in some cases so we
    // need to be pass the exact number of arguments we where given.
    return match (func_num_args()) {    1 => $this->clientStatement
            ->setFetchMode($mode),
        2 => $this->clientStatement
            ->setFetchMode($mode, $a1),
        default => $this->clientStatement
            ->setFetchMode($mode, $a1, $a2),
    
    };
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.