class PathLanguageTest

Same name in other branches
  1. 9 core/modules/path/tests/src/Functional/PathLanguageTest.php \Drupal\Tests\path\Functional\PathLanguageTest
  2. 8.9.x core/modules/path/tests/src/Functional/PathLanguageTest.php \Drupal\Tests\path\Functional\PathLanguageTest
  3. 11.x core/modules/path/tests/src/Functional/PathLanguageTest.php \Drupal\Tests\path\Functional\PathLanguageTest

Confirm that paths work with translated nodes.

@group path

Hierarchy

Expanded class hierarchy of PathLanguageTest

File

core/modules/path/tests/src/Functional/PathLanguageTest.php, line 18

Namespace

Drupal\Tests\path\Functional
View source
class PathLanguageTest extends PathTestBase {
    use ContentTranslationTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'path',
        'locale',
        'locale_test',
        'content_translation',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * A user with permissions to administer content types.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $webUser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $permissions = [
            'access administration pages',
            'administer content translation',
            'administer content types',
            'administer languages',
            'administer url aliases',
            'create content translations',
            'create page content',
            'create url aliases',
            'edit any page content',
            'translate any entity',
        ];
        // Create and log in user.
        $this->webUser = $this->drupalCreateUser($permissions);
        $this->drupalLogin($this->webUser);
        // Enable French language.
        static::createLanguageFromLangcode('fr');
        // Enable URL language detection and selection.
        $this->container
            ->get('language_negotiator')
            ->saveConfiguration(LanguageInterface::TYPE_URL, [
            LanguageNegotiationUrl::METHOD_ID => 1,
        ]);
        // Enable translation for page node.
        static::enableContentTranslation('node', 'page');
        static::setFieldTranslatable('node', 'page', 'body', TRUE);
        $definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('node', 'page');
        $this->assertTrue($definitions['path']->isTranslatable(), 'Node path is translatable.');
        $this->assertTrue($definitions['body']->isTranslatable(), 'Node body is translatable.');
    }
    
    /**
     * Tests alias functionality through the admin interfaces.
     */
    public function testAliasTranslation() : void {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $english_node = $this->drupalCreateNode([
            'type' => 'page',
            'langcode' => 'en',
        ]);
        $english_alias = $this->randomMachineName();
        // Edit the node to set language and path.
        $edit = [];
        $edit['path[0][alias]'] = '/' . $english_alias;
        $this->drupalGet('node/' . $english_node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Confirm that the alias works.
        $this->drupalGet($english_alias);
        $this->assertSession()
            ->pageTextContains($english_node->body->value);
        // Translate the node into French.
        $this->drupalGet('node/' . $english_node->id() . '/translations');
        $this->clickLink('Add');
        $edit = [];
        $edit['title[0][value]'] = $this->randomMachineName();
        $edit['body[0][value]'] = $this->randomMachineName();
        $french_alias = $this->randomMachineName();
        $edit['path[0][alias]'] = '/' . $french_alias;
        $this->submitForm($edit, 'Save (this translation)');
        // Clear the path lookup cache.
        $this->container
            ->get('path_alias.manager')
            ->cacheClear();
        // Languages are cached on many levels, and we need to clear those caches.
        $this->container
            ->get('language_manager')
            ->reset();
        $this->rebuildContainer();
        $languages = $this->container
            ->get('language_manager')
            ->getLanguages();
        // Ensure the node was created.
        $node_storage->resetCache([
            $english_node->id(),
        ]);
        $english_node = $node_storage->load($english_node->id());
        $english_node_french_translation = $english_node->getTranslation('fr');
        $this->assertTrue($english_node->hasTranslation('fr'), 'Node found in database.');
        // Confirm that the alias works.
        $this->drupalGet('fr' . $edit['path[0][alias]']);
        $this->assertSession()
            ->pageTextContains($english_node_french_translation->body->value);
        // Confirm that the alias is returned for the URL. Languages are cached on
        // many levels, and we need to clear those caches.
        $this->container
            ->get('language_manager')
            ->reset();
        $languages = $this->container
            ->get('language_manager')
            ->getLanguages();
        $url = $english_node_french_translation->toUrl('canonical', [
            'language' => $languages['fr'],
        ])
            ->toString();
        $this->assertStringContainsString($edit['path[0][alias]'], $url, 'URL contains the path alias.');
        // Confirm that the alias works even when changing language negotiation
        // options. Enable User language detection and selection over URL one.
        $this->container
            ->get('language_negotiator')
            ->saveConfiguration(LanguageInterface::TYPE_INTERFACE, [
            LanguageNegotiationUser::METHOD_ID => 1,
        ]);
        $this->container
            ->get('language_negotiator')
            ->saveConfiguration(LanguageInterface::TYPE_URL, [
            LanguageNegotiationUrl::METHOD_ID => 1,
        ]);
        // Change user language preference.
        $user = User::load($this->webUser
            ->id());
        $user->set('preferred_langcode', 'fr');
        $user->save();
        // Check that the English alias works. In this situation French is the
        // current UI and content language, while URL language is English (since we
        // do not have a path prefix we fall back to the site's default language).
        // We need to ensure that the user language preference is not taken into
        // account while determining the path alias language, because if this
        // happens we have no way to check that the path alias is valid: there is no
        // path alias for French matching the english alias. So the alias manager
        // needs to use the URL language to check whether the alias is valid.
        $this->drupalGet($english_alias);
        $this->assertSession()
            ->pageTextContains($english_node_french_translation->body->value);
        // Check that the French alias works.
        $this->drupalGet("fr/{$french_alias}");
        $this->assertSession()
            ->pageTextContains($english_node_french_translation->body->value);
        // Disable URL language negotiation.
        $this->container
            ->get('language_negotiator')
            ->saveConfiguration(LanguageInterface::TYPE_URL, [
            LanguageNegotiationUrl::METHOD_ID => FALSE,
        ]);
        // Check that the English alias still works.
        $this->drupalGet($english_alias);
        $this->assertSession()
            ->pageTextContains($english_node_french_translation->body->value);
        // Check that the French alias is not available. We check the unprefixed
        // alias because we disabled URL language negotiation above. In this
        // situation only aliases in the default language and language neutral ones
        // should keep working.
        $this->drupalGet($french_alias);
        $this->assertSession()
            ->statusCodeEquals(404);
        // The alias manager has an internal path lookup cache. Check to see that
        // it has the appropriate contents at this point.
        $this->container
            ->get('path_alias.manager')
            ->cacheClear();
        $french_node_path = $this->container
            ->get('path_alias.manager')
            ->getPathByAlias('/' . $french_alias, 'fr');
        $this->assertEquals('/node/' . $english_node_french_translation->id(), $french_node_path, 'Normal path works.');
        // Second call should return the same path.
        $french_node_path = $this->container
            ->get('path_alias.manager')
            ->getPathByAlias('/' . $french_alias, 'fr');
        $this->assertEquals('/node/' . $english_node_french_translation->id(), $french_node_path, 'Normal path is the same.');
        // Confirm that the alias works.
        $french_node_alias = $this->container
            ->get('path_alias.manager')
            ->getAliasByPath('/node/' . $english_node_french_translation->id(), 'fr');
        $this->assertEquals('/' . $french_alias, $french_node_alias, 'Alias works.');
        // Second call should return the same alias.
        $french_node_alias = $this->container
            ->get('path_alias.manager')
            ->getAliasByPath('/node/' . $english_node_french_translation->id(), 'fr');
        $this->assertEquals('/' . $french_alias, $french_node_alias, 'Alias is the same.');
        // Confirm that the alias is removed if the translation is deleted.
        $english_node->removeTranslation('fr');
        $english_node->save();
        $this->assertPathAliasNotExists('/' . $french_alias, 'fr', NULL, 'Alias for French translation is removed when translation is deleted.');
        // Check that the English alias still works.
        $this->drupalGet($english_alias);
        $this->assertPathAliasExists('/' . $english_alias, 'en', NULL, 'English alias is not deleted when French translation is removed.');
        $this->assertSession()
            ->pageTextContains($english_node->body->value);
    }

}

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.
ContentTranslationTestTrait::enableContentTranslation public function Enables content translation for the given entity type bundle.
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 '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. 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
LanguageTestTrait::createLanguageFromLangcode public static function Creates a configurable language object from a langcode.
LanguageTestTrait::disableBundleTranslation public static function Disables translations for the given entity type bundle.
LanguageTestTrait::enableBundleTranslation public static function Enables translations for the given entity type bundle.
LanguageTestTrait::setFieldTranslatable public static function Sets and saves a given field instance translation status.
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
PathAliasTestTrait::assertPathAliasExists protected function Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists protected function Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias protected function Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions protected function Gets the first result from a 'load by properties' storage call.
PathLanguageTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PathLanguageTest::$modules protected static property Modules to install. Overrides PathTestBase::$modules
PathLanguageTest::$webUser protected property A user with permissions to administer content types.
PathLanguageTest::setUp protected function Overrides PathTestBase::setUp
PathLanguageTest::testAliasTranslation public function Tests alias functionality through the admin interfaces.
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.
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.