You are here

class ParagraphsTranslationTest in Paragraphs 8

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

Tests the configuration of paragraphs.

@group paragraphs

Hierarchy

Expanded class hierarchy of ParagraphsTranslationTest

File

tests/src/Functional/WidgetLegacy/ParagraphsTranslationTest.php, line 18

Namespace

Drupal\Tests\paragraphs\Functional\WidgetLegacy
View source
class ParagraphsTranslationTest extends ParagraphsTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'content_translation',
    'link',
    'image',
    'field',
    'field_ui',
    'block',
    'language',
    'node',
  );

  /**
   * A user with admin permissions.
   *
   * @var array
   */
  protected $admin_user;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    ConfigurableLanguage::create([
      'id' => 'de',
      'label' => '1German',
    ])
      ->save();
    ConfigurableLanguage::create([
      'id' => 'fr',
      'label' => '2French',
    ])
      ->save();
    $this
      ->addParagraphedContentType('paragraphed_content_demo', 'field_paragraphs_demo');
    $this
      ->loginAsAdmin([
      'administer site configuration',
      'create paragraphed_content_demo content',
      'edit any paragraphed_content_demo content',
      'delete any paragraphed_content_demo content',
      'administer content translation',
      'translate any entity',
      'create content translations',
      'administer languages',
    ]);
    $this
      ->addParagraphsType('nested_paragraph');
    $this
      ->addParagraphsField('nested_paragraph', 'field_paragraphs_demo', 'paragraph');
    $this
      ->addParagraphsType('images');
    static::fieldUIAddNewField('admin/structure/paragraphs_type/images', 'images_demo', 'Images', 'image', [
      'cardinality' => -1,
    ], [
      'settings[alt_field]' => FALSE,
    ]);
    $this
      ->addParagraphsType('text_image');
    static::fieldUIAddNewField('admin/structure/paragraphs_type/text_image', 'image_demo', 'Images', 'image', [
      'cardinality' => -1,
    ], [
      'settings[alt_field]' => FALSE,
    ]);
    static::fieldUIAddNewField('admin/structure/paragraphs_type/text_image', 'text_demo', 'Text', 'text_long', [], []);
    $this
      ->addParagraphsType('text');
    static::fieldUIAddExistingField('admin/structure/paragraphs_type/text', 'field_text_demo', 'Text', []);
    $edit = [
      'entity_types[node]' => TRUE,
      'entity_types[paragraph]' => TRUE,
      'settings[node][paragraphed_content_demo][translatable]' => TRUE,
      'settings[node][paragraphed_content_demo][fields][field_paragraphs_demo]' => FALSE,
      'settings[paragraph][images][translatable]' => TRUE,
      'settings[paragraph][text_image][translatable]' => TRUE,
      'settings[paragraph][text][translatable]' => TRUE,
      'settings[paragraph][nested_paragraph][translatable]' => TRUE,
      'settings[paragraph][nested_paragraph][fields][field_paragraphs_demo]' => FALSE,
      'settings[paragraph][nested_paragraph][settings][language][language_alterable]' => TRUE,
      'settings[paragraph][images][fields][field_images_demo]' => TRUE,
      'settings[paragraph][text_image][fields][field_image_demo]' => TRUE,
      'settings[paragraph][text_image][fields][field_text_demo]' => TRUE,
      'settings[node][paragraphed_content_demo][settings][language][language_alterable]' => TRUE,
    ];
    $this
      ->drupalGet('admin/config/regional/content-language');
    $this
      ->submitForm($edit, 'Save configuration');

    // Set the form display to legacy.
    EntityFormDisplay::load('node.paragraphed_content_demo.default')
      ->setComponent('field_paragraphs_demo', [
      'type' => 'entity_reference_paragraphs',
    ])
      ->save();
    EntityFormDisplay::load('paragraph.nested_paragraph.default')
      ->setComponent('field_paragraphs_demo', [
      'type' => 'entity_reference_paragraphs',
    ])
      ->save();
    if (version_compare(\Drupal::VERSION, '8.4', '>=')) {

      // @todo Workaround for file usage/unable to save the node with no usages.
      //   Remove when https://www.drupal.org/node/2801777 is fixed.
      \Drupal::configFactory()
        ->getEditable('file.settings')
        ->set('make_unused_managed_files_temporary', TRUE)
        ->save();
    }
  }

  /**
   * Tests the paragraph translation.
   */
  public function testParagraphTranslation() {

    // We need to add a permission to administer roles to deal with revisions.
    $roles = $this->loggedInUser
      ->getRoles();
    $this
      ->grantPermissions(Role::load(array_shift($roles)), [
      'administer nodes',
    ]);
    $this
      ->drupalGet('admin/config/regional/content-language');

    // Check the settings are saved correctly.
    $this
      ->assertSession()
      ->checkboxChecked('edit-entity-types-paragraph');
    $this
      ->assertSession()
      ->checkboxChecked('edit-settings-node-paragraphed-content-demo-translatable');
    $this
      ->assertSession()
      ->checkboxChecked('edit-settings-paragraph-text-image-translatable');
    $this
      ->assertSession()
      ->checkboxChecked('edit-settings-paragraph-images-columns-field-images-demo-alt');
    $this
      ->assertSession()
      ->checkboxChecked('edit-settings-paragraph-images-columns-field-images-demo-title');

    // Check if the publish/unpublish option works.
    $this
      ->drupalGet('admin/structure/paragraphs_type/text_image/form-display');
    $edit = array(
      'fields[status][type]' => 'boolean_checkbox',
      'fields[status][region]' => 'content',
    );
    $this
      ->submitForm($edit, 'Save');
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $this
      ->submitForm([], 'Add text_image');
    $this
      ->assertSession()
      ->responseContains('edit-field-paragraphs-demo-0-subform-status-value');
    $edit = [
      'title[0][value]' => 'example_publish_unpublish',
      'field_paragraphs_demo[0][subform][field_text_demo][0][value]' => 'Example published and unpublished',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Example published and unpublished');
    $this
      ->clickLink('Edit');
    $this
      ->submitForm([], 'field_paragraphs_demo_nested_paragraph_add_more');
    $this
      ->submitForm([], 'field_paragraphs_demo_1_subform_field_paragraphs_demo_text_add_more');
    $edit = [
      'field_paragraphs_demo[0][subform][status][value]' => FALSE,
      'field_paragraphs_demo[1][subform][field_paragraphs_demo][0][subform][field_text_demo][0][value]' => 'Dummy text',
    ];
    $this
      ->submitForm($edit + [
      'status[value]' => FALSE,
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextNotContains('Example published and unpublished');

    // Check the parent fields are set properly. Get the node.
    $node = $this
      ->drupalGetNodeByTitle('example_publish_unpublish');

    // Loop over the paragraphs of the node.
    foreach ($node->field_paragraphs_demo
      ->referencedEntities() as $paragraph) {
      $node_paragraph = Paragraph::load($paragraph
        ->id())
        ->toArray();

      // Check if the fields are set properly.
      $this
        ->assertEquals($node_paragraph['parent_id'][0]['value'], $node
        ->id());
      $this
        ->assertEquals($node_paragraph['parent_type'][0]['value'], 'node');
      $this
        ->assertEquals($node_paragraph['parent_field_name'][0]['value'], 'field_paragraphs_demo');

      // If the paragraph is nested type load the child.
      if ($node_paragraph['type'][0]['target_id'] == 'nested_paragraph') {
        $nested_paragraph = Paragraph::load($node_paragraph['field_paragraphs_demo'][0]['target_id'])
          ->toArray();

        // Check if the fields are properly set.
        $this
          ->assertEquals($nested_paragraph['parent_id'][0]['value'], $paragraph
          ->id());
        $this
          ->assertEquals($nested_paragraph['parent_type'][0]['value'], 'paragraph');
        $this
          ->assertEquals($nested_paragraph['parent_field_name'][0]['value'], 'field_paragraphs_demo');
      }
    }

    // Add paragraphed content.
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $this
      ->submitForm([], 'Add text_image');
    $edit = array(
      'title[0][value]' => 'Title in english',
      'field_paragraphs_demo[0][subform][field_text_demo][0][value]' => 'Text in english',
    );

    // The button to remove a paragraph is present.
    $this
      ->assertSession()
      ->responseContains('Remove');
    $this
      ->submitForm($edit, 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Title in english');

    // The text is present when editing again.
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->pageTextContains('Title in english');
    $this
      ->assertSession()
      ->pageTextContains('Text in english');

    // Add french translation.
    $this
      ->clickLink('Translate');
    $this
      ->clickLink('Add', 1);

    // Make sure the Add / Remove paragraph buttons are hidden.
    $this
      ->assertSession()
      ->responseNotContains('Remove');
    $this
      ->assertSession()
      ->responseNotContains('Add text_image');

    // Make sure that the original paragraph text is displayed.
    $this
      ->assertSession()
      ->pageTextContains('Text in english');
    $edit = array(
      'title[0][value]' => 'Title in french',
      'field_paragraphs_demo[0][subform][field_text_demo][0][value]' => 'Text in french',
      'revision' => TRUE,
      'revision_log[0][value]' => 'french 1',
    );
    $this
      ->submitForm($edit, 'Save (this translation)');
    $this
      ->assertSession()
      ->pageTextContains('paragraphed_content_demo Title in french has been updated.');

    // Check the english translation.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Title in english');
    $this
      ->assertSession()
      ->pageTextContains('Text in english');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in french');
    $this
      ->assertSession()
      ->pageTextNotContains('Text in french');

    // Check the french translation.
    $this
      ->drupalGet('fr/node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Title in french');
    $this
      ->assertSession()
      ->pageTextContains('Text in french');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in english');

    // The translation is still present when editing again.
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->pageTextContains('Title in french');
    $this
      ->assertSession()
      ->pageTextContains('Text in french');
    $edit = array(
      'title[0][value]' => 'Title Change in french',
      'field_paragraphs_demo[0][subform][field_text_demo][0][value]' => 'New text in french',
      'revision' => TRUE,
      'revision_log[0][value]' => 'french 2',
    );
    $this
      ->submitForm($edit, 'Save (this translation)');
    $this
      ->assertSession()
      ->pageTextContains('Title Change in french');
    $this
      ->assertSession()
      ->pageTextContains('New text in french');

    // Back to the source language.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->pageTextContains('Title in english');
    $this
      ->assertSession()
      ->pageTextContains('Text in english');

    // Save the original content on second request.
    $this
      ->submitForm([], 'Save (this translation)');
    $this
      ->assertSession()
      ->pageTextContains('paragraphed_content_demo Title in english has been updated.');

    // Test if reverting to old paragraphs revisions works, make sure that
    // the reverted node can be saved again.
    $this
      ->drupalGet('fr/node/' . $node
      ->id() . '/revisions');
    $this
      ->clickLink('Revert');
    $this
      ->submitForm([
      'revert_untranslated_fields' => TRUE,
    ], 'Revert');
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->responseContains('Title in french');
    $this
      ->assertSession()
      ->pageTextContains('Text in french');
    $this
      ->submitForm([], 'Save (this translation)');
    $this
      ->assertSession()
      ->responseNotContains('The content has either been modified by another user, or you have already submitted modifications');
    $this
      ->assertSession()
      ->pageTextContains('Text in french');

    //Add paragraphed content with untranslatable language
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $edit = array(
      'langcode[0][value]' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    );
    $this
      ->submitForm($edit, 'Add text_image');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Make 'Images' paragraph field translatable, enable alt and title fields.
    $this
      ->drupalGet('admin/structure/paragraphs_type/images/fields');
    $this
      ->clickLink('Edit');
    $edit = [
      'translatable' => 1,
      'settings[alt_field]' => 1,
      'settings[title_field]' => 1,
    ];
    $this
      ->submitForm($edit, 'Save settings');

    // Create a node with an image paragraph, its alt and title text.
    $files = $this
      ->getTestFiles('image');
    $file_system = \Drupal::service('file_system');
    $file_path = $file_system
      ->realpath($file_system
      ->realpath($files[0]->uri));
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $this
      ->submitForm([], 'Add images');
    $this
      ->submitForm([
      'files[field_paragraphs_demo_0_subform_field_images_demo_0][]' => $file_path,
    ], 'Upload');
    $edit = [
      'title[0][value]' => 'Title EN',
      'field_paragraphs_demo[0][subform][field_images_demo][0][alt]' => 'Image alt',
      'field_paragraphs_demo[0][subform][field_images_demo][0][title]' => 'Image title',
    ];
    $this
      ->submitForm($edit, 'Save');

    // Translate the node with the image paragraph.
    $this
      ->clickLink('Translate');
    $this
      ->clickLink('Add', 1);
    $edit = [
      'title[0][value]' => 'Title FR',
      'field_paragraphs_demo[0][subform][field_images_demo][0][alt]' => 'Image alt FR',
      'field_paragraphs_demo[0][subform][field_images_demo][0][title]' => 'Image title FR',
    ];
    $this
      ->submitForm($edit, 'Save (this translation)');
    $this
      ->assertSession()
      ->responseContains('Title FR');
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $this
      ->submitForm([], 'Add text');
    $edit = [
      'field_paragraphs_demo[0][subform][field_text_demo][0][value]' => 'texto',
      'title[0][value]' => 'titulo',
      'langcode[0][value]' => 'de',
    ];
    $this
      ->submitForm($edit, 'Save');
    $node = $this
      ->drupalGetNodeByTitle('titulo');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de');

    // Test langcode matching when Paragraphs and node have different language.
    $paragraph_1 = Paragraph::create([
      'title' => 'Paragraph',
      'type' => 'text',
      'langcode' => 'en',
      'field_text_demo' => 'english_text_1',
    ]);
    $paragraph_1
      ->save();
    $paragraph_2 = Paragraph::create([
      'title' => 'Paragraph',
      'type' => 'text',
      'langcode' => 'en',
      'field_text_demo' => 'english_text_2',
    ]);
    $paragraph_2
      ->save();
    $paragraph_data = $paragraph_2
      ->toArray();
    $paragraph_data['field_text_demo'] = 'german_text_2';
    $paragraph_2
      ->addTranslation('de', $paragraph_data);
    $paragraph_2
      ->save();
    $translated_paragraph = $paragraph_2
      ->getTranslation('en');
    $node = $this
      ->createNode([
      'langcode' => 'de',
      'type' => 'paragraphed_content_demo',
      'field_paragraphs_demo' => [
        $paragraph_1,
        $translated_paragraph,
      ],
    ]);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('paragraphed_content_demo ' . $node
      ->label() . ' has been updated.');

    // Check that first paragraph langcode has been updated.
    \Drupal::entityTypeManager()
      ->getStorage('paragraph')
      ->resetCache([
      $paragraph_1
        ->id(),
      $paragraph_2
        ->id(),
    ]);
    $paragraph = Paragraph::load($paragraph_1
      ->id());
    $this
      ->assertEquals($paragraph
      ->language()
      ->getId(), 'de');
    $this
      ->assertFalse($paragraph
      ->hasTranslation('en'));

    // Check that second paragraph has two translations.
    $paragraph = Paragraph::load($paragraph_2
      ->id());
    $this
      ->assertTrue($paragraph
      ->hasTranslation('de'));
    $this
      ->assertTrue($paragraph
      ->hasTranslation('en'));
    $this
      ->assertSession()
      ->responseContains('german_text');

    // Create an english translation of the node.
    $edit = [
      'field_paragraphs_demo[0][subform][field_text_demo][0][value]' => 'english_translation_1',
      'field_paragraphs_demo[1][subform][field_text_demo][0][value]' => 'english_translation_2',
    ];
    $this
      ->drupalGet('node/' . $node
      ->id() . '/translations/add/de/en');
    $this
      ->submitForm($edit, 'Save (this translation)');

    // Attempt to create a french translation.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/translations/add/de/fr');

    // Check that the german translation of the paragraphs is displayed.
    $this
      ->assertSession()
      ->fieldValueEquals('field_paragraphs_demo[0][subform][field_text_demo][0][value]', 'english_text_1');
    $this
      ->assertSession()
      ->fieldValueEquals('field_paragraphs_demo[1][subform][field_text_demo][0][value]', 'german_text_2');
    $this
      ->submitForm([
      'source_langcode[source]' => 'en',
    ], 'Change');

    // Check that the english translation of the paragraphs is displayed.
    $this
      ->assertSession()
      ->fieldValueEquals('field_paragraphs_demo[0][subform][field_text_demo][0][value]', 'english_translation_1');
    $this
      ->assertSession()
      ->fieldValueEquals('field_paragraphs_demo[1][subform][field_text_demo][0][value]', 'english_translation_2');

    // Create a node with empty Paragraphs.
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $this
      ->submitForm([], 'Add nested_paragraph');
    $edit = [
      'title[0][value]' => 'empty_node',
    ];
    $this
      ->submitForm($edit, 'Save');

    // Attempt to translate it.
    $this
      ->clickLink('Translate');
    $this
      ->clickLink('Add');

    // Check the add button is not displayed.
    $this
      ->assertEquals(count($this
      ->xpath('//*[@name="field_paragraphs_demo_0_subform_field_paragraphs_demo_images_add_more"]')), 0);

    // Add a non translatable field to Text Paragraph type.
    $edit = [
      'new_storage_type' => 'text_long',
      'label' => 'untranslatable_field',
      'field_name' => 'untranslatable_field',
    ];
    $this
      ->drupalGet('admin/structure/paragraphs_type/text/fields/add-field');
    $this
      ->submitForm($edit, 'Save and continue');
    $this
      ->submitForm([], 'Save field settings');
    $this
      ->submitForm([], 'Save settings');

    // Add a non translatable reference field.
    $edit = [
      'new_storage_type' => 'field_ui:entity_reference:node',
      'label' => 'untranslatable_ref_field',
      'field_name' => 'untranslatable_ref_field',
    ];
    $this
      ->drupalGet('admin/structure/paragraphs_type/text/fields/add-field');
    $this
      ->submitForm($edit, 'Save and continue');
    $this
      ->submitForm([], 'Save field settings');
    $this
      ->submitForm([
      'settings[handler_settings][target_bundles][paragraphed_content_demo]' => TRUE,
    ], 'Save settings');

    // Add a non translatable link field.
    $edit = [
      'new_storage_type' => 'link',
      'label' => 'untranslatable_link_field',
      'field_name' => 'untranslatable_link_field',
    ];
    $this
      ->drupalGet('admin/structure/paragraphs_type/text/fields/add-field');
    $this
      ->submitForm($edit, 'Save and continue');
    $this
      ->submitForm([], 'Save field settings');
    $this
      ->submitForm([], 'Save settings');

    // Attempt to add a translation.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/translations/add/de/fr');
    $this
      ->assertSession()
      ->pageTextContains('untranslatable_field (all languages)');
    $this
      ->assertSession()
      ->pageTextContains('untranslatable_ref_field (all languages)');
    $this
      ->assertSession()
      ->pageTextContains('untranslatable_link_field (all languages)');
    $this
      ->assertSession()
      ->pageTextNotContains('Text (all languages)');

    // Enable translations for the reference and link field.
    $edit = [
      'translatable' => TRUE,
    ];
    $this
      ->drupalGet('admin/structure/paragraphs_type/text/fields/paragraph.text.field_untranslatable_ref_field');
    $this
      ->submitForm($edit, 'Save settings');
    $this
      ->drupalGet('admin/structure/paragraphs_type/text/fields/paragraph.text.field_untranslatable_link_field');
    $this
      ->submitForm($edit, 'Save settings');

    // Attempt to add a translation.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/translations/add/de/fr');
    $this
      ->assertSession()
      ->pageTextContains('untranslatable_field (all languages)');
    $this
      ->assertSession()
      ->pageTextNotContains('untranslatable_link_field (all languages)');
    $this
      ->assertSession()
      ->pageTextNotContains('untranslatable_ref_field (all languages)');
    $this
      ->assertSession()
      ->pageTextNotContains('Text (all languages)');
  }

  /**
   * Tests the paragraph buttons presence in translation multilingual workflow.
   *
   * This test covers the following test cases:
   * 1) original node langcode in EN, translate in FR, change to DE.
   * 2) original node langcode in DE, change site langcode to DE, change node
   *    langcode to EN.
   */
  public function testParagraphTranslationMultilingual() {

    // Case 1: original node langcode in EN, translate in FR, change to DE.
    // Add 'Images' paragraph and check the paragraphs buttons are displayed.
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $this
      ->submitForm([], 'Add images');
    $this
      ->assertParagraphsButtons(1);

    // Upload an image and check the paragraphs buttons are still displayed.
    $images = $this
      ->getTestFiles('image')[0];
    $edit = [
      'title[0][value]' => 'Title in english',
      'files[field_paragraphs_demo_0_subform_field_images_demo_0][]' => $images->uri,
    ];
    $this
      ->submitForm($edit, 'Upload');
    $this
      ->assertParagraphsButtons(1);
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Title in english');
    $node = $this
      ->drupalGetNodeByTitle('Title in english');

    // Check the paragraph langcode is 'en'.
    $this
      ->assertParagraphsLangcode($node
      ->id());

    // Add french translation.
    $this
      ->clickLink('Translate');
    $this
      ->clickLink('Add', 1);

    // Make sure the host entity and its paragraphs have valid source language
    // and check that the paragraphs buttons are hidden.
    $this
      ->assertNoParagraphsButtons(1);
    $edit = [
      'title[0][value]' => 'Title in french',
    ];
    $this
      ->submitForm($edit, 'Save (this translation)');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'en', 'fr');
    $this
      ->assertSession()
      ->pageTextContains('paragraphed_content_demo Title in french has been updated.');
    $this
      ->assertSession()
      ->pageTextContains('Title in french');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in english');

    // Check the original node and the paragraph langcode is still 'en'.
    $this
      ->assertParagraphsLangcode($node
      ->id());

    // Edit the french translation and upload a new image.
    $this
      ->clickLink('Edit');
    $images = $this
      ->getTestFiles('image')[1];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_0_subform_field_images_demo_1][]' => $images->uri,
    ], 'Upload');

    // Check editing a translation does not affect the source langcode and
    // check that the paragraphs buttons are still hidden.
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'en', 'fr');
    $this
      ->assertNoParagraphsButtons(1);
    $this
      ->submitForm([], 'Save (this translation)');
    $this
      ->assertSession()
      ->pageTextContains('Title in french');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in english');

    // Back to the original node.
    $this
      ->drupalGet('node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Title in english');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in french');

    // Check the original node and the paragraph langcode are still 'en' and
    // check that the paragraphs buttons are still displayed.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node
      ->id());
    $this
      ->assertParagraphsButtons(1);

    // Change the node langcode to 'german', add a 'Nested Paragraph', check
    // the paragraphs langcode are still 'en' and their buttons are displayed.
    $edit = [
      'title[0][value]' => 'Title in english (de)',
      'langcode[0][value]' => 'de',
    ];
    $this
      ->submitForm($edit, 'Add nested_paragraph');
    $this
      ->assertParagraphsLangcode($node
      ->id());
    $this
      ->assertParagraphsButtons(2);

    // Add an 'Images' paragraph inside the nested one, check the paragraphs
    // langcode are still 'en' and the paragraphs buttons are still displayed.
    $this
      ->submitForm([], 'field_paragraphs_demo_1_subform_field_paragraphs_demo_images_add_more');
    $this
      ->assertParagraphsLangcode($node
      ->id());
    $this
      ->assertParagraphsButtons(2);

    // Upload a new image, check the paragraphs langcode are still 'en' and the
    // paragraphs buttons are displayed.
    $images = $this
      ->getTestFiles('image')[2];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_1_subform_field_paragraphs_demo_0_subform_field_images_demo_0][]' => $images->uri,
    ], 'Upload');
    $this
      ->assertParagraphsLangcode($node
      ->id());
    $this
      ->assertParagraphsButtons(2);
    $this
      ->submitForm([], 'Save (this translation)');
    $this
      ->assertSession()
      ->pageTextContains('Title in english (de)');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in french');

    // Check the original node and the paragraphs langcode are now 'de'.
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de');

    // Check the french translation.
    $this
      ->drupalGet('fr/node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Title in french');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in english (de)');

    // Check editing a translation does not affect the source langcode and
    // check that the paragraphs buttons are still hidden.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de', 'fr');
    $this
      ->assertNoParagraphsButtons(2);

    // Case 2: original node langcode in DE, change site langcode to DE, change
    // node langcode to EN.
    // Change the site langcode to french.
    $this
      ->drupalGet('admin/config/regional/language');
    $this
      ->submitForm([
      'site_default_language' => 'fr',
    ], 'Save configuration');

    // Check the original node and its paragraphs langcode are still 'de'
    // and the paragraphs buttons are still displayed.
    $this
      ->drupalGet('de/node/' . $node
      ->id() . '/edit');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de');
    $this
      ->assertParagraphsButtons(2);

    // Go to the french translation.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/translations');
    $this
      ->clickLink('Edit', 1);

    // Check editing a translation does not affect the source langcode and
    // check that the paragraphs buttons are still hidden.
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de', 'fr');
    $this
      ->assertNoParagraphsButtons(2);

    // Upload another image.
    $images = $this
      ->getTestFiles('image')[3];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_1_subform_field_paragraphs_demo_0_subform_field_images_demo_1][]' => $images->uri,
    ], 'Upload');

    // Check editing a translation does not affect the source langcode and
    // check that the paragraphs buttons are still hidden.
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de', 'fr');
    $this
      ->assertNoParagraphsButtons(2);
    $this
      ->submitForm([], 'Save (this translation)');

    // Check the paragraphs langcode are still 'de' after saving the translation.
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de', 'fr');
    $this
      ->assertSession()
      ->pageTextContains('Title in french');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in english (de)');

    // Back to the original node.
    $this
      ->drupalGet('de/node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Title in english (de)');
    $this
      ->assertSession()
      ->pageTextNotContains('Title in french');

    // Check the original node and the paragraphs langcode are still 'de' and
    // check that the paragraphs buttons are still displayed.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de');
    $this
      ->assertParagraphsButtons(2);

    // Change the node langcode back to 'english', add an 'Images' paragraph,
    // check the paragraphs langcode are still 'de' and their buttons are shown.
    $edit = [
      'title[0][value]' => 'Title in english',
      'langcode[0][value]' => 'en',
    ];
    $this
      ->submitForm($edit, 'field_paragraphs_demo_images_add_more');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de');
    $this
      ->assertParagraphsButtons(3);

    // Upload a new image, check the paragraphs langcode are still 'de' and the
    // paragraphs buttons are displayed.
    $images = $this
      ->getTestFiles('image')[4];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_2_subform_field_images_demo_0][]' => $images->uri,
    ], 'Upload');
    $this
      ->assertParagraphsLangcode($node
      ->id(), 'de');
    $this
      ->assertParagraphsButtons(3);
    $this
      ->submitForm([], 'Save (this translation)');
    $this
      ->assertSession()
      ->pageTextContains('paragraphed_content_demo Title in english has been updated.');

    // Check the original node and the paragraphs langcode are now 'en'.
    $this
      ->assertParagraphsLangcode($node
      ->id());
  }

  /**
   * Tests the paragraphs buttons presence in multilingual workflow.
   *
   * This test covers the following test cases:
   * 1) original node langcode in german, change to english.
   * 2) original node langcode in english, change to german.
   * 3) original node langcode in english, change site langcode to german,
   *   change node langcode to german.
   */
  public function testParagraphsMultilingualWorkflow() {

    // Case 1: Check the paragraphs buttons after changing the NODE language
    // (original node langcode in GERMAN, default site langcode in english).
    // Create a node and check that the node langcode is 'english'.
    $this
      ->drupalGet('node/add/paragraphed_content_demo');
    $langcode_option = $this
      ->assertSession()
      ->optionExists('edit-langcode-0-value', 'en');
    $this
      ->assertTrue($langcode_option
      ->hasAttribute('selected'));

    // Change the node langcode to 'german' and add a 'Nested Paragraph'.
    $edit = [
      'title[0][value]' => 'Title in german',
      'langcode[0][value]' => 'de',
    ];
    $this
      ->submitForm($edit, 'Add nested_paragraph');

    // Check that the paragraphs buttons are displayed and add an 'Images'
    // paragraph inside the nested paragraph.
    $this
      ->assertParagraphsButtons(1);
    $this
      ->submitForm([], 'field_paragraphs_demo_0_subform_field_paragraphs_demo_images_add_more');

    // Upload an image and check the paragraphs buttons are still displayed.
    $images = $this
      ->getTestFiles('image')[0];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_0_subform_field_paragraphs_demo_0_subform_field_images_demo_0][]' => $images->uri,
    ], 'Upload');
    $this
      ->assertParagraphsButtons(1);
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Title in german');
    $node1 = $this
      ->getNodeByTitle('Title in german');

    // Check the paragraph langcode is 'de' and its buttons are displayed.
    // @todo check for the nested children paragraphs buttons and langcode
    // when it's supported.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node1
      ->id(), 'de');
    $this
      ->assertParagraphsButtons(1);

    // Change the node langcode to 'english' and upload another image.
    $images = $this
      ->getTestFiles('image')[1];
    $edit = [
      'title[0][value]' => 'Title in german (en)',
      'langcode[0][value]' => 'en',
      'files[field_paragraphs_demo_0_subform_field_paragraphs_demo_0_subform_field_images_demo_1][]' => $images->uri,
    ];
    $this
      ->submitForm($edit, 'Upload');

    // Check the paragraph langcode is still 'de' and its buttons are shown.
    $this
      ->assertParagraphsLangcode($node1
      ->id(), 'de');
    $this
      ->assertParagraphsButtons(1);
    $this
      ->submitForm([], 'Save');

    // Check the paragraph langcode is now 'en' after saving.
    $this
      ->assertParagraphsLangcode($node1
      ->id());

    // Check the paragraph langcode is 'en' and its buttons are still shown.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node1
      ->id());
    $this
      ->assertParagraphsButtons(1);

    // Case 2: Check the paragraphs buttons after changing the NODE language
    // (original node langcode in ENGLISH, default site langcode in english).
    // Create another node.
    $this
      ->drupalGet('node/add/paragraphed_content_demo');

    // Check that the node langcode is 'english' and add a 'Nested Paragraph'.
    $langcode_option = $this
      ->assertSession()
      ->optionExists('edit-langcode-0-value', 'en');
    $this
      ->assertTrue($langcode_option
      ->hasAttribute('selected'));
    $this
      ->submitForm([], 'Add nested_paragraph');

    // Check that the paragraphs buttons are displayed and add an 'Images'
    // paragraph inside the nested paragraph.
    $this
      ->assertParagraphsButtons(1);
    $this
      ->submitForm([], 'field_paragraphs_demo_0_subform_field_paragraphs_demo_images_add_more');

    // Upload an image and check the paragraphs buttons are still displayed.
    $images = $this
      ->getTestFiles('image')[0];
    $edit = [
      'title[0][value]' => 'Title in english',
      'files[field_paragraphs_demo_0_subform_field_paragraphs_demo_0_subform_field_images_demo_0][]' => $images->uri,
    ];
    $this
      ->submitForm($edit, 'Upload');
    $this
      ->assertParagraphsButtons(1);
    $this
      ->submitForm([], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Title in english');
    $node2 = $this
      ->drupalGetNodeByTitle('Title in english');

    // Check the paragraph langcode is 'en' and its buttons are displayed.
    // @todo check for the nested children paragraphs buttons and langcode
    // when it's supported.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(1);

    // Change the node langcode to 'german' and add another 'Images' paragraph.
    $edit = [
      'title[0][value]' => 'Title in english (de)',
      'langcode[0][value]' => 'de',
    ];
    $this
      ->submitForm($edit, 'field_paragraphs_demo_images_add_more');

    // Check the paragraphs langcode are still 'en' and their buttons are shown.
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(2);

    // Upload an image, check the paragraphs langcode are still 'en' and their
    // buttons are displayed.
    $images = $this
      ->getTestFiles('image')[1];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_1_subform_field_images_demo_0][]' => $images->uri,
    ], 'Upload');
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(2);
    $this
      ->submitForm([], 'Save');

    // Check the paragraphs langcode are now 'de' after saving.
    $this
      ->assertParagraphsLangcode($node2
      ->id(), 'de');

    // Change node langcode back to 'english' and save.
    $this
      ->clickLink('Edit');
    $edit = [
      'title[0][value]' => 'Title in english',
      'langcode[0][value]' => 'en',
    ];
    $this
      ->submitForm($edit, 'Save');

    // Check the paragraphs langcode are now 'en' after saving.
    $this
      ->assertParagraphsLangcode($node2
      ->id());

    // Case 3: Check the paragraphs buttons after changing the SITE language.
    // Change the site langcode to german.
    $edit = [
      'site_default_language' => 'de',
    ];
    $this
      ->drupalGet('admin/config/regional/language');
    $this
      ->submitForm($edit, 'Save configuration');

    // Check the original node and the paragraphs langcode are still 'en' and
    // check that the paragraphs buttons are still displayed.
    $this
      ->drupalGet('node/' . $node2
      ->id() . '/edit');
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(2);

    // Add another 'Images' paragraph with node langcode as 'english'.
    $this
      ->submitForm([], 'field_paragraphs_demo_images_add_more');

    // Check the paragraph langcode are still 'en' and their buttons are shown.
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(3);

    // Upload an image, check the paragraphs langcode are still 'en' and their
    // buttons are displayed.
    $images = $this
      ->getTestFiles('image')[2];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_2_subform_field_images_demo_0][]' => $images->uri,
    ], 'Upload');
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(3);
    $this
      ->submitForm([], 'Save');

    // Check the paragraphs langcode are still 'en' after saving.
    $this
      ->assertParagraphsLangcode($node2
      ->id());

    // Check the paragraphs langcode are still 'en' and their buttons are shown.
    $this
      ->clickLink('Edit');
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(3);

    // Change node langcode to 'german' and add another 'Images' paragraph.
    $edit = [
      'title[0][value]' => 'Title in english (de)',
      'langcode[0][value]' => 'de',
    ];
    $this
      ->submitForm($edit, 'field_paragraphs_demo_images_add_more');

    // Check the paragraphs langcode are still 'en' and their buttons are shown.
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(4);

    // Upload an image, check the paragraphs langcode are still 'en' and their
    // buttons are displayed.
    $images = $this
      ->getTestFiles('image')[3];
    $this
      ->submitForm([
      'files[field_paragraphs_demo_3_subform_field_images_demo_0][]' => $images->uri,
    ], 'Upload');
    $this
      ->assertParagraphsLangcode($node2
      ->id());
    $this
      ->assertParagraphsButtons(4);
    $this
      ->submitForm([], 'Save');

    // Check the paragraphs langcode are now 'de' after saving.
    $this
      ->assertParagraphsLangcode($node2
      ->id(), 'de');
  }

  /**
   * Passes if the paragraphs buttons are present.
   *
   * @param int $count
   *   Number of paragraphs buttons to look for.
   */
  protected function assertParagraphsButtons($count) {
    $this
      ->assertParagraphsButtonsHelper($count, FALSE);
  }

  /**
   * Passes if the paragraphs buttons are NOT present.
   *
   * @param int $count
   *   Number of paragraphs buttons to look for.
   */
  protected function assertNoParagraphsButtons($count) {
    $this
      ->assertParagraphsButtonsHelper($count, TRUE);
  }

  /**
   * Helper for assertParagraphsButtons and assertNoParagraphsButtons.
   *
   * @param int $count
   *   Number of paragraphs buttons to look for.
   * @param bool $hidden
   *   TRUE if these buttons should not be shown, FALSE otherwise.
   *   Defaults to TRUE.
   */
  protected function assertParagraphsButtonsHelper($count, $hidden = TRUE) {
    for ($i = 0; $i < $count; $i++) {
      $remove_button = $this
        ->xpath('//*[@name="field_paragraphs_demo_' . $i . '_remove"]');
      if (!$hidden) {
        $this
          ->assertNotEquals(count($remove_button), 0);
      }
      else {
        $this
          ->assertEquals(count($remove_button), 0);
      }
    }

    // It is enough to check for the specific paragraph type 'Images' to assert
    // the add more buttons presence for this test class.
    $add_button = $this
      ->xpath('//input[@value="Add images"]');
    if (!$hidden) {
      $this
        ->assertNotEquals(count($add_button), 0);
    }
    else {
      $this
        ->assertEquals(count($add_button), 0);
    }
  }

  /**
   * Assert each paragraph items have the same langcode as the node one.
   *
   * @param string $node_id
   *   The node ID which contains the paragraph items to be checked.
   * @param string $source_lang
   *   The expected node source langcode. Defaults to 'en'.
   * @param string $trans_lang
   *   The expected translated node langcode. Defaults to NULL.
   */
  protected function assertParagraphsLangcode($node_id, $source_lang = 'en', $trans_lang = NULL) {

    // Update the outdated node and check all the paragraph items langcodes.
    \Drupal::entityTypeManager()
      ->getStorage('node')
      ->resetCache([
      $node_id,
    ]);

    /** @var \Drupal\node\NodeInterface $node */
    $node = Node::load($node_id);
    $node_langcode = $node->langcode->value;
    $this
      ->assertEquals($node_langcode, $source_lang, 'Host langcode matches.');

    /** @var \Drupal\Core\Entity\ContentEntityBase $paragraph */
    foreach ($node->field_paragraphs_demo
      ->referencedEntities() as $paragraph) {
      $paragraph_langcode = $paragraph
        ->language()
        ->getId();
      $message = new FormattableMarkup('Node langcode is "@node", paragraph item langcode is "@item".', [
        '@node' => $source_lang,
        '@item' => $paragraph_langcode,
      ]);
      $this
        ->assertEquals($paragraph_langcode, $source_lang, $message);
    }

    // Check the translation.
    if (!empty($trans_lang)) {
      $this
        ->assertTrue($node
        ->hasTranslation($trans_lang), 'Translation exists.');
    }
    if ($node
      ->hasTranslation($trans_lang)) {
      $trans_node = $node
        ->getTranslation($trans_lang);
      $trans_node_langcode = $trans_node
        ->language()
        ->getId();
      $this
        ->assertEquals($trans_node_langcode, $trans_lang, 'Translated node langcode matches.');

      // Check the paragraph item langcode matching the translated node langcode.
      foreach ($trans_node->field_paragraphs_demo
        ->referencedEntities() as $paragraph) {
        if ($paragraph
          ->hasTranslation($trans_lang)) {
          $trans_item = $paragraph
            ->getTranslation($trans_lang);
          $paragraph_langcode = $trans_item
            ->language()
            ->getId();
          $message = new FormattableMarkup('Translated node langcode is "@node", paragraph item langcode is "@item".', [
            '@node' => $trans_lang,
            '@item' => $paragraph_langcode,
          ]);
          $this
            ->assertEquals($paragraph_langcode, $trans_lang, $message);
        }
      }
    }
  }

}

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::$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. 1
ParagraphsTestBase::setAddMode protected function Sets the Paragraphs widget add mode. 1
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.
ParagraphsTranslationTest::$admin_user protected property A user with admin permissions. Overrides ParagraphsTestBase::$admin_user
ParagraphsTranslationTest::$modules public static property Modules to enable. Overrides ParagraphsTestBase::$modules
ParagraphsTranslationTest::assertNoParagraphsButtons protected function Passes if the paragraphs buttons are NOT present.
ParagraphsTranslationTest::assertParagraphsButtons protected function Passes if the paragraphs buttons are present.
ParagraphsTranslationTest::assertParagraphsButtonsHelper protected function Helper for assertParagraphsButtons and assertNoParagraphsButtons.
ParagraphsTranslationTest::assertParagraphsLangcode protected function Assert each paragraph items have the same langcode as the node one.
ParagraphsTranslationTest::setUp protected function Overrides ParagraphsTestBase::setUp
ParagraphsTranslationTest::testParagraphsMultilingualWorkflow public function Tests the paragraphs buttons presence in multilingual workflow.
ParagraphsTranslationTest::testParagraphTranslation public function Tests the paragraph translation.
ParagraphsTranslationTest::testParagraphTranslationMultilingual public function Tests the paragraph buttons presence in translation multilingual workflow.
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.
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.