You are here

class Insert in Drupal 9

Same name in this branch
  1. 9 core/lib/Drupal/Core/Database/Query/Insert.php \Drupal\Core\Database\Query\Insert
  2. 9 core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php \Drupal\Core\Database\Driver\sqlite\Insert
  3. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php \Drupal\Core\Database\Driver\pgsql\Insert
  4. 9 core/lib/Drupal/Core/Database/Driver/mysql/Insert.php \Drupal\Core\Database\Driver\mysql\Insert
  5. 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Insert.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Insert
  6. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Insert.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Insert
  7. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Insert.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Insert
  8. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Insert.php \Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion\Insert
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Driver/mysql/Insert.php \Drupal\Core\Database\Driver\mysql\Insert

MySQL implementation of \Drupal\Core\Database\Query\Insert.

Hierarchy

Expanded class hierarchy of Insert

2 files declare their use of Insert
Insert.php in core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Insert.php
Insert.php in core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Insert.php
3 string references to 'Insert'
Connection::getDriverClass in core/lib/Drupal/Core/Database/Connection.php
Gets the driver-specific override class if any for the specified class.
Connection::insert in core/lib/Drupal/Core/Database/Connection.php
Prepares and returns an INSERT query object.
ConnectionTest::providerGetDriverClass in core/tests/Drupal/Tests/Core/Database/ConnectionTest.php
Data provider for testGetDriverClass().

File

core/lib/Drupal/Core/Database/Driver/mysql/Insert.php, line 10

Namespace

Drupal\Core\Database\Driver\mysql
View source
class Insert extends QueryInsert {
  public function execute() {
    if (!$this
      ->preExecute()) {
      return NULL;
    }

    // If we're selecting from a SelectQuery, finish building the query and
    // pass it back, as any remaining options are irrelevant.
    if (empty($this->fromQuery)) {
      $max_placeholder = 0;
      $values = [];
      foreach ($this->insertValues as $insert_values) {
        foreach ($insert_values as $value) {
          $values[':db_insert_placeholder_' . $max_placeholder++] = $value;
        }
      }
    }
    else {
      $values = $this->fromQuery
        ->getArguments();
    }
    $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 = [];
    return $last_insert_id;
  }
  public function __toString() {

    // Create a sanitized comment string to prepend to the query.
    $comments = $this->connection
      ->makeComment($this->comments);

    // Default fields are always placed first for consistency.
    $insert_fields = array_merge($this->defaultFields, $this->insertFields);
    $insert_fields = array_map(function ($field) {
      return $this->connection
        ->escapeField($field);
    }, $insert_fields);

    // If we're selecting from a SelectQuery, finish building the query and
    // pass it back, as any remaining options are irrelevant.
    if (!empty($this->fromQuery)) {
      $insert_fields_string = $insert_fields ? ' (' . implode(', ', $insert_fields) . ') ' : ' ';
      return $comments . 'INSERT INTO {' . $this->table . '}' . $insert_fields_string . $this->fromQuery;
    }
    $query = $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES ';
    $values = $this
      ->getInsertPlaceholderFragment($this->insertValues, $this->defaultFields);
    $query .= implode(', ', $values);
    return $query;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Insert::$fromQuery protected property A SelectQuery object to fetch the rows that should be inserted.
Insert::execute public function Executes the insert query. Overrides Insert::execute
Insert::from public function Sets the fromQuery on this InsertQuery object.
Insert::preExecute protected function Preprocesses and validates the query.
Insert::__construct public function Constructs an Insert object. Overrides Query::__construct
Insert::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Insert::__toString
InsertTrait::$defaultFields protected property An array of fields that should be set to their database-defined defaults.
InsertTrait::$insertFields protected property An array of fields on which to insert.
InsertTrait::$insertValues protected property A nested array of values to insert.
InsertTrait::$table protected property The table on which to insert.
InsertTrait::count public function
InsertTrait::fields public function Adds a set of field->value pairs to be inserted.
InsertTrait::getInsertPlaceholderFragment protected function Returns the query placeholders for values that will be inserted.
InsertTrait::useDefaults public function Specifies fields for which the database defaults should be used.
InsertTrait::values public function Adds another set of values to the query to be inserted.
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.