307 lines
8.4 KiB
PHP
307 lines
8.4 KiB
PHP
<?php
|
|
/*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the MIT license. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\DBAL;
|
|
|
|
use Doctrine\DBAL\Types\Type;
|
|
use Doctrine\DBAL\Driver\Statement as DriverStatement;
|
|
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.
|
|
*
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
* @since 2.0
|
|
*/
|
|
class Statement implements \IteratorAggregate, DriverStatement
|
|
{
|
|
/**
|
|
* The SQL statement.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $sql;
|
|
|
|
/**
|
|
* The bound parameters.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $params = [];
|
|
|
|
/**
|
|
* The parameter types.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $types = [];
|
|
|
|
/**
|
|
* The underlying driver statement.
|
|
*
|
|
* @var \Doctrine\DBAL\Driver\Statement
|
|
*/
|
|
protected $stmt;
|
|
|
|
/**
|
|
* The underlying database platform.
|
|
*
|
|
* @var \Doctrine\DBAL\Platforms\AbstractPlatform
|
|
*/
|
|
protected $platform;
|
|
|
|
/**
|
|
* The connection this statement is bound to and executed on.
|
|
*
|
|
* @var \Doctrine\DBAL\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 \Doctrine\DBAL\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 $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 $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 array|null $params
|
|
*
|
|
* @return bool TRUE on success, FALSE on failure.
|
|
*
|
|
* @throws \Doctrine\DBAL\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 (\Exception $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();
|
|
}
|
|
|
|
/**
|
|
* Fetches extended error information associated with the last operation on the statement.
|
|
*
|
|
* @return array
|
|
*/
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* Returns a single column from the next row of a result set.
|
|
*
|
|
* @param int $columnIndex
|
|
*
|
|
* @return mixed A single column from the next row of a result set or FALSE if there are no more rows.
|
|
*/
|
|
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;
|
|
}
|
|
}
|