class Update
Same name in this branch
- 9 core/modules/sqlite/src/Driver/Database/sqlite/Update.php \Drupal\sqlite\Driver\Database\sqlite\Update
- 9 core/modules/mysql/src/Driver/Database/mysql/Update.php \Drupal\mysql\Driver\Database\mysql\Update
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Update.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Update
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Update.php \Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion\Update
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Update.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Update
- 9 core/modules/pgsql/src/Driver/Database/pgsql/Update.php \Drupal\pgsql\Driver\Database\pgsql\Update
- 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Update.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Update
- 9 core/lib/Drupal/Core/Database/Driver/pgsql/Update.php \Drupal\Core\Database\Driver\pgsql\Update
Same name in other branches
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Update.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Update
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Update.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Update
- 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Update.php \Drupal\Core\Database\Driver\sqlite\Update
- 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Update.php \Drupal\Core\Database\Driver\mysql\Update
- 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Update.php \Drupal\Core\Database\Driver\pgsql\Update
- 8.9.x core/lib/Drupal/Core/Database/Query/Update.php \Drupal\Core\Database\Query\Update
- 10 core/modules/sqlite/src/Driver/Database/sqlite/Update.php \Drupal\sqlite\Driver\Database\sqlite\Update
- 10 core/modules/mysql/src/Driver/Database/mysql/Update.php \Drupal\mysql\Driver\Database\mysql\Update
- 10 core/modules/pgsql/src/Driver/Database/pgsql/Update.php \Drupal\pgsql\Driver\Database\pgsql\Update
- 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Update.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Update
- 10 core/lib/Drupal/Core/Database/Driver/pgsql/Update.php \Drupal\Core\Database\Driver\pgsql\Update
- 10 core/lib/Drupal/Core/Database/Query/Update.php \Drupal\Core\Database\Query\Update
- 11.x core/modules/sqlite/src/Driver/Database/sqlite/Update.php \Drupal\sqlite\Driver\Database\sqlite\Update
- 11.x core/modules/mysql/src/Driver/Database/mysql/Update.php \Drupal\mysql\Driver\Database\mysql\Update
- 11.x core/modules/pgsql/src/Driver/Database/pgsql/Update.php \Drupal\pgsql\Driver\Database\pgsql\Update
- 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Update.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Update
- 11.x core/lib/Drupal/Core/Database/Query/Update.php \Drupal\Core\Database\Query\Update
General class for an abstracted UPDATE operation.
Hierarchy
- class \Drupal\Core\Database\Query\Query implements \Drupal\Core\Database\Query\PlaceholderInterface
- class \Drupal\Core\Database\Query\Update extends \Drupal\Core\Database\Query\Query implements \Drupal\Core\Database\Query\ConditionInterface uses \Drupal\Core\Database\Query\QueryConditionTrait
Expanded class hierarchy of Update
Related topics
5 files declare their use of Update
- Connection.php in core/
lib/ Drupal/ Core/ Database/ Connection.php - Update.php in core/
modules/ sqlite/ src/ Driver/ Database/ sqlite/ Update.php - Update.php in core/
modules/ mysql/ src/ Driver/ Database/ mysql/ Update.php - Update.php in core/
modules/ pgsql/ src/ Driver/ Database/ pgsql/ Update.php - Update.php in core/
tests/ fixtures/ database_drivers/ module/ corefake/ src/ Driver/ Database/ corefakeWithAllCustomClasses/ Update.php
179 string references to 'Update'
- AccessTest::testOnlyOwnerCanDeleteUpdateFile in core/
modules/ file/ tests/ src/ Kernel/ AccessTest.php - Tests that only the file owner can delete or update a file.
- AllowedPackages::event in composer/
Plugin/ Scaffold/ AllowedPackages.php - Handles package events during a 'composer require' operation.
- BlockContentAccessHandlerTest::providerTestAccess in core/
modules/ block_content/ tests/ src/ Kernel/ BlockContentAccessHandlerTest.php - Data provider for testAccess().
- BlockUser::access in core/
modules/ user/ src/ Plugin/ Action/ BlockUser.php - Checks object access.
- BrowserTestBaseTest::testInstall in core/
tests/ Drupal/ FunctionalTests/ BrowserTestBaseTest.php - Tests the Drupal install done in \Drupal\Tests\BrowserTestBase::setUp().
File
-
core/
lib/ Drupal/ Core/ Database/ Query/ Update.php, line 13
Namespace
Drupal\Core\Database\QueryView 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 = [];
/**
* An array of values to update to.
*
* @var array
*/
protected $arguments = [];
/**
* 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 = [];
/**
* 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 = []) {
// @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');
}
/**
* 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 $this
* 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 $this
* The called object.
*/
public function expression($field, $expression, array $arguments = NULL) {
$this->expressionFields[$field] = [
'expression' => $expression,
'arguments' => $arguments,
];
return $this;
}
/**
* Executes the UPDATE query.
*
* @return int|null
* 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 = [];
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());
}
$stmt = $this->connection
->prepareStatement((string) $this, $this->queryOptions, TRUE);
try {
$stmt->execute($update_values, $this->queryOptions);
return $stmt->rowCount();
} catch (\Exception $e) {
$this->connection
->exceptionHandler()
->handleExecutionException($e, $stmt, $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 = [];
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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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::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 | |||
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 | 3 |
Update::__toString | public | function | Implements PHP magic __toString method to convert the query to a string. | Overrides Query::__toString |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.