class Statement

Same name in this branch
  1. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Statement.php \Drupal\sqlite\Driver\Database\sqlite\Statement
Same name and namespace in other branches
  1. 9 core/modules/sqlite/src/Driver/Database/sqlite/Statement.php \Drupal\sqlite\Driver\Database\sqlite\Statement
  2. 9 core/lib/Drupal/Core/Database/Driver/sqlite/Statement.php \Drupal\Core\Database\Driver\sqlite\Statement
  3. 9 core/lib/Drupal/Core/Database/Statement.php \Drupal\Core\Database\Statement
  4. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Statement.php \Drupal\Core\Database\Driver\sqlite\Statement
  5. 8.9.x core/lib/Drupal/Core/Database/Statement.php \Drupal\Core\Database\Statement
  6. 10 core/modules/sqlite/src/Driver/Database/sqlite/Statement.php \Drupal\sqlite\Driver\Database\sqlite\Statement
  7. 10 core/lib/Drupal/Core/Database/Driver/sqlite/Statement.php \Drupal\Core\Database\Driver\sqlite\Statement

MySQLi implementation of \Drupal\Core\Database\Query\StatementInterface.

Hierarchy

Expanded class hierarchy of Statement

File

core/modules/mysqli/src/Driver/Database/mysqli/Statement.php, line 14

Namespace

Drupal\mysqli\Driver\Database\mysqli
View source
class Statement extends StatementBase {
  
  /**
   * Holds the index position of named parameters.
   *
   * The mysqli driver only allows positional placeholders '?', whereas in
   * Drupal the SQL is generated with named placeholders ':name'. In order to
   * execute the SQL, the string containing the named placeholders is converted
   * to using positional ones, and the position (index) of each named
   * placeholder in the string is stored here.
   */
  protected array $paramsPositions;
  
  /**
   * Constructs a Statement object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   Drupal database connection object.
   * @param \mysqli $clientConnection
   *   Client database connection object.
   * @param string $queryString
   *   The SQL query string.
   * @param array $driverOpts
   *   (optional) Array of query options.
   * @param bool $rowCountEnabled
   *   (optional) Enables counting the rows affected. Defaults to FALSE.
   */
  public function __construct(Connection $connection, \mysqli $clientConnection, string $queryString, protected array $driverOpts = [], bool $rowCountEnabled = FALSE) {
    parent::__construct($connection, $clientConnection, $queryString, $rowCountEnabled);
    $this->setFetchMode(FetchAs::Object);
  }
  
  /**
   * Returns the client-level database statement object.
   *
   * This method should normally be used only within database driver code.
   *
   * @return \mysqli_stmt
   *   The client-level database statement.
   */
  public function getClientStatement() : \mysqli_stmt {
    if ($this->hasClientStatement()) {
      assert($this->clientStatement instanceof \mysqli_stmt);
      return $this->clientStatement;
    }
    throw new \LogicException('\\mysqli_stmt not initialized');
  }
  
