public function UpdateQuery::__toString

Implements PHP magic __toString method to convert the query to a string.

Return value

string: The prepared statement.

Overrides Query::__toString

File

core/includes/database/query.inc, line 1206

Non-specific Database query code. Used by all engines.

Class

UpdateQuery

General class for an abstracted UPDATE operation.

Code

public function __toString() {
  // Older PHP versions cannot throw an exception in __toString().
  if (!is_array($this->expressionFields) || !is_array($this->fields)) {
    if (version_compare(PHP_VERSION, '7.4', '>=')) {
      throw new UnexpectedValueException();
    }
    else {
      trigger_error('Unexpected Value');
    }
  }

  // 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) {
    unset($fields[$field]);
    $field = $this->connection->escapeField($field);
    $update_fields[] = $field . '=' . $data['expression'];
  }

  $max_placeholder = 0;
  foreach ($fields as $field => $value) {
    $field = $this->connection->escapeField($field);
    $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;
}