class ConfigTranslationUiTest

Same name in this branch
  1. 9 core/modules/config_translation/tests/src/FunctionalJavascript/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\FunctionalJavascript\ConfigTranslationUiTest
Same name in other branches
  1. 8.9.x core/modules/config_translation/tests/src/FunctionalJavascript/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\FunctionalJavascript\ConfigTranslationUiTest
  2. 8.9.x core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\Functional\ConfigTranslationUiTest
  3. 10 core/modules/config_translation/tests/src/FunctionalJavascript/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\FunctionalJavascript\ConfigTranslationUiTest
  4. 10 core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\Functional\ConfigTranslationUiTest
  5. 11.x core/modules/config_translation/tests/src/FunctionalJavascript/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\FunctionalJavascript\ConfigTranslationUiTest
  6. 11.x core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php \Drupal\Tests\config_translation\Functional\ConfigTranslationUiTest

Translate settings and entities to various languages.

@group config_translation

Hierarchy

Expanded class hierarchy of ConfigTranslationUiTest

File

core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php, line 23

Namespace

Drupal\Tests\config_translation\Functional
View source
class ConfigTranslationUiTest extends BrowserTestBase {
    use AssertMailTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'block',
        'config_translation',
        'config_translation_test',
        'contact',
        'contact_test',
        'contextual',
        'entity_test',
        'field_test',
        'field_ui',
        'filter',
        'filter_test',
        'node',
        'views',
        'views_ui',
        'menu_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Languages to enable.
     *
     * @var array
     */
    protected $langcodes = [
        'fr',
        'ta',
        'tyv',
    ];
    
    /**
     * Administrator user for tests.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * Translator user for tests.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $translatorUser;
    
    /**
     * String translation storage object.
     *
     * @var \Drupal\locale\StringStorageInterface
     */
    protected $localeStorage;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $translator_permissions = [
            'translate configuration',
        ];
        
        /** @var \Drupal\filter\FilterFormatInterface $filter_test_format */
        $filter_test_format = FilterFormat::load('filter_test');
        
        /** @var \Drupal\filter\FilterFormatInterface $filtered_html_format */
        $filtered_html_format = FilterFormat::load('filtered_html');
        
