1. 8.3.x core/lib/Drupal/Core/Database/Driver/mysql/Update.php Update
  2. 8.3.x core/lib/Drupal/Core/Database/Query/Update.php Update
  3. 8.3.x core/lib/Drupal/Core/Database/Driver/pgsql/Update.php Update
  4. 8.3.x core/lib/Drupal/Core/Database/Driver/sqlite/Update.php Update
  5. 8.0.x core/lib/Drupal/Core/Database/Query/Update.php Update
  6. 8.0.x core/lib/Drupal/Core/Database/Driver/mysql/Update.php Update
  7. 8.0.x core/lib/Drupal/Core/Database/Driver/pgsql/Update.php Update
  8. 8.0.x core/lib/Drupal/Core/Database/Driver/sqlite/Update.php Update
  9. 8.1.x core/lib/Drupal/Core/Database/Driver/sqlite/Update.php Update
  10. 8.1.x core/lib/Drupal/Core/Database/Driver/mysql/Update.php Update
  11. 8.1.x core/lib/Drupal/Core/Database/Driver/pgsql/Update.php Update
  12. 8.1.x core/lib/Drupal/Core/Database/Query/Update.php Update
  13. 8.2.x core/lib/Drupal/Core/Database/Driver/pgsql/Update.php Update
  14. 8.2.x core/lib/Drupal/Core/Database/Query/Update.php Update
  15. 8.2.x core/lib/Drupal/Core/Database/Driver/sqlite/Update.php Update
  16. 8.2.x core/lib/Drupal/Core/Database/Driver/mysql/Update.php Update
  17. 8.4.x core/lib/Drupal/Core/Database/Driver/sqlite/Update.php Update
  18. 8.4.x core/lib/Drupal/Core/Database/Driver/pgsql/Update.php Update
  19. 8.4.x core/lib/Drupal/Core/Database/Query/Update.php Update
  20. 8.4.x core/lib/Drupal/Core/Database/Driver/mysql/Update.php Update

General class for an abstracted UPDATE operation.

Hierarchy

Expanded class hierarchy of Update

Related topics

3 files declare their use of Update
Update.php in core/lib/Drupal/Core/Database/Driver/mysql/Update.php
Update.php in core/lib/Drupal/Core/Database/Driver/pgsql/Update.php
Update.php in core/lib/Drupal/Core/Database/Driver/sqlite/Update.php
11 string references to 'Update'
CommentAdminOverview::buildForm in core/modules/comment/src/Form/CommentAdminOverview.php
Form constructor for the comment overview administration form.
CommentAdminTest::testApprovalAdminInterface in core/modules/comment/src/Tests/CommentAdminTest.php
Test comment approval functionality through admin/content/comment.
CommentNonNodeTest::performCommentOperation in core/modules/comment/src/Tests/CommentNonNodeTest.php
Performs the specified operation on the specified comment.
CommentTestBase::performCommentOperation in core/modules/comment/src/Tests/CommentTestBase.php
Performs the specified operation on the specified comment.
Connection::update in core/lib/Drupal/Core/Database/Connection.php
Prepares and returns an UPDATE query object.

... See full list

File

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

Namespace

Drupal\Core\Database\Query
View source
class Update extends Query implements ConditionInterface {

  use QueryConditionTrait;

  /**
   * The table to update.
   *
   * @var string
   */
  protected $table;

  /**
   * An array of fields that will be updated.
   *
   * @var array
   */
  protected $fields = array();

  /**
   * An array of values to update to.
   *
   * @var array
   */
  protected $arguments = array();

  /**
   * Array of fields to update to an expression in case of a duplicate record.
   *
   * This variable is a nested array in the following format:
   * @code
   * <some field> => array(
   *  'condition' => <condition to execute, as a string>,
   *  'arguments' => <array of arguments for condition, or NULL for none>,
   * );
   * @endcode
   *
   * @var array
   */
  protected $expressionFields = array();

  /**
   * Constructs an Update query 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 = array()) {
    $options['return'] = Database::RETURN_AFFECTED;
    parent::__construct($connection, $options);
    $this->table = $table;

    $this->condition = new Condition('AND');
  }

  /**
   * Adds a set of field->value pairs to be updated.
   *
   * @param $fields
   *   An associative array of fields to write into the database. The array keys
   *   are the field names and the values are the values to which to set them.
   *
   * @return \Drupal\Core\Database\Query\Update
   *   The called object.
   */
  public function fields(array $fields) {
    $this->fields = $fields;
    return $this;
  }

