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 in other branches
  1. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Delete
  2. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Delete.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Delete
  3. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Delete.php \Drupal\Core\Database\Driver\sqlite\Delete
  4. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Delete.php \Drupal\Core\Database\Driver\mysql\Delete
  5. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php \Drupal\Core\Database\Driver\pgsql\Delete
  6. 8.9.x core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
  7. 10 core/modules/sqlite/src/Driver/Database/sqlite/Delete.php \Drupal\sqlite\Driver\Database\sqlite\Delete
  8. 10 core/modules/mysql/src/Driver/Database/mysql/Delete.php \Drupal\mysql\Driver\Database\mysql\Delete
  9. 10 core/modules/pgsql/src/Driver/Database/pgsql/Delete.php \Drupal\pgsql\Driver\Database\pgsql\Delete
  10. 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Delete.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Delete
  11. 10 core/lib/Drupal/Core/Database/Driver/pgsql/Delete.php \Drupal\Core\Database\Driver\pgsql\Delete
  12. 10 core/lib/Drupal/Core/Database/Query/Delete.php \Drupal\Core\Database\Query\Delete
  13. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Delete.php \Drupal\sqlite\Driver\Database\sqlite\Delete
  14. 11.x core/modules/mysql/src/Driver/Database/mysql/Delete.php \Drupal\mysql\Driver\Database\mysql\Delete
  15. 11.x core/modules/pgsql/src/Driver/Database/pgsql/Delete.php \Drupal\pgsql\Driver\Database\pgsql\Delete
  16. 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Delete.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Delete
  17. 11.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;
    }

}

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 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. 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.