You are here

Home » API reference » Paragraphs 8 » ParagraphsWidgetButtonsTest.php

class ParagraphsWidgetButtonsTest in Paragraphs 8

Same name in this branch
  1. 8 tests/src/Functional/ParagraphsWidgetButtonsTest.php \Drupal\Tests\paragraphs\Functional\ParagraphsWidgetButtonsTest
  2. 8 tests/src/Functional/WidgetLegacy/ParagraphsWidgetButtonsTest.php \Drupal\Tests\paragraphs\Functional\WidgetLegacy\ParagraphsWidgetButtonsTest
  3. 8 tests/src/Functional/WidgetStable/ParagraphsWidgetButtonsTest.php \Drupal\Tests\paragraphs\Functional\WidgetStable\ParagraphsWidgetButtonsTest

Tests paragraphs stable widget buttons.

@group paragraphs

Hierarchy

Expanded class hierarchy of ParagraphsWidgetButtonsTest

File

tests/src/Functional/ParagraphsWidgetButtonsTest.php, line 14

Namespace

Drupal\Tests\paragraphs\Functional
View source 
class ParagraphsWidgetButtonsTest extends ParagraphsTestBase {

  /**
   * Modules to enable.
   *
   * @var string[]
   */
  public static $modules = [
    'paragraphs_test',
    'node',
    'paragraphs',
    'field',
    'field_ui',
    'block',
  ];