  /**
   * Specifies fields to be updated as an expression.
   *
   * Expression fields are cases such as counter=counter+1. This method takes
   * precedence over fields().
   *
   * @param $field
   *   The field to set.
   * @param $expression
   *   The field will be set to the value of this expression. This parameter
   *   may include named placeholders.
   * @param $arguments
   *   If specified, this is an array of key/value pairs for named placeholders
   *   corresponding to the expression.
   *
   * @return \Drupal\Core\Database\Query\Update
   *   The called object.
   */
  public function expression($field, $expression, array $arguments = NULL) {
    $this->expressionFields[$field] = array(
      'expression' => $expression,
      'arguments' => $arguments,
    );

    return $this;
  }

  /**
   * Executes the UPDATE query.
   *
   * @return
   *   The number of rows matched by the update query. This includes rows that
   *   actually didn't have to be updated because the values didn't change.
   */
  public function execute() {
    // Expressions take priority over literal fields, so we process those first
    // and remove any literal fields that conflict.
    $fields = $this->fields;
    $update_values = array();
    foreach ($this->expressionFields as $field => $data) {
      if (!empty($data['arguments'])) {
        $update_values += $data['arguments'];
      }
      if ($data['expression'] instanceof SelectInterface) {
        $data['expression']->compile($this->connection, $this);
        $update_values += $data['expression']->arguments();
      }
      unset($fields[$field]);
    }

    // Because we filter $fields the same way here and in __toString(), the
    // placeholders will all match up properly.
    $max_placeholder = 0;
    foreach ($fields as $value) {
      $update_values[':db_update_placeholder_' . ($max_placeholder++)] = $value;
    }

    if (count($this->condition)) {
      $this->condition->compile($this->connection, $this);
      $update_values = array_merge($update_values, $this->condition->arguments());
    }

    return $this->connection->query((string) $this, $update_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);

    // Expressions take priority over literal fields, so we process those first
    // and remove any literal fields that conflict.
    $fields = $this->fields;
    $update_fields = array();
    foreach ($this->expressionFields as $field => $data) {
      if ($data['expression'] instanceof SelectInterface) {
        // Compile and cast expression subquery to a string.
        $data['expression']->compile($this->connection, $this);
        $data['expression'] = ' (' . $data['expression'] . ')';
      }
      $update_fields[] = $this->connection->escapeField($field) . '=' . $data['expression'];
      unset($fields[$field]);
    }

    $max_placeholder = 0;
    foreach ($fields as $field => $value) {
      $update_fields[] = $this->connection->escapeField($field) . '=:db_update_placeholder_' . ($max_placeholder++);
    }

    $query = $comments . 'UPDATE {' . $this->connection->escapeTable($this->table) . '} SET ' . implode(', ', $update_fields);

    if (count($this->condition)) {
      $this->condition->compile($this->connection, $this);
      // There is an implicit string cast on $this->condition.
      $query .= "\nWHERE " . $this->condition;
    }

    return $query;
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
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::andConditionGroup public function Creates a new group of conditions ANDed together. Overrides ConditionInterface::andConditionGroup
QueryConditionTrait::arguments public function Gets a complete list of all values to insert into the prepared statement. Overrides ConditionInterface::arguments 1
QueryConditionTrait::compile public function Compiles the saved conditions for later retrieval. Overrides ConditionInterface::compile 1
QueryConditionTrait::compiled public function Check whether a condition has been previously compiled. Overrides ConditionInterface::compiled 1
QueryConditionTrait::condition public function Helper function: builds the most common conditional clauses. Overrides ConditionInterface::condition
QueryConditionTrait::conditionGroupFactory public function Creates an object holding a group of conditions. Overrides ConditionInterface::conditionGroupFactory
QueryConditionTrait::conditions public function Gets a complete list of all conditions in this conditional clause. Overrides ConditionInterface::conditions
QueryConditionTrait::exists public function Sets a condition that the specified subquery returns values. Overrides ConditionInterface::exists
QueryConditionTrait::isNotNull public function Sets a condition that the specified field be NOT NULL. Overrides ConditionInterface::isNotNull
QueryConditionTrait::isNull public function Sets a condition that the specified field be NULL. Overrides ConditionInterface::isNull
QueryConditionTrait::notExists public function Sets a condition that the specified subquery returns no values. Overrides ConditionInterface::notExists
QueryConditionTrait::orConditionGroup public function Creates a new group of conditions ORed together. Overrides ConditionInterface::orConditionGroup
QueryConditionTrait::where public function Adds an arbitrary WHERE clause to the query. Overrides ConditionInterface::where
Update::$arguments protected property An array of values to update to.
Update::$expressionFields protected property Array of fields to update to an expression in case of a duplicate record.
Update::$fields protected property An array of fields that will be updated.
Update::$table protected property The table to update.
Update::execute public function Executes the UPDATE query. Overrides Query::execute 1
Update::expression public function Specifies fields to be updated as an expression.
Update::fields public function Adds a set of field->value pairs to be updated.
Update::__construct public function Constructs an Update query object. Overrides Query::__construct
Update::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString

Comments

manoj mehta’s picture

I have created custom table i want curd operation with it update insert etc how to use them plz let me know asap