public function Insert::__toString in Drupal 9

Same name in this branch

1. 9 core/lib/Drupal/Core/Database/Query/Insert.php \Drupal\Core\Database\Query\Insert::__toString()
2. 9 core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php \Drupal\Core\Database\Driver\sqlite\Insert::__toString()
3. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php \Drupal\Core\Database\Driver\pgsql\Insert::__toString()
4. 9 core/lib/Drupal/Core/Database/Driver/mysql/Insert.php \Drupal\Core\Database\Driver\mysql\Insert::__toString()

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php \Drupal\Core\Database\Driver\pgsql\Insert::__toString()

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

Return value

string The prepared statement.

Overrides Insert::__toString

File

core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php, line 117

Class

Insert

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

Namespace

Drupal\Core\Database\Driver\pgsql

Code

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 ($f) {
    return $this->connection
      ->escapeField($f);
  }, $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) . ') ' : ' ';
    $query = $comments . 'INSERT INTO {' . $this->table . '}' . $insert_fields_string . $this->fromQuery;
  }
  else {
    $query = $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES ';
    $values = $this
      ->getInsertPlaceholderFragment($this->insertValues, $this->defaultFields);
    $query .= implode(', ', $values);
  }
  try {

    // Fetch the list of blobs and sequences used on that table.
    $table_information = $this->connection
      ->schema()
      ->queryTableInformation($this->table);
    if (isset($table_information->serial_fields[0])) {

      // Use RETURNING syntax to get the last insert ID in the same INSERT
      // query, see https://www.postgresql.org/docs/10/dml-returning.html.
      $query .= ' RETURNING ' . $table_information->serial_fields[0];
    }
  } catch (DatabaseExceptionWrapper $e) {

    // If we fail to get the table information it is probably because the
    // table does not exist yet so adding the returning statement is pointless
    // because the query will fail. This happens for tables created on demand,
    // for example, cache tables.
  }
  return $query;
}