class UserAdminLanguageTest

Same name in other branches
  1. 9 core/modules/user/tests/src/Functional/UserAdminLanguageTest.php \Drupal\Tests\user\Functional\UserAdminLanguageTest
  2. 8.9.x core/modules/user/tests/src/Functional/UserAdminLanguageTest.php \Drupal\Tests\user\Functional\UserAdminLanguageTest
  3. 10 core/modules/user/tests/src/Functional/UserAdminLanguageTest.php \Drupal\Tests\user\Functional\UserAdminLanguageTest

Tests users' ability to change their own administration language.

@group user

Hierarchy

Expanded class hierarchy of UserAdminLanguageTest

File

core/modules/user/tests/src/Functional/UserAdminLanguageTest.php, line 15

Namespace

Drupal\Tests\user\Functional
View source
class UserAdminLanguageTest extends BrowserTestBase {
    
    /**
     * A user with permission to access admin pages and administer languages.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * A non-administrator user for this test.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $regularUser;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'user',
        'language',
        'language_test',
        'user_language_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // User to add and remove language.
        $this->adminUser = $this->drupalCreateUser([
            'administer languages',
            'access administration pages',
        ]);
        // User to check non-admin access.
        $this->regularUser = $this->drupalCreateUser();
    }
    
    /**
     * Tests that admin language is not configurable in single language sites.
     */
    public function testUserAdminLanguageConfigurationNotAvailableWithOnlyOneLanguage() : void {
        $this->drupalLogin($this->adminUser);
        $this->setLanguageNegotiation();
        $path = 'user/' . $this->adminUser
            ->id() . '/edit';
        $this->drupalGet($path);
        // Ensure administration pages language settings widget is not available.
        $this->assertSession()
            ->fieldNotExists('edit-preferred-admin-langcode');
    }
    
    /**
     * Tests that admin language negotiation is configurable only if enabled.
     */
    public function testUserAdminLanguageConfigurationAvailableWithAdminLanguageNegotiation() : void {
        $this->drupalLogin($this->adminUser);
        $this->addCustomLanguage();
        $path = 'user/' . $this->adminUser
            ->id() . '/edit';
        // Checks with user administration pages language negotiation disabled.
        $this->drupalGet($path);
        // Ensure administration pages language settings widget is not available.
        $this->assertSession()
            ->fieldNotExists('edit-preferred-admin-langcode');
        // Checks with user administration pages language negotiation enabled.
        $this->setLanguageNegotiation();
        $this->drupalGet($path);
        // Ensure administration pages language settings widget is available.
        $this->assertSession()
            ->fieldExists('edit-preferred-admin-langcode');
    }
    
    /**
     * Tests that the admin language is configurable only for administrators.
     *
     * If a user has the permission "access administration pages" or
     * "view the administration theme", they should be able to see the setting to
     * pick the language they want those pages in.
     *
     * If a user does not have that permission, it would confusing for them to
     * have a setting for pages they cannot access, so they should not be able to
     * set a language for those pages.
     */
    public function testUserAdminLanguageConfigurationAvailableIfAdminLanguageNegotiationIsEnabled() : void {
        $this->drupalLogin($this->adminUser);
        // Adds a new language, because with only one language, setting won't show.
        $this->addCustomLanguage();
        $this->setLanguageNegotiation();
        $path = 'user/' . $this->adminUser
            ->id() . '/edit';
        $this->drupalGet($path);
        // Ensure administration pages language setting is visible for admin.
        $this->assertSession()
            ->fieldExists('edit-preferred-admin-langcode');
        // Ensure administration pages language setting is visible for editors.
        $editor = $this->drupalCreateUser([
            'view the administration theme',
        ]);
        $this->drupalLogin($editor);
        $path = 'user/' . $editor->id() . '/edit';
        $this->drupalGet($path);
        $this->assertSession()
            ->fieldExists('edit-preferred-admin-langcode');
        // Ensure administration pages language setting is hidden for non-admins.
        $this->drupalLogin($this->regularUser);
        $path = 'user/' . $this->regularUser
            ->id() . '/edit';
        $this->drupalGet($path);
        $this->assertSession()
            ->fieldNotExists('edit-preferred-admin-langcode');
    }
    
