You are here

class ParagraphsStylePluginTest in Paragraphs Collection 8

Tests the style selection plugin.

@group paragraphs_collection

Hierarchy

Expanded class hierarchy of ParagraphsStylePluginTest

See also

\Drupal\paragraphs_collection\Plugin\paragraphs\Behavior\ParagraphsStylePlugin

File

tests/src/FunctionalJavascript/ParagraphsStylePluginTest.php, line 19

Namespace

Drupal\Tests\paragraphs_collection\FunctionalJavascript
View source
class ParagraphsStylePluginTest extends WebDriverTestBase {
  use LoginAdminTrait;
  use ParagraphsTestBaseTrait;
  use FieldUiTestTrait;

  /**
   * Modules to be enabled.
   */
  public static $modules = [
    'node',
    'paragraphs',
    'field',
    'field_ui',
    'block',
    'paragraphs_test',
    'paragraphs_collection',
  ];

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Place the breadcrumb, tested in fieldUIAddNewField().
    $this
      ->drupalPlaceBlock('system_breadcrumb_block');
    $this
      ->drupalPlaceBlock('local_tasks_block');
    $this
      ->drupalPlaceBlock('local_actions_block');
    $this
      ->drupalPlaceBlock('page_title_block');
    $this->admin_permissions = [
      'administer content types',
      'administer node fields',
      'administer paragraphs types',
      'administer node form display',
      'administer paragraph fields',
      'administer paragraph form display',
    ];
  }

  /**
   * Tests the advanced style functionality.
   */
  public function testAdvancedStyles() {

    // Install Paragraph Collection Test in order to have styles.
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
      'use advanced style',
    ]);
    $this
      ->drupalGet('admin/structure/paragraphs_type/add');

    // Create Paragraph type with Style plugin enabled.
    $paragraph_type = 'test_style_plugin';
    $this
      ->addParagraphsType($paragraph_type);

    // Add a text field.
    $this
      ->fieldUIAddExistingField('admin/structure/paragraphs_type/' . $paragraph_type, 'paragraphs_text', $paragraph_type);
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-enabled');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-advanced-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][advanced_test_group][default]' => '',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Create paragraphed content.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_test_style_plugin_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();

    // Assert a user has no access to super advanced style.
    $options = $this
      ->xpath('//select[contains(@id, :id)]/option', [
      ':id' => 'edit-paragraphs-0-behavior-plugins-style-style',
    ]);
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals('- Default -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Advanced', $options[1]
      ->getHtml());

    // Apply advanced style.
    $page
      ->fillField('title[0][value]', 'advanced_style');
    $page
      ->fillField('paragraphs[0][subform][paragraphs_text][0][value]', 'I am text enhanced with advanced style.');
    $page
      ->clickLink('Behavior');
    $page
      ->fillField('paragraphs[0][behavior_plugins][style][style_wrapper][styles][advanced_test_group]', 'advanced');
    $page
      ->pressButton('Save');

    // Advanced style has been applied.
    $this
      ->assertCount(1, $this
      ->cssSelect('.paragraphs-behavior-style--advanced'));

    // Assert that the attributes are visible.
    $this
      ->assertCount(1, $this
      ->cssSelect('[data-attribute="test"]'));

    // Set advanced style as a default one.
    $edit = [
      'behavior_plugins[style][settings][groups][advanced_test_group]' => TRUE,
      'behavior_plugins[style][settings][groups_defaults][advanced_test_group][default]' => 'advanced',
    ];
    $this
      ->drupalPostForm('admin/structure/paragraphs_type/' . $paragraph_type, $edit, t('Save'));

    // Anonymous users still see the advanced style applied.
    $node = $this
      ->getNodeByTitle('advanced_style');
    $this
      ->drupalLogout();
    $this
      ->drupalGet($node
      ->toUrl());
    $this
      ->assertCount(1, $this
      ->cssSelect('.paragraphs-behavior-style--advanced'));

    // Advanced style can not be changed without the style permission.
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
      'use super-advanced style',
    ]);
    $this
      ->drupalGet($node
      ->toUrl('edit-form'));

    // User cannot update the advanced style.
    $styles = $this
      ->xpath('//select[@name="paragraphs[0][behavior_plugins][style][style_wrapper][styles][advanced_test_group]"]');
    $this
      ->assertEquals('disabled', $styles[0]
      ->getAttribute('disabled'));

    // As the user can not access advanced style and as with super-advanced
    // style there would be only element in the list, no style selection is
    // displayed.
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_test_style_plugin_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $styles = $this
      ->xpath('//select[@name="paragraphs[1][behavior_plugins][style][style_wrapper][styles][advanced_test_group]"]');
    $this
      ->assertSession()
      ->elementNotExists('css', 'select[name="paragraphs[1][behavior_plugins][style][style_wrapper][styles][advanced_test_group]"]');
    $this
      ->drupalPostForm(NULL, [], 'Save');

    // The advanced (default) style was applied to the second text paragraph.
    $this
      ->assertCount(2, $this
      ->cssSelect('.paragraphs-behavior-style--advanced'));
  }

  /**
   * Tests the style selection plugin settings and functionality.
   */
  public function testStyleSelection() {

    // Install Paragraph Collection Test in order to have styles.
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
    ]);
    $this
      ->drupalGet('admin/structure/paragraphs_type/add');

    // Create Paragraph type with Style plugin enabled.
    $paragraph_type = 'test_style_plugin';
    $this
      ->addParagraphsType($paragraph_type);

    // Add a text field.
    $this
      ->fieldUIAddExistingField('admin/structure/paragraphs_type/' . $paragraph_type, 'paragraphs_text', $paragraph_type);
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $edit = [
      'behavior_plugins[style][enabled]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertSession()
      ->pageTextContains('The style plugin cannot be enabled if no groups are selected.');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-regular-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][regular_test_group][default]' => '',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Create paragraphed content.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_test_style_plugin_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();

    // Check that we have style plugin.
    $this
      ->assertSession()
      ->pageTextContains('style');
    $this
      ->assertField('paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]');

    // Check that the style options are sorted alphabetically.
    $options = $this
      ->xpath('//select[contains(@id, :id)]/option', [
      ':id' => 'edit-paragraphs-0-behavior-plugins-style-style',
    ]);
    $this
      ->assertEquals('- Default -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $this
      ->assertEquals('Overridden style Module', $options[2]
      ->getHtml());
    $this
      ->assertEquals('Regular', $options[3]
      ->getHtml());

    // Restrict the paragraphs type to the "Italic Test Group" style group.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->assertFieldByName('behavior_plugins[style][settings][groups][italic_test_group]');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-italic-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-regular-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][italic_test_group][default]' => '',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Check that the style without a style group is no longer available.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_test_style_plugin_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();

    // Since Italic Group defines only two styles, assert that only they appear.
    $options = $this
      ->xpath('//select[contains(@id, :id)]/option', [
      ':id' => 'edit-paragraphs-0-behavior-plugins-style-style',
    ]);
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('- Default -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $this
      ->assertEquals('Italic', $options[2]
      ->getHtml());

    // Configure Regular as a default style.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->assertFieldByName('behavior_plugins[style][settings][groups_defaults][italic_test_group][default]', '');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-italic-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-regular-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][regular_test_group][default]' => 'regular',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Regular style should be shown first in the list.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_test_style_plugin_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $page
      ->clickLink('Behavior');
    $option = $this
      ->assertSession()
      ->selectExists('paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]')
      ->getValue();
    $this
      ->assertEquals('regular', $option);
    $options = $this
      ->xpath('//select[contains(@id, :id)]/option', [
      ':id' => 'edit-paragraphs-0-behavior-plugins-style-style',
    ]);
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('- Regular -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());

    // Default style should be applied.
    $page
      ->clickLink('Content');
    $page
      ->fillField('title[0][value]', 'style_plugin_node');
    $page
      ->fillField('paragraphs[0][subform][paragraphs_text][0][value]', 'I am regular text.');
    $this
      ->drupalPostForm(NULL, [], 'Save');

    // Assert the theme suggestion added by the style plugin.
    $this
      ->assertSession()
      ->pageTextContains('paragraph__test_style_plugin__regular');
    $style = $this
      ->xpath('//div[@class="regular regular-wrapper paragraphs-behavior-style--regular paragraph paragraph--type--test-style-plugin paragraph--view-mode--default"]')[0];
    $this
      ->assertNotNull($style);

    // Assert default value for the style selection.
    $node = $this
      ->getNodeByTitle('style_plugin_node');
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $option = $this
      ->assertSession()
      ->selectExists('paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]')
      ->getValue();
    $this
      ->assertEquals('regular', $option);

    // Update the styles group configuration.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-bold-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-overline-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-empty-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][bold_test_group][default]' => 'bold',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');

    // Assert the values on the behavior form.
    $this
      ->drupalGet($node
      ->toUrl('edit-form'));
    $this
      ->assertSession()
      ->pageTextNotContains('Bold CONTEXT');
    $this
      ->assertSession()
      ->pageTextNotContains('Empty Test Group');

    // Regular and Overline style groups are visible.
    $this
      ->assertOptionSelected('edit-paragraphs-0-behavior-plugins-style-style-wrapper-styles-regular-test-group', 'regular', 'Regular style group has a default option applied.');
    $this
      ->assertOptionSelected('edit-paragraphs-0-behavior-plugins-style-style-wrapper-styles-overline-test-group', '', 'There is no configured default value for Overline style group.');

    // Bold and Empty style groups are not visible as they have exactly one
    // item in the list.
    $this
      ->assertNoRaw('edit-paragraphs-0-behavior-plugins-style-style-wrapper-styles-bold-test-group');
    $this
      ->assertNoRaw('edit-paragraphs-0-behavior-plugins-style-style-wrapper-styles-empty-test-group');
    $this
      ->drupalPostForm(NULL, [], 'Save');

    // Regular style has been selected through the form.
    $this
      ->assertCount(1, $this
      ->cssSelect('.paragraphs-behavior-style--regular'));

    // Default Bold style has been applied in the background.
    $this
      ->assertCount(1, $this
      ->cssSelect('.paragraphs-behavior-style--bold'));

    // Overline style has not been applied as it has no default option.
    $this
      ->assertSession()
      ->elementNotExists('css', '.paragraphs-behavior-style--overline');

    // Empty style has not been applied as it has no default option nor styles.
    $this
      ->assertSession()
      ->elementNotExists('css', '.paragraphs-behavior-style--empty');
    $edit = [
      // Set default style for the overline group.
      'behavior_plugins[style][settings][groups_defaults][overline_test_group][default]' => 'overline',
      // Remove default style for the bold group.
      'behavior_plugins[style][settings][groups_defaults][bold_test_group][default]' => '',
    ];
    $this
      ->drupalPostForm('admin/structure/paragraphs_type/' . $paragraph_type, $edit, 'Save');
    $edit = [
      'styles[bold][enabled]' => TRUE,
      'styles[italic][enabled]' => TRUE,
      'styles[underline][enabled]' => TRUE,
      'styles[overline][enabled]' => TRUE,
      // Disable regular style.
      'styles[regular][enabled]' => FALSE,
    ];
    $this
      ->drupalPostForm('admin/reports/paragraphs_collection/styles', $edit, 'Save configuration');
    $this
      ->drupalGet($node
      ->toUrl());

    // The new default overline style applies to the previously saved paragraph.
    $this
      ->assertCount(1, $this
      ->cssSelect('.paragraphs-behavior-style--overline'));

    // The bold style has no default and no longer applies.
    $this
      ->assertSession()
      ->elementNotExists('css', '.paragraphs-behavior-style--bold');

    // The regular style is disabled and no longer applies.
    $this
      ->assertSession()
      ->elementNotExists('css', '.paragraphs-behavior-style--regular');

    // Default overline style is selected and all overline styles are disabled.
    // The empty form element should not be displayed.
    $edit = [
      'styles[bold][enabled]' => FALSE,
      'styles[italic][enabled]' => TRUE,
      'styles[underline][enabled]' => TRUE,
      // Disable overline style.
      'styles[overline][enabled]' => FALSE,
      'styles[regular][enabled]' => FALSE,
    ];
    $this
      ->drupalPostForm('admin/reports/paragraphs_collection/styles', $edit, 'Save configuration');
    $this
      ->drupalGet($node
      ->toUrl('edit-form'));
    $this
      ->assertNoFieldByName('paragraphs[0][behavior_plugins][style][style_wrapper][styles][overline_test_group]');
    $this
      ->assertNoRaw('edit-paragraphs-0-behavior-plugins-style');
  }

  /**
   * Tests style settings summary.
   */
  public function testStyleSettingsSummary() {

    // Install Paragraph Collection Test in order to have styles.
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    $this
      ->addParagraphedContentType('paragraphed_test');
    $this
      ->loginAsAdmin([
      'create paragraphed_test content',
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
    ]);

    // Create text paragraph.
    $text_paragraph = Paragraph::create([
      'type' => 'text',
      'paragraphs_text' => [
        'value' => '<p>Test text 1.</p>',
        'format' => 'basic_html',
      ],
    ]);
    $text_paragraph
      ->save();

    // Create a container paragraph for the text paragraph.
    $paragraph = Paragraph::create([
      'title' => 'Demo Paragraph',
      'type' => 'container',
      'paragraphs_container_paragraphs' => [
        $text_paragraph,
      ],
    ]);
    $paragraph
      ->save();

    // Create a node with the paragraphs content.
    $node = Node::create([
      'title' => 'Style plugin test',
      'type' => 'paragraphed_test',
      'field_paragraphs' => [
        $paragraph,
      ],
    ]);
    $node
      ->save();

    // Check the empty summary.
    $behavior_plugins = $paragraph
      ->getParagraphType()
      ->get('behavior_plugins');
    $behavior_plugins['style'] = [
      'enabled' => TRUE,
      'groups' => [
        'bold_test_group' => [
          'default' => '',
        ],
      ],
    ];
    $paragraph
      ->getParagraphType()
      ->set('behavior_plugins', $behavior_plugins);
    $paragraph
      ->getParagraphType()
      ->save();
    $style_plugin = $paragraph
      ->getParagraphType()
      ->getEnabledBehaviorPlugins()['style'];
    $this
      ->assertEquals([], $style_plugin
      ->settingsSummary($paragraph));

    // Use bold style for this container.
    $paragraph
      ->setBehaviorSettings('style', [
      'styles' => [
        'bold_test_group' => 'bold',
      ],
    ]);
    $paragraph
      ->save();
    $this
      ->assertEquals([
      [
        'label' => 'Bold CONTEXT',
        'value' => 'Bold',
      ],
    ], $style_plugin
      ->settingsSummary($paragraph));
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph
      ->getParagraphType()
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Bold Test Group');

    // Check the settings summary in a closed mode.
    $this
      ->drupalGet('admin/structure/types/manage/paragraphed_test/form-display');
    $this
      ->drupalPostForm(NULL, [], 'field_paragraphs_settings_edit');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->drupalPostForm(NULL, [
      'fields[field_paragraphs][settings_edit_form][settings][edit_mode]' => 'closed',
    ], t('Update'));
    $this
      ->drupalPostForm(NULL, [], 'Save');
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertRaw('edit-field-paragraphs-0-top-icons');
    $this
      ->assertRaw('<span class="summary-content">Test text 1.</span></div><div class="paragraphs-plugin-wrapper"><span class="summary-plugin"><span class="summary-plugin-label">Bold CONTEXT</span>Bold');

    // Configure style bold as default.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph
      ->getType());
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][bold_test_group][default]' => 'bold',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Check that the settings summary does not show the default style.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertRaw('<span class="summary-content">Test text 1.');
    $this
      ->assertNoRaw('Style: Bold');
    $this
      ->assertNoRaw('Style: - Bold -');
  }

  /**
   * Tests style plugin with no styles available.
   */
  public function testNoStylesAvailable() {
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
    ]);
    $this
      ->drupalGet('admin/structure/paragraphs_type/add');

    // Create Paragraph type with Style plugin enabled.
    $paragraph_type = 'test_style_plugin';
    $this
      ->addParagraphsType($paragraph_type);

    // Add a text field.
    $this
      ->fieldUIAddExistingField('admin/structure/paragraphs_type/' . $paragraph_type, 'paragraphs_text', 'paragraphs_text');
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $options = $this
      ->xpath('//*[contains(@id,"edit-behavior-plugins-style-settings-groups")]/option');
    $this
      ->assertCount(0, $options);
    $edit = [
      'behavior_plugins[style][enabled]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Make sure there is an error message shown for the style group.
    $this
      ->assertSession()
      ->pageTextContains('There is no style group available, the style plugin can not be enabled.');
  }

  /**
   * Tests global settings for style plugin.
   */
  public function testGlobalStyleSettings() {

    // Install paragraphs collection test to use test style plugins.
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
    ]);

    // Create Paragraph type with Style plugin enabled.
    $paragraph_type = 'test_style_plugin';
    $this
      ->addParagraphsType($paragraph_type);

    // Add a text field.
    $this
      ->fieldUIAddExistingField('admin/structure/paragraphs_type/' . $paragraph_type, 'paragraphs_text', 'paragraphs_text');
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-enabled');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-bold-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-regular-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);

    // Assert global settings.
    $this
      ->drupalGet('admin/reports/paragraphs_collection/styles');
    $this
      ->assertFieldByName('styles[bold][enabled]', FALSE);
    $this
      ->assertFieldByName('styles[italic][enabled]', FALSE);
    $this
      ->assertFieldByName('styles[regular][enabled]', FALSE);
    $this
      ->assertFieldByName('styles[underline][enabled]', FALSE);

    // Add a node with paragraphs and check the available styles.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_' . $paragraph_type . '_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $page
      ->clickLink('Behavior');
    $options = $this
      ->xpath('//*[contains(@class,"paragraphs-plugin-form-element")]/option');
    $this
      ->assertCount(6, $options);
    $page
      ->fillField('title[0][value]', 'global_settings');
    $edit = [
      'paragraphs[0][behavior_plugins][style][style_wrapper][styles][bold_test_group]' => 'bold',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('paragraphs-behavior-style--bold');
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-italic-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-bold-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->drupalPostForm(NULL, [], t('Save'));

    // Update global settings and enable two styles.
    $this
      ->drupalGet('admin/reports/paragraphs_collection/styles');
    $this
      ->click('#edit-styles-italic-enabled');
    $this
      ->drupalPostForm(NULL, [], 'Save configuration');
    $node = $this
      ->getNodeByTitle('global_settings');
    $this
      ->drupalGet('node/' . $node
      ->id());

    // Assert that the class of the plugin is not added if disabled.
    $this
      ->assertNoRaw('paragraphs-behavior-style--bold');
    $this
      ->clickLink('Edit');

    // Assert that only the two enabled styles are available.
    $options = $this
      ->xpath('//*[contains(@class,"paragraphs-plugin-form-element")]/option');
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals($options[0]
      ->getHtml(), '- Default -');
    $this
      ->assertEquals($options[1]
      ->getHtml(), 'Italic');
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $options = $this
      ->xpath('//*[contains(@name,"behavior_plugins[style][settings][groups_defaults][italic_test_group][default]")]/option');
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals($options[0]
      ->getHtml(), '- None -');
    $this
      ->assertEquals($options[1]
      ->getHtml(), 'Italic');

    // Enable bold and italic styles.
    $edit = [
      'styles[bold][enabled]' => TRUE,
      'styles[italic][enabled]' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/reports/paragraphs_collection/styles', $edit, 'Save configuration');

    // Set default style to italic.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-bold-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][italic_test_group][default]' => 'italic',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Set the paragraph style to bold.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $page
      ->clickLink('Behavior');
    $this
      ->drupalPostForm(NULL, [
      'paragraphs[0][behavior_plugins][style][style_wrapper][styles][italic_test_group]' => 'bold',
    ], t('Save'));
    $this
      ->assertRaw('paragraphs-behavior-style--bold');

    // Assert that the selection is correctly displayed.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertOptionSelected('edit-paragraphs-0-behavior-plugins-style-style-wrapper-styles-italic-test-group', 'bold');

    // Disable the bold style.
    $this
      ->drupalGet('admin/reports/paragraphs_collection/styles');
    $edit = [
      'styles[bold][enabled]' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save configuration');

    // The plugin should fallback on the default style defined.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertRaw('paragraphs-behavior-style--italic');
  }

  /**
   * Tests the multiple style selection plugin settings and functionality.
   */
  public function testMultipleGroups() {

    // Install Paragraph Collection Test in order to have styles.
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
    ]);
    $this
      ->drupalGet('admin/structure/paragraphs_type/add');

    // Create Paragraph type with Style plugin enabled.
    $paragraph_type = 'test_style_plugin';
    $this
      ->addParagraphsType($paragraph_type);

    // Add a text field.
    $this
      ->fieldUIAddExistingField('admin/structure/paragraphs_type/' . $paragraph_type, 'paragraphs_text', $paragraph_type);

    // Restrict the paragraphs type to the "Italic Test Group" style group.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-enabled');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-italic-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][italic_test_group][default]' => 'italic',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Create a paragraphed test node and check the style classes.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_test_style_plugin_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();

    // Since Italic Group defines only two styles, assert that only they appear.
    $page
      ->clickLink('Behavior');
    $options = $this
      ->xpath('//select[contains(@id, :id)]/option', [
      ':id' => 'edit-paragraphs-0-behavior-plugins-style-style',
    ]);
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals('- Italic -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $page
      ->clickLink('Content');
    $edit = [
      'title[0][value]' => 'title_to_remember',
      'paragraphs[0][subform][paragraphs_text][0][value]' => 'text to apply styles',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('paragraphs-behavior-style--italic');

    // Configure two groups and set their defaults.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-regular-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][regular_test_group][default]' => 'regular',
      'behavior_plugins[style][settings][groups_defaults][italic_test_group][default]' => 'italic',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Check the selects elements for each enabled group and check the classes.
    $node = $this
      ->getNodeByTitle('title_to_remember');
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $options = $this
      ->xpath('//select[contains(@name, :name)]/option', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]',
    ]);
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('- Regular -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $options = $this
      ->xpath('//select[contains(@name, :name)]/option', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][italic_test_group]',
    ]);
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals('- Italic -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertRaw('paragraphs-behavior-style--italic');
    $this
      ->assertRaw('paragraphs-behavior-style--regular');

    // Configure Regular as a default style.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-italic-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][regular_test_group][default]' => 'bold',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Check that there is only one select and only one style class.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $options = $this
      ->xpath('//select[contains(@name, :name)]/option', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]',
    ]);
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('- Bold -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Overridden style Module', $options[1]
      ->getHtml());
    $this
      ->assertEquals('Regular', $options[2]
      ->getHtml());
    $styles = $this
      ->xpath('//select[contains(@name, :name)]', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][italic_test_group]',
    ]);
    $this
      ->assertEquals([], $styles);
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertNoRaw('paragraphs-behavior-style--italic');
    $this
      ->assertRaw('paragraphs-behavior-style--bold');

    // Configure Regular as a default style.
    $this
      ->drupalGet('admin/structure/paragraphs_type/' . $paragraph_type);
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-italic-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-underline-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'behavior_plugins[style][settings][groups_defaults][italic_test_group][default]' => 'italic',
      'behavior_plugins[style][settings][groups_defaults][regular_test_group][default]' => 'regular',
      'behavior_plugins[style][settings][groups_defaults][underline_test_group][default]' => 'underline',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Check that there is only one select and only one style class.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $options = $this
      ->xpath('//select[contains(@name, :name)]/option', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]',
    ]);
    $this
      ->assertCount(3, $options);
    $this
      ->assertEquals('- Regular -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $options = $this
      ->xpath('//select[contains(@name, :name)]/option', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][italic_test_group]',
    ]);
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals('- Italic -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $options = $this
      ->xpath('//select[contains(@name, :name)]/option', [
      ':name' => 'paragraphs[0][behavior_plugins][style][style_wrapper][styles][underline_test_group]',
    ]);
    $this
      ->assertCount(2, $options);
    $this
      ->assertEquals('- Underline -', $options[0]
      ->getHtml());
    $this
      ->assertEquals('Bold', $options[1]
      ->getHtml());
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertRaw('paragraphs-behavior-style--italic');
    $this
      ->assertRaw('paragraphs-behavior-style--regular');
    $this
      ->assertRaw('paragraphs-behavior-style--underline');

    // Change a plugin.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $page
      ->clickLink('Behavior');
    $edit = [
      'paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]' => 'bold',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('paragraphs-behavior-style--italic');
    $this
      ->assertRaw('paragraphs-behavior-style--bold');
    $this
      ->assertRaw('paragraphs-behavior-style--underline');

    // Assert the theme suggestion added by the style plugin.
    $this
      ->assertSession()
      ->pageTextContains('paragraph__test_style_plugin__bold');
    $this
      ->assertSession()
      ->pageTextContains('paragraph__test_style_plugin__italic');
  }

  /**
   * Tests the style overriding with sub themes.
   */
  public function testStyleOverriding() {

    // Install theme c and assert that the gotten style has the class "c".
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    $style_discovery = \Drupal::getContainer()
      ->get('paragraphs_collection.style_discovery');
    $style = $style_discovery
      ->getStyle('style-overridden');
    $this
      ->assertEquals($style['title'], new TranslatableMarkup('Overridden style Module'));
    $this
      ->assertEquals($style['classes'], [
      'overridden-style-module',
    ]);
    \Drupal::service('theme_installer')
      ->install([
      'paragraphs_collection_test_theme_a',
    ]);
    $style = $style_discovery
      ->getStyle('style-overridden');
    $this
      ->assertEquals($style['title'], new TranslatableMarkup('Overridden style A'));
    $this
      ->assertEquals($style['classes'], [
      'overridden-style-a',
    ]);
    \Drupal::service('theme_installer')
      ->uninstall([
      'paragraphs_collection_test_theme_a',
    ]);
    $style = $style_discovery
      ->getStyle('style-overridden');
    $this
      ->assertEquals($style['title'], new TranslatableMarkup('Overridden style C'));
    $this
      ->assertEquals($style['classes'], [
      'overridden-style-c',
    ]);
  }

  /**
   * Tests the style template picking.
   */
  public function testStyleTemplate() {

    // Install paragraphs collection test to use test style plugins.
    \Drupal::service('module_installer')
      ->install([
      'paragraphs_collection_test',
    ]);
    \Drupal::service('theme_installer')
      ->install([
      'paragraphs_collection_test_theme_a',
    ]);
    $theme_config = \Drupal::configFactory()
      ->getEditable('system.theme');
    $theme_config
      ->set('default', 'paragraphs_collection_test_theme_a');
    $theme_config
      ->save();
    $this
      ->addParagraphedContentType('paragraphed_test', 'paragraphs');
    $this
      ->loginAsAdmin([
      'edit any paragraphed_test content',
      'edit behavior plugin settings',
    ]);

    // Enable the style plugin.
    $this
      ->drupalGet('admin/structure/paragraphs_type/separator');
    $this
      ->click('#edit-behavior-plugins-style-enabled');
    $this
      ->click('#edit-behavior-plugins-style-settings-groups-regular-test-group');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->drupalPostForm(NULL, [], t('Save'));

    // Add a Separator paragraph and check if it uses the paragraph type
    // template.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->pressButton('List additional actions');
    $page
      ->pressButton('paragraphs_separator_add_more');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit = [
      'title[0][value]' => 'test_title',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');

    // Assert that the Paragraph type template is used.
    $this
      ->assertUniqueText('paragraph-type-template');
    $this
      ->assertSession()
      ->pageTextNotContains('paragraph-style-template');

    // Set the style for the paragraphs and check if it uses the style template.
    $node = $this
      ->getNodeByTitle('test_title');
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $page
      ->clickLink('Behavior');
    $edit = [
      'paragraphs[0][behavior_plugins][style][style_wrapper][styles][regular_test_group]' => 'style-overridden',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');

    // Assert that the Style template is used.
    $this
      ->assertUniqueText('paragraph-style-template');
    $this
      ->assertSession()
      ->pageTextNotContains('paragraph-type-template');
  }

}

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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
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::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.
LoginAdminTrait::loginAsAdmin public function Creates an user with admin permissions and log in.
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
ParagraphsStylePluginTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ParagraphsStylePluginTest::$modules public static property Modules to be enabled. Overrides BrowserTestBase::$modules
ParagraphsStylePluginTest::setUp protected function Overrides BrowserTestBase::setUp
ParagraphsStylePluginTest::testAdvancedStyles public function Tests the advanced style functionality.
ParagraphsStylePluginTest::testGlobalStyleSettings public function Tests global settings for style plugin.
ParagraphsStylePluginTest::testMultipleGroups public function Tests the multiple style selection plugin settings and functionality.
ParagraphsStylePluginTest::testNoStylesAvailable public function Tests style plugin with no styles available.
ParagraphsStylePluginTest::testStyleOverriding public function Tests the style overriding with sub themes.
ParagraphsStylePluginTest::testStyleSelection public function Tests the style selection plugin settings and functionality.
ParagraphsStylePluginTest::testStyleSettingsSummary public function Tests style settings summary.
ParagraphsStylePluginTest::testStyleTemplate public function Tests the style template picking.
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.
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.