123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284 |
- <?php
- namespace Doctrine\DBAL;
- use Doctrine\DBAL\Driver\Statement as DriverStatement;
- use Doctrine\DBAL\Platforms\AbstractPlatform;
- use Doctrine\DBAL\Types\Type;
- use IteratorAggregate;
- use PDO;
- use Throwable;
- use function is_array;
- use function is_string;
- /**
- * A thin wrapper around a Doctrine\DBAL\Driver\Statement that adds support
- * for logging, DBAL mapping types, etc.
- */
- class Statement implements IteratorAggregate, DriverStatement
- {
- /**
- * The SQL statement.
- *
- * @var string
- */
- protected $sql;
- /**
- * The bound parameters.
- *
- * @var mixed[]
- */
- protected $params = [];
- /**
- * The parameter types.
- *
- * @var int[]|string[]
- */
- protected $types = [];
- /**
- * The underlying driver statement.
- *
- * @var \Doctrine\DBAL\Driver\Statement
- */
- protected $stmt;
- /**
- * The underlying database platform.
- *
- * @var AbstractPlatform
- */
- protected $platform;
- /**
- * The connection this statement is bound to and executed on.
- *
- * @var Connection
- */
- protected $conn;
- /**
- * Creates a new <tt>Statement</tt> for the given SQL and <tt>Connection</tt>.
- *
- * @param string $sql The SQL of the statement.
- * @param Connection $conn The connection on which the statement should be executed.
- */
- public function __construct($sql, Connection $conn)
- {
- $this->sql = $sql;
- $this->stmt = $conn->getWrappedConnection()->prepare($sql);
- $this->conn = $conn;
- $this->platform = $conn->getDatabasePlatform();
- }
- /**
- * Binds a parameter value to the statement.
- *
- * The value can optionally be bound with a PDO binding type or a DBAL mapping type.
- * If bound with a DBAL mapping type, the binding type is derived from the mapping
- * type and the value undergoes the conversion routines of the mapping type before
- * being bound.
- *
- * @param string|int $name The name or position of the parameter.
- * @param mixed $value The value of the parameter.
- * @param mixed $type Either a PDO binding type or a DBAL mapping type name or instance.
- *
- * @return bool TRUE on success, FALSE on failure.
- */
- public function bindValue($name, $value, $type = ParameterType::STRING)
- {
- $this->params[$name] = $value;
- $this->types[$name] = $type;
- if ($type !== null) {
- if (is_string($type)) {
- $type = Type::getType($type);
- }
- if ($type instanceof Type) {
- $value = $type->convertToDatabaseValue($value, $this->platform);
- $bindingType = $type->getBindingType();
- } else {
- $bindingType = $type;
- }
- return $this->stmt->bindValue($name, $value, $bindingType);
- }
- return $this->stmt->bindValue($name, $value);
- }
- /**
- * Binds a parameter to a value by reference.
- *
- * Binding a parameter by reference does not support DBAL mapping types.
- *
- * @param string|int $name The name or position of the parameter.
- * @param mixed $var The reference to the variable to bind.
- * @param int $type The PDO binding type.
- * @param int|null $length Must be specified when using an OUT bind
- * so that PHP allocates enough memory to hold the returned value.
- *
- * @return bool TRUE on success, FALSE on failure.
- */
- public function bindParam($name, &$var, $type = ParameterType::STRING, $length = null)
- {
- $this->params[$name] = $var;
- $this->types[$name] = $type;
- return $this->stmt->bindParam($name, $var, $type, $length);
- }
- /**
- * Executes the statement with the currently bound parameters.
- *
- * @param mixed[]|null $params
- *
- * @return bool TRUE on success, FALSE on failure.
- *
- * @throws DBALException
- */
- public function execute($params = null)
- {
- if (is_array($params)) {
- $this->params = $params;
- }
- $logger = $this->conn->getConfiguration()->getSQLLogger();
- if ($logger) {
- $logger->startQuery($this->sql, $this->params, $this->types);
- }
- try {
- $stmt = $this->stmt->execute($params);
- } catch (Throwable $ex) {
- if ($logger) {
- $logger->stopQuery();
- }
- throw DBALException::driverExceptionDuringQuery(
- $this->conn->getDriver(),
- $ex,
- $this->sql,
- $this->conn->resolveParams($this->params, $this->types)
- );
- }
- if ($logger) {
- $logger->stopQuery();
- }
- $this->params = [];
- $this->types = [];
- return $stmt;
- }
- /**
- * Closes the cursor, freeing the database resources used by this statement.
- *
- * @return bool TRUE on success, FALSE on failure.
- */
- public function closeCursor()
- {
- return $this->stmt->closeCursor();
- }
- /**
- * Returns the number of columns in the result set.
- *
- * @return int
- */
- public function columnCount()
- {
- return $this->stmt->columnCount();
- }
- /**
- * Fetches the SQLSTATE associated with the last operation on the statement.
- *
- * @return string|int|bool
- */
- public function errorCode()
- {
- return $this->stmt->errorCode();
- }
- /**
- * {@inheritDoc}
- */
- public function errorInfo()
- {
- return $this->stmt->errorInfo();
- }
- /**
- * {@inheritdoc}
- */
- public function setFetchMode($fetchMode, $arg2 = null, $arg3 = null)
- {
- if ($arg2 === null) {
- return $this->stmt->setFetchMode($fetchMode);
- } elseif ($arg3 === null) {
- return $this->stmt->setFetchMode($fetchMode, $arg2);
- }
- return $this->stmt->setFetchMode($fetchMode, $arg2, $arg3);
- }
- /**
- * Required by interface IteratorAggregate.
- *
- * {@inheritdoc}
- */
- public function getIterator()
- {
- return $this->stmt;
- }
- /**
- * {@inheritdoc}
- */
- public function fetch($fetchMode = null, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0)
- {
- return $this->stmt->fetch($fetchMode);
- }
- /**
- * {@inheritdoc}
- */
- public function fetchAll($fetchMode = null, $fetchArgument = null, $ctorArgs = null)
- {
- if ($fetchArgument) {
- return $this->stmt->fetchAll($fetchMode, $fetchArgument);
- }
- return $this->stmt->fetchAll($fetchMode);
- }
- /**
- * {@inheritDoc}
- */
- public function fetchColumn($columnIndex = 0)
- {
- return $this->stmt->fetchColumn($columnIndex);
- }
- /**
- * Returns the number of rows affected by the last execution of this statement.
- *
- * @return int The number of affected rows.
- */
- public function rowCount()
- {
- return $this->stmt->rowCount();
- }
- /**
- * Gets the wrapped driver statement.
- *
- * @return \Doctrine\DBAL\Driver\Statement
- */
- public function getWrappedStatement()
- {
- return $this->stmt;
- }
- }
|