public function CommentTestBase::setCommentPreview in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/comment/tests/src/Functional/CommentTestBase.php \Drupal\Tests\comment\Functional\CommentTestBase::setCommentPreview()
2. 9 core/modules/comment/tests/src/Functional/CommentTestBase.php \Drupal\Tests\comment\Functional\CommentTestBase::setCommentPreview()

Sets the value governing the previewing mode for the comment form.

Parameters

int $mode: The preview mode: DRUPAL_DISABLED, DRUPAL_OPTIONAL or DRUPAL_REQUIRED.

string $field_name: (optional) Field name through which the comment should be posted. Defaults to 'comment'.

File

core/modules/comment/tests/src/Functional/CommentTestBase.php, line 265

Class

CommentTestBase

Provides setup and helper methods for comment tests.

Namespace

Drupal\Tests\comment\Functional

Code

public function setCommentPreview($mode, $field_name = 'comment') {
  switch ($mode) {
    case DRUPAL_DISABLED:
      $mode_text = 'disabled';
      break;
    case DRUPAL_OPTIONAL:
      $mode_text = 'optional';
      break;
    case DRUPAL_REQUIRED:
      $mode_text = 'required';
      break;
  }
  $this
    ->setCommentSettings('preview', $mode, new FormattableMarkup('Comment preview @mode_text.', [
    '@mode_text' => $mode_text,
  ]), $field_name);
}