class LinksetControllerMultiLingualTest

Same name in other branches
  1. 10 core/modules/system/tests/src/Functional/Menu/LinksetControllerMultiLingualTest.php \Drupal\Tests\system\Functional\Menu\LinksetControllerMultiLingualTest

Tests the behavior of the linkset controller in multilingual setup.

@group decoupled_menus

Hierarchy

Expanded class hierarchy of LinksetControllerMultiLingualTest

See also

https://tools.ietf.org/html/draft-ietf-httpapi-linkset-00

File

core/modules/system/tests/src/Functional/Menu/LinksetControllerMultiLingualTest.php, line 22

Namespace

Drupal\Tests\system\Functional\Menu
View source
final class LinksetControllerMultiLingualTest extends LinksetControllerTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected $profile = 'minimal';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
    ];
    
    /**
     * An HTTP kernel.
     *
     * Used to send a test request to the controller under test and validate its
     * response.
     *
     * @var \Symfony\Component\HttpKernel\HttpKernelInterface
     */
    protected $httpKernel;
    
    /**
     * A user account to author test content.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $authorAccount;
    
    /**
     * Test set up.
     *
     * Installs necessary database schemas, then creates test content and menu
     * items. The concept of this set up is to replicate a typical site's menus.
     *
     * @throws \Drupal\Core\Entity\EntityStorageException
     */
    public function setUp() : void {
        parent::setUp();
        // Create Basic page node type.
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Basic page',
        ]);
        // Add some custom languages.
        foreach ([
            'aa',
            'bb',
            'cc',
            'dd',
        ] as $index => $language_code) {
            ConfigurableLanguage::create([
                'id' => $language_code,
                'label' => $this->randomMachineName(),
                'weight' => $index,
            ])
                ->save();
        }
        // Set up an admin user with appropriate permissions.
        $admin_user = $this->drupalCreateUser([
            'view own unpublished content',
            'administer languages',
            'administer content types',
            'access administration pages',
            'create page content',
            'edit own page content',
        ]);
        $this->drupalLogin($admin_user);
        $config = $this->config('language.types');
        $config->set('configurable', [
            LanguageInterface::TYPE_INTERFACE,
        ]);
        $config->set('negotiation.language_content.enabled', [
            LanguageNegotiationUrl::METHOD_ID => 1,
            LanguageNegotiationSelected::METHOD_ID => 1,
        ]);
        $config->save();
        \Drupal::configFactory()->getEditable('language.negotiation')
            ->set('url.prefixes.aa', 'aa')
            ->set('url.prefixes.bb', 'bb')
            ->set('url.prefixes.cc', 'cc')
            ->set('selected_langcode', 'dd')
            ->save();
        // Set default language code for content type page to 'dd'.
        ContentLanguageSettings::loadByEntityTypeBundle('node', 'page')->setDefaultLangcode('dd')
            ->setLanguageAlterable(TRUE)
            ->save();
        // Set default language code to for menu_link_content 'dd'.
        ContentLanguageSettings::loadByEntityTypeBundle('menu_link_content', 'menu_link_content')->setDefaultLangcode('dd')
            ->setLanguageAlterable(TRUE)
            ->save();
        $this->config('system.feature_flags')
            ->set('linkset_endpoint', TRUE)
            ->save(TRUE);
        // Using rebuildIfNeeded here to implicitly test that router is only rebuilt
        // when necessary.
        $this->rebuildIfNeeded();
        $this->drupalLogout();
        $permissions = [
            'view own unpublished content',
        ];
        $this->authorAccount = $this->setUpCurrentUser([
            'name' => 'author',
            'pass' => 'authorPass',
        ], $permissions);
        // Generate some data which we can test against.
        $home_page_link = $this->createMenuItem([
            'title' => 'Home',
            'description' => 'Links to the home page.',
            'link' => 'internal:/<front>',
            'weight' => 0,
            'menu_name' => 'main',
        ]);
        // Multilingual test.
        $multi_lingual_node = $this->createNode([
            'nid' => 1,
            'title' => 'A multi-lingual-node',
            'type' => 'page',
            'path' => '/multi-lingual-node',
        ]);
        $multi_lingual_menu_item = $this->createMenuItem([
            'title' => 'A multi-lingual-node',
            'link' => 'entity:node/' . (int) $multi_lingual_node->id(),
            'menu_name' => 'main',
            'weight' => $home_page_link->getWeight() + 1,
        ]);
        foreach ([
            'aa',
            'bb',
            'cc',
        ] as $language_code) {
            $multi_lingual_menu_item->addTranslation($language_code, [
                'title' => $language_code . '|' . 'A multi-lingual-node',
            ]);
            $multi_lingual_menu_item->save();
        }
        // Multilingual Menu item with missing language using `entity:` route.
        $multi_lingual_node = $this->createNode([
            'nid' => 2,
            'title' => 'A multi-lingual-node',
            'type' => 'page',
            'path' => '/multi-lingual-node-two',
        ]);
        $multi_lingual_menu_item = $this->createMenuItem([
            'title' => 'Second multi-lingual-node',
            'link' => 'entity:node/' . (int) $multi_lingual_node->id(),
            'menu_name' => 'main',
            'weight' => $home_page_link->getWeight() + 2,
        ]);
        foreach ([
            'aa',
            'bb',
        ] as $language_code) {
            $multi_lingual_menu_item->addTranslation($language_code, [
                'title' => $language_code . '|' . 'Second multi-lingual-node',
            ]);
            $multi_lingual_menu_item->save();
        }
        // Multilingual Menu item with missing language using `internal` route.
        $multi_lingual_node = $this->createNode([
            'nid' => 3,
            'title' => 'A multi-lingual-node',
            'type' => 'page',
            'path' => '/multi-lingual-node-three',
        ]);
        $multi_lingual_menu_item = $this->createMenuItem([
            'title' => 'Third multi-lingual-node',
            'link' => 'internal:/node/' . (int) $multi_lingual_node->id(),
            'menu_name' => 'main',
            'weight' => $home_page_link->getWeight() + 3,
        ]);
        foreach ([
            'aa',
            'bb',
        ] as $language_code) {
            $multi_lingual_menu_item->addTranslation($language_code, [
                'title' => $language_code . '|' . 'Third multi-lingual-node',
            ]);
            $multi_lingual_menu_item->save();
        }
        $this->httpKernel = $this->container
            ->get('http_kernel');
    }
    
    /**
     * Test core functions of the linkset for multilingual behavior.
     *
     * @throws \Exception
     */
    public function testBasicMultilingualFunctions() : void {
        foreach ([
            'aa',
            'bb',
            'cc',
            'dd',
        ] as $language_code) {
            $expected_linkset = $this->getReferenceLinksetDataFromFile(__DIR__ . '/../../../fixtures/linkset/linkset-menu-main-multilingual-' . $language_code . '.json');
            $response = $this->doRequest('GET', Url::fromUri('base:/' . $language_code . '/system/menu/main/linkset'));
            $this->assertSame($expected_linkset, Json::decode((string) $response->getBody()));
        }
    }
    
    /**
     * Test core functions of the linkset for multilingual behavior.
     *
     * @throws \Exception
     */
    public function testDefaultMultilingualFunctions() : void {
        $expected_linkset = $this->getReferenceLinksetDataFromFile(__DIR__ . '/../../../fixtures/linkset/linkset-menu-main-multilingual-default.json');
        $response = $this->doRequest('GET', Url::fromUri('base:/system/menu/main/linkset'));
        $this->assertSame($expected_linkset, Json::decode((string) $response->getBody()));
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
ApiRequestTrait::decorateWithXdebugCookie protected function Adds the Xdebug cookie to the request options.
ApiRequestTrait::makeApiRequest protected function Performs an HTTP request. Wraps the Guzzle HTTP client. 1
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::$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
LinksetControllerMultiLingualTest::$authorAccount protected property A user account to author test content.
LinksetControllerMultiLingualTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LinksetControllerMultiLingualTest::$httpKernel protected property An HTTP kernel.
LinksetControllerMultiLingualTest::$modules protected static property Modules to install. Overrides LinksetControllerTestBase::$modules
LinksetControllerMultiLingualTest::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
LinksetControllerMultiLingualTest::setUp public function Test set up. Overrides BrowserTestBase::setUp
LinksetControllerMultiLingualTest::testBasicMultilingualFunctions public function Test core functions of the linkset for multilingual behavior.
LinksetControllerMultiLingualTest::testDefaultMultilingualFunctions public function Test core functions of the linkset for multilingual behavior.
LinksetControllerTestBase::assertDrupalResponseCacheability protected function Helper to assert a cacheable value matches an expectation.
LinksetControllerTestBase::createMenuItem protected function Creates, saves, and returns a new menu link content entity.
LinksetControllerTestBase::doRequest protected function Sends a request to the kernel and makes basic response assertions.
LinksetControllerTestBase::enableEndpoint protected function Enables or disables the menu linkset endpoint.
LinksetControllerTestBase::getReferenceLinksetDataFromFile protected function Retrieve reference linkset controller output adjusted for proper base URL.
LinksetControllerTestBase::rebuildIfNeeded public function Rebuild the router only if needed.
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.
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.
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.