        /** @var \Drupal\filter\FilterFormatInterface $full_html_format */
        $full_html_format = FilterFormat::load('full_html');
        $admin_permissions = array_merge($translator_permissions, [
            'administer languages',
            'administer site configuration',
            'link to any page',
            'administer contact forms',
            'administer filters',
            $filtered_html_format->getPermissionName(),
            $full_html_format->getPermissionName(),
            $filter_test_format->getPermissionName(),
            'access site-wide contact form',
            'access contextual links',
            'administer views',
            'administer account settings',
            'administer themes',
            'bypass node access',
            'administer content types',
            'translate interface',
        ]);
        // Create and log in user.
        $this->translatorUser = $this->drupalCreateUser($translator_permissions);
        $this->adminUser = $this->drupalCreateUser($admin_permissions);
        // Add languages.
        foreach ($this->langcodes as $langcode) {
            ConfigurableLanguage::createFromLangcode($langcode)->save();
        }
        $this->localeStorage = $this->container
            ->get('locale.storage');
        $this->drupalPlaceBlock('local_tasks_block');
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests the site information translation interface.
     */
    public function testSiteInformationTranslationUi() {
        $this->drupalLogin($this->adminUser);
        $site_name = 'Name of the site for testing configuration translation';
        $site_slogan = 'Site slogan for testing configuration translation';
        $site_name_label = 'Site name';
        $fr_site_name = 'Nom du site pour tester la configuration traduction';
        $fr_site_slogan = 'Slogan du site pour tester la traduction de configuration';
        $fr_site_name_label = 'Libellé du champ "Nom du site"';
        $translation_base_url = 'admin/config/system/site-information/translate';
        // Set site name and slogan for default language.
        $this->setSiteInformation($site_name, $site_slogan);
        $this->drupalGet('admin/config/system/site-information');
        // Check translation tab exist.
        $this->assertSession()
            ->linkByHrefExists($translation_base_url);
        $this->drupalGet($translation_base_url);
        // Check that the 'Edit' link in the source language links back to the
        // original form.
        $this->clickLink('Edit');
        // Also check that saving the form leads back to the translation overview.
        $this->submitForm([], 'Save configuration');
        $this->assertSession()
            ->addressEquals($translation_base_url);
        // Check 'Add' link of French to visit add page.
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/add");
        $this->clickLink('Add');
        // Make sure original text is present on this page.
        $this->assertSession()
            ->pageTextContains($site_name);
        $this->assertSession()
            ->pageTextContains($site_slogan);
        // Update site name and slogan for French.
        $edit = [
            'translation[config_names][system.site][name]' => $fr_site_name,
            'translation[config_names][system.site][slogan]' => $fr_site_slogan,
        ];
        $this->drupalGet("{$translation_base_url}/fr/add");
        $this->submitForm($edit, 'Save translation');
        $this->assertSession()
            ->pageTextContains('Successfully saved French translation.');
        // Check for edit, delete links (and no 'add' link) for French language.
        $this->assertSession()
            ->linkByHrefNotExists("{$translation_base_url}/fr/add");
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/delete");
        // Check translation saved proper.
        $this->drupalGet("{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][system.site][name]', $fr_site_name);
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][system.site][slogan]', $fr_site_slogan);
        // Place branding block with site name and slogan into header region.
        $this->drupalPlaceBlock('system_branding_block', [
            'region' => 'header',
        ]);
        // Check French translation of site name and slogan are in place.
        $this->drupalGet('fr');
        $this->assertSession()
            ->pageTextContains($fr_site_name);
        $this->assertSession()
            ->pageTextContains($fr_site_slogan);
        // Visit French site to ensure base language string present as source.
        $this->drupalGet("fr/{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->pageTextContains($site_name);
        $this->assertSession()
            ->pageTextContains($site_slogan);
        // Translate 'Site name' label in French.
        $search = [
            'string' => $site_name_label,
            'langcode' => 'fr',
            'translation' => 'untranslated',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $textarea = $this->assertSession()
            ->elementExists('xpath', '//textarea');
        $lid = $textarea->getAttribute('name');
        $edit = [
            $lid => $fr_site_name_label,
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($edit, 'Save translations');
        // Ensure that the label is in French (and not in English).
        $this->drupalGet("fr/{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->pageTextContains($fr_site_name_label);
        $this->assertSession()
            ->pageTextNotContains($site_name_label);
        // Ensure that the label is also in French (and not in English)
        // when editing another language with the interface in French.
        $this->drupalGet("fr/{$translation_base_url}/ta/edit");
        $this->assertSession()
            ->pageTextContains($fr_site_name_label);
        $this->assertSession()
            ->pageTextNotContains($site_name_label);
        // Ensure that the label is not translated when the interface is in English.
        $this->drupalGet("{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->pageTextContains($site_name_label);
        $this->assertSession()
            ->pageTextNotContains($fr_site_name_label);
    }
    
    /**
     * Tests the site information translation interface.
     */
    public function testSourceValueDuplicateSave() {
        $this->drupalLogin($this->adminUser);
        $site_name = 'Site name for testing configuration translation';
        $site_slogan = 'Site slogan for testing configuration translation';
        $translation_base_url = 'admin/config/system/site-information/translate';
        $this->setSiteInformation($site_name, $site_slogan);
        $this->drupalGet($translation_base_url);
        // Case 1: Update new value for site slogan and site name.
        $edit = [
            'translation[config_names][system.site][name]' => 'FR ' . $site_name,
            'translation[config_names][system.site][slogan]' => 'FR ' . $site_slogan,
        ];
        // First time, no overrides, so just Add link.
        $this->drupalGet("{$translation_base_url}/fr/add");
        $this->submitForm($edit, 'Save translation');
        // Read overridden file from active config.
        $override = \Drupal::languageManager()->getLanguageConfigOverride('fr', 'system.site');
        // Expect both name and slogan in language specific file.
        $expected = [
            'name' => 'FR ' . $site_name,
            'slogan' => 'FR ' . $site_slogan,
        ];
        $this->assertEquals($expected, $override->get());
        // Case 2: Update new value for site slogan and default value for site name.
        $this->drupalGet("{$translation_base_url}/fr/edit");
        // Assert that the language configuration does not leak outside of the
        // translation form into the actual site name and slogan.
        $this->assertSession()
            ->pageTextNotContains('FR ' . $site_name);
        $this->assertSession()
            ->pageTextNotContains('FR ' . $site_slogan);
        $edit = [
            'translation[config_names][system.site][name]' => $site_name,
            'translation[config_names][system.site][slogan]' => 'FR ' . $site_slogan,
        ];
        $this->submitForm($edit, 'Save translation');
        $this->assertSession()
            ->pageTextContains('Successfully updated French translation.');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('fr', 'system.site');
        // Expect only slogan in language specific file.
        $expected = 'FR ' . $site_slogan;
        $this->assertEquals($expected, $override->get('slogan'));
        // Case 3: Keep default value for site name and slogan.
        $this->drupalGet("{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->pageTextNotContains('FR ' . $site_slogan);
        $edit = [
            'translation[config_names][system.site][name]' => $site_name,
            'translation[config_names][system.site][slogan]' => $site_slogan,
        ];
        $this->submitForm($edit, 'Save translation');
        $override = \Drupal::languageManager()->getLanguageConfigOverride('fr', 'system.site');
        // Expect no language specific file.
        $this->assertTrue($override->isNew());
        // Check configuration page with translator user. Should have no access.
        $this->drupalLogout();
        $this->drupalLogin($this->translatorUser);
        $this->drupalGet('admin/config/system/site-information');
        $this->assertSession()
            ->statusCodeEquals(403);
        // While translator can access the translation page, the edit link is not
        // present due to lack of permissions.
        $this->drupalGet($translation_base_url);
        $this->assertSession()
            ->linkNotExists('Edit');
        // Check 'Add' link for French.
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/add");
    }
    
    /**
     * Tests the contact form translation.
     */
    public function testContactConfigEntityTranslation() {
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/structure/contact');
        // Check for default contact form configuration entity from Contact module.
        $this->assertSession()
            ->linkByHrefExists('admin/structure/contact/manage/feedback');
        // Save default language configuration.
        $label = 'Send your feedback';
        $edit = [
            'label' => $label,
            'recipients' => 'sales@example.com,support@example.com',
            'reply' => 'Thank you for your mail',
        ];
        $this->drupalGet('admin/structure/contact/manage/feedback');
        $this->submitForm($edit, 'Save');
        // Ensure translation link is present.
        $translation_base_url = 'admin/structure/contact/manage/feedback/translate';
        $this->assertSession()
            ->linkByHrefExists($translation_base_url);
        // Make sure translate tab is present.
        $this->drupalGet('admin/structure/contact/manage/feedback');
        $this->assertSession()
            ->linkExists('Translate contact form');
        // Visit the form to confirm the changes.
        $this->drupalGet('contact/feedback');
        $this->assertSession()
            ->pageTextContains($label);
        foreach ($this->langcodes as $langcode) {
            $this->drupalGet($translation_base_url);
            $this->assertSession()
                ->linkExists('Translate contact form');
            // 'Add' link should be present for $langcode translation.
            $translation_page_url = "{$translation_base_url}/{$langcode}/add";
            $this->assertSession()
                ->linkByHrefExists($translation_page_url);
            // Make sure original text is present on this page.
            $this->drupalGet($translation_page_url);
            $this->assertSession()
                ->pageTextContains($label);
            // Update translatable fields.
            $edit = [
                'translation[config_names][contact.form.feedback][label]' => 'Website feedback - ' . $langcode,
                'translation[config_names][contact.form.feedback][reply]' => 'Thank you for your mail - ' . $langcode,
            ];
            // Save language specific version of form.
            $this->drupalGet($translation_page_url);
            $this->submitForm($edit, 'Save translation');
            // Expect translated values in language specific file.
            $override = \Drupal::languageManager()->getLanguageConfigOverride($langcode, 'contact.form.feedback');
            $expected = [
                'label' => 'Website feedback - ' . $langcode,
                'reply' => 'Thank you for your mail - ' . $langcode,
            ];
            $this->assertEquals($expected, $override->get());
            // Check for edit, delete links (and no 'add' link) for $langcode.
            $this->assertSession()
                ->linkByHrefNotExists("{$translation_base_url}/{$langcode}/add");
            $this->assertSession()
                ->linkByHrefExists("{$translation_base_url}/{$langcode}/edit");
            $this->assertSession()
                ->linkByHrefExists("{$translation_base_url}/{$langcode}/delete");
            // Visit language specific version of form to check label.
            $this->drupalGet($langcode . '/contact/feedback');
            $this->assertSession()
                ->pageTextContains('Website feedback - ' . $langcode);
            // Submit feedback.
            $edit = [
                'subject[0][value]' => 'Test subject',
                'message[0][value]' => 'Test message',
            ];
            $this->submitForm($edit, 'Send message');
        }
        // Now that all language translations are present, check translation and
        // original text all appear in any translated page on the translation
        // forms.
        foreach ($this->langcodes as $langcode) {
            $langcode_prefixes = array_merge([
                '',
            ], $this->langcodes);
            foreach ($langcode_prefixes as $langcode_prefix) {
                $this->drupalGet(ltrim("{$langcode_prefix}/{$translation_base_url}/{$langcode}/edit", '/'));
                $this->assertSession()
                    ->fieldValueEquals('translation[config_names][contact.form.feedback][label]', 'Website feedback - ' . $langcode);
                $this->assertSession()
                    ->pageTextContains($label);
            }
        }
        // We get all emails so no need to check inside the loop.
        $captured_emails = $this->getMails();
        // Check language specific auto reply text in email body.
        foreach ($captured_emails as $email) {
            if ($email['id'] == 'contact_page_autoreply') {
                // Trim because we get an added newline for the body.
                $this->assertEquals('Thank you for your mail - ' . $email['langcode'], trim($email['body']));
            }
        }
        // Test that delete links work and operations perform properly.
        foreach ($this->langcodes as $langcode) {
            $language = \Drupal::languageManager()->getLanguage($langcode)
                ->getName();
            $this->drupalGet("{$translation_base_url}/{$langcode}/delete");
            $this->assertSession()
                ->pageTextContains("Are you sure you want to delete the {$language} translation of {$label} contact form?");
            // Assert link back to list page to cancel delete is present.
            $this->assertSession()
                ->linkByHrefExists($translation_base_url);
            $this->submitForm([], 'Delete');
            $this->assertSession()
                ->pageTextContains("{$language} translation of {$label} contact form was deleted");
            $this->assertSession()
                ->linkByHrefExists("{$translation_base_url}/{$langcode}/add");
            $this->assertSession()
                ->linkByHrefNotExists("translation_base_url/{$langcode}/edit");
            $this->assertSession()
                ->linkByHrefNotExists("{$translation_base_url}/{$langcode}/delete");
            // Expect no language specific file present anymore.
            $override = \Drupal::languageManager()->getLanguageConfigOverride($langcode, 'contact.form.feedback');
            $this->assertTrue($override->isNew());
        }
        // Check configuration page with translator user. Should have no access.
        $this->drupalLogout();
        $this->drupalLogin($this->translatorUser);
        $this->drupalGet('admin/structure/contact/manage/feedback');
        $this->assertSession()
            ->statusCodeEquals(403);
        // While translator can access the translation page, the edit link is not
        // present due to lack of permissions.
        $this->drupalGet($translation_base_url);
        $this->assertSession()
            ->linkNotExists('Edit');
        // Check 'Add' link for French.
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/add");
    }
    
    /**
     * Tests date format translation.
     */
    public function testDateFormatTranslation() {
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/config/regional/date-time');
        // Check for medium format.
        $this->assertSession()
            ->linkByHrefExists('admin/config/regional/date-time/formats/manage/medium');
        // Save default language configuration for a new format.
        $edit = [
            'label' => 'Custom medium date',
            'id' => 'custom_medium',
            'date_format_pattern' => 'Y. m. d. H:i',
        ];
        $this->drupalGet('admin/config/regional/date-time/formats/add');
        $this->submitForm($edit, 'Add format');
        // Test translating a default shipped format and our custom format.
        $formats = [
            'medium' => 'Default medium date',
            'custom_medium' => 'Custom medium date',
        ];
        foreach ($formats as $id => $label) {
            $translation_base_url = 'admin/config/regional/date-time/formats/manage/' . $id . '/translate';
            $this->drupalGet($translation_base_url);
            // 'Add' link should be present for French translation.
            $translation_page_url = "{$translation_base_url}/fr/add";
            $this->assertSession()
                ->linkByHrefExists($translation_page_url);
            // Make sure original text is present on this page.
            $this->drupalGet($translation_page_url);
            $this->assertSession()
                ->pageTextContains($label);
            // Make sure that the date library is added.
            $this->assertSession()
                ->responseContains('core/modules/system/js/system.date.js');
            // Update translatable fields.
            $edit = [
                'translation[config_names][core.date_format.' . $id . '][label]' => $id . ' - FR',
                'translation[config_names][core.date_format.' . $id . '][pattern]' => 'D',
            ];
            // Save language specific version of form.
            $this->drupalGet($translation_page_url);
            $this->submitForm($edit, 'Save translation');
            // Get translation and check we've got the right value.
            $override = \Drupal::languageManager()->getLanguageConfigOverride('fr', 'core.date_format.' . $id);
            $expected = [
                'label' => $id . ' - FR',
                'pattern' => 'D',
            ];
            $this->assertEquals($expected, $override->get());
            // Formatting the date 8 / 27 / 1985 @ 13:37 EST with pattern D should
            // display "Tue".
            $formatted_date = $this->container
                ->get('date.formatter')
                ->format(494015820, $id, NULL, 'America/New_York', 'fr');
            $this->assertEquals('Tue', $formatted_date, 'Got the right formatted date using the date format translation pattern.');
        }
    }
    
    /**
     * Tests the account settings translation interface.
     *
     * This is the only special case so far where we have multiple configuration
     * names involved building up one configuration translation form. Test that
     * the translations are saved for all configuration names properly.
     */
    public function testAccountSettingsConfigurationTranslation() {
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/config/people/accounts');
        $this->assertSession()
            ->linkExists('Translate account settings');
        $this->drupalGet('admin/config/people/accounts/translate');
        $this->assertSession()
            ->linkExists('Translate account settings');
        $this->assertSession()
            ->linkByHrefExists('admin/config/people/accounts/translate/fr/add');
        // Update account settings fields for French.
        $edit = [
            'translation[config_names][user.settings][anonymous]' => 'Anonyme',
            'translation[config_names][user.mail][status_blocked][subject]' => 'Testing, your account is blocked.',
            'translation[config_names][user.mail][status_blocked][body]' => 'Testing account blocked body.',
        ];
        $this->drupalGet('admin/config/people/accounts/translate/fr/add');
        $this->submitForm($edit, 'Save translation');
        // Make sure the changes are saved and loaded back properly.
        $this->drupalGet('admin/config/people/accounts/translate/fr/edit');
        foreach ($edit as $key => $value) {
            // Check the translations appear in the right field type as well.
            $this->assertSession()
                ->fieldValueEquals($key, $value);
        }
        // Check that labels for email settings appear.
        $this->assertSession()
            ->pageTextContains('Account cancellation confirmation');
        $this->assertSession()
            ->pageTextContains('Password recovery');
    }
    
    /**
     * Tests source and target language edge cases.
     */
    public function testSourceAndTargetLanguage() {
        $this->drupalLogin($this->adminUser);
        // Loading translation page for not-specified language (und)
        // should return 403.
        $this->drupalGet('admin/config/system/site-information/translate/und/add');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Check the source language doesn't have 'Add' or 'Delete' link and
        // make sure source language edit goes to original configuration page
        // not the translation specific edit page.
        $this->drupalGet('admin/config/system/site-information/translate');
        $this->assertSession()
            ->linkByHrefNotExists('admin/config/system/site-information/translate/en/edit');
        $this->assertSession()
            ->linkByHrefNotExists('admin/config/system/site-information/translate/en/add');
        $this->assertSession()
            ->linkByHrefNotExists('admin/config/system/site-information/translate/en/delete');
        $this->assertSession()
            ->linkByHrefExists('admin/config/system/site-information');
        // Translation addition to source language should return 403.
        $this->drupalGet('admin/config/system/site-information/translate/en/add');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Translation editing in source language should return 403.
        $this->drupalGet('admin/config/system/site-information/translate/en/edit');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Translation deletion in source language should return 403.
        $this->drupalGet('admin/config/system/site-information/translate/en/delete');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Set default language of site information to not-specified language (und).
        $this->config('system.site')
            ->set('langcode', LanguageInterface::LANGCODE_NOT_SPECIFIED)
            ->save();
        // Make sure translation tab does not exist on the configuration page.
        $this->drupalGet('admin/config/system/site-information');
        $this->assertSession()
            ->linkByHrefNotExists('admin/config/system/site-information/translate');
        // If source language is not specified, translation page should be 403.
        $this->drupalGet('admin/config/system/site-information/translate');
        $this->assertSession()
            ->statusCodeEquals(403);
    }
    
    /**
     * Tests the views translation interface.
     */
    public function testViewsTranslationUI() {
        $this->drupalLogin($this->adminUser);
        $description = 'All content promoted to the front page.';
        $human_readable_name = 'Frontpage';
        $display_settings_default = 'Default';
        $display_options_default = '(Empty)';
        $translation_base_url = 'admin/structure/views/view/frontpage/translate';
        $this->drupalGet($translation_base_url);
        // Check 'Add' link of French to visit add page.
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/add");
        $this->clickLink('Add');
        // Make sure original text is present on this page.
        $this->assertSession()
            ->pageTextContains($description);
        $this->assertSession()
            ->pageTextContains($human_readable_name);
        // Update Views Fields for French.
        $edit = [
            'translation[config_names][views.view.frontpage][description]' => $description . " FR",
            'translation[config_names][views.view.frontpage][label]' => $human_readable_name . " FR",
            'translation[config_names][views.view.frontpage][display][default][display_title]' => $display_settings_default . " FR",
            'translation[config_names][views.view.frontpage][display][default][display_options][title]' => $display_options_default . " FR",
        ];
        $this->drupalGet("{$translation_base_url}/fr/add");
        $this->submitForm($edit, 'Save translation');
        $this->assertSession()
            ->pageTextContains('Successfully saved French translation.');
        // Check for edit, delete links (and no 'add' link) for French language.
        $this->assertSession()
            ->linkByHrefNotExists("{$translation_base_url}/fr/add");
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->linkByHrefExists("{$translation_base_url}/fr/delete");
        // Check translation saved proper.
        $this->drupalGet("{$translation_base_url}/fr/edit");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.frontpage][description]', $description . " FR");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.frontpage][label]', $human_readable_name . " FR");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.frontpage][display][default][display_title]', $display_settings_default . " FR");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.frontpage][display][default][display_options][title]', $display_options_default . " FR");
    }
    
    /**
     * Tests plural source elements in configuration translation forms.
     */
    public function testPluralConfigStringsSourceElements() {
        $this->drupalLogin($this->adminUser);
        // Languages to test, with various number of plural forms.
        $languages = [
            'vi' => [
                'plurals' => 1,
                'expected' => [
                    TRUE,
                    FALSE,
                    FALSE,
                    FALSE,
                ],
            ],
            'fr' => [
                'plurals' => 2,
                'expected' => [
                    TRUE,
                    TRUE,
                    FALSE,
                    FALSE,
                ],
            ],
            'sl' => [
                'plurals' => 4,
                'expected' => [
                    TRUE,
                    TRUE,
                    TRUE,
                    TRUE,
                ],
            ],
        ];
        foreach ($languages as $langcode => $data) {
            // Import a .po file to add a new language with a given number of plural forms
            $name = \Drupal::service('file_system')->tempnam('temporary://', $langcode . '_') . '.po';
            file_put_contents($name, $this->getPoFile($data['plurals']));
            $this->drupalGet('admin/config/regional/translate/import');
            $this->submitForm([
                'langcode' => $langcode,
                'files[file]' => $name,
            ], 'Import');
            // Change the config langcode of the 'files' view.
            $config = \Drupal::service('config.factory')->getEditable('views.view.files');
            $config->set('langcode', $langcode);
            $config->save();
            // Go to the translation page of the 'files' view.
            $translation_url = 'admin/structure/views/view/files/translate/en/add';
            $this->drupalGet($translation_url);
            // Check if the expected number of source elements are present.
            foreach ($data['expected'] as $index => $expected) {
                if ($expected) {
                    $this->assertSession()
                        ->responseContains('edit-source-config-names-viewsviewfiles-display-default-display-options-fields-count-format-plural-string-' . $index);
                }
                else {
                    $this->assertSession()
                        ->responseNotContains('edit-source-config-names-viewsviewfiles-display-default-display-options-fields-count-format-plural-string-' . $index);
                }
            }
        }
    }
    
    /**
     * Tests translation of plural strings with multiple plural forms in config.
     */
    public function testPluralConfigStrings() {
        $this->drupalLogin($this->adminUser);
        // First import a .po file with multiple plural forms.
        // This will also automatically add the 'sl' language.
        $name = \Drupal::service('file_system')->tempnam('temporary://', "sl_") . '.po';
        file_put_contents($name, $this->getPoFile(4));
        $this->drupalGet('admin/config/regional/translate/import');
        $this->submitForm([
            'langcode' => 'sl',
            'files[file]' => $name,
        ], 'Import');
        // Translate the files view, as this one uses numeric formatters.
        $description = 'Singular form';
        $field_value = '1 place';
        $field_value_plural = '@count places';
        $translation_url = 'admin/structure/views/view/files/translate/sl/add';
        $this->drupalGet($translation_url);
        // Make sure original text is present on this page, in addition to 2 new
        // empty fields.
        $this->assertSession()
            ->pageTextContains($description);
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][0]', $field_value);
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][1]', $field_value_plural);
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][2]', '');
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][3]', '');
        // Then make sure it also works.
        $edit = [
            'translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][0]' => $field_value . ' SL',
            'translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][1]' => $field_value_plural . ' 1 SL',
            'translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][2]' => $field_value_plural . ' 2 SL',
            'translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][3]' => $field_value_plural . ' 3 SL',
        ];
        $this->drupalGet($translation_url);
        $this->submitForm($edit, 'Save translation');
        // Make sure the values have changed.
        $this->drupalGet($translation_url);
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][0]', "{$field_value} SL");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][1]', "{$field_value_plural} 1 SL");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][2]', "{$field_value_plural} 2 SL");
        $this->assertSession()
            ->fieldValueEquals('translation[config_names][views.view.files][display][default][display_options][fields][count][format_plural_string][3]', "{$field_value_plural} 3 SL");
    }
    
    /**
     * Tests the translation of field and field storage configuration.
     */
    public function testFieldConfigTranslation() {
        // Add a test field which has a translatable field setting and a
        // translatable field storage setting.
        $field_name = strtolower($this->randomMachineName());
        $field_storage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'test_field',
        ]);
        $translatable_storage_setting = $this->randomString();
        $field_storage->setSetting('translatable_storage_setting', $translatable_storage_setting);
        $field_storage->save();
        $bundle = strtolower($this->randomMachineName());
        entity_test_create_bundle($bundle);
        $field = FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => $bundle,
        ]);
        $translatable_field_setting = $this->randomString();
        $field->setSetting('translatable_field_setting', $translatable_field_setting);
        $field->save();
        $this->drupalLogin($this->translatorUser);
        $this->drupalGet("/entity_test/structure/{$bundle}/fields/entity_test.{$bundle}.{$field_name}/translate");
        $this->clickLink('Add');
        $this->assertSession()
            ->pageTextContains('Translatable field setting');
        $this->assertSession()
            ->assertEscaped($translatable_field_setting);
        $this->assertSession()
            ->pageTextContains('Translatable storage setting');
        $this->assertSession()
            ->assertEscaped($translatable_storage_setting);
    }
    
    /**
     * Tests the translation of a boolean field settings.
     */
    public function testBooleanFieldConfigTranslation() {
        // Add a test boolean field.
        $field_name = strtolower($this->randomMachineName());
        FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'boolean',
        ])->save();
        $bundle = strtolower($this->randomMachineName());
        entity_test_create_bundle($bundle);
        $field = FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => $bundle,
        ]);
        $on_label = 'On label (with <em>HTML</em> & things)';
        $field->setSetting('on_label', $on_label);
        $off_label = 'Off label (with <em>HTML</em> & things)';
        $field->setSetting('off_label', $off_label);
        $field->save();
        $this->drupalLogin($this->translatorUser);
        $this->drupalGet("/entity_test/structure/{$bundle}/fields/entity_test.{$bundle}.{$field_name}/translate");
        $this->clickLink('Add');
        // Checks the text of details summary element that surrounds the translation
        // options.
        $this->assertSession()
            ->responseContains(Html::escape(strip_tags($on_label)) . ' Boolean settings');
        // Checks that the correct on and off labels appear on the form.
        $this->assertSession()
            ->assertEscaped($on_label);
        $this->assertSession()
            ->assertEscaped($off_label);
    }
    
    /**
     * Tests translation storage in locale storage.
     */
    public function testLocaleDBStorage() {
        // Enable import of translations. By default this is disabled for automated
        // tests.
        $this->config('locale.settings')
            ->set('translation.import_enabled', TRUE)
            ->set('translation.use_source', LOCALE_TRANSLATION_USE_SOURCE_LOCAL)
            ->save();
        $this->drupalLogin($this->adminUser);
        $langcode = 'xx';
        $name = $this->randomMachineName(16);
        $edit = [
            'predefined_langcode' => 'custom',
            'langcode' => $langcode,
            'label' => $name,
            'direction' => Language::DIRECTION_LTR,
        ];
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add custom language');
        // Make sure there is no translation stored in locale storage before edit.
        $translation = $this->getTranslation('user.settings', 'anonymous', 'fr');
        $this->assertEmpty($translation);
        // Add custom translation.
        $edit = [
            'translation[config_names][user.settings][anonymous]' => 'Anonyme',
        ];
        $this->drupalGet('admin/config/people/accounts/translate/fr/add');
        $this->submitForm($edit, 'Save translation');
        // Make sure translation stored in locale storage after saved language
        // specific configuration translation.
        $translation = $this->getTranslation('user.settings', 'anonymous', 'fr');
        $this->assertEquals('Anonyme', $translation->getString());
        // revert custom translations to base translation.
        $edit = [
            'translation[config_names][user.settings][anonymous]' => 'Anonymous',
        ];
        $this->drupalGet('admin/config/people/accounts/translate/fr/edit');
        $this->submitForm($edit, 'Save translation');
        // Make sure there is no translation stored in locale storage after revert.
        $translation = $this->getTranslation('user.settings', 'anonymous', 'fr');
        $this->assertEquals('Anonymous', $translation->getString());
    }
    
    /**
     * Tests the single language existing.
     */
    public function testSingleLanguageUI() {
        $this->drupalLogin($this->adminUser);
        // Delete French language
        $this->drupalGet('admin/config/regional/language/delete/fr');
        $this->submitForm([], 'Delete');
        $this->assertSession()
            ->pageTextContains('The French (fr) language has been removed.');
        // Change default language to Tamil.
        $edit = [
            'site_default_language' => 'ta',
        ];
        $this->drupalGet('admin/config/regional/language');
        $this->submitForm($edit, 'Save configuration');
        $this->assertSession()
            ->pageTextContains('Configuration saved.');
        // Delete English language
        $this->drupalGet('admin/config/regional/language/delete/en');
        $this->submitForm([], 'Delete');
        $this->assertSession()
            ->pageTextContains('The English (en) language has been removed.');
        // Visit account setting translation page, this should not
        // throw any notices.
        $this->drupalGet('admin/config/people/accounts/translate');
        $this->assertSession()
            ->statusCodeEquals(200);
    }
    
    /**
     * Tests the config_translation_info_alter() hook.
     */
    public function testAlterInfo() {
        $this->drupalLogin($this->adminUser);
        $this->container
            ->get('state')
            ->set('config_translation_test_config_translation_info_alter', TRUE);
        $this->container
            ->get('plugin.manager.config_translation.mapper')
            ->clearCachedDefinitions();
        // Check if the translation page does not have the altered out settings.
        $this->drupalGet('admin/config/people/accounts/translate/fr/add');
        $this->assertSession()
            ->pageTextContains('Name');
        $this->assertSession()
            ->pageTextNotContains('Account cancellation confirmation');
        $this->assertSession()
            ->pageTextNotContains('Password recovery');
    }
    
    /**
     * Tests the sequence data type translation.
     */
    public function testSequenceTranslation() {
        $this->drupalLogin($this->adminUser);
        
        /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
        $config_factory = $this->container
            ->get('config.factory');
        $expected = [
            'kitten',
            'llama',
            'elephant',
        ];
        $actual = $config_factory->getEditable('config_translation_test.content')
            ->get('animals');
        $this->assertEquals($expected, $actual);
        $edit = [
            'translation[config_names][config_translation_test.content][content][value]' => '<p><strong>Hello World</strong> - FR</p>',
            'translation[config_names][config_translation_test.content][animals][0]' => 'kitten - FR',
            'translation[config_names][config_translation_test.content][animals][1]' => 'llama - FR',
            'translation[config_names][config_translation_test.content][animals][2]' => 'elephant - FR',
        ];
        $this->drupalGet('admin/config/media/file-system/translate/fr/add');
        $this->submitForm($edit, 'Save translation');
        $this->container
            ->get('language.config_factory_override')
            ->setLanguage(new Language([
            'id' => 'fr',
        ]));
        $expected = [
            'kitten - FR',
            'llama - FR',
            'elephant - FR',
        ];
        $actual = $config_factory->get('config_translation_test.content')
            ->get('animals');
        $this->assertEquals($expected, $actual);
    }
    
    /**
     * Tests text_format translation.
     */
    public function testTextFormatTranslation() {
        $this->drupalLogin($this->adminUser);
        
        /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
        $config_factory = $this->container
            ->get('config.factory');
        $expected = [
            'value' => '<p><strong>Hello World</strong></p>',
            'format' => 'plain_text',
        ];
        $actual = $config_factory->get('config_translation_test.content')
            ->getOriginal('content', FALSE);
        $this->assertEquals($expected, $actual);
        $translation_base_url = 'admin/config/media/file-system/translate';
        $this->drupalGet($translation_base_url);
        // 'Add' link should be present for French translation.
        $translation_page_url = "{$translation_base_url}/fr/add";
        $this->assertSession()
            ->linkByHrefExists($translation_page_url);
        $this->drupalGet($translation_page_url);
        // Assert that changing the text format is not possible, even for an
        // administrator.
        $this->assertSession()
            ->fieldNotExists('translation[config_names][config_translation_test.content][content][format]');
        // Update translatable fields.
        $edit = [
            'translation[config_names][config_translation_test.content][content][value]' => '<p><strong>Hello World</strong> - FR</p>',
        ];
        // Save language specific version of form.
        $this->drupalGet($translation_page_url);
        $this->submitForm($edit, 'Save translation');
        // Get translation and check we've got the right value.
        $expected = [
            'value' => '<p><strong>Hello World</strong> - FR</p>',
            'format' => 'plain_text',
        ];
        $this->container
            ->get('language.config_factory_override')
            ->setLanguage(new Language([
            'id' => 'fr',
        ]));
        $actual = $config_factory->get('config_translation_test.content')
            ->get('content');
        $this->assertEquals($expected, $actual);
        // Change the text format of the source configuration and verify that the
        // text format of the translation does not change because that could lead to
        // security vulnerabilities.
        $config_factory->getEditable('config_translation_test.content')
            ->set('content.format', 'full_html')
            ->save();
        $actual = $config_factory->get('config_translation_test.content')
            ->get('content');
        // The translation should not have changed, so re-use $expected.
        $this->assertEquals($expected, $actual);
        // Because the text is now in a text format that the translator does not
        // have access to, the translator should not be able to translate it.
        $translation_page_url = "{$translation_base_url}/fr/edit";
        $this->drupalLogin($this->translatorUser);
        $this->drupalGet($translation_page_url);
        $this->assertDisabledTextarea('edit-translation-config-names-config-translation-testcontent-content-value');
        $this->submitForm([], 'Save translation');
        // Check that submitting the form did not update the text format of the
        // translation.
        $actual = $config_factory->get('config_translation_test.content')
            ->get('content');
        $this->assertEquals($expected, $actual);
        // The administrator must explicitly change the text format.
        $this->drupalLogin($this->adminUser);
        $edit = [
            'translation[config_names][config_translation_test.content][content][format]' => 'full_html',
        ];
        $this->drupalGet($translation_page_url);
        $this->submitForm($edit, 'Save translation');
        $expected = [
            'value' => '<p><strong>Hello World</strong> - FR</p>',
            'format' => 'full_html',
        ];
        $actual = $config_factory->get('config_translation_test.content')
            ->get('content');
        $this->assertEquals($expected, $actual);
    }
    
    /**
     * Tests field translation for node fields.
     */
    public function testNodeFieldTranslation() {
        NodeType::create([
            'type' => 'article',
            'name' => 'Article',
        ])->save();
        $field_name = 'translatable_field';
        $field_storage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'node',
            'type' => 'text',
        ]);
        $field_storage->setSetting('translatable_storage_setting', 'translatable_storage_setting');
        $field_storage->save();
        $field = FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'node',
            'bundle' => 'article',
        ]);
        $field->save();
        $this->drupalLogin($this->translatorUser);
        $this->drupalGet("/entity_test/structure/article/fields/node.article.{$field_name}/translate");
        $this->clickLink('Add');
        $form_values = [
            'translation[config_names][field.field.node.article.translatable_field][description]' => 'FR Help text.',
            'translation[config_names][field.field.node.article.translatable_field][label]' => 'FR label',
        ];
        $this->submitForm($form_values, 'Save translation');
        $this->assertSession()
            ->pageTextContains('Successfully saved French translation.');
        // Check that the translations are saved.
        $this->clickLink('Add');
        $this->assertSession()
            ->responseContains('FR label');
    }
    
    /**
     * Test translation save confirmation message.
     */
    public function testMenuTranslationWithoutChange() {
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/structure/menu/manage/main/translate/tyv/add');
        $this->submitForm([], 'Save translation');
        $this->assertSession()
            ->pageTextContains('Tuvan translation was not added. To add a translation, you must modify the configuration.');
        $this->drupalGet('admin/structure/menu/manage/main/translate/tyv/add');
        $edit = [
            'translation[config_names][system.menu.main][label]' => 'Main navigation Translation',
            'translation[config_names][system.menu.main][description]' => 'Site section links Translation',
        ];
        $this->submitForm($edit, 'Save translation');
        $this->assertSession()
            ->pageTextContains('Successfully saved Tuvan translation.');
    }
    
    /**
     * Gets translation from locale storage.
     *
     * @param $config_name
     *   Configuration object.
     * @param $key
     *   Translation configuration field key.
     * @param $langcode
     *   String language code to load translation.
     *
     * @return bool|mixed
     *   Returns translation if exists, FALSE otherwise.
     */
    protected function getTranslation($config_name, $key, $langcode) {
        $settings_locations = $this->localeStorage
            ->getLocations([
            'type' => 'configuration',
            'name' => $config_name,
        ]);
        $this->assertNotEmpty($settings_locations, "{$config_name} should have configuration locations.");
        if (!empty($settings_locations)) {
            $source = $this->container
                ->get('config.factory')
                ->get($config_name)
                ->get($key);
            $source_string = $this->localeStorage
                ->findString([
                'source' => $source,
                'type' => 'configuration',
            ]);
            $this->assertNotEmpty($source_string, "{$config_name}.{$key} should have a source string.");
            if (!empty($source_string)) {
                $conditions = [
                    'lid' => $source_string->lid,
                    'language' => $langcode,
                ];
                $translations = $this->localeStorage
                    ->getTranslations($conditions + [
                    'translated' => TRUE,
                ]);
                return reset($translations);
            }
        }
        return FALSE;
    }
    
    /**
     * Sets site name and slogan for default language, helps in tests.
     *
     * @param string $site_name
     *   The site name.
     * @param string $site_slogan
     *   The site slogan.
     */
    protected function setSiteInformation($site_name, $site_slogan) {
        $edit = [
            'site_name' => $site_name,
            'site_slogan' => $site_slogan,
        ];
        $this->drupalGet('admin/config/system/site-information');
        $this->submitForm($edit, 'Save configuration');
        $this->assertSession()
            ->pageTextContains('The configuration options have been saved.');
    }
    
    /**
     * Get server-rendered contextual links for the given contextual link ids.
     *
     * @param array $ids
     *   An array of contextual link ids.
     * @param string $current_path
     *   The Drupal path for the page for which the contextual links are rendered.
     *
     * @return string
     *   The response body.
     */
    protected function renderContextualLinks($ids, $current_path) {
        $post = [];
        for ($i = 0; $i < count($ids); $i++) {
            $post['ids[' . $i . ']'] = $ids[$i];
        }
        return $this->drupalPostWithFormat('contextual/render', 'json', $post, [
            'query' => [
                'destination' => $current_path,
            ],
        ]);
    }
    
    /**
     * Asserts that a textarea with a given ID has been disabled from editing.
     *
     * @param string $id
     *   The HTML ID of the textarea.
     *
     * @internal
     */
    protected function assertDisabledTextarea(string $id) : void {
        $textarea = $this->assertSession()
            ->fieldDisabled($id);
        $this->assertSame('textarea', $textarea->getTagName());
        $this->assertSame('This field has been disabled because you do not have sufficient permissions to edit it.', $textarea->getText());
        // Make sure the text format select is not shown.
        $select_id = str_replace('value', 'format--2', $id);
        $xpath = $this->assertSession()
            ->buildXPathQuery('//select[@id=:id]', [
            ':id' => $select_id,
        ]);
        $this->assertSession()
            ->elementNotExists('xpath', $xpath);
    }
    
    /**
     * Helper function that returns a .po file with a given number of plural forms.
     */
    public function getPoFile($plurals) {
        $po_file = [];
        $po_file[1] = <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 8\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=1; plural=0;\\n"
EOF;
        $po_file[2] = <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 8\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n>1);\\n"
