You are here

class LanguageTest in Token 8

Tests language tokens.

@group token

Hierarchy

Expanded class hierarchy of LanguageTest

File

tests/src/Kernel/LanguageTest.php, line 16

Namespace

Drupal\Tests\token\Kernel
View source
class LanguageTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'language',
    'token',
  ];

  /**
   * Language codes of languages to enable during the test.
   *
   * @var array
   */
  protected $langcodes = [
    'bg',
    'hu',
    'nl',
    'pt-pt',
  ];

  /**
   * An array of languages used during the test, keyed by language code.
   *
   * @var \Drupal\language\Entity\ConfigurableLanguage[]
   */
  protected $languages = [];

  /**
   * Language prefixes used during the test.
   *
   * @var array
   */
  protected $language_prefixes = [];

  /**
   * Language domains used during the test.
   *
   * @var array
   */
  protected $language_domains = [];

  /**
   * The token replacement service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * The mock language manager service.
   *
   * @var \Drupal\Tests\token\Kernel\MockLanguageManager
   */
  protected $languageManager;

  /**
   * {@inheritdoc}
   */
  public function register(ContainerBuilder $container) {
    parent::register($container);

    // Use Portuguese as the default language during the test. We're not using
    // English so we can detect if the default language is correctly honored.
    $language = Language::$defaultValues;
    $language['id'] = 'pt-pt';
    $language['name'] = 'Portuguese, Portugal';
    $container
      ->setParameter('language.default_values', $language);
    $this->container
      ->register('language.default', 'Drupal\\Core\\Language\\LanguageDefault')
      ->addArgument('%language.default_values%');
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->token = $this->container
      ->get('token');

    // Use a version of the language manager in which the various languages can
    // be easily overridden during the test. We need to do this here instead of
    // in ::register() since the container is being altered by
    // LanguageServiceProvider::alter() after the services have been registered.
    $this->languageManager = new MockLanguageManager($this->container
      ->get('language.default'), $this->container
      ->get('config.factory'), $this->container
      ->get('module_handler'), $this->container
      ->get('language.config_factory_override'), $this->container
      ->get('request_stack'));
    $this->container
      ->set('language_manager', $this->languageManager);
    foreach ($this->langcodes as $langcode) {

      // Enable test languages.
      $this->languages[$langcode] = ConfigurableLanguage::createFromLangcode($langcode);
      $this->languages[$langcode]
        ->save();

      // Populate language prefixes and domains to use in the test.
      $this->language_prefixes[$langcode] = "{$langcode}-prefix";
      $this->language_domains[$langcode] = $langcode . '.example.com';
    }

    // Set language negotiation prefixes and domains to values that are uniquely
    // identifiable in the test.
    $language_negotiation_config = $this
      ->config('language.negotiation');
    $language_negotiation_config
      ->set('url.prefixes', $this->language_prefixes);
    $language_negotiation_config
      ->set('url.domains', $this->language_domains);
    $language_negotiation_config
      ->save();
  }

  /**
   * Tests the language tokens.
   *
   * @dataProvider languageTokenReplacementDataProvider
   */
  public function testLanguageTokenReplacement($token, $langcode, $expected_result) {
    $bubbleable_metadata = new BubbleableMetadata();
    $options = $langcode ? [
      'langcode' => $langcode,
    ] : [];

    // The part of the token name between the last `:` and the closing bracket
    // is the machine name of the token.
    preg_match('/\\[.+:(.+)\\]/', $token, $matches);
    $name = $matches[1];
    $replacements = $this->token
      ->generate('language', [
      $name => $token,
    ], [], $options, $bubbleable_metadata);
    $this
      ->assertEquals($expected_result, $replacements[$token]);
  }

  /**
   * Tests retrieving the interface and content language from the current page.
   *
   * @dataProvider currentPageLanguageTokenReplacementDataProvider
   */
  public function testCurrentPageLanguageTokenReplacement($token, $langcode, $expected_result) {

    // Set the interface language to Dutch.
    $this->languageManager
      ->setCurrentLanguage(LanguageInterface::TYPE_INTERFACE, $this->languages['nl']);

    // Set the content language to Hungarian.
    $this->languageManager
      ->setCurrentLanguage(LanguageInterface::TYPE_CONTENT, $this->languages['hu']);
    $options = $langcode ? [
      'langcode' => $langcode,
    ] : [];
    $result = $this->token
      ->replace($token, [], $options);
    $this
      ->assertEquals($expected_result, $result);
  }

  /**
   * Provides test data for ::testLanguageTokenReplacement().
   *
   * @return array
   *   An array of test cases. Each test case is an array with the following
   *   values:
   *   - The token to test.
   *   - An optional language code to pass as an option.
   *   - The expected result of the token replacement.
   *
   * @see testLanguageTokenReplacement()
   */
  public function languageTokenReplacementDataProvider() {
    return [
      [
        // Test the replacement of the name of the site default language.
        '[language:name]',
        // We are not overriding the language by passing a language code as an
        // option. This means that the default language should be used which has
        // been set to Portuguese.
        NULL,
        // The expected result.
        'Portuguese, Portugal',
      ],
      // Test the replacement of the other properties of the default language.
      [
        '[language:langcode]',
        NULL,
        'pt-pt',
      ],
      [
        '[language:direction]',
        NULL,
        'ltr',
      ],
      [
        '[language:domain]',
        NULL,
        'pt-pt.example.com',
      ],
      [
        '[language:prefix]',
        NULL,
        'pt-pt-prefix',
      ],
      // Now repeat the entire test but override the language to use by passing
      // Bulgarian as an option.
      [
        '[language:name]',
        'bg',
        'Bulgarian',
      ],
      [
        '[language:langcode]',
        'bg',
        'bg',
      ],
      [
        '[language:direction]',
        'bg',
        'ltr',
      ],
      [
        '[language:domain]',
        'bg',
        'bg.example.com',
      ],
      [
        '[language:prefix]',
        'bg',
        'bg-prefix',
      ],
    ];
  }

  /**
   * Provides test data for ::testCurrentPageLanguageTokenReplacement().
   *
   * @return array
   *   An array of test cases. Each test case is an array with the following
   *   values:
   *   - The token to test.
   *   - An optional language code to pass as an option.
   *   - The expected result of the token replacement.
   *
   * @see testCurrentPageLanguageTokenReplacement()
   */
  public function currentPageLanguageTokenReplacementDataProvider() {
    return [
      [
        // Test the replacement of the language name token, taken from the
        // interface language of the current page.
        '[current-page:interface-language:name]',
        // We are not overriding the language by passing a language code as an
        // option. This means that the language should be taken from the
        // interface language which has been set to Dutch.
        NULL,
        // The expected result.
        'Dutch',
      ],
      // Test the token name in the content language.
      [
        '[current-page:content-language:name]',
        NULL,
        'Hungarian',
      ],
      // Test the other tokens both for the content and interface languages.
      [
        '[current-page:interface-language:langcode]',
        NULL,
        'nl',
      ],
      [
        '[current-page:content-language:langcode]',
        NULL,
        'hu',
      ],
      [
        '[current-page:interface-language:direction]',
        NULL,
        'ltr',
      ],
      [
        '[current-page:content-language:direction]',
        NULL,
        'ltr',
      ],
      [
        '[current-page:interface-language:domain]',
        NULL,
        'nl.example.com',
      ],
      [
        '[current-page:content-language:domain]',
        NULL,
        'hu.example.com',
      ],
      [
        '[current-page:interface-language:prefix]',
        NULL,
        'nl-prefix',
      ],
      [
        '[current-page:content-language:prefix]',
        NULL,
        'hu-prefix',
      ],
      // Now repeat the entire test with Bulgarian passed as an option. This
      // should not affect the results, the language should be sourced from the
      // current page.
      [
        // Test the replacement of the language name token, taken from the
        // interface language of the current page.
        '[current-page:interface-language:name]',
        // We are not overriding the language by passing a language code as an
        // option. This means that the language should be taken from the
        // interface language which has been set to Dutch.
        'bg',
        // The expected result.
        'Dutch',
      ],
      // Test the token name in the content language.
      [
        '[current-page:content-language:name]',
        'bg',
        'Hungarian',
      ],
      // Test the other tokens both for the content and interface languages.
      [
        '[current-page:interface-language:langcode]',
        'bg',
        'nl',
      ],
      [
        '[current-page:content-language:langcode]',
        'bg',
        'hu',
      ],
      [
        '[current-page:interface-language:direction]',
        'bg',
        'ltr',
      ],
      [
        '[current-page:content-language:direction]',
        'bg',
        'ltr',
      ],
      [
        '[current-page:interface-language:domain]',
        'bg',
        'nl.example.com',
      ],
      [
        '[current-page:content-language:domain]',
        'bg',
        'hu.example.com',
      ],
      [
        '[current-page:interface-language:prefix]',
        'bg',
        'nl-prefix',
      ],
      [
        '[current-page:content-language:prefix]',
        'bg',
        'hu-prefix',
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
LanguageTest::$langcodes protected property Language codes of languages to enable during the test.
LanguageTest::$languageManager protected property The mock language manager service.
LanguageTest::$languages protected property An array of languages used during the test, keyed by language code.
LanguageTest::$language_domains protected property Language domains used during the test.
LanguageTest::$language_prefixes protected property Language prefixes used during the test.
LanguageTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
LanguageTest::$token protected property The token replacement service.
LanguageTest::currentPageLanguageTokenReplacementDataProvider public function Provides test data for ::testCurrentPageLanguageTokenReplacement().
LanguageTest::languageTokenReplacementDataProvider public function Provides test data for ::testLanguageTokenReplacement().
LanguageTest::register public function Registers test-specific services. Overrides KernelTestBase::register
LanguageTest::setUp protected function Overrides KernelTestBase::setUp
LanguageTest::testCurrentPageLanguageTokenReplacement public function Tests retrieving the interface and content language from the current page.
LanguageTest::testLanguageTokenReplacement public function Tests the language tokens.
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.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TokenTestTrait::assertNoTokens function
TokenTestTrait::assertPageTokens function Make a page request and test for token generation.
TokenTestTrait::assertToken function
TokenTestTrait::assertTokens function
TokenTestTrait::mapTokenNames function
TokenTestTrait::saveAlias function
TokenTestTrait::saveEntityAlias function