class CommentPagerTest in Drupal 9

Same name and namespace in other branches

8 core/modules/comment/tests/src/Functional/CommentPagerTest.php \Drupal\Tests\comment\Functional\CommentPagerTest

Tests paging of comments and their settings.

@group comment

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\comment\Functional\CommentTestBase uses CommentTestTrait
  - class \Drupal\Tests\comment\Functional\CommentPagerTest

Expanded class hierarchy of CommentPagerTest

File

core/modules/comment/tests/src/Functional/CommentPagerTest.php, line 14

Namespace

Drupal\Tests\comment\Functional

View source

class CommentPagerTest extends CommentTestBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * Confirms comment paging works correctly with flat and threaded comments.
   */
  public function testCommentPaging() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
    ]);
    $comments = [];
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this
      ->setCommentsPerPage(1);

    // Check the first page of the node, and confirm the correct comments are
    // shown.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('next');
    $this
      ->assertTrue($this
      ->commentExists($comments[0]), 'Comment 1 appears on page 1.');
    $this
      ->assertFalse($this
      ->commentExists($comments[1]), 'Comment 2 does not appear on page 1.');
    $this
      ->assertFalse($this
      ->commentExists($comments[2]), 'Comment 3 does not appear on page 1.');

    // Check the second page.
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'query' => [
        'page' => 1,
      ],
    ]);
    $this
      ->assertTrue($this
      ->commentExists($comments[1]), 'Comment 2 appears on page 2.');
    $this
      ->assertFalse($this
      ->commentExists($comments[0]), 'Comment 1 does not appear on page 2.');
    $this
      ->assertFalse($this
      ->commentExists($comments[2]), 'Comment 3 does not appear on page 2.');

    // Check the third page.
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'query' => [
        'page' => 2,
      ],
    ]);
    $this
      ->assertTrue($this
      ->commentExists($comments[2]), 'Comment 3 appears on page 3.');
    $this
      ->assertFalse($this
      ->commentExists($comments[0]), 'Comment 1 does not appear on page 3.');
    $this
      ->assertFalse($this
      ->commentExists($comments[1]), 'Comment 2 does not appear on page 3.');

    // Post a reply to the oldest comment and test again.
    $oldest_comment = reset($comments);
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $oldest_comment
      ->id());
    $reply = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->setCommentsPerPage(2);

    // We are still in flat view - the replies should not be on the first page,
    // even though they are replies to the oldest comment.
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'query' => [
        'page' => 0,
      ],
    ]);
    $this
      ->assertFalse($this
      ->commentExists($reply, TRUE), 'In flat mode, reply does not appear on page 1.');

    // If we switch to threaded mode, the replies on the oldest comment
    // should be bumped to the first page and comment 6 should be bumped
    // to the second page.
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'query' => [
        'page' => 0,
      ],
    ]);
    $this
      ->assertTrue($this
      ->commentExists($reply, TRUE), 'In threaded mode, reply appears on page 1.');
    $this
      ->assertFalse($this
      ->commentExists($comments[1]), 'In threaded mode, comment 2 has been bumped off of page 1.');

    // If (# replies > # comments per page) in threaded expanded view,
    // the overage should be bumped.
    $reply2 = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'query' => [
        'page' => 0,
      ],
    ]);
    $this
      ->assertFalse($this
      ->commentExists($reply2, TRUE), 'In threaded mode where # replies > # comments per page, the newest reply does not appear on page 1.');

    // Test that the page build process does not somehow generate errors when
    // # comments per page is set to 0.
    $this
      ->setCommentsPerPage(0);
    $this
      ->drupalGet('node/' . $node
      ->id(), [
      'query' => [
        'page' => 0,
      ],
    ]);
    $this
      ->assertFalse($this
      ->commentExists($reply2, TRUE), 'Threaded mode works correctly when comments per page is 0.');
    $this
      ->drupalLogout();
  }

  /**
   * Confirms comment paging works correctly with flat and threaded comments.
   */
  public function testCommentPermalink() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
    ]);
    $comments = [];
    $comments[] = $this
      ->postComment($node, 'comment 1: ' . $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, 'comment 2: ' . $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, 'comment 3: ' . $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this
      ->setCommentsPerPage(1);

    // Navigate to each comment permalink as anonymous and assert it appears on
    // the page.
    foreach ($comments as $index => $comment) {
      $this
        ->drupalGet($comment
        ->toUrl());
      $this
        ->assertTrue($this
        ->commentExists($comment), sprintf('Comment %d appears on page %d.', $index + 1, $index + 1));
    }
  }

  /**
   * Tests comment ordering and threading.
   */
  public function testCommentOrderingThreading() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Display all the comments on the same page.
    $this
      ->setCommentsPerPage(1000);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
    ]);
    $comments = [];
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the second comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[1]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the first comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[0]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the last comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[2]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the second comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[3]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // At this point, the comment tree is:
    // - 0
    //   - 4
    // - 1
    //   - 3
    //     - 6
    // - 2
    //   - 5
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
    $expected_order = [
      0,
      1,
      2,
      3,
      4,
      5,
      6,
    ];
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertCommentOrder($comments, $expected_order);
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
    $expected_order = [
      0,
      4,
      1,
      3,
      6,
      2,
      5,
    ];
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertCommentOrder($comments, $expected_order);
  }

  /**
   * Asserts that the comments are displayed in the correct order.
   *
   * @param \Drupal\comment\CommentInterface[] $comments
   *   An array of comments, must be of the type CommentInterface.
   * @param array $expected_order
   *   An array of keys from $comments describing the expected order.
   */
  public function assertCommentOrder(array $comments, array $expected_order) {
    $expected_cids = [];

    // First, rekey the expected order by cid.
    foreach ($expected_order as $key) {
      $expected_cids[] = $comments[$key]
        ->id();
    }
    $comment_anchors = $this
      ->xpath('//article[starts-with(@id,"comment-")]');
    $result_order = [];
    foreach ($comment_anchors as $anchor) {
      $result_order[] = substr($anchor
        ->getAttribute('id'), 8);
    }
    $this
      ->assertEquals($expected_cids, $result_order, new FormattableMarkup('Comment order: expected @expected, returned @returned.', [
      '@expected' => implode(',', $expected_cids),
      '@returned' => implode(',', $result_order),
    ]));
  }

  /**
   * Tests calculation of first page with new comment.
   */
  public function testCommentNewPageIndicator() {
    $this
      ->drupalLogin($this->adminUser);

    // Set comment variables.
    $this
      ->setCommentForm(TRUE);
    $this
      ->setCommentSubject(TRUE);
    $this
      ->setCommentPreview(DRUPAL_DISABLED);

    // Set comments to one per page so that we are able to test paging without
    // needing to insert large numbers of comments.
    $this
      ->setCommentsPerPage(1);

    // Create a node and three comments.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
    ]);
    $comments = [];
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);
    $comments[] = $this
      ->postComment($node, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the second comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[1]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the first comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[0]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // Post a reply to the last comment.
    $this
      ->drupalGet('comment/reply/node/' . $node
      ->id() . '/comment/' . $comments[2]
      ->id());
    $comments[] = $this
      ->postComment(NULL, $this
      ->randomMachineName(), $this
      ->randomMachineName(), TRUE);

    // At this point, the comment tree is:
    // - 0
    //   - 4
    // - 1
    //   - 3
    // - 2
    //   - 5
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.');
    $expected_pages = [
      // Page of comment 5
      1 => 5,
      // Page of comment 4
      2 => 4,
      // Page of comment 3
      3 => 3,
      // Page of comment 2
      4 => 2,
      // Page of comment 1
      5 => 1,
      // Page of comment 0
      6 => 0,
    ];
    $node = Node::load($node
      ->id());
    foreach ($expected_pages as $new_replies => $expected_page) {
      $returned_page = \Drupal::entityTypeManager()
        ->getStorage('comment')
        ->getNewCommentPageNumber($node
        ->get('comment')->comment_count, $new_replies, $node, 'comment');
      $this
        ->assertSame($expected_page, $returned_page, new FormattableMarkup('Flat mode, @new replies: expected page @expected, returned page @returned.', [
        '@new' => $new_replies,
        '@expected' => $expected_page,
        '@returned' => $returned_page,
      ]));
    }
    $this
      ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_THREADED, 'Switched to threaded mode.');
    $expected_pages = [
      // Page of comment 5
      1 => 5,
      // Page of comment 4
      2 => 1,
      // Page of comment 4
      3 => 1,
      // Page of comment 4
      4 => 1,
      // Page of comment 4
      5 => 1,
      // Page of comment 0
      6 => 0,
    ];
    \Drupal::entityTypeManager()
      ->getStorage('node')
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = Node::load($node
      ->id());
    foreach ($expected_pages as $new_replies => $expected_page) {
      $returned_page = \Drupal::entityTypeManager()
        ->getStorage('comment')
        ->getNewCommentPageNumber($node
        ->get('comment')->comment_count, $new_replies, $node, 'comment');
      $this
        ->assertEquals($expected_page, $returned_page, new FormattableMarkup('Threaded mode, @new replies: expected page @expected, returned page @returned.', [
        '@new' => $new_replies,
        '@expected' => $expected_page,
        '@returned' => $returned_page,
      ]));
    }
  }

  /**
   * Confirms comment paging works correctly with two pagers.
   */
  public function testTwoPagers() {

    // Add another field to article content-type.
    $this
      ->addDefaultCommentField('node', 'article', 'comment_2');

    // Set default to display comment list with unique pager id.
    \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', 'article')
      ->setComponent('comment_2', [
      'label' => 'hidden',
      'type' => 'comment_default',
      'weight' => 30,
      'settings' => [
        'pager_id' => 1,
        'view_mode' => 'default',
      ],
    ])
      ->save();

    // Make sure pager appears in formatter summary and settings form.
    $account = $this
      ->drupalCreateUser([
      'administer node display',
    ]);
    $this
      ->drupalLogin($account);
    $this
      ->drupalGet('admin/structure/types/manage/article/display');

    // No summary for standard pager.
    $this
      ->assertSession()
      ->pageTextNotContains('Pager ID: 0');
    $this
      ->assertSession()
      ->pageTextContains('Pager ID: 1');
    $this
      ->submitForm([], 'comment_settings_edit');

    // Change default pager to 2.
    $this
      ->submitForm([
      'fields[comment][settings_edit_form][settings][pager_id]' => 2,
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Pager ID: 2');

    // Revert the changes.
    $this
      ->submitForm([], 'comment_settings_edit');
    $this
      ->submitForm([
      'fields[comment][settings_edit_form][settings][pager_id]' => 0,
    ], 'Save');

    // No summary for standard pager.
    $this
      ->assertSession()
      ->pageTextNotContains('Pager ID: 0');
    $this
      ->drupalLogin($this->adminUser);

    // Add a new node with both comment fields open.
    $node = $this
      ->drupalCreateNode([
      'type' => 'article',
      'promote' => 1,
      'uid' => $this->webUser
        ->id(),
    ]);

    // Set comment options.
    $comments = [];
    foreach ([
      'comment',
      'comment_2',
    ] as $field_name) {
      $this
        ->setCommentForm(TRUE, $field_name);
      $this
        ->setCommentPreview(DRUPAL_OPTIONAL, $field_name);
      $this
        ->setCommentSettings('default_mode', CommentManagerInterface::COMMENT_MODE_FLAT, 'Comment paging changed.', $field_name);

      // Set comments to one per page so that we are able to test paging without
      // needing to insert large numbers of comments.
      $this
        ->setCommentsPerPage(1, $field_name);
      for ($i = 0; $i < 3; $i++) {
        $comment = t('Comment @count on field @field', [
          '@count' => $i + 1,
          '@field' => $field_name,
        ]);
        $comments[] = $this
          ->postComment($node, $comment, $comment, TRUE, $field_name);
      }
    }

    // Check the first page of the node, and confirm the correct comments are
    // shown.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('next');
    $this
      ->assertSession()
      ->pageTextContains('Comment 1 on field comment');
    $this
      ->assertSession()
      ->pageTextContains('Comment 1 on field comment_2');

    // Navigate to next page of field 1.
    $this
      ->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', [
      ':label' => 'Comment 1 on field comment',
    ]);

    // Check only one pager updated.
    $this
      ->assertSession()
      ->pageTextContains('Comment 2 on field comment');
    $this
      ->assertSession()
      ->pageTextContains('Comment 1 on field comment_2');

    // Return to page 1.
    $this
      ->drupalGet('node/' . $node
      ->id());

    // Navigate to next page of field 2.
    $this
      ->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', [
      ':label' => 'Comment 1 on field comment_2',
    ]);

    // Check only one pager updated.
    $this
      ->assertSession()
      ->pageTextContains('Comment 1 on field comment');
    $this
      ->assertSession()
      ->pageTextContains('Comment 2 on field comment_2');

    // Navigate to next page of field 1.
    $this
      ->clickLinkWithXPath('//h3/a[normalize-space(text())=:label]/ancestor::section[1]//a[@rel="next"]', [
      ':label' => 'Comment 1 on field comment',
    ]);

    // Check only one pager updated.
    $this
      ->assertSession()
      ->pageTextContains('Comment 2 on field comment');
    $this
      ->assertSession()
      ->pageTextContains('Comment 2 on field comment_2');
  }

  /**
   * Follows a link found at a give xpath query.
   *
   * Will click the first link found with the given xpath query by default,
   * or a later one if an index is given.
   *
   * If the link is discovered and clicked, the test passes. Fail otherwise.
   *
   * @param string $xpath
   *   Xpath query that targets an anchor tag, or set of anchor tags.
   * @param array $arguments
   *   An array of arguments with keys in the form ':name' matching the
   *   placeholders in the query. The values may be either strings or numeric
   *   values.
   * @param int $index
   *   Link position counting from zero.
   *
   * @return string|false
   *   Page contents on success, or FALSE on failure.
   *
   * @see \Drupal\Tests\UiHelperTrait::clickLink()
   */
  protected function clickLinkWithXPath($xpath, $arguments = [], $index = 0) {
    $url_before = $this
      ->getUrl();
    $urls = $this
      ->xpath($xpath, $arguments);
    if (isset($urls[$index])) {
      $url_target = $this
        ->getAbsoluteUrl($urls[$index]
        ->getAttribute('href'));
      return $this
        ->drupalGet($url_target);
    }
    $this
      ->fail(new FormattableMarkup('Link %label does not exist on @url_before', [
      '%label' => $xpath,
      '@url_before' => $url_before,
    ]), 'Browser');
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
CommentPagerTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentPagerTest::assertCommentOrder	public	function	Asserts that the comments are displayed in the correct order.
CommentPagerTest::clickLinkWithXPath	protected	function	Follows a link found at a give xpath query.
CommentPagerTest::testCommentNewPageIndicator	public	function	Tests calculation of first page with new comment.
CommentPagerTest::testCommentOrderingThreading	public	function	Tests comment ordering and threading.
CommentPagerTest::testCommentPaging	public	function	Confirms comment paging works correctly with flat and threaded comments.
CommentPagerTest::testCommentPermalink	public	function	Confirms comment paging works correctly with flat and threaded comments.
CommentPagerTest::testTwoPagers	public	function	Confirms comment paging works correctly with two pagers.
CommentTestBase::$adminUser	protected	property	An administrative user with permission to configure comment settings.	1
CommentTestBase::$modules	protected static	property	Modules to install. Overrides BrowserTestBase::$modules	13
CommentTestBase::$node	protected	property	A test node to which comments will be posted.
CommentTestBase::$webUser	protected	property	A normal user with permission to post comments.
CommentTestBase::commentContactInfoAvailable	public	function	Checks whether the commenter's contact information is displayed.
CommentTestBase::commentExists	public	function	Checks current page for specified comment.
CommentTestBase::createCommentType	protected	function	Creates a comment comment type (bundle).
CommentTestBase::deleteComment	public	function	Deletes a comment.
CommentTestBase::getUnapprovedComment	public	function	Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation	public	function	Performs the specified operation on the specified comment.
CommentTestBase::postComment	public	function	Posts a comment.
CommentTestBase::setCommentAnonymous	public	function	Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm	public	function	Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview	public	function	Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings	public	function	Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage	public	function	Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject	public	function	Sets the value governing whether the subject field should be enabled.
CommentTestBase::setUp	protected	function	Overrides BrowserTestBase::setUp	15
CommentTestTrait::addDefaultCommentField	public	function	Adds the default comment field to an entity.
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class CommentPagerTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation