General class for an abstracted UPDATE operation.
Expanded class hierarchy of Update
class Update extends Query implements ConditionInterface {
/**
* 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();
/**
* The condition object for this query.
*
* Condition handling is handled via composition.
*
* @var Drupal\Core\Database\Query\Condition
*/
protected $condition;
/**
* 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');
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::condition().
*/
public function condition($field, $value = NULL, $operator = NULL) {
$this->condition
->condition($field, $value, $operator);
return $this;
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::isNull().
*/
public function isNull($field) {
$this->condition
->isNull($field);
return $this;
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::isNotNull().
*/
public function isNotNull($field) {
$this->condition
->isNotNull($field);
return $this;
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::exists().
*/
public function exists(SelectInterface $select) {
$this->condition
->exists($select);
return $this;
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::notExists().
*/
public function notExists(SelectInterface $select) {
$this->condition
->notExists($select);
return $this;
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::conditions().
*/
public function &conditions() {
return $this->condition
->conditions();
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::arguments().
*/
public function arguments() {
return $this->condition
->arguments();
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::where().
*/
public function where($snippet, $args = array()) {
$this->condition
->where($snippet, $args);
return $this;
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::compile().
*/
public function compile(Connection $connection, PlaceholderInterface $queryPlaceholder) {
return $this->condition
->compile($connection, $queryPlaceholder);
}
/**
* Implements Drupal\Core\Database\Query\ConditionInterface::compiled().
*/
public function compiled() {
return $this->condition
->compiled();
}
/**
* 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 $field => $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[] = $field . '=' . $data['expression'];
unset($fields[$field]);
}
$max_placeholder = 0;
foreach ($fields as $field => $value) {
$update_fields[] = $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;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Query:: |
protected | property | An array of comments that can be prepended to a query. | |
Query:: |
protected | property | The connection object on which to run this query. | |
Query:: |
protected | property | The key of the connection object. | |
Query:: |
protected | property | The target of the connection object. | |
Query:: |
protected | property | The placeholder counter. | |
Query:: |
protected | property | The query options to pass on to the connection object. | |
Query:: |
protected | property | A unique identifier for this query object. | |
Query:: |
public | function | Adds a comment to the query. | |
Query:: |
public | function | Returns a reference to the comments array for the query. | |
Query:: |
public | function |
Gets the next placeholder value for this query object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function |
Returns a unique identifier for this object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function | Implements the magic __clone function. | 1 |
Query:: |
public | function | Implements the magic __sleep function to disconnect from the database. | |
Query:: |
public | function | Implements the magic __wakeup function to reconnect to the database. | |
Update:: |
protected | property | An array of values to update to. | |
Update:: |
protected | property | The condition object for this query. | |
Update:: |
protected | property | Array of fields to update to an expression in case of a duplicate record. | |
Update:: |
protected | property | An array of fields that will be updated. | |
Update:: |
protected | property | The table to update. | |
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::arguments(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::compile(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::compiled(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::condition(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::conditions(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Executes the UPDATE query. Overrides Query:: |
1 |
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::exists(). Overrides ConditionInterface:: |
|
Update:: |
public | function | Specifies fields to be updated as an expression. | |
Update:: |
public | function | Adds a set of field->value pairs to be updated. | |
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::isNotNull(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::isNull(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::notExists(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Implements Drupal\Core\Database\Query\ConditionInterface::where(). Overrides ConditionInterface:: |
|
Update:: |
public | function |
Constructs an Update query object. Overrides Query:: |
|
Update:: |
public | function |
Implements PHP magic __toString method to convert the query to a string. Overrides Query:: |