You are here

class NodeTranslationUITest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/node/tests/src/Functional/NodeTranslationUITest.php \Drupal\Tests\node\Functional\NodeTranslationUITest
  2. 10 core/modules/node/tests/src/Functional/NodeTranslationUITest.php \Drupal\Tests\node\Functional\NodeTranslationUITest

Tests the Node Translation UI.

@group node

Hierarchy

Expanded class hierarchy of NodeTranslationUITest

File

core/modules/node/tests/src/Functional/NodeTranslationUITest.php, line 19

Namespace

Drupal\Tests\node\Functional
View source
class NodeTranslationUITest extends ContentTranslationUITestBase {

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

  /**
   * {inheritdoc}
   */
  protected $defaultCacheContexts = [
    'languages:language_interface',
    'theme',
    'route',
    'timezone',
    'url.path.parent',
    'url.query_args:_wrapper_format',
    'url.site',
    'user.roles',
    'url.path.is_front',
    // These two cache contexts are added by BigPipe.
    'cookies:big_pipe_nojs',
    'session.exists',
  ];

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'block',
    'language',
    'content_translation',
    'node',
    'datetime',
    'field_ui',
    'help',
  ];

  /**
   * The profile to install as a basis for testing.
   *
   * @var string
   */
  protected $profile = 'standard';
  protected function setUp() {
    $this->entityTypeId = 'node';
    $this->bundle = 'article';
    parent::setUp();

    // Ensure the help message is shown even with prefixed paths.
    $this
      ->drupalPlaceBlock('help_block', [
      'region' => 'content',
    ]);

    // Display the language selector.
    $this
      ->drupalLogin($this->administrator);
    $edit = [
      'language_configuration[language_alterable]' => TRUE,
    ];
    $this
      ->drupalPostForm('admin/structure/types/manage/article', $edit, t('Save content type'));
    $this
      ->drupalLogin($this->translator);
  }

  /**
   * Tests the basic translation UI.
   */
  public function testTranslationUI() {
    parent::testTranslationUI();
    $this
      ->doUninstallTest();
  }

  /**
   * Tests changing the published status on a node without fields.
   */
  public function testPublishedStatusNoFields() {

    // Test changing the published status of an article without fields.
    $this
      ->drupalLogin($this->administrator);

    // Delete all fields.
    $this
      ->drupalGet('admin/structure/types/manage/article/fields');
    $this
      ->drupalPostForm('admin/structure/types/manage/article/fields/node.article.' . $this->fieldName . '/delete', [], t('Delete'));
    $this
      ->drupalPostForm('admin/structure/types/manage/article/fields/node.article.field_tags/delete', [], t('Delete'));
    $this
      ->drupalPostForm('admin/structure/types/manage/article/fields/node.article.field_image/delete', [], t('Delete'));

    // Add a node.
    $default_langcode = $this->langcodes[0];
    $values[$default_langcode] = [
      'title' => [
        [
          'value' => $this
            ->randomMachineName(),
        ],
      ],
    ];
    $this->entityId = $this
      ->createEntity($values[$default_langcode], $default_langcode);
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityTypeId);
    $storage
      ->resetCache([
      $this->entityId,
    ]);
    $entity = $storage
      ->load($this->entityId);

    // Add a content translation.
    $langcode = 'fr';
    $language = ConfigurableLanguage::load($langcode);
    $values[$langcode] = [
      'title' => [
        [
          'value' => $this
            ->randomMachineName(),
        ],
      ],
    ];
    $entity_type_id = $entity
      ->getEntityTypeId();
    $add_url = Url::fromRoute("entity.{$entity_type_id}.content_translation_add", [
      $entity
        ->getEntityTypeId() => $entity
        ->id(),
      'source' => $default_langcode,
      'target' => $langcode,
    ], [
      'language' => $language,
    ]);
    $edit = $this
      ->getEditValues($values, $langcode);
    $edit['status[value]'] = FALSE;
    $this
      ->drupalPostForm($add_url, $edit, t('Save (this translation)'));
    $storage
      ->resetCache([
      $this->entityId,
    ]);
    $entity = $storage
      ->load($this->entityId);
    $translation = $entity
      ->getTranslation($langcode);

    // Make sure we unpublished the node correctly.
    $this
      ->assertFalse($this->manager
      ->getTranslationMetadata($translation)
      ->isPublished(), 'The translation has been correctly unpublished.');
  }

  /**
   * {@inheritdoc}
   */
  protected function getTranslatorPermissions() {
    return array_merge(parent::getTranslatorPermissions(), [
      'administer nodes',
      "edit any {$this->bundle} content",
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditorPermissions() {
    return [
      'administer nodes',
      'create article content',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getAdministratorPermissions() {
    return array_merge(parent::getAdministratorPermissions(), [
      'access administration pages',
      'administer content types',
      'administer node fields',
      'access content overview',
      'bypass node access',
      'administer languages',
      'administer themes',
      'view the administration theme',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getNewEntityValues($langcode) {
    return [
      'title' => [
        [
          'value' => $this
            ->randomMachineName(),
        ],
      ],
    ] + parent::getNewEntityValues($langcode);
  }

  /**
   * {@inheritdoc}
   */
  protected function doTestPublishedStatus() {
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityTypeId);
    $storage
      ->resetCache([
      $this->entityId,
    ]);
    $entity = $storage
      ->load($this->entityId);
    $languages = $this->container
      ->get('language_manager')
      ->getLanguages();
    $statuses = [
      TRUE,
      FALSE,
    ];
    foreach ($statuses as $index => $value) {

      // (Un)publish the node translations and check that the translation
      // statuses are (un)published accordingly.
      foreach ($this->langcodes as $langcode) {
        $options = [
          'language' => $languages[$langcode],
        ];
        $url = $entity
          ->toUrl('edit-form', $options);
        $this
          ->drupalPostForm($url, [
          'status[value]' => $value,
        ], t('Save') . $this
          ->getFormSubmitSuffix($entity, $langcode), $options);
      }
      $storage
        ->resetCache([
        $this->entityId,
      ]);
      $entity = $storage
        ->load($this->entityId);
      foreach ($this->langcodes as $langcode) {

        // The node is created as unpublished thus we switch to the published
        // status first.
        $status = !$index;
        $translation = $entity
          ->getTranslation($langcode);
        $this
          ->assertEqual($status, $this->manager
          ->getTranslationMetadata($translation)
          ->isPublished(), 'The translation has been correctly unpublished.');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function doTestAuthoringInfo() {
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityTypeId);
    $storage
      ->resetCache([
      $this->entityId,
    ]);
    $entity = $storage
      ->load($this->entityId);
    $languages = $this->container
      ->get('language_manager')
      ->getLanguages();
    $values = [];

    // Post different base field information for each translation.
    foreach ($this->langcodes as $langcode) {
      $user = $this
        ->drupalCreateUser();
      $values[$langcode] = [
        'uid' => $user
          ->id(),
        'created' => REQUEST_TIME - mt_rand(0, 1000),
        'sticky' => (bool) mt_rand(0, 1),
        'promote' => (bool) mt_rand(0, 1),
      ];

      /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
      $date_formatter = $this->container
        ->get('date.formatter');
      $edit = [
        'uid[0][target_id]' => $user
          ->getAccountName(),
        'created[0][value][date]' => $date_formatter
          ->format($values[$langcode]['created'], 'custom', 'Y-m-d'),
        'created[0][value][time]' => $date_formatter
          ->format($values[$langcode]['created'], 'custom', 'H:i:s'),
        'sticky[value]' => $values[$langcode]['sticky'],
        'promote[value]' => $values[$langcode]['promote'],
      ];
      $options = [
        'language' => $languages[$langcode],
      ];
      $url = $entity
        ->toUrl('edit-form', $options);
      $this
        ->drupalPostForm($url, $edit, $this
        ->getFormSubmitAction($entity, $langcode), $options);
    }
    $storage
      ->resetCache([
      $this->entityId,
    ]);
    $entity = $storage
      ->load($this->entityId);
    foreach ($this->langcodes as $langcode) {
      $translation = $entity
        ->getTranslation($langcode);
      $metadata = $this->manager
        ->getTranslationMetadata($translation);
      $this
        ->assertEqual($metadata
        ->getAuthor()
        ->id(), $values[$langcode]['uid'], 'Translation author correctly stored.');
      $this
        ->assertEqual($metadata
        ->getCreatedTime(), $values[$langcode]['created'], 'Translation date correctly stored.');
      $this
        ->assertEqual($translation
        ->isSticky(), $values[$langcode]['sticky'], 'Sticky of Translation correctly stored.');
      $this
        ->assertEqual($translation
        ->isPromoted(), $values[$langcode]['promote'], 'Promoted of Translation correctly stored.');
    }
  }

  /**
   * Tests that translation page inherits admin status of edit page.
   */
  public function testTranslationLinkTheme() {
    $this
      ->drupalLogin($this->administrator);
    $article = $this
      ->drupalCreateNode([
      'type' => 'article',
      'langcode' => $this->langcodes[0],
    ]);

    // Set up Seven as the admin theme and use it for node editing.
    $this->container
      ->get('theme_installer')
      ->install([
      'seven',
    ]);
    $edit = [];
    $edit['admin_theme'] = 'seven';
    $edit['use_admin_theme'] = TRUE;
    $this
      ->drupalPostForm('admin/appearance', $edit, t('Save configuration'));
    $this
      ->drupalGet('node/' . $article
      ->id() . '/translations');
    $this
      ->assertRaw('core/themes/seven/css/base/elements.css', 'Translation uses admin theme if edit is admin.');

    // Turn off admin theme for editing, assert inheritance to translations.
    $edit['use_admin_theme'] = FALSE;
    $this
      ->drupalPostForm('admin/appearance', $edit, t('Save configuration'));
    $this
      ->drupalGet('node/' . $article
      ->id() . '/translations');
    $this
      ->assertNoRaw('core/themes/seven/css/base/elements.css', 'Translation uses frontend theme if edit is frontend.');

    // Assert presence of translation page itself (vs. DisabledBundle below).
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Tests that no metadata is stored for a disabled bundle.
   */
  public function testDisabledBundle() {

    // Create a bundle that does not have translation enabled.
    $disabledBundle = $this
      ->randomMachineName();
    $this
      ->drupalCreateContentType([
      'type' => $disabledBundle,
      'name' => $disabledBundle,
    ]);

    // Create a node for each bundle.
    $node = $this
      ->drupalCreateNode([
      'type' => $this->bundle,
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ]);

    // Make sure that nothing was inserted into the {content_translation} table.
    $rows = Database::getConnection()
      ->query('SELECT nid, count(nid) AS count FROM {node_field_data} WHERE type <> :type GROUP BY nid HAVING count(nid) >= 2', [
      ':type' => $this->bundle,
    ])
      ->fetchAll();
    $this
      ->assertCount(0, $rows);

    // Ensure the translation tab is not accessible.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/translations');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests that translations are rendered properly.
   */
  public function testTranslationRendering() {
    $default_langcode = $this->langcodes[0];
    $values[$default_langcode] = $this
      ->getNewEntityValues($default_langcode);
    $this->entityId = $this
      ->createEntity($values[$default_langcode], $default_langcode);
    $node = \Drupal::entityTypeManager()
      ->getStorage($this->entityTypeId)
      ->load($this->entityId);
    $node
      ->setPromoted(TRUE);

    // Create translations.
    foreach (array_diff($this->langcodes, [
      $default_langcode,
    ]) as $langcode) {
      $values[$langcode] = $this
        ->getNewEntityValues($langcode);
      $translation = $node
        ->addTranslation($langcode, $values[$langcode]);

      // Publish and promote the translation to frontpage.
      $translation
        ->setPromoted(TRUE);
      $translation
        ->setPublished();
    }
    $node
      ->save();

    // Test that the frontpage view displays the correct translations.
    \Drupal::service('module_installer')
      ->install([
      'views',
    ], TRUE);
    $this
      ->rebuildContainer();
    $this
      ->doTestTranslations('node', $values);

    // Enable the translation language renderer.
    $view = \Drupal::entityTypeManager()
      ->getStorage('view')
      ->load('frontpage');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['rendering_language'] = '***LANGUAGE_entity_translation***';
    $view
      ->save();

    // Need to check from the beginning, including the base_path, in the url
    // since the pattern for the default language might be a substring of
    // the strings for other languages.
    $base_path = base_path();

    // Check the frontpage for 'Read more' links to each translation.
    // See also assertTaxonomyPage() in NodeAccessBaseTableTest.
    $node_href = 'node/' . $node
      ->id();
    foreach ($this->langcodes as $langcode) {
      $this
        ->drupalGet('node', [
        'language' => \Drupal::languageManager()
          ->getLanguage($langcode),
      ]);
      $num_match_found = 0;
      if ($langcode == 'en') {

        // Site default language does not have langcode prefix in the URL.
        $expected_href = $base_path . $node_href;
      }
      else {
        $expected_href = $base_path . $langcode . '/' . $node_href;
      }
      $pattern = '|^' . $expected_href . '$|';
      foreach ($this
        ->xpath("//a[text()='Read more']") as $link) {
        if (preg_match($pattern, $link
          ->getAttribute('href'), $matches) == TRUE) {
          $num_match_found++;
        }
      }
      $this
        ->assertTrue($num_match_found == 1, 'There is 1 Read more link, ' . $expected_href . ', for the ' . $langcode . ' translation of a node on the frontpage. (Found ' . $num_match_found . '.)');
    }

    // Check the frontpage for 'Add new comment' links that include the
    // language.
    $comment_form_href = 'node/' . $node
      ->id() . '#comment-form';
    foreach ($this->langcodes as $langcode) {
      $this
        ->drupalGet('node', [
        'language' => \Drupal::languageManager()
          ->getLanguage($langcode),
      ]);
      $num_match_found = 0;
      if ($langcode == 'en') {

        // Site default language does not have langcode prefix in the URL.
        $expected_href = $base_path . $comment_form_href;
      }
      else {
        $expected_href = $base_path . $langcode . '/' . $comment_form_href;
      }
      $pattern = '|^' . $expected_href . '$|';
      foreach ($this
        ->xpath("//a[text()='Add new comment']") as $link) {
        if (preg_match($pattern, $link
          ->getAttribute('href'), $matches) == TRUE) {
          $num_match_found++;
        }
      }
      $this
        ->assertTrue($num_match_found == 1, 'There is 1 Add new comment link, ' . $expected_href . ', for the ' . $langcode . ' translation of a node on the frontpage. (Found ' . $num_match_found . '.)');
    }

    // Test that the node page displays the correct translations.
    $this
      ->doTestTranslations('node/' . $node
      ->id(), $values);

    // Test that the node page has the correct alternate hreflang links.
    $this
      ->doTestAlternateHreflangLinks($node);
  }

  /**
   * Tests that the given path displays the correct translation values.
   *
   * @param string $path
   *   The path to be tested.
   * @param array $values
   *   The translation values to be found.
   */
  protected function doTestTranslations($path, array $values) {
    $languages = $this->container
      ->get('language_manager')
      ->getLanguages();
    foreach ($this->langcodes as $langcode) {
      $this
        ->drupalGet($path, [
        'language' => $languages[$langcode],
      ]);
      $this
        ->assertText($values[$langcode]['title'][0]['value'], new FormattableMarkup('The %langcode node translation is correctly displayed.', [
        '%langcode' => $langcode,
      ]));
    }
  }

  /**
   * Tests that the given path provides the correct alternate hreflang links.
   *
   * @param \Drupal\node\Entity\Node $node
   *   The node to be tested.
   */
  protected function doTestAlternateHreflangLinks(Node $node) {
    $url = $node
      ->toUrl();
    $languages = $this->container
      ->get('language_manager')
      ->getLanguages();
    $url
      ->setAbsolute();
    $urls = [];
    $translations = [];
    foreach ($this->langcodes as $langcode) {
      $language_url = clone $url;
      $urls[$langcode] = $language_url
        ->setOption('language', $languages[$langcode]);
      $translations[$langcode] = $node
        ->getTranslation($langcode);
    }
    foreach ($this->langcodes as $langcode) {

      // Skip unpublished translations.
      if ($translations[$langcode]
        ->isPublished()) {
        $this
          ->drupalGet($urls[$langcode]);
        foreach ($urls as $alternate_langcode => $language_url) {

          // Retrieve desired link elements from the HTML head.
          $links = $this
            ->xpath('head/link[@rel = "alternate" and @href = :href and @hreflang = :hreflang]', [
            ':href' => $language_url
              ->toString(),
            ':hreflang' => $alternate_langcode,
          ]);
          if ($translations[$alternate_langcode]
            ->isPublished()) {
            $this
              ->assert(isset($links[0]), new FormattableMarkup('The %langcode node translation has the correct alternate hreflang link for %alternate_langcode: %link.', [
              '%langcode' => $langcode,
              '%alternate_langcode' => $alternate_langcode,
              '%link' => $url
                ->toString(),
            ]));
          }
          else {
            $this
              ->assertFalse(isset($links[0]), new FormattableMarkup('The %langcode node translation has an hreflang link for unpublished %alternate_langcode translation: %link.', [
              '%langcode' => $langcode,
              '%alternate_langcode' => $alternate_langcode,
              '%link' => $url
                ->toString(),
            ]));
          }
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getFormSubmitSuffix(EntityInterface $entity, $langcode) {
    if (!$entity
      ->isNew() && $entity
      ->isTranslatable()) {
      $translations = $entity
        ->getTranslationLanguages();
      if ((count($translations) > 1 || !isset($translations[$langcode])) && ($field = $entity
        ->getFieldDefinition('status'))) {
        return ' ' . ($field
          ->isTranslatable() ? t('(this translation)') : t('(all translations)'));
      }
    }
    return '';
  }

  /**
   * Tests uninstalling content_translation.
   */
  protected function doUninstallTest() {

    // Delete all the nodes so there is no data.
    $nodes = Node::loadMultiple();
    foreach ($nodes as $node) {
      $node
        ->delete();
    }
    $language_count = count(\Drupal::configFactory()
      ->listAll('language.content_settings.'));
    \Drupal::service('module_installer')
      ->uninstall([
      'content_translation',
    ]);
    $this
      ->rebuildContainer();
    $this
      ->assertEqual($language_count, count(\Drupal::configFactory()
      ->listAll('language.content_settings.')), 'Languages have been fixed rather than deleted during content_translation uninstall.');
  }

  /**
   * {@inheritdoc}
   */
  protected function doTestTranslationEdit() {
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage($this->entityTypeId);
    $storage
      ->resetCache([
      $this->entityId,
    ]);
    $entity = $storage
      ->load($this->entityId);
    $languages = $this->container
      ->get('language_manager')
      ->getLanguages();
    $type_name = node_get_type_label($entity);
    foreach ($this->langcodes as $langcode) {

      // We only want to test the title for non-english translations.
      if ($langcode != 'en') {
        $options = [
          'language' => $languages[$langcode],
        ];
        $url = $entity
          ->toUrl('edit-form', $options);
        $this
          ->drupalGet($url);
        $title = t('<em>Edit @type</em> @title [%language translation]', [
          '@type' => $type_name,
          '@title' => $entity
            ->getTranslation($langcode)
            ->label(),
          '%language' => $languages[$langcode]
            ->getName(),
        ]);
        $this
          ->assertRaw($title);
      }
    }
  }

  /**
   * Tests that revision translations are rendered properly.
   */
  public function testRevisionTranslationRendering() {
    $storage = \Drupal::entityTypeManager()
      ->getStorage('node');

    // Create a node.
    $nid = $this
      ->createEntity([
      'title' => 'First rev en title',
    ], 'en');
    $node = $storage
      ->load($nid);
    $original_revision_id = $node
      ->getRevisionId();

    // Add a French translation.
    $translation = $node
      ->addTranslation('fr');
    $translation->title = 'First rev fr title';
    $translation
      ->setNewRevision(FALSE);
    $translation
      ->save();

    // Create a new revision.
    $node->title = 'Second rev en title';
    $node
      ->setNewRevision(TRUE);
    $node
      ->save();

    // Get an English view of this revision.
    $original_revision = $storage
      ->loadRevision($original_revision_id);
    $original_revision_url = $original_revision
      ->toUrl('revision')
      ->toString();

    // Should be different from regular node URL.
    $this
      ->assertNotIdentical($original_revision_url, $original_revision
      ->toUrl()
      ->toString());
    $this
      ->drupalGet($original_revision_url);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Contents should be in English, of correct revision.
    $this
      ->assertText('First rev en title');
    $this
      ->assertNoText('First rev fr title');

    // Get a French view.
    $url_fr = $original_revision
      ->getTranslation('fr')
      ->toUrl('revision')
      ->toString();

    // Should have different URL from English.
    $this
      ->assertNotIdentical($url_fr, $original_revision
      ->toUrl()
      ->toString());
    $this
      ->assertNotIdentical($url_fr, $original_revision_url);
    $this
      ->drupalGet($url_fr);
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Contents should be in French, of correct revision.
    $this
      ->assertText('First rev fr title');
    $this
      ->assertNoText('First rev en title');
  }

  /**
   * Test that title is not escaped (but XSS-filtered) for details form element.
   */
  public function testDetailsTitleIsNotEscaped() {
    $this
      ->drupalLogin($this->administrator);

    // Make the image field a multi-value field in order to display a
    // details form element.
    $edit = [
      'cardinality_number' => 2,
    ];
    $this
      ->drupalPostForm('admin/structure/types/manage/article/fields/node.article.field_image/storage', $edit, t('Save field settings'));

    // Make the image field non-translatable.
    $edit = [
      'settings[node][article][fields][field_image]' => FALSE,
    ];
    $this
      ->drupalPostForm('admin/config/regional/content-language', $edit, t('Save configuration'));

    // Create a node.
    $nid = $this
      ->createEntity([
      'title' => 'Node with multi-value image field en title',
    ], 'en');

    // Add a French translation and assert the title markup is not escaped.
    $this
      ->drupalGet("node/{$nid}/translations/add/en/fr");
    $markup = 'Image <span class="translation-entity-all-languages">(all languages)</span>';
    $this
      ->assertSession()
      ->assertNoEscaped($markup);
    $this
      ->assertSession()
      ->responseContains($markup);
  }

}

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
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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::$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.
ContentTranslationTestBase::$administrator protected property The account to be used to test access to both workflows.
ContentTranslationTestBase::$bundle protected property The bundle being tested. 1
ContentTranslationTestBase::$controller protected property The translation controller for the current entity type.
ContentTranslationTestBase::$editor protected property The account to be used to test multilingual entity editing.
ContentTranslationTestBase::$entityTypeId protected property The entity type being tested. 1
ContentTranslationTestBase::$fieldName protected property The name of the field used to test translation.
ContentTranslationTestBase::$langcodes protected property The added languages.
ContentTranslationTestBase::$manager protected property
ContentTranslationTestBase::$translator protected property The account to be used to test translation operations.
ContentTranslationTestBase::createEntity protected function Creates the entity to be translated. 3
ContentTranslationTestBase::enableTranslation protected function Enables translation for the current entity type and bundle.
ContentTranslationTestBase::getEditUrl protected function Returns the edit URL for the specified entity. 1
ContentTranslationTestBase::getTranslatePermission protected function Returns the translate permissions for the current entity and bundle.
ContentTranslationTestBase::setupBundle protected function Creates or initializes the bundle date if needed. 5
ContentTranslationTestBase::setupLanguages protected function Adds additional languages.
ContentTranslationTestBase::setupTestFields protected function Creates the test fields. 2
ContentTranslationTestBase::setupUsers protected function Creates and activates translator, editor and admin users.
ContentTranslationUITestBase::$entityId protected property The id of the entity being translated.
ContentTranslationUITestBase::$testHTMLEscapeForAllLanguages protected property Flag to determine if "all languages" rendering is tested. 1
ContentTranslationUITestBase::$testLanguageSelector protected property Whether the behavior of the language selector should be tested.
ContentTranslationUITestBase::doTestBasicTranslation protected function Tests the basic translation workflow. 2
ContentTranslationUITestBase::doTestChangedTimeAfterSaveWithoutChanges public function Test the changed time after API and FORM save without changes.
ContentTranslationUITestBase::doTestOutdatedStatus protected function Tests up-to-date status tracking.
ContentTranslationUITestBase::doTestTranslationChanged protected function Tests the basic translation workflow. 1
ContentTranslationUITestBase::doTestTranslationDeletion protected function Tests translation deletion.
ContentTranslationUITestBase::doTestTranslationOverview protected function Tests that the translation overview shows the correct values.
ContentTranslationUITestBase::getChangedFieldName protected function Returns the name of the field that implements the changed timestamp.
ContentTranslationUITestBase::getEditValues protected function Returns an edit array containing the values to be posted. 2
ContentTranslationUITestBase::getFormSubmitAction protected function Returns the form action value to be used to submit the entity form.
ContentTranslationUITestBase::getFormSubmitActionForNewTranslation protected function Returns the form action value when submitting a new translation.
ContentTranslationUITestBase::getTranslation protected function Returns the translation object to use to retrieve the translated values.
ContentTranslationUITestBase::getValue protected function Returns the value for the specified property in the given language.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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
NodeTranslationUITest::$defaultCacheContexts protected property {inheritdoc} Overrides ContentTranslationUITestBase::$defaultCacheContexts
NodeTranslationUITest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NodeTranslationUITest::$modules public static property Modules to enable. Overrides ContentTranslationTestBase::$modules
NodeTranslationUITest::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
NodeTranslationUITest::doTestAlternateHreflangLinks protected function Tests that the given path provides the correct alternate hreflang links.
NodeTranslationUITest::doTestAuthoringInfo protected function Tests the translation authoring information. Overrides ContentTranslationUITestBase::doTestAuthoringInfo
NodeTranslationUITest::doTestPublishedStatus protected function Tests the translation publishing status. Overrides ContentTranslationUITestBase::doTestPublishedStatus
NodeTranslationUITest::doTestTranslationEdit protected function Tests edit content translation. Overrides ContentTranslationUITestBase::doTestTranslationEdit
NodeTranslationUITest::doTestTranslations protected function Tests that the given path displays the correct translation values.
NodeTranslationUITest::doUninstallTest protected function Tests uninstalling content_translation.
NodeTranslationUITest::getAdministratorPermissions protected function Returns an array of permissions needed for the administrator. Overrides ContentTranslationTestBase::getAdministratorPermissions
NodeTranslationUITest::getEditorPermissions protected function Returns an array of permissions needed for the editor. Overrides ContentTranslationTestBase::getEditorPermissions
NodeTranslationUITest::getFormSubmitSuffix protected function Returns appropriate submit button suffix based on translatability. Overrides ContentTranslationUITestBase::getFormSubmitSuffix
NodeTranslationUITest::getNewEntityValues protected function Returns an array of entity field values to be tested. Overrides ContentTranslationUITestBase::getNewEntityValues
NodeTranslationUITest::getTranslatorPermissions protected function Returns an array of permissions needed for the translator. Overrides ContentTranslationTestBase::getTranslatorPermissions
NodeTranslationUITest::setUp protected function Overrides ContentTranslationTestBase::setUp
NodeTranslationUITest::testDetailsTitleIsNotEscaped public function Test that title is not escaped (but XSS-filtered) for details form element.
NodeTranslationUITest::testDisabledBundle public function Tests that no metadata is stored for a disabled bundle.
NodeTranslationUITest::testPublishedStatusNoFields public function Tests changing the published status on a node without fields.
NodeTranslationUITest::testRevisionTranslationRendering public function Tests that revision translations are rendered properly.
NodeTranslationUITest::testTranslationLinkTheme public function Tests that translation page inherits admin status of edit page.
NodeTranslationUITest::testTranslationRendering public function Tests that translations are rendered properly.
NodeTranslationUITest::testTranslationUI public function Tests the basic translation UI. Overrides ContentTranslationUITestBase::testTranslationUI
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.