class ConfigurableLanguageManagerTest

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

Tests Language Negotiation.

Uses different negotiators for content and interface.

@group language

Hierarchy

Expanded class hierarchy of ConfigurableLanguageManagerTest

File

core/modules/language/tests/src/Functional/ConfigurableLanguageManagerTest.php, line 27

Namespace

Drupal\Tests\language\Functional
View source
class ConfigurableLanguageManagerTest extends BrowserTestBase {
    use WaitTerminateTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'content_translation',
        'node',
        'locale',
        'block',
        'system',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // The \Drupal\locale\LocaleTranslation service clears caches after the
        // response is flushed to the client. We use WaitTerminateTestTrait to wait
        // for Drupal to perform its termination work before continuing.
        $this->setWaitForTerminate();
        
        /** @var \Drupal\user\UserInterface $user */
        $user = $this->createUser([], '', TRUE);
        $this->drupalLogin($user);
        ConfigurableLanguage::createFromLangcode('es')->save();
        // Create a page node type and make it translatable.
        NodeType::create([
            'type' => 'page',
            'name' => 'Page',
        ])->save();
        $config = ContentLanguageSettings::loadByEntityTypeBundle('node', 'page');
        $config->setDefaultLangcode('en')
            ->setLanguageAlterable(TRUE)
            ->save();
        // Create a Node with title 'English' and translate it to Spanish.
        $node = Node::create([
            'type' => 'page',
            'title' => 'English',
        ]);
        $node->save();
        $node->addTranslation('es', [
            'title' => 'Español',
        ]);
        $node->save();
        // Enable both language_interface and language_content language negotiation.
        \Drupal::getContainer()->get('language_negotiator')
            ->updateConfiguration([
            'language_interface',
            'language_content',
        ]);
        // Set the preferred language of the user for admin pages to English.
        $user->set('preferred_admin_langcode', 'en')
            ->save();
        // Make sure node edit pages are administration pages.
        $this->config('node.settings')
            ->set('use_admin_theme', '1')
            ->save();
        $this->container
            ->get('router.builder')
            ->rebuild();
        // Place a Block with a translatable string on the page.
        $this->placeBlock('system_powered_by_block', [
            'region' => 'content',
        ]);
        // Load the Spanish Node page once, to register the translatable string.
        $this->drupalGet('/es/node/1');
        // Translate the Powered by string.
        
