Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 32 |
Upsert | |
0.00% |
0 / 1 |
|
0.00% |
0 / 4 |
132 | |
0.00% |
0 / 32 |
__construct | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 4 |
|||
key | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
preExecute | |
0.00% |
0 / 1 |
30 | |
0.00% |
0 / 11 |
|||
execute | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 14 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\Core\Database\Query\Upsert. | |
*/ | |
namespace Drupal\Core\Database\Query; | |
use Drupal\Core\Database\Connection; | |
use Drupal\Core\Database\Database; | |
/** | |
* General class for an abstracted "Upsert" (UPDATE or INSERT) query operation. | |
* | |
* This class can only be used with a table with a single unique index. | |
* Often, this will be the primary key. On such a table this class works like | |
* Insert except the rows will be set to the desired values even if the key | |
* existed before. | |
*/ | |
abstract class Upsert extends Query { | |
use InsertTrait; | |
/** | |
* The unique or primary key of the table. | |
* | |
* @var string | |
*/ | |
protected $key; | |
/** | |
* Constructs an Upsert 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 | |
* (optional) An array of database options. | |
*/ | |
public function __construct(Connection $connection, $table, array $options = []) { | |
$options['return'] = Database::RETURN_AFFECTED; | |
parent::__construct($connection, $options); | |
$this->table = $table; | |
} | |
/** | |
* Sets the unique / primary key field to be used as condition for this query. | |
* | |
* @param string $field | |
* The name of the field to set. | |
* | |
* @return $this | |
*/ | |
public function key($field) { | |
$this->key = $field; | |
return $this; | |
} | |
/** | |
* Preprocesses and validates the query. | |
* | |
* @return bool | |
* TRUE if the validation was successful, FALSE otherwise. | |
* | |
* @throws \Drupal\Core\Database\Query\NoUniqueFieldException | |
* @throws \Drupal\Core\Database\Query\FieldsOverlapException | |
* @throws \Drupal\Core\Database\Query\NoFieldsException | |
*/ | |
protected function preExecute() { | |
// Confirm that the user set the unique/primary key of the table. | |
if (!$this->key) { | |
throw new NoUniqueFieldException('There is no unique field specified.'); | |
} | |
// Confirm that the user did not try to specify an identical | |
// field and default field. | |
if (array_intersect($this->insertFields, $this->defaultFields)) { | |
throw new FieldsOverlapException('You may not specify the same field to have a value and a schema-default value.'); | |
} | |
// Don't execute query without fields. | |
if (count($this->insertFields) + count($this->defaultFields) == 0) { | |
throw new NoFieldsException('There are no fields available to insert with.'); | |
} | |
// If no values have been added, silently ignore this query. This can happen | |
// if values are added conditionally, so we don't want to throw an | |
// exception. | |
return isset($this->insertValues[0]) || $this->insertFields; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function execute() { | |
if (!$this->preExecute()) { | |
return NULL; | |
} | |
$max_placeholder = 0; | |
$values = array(); | |
foreach ($this->insertValues as $insert_values) { | |
foreach ($insert_values as $value) { | |
$values[':db_insert_placeholder_' . $max_placeholder++] = $value; | |
} | |
} | |
$last_insert_id = $this->connection->query((string) $this, $values, $this->queryOptions); | |
// Re-initialize the values array so that we can re-use this query. | |
$this->insertValues = array(); | |
return $last_insert_id; | |
} | |
} |