  /**
   * {@inheritdoc}
   */
  public function execute($args = [], $options = []) {
    if (isset($options['fetch'])) {
      if (is_string($options['fetch'])) {
        $this->setFetchMode(FetchAs::ClassObject, $options['fetch']);
      }
      else {
        if (is_int($options['fetch'])) {
          @trigger_error("Passing the 'fetch' key as an integer to \$options in execute() is deprecated in drupal:11.2.0 and is removed from drupal:12.0.0. Use a case of \\Drupal\\Core\\Database\\Statement\\FetchAs enum instead. See https://www.drupal.org/node/3488338", E_USER_DEPRECATED);
        }
        $this->setFetchMode($options['fetch']);
      }
    }
    $startEvent = $this->dispatchStatementExecutionStartEvent($args ?? []);
    try {
      // Prepare the lower-level statement if it's not been prepared already.
      if (!$this->hasClientStatement()) {
        // Replace named placeholders with positional ones if needed.
        $this->paramsPositions = array_flip(array_keys($args));
        $converter = new NamedPlaceholderConverter();
        $converter->parse($this->queryString, $args);
        [
          $convertedQueryString,
          $args,
        ] = [
          $converter->getConvertedSQL(),
          $converter->getConvertedParameters(),
        ];
        $this->clientStatement = $this->clientConnection
          ->prepare($convertedQueryString);
      }
      else {
        // Transform the $args to positional.
        $tmp = [];
        foreach ($this->paramsPositions as $param => $pos) {
          $tmp[$pos] = $args[$param];
        }
        $args = $tmp;
      }
      // In mysqli, the results of the statement execution are returned in a
      // different object than the statement itself.
      $return = $this->getClientStatement()
        ->execute($args);
      $this->result = new Result($this->fetchMode, $this->fetchOptions, $this->getClientStatement()
        ->get_result(), $this->clientConnection);
      $this->markResultsetIterable($return);
    } catch (\Exception $e) {
      $this->dispatchStatementExecutionFailureEvent($startEvent, $e);
      throw $e;
    }
    $this->dispatchStatementExecutionEndEvent($startEvent);
    return $return;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
FetchModeTrait::$fetchModeLiterals protected property Map FETCH_* modes to their literal for inclusion in messages.
FetchModeTrait::$supportedFetchModes protected property The fetch modes supported.
FetchModeTrait::assocToClass protected function Converts a row of data in FETCH_ASSOC format to FETCH_CLASS.
FetchModeTrait::assocToColumn protected function Converts a row of data in FETCH_ASSOC format to FETCH_COLUMN.
FetchModeTrait::assocToFetchMode protected function Converts a row of data in associative format to a specified format.
FetchModeTrait::assocToNum protected function Converts a row of data in FETCH_ASSOC format to FETCH_NUM.
FetchModeTrait::assocToObj protected function Converts a row of data in FETCH_ASSOC format to FETCH_OBJ.
PdoTrait::clientExecute protected function Executes the prepared PDO statement.
PdoTrait::clientFetch protected function Fetches the next row from the PDO statement.
PdoTrait::clientFetchAll protected function Returns an array containing all of the result set rows.
PdoTrait::clientFetchColumn protected function Returns a single column from the next row of a result set.
PdoTrait::clientFetchObject protected function Fetches the next row and returns it as an object.
PdoTrait::clientQueryString protected function Returns the query string used to prepare the statement.
PdoTrait::clientRowCount protected function Returns the number of rows affected by the last SQL statement.
PdoTrait::clientSetFetchMode protected function Sets the default fetch mode for the PDO statement.
PdoTrait::fetchAsToPdo protected function Converts a FetchAs mode to a \PDO::FETCH_* constant value.
PdoTrait::pdoToFetchAs protected function Converts a \PDO::FETCH_* constant value to a FetchAs mode.
Statement::$paramsPositions protected property Holds the index position of named parameters.
Statement::execute public function Executes a prepared statement. Overrides StatementBase::execute
Statement::getClientStatement public function Returns the client-level database statement object. Overrides StatementBase::getClientStatement
Statement::__construct public function Constructs a Statement object. Overrides StatementBase::__construct
StatementBase::$clientStatement protected property The client database Statement object.
StatementBase::$fetchMode protected property Holds the default fetch mode.
StatementBase::$fetchOptions protected property Holds fetch options.
StatementBase::$result protected property The results of a data query language (DQL) statement.
StatementBase::dispatchStatementExecutionEndEvent protected function Dispatches an event informing that the statement execution succeeded.
StatementBase::dispatchStatementExecutionFailureEvent protected function Dispatches an event informing of the statement execution failure.
StatementBase::dispatchStatementExecutionStartEvent protected function Dispatches an event informing that the statement execution begins.
StatementBase::fetch public function Fetches the next row from a result set. Overrides StatementInterface::fetch
StatementBase::fetchAll public function Returns an array containing all of the result set rows. Overrides StatementInterface::fetchAll
StatementBase::fetchAllAssoc public function Returns the result set as an associative array keyed by the given field. Overrides StatementInterface::fetchAllAssoc
StatementBase::fetchAllKeyed public function Returns the entire result set as a single associative array. Overrides StatementInterface::fetchAllKeyed
StatementBase::fetchAssoc public function Fetches the next row and returns it as an associative array. Overrides StatementInterface::fetchAssoc
StatementBase::fetchCol public function Returns an entire single column of a result set as an indexed array. Overrides StatementInterface::fetchCol
StatementBase::fetchField public function Returns a single field from the next record of a result set. Overrides StatementInterface::fetchField
StatementBase::fetchObject public function Fetches the next row and returns it as an object. Overrides StatementInterface::fetchObject
StatementBase::getConnectionTarget public function Returns the target connection this statement is associated with. Overrides StatementInterface::getConnectionTarget
StatementBase::getQueryString public function Gets the query string of this statement. Overrides StatementInterface::getQueryString
StatementBase::hasClientStatement public function Determines if the client-level database statement object exists.
StatementBase::rowCount public function Returns the number of rows matched by the last SQL statement. Overrides StatementInterface::rowCount
StatementBase::setFetchMode public function Sets the default fetch mode for this statement. Overrides StatementInterface::setFetchMode
StatementIteratorTrait::$isResultsetIterable private property Traces if rows can be fetched from the resultset.
StatementIteratorTrait::$resultsetKey private property The key of the current row.
StatementIteratorTrait::$resultsetRow private property The current row, retrieved in the current fetch format.
StatementIteratorTrait::current public function Returns the current element.
StatementIteratorTrait::getResultsetCurrentRowIndex protected function Returns the row index of the current element in the resultset.
StatementIteratorTrait::key public function Returns the key of the current element.
StatementIteratorTrait::markResultsetFetchingComplete protected function Informs the iterator that no more rows can be fetched from the resultset.
StatementIteratorTrait::markResultsetIterable protected function Informs the iterator whether rows can be fetched from the resultset.
StatementIteratorTrait::next public function Moves the current position to the next element.
StatementIteratorTrait::rewind public function Rewinds back to the first element of the Iterator.
StatementIteratorTrait::setResultsetCurrentRow protected function Sets the current resultset row for the iterator, and increments the key.
StatementIteratorTrait::valid public function Checks if current position is valid.

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