Delete.php
Same filename in this branch
- 10 core/modules/sqlite/src/Driver/Database/sqlite/Delete.php
- 10 core/modules/mysql/src/Driver/Database/mysql/Delete.php
- 10 core/modules/pgsql/src/Driver/Database/pgsql/Delete.php
- 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Delete.php
- 10 core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php
Same filename in other branches
- 9 core/modules/sqlite/src/Driver/Database/sqlite/Delete.php
- 9 core/modules/mysql/src/Driver/Database/mysql/Delete.php
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Delete.php
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Delete.php
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Delete.php
- 9 core/modules/pgsql/src/Driver/Database/pgsql/Delete.php
- 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Delete.php
- 9 core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php
- 9 core/lib/Drupal/Core/Database/Query/Delete.php
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Delete.php
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Delete.php
- 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Delete.php
- 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Delete.php
- 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php
- 8.9.x core/lib/Drupal/Core/Database/Query/Delete.php
- 11.x core/modules/sqlite/src/Driver/Database/sqlite/Delete.php
- 11.x core/modules/mysql/src/Driver/Database/mysql/Delete.php
- 11.x core/modules/pgsql/src/Driver/Database/pgsql/Delete.php
- 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Delete.php
- 11.x core/lib/Drupal/Core/Database/Query/Delete.php
Namespace
Drupal\Core\Database\QueryFile
-
core/
lib/ Drupal/ Core/ Database/ Query/ Delete.php
View source
<?php
namespace Drupal\Core\Database\Query;
use Drupal\Core\Database\Database;
use Drupal\Core\Database\Connection;
/**
* General class for an abstracted DELETE operation.
*
* @ingroup database
*/
class Delete extends Query implements ConditionInterface {
use QueryConditionTrait;
/**
* The table from which to delete.
*
* @var string
*/
protected $table;
/**
* Constructs a Delete object.
*
* @param \Drupal\Core\Database\Connection $connection
* A Connection object.
* @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 = []) {
// @todo Remove $options['return'] in Drupal 11.
// @see https://www.drupal.org/project/drupal/issues/3256524
$options['return'] = Database::RETURN_AFFECTED;
parent::__construct($connection, $options);
$this->table = $table;
$this->condition = $this->connection
->condition('AND');
}
/**
* Executes the DELETE query.
*
* @return int
* The number of rows affected by the delete query.
*/
public function execute() {
$values = [];
if (count($this->condition)) {
$this->condition
->compile($this->connection, $this);
$values = $this->condition
->arguments();
}
$stmt = $this->connection
->prepareStatement((string) $this, $this->queryOptions, TRUE);
try {
$stmt->execute($values, $this->queryOptions);
return $stmt->rowCount();
} catch (\Exception $e) {
$this->connection
->exceptionHandler()
->handleExecutionException($e, $stmt, $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;
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
Delete | General class for an abstracted DELETE operation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.