Newer
Older
Larry Garfield
committed
<?php
namespace Drupal\Core\Database\Query;
Larry Garfield
committed
use Drupal\Core\Database\Database;
use Drupal\Core\Database\Connection;
Larry Garfield
committed
/**
* General class for an abstracted DELETE operation.
Angie Byron
committed
*
* @ingroup database
Larry Garfield
committed
*/
class Delete extends Query implements ConditionInterface {
use QueryConditionTrait;
Larry Garfield
committed
/**
* The table from which to delete.
*
* @var string
*/
protected $table;
/**
* Constructs a Delete object.
Larry Garfield
committed
*
Jennifer Hodgdon
committed
* @param \Drupal\Core\Database\Connection $connection
* A Connection object.
Larry Garfield
committed
* @param string $table
* Name of the table to associate with this query.
* @param array $options
* Array of database options.
*/
public function __construct(Connection $connection, $table, array $options = array()) {
$options['return'] = Database::RETURN_AFFECTED;
parent::__construct($connection, $options);
$this->table = $table;
$this->condition = new Condition('AND');
Larry Garfield
committed
}
/**
* Executes the DELETE query.
*
* @return int
* The number of rows affected by the delete query.
Larry Garfield
committed
*/
public function execute() {
$values = array();
if (count($this->condition)) {
$this->condition->compile($this->connection, $this);
$values = $this->condition->arguments();
}
return $this->connection->query((string) $this, $values, $this->queryOptions);
}
/**
* Implements PHP magic __toString method to convert the query to a string.
*
* @return string
* The prepared statement.
*/
public function __toString() {
// Create a sanitized comment string to prepend to the query.
$comments = $this->connection->makeComment($this->comments);
$query = $comments . 'DELETE FROM {' . $this->connection->escapeTable($this->table) . '} ';
if (count($this->condition)) {
$this->condition->compile($this->connection, $this);
$query .= "\nWHERE " . $this->condition;
}
return $query;
}
}