class Delete in Drupal 8
Same name in this branch
- 8 core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
- 8 core/lib/Drupal/Core/Database/Driver/sqlite/Delete.php \Drupal\Core\Database\Driver\sqlite\Delete
- 8 core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php \Drupal\Core\Database\Driver\pgsql\Delete
- 8 core/lib/Drupal/Core/Database/Driver/mysql/Delete.php \Drupal\Core\Database\Driver\mysql\Delete
- 8 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Delete
- 8 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Delete
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
- 10 core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
General class for an abstracted DELETE operation.
Hierarchy
- class \Drupal\Core\Database\Query\Query implements PlaceholderInterface
- class \Drupal\Core\Database\Query\Delete implements ConditionInterface uses QueryConditionTrait
Expanded class hierarchy of Delete
Related topics
4 files declare their use of Delete
- DatabaseLegacyTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Database/ DatabaseLegacyTest.php - Delete.php in core/
lib/ Drupal/ Core/ Database/ Driver/ sqlite/ Delete.php - Delete.php in core/
lib/ Drupal/ Core/ Database/ Driver/ pgsql/ Delete.php - Delete.php in core/
lib/ Drupal/ Core/ Database/ Driver/ mysql/ Delete.php
164 string references to 'Delete'
- aggregator.links.task.yml in core/
modules/ aggregator/ aggregator.links.task.yml - core/modules/aggregator/aggregator.links.task.yml
- AggregatorController::adminOverview in core/
modules/ aggregator/ src/ Controller/ AggregatorController.php - Displays the aggregator administration page.
- AggregatorTestBase::deleteFeed in core/
modules/ aggregator/ src/ Tests/ AggregatorTestBase.php - Deletes an aggregator feed.
- AggregatorTestBase::deleteFeed in core/
modules/ aggregator/ tests/ src/ Functional/ AggregatorTestBase.php - Deletes an aggregator feed.
- BanAdmin::buildForm in core/
modules/ ban/ src/ Form/ BanAdmin.php
File
- core/
lib/ Drupal/ Core/ Database/ Query/ Delete.php, line 13
Namespace
Drupal\Core\Database\QueryView source
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 = []) {
$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();
}
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;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Delete:: |
protected | property | The table from which to delete. | |
Delete:: |
public | function |
Executes the DELETE query. Overrides Query:: |
1 |
Delete:: |
public | function |
Constructs a Delete object. Overrides Query:: |
|
Delete:: |
public | function |
Implements PHP magic __toString method to convert the query to a string. Overrides Query:: |
|
Query:: |
protected | property | An array of comments that can be prepended to a query. | |
Query:: |
protected | property | The connection object on which to run this query. | |
Query:: |
protected | property | The key of the connection object. | |
Query:: |
protected | property | The target of the connection object. | |
Query:: |
protected | property | The placeholder counter. | |
Query:: |
protected | property | The query options to pass on to the connection object. | |
Query:: |
protected | property | A unique identifier for this query object. | |
Query:: |
public | function | Adds a comment to the query. | |
Query:: |
public | function | Returns a reference to the comments array for the query. | |
Query:: |
public | function |
Gets the next placeholder value for this query object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function |
Returns a unique identifier for this object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function | Implements the magic __clone function. | 1 |
Query:: |
public | function | Implements the magic __sleep function to disconnect from the database. | |
Query:: |
public | function | Implements the magic __wakeup function to reconnect to the database. | |
QueryConditionTrait:: |
protected | property | The condition object for this query. | |
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | 1 | |
QueryConditionTrait:: |
public | function | 1 | |
QueryConditionTrait:: |
public | function | 1 | |
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function | ||
QueryConditionTrait:: |
public | function |