public function Connection::makeComment in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Database/Connection.php \Drupal\Core\Database\Connection::makeComment()

Flatten an array of query comments into a single comment string.

The comment string will be sanitized to avoid SQL injection attacks.

Parameters

string[] $comments: An array of query comment strings.

Return value

string A sanitized comment string.

File

core/lib/Drupal/Core/Database/Connection.php, line 513

Class

Connection

Base Database API class.

Namespace

Drupal\Core\Database

Code

public function makeComment($comments) {
  if (empty($comments)) {
    return '';
  }

  // Flatten the array of comments.
  $comment = implode('. ', $comments);

  // Sanitize the comment string so as to avoid SQL injection attacks.
  return '/* ' . $this
    ->filterComment($comment) . ' */ ';
}