        /** @var \Drupal\locale\StringStorageInterface $string_storage */
        $string_storage = \Drupal::getContainer()->get('locale.storage');
        $source = $string_storage->findString([
            'source' => 'Powered by <a href=":poweredby">Drupal</a>',
        ]);
        $string_storage->createTranslation([
            'lid' => $source->lid,
            'language' => 'es',
            'translation' => 'Funciona con ...',
        ])
            ->save();
        // Invalidate caches so that the new translation will be used.
        Cache::invalidateTags([
            'rendered',
            'locale',
        ]);
    }
    
    /**
     * Tests translation with URL and Preferred Admin Language negotiators.
     *
     * The interface language uses the preferred language for admin pages of the
     * user and after that the URL. The Content uses just the URL.
     */
    public function testUrlContentTranslationWithPreferredAdminLanguage() : void {
        $assert_session = $this->assertSession();
        // Set the interface language to use the preferred administration language
        // and then the URL.
        
        /** @var \Drupal\language\LanguageNegotiatorInterface $language_negotiator */
        $language_negotiator = \Drupal::getContainer()->get('language_negotiator');
        $language_negotiator->saveConfiguration('language_interface', [
            'language-user-admin' => 1,
            'language-url' => 2,
            'language-selected' => 3,
        ]);
        // Set Content Language Negotiator to use just the URL.
        $language_negotiator->saveConfiguration('language_content', [
            'language-url' => 4,
            'language-selected' => 5,
        ]);
        // See if the full view of the node in english is present and the
        // string in the Powered By Block is in English.
        $this->drupalGet('/node/1');
        $assert_session->pageTextContains('English');
        $assert_session->pageTextContains('Powered by');
        // Load the spanish node page again and see if both the node and the string
        // are translated.
        $this->drupalGet('/es/node/1');
        $assert_session->pageTextContains('Español');
        $assert_session->pageTextContains('Funciona con');
        $assert_session->pageTextNotContains('Powered by');
        // Check if the Powered by string is shown in English on an
        // administration page, and the node content is shown in Spanish.
        $this->drupalGet('/es/node/1/edit');
        $assert_session->pageTextContains('Español');
        $assert_session->pageTextContains('Powered by');
        $assert_session->pageTextNotContains('Funciona con');
    }
    
    /**
     * Tests translation with URL and Session Language Negotiators.
     */
    public function testUrlContentTranslationWithSessionLanguage() : void {
        $assert_session = $this->assertSession();
        
        /** @var \Drupal\language\LanguageNegotiatorInterface $language_negotiator */
        $language_negotiator = \Drupal::getContainer()->get('language_negotiator');
        // Set Interface Language Negotiator to Session.
        $language_negotiator->saveConfiguration('language_interface', [
            'language-session' => 1,
            'language-url' => 2,
            'language-selected' => 3,
        ]);
        // Set Content Language Negotiator to URL.
        $language_negotiator->saveConfiguration('language_content', [
            'language-url' => 4,
            'language-selected' => 5,
        ]);
        // See if the full view of the node in english is present and the
        // string in the Powered By Block is in English.
        $this->drupalGet('/node/1');
        $assert_session->pageTextContains('English');
        $assert_session->pageTextContains('Powered by');
        // The language session variable has not been set yet, so
        // The string should be in Spanish.
        $this->drupalGet('/es/node/1');
        $assert_session->pageTextContains('Español');
        $assert_session->pageTextNotContains('Powered by');
        $assert_session->pageTextContains('Funciona con');
        // Set the session language to Spanish but load the English node page.
        $this->drupalGet('/node/1', [
            'query' => [
                'language' => 'es',
            ],
        ]);
        $assert_session->pageTextContains('English');
        $assert_session->pageTextNotContains('Español');
        $assert_session->pageTextContains('Funciona con');
        $assert_session->pageTextNotContains('Powered by');
        // Set the session language to English but load the node page in Spanish.
        $this->drupalGet('/es/node/1', [
            'query' => [
                'language' => 'en',
            ],
        ]);
        $assert_session->pageTextNotContains('English');
        $assert_session->pageTextContains('Español');
        $assert_session->pageTextNotContains('Funciona con');
        $assert_session->pageTextContains('Powered by');
    }
    
    /**
     * Tests translation of the user profile edit form.
     *
     * The user profile edit form is a special case when used with the preferred
     * admin language negotiator because of the recursive way that the negotiator
     * is called.
     */
    public function testUserProfileTranslationWithPreferredAdminLanguage() : void {
        $assert_session = $this->assertSession();
        // Set the interface language to use the preferred administration language.
        
        /** @var \Drupal\language\LanguageNegotiatorInterface $language_negotiator */
        $language_negotiator = \Drupal::getContainer()->get('language_negotiator');
        $language_negotiator->saveConfiguration('language_interface', [
            'language-user-admin' => 1,
            'language-selected' => 2,
        ]);
        // Create a field on the user entity.
        $field_name = $this->randomMachineName();
        $label = $this->randomMachineName();
        $field_label_en = "English {$label}";
        $field_label_es = "Español {$label}";
        $field_storage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'user',
            'type' => 'string',
        ]);
        $field_storage->save();
        $instance = FieldConfig::create([
            'field_storage' => $field_storage,
            'bundle' => 'user',
            'label' => $field_label_en,
        ]);
        $instance->save();
        // Add a Spanish translation.
        \Drupal::languageManager()->getLanguageConfigOverride('es', "field.field.user.user.{$field_name}")
            ->set('label', $field_label_es)
            ->save();
        // Add the new field to the edit form.
        EntityFormDisplay::create([
            'targetEntityType' => 'user',
            'bundle' => 'user',
            'mode' => 'default',
            'status' => TRUE,
        ])->setComponent($field_name, [
            'type' => 'string_textfield',
        ])
            ->save();
        $user_id = \Drupal::currentUser()->id();
        $this->drupalGet("/user/{$user_id}/edit");
        // Admin language choice is "No preference" so we should get the default.
        $assert_session->pageTextContains($field_label_en);
        $assert_session->pageTextNotContains($field_label_es);
        // Set admin language to Spanish.
        $this->submitForm([
            'edit-preferred-admin-langcode' => 'es',
        ], 'edit-submit');
        $assert_session->pageTextContains($field_label_es);
        $assert_session->pageTextNotContains($field_label_en);
        // Set admin language to English.
        $this->submitForm([
            'edit-preferred-admin-langcode' => 'en',
        ], 'edit-submit');
        $assert_session->pageTextContains($field_label_en);
        $assert_session->pageTextNotContains($field_label_es);
    }

}

Members

Title Sort descending Deprecated 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::$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 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::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
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 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::__get public function
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.
ConfigurableLanguageManagerTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigurableLanguageManagerTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ConfigurableLanguageManagerTest::setUp protected function Overrides BrowserTestBase::setUp
ConfigurableLanguageManagerTest::testUrlContentTranslationWithPreferredAdminLanguage public function Tests translation with URL and Preferred Admin Language negotiators.
ConfigurableLanguageManagerTest::testUrlContentTranslationWithSessionLanguage public function Tests translation with URL and Session Language Negotiators.
ConfigurableLanguageManagerTest::testUserProfileTranslationWithPreferredAdminLanguage public function Tests translation of the user profile edit form.
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::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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. 28
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
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::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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
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::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated 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. 2
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. 5
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 Deprecated public static function Returns the database connection to the site under 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.
WaitTerminateTestTrait::setWaitForTerminate protected function Specify that subsequent requests must wait for the terminate event.
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.