public function Merge::key in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Database/Query/Merge.php \Drupal\Core\Database\Query\Merge::key()
2. 10 core/lib/Drupal/Core/Database/Query/Merge.php \Drupal\Core\Database\Query\Merge::key()

Sets a single key field to be used as condition for this query.

Same as \Drupal\Core\Database\Query\Merge::keys() but offering a signature that is more natural for the case of a single key.

Parameters

string $field: The name of the field to set.

mixed $value: The value to set into the database.

Return value

$this

See also

\Drupal\Core\Database\Query\Merge::keys()

File

core/lib/Drupal/Core/Database/Query/Merge.php, line 331

Class

Merge

General class for an abstracted MERGE query operation.

Namespace

Drupal\Core\Database\Query

Code

public function key($field, $value = NULL) {

  // @todo D9: Remove this backwards-compatibility shim.
  if (is_array($field)) {
    $this
      ->keys($field, isset($value) ? $value : []);
  }
  else {
    $this
      ->keys([
      $field => $value,
    ]);
  }
  return $this;
}