function Connection::prepare
Same name in this branch
- 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Connection.php \Drupal\Core\Database\Driver\sqlite\Connection::prepare()
Same name in other branches
- 9 core/modules/sqlite/src/Driver/Database/sqlite/Connection.php \Drupal\sqlite\Driver\Database\sqlite\Connection::prepare()
- 9 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::prepare()
Prepares a statement for execution and returns a statement object
Emulated prepared statements do not communicate with the database server so this method does not check the statement.
Parameters
string $statement: This must be a valid SQL statement for the target database server.
array $driver_options: (optional) This array holds one or more key=>value pairs to set attribute values for the PDOStatement object that this method returns. You would most commonly use this to set the \PDO::ATTR_CURSOR value to \PDO::CURSOR_SCROLL to request a scrollable cursor. Some drivers have driver specific options that may be set at prepare-time. Defaults to an empty array.
Return value
\PDOStatement|false If the database server successfully prepares the statement, returns a \PDOStatement object. If the database server cannot successfully prepare the statement returns FALSE or emits \PDOException (depending on error handling).
Throws
\PDOException
See also
\PDO::prepare()
1 method overrides Connection::prepare()
- Connection::prepare in core/
lib/ Drupal/ Core/ Database/ Driver/ sqlite/ Connection.php - Prepares a statement for execution and returns a statement object
File
-
core/
lib/ Drupal/ Core/ Database/ Connection.php, line 1527
Class
- Connection
- Base Database API class.
Namespace
Drupal\Core\DatabaseCode
public function prepare($statement, array $driver_options = []) {
return $this->connection
->prepare($statement, $driver_options);
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.