EOF;
        $po_file[4] = <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 8\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=4; plural=(((n%100)==1)?(0):(((n%100)==2)?(1):((((n%100)==3)||((n%100)==4))?(2):3)));\\n"
EOF;
        return $po_file[$plurals];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail Deprecated protected function Outputs to verbose the most recent $count emails sent.
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 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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. 37
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::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
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.
ConfigTranslationUiTest::$adminUser protected property Administrator user for tests.
ConfigTranslationUiTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigTranslationUiTest::$langcodes protected property Languages to enable.
ConfigTranslationUiTest::$localeStorage protected property String translation storage object.
ConfigTranslationUiTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
ConfigTranslationUiTest::$translatorUser protected property Translator user for tests.
ConfigTranslationUiTest::assertDisabledTextarea protected function Asserts that a textarea with a given ID has been disabled from editing.
ConfigTranslationUiTest::getPoFile public function Helper function that returns a .po file with a given number of plural forms.
ConfigTranslationUiTest::getTranslation protected function Gets translation from locale storage.
ConfigTranslationUiTest::renderContextualLinks protected function Get server-rendered contextual links for the given contextual link ids.
ConfigTranslationUiTest::setSiteInformation protected function Sets site name and slogan for default language, helps in tests.
ConfigTranslationUiTest::setUp protected function Overrides BrowserTestBase::setUp
ConfigTranslationUiTest::testAccountSettingsConfigurationTranslation public function Tests the account settings translation interface.
ConfigTranslationUiTest::testAlterInfo public function Tests the config_translation_info_alter() hook.
ConfigTranslationUiTest::testBooleanFieldConfigTranslation public function Tests the translation of a boolean field settings.
ConfigTranslationUiTest::testContactConfigEntityTranslation public function Tests the contact form translation.
ConfigTranslationUiTest::testDateFormatTranslation public function Tests date format translation.
ConfigTranslationUiTest::testFieldConfigTranslation public function Tests the translation of field and field storage configuration.
ConfigTranslationUiTest::testLocaleDBStorage public function Tests translation storage in locale storage.
ConfigTranslationUiTest::testMenuTranslationWithoutChange public function Test translation save confirmation message.
ConfigTranslationUiTest::testNodeFieldTranslation public function Tests field translation for node fields.
ConfigTranslationUiTest::testPluralConfigStrings public function Tests translation of plural strings with multiple plural forms in config.
ConfigTranslationUiTest::testPluralConfigStringsSourceElements public function Tests plural source elements in configuration translation forms.
ConfigTranslationUiTest::testSequenceTranslation public function Tests the sequence data type translation.
ConfigTranslationUiTest::testSingleLanguageUI public function Tests the single language existing.
ConfigTranslationUiTest::testSiteInformationTranslationUi public function Tests the site information translation interface.
ConfigTranslationUiTest::testSourceAndTargetLanguage public function Tests source and target language edge cases.
ConfigTranslationUiTest::testSourceValueDuplicateSave public function Tests the site information translation interface.
ConfigTranslationUiTest::testTextFormatTranslation public function Tests text_format translation.
ConfigTranslationUiTest::testViewsTranslationUI public function Tests the views translation interface.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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. 1
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. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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. 1
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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. 1
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.
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. 1
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
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. 1
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 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
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 Deprecated 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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.