paragraphs-8.x-1.11/tests/src/Functional/ParagraphsWidgetButtonsTest.php
tests/src/Functional/ParagraphsWidgetButtonsTest.php
<?php
namespace Drupal\Tests\paragraphs\Functional;
use Drupal\Tests\paragraphs\Functional\WidgetStable\ParagraphsTestBase;
use Drupal\paragraphs\Entity\Paragraph;
use Drupal\node\Entity\Node;
/**
* Tests paragraphs stable widget buttons.
*
* @group paragraphs
*/
class ParagraphsWidgetButtonsTest extends ParagraphsTestBase {
/**
* Modules to enable.
*
* @var string[]
*/
protected 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');
}
}
}
