You are here

public function Schema::prepareComment in Drupal 9

Same name in this branch
  1. 9 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::prepareComment()
  2. 9 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::prepareComment()
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::prepareComment()

Prepare a table or column comment for database query.

Parameters

$comment: The comment string to prepare.

$length: Optional upper limit on the returned string length.

Return value

The prepared comment.

Overrides Schema::prepareComment

2 calls to Schema::prepareComment()
Schema::createFieldSql in core/lib/Drupal/Core/Database/Driver/mysql/Schema.php
Create an SQL string for a field to be used in table creation or alteration.
Schema::createTableSql in core/lib/Drupal/Core/Database/Driver/mysql/Schema.php
Generate SQL to create a new table from a Drupal schema definition.

File

core/lib/Drupal/Core/Database/Driver/mysql/Schema.php, line 642

Class

Schema
MySQL implementation of \Drupal\Core\Database\Schema.

Namespace

Drupal\Core\Database\Driver\mysql

Code

public function prepareComment($comment, $length = NULL) {

  // Truncate comment to maximum comment length.
  if (isset($length)) {

    // Add table prefixes before truncating.
    $comment = Unicode::truncate($this->connection
      ->prefixTables($comment), $length, TRUE, TRUE);
  }

  // Remove semicolons to avoid triggering multi-statement check.
  $comment = strtr($comment, [
    ';' => '.',
  ]);
  return $this->connection
    ->quote($comment);
}