  /**
   * Tests the autocollapse functionality.
   */
  public function testAutocollapse() {
    $this
      ->addParagraphedContentType('paragraphed_test');
    $permissions = [
      'administer content types',
      'administer node fields',
      'administer paragraphs types',
      'administer node form display',
      'administer paragraph fields',
      'administer paragraph form display',
      'create paragraphed_test content',
      'edit any paragraphed_test content',
    ];
    $this
      ->loginAsAdmin($permissions, TRUE);

    // Add a text Paragraph type.
    $this
      ->addParagraphsType('text_paragraph');
    $this
      ->addFieldtoParagraphType('text_paragraph', 'field_text', 'text_long');

    // Add another Paragraph type so that there is no default Paragraphs type.
    $this
      ->addParagraphsType('another_paragraph');

    // Check that the paragraphs field uses the stable widget.
    $this
      ->drupalGet('admin/structure/types/manage/paragraphed_test/form-display');
    $option = $this
      ->assertSession()
      ->optionExists('fields[field_paragraphs][type]', 'paragraphs');
    $this
      ->assertTrue($option
      ->isSelected());

    // Check that the autocollapse is not displayed if the edit mode is open.
    $this
      ->assertSession()
      ->pageTextNotContains('Autocollapse: None');
    $this
      ->assertSession()
      ->pageTextContains('Edit mode: Open');

    // Create a new node with 2 paragraphs.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_text_paragraph_add_more')
      ->press();
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_text_paragraph_add_more')
      ->press();
    $edit = [
      'title[0][value]' => 'Autocollapse test node',
      'field_paragraphs[0][subform][field_text][0][value]' => 'Fist paragraph',
      'field_paragraphs[1][subform][field_text][0][value]' => 'Second paragraph',
    ];
    $this
      ->submitForm($edit, 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Autocollapse test node');

    // Set the settings to "Open" edit mode without autocollapse.
    $settings = [
      'edit_mode' => 'open',
      'closed_mode' => 'summary',
      'autocollapse' => 'none',
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);

    // Edit the node. Edit mode is "Open". All paragraphs are in the "Edit"
    // mode.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // Autocollapse is disabled. Closing and opening a paragraphs does not
    // affect the other one.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_collapse')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // "Collapse all" affects all paragraphs.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_collapse_all')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');

    // Open the first paragraph and then the second. Opening the second does not
    // close the first.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_1_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // "Edit all" affects all paragraphs.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_edit_all')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // Closing and opening a paragraphs does not affect the other one.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_collapse')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // Enable autocollapse. Set edit mode to "Closed".
    $settings = [
      'edit_mode' => 'closed',
      'closed_mode' => 'summary',
      'autocollapse' => 'all',
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);

    // Edit the node. All paragraphs are closed.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');

    // Open the first paragraph and then the second. Opening the second closes
    // the first.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_1_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // "Edit all" disables auto collapse.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_edit_all')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // Closing and opening a paragraphs does not affect the other one anymore.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_collapse')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // "Collapse all" re-enables autocollapse.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_collapse_all')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');

    // Open the first paragraph and then the second. Opening the second closes
    // the first.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_1_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // Check that adding a new paragraphs closes the others.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_text_paragraph_add_more')
      ->press();
    $this
      ->getSession()
      ->getPage()
      ->fillField('field_paragraphs[2][subform][field_text][0][value]', 'Third paragraph');
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_2', 'edit');

    // Check that duplicating closes the other paragraphs.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_2_duplicate')
      ->press();
    $this
      ->getSession()
      ->getPage()
      ->fillField('field_paragraphs[3][subform][field_text][0][value]', 'Fourth paragraph');
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_2', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_3', 'edit');

    // Check that autocollapse does not restore removed paragraphs.
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_3_remove')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_3', 'removed');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_2_edit')
      ->press();
    $this
      ->checkParagraphInMode('field_paragraphs_3', 'removed');
  }

  /**
   * Tests the "Closed, show nested" edit mode.
   */
  public function testClosedExtendNestedEditMode() {
    $this
      ->addParagraphedContentType('paragraphed_test');
    $permissions = [
      'administer content types',
      'administer node fields',
      'administer paragraphs types',
      'administer node form display',
      'administer paragraph fields',
      'administer paragraph form display',
      'create paragraphed_test content',
      'edit any paragraphed_test content',
    ];
    $this
      ->loginAsAdmin($permissions, TRUE);

    // Add a container Paragraph type.
    $this
      ->addParagraphsType('container_paragraph');
    $this
      ->addParagraphsField('container_paragraph', 'field_paragraphs', 'paragraph', 'paragraphs');

    // Set the edit mode to "Closed".
    $settings = [
      'edit_mode' => 'closed',
      'closed_mode' => 'summary',
    ];
    $this
      ->setParagraphsWidgetSettings('container_paragraph', 'field_paragraphs', $settings, 'paragraphs', 'paragraph');

    // Add a text Paragraph type.
    $this
      ->addParagraphsType('text_paragraph');
    $this
      ->addFieldtoParagraphType('text_paragraph', 'field_text', 'text_long');

    // Set the edit mode to "Closed, show nested".
    $settings = [
      'edit_mode' => 'closed_expand_nested',
      'closed_mode' => 'summary',
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);

    // Check that the paragraphs field uses the stable widget on the
    // paragraphed_test content type.
    $this
      ->drupalGet('admin/structure/types/manage/paragraphed_test/form-display');
    $option = $this
      ->assertSession()
      ->optionExists('fields[field_paragraphs][type]', 'paragraphs');
    $this
      ->assertTrue($option
      ->isSelected());

    // Check if the edit mode is set to "Closed, show nested".
    $this
      ->assertSession()
      ->pageTextContains('Edit mode: Closed, show nested');

    // Check that the paragraphs field uses the stable widget on the
    // container_paragraph paragraph type.
    $this
      ->drupalGet('admin/structure/paragraphs_type/container_paragraph/form-display');
    $option = $this
      ->assertSession()
      ->optionExists('fields[field_paragraphs][type]', 'paragraphs');
    $this
      ->assertTrue($option
      ->isSelected());

    // Check if the edit mode is set to "Closed".
    $this
      ->assertSession()
      ->pageTextContains('Edit mode: Closed');

    // Create a text paragraph.
    $text_paragraph_1 = Paragraph::create([
      'type' => 'text_paragraph',
      'field_text' => [
        'value' => 'Test text 1',
        'format' => 'plain_text',
      ],
    ]);
    $text_paragraph_1
      ->save();

    // Create a container paragraph referencing to the text paragraph.
    $paragraph_1 = Paragraph::create([
      'type' => 'container_paragraph',
      'field_paragraphs' => [
        $text_paragraph_1,
      ],
    ]);
    $paragraph_1
      ->save();

    // Create a second text paragraph.
    $text_paragraph_2 = Paragraph::create([
      'type' => 'text_paragraph',
      'field_text' => [
        'value' => 'Test text 2',
        'format' => 'plain_text',
      ],
    ]);
    $text_paragraph_2
      ->save();

    // Create a second container paragraph referencing to the second text paragraph
    // and the first container paragraph.
    $paragraph_2 = Paragraph::create([
      'type' => 'container_paragraph',
      'field_paragraphs' => [
        $text_paragraph_2,
        $paragraph_1,
      ],
    ]);
    $paragraph_2
      ->save();

    // Create a third text paragraph.
    $text_paragraph_3 = Paragraph::create([
      'type' => 'text_paragraph',
      'field_text' => [
        'value' => 'Test text 3',
        'format' => 'plain_text',
      ],
    ]);
    $text_paragraph_3
      ->save();

    // Create a node referencing to the second container paragraph and the third
    // text paragraph.
    $node = Node::create([
      'type' => 'paragraphed_test',
      'title' => 'Paragraphs Test',
      'field_paragraphs' => [
        $paragraph_2,
        $text_paragraph_3,
      ],
    ]);
    $node
      ->save();

    // Edit the test node.
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');

    // Check if the top level container paragraph is open and the text paragraph
    // is closed.
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'closed');

    // Check if the nested paragraphs are closed.
    $this
      ->checkParagraphInMode('field_paragraphs_0_subform_field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_0_subform_field_paragraphs_1', 'closed');

    // Change the edit mode to "Closed, show nested" on the container_paragraph type.
    $settings = [
      'edit_mode' => 'closed_expand_nested',
    ];

    // Check if the edit mode is changed.
    $this
      ->setParagraphsWidgetSettings('container_paragraph', 'field_paragraphs', $settings, 'paragraphs', 'paragraph');
    $this
      ->drupalGet('admin/structure/paragraphs_type/container_paragraph/form-display');
    $this
      ->assertSession()
      ->pageTextContains('Edit mode: Closed, show nested');

    // Edit the test node agian.
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');

    // Check if the nested container paragraph is open after the change.
    $this
      ->checkParagraphInMode('field_paragraphs_0_subform_field_paragraphs_1', 'edit');
  }

  /**
   * Tests the closed mode threshold.
   */
  public function testClosedModeThreshold() {
    $this
      ->addParagraphedContentType('paragraphed_test');
    $permissions = [
      'administer content types',
      'administer node fields',
      'administer paragraphs types',
      'administer node form display',
      'administer paragraph fields',
      'administer paragraph form display',
      'create paragraphed_test content',
      'edit any paragraphed_test content',
    ];
    $this
      ->loginAsAdmin($permissions, TRUE);
    $this
      ->addParagraphsType('text_paragraph');
    $this
      ->addFieldtoParagraphType('text_paragraph', 'field_text', 'text_long');

    // Add a container Paragraph type.
    $this
      ->addParagraphsType('container_paragraph');
    $this
      ->addParagraphsField('container_paragraph', 'field_paragraphs', 'paragraph', 'paragraphs');

    // Set the edit mode to "Closed".
    $settings = [
      'edit_mode' => 'closed',
      'closed_mode' => 'summary',
    ];
    $this
      ->setParagraphsWidgetSettings('container_paragraph', 'field_paragraphs', $settings, 'paragraphs', 'paragraph');

    // Set the edit mode to "Closed" on the  paragraphed_test content type.
    $settings = [
      'edit_mode' => 'closed',
      'closed_mode' => 'summary',
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);

    // Check if the closed mode threshold summary is not visible.
    $this
      ->assertSession()
      ->pageTextNotContains('Closed mode threshold: 1');

    // Create a text paragraph
    $text_paragraph_1 = Paragraph::create([
      'type' => 'text_paragraph',
      'field_text' => [
        'value' => 'Test text 1',
        'format' => 'plain_text',
      ],
    ]);
    $text_paragraph_1
      ->save();

    // Create a node referencing to the text paragraph.
    $node = Node::create([
      'type' => 'paragraphed_test',
      'title' => 'Paragraphs Test',
      'field_paragraphs' => [
        $text_paragraph_1,
      ],
    ]);
    $node
      ->save();
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');

    // Check if the text paragraph is closed.
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');

    // Set the closed mode threshold to 2.
    $settings = [
      'closed_mode_threshold' => 2,
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');

    // Check if the text paragraph is now open.
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');

    // Set the edit mode to "Closed, show nested".
    $settings = [
      'edit_mode' => 'closed_expand_nested',
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);

    // Create a second text paragraph.
    $text_paragraph_2 = Paragraph::create([
      'type' => 'text_paragraph',
      'field_text' => [
        'value' => 'Test text 2',
        'format' => 'plain_text',
      ],
    ]);
    $text_paragraph_2
      ->save();

    // Create a container paragraph referencing to the second text paragraph.
    $paragraph_1 = Paragraph::create([
      'type' => 'container_paragraph',
      'field_paragraphs' => [
        $text_paragraph_2,
      ],
    ]);
    $paragraph_1
      ->save();

    // Add the container paragraph to the node.
    $node
      ->set('field_paragraphs', [
      $text_paragraph_1,
      $paragraph_1,
    ]);
    $node
      ->save();
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');

    // Check if the text paragraph is closed and the container is opened.
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'closed');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');

    // Set the closed mode threshold to 3.
    $settings = [
      'closed_mode_threshold' => 3,
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'field_paragraphs', $settings);
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');

    // Check if the text paragraph is opened and the container is also opened.
    $this
      ->checkParagraphInMode('field_paragraphs_0', 'edit');
    $this
      ->checkParagraphInMode('field_paragraphs_1', 'edit');
  }

  /**
   * Tests 'Select list' add mode logic.
   */
  public function testAddModeSelect() {
    $this
      ->loginAsAdmin();
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->addParagraphsType('test_paragraph');
    $this
      ->addParagraphsType('text');
    $this
      ->addFieldtoParagraphType('text', 'field_text_demo', 'text');
    $settings = [
      'add_mode' => 'select',
      'edit_mode' => 'closed',
      'closed_mode' => 'summary',
    ];
    $this
      ->setParagraphsWidgetSettings('paragraphed_test', 'paragraphs', $settings, 'paragraphs');
    $this
      ->drupalGet('node/add/paragraphed_test');
    $this
      ->assertSession()
      ->selectExists('paragraphs[add_more][add_more_select]');
    $edit = [
      'settings[handler_settings][negate]' => 0,
      'settings[handler_settings][target_bundles_drag_drop][text][enabled]' => 1,
    ];
    $this
      ->drupalGet('admin/structure/types/manage/paragraphed_test/fields/node.paragraphed_test.paragraphs');
    $this
      ->submitForm($edit, 'Save settings');
    $this
      ->drupalGet('node/add/paragraphed_test');
    $this
      ->assertSession()
      ->fieldNotExists('paragraphs[add_more][add_more_select]');
    $this
      ->getSession()
      ->getPage()
      ->findButton('paragraphs_add_more')
      ->press();
    $edit = [
      'title[0][value]' => 'Demo text title',
      'paragraphs[0][subform][field_text_demo][0][value]' => 'Demo text for the detail page',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Demo text for the detail page');
  }

  /**
   * Asserts that a paragraph is in a particular mode.
   *
   * It does this indirectly by checking checking what buttons are available.
   *
   * @param string $button_prefix
   *   An initial part of the button name; namely "<paragraphs_field>_<delta>".
   *
   * @param string $mode
   *   Assert that the paragraphs is in this widget item mode. Supported modes
   *   are "edit", "closed" and "removed". A paragraph in the "removed" mode
   *   cannot be distinguished from one that has never been added.
   */
  public function checkParagraphInMode($button_prefix, $mode) {
    switch ($mode) {
      case 'edit':
        $this
          ->assertSession()
          ->buttonNotExists($button_prefix . '_edit');
        $this
          ->assertSession()
          ->buttonExists($button_prefix . '_collapse');
        break;
      case 'closed':
        $this
          ->assertSession()
          ->buttonExists($button_prefix . '_edit');
        $this
          ->assertSession()
          ->buttonNotExists($button_prefix . '_collapse');
        break;
      case 'removed':
        $this
          ->assertSession()
          ->buttonNotExists($button_prefix . '_edit');
        $this
          ->assertSession()
          ->buttonNotExists($button_prefix . '_collapse');
        break;
      default:
        throw new \InvalidArgumentException('This function does not support "' . $mode . '" as an argument for "$mode" parameter');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::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
BrowserTestBase::$minkDefaultDriverClass protected property 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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. 23
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.
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
ParagraphsTestBase::$admin_permissions protected property List of permissions used by loginAsAdmin().
ParagraphsTestBase::$admin_user protected property Drupal user object created by loginAsAdmin(). 1
ParagraphsTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ParagraphsTestBase::loginAsAdmin function Creates an user with admin permissions and log in.
ParagraphsTestBase::removeDefaultParagraphType protected function Removes the default paragraph type. Overrides ParagraphsTestBase::removeDefaultParagraphType
ParagraphsTestBase::setAddMode protected function Sets the Paragraphs widget add mode. Overrides ParagraphsTestBase::setAddMode
ParagraphsTestBase::setAllowedParagraphsTypes protected function Sets the allowed Paragraphs types that can be added.
ParagraphsTestBase::setDefaultParagraphType protected function Sets the default paragraph type.
ParagraphsTestBase::setParagraphsTypeWeight protected function Sets the weight of a given Paragraphs type.
ParagraphsTestBase::setParagraphsWidgetMode protected function Sets the Paragraphs widget display mode.
ParagraphsTestBase::setUp protected function Overrides BrowserTestBase::setUp 16
ParagraphsTestBaseTrait::$workflow protected property The workflow entity.
ParagraphsTestBaseTrait::addFieldtoParagraphType protected function Adds a field to a given paragraph type.
ParagraphsTestBaseTrait::addParagraphedContentType protected function Adds a content type with a Paragraphs field.
ParagraphsTestBaseTrait::addParagraphsField protected function Adds a Paragraphs field to a given entity type.
ParagraphsTestBaseTrait::addParagraphsType protected function Adds a Paragraphs type.
ParagraphsTestBaseTrait::addParagraphsTypeIcon protected function Adds an icon to a paragraphs type.
ParagraphsTestBaseTrait::createEditorialWorkflow protected function Creates a workflow entity.
ParagraphsTestBaseTrait::setParagraphsWidgetSettings protected function Sets some of the settings of a paragraphs field widget.
ParagraphsWidgetButtonsTest::$modules public static property Modules to enable. Overrides ParagraphsTestBase::$modules
ParagraphsWidgetButtonsTest::checkParagraphInMode public function Asserts that a paragraph is in a particular mode.
ParagraphsWidgetButtonsTest::testAddModeSelect public function Tests 'Select list' add mode logic.
ParagraphsWidgetButtonsTest::testAutocollapse public function Tests the autocollapse functionality.
ParagraphsWidgetButtonsTest::testClosedExtendNestedEditMode public function Tests the "Closed, show nested" edit mode.
ParagraphsWidgetButtonsTest::testClosedModeThreshold public function Tests the closed mode threshold.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
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. 2
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. 2
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 a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
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 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::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.