class Delete
General class for an abstracted DELETE operation.
Hierarchy
- class \Drupal\Core\Database\Query\Query implements \Drupal\Core\Database\Query\PlaceholderInterface- class \Drupal\Core\Database\Query\Delete implements \Drupal\Core\Database\Query\ConditionInterface uses \Drupal\Core\Database\Query\QueryConditionTrait extends \Drupal\Core\Database\Query\Query
 
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/ mysql/ Delete.php 
- Delete.php in core/lib/ Drupal/ Core/ Database/ Driver/ pgsql/ Delete.php 
373 string references to 'Delete'
- AccessTest::testOnlyOwnerCanDeleteUpdateFile in core/modules/ file/ tests/ src/ Kernel/ AccessTest.php 
- Tests that only the file owner can delete or update a file.
- 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/ tests/ src/ Functional/ AggregatorTestBase.php 
- Deletes an aggregator feed.
- AggregatorTestBase::deleteFeed in core/modules/ aggregator/ src/ Tests/ AggregatorTestBase.php 
- Deletes an aggregator feed.
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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| Delete::$table | protected | property | The table from which to delete. | ||
| Delete::execute | public | function | Executes the DELETE query. | Overrides Query::execute | 1 | 
| Delete::__construct | public | function | Constructs a Delete object. | Overrides Query::__construct | |
| Delete::__toString | public | function | Implements PHP magic __toString method to convert the query to a string. | Overrides Query::__toString | |
| Query::$comments | protected | property | An array of comments that can be prepended to a query. | ||
| Query::$connection | protected | property | The connection object on which to run this query. | ||
| Query::$connectionKey | protected | property | The key of the connection object. | ||
| Query::$connectionTarget | protected | property | The target of the connection object. | ||
| Query::$nextPlaceholder | protected | property | The placeholder counter. | ||
| Query::$queryOptions | protected | property | The query options to pass on to the connection object. | ||
| Query::$uniqueIdentifier | protected | property | A unique identifier for this query object. | ||
| Query::comment | public | function | Adds a comment to the query. | ||
| Query::getComments | public | function | Returns a reference to the comments array for the query. | ||
| Query::nextPlaceholder | public | function | Gets the next placeholder value for this query object. | Overrides PlaceholderInterface::nextPlaceholder | |
| Query::uniqueIdentifier | public | function | Returns a unique identifier for this object. | Overrides PlaceholderInterface::uniqueIdentifier | |
| Query::__clone | public | function | Implements the magic __clone function. | 1 | |
| Query::__sleep | public | function | Implements the magic __sleep function to disconnect from the database. | ||
| Query::__wakeup | public | function | Implements the magic __wakeup function to reconnect to the database. | ||
| QueryConditionTrait::$condition | protected | property | The condition object for this query. | ||
| QueryConditionTrait::alwaysFalse | public | function | |||
| QueryConditionTrait::andConditionGroup | public | function | |||
| QueryConditionTrait::arguments | public | function | 1 | ||
| QueryConditionTrait::compile | public | function | 1 | ||
| QueryConditionTrait::compiled | public | function | 1 | ||
| QueryConditionTrait::condition | public | function | |||
| QueryConditionTrait::conditionGroupFactory | public | function | |||
| QueryConditionTrait::conditions | public | function | |||
| QueryConditionTrait::exists | public | function | |||
| QueryConditionTrait::isNotNull | public | function | |||
| QueryConditionTrait::isNull | public | function | |||
| QueryConditionTrait::notExists | public | function | |||
| QueryConditionTrait::orConditionGroup | public | function | |||
| QueryConditionTrait::where | public | function | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