    /**
     * Tests the actual language negotiation.
     */
    public function testActualNegotiation() : void {
        $this->drupalLogin($this->adminUser);
        $this->addCustomLanguage();
        $this->setLanguageNegotiation();
        // Even though we have admin language negotiation, so long as the user has
        // no preference set, negotiation will fall back further.
        $path = 'user/' . $this->adminUser
            ->id() . '/edit';
        $this->drupalGet($path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-default');
        $this->drupalGet('xx/' . $path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-url');
        // Set a preferred language code for the user.
        $edit = [];
        $edit['preferred_admin_langcode'] = 'xx';
        $this->drupalGet($path);
        $this->submitForm($edit, 'Save');
        // Test negotiation with the URL method first. The admin method will only
        // be used if the URL method did not match.
        $this->drupalGet($path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-user-admin');
        $this->drupalGet('xx/' . $path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-url');
        // Test negotiation with the admin language method first. The admin method
        // will be used at all times.
        $this->setLanguageNegotiation(TRUE);
        $this->drupalGet($path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-user-admin');
        $this->drupalGet('xx/' . $path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-user-admin');
        // Make sure 'language-user-admin' plugin does not fail when a route is
        // restricted to POST requests and language negotiation with the admin
        // language method is used.
        $this->drupalGet('/user-language-test/form');
        $this->submitForm([], 'Send');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Unset the preferred language code for the user.
        $edit = [];
        $edit['preferred_admin_langcode'] = '';
        $this->drupalGet($path);
        $this->submitForm($edit, 'Save');
        $this->drupalGet($path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-default');
        $this->drupalGet('xx/' . $path);
        $this->assertSession()
            ->pageTextContains('Language negotiation method: language-url');
    }
    
    /**
     * Sets the User interface negotiation detection method.
     *
     * Enables the "Account preference for administration pages" language
     * detection method for the User interface language negotiation type.
     *
     * @param bool $admin_first
     *   Whether the admin negotiation should be first.
     */
    public function setLanguageNegotiation($admin_first = FALSE) : void {
        $edit = [
            'language_interface[enabled][language-user-admin]' => TRUE,
            'language_interface[enabled][language-url]' => TRUE,
            'language_interface[weight][language-user-admin]' => $admin_first ? -12 : -8,
            'language_interface[weight][language-url]' => -10,
        ];
        $this->drupalGet('admin/config/regional/language/detection');
        $this->submitForm($edit, 'Save settings');
    }
    
    /**
     * Helper method for adding a custom language.
     */
    public function addCustomLanguage() : void {
        $langcode = 'xx';
        // The English name for the language.
        $name = $this->randomMachineName(16);
        $edit = [
            'predefined_langcode' => 'custom',
            'langcode' => $langcode,
            'label' => $name,
            'direction' => LanguageInterface::DIRECTION_LTR,
        ];
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add custom language');
    }

}

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. 42
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 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
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
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.
UserAdminLanguageTest::$adminUser protected property A user with permission to access admin pages and administer languages.
UserAdminLanguageTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UserAdminLanguageTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
UserAdminLanguageTest::$regularUser protected property A non-administrator user for this test.
UserAdminLanguageTest::addCustomLanguage public function Helper method for adding a custom language.
UserAdminLanguageTest::setLanguageNegotiation public function Sets the User interface negotiation detection method.
UserAdminLanguageTest::setUp protected function Overrides BrowserTestBase::setUp
UserAdminLanguageTest::testActualNegotiation public function Tests the actual language negotiation.
UserAdminLanguageTest::testUserAdminLanguageConfigurationAvailableIfAdminLanguageNegotiationIsEnabled public function Tests that the admin language is configurable only for administrators.
UserAdminLanguageTest::testUserAdminLanguageConfigurationAvailableWithAdminLanguageNegotiation public function Tests that admin language negotiation is configurable only if enabled.
UserAdminLanguageTest::testUserAdminLanguageConfigurationNotAvailableWithOnlyOneLanguage public function Tests that admin language is not configurable in single language sites.
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.