class Delete in Drupal 10

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

Related topics

Database abstraction layer

Allow the use of different database servers using the same code base.

4 files declare their use of Delete

Delete.php in core/modules/sqlite/src/Driver/Database/sqlite/Delete.php

Delete.php in core/modules/pgsql/src/Driver/Database/pgsql/Delete.php

Delete.php in core/modules/mysql/src/Driver/Database/mysql/Delete.php

Delete.php in core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Delete.php

162 string references to 'Delete'

BanAdmin::buildForm in core/modules/ban/src/Form/BanAdmin.php

BanDelete::getConfirmText in core/modules/ban/src/Form/BanDelete.php

Returns a caption for the button that confirms the action.

BlockContentCreationTest::testBlockDelete in core/modules/block_content/tests/src/Functional/BlockContentCreationTest.php

Tests deleting a block.

BlockContentListTest::testListing in core/modules/block_content/tests/src/Functional/BlockContentListTest.php

Tests the custom block listing page.

BlockContentListViewsTest::testListing in core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php

Tests the custom block listing page.

... See full list

File

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

Namespace

Drupal\Core\Database\Query

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;
  }

}

Members

Name	Modifiers	Type	Description	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	3
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::getConnection	public	function	Gets the database connection to be used 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.
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
QueryConditionTrait::compile	public	function
QueryConditionTrait::compiled	public	function
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