public function InsertQuery_mysql::__toString

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

Return value

string: The prepared statement.

Overrides InsertQuery::__toString

File

core/includes/database/mysql/query.inc, line 50

Query code for MySQL embedded database engine.

Class

InsertQuery_mysql

MySQL-specific class for executing INSERT queries.

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);

  // Escape each field.
  foreach ($insert_fields as $field_key => $insert_field) {
    $insert_fields[$field_key] = $this->connection->escapeField($insert_field);
  }

  // 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 ';

  $max_placeholder = 0;
  $values = array();
  if (!is_array($this->insertValues)) {
    // Older PHP versions cannot throw an exception within __toString().
    if (version_compare(PHP_VERSION, '7.4', '>=')) {
      throw new UnexpectedValueException();
    }
    else {
      trigger_error('Unexpected Value');
    }
  }
  if (count($this->insertValues)) {
    foreach ($this->insertValues as $insert_values) {
      $placeholders = array();

      // Default fields aren't really placeholders, but this is the most
      // convenient way to handle them.
      $placeholders = array_pad($placeholders, count($this->defaultFields), 'default');

      $new_placeholder = $max_placeholder + count($insert_values);
      for ($i = $max_placeholder; $i < $new_placeholder; ++$i) {
        $placeholders[] = ':db_insert_placeholder_' . $i;
      }
      $max_placeholder = $new_placeholder;
      $values[] = '(' . implode(', ', $placeholders) . ')';
    }
  }
  else {
    // If there are no values, then this is a default-only query. We still
    // need to handle that.
    $placeholders = array_fill(0, count($this->defaultFields), 'default');
    $values[] = '(' . implode(', ', $placeholders) . ')';
  }

  $query .= implode(', ', $values);

  return $query;
}