class LocaleImportFunctionalTest

Same name in other branches
  1. 7.x modules/locale/locale.test \LocaleImportFunctionalTest
  2. 9 core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php \Drupal\Tests\locale\Functional\LocaleImportFunctionalTest
  3. 8.9.x core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php \Drupal\Tests\locale\Functional\LocaleImportFunctionalTest
  4. 10 core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php \Drupal\Tests\locale\Functional\LocaleImportFunctionalTest

Tests the import of locale files.

@group locale

Hierarchy

Expanded class hierarchy of LocaleImportFunctionalTest

File

core/modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php, line 21

Namespace

Drupal\Tests\locale\Functional
View source
class LocaleImportFunctionalTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'locale',
        'dblog',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * A user able to create languages and import translations.
     *
     * @var \Drupal\user\Entity\User
     */
    protected $adminUser;
    
    /**
     * A user able to create languages, import translations, access site reports.
     *
     * @var \Drupal\user\Entity\User
     */
    protected $adminUserAccessSiteReports;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Copy test po files to the translations directory.
        
        /** @var \Drupal\Core\File\FileSystemInterface $file_system */
        $file_system = \Drupal::service('file_system');
        $file_system->copy(__DIR__ . '/../../../tests/test.de.po', 'translations://', FileExists::Replace);
        $file_system->copy(__DIR__ . '/../../../tests/test.xx.po', 'translations://', FileExists::Replace);
        $this->adminUser = $this->drupalCreateUser([
            'administer languages',
            'translate interface',
            'access administration pages',
        ]);
        $this->adminUserAccessSiteReports = $this->drupalCreateUser([
            'administer languages',
            'translate interface',
            'access administration pages',
            'access site reports',
        ]);
        $this->drupalLogin($this->adminUser);
        // 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();
    }
    
    /**
     * Tests import of standalone .po files.
     */
    public function testStandalonePoFile() : void {
        // Try importing a .po file.
        $this->importPoFile($this->getPoFile(), [
            'langcode' => 'fr',
        ]);
        $this->config('locale.settings');
        // The import should automatically create the corresponding language.
        $this->assertSession()
            ->pageTextContains("The language French has been created.");
        // The import should have created 8 strings.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 8 translations were added, 0 translations were updated and 0 translations were removed.");
        // This import should have saved plural forms to have 2 variants.
        $locale_plurals = \Drupal::service('locale.plural.formula')->getNumberOfPlurals('fr');
        $this->assertEquals(2, $locale_plurals, 'Plural number initialized.');
        // Ensure we were redirected correctly.
        $this->assertSession()
            ->addressEquals(Url::fromRoute('locale.translate_page'));
        // Try importing a .po file with invalid tags.
        $this->importPoFile($this->getBadPoFile(), [
            'langcode' => 'fr',
        ]);
        // The import should have created 1 string and rejected 2.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 1 translations were added, 0 translations were updated and 0 translations were removed.");
        $this->assertSession()
            ->pageTextContains("2 translation strings were skipped because of disallowed or malformed HTML. See the log for details.");
        // Repeat the process with a user that can access site reports, and this
        // time the different warnings must contain links to the log.
        $this->drupalLogin($this->adminUserAccessSiteReports);
        // Try importing a .po file with invalid tags.
        $this->importPoFile($this->getBadPoFile(), [
            'langcode' => 'fr',
        ]);
        $this->assertSession()
            ->pageTextContains("2 translation strings were skipped because of disallowed or malformed HTML. See the log for details.");
        // Check empty files import with a user that cannot access site reports..
        $this->drupalLogin($this->adminUser);
        // Try importing a zero byte sized .po file.
        $this->importPoFile($this->getEmptyPoFile(), [
            'langcode' => 'fr',
        ]);
        // The import should have created 0 string and rejected 0.
        $this->assertSession()
            ->pageTextContains("One translation file could not be imported. See the log for details.");
        // Repeat the process with a user that can access site reports, and this
        // time the different warnings must contain links to the log.
        $this->drupalLogin($this->adminUserAccessSiteReports);
        // Try importing a zero byte sized .po file.
        $this->importPoFile($this->getEmptyPoFile(), [
            'langcode' => 'fr',
        ]);
        // The import should have created 0 string and rejected 0.
        $this->assertSession()
            ->pageTextContains("One translation file could not be imported. See the log for details.");
        // Try importing a .po file which doesn't exist.
        $name = $this->randomMachineName(16);
        $this->drupalGet('admin/config/regional/translate/import');
        $this->submitForm([
            'langcode' => 'fr',
            'files[file]' => $name,
        ], 'Import');
        $this->assertSession()
            ->addressEquals(Url::fromRoute('locale.translate_import'));
        $this->assertSession()
            ->pageTextContains('File to import not found.');
        // Try importing a .po file with overriding strings, and ensure existing
        // strings are kept.
        $this->importPoFile($this->getOverwritePoFile(), [
            'langcode' => 'fr',
        ]);
        // The import should have created 1 string.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 1 translations were added, 0 translations were updated and 0 translations were removed.");
        // Ensure string wasn't overwritten.
        $search = [
            'string' => 'Montag',
            'langcode' => 'fr',
            'translation' => 'translated',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $this->assertSession()
            ->pageTextContains('No strings available.');
        // This import should not have changed number of plural forms.
        $locale_plurals = \Drupal::service('locale.plural.formula')->getNumberOfPlurals('fr');
        $this->assertEquals(2, $locale_plurals, 'Plural numbers untouched.');
        // Try importing a .po file with overriding strings, and ensure existing
        // strings are overwritten.
        $this->importPoFile($this->getOverwritePoFile(), [
            'langcode' => 'fr',
            'overwrite_options[not_customized]' => TRUE,
        ]);
        // The import should have updated 2 strings.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 0 translations were added, 2 translations were updated and 0 translations were removed.");
        // Ensure string was overwritten.
        $search = [
            'string' => 'Montag',
            'langcode' => 'fr',
            'translation' => 'translated',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $this->assertSession()
            ->pageTextNotContains('No strings available.');
        // This import should have changed number of plural forms.
        $locale_plurals = \Drupal::service('locale.plural.formula')->reset()
            ->getNumberOfPlurals('fr');
        $this->assertEquals(3, $locale_plurals, 'Plural numbers changed.');
        // Importing a .po file and mark its strings as customized strings.
        $this->importPoFile($this->getCustomPoFile(), [
            'langcode' => 'fr',
            'customized' => TRUE,
        ]);
        // The import should have created 6 strings.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 6 translations were added, 0 translations were updated and 0 translations were removed.");
        // The database should now contain 6 customized strings (two imported
        // strings are not translated).
        $count = Database::getConnection()->select('locales_target')
            ->condition('customized', 1)
            ->countQuery()
            ->execute()
            ->fetchField();
        $this->assertEquals(6, $count, 'Customized translations successfully imported.');
        // Try importing a .po file with overriding strings, and ensure existing
        // customized strings are kept.
        $this->importPoFile($this->getCustomOverwritePoFile(), [
            'langcode' => 'fr',
            'overwrite_options[not_customized]' => TRUE,
            'overwrite_options[customized]' => FALSE,
        ]);
        // The import should have created 1 string.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 1 translations were added, 0 translations were updated and 0 translations were removed.");
        // Ensure string wasn't overwritten.
        $search = [
            'string' => 'januari',
            'langcode' => 'fr',
            'translation' => 'translated',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $this->assertSession()
            ->pageTextContains('No strings available.');
        // Try importing a .po file with overriding strings, and ensure existing
        // customized strings are overwritten.
        $this->importPoFile($this->getCustomOverwritePoFile(), [
            'langcode' => 'fr',
            'overwrite_options[not_customized]' => FALSE,
            'overwrite_options[customized]' => TRUE,
        ]);
        // The import should have updated 2 strings.
        $this->assertSession()
            ->pageTextContains("One translation file imported. 0 translations were added, 2 translations were updated and 0 translations were removed.");
        // Ensure string was overwritten.
        $search = [
            'string' => 'januari',
            'langcode' => 'fr',
            'translation' => 'translated',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $this->assertSession()
            ->pageTextNotContains('No strings available.');
        // Try importing a .po file with invalid encoding.
        $this->importPoFile($this->getInvalidEncodedPoFile(), [], [
            'Windows-1252',
        ]);
        $this->assertSession()
            ->pageTextContains('The file is encoded with ASCII. It must be encoded with UTF-8');
    }
    
    /**
     * Tests msgctxt context support.
     */
    public function testLanguageContext() : void {
        // Try importing a .po file.
        $this->importPoFile($this->getPoFileWithContext(), [
            'langcode' => 'hr',
        ]);
        // We cast the return value of t() to string so as to retrieve the
        // translated value, rendered as a string.
        $this->assertSame('Svibanj', (string) t('May', [], [
            'langcode' => 'hr',
            'context' => 'Long month name',
        ]), 'Long month name context is working.');
        $this->assertSame('Svi.', (string) t('May', [], [
            'langcode' => 'hr',
        ]), 'Default context is working.');
    }
    
    /**
     * Tests empty msgstr at end of .po file see #611786.
     */
    public function testEmptyMsgstr() : void {
        $langcode = 'hu';
        // Try importing a .po file.
        $this->importPoFile($this->getPoFileWithMsgstr(), [
            'langcode' => $langcode,
        ]);
        $this->assertSession()
            ->pageTextContains("One translation file imported. 1 translations were added, 0 translations were updated and 0 translations were removed.");
        $this->assertSame('Műveletek', (string) t('Operations', [], [
            'langcode' => $langcode,
        ]), 'String imported and translated.');
        // Try importing a .po file.
        $this->importPoFile($this->getPoFileWithEmptyMsgstr(), [
            'langcode' => $langcode,
            'overwrite_options[not_customized]' => TRUE,
        ]);
        $this->assertSession()
            ->pageTextContains("One translation file imported. 0 translations were added, 0 translations were updated and 1 translations were removed.");
        $str = "Operations";
        $search = [
            'string' => $str,
            'langcode' => $langcode,
            'translation' => 'untranslated',
        ];
        // Check that search finds the string as untranslated.
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $this->assertSession()
            ->pageTextContains($str);
    }
    
    /**
     * Tests .po file import with configuration translation.
     */
    public function testConfigPoFile() : void {
        // Values for translations to assert. Config key, original string,
        // translation and config property name.
        $config_strings = [
            'system.maintenance' => [
                '@site is currently under maintenance. We should be back shortly. Thank you for your patience.',
                // cSpell:disable-next-line
'@site karbantartás alatt áll. Rövidesen visszatérünk. Köszönjük a türelmet.',
                'message',
            ],
            'user.role.anonymous' => [
                'Anonymous user',
                // cSpell:disable-next-line
'Névtelen felhasználó',
                'label',
            ],
        ];
        // Add custom language for testing.
        $langcode = 'xx';
        $edit = [
            'predefined_langcode' => 'custom',
            'langcode' => $langcode,
            'label' => $this->randomMachineName(16),
            'direction' => LanguageInterface::DIRECTION_LTR,
        ];
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add custom language');
        // Check for the source strings we are going to translate. Adding the
        // custom language should have made the process to export configuration
        // strings to interface translation executed.
        $locale_storage = $this->container
            ->get('locale.storage');
        foreach ($config_strings as $config_string) {
            $string = $locale_storage->findString([
                'source' => $config_string[0],
                'context' => '',
                'type' => 'configuration',
            ]);
            $this->assertNotEmpty($string, 'Configuration strings have been created upon installation.');
        }
        // Import a .po file to translate.
        $this->importPoFile($this->getPoFileWithConfig(), [
            'langcode' => $langcode,
        ]);
        // Translations got recorded in the interface translation system.
        foreach ($config_strings as $config_string) {
            $search = [
                'string' => $config_string[0],
                'langcode' => $langcode,
                'translation' => 'all',
            ];
            $this->drupalGet('admin/config/regional/translate');
            $this->submitForm($search, 'Filter');
            $this->assertSession()
                ->pageTextContains($config_string[1]);
        }
        // Test that translations got recorded in the config system.
        $overrides = \Drupal::service('language.config_factory_override');
        foreach ($config_strings as $config_key => $config_string) {
            $override = $overrides->getOverride($langcode, $config_key);
            $this->assertEquals($override->get($config_string[2]), $config_string[1]);
        }
    }
    
    /**
     * Tests .po file import with user.settings configuration.
     */
    public function testConfigTranslationImportingPoFile() : void {
        // Set the language code.
        $langcode = 'de';
        // Import a .po file to translate.
        $this->importPoFile($this->getPoFileWithConfigDe(), [
            'langcode' => $langcode,
        ]);
        // Check that the 'Anonymous' string is translated.
        $config = \Drupal::languageManager()->getLanguageConfigOverride($langcode, 'user.settings');
        $this->assertEquals('Anonymous German', $config->get('anonymous'));
    }
    
    /**
     * Tests the translation are imported when a new language is created.
     */
    public function testCreatedLanguageTranslation() : void {
        // Import a .po file to add de language.
        $this->importPoFile($this->getPoFileWithConfigDe(), [
            'langcode' => 'de',
        ]);
        // Get the language.entity.de label and check it's been translated.
        $override = \Drupal::languageManager()->getLanguageConfigOverride('de', 'language.entity.de');
        $this->assertEquals('Deutsch', $override->get('label'));
    }
    
    /**
     * Helper function: import a standalone .po file in a given language.
     *
     * @param string $contents
     *   Contents of the .po file to import.
     * @param array $options
     *   (optional) Additional options to pass to the translation import form.
     * @param array $encodings
     *   (optional) The encoding of the file.
     */
    public function importPoFile($contents, array $options = [], array $encodings = []) {
        $file_system = \Drupal::service('file_system');
        $name = $file_system->tempnam('temporary://', "po_") . '.po';
        foreach ($encodings as $encoding) {
            $contents = mb_convert_encoding($contents, $encoding);
        }
        file_put_contents($name, $contents);
        $options['files[file]'] = $name;
        $this->drupalGet('admin/config/regional/translate/import');
        $this->submitForm($options, 'Import');
        $file_system->unlink($name);
    }
    
    /**
     * Helper function that returns a proper .po file.
     */
    public function getPoFile() {
        return <<<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"

msgid "One sheep"
msgid_plural "@count sheep"
msgstr[0] "un mouton"
msgstr[1] "@count moutons"

msgid "Monday"
msgstr "lundi"

msgid "Tuesday"
msgstr "mardi"

msgid "Wednesday"
msgstr "mercredi"

msgid "Thursday"
msgstr "jeudi"

msgid "Friday"
msgstr "vendredi"

msgid "Saturday"
msgstr "samedi"

msgid "Sunday"
msgstr "dimanche"
EOF;
    }
    
    /**
     * Helper function that returns an empty .po file.
     */
    public function getEmptyPoFile() {
        return '';
    }
    
    /**
     * Helper function that returns a bad .po file.
     */
    public function getBadPoFile() {
        return <<<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"

msgid "Save configuration"
msgstr "Enregistrer la configuration"

msgid "edit"
msgstr "modifier<img SRC="javascript:alert(\\'xss\\');">"

msgid "delete"
msgstr "supprimer<script>alert('xss');</script>"

EOF;
    }
    
    /**
     * Helper function that returns a proper .po file for testing.
     */
    public function getOverwritePoFile() {
        return <<<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=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\\n"

msgid "Monday"
msgstr "Montag"

msgid "Day"
msgstr "Jour"
EOF;
    }
    
    /**
     * Returns a .po file that will be marked as customized.
     */
    public function getCustomPoFile() {
        return <<<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"

msgid "One dog"
msgid_plural "@count dogs"
msgstr[0] "un chien"
msgstr[1] "@count chiens"

msgid "January"
msgstr "janvier"

msgid "February"
msgstr "février"

msgid "March"
msgstr "mars"

msgid "April"
msgstr "avril"

msgid "June"
msgstr "juin"
EOF;
    }
    
    /**
     * Helper function that returns a .po file for testing customized strings.
     */
    public function getCustomOverwritePoFile() {
        return <<<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"

msgid "January"
msgstr "januari"

msgid "February"
msgstr "februari"

msgid "July"
msgstr "juillet"
EOF;
    }
    
    /**
     * Helper function that returns a .po file with context.
     */
    public function getPoFileWithContext() {
        // Croatian (code hr) is one of the languages that have a different
        // form for the full name and the abbreviated name for the month of May.
        return <<<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=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\\n"

msgctxt "Long month name"
msgid "May"
msgstr "Svibanj"

msgid "May"
msgstr "Svi."
EOF;
    }
    
    /**
     * Helper function that returns a .po file with an empty last item.
     */
    public function getPoFileWithEmptyMsgstr() {
        return <<<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"

msgid "Operations"
msgstr ""

EOF;
    }
    
    /**
     * Helper function that returns a .po file with an empty last item.
     */
    public function getPoFileWithMsgstr() {
        return <<<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"

msgid "Operations"
msgstr "Műveletek"

msgid "Will not appear in Drupal core, so we can ensure the test passes"
msgstr ""

EOF;
    }
    
    /**
     * Helper function that returns a .po file with configuration translations.
     */
    public function getPoFileWithConfig() {
        return <<<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"

msgid "@site is currently under maintenance. We should be back shortly. Thank you for your patience."
msgstr "@site karbantartás alatt áll. Rövidesen visszatérünk. Köszönjük a türelmet."

msgid "Anonymous user"
msgstr "Névtelen felhasználó"

EOF;
    }
    
    /**
     * Helper function that returns a .po file with configuration translations.
     */
    public function getPoFileWithConfigDe() {
        return <<<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"

msgid "Anonymous"
msgstr "Anonymous German"

msgid "German"
msgstr "Deutsch"

EOF;
    }
    
    /**
     * Helper function that returns a .po file with invalid encoding.
     */
    public function getInvalidEncodedPoFile() {
        return <<<EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 8\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=Windows-1252\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"

msgid "Swamp"
msgstr "Räme"
EOF;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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::$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 SettingsEditor::rewrite().
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::$profile protected property The profile to install as a basis for testing. 41
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 test site. 2
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::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
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. 4
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
LocaleImportFunctionalTest::$adminUser protected property A user able to create languages and import translations.
LocaleImportFunctionalTest::$adminUserAccessSiteReports protected property A user able to create languages, import translations, access site reports.
LocaleImportFunctionalTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LocaleImportFunctionalTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
LocaleImportFunctionalTest::getBadPoFile public function Helper function that returns a bad .po file.
LocaleImportFunctionalTest::getCustomOverwritePoFile public function Helper function that returns a .po file for testing customized strings.
LocaleImportFunctionalTest::getCustomPoFile public function Returns a .po file that will be marked as customized.
LocaleImportFunctionalTest::getEmptyPoFile public function Helper function that returns an empty .po file.
LocaleImportFunctionalTest::getInvalidEncodedPoFile public function Helper function that returns a .po file with invalid encoding.
LocaleImportFunctionalTest::getOverwritePoFile public function Helper function that returns a proper .po file for testing.
LocaleImportFunctionalTest::getPoFile public function Helper function that returns a proper .po file.
LocaleImportFunctionalTest::getPoFileWithConfig public function Helper function that returns a .po file with configuration translations.
LocaleImportFunctionalTest::getPoFileWithConfigDe public function Helper function that returns a .po file with configuration translations.
LocaleImportFunctionalTest::getPoFileWithContext public function Helper function that returns a .po file with context.
LocaleImportFunctionalTest::getPoFileWithEmptyMsgstr public function Helper function that returns a .po file with an empty last item.
LocaleImportFunctionalTest::getPoFileWithMsgstr public function Helper function that returns a .po file with an empty last item.
LocaleImportFunctionalTest::importPoFile public function Helper function: import a standalone .po file in a given language.
LocaleImportFunctionalTest::setUp protected function Overrides BrowserTestBase::setUp
LocaleImportFunctionalTest::testConfigPoFile public function Tests .po file import with configuration translation.
LocaleImportFunctionalTest::testConfigTranslationImportingPoFile public function Tests .po file import with user.settings configuration.
LocaleImportFunctionalTest::testCreatedLanguageTranslation public function Tests the translation are imported when a new language is created.
LocaleImportFunctionalTest::testEmptyMsgstr public function Tests empty msgstr at end of .po file see #611786.
LocaleImportFunctionalTest::testLanguageContext public function Tests msgctxt context support.
LocaleImportFunctionalTest::testStandalonePoFile public function Tests import of standalone .po files.
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
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.
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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::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. 3
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. 4
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::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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
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. 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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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.