class Delete

Same name in this branch
  1. 9 core/modules/sqlite/src/Driver/Database/sqlite/Delete.php \Drupal\sqlite\Driver\Database\sqlite\Delete
  2. 9 core/modules/mysql/src/Driver/Database/mysql/Delete.php \Drupal\mysql\Driver\Database\mysql\Delete
  3. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Delete
  4. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Delete.php \Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion\Delete
  5. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Delete
  6. 9 core/modules/pgsql/src/Driver/Database/pgsql/Delete.php \Drupal\pgsql\Driver\Database\pgsql\Delete
  7. 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Delete.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Delete
  8. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php \Drupal\Core\Database\Driver\pgsql\Delete
Same name and namespace in other branches
  1. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Delete.php \Drupal\sqlite\Driver\Database\sqlite\Delete
  2. 11.x core/modules/mysql/src/Driver/Database/mysql/Delete.php \Drupal\mysql\Driver\Database\mysql\Delete
  3. 11.x core/modules/pgsql/src/Driver/Database/pgsql/Delete.php \Drupal\pgsql\Driver\Database\pgsql\Delete
  4. 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Delete.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Delete
  5. 11.x core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
  6. 10 core/modules/sqlite/src/Driver/Database/sqlite/Delete.php \Drupal\sqlite\Driver\Database\sqlite\Delete
  7. 10 core/modules/mysql/src/Driver/Database/mysql/Delete.php \Drupal\mysql\Driver\Database\mysql\Delete
  8. 10 core/modules/pgsql/src/Driver/Database/pgsql/Delete.php \Drupal\pgsql\Driver\Database\pgsql\Delete
  9. 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Delete.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Delete
  10. 10 core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php \Drupal\Core\Database\Driver\pgsql\Delete
  11. 10 core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
  12. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Delete
  13. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Delete
  14. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Delete.php \Drupal\Core\Database\Driver\sqlite\Delete
  15. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Delete.php \Drupal\Core\Database\Driver\mysql\Delete
  16. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php \Drupal\Core\Database\Driver\pgsql\Delete
  17. 8.9.x core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete

General class for an abstracted DELETE operation.

Hierarchy

Expanded class hierarchy of Delete

Related topics

5 files declare their use of Delete
Connection.php in core/lib/Drupal/Core/Database/Connection.php
Delete.php in core/modules/sqlite/src/Driver/Database/sqlite/Delete.php
Delete.php in core/modules/mysql/src/Driver/Database/mysql/Delete.php
Delete.php in core/modules/pgsql/src/Driver/Database/pgsql/Delete.php
Delete.php in core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Delete.php
364 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.
BanAdmin::buildForm in core/modules/ban/src/Form/BanAdmin.php

... See full list

File

core/lib/Drupal/Core/Database/Query/Delete.php, line 13

Namespace

Drupal\Core\Database\Query
View 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 = []) {
    // @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;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.