class LanguageNegotiationUrlTest
Same name in this branch
- 11.x core/modules/language/tests/src/Functional/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Functional\LanguageNegotiationUrlTest
Same name in other branches
- 9 core/modules/language/tests/src/Unit/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Unit\LanguageNegotiationUrlTest
- 9 core/modules/language/tests/src/Functional/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Functional\LanguageNegotiationUrlTest
- 8.9.x core/modules/language/tests/src/Unit/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Unit\LanguageNegotiationUrlTest
- 8.9.x core/modules/language/tests/src/Functional/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Functional\LanguageNegotiationUrlTest
- 10 core/modules/language/tests/src/Unit/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Unit\LanguageNegotiationUrlTest
- 10 core/modules/language/tests/src/Functional/LanguageNegotiationUrlTest.php \Drupal\Tests\language\Functional\LanguageNegotiationUrlTest
@coversDefaultClass \Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl @group language
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\language\Unit\LanguageNegotiationUrlTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of LanguageNegotiationUrlTest
File
-
core/
modules/ language/ tests/ src/ Unit/ LanguageNegotiationUrlTest.php, line 19
Namespace
Drupal\Tests\language\UnitView source
class LanguageNegotiationUrlTest extends UnitTestCase {
protected $languageManager;
protected $user;
protected array $languages;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
// Set up some languages to be used by the language-based path processor.
$language_de = $this->createMock('\\Drupal\\Core\\Language\\LanguageInterface');
$language_de->expects($this->any())
->method('getId')
->willReturn('de');
$language_en = $this->createMock('\\Drupal\\Core\\Language\\LanguageInterface');
$language_en->expects($this->any())
->method('getId')
->willReturn('en');
$languages = [
'de' => $language_de,
'en' => $language_en,
];
$this->languages = $languages;
// Create a language manager stub.
$language_manager = $this->getMockBuilder('Drupal\\language\\ConfigurableLanguageManagerInterface')
->getMock();
$language_manager->expects($this->any())
->method('getLanguages')
->willReturn($languages);
$this->languageManager = $language_manager;
// Create a user stub.
$this->user = $this->getMockBuilder('Drupal\\Core\\Session\\AccountInterface')
->getMock();
$cache_contexts_manager = $this->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
->disableOriginalConstructor()
->getMock();
$cache_contexts_manager->method('assertValidTokens')
->willReturn(TRUE);
$container = new ContainerBuilder();
$container->set('cache_contexts_manager', $cache_contexts_manager);
\Drupal::setContainer($container);
}
/**
* Tests path prefix language negotiation and outbound path processing.
*
* @dataProvider providerTestPathPrefix
*/
public function testPathPrefix($prefix, $prefixes, $expected_langcode) : void {
$this->languageManager
->expects($this->any())
->method('getCurrentLanguage')
->willReturn($this->languages[in_array($expected_langcode, [
'en',
'de',
]) ? $expected_langcode : 'en']);
$config = $this->getConfigFactoryStub([
'language.negotiation' => [
'url' => [
'source' => LanguageNegotiationUrl::CONFIG_PATH_PREFIX,
'prefixes' => $prefixes,
],
],
]);
$request = Request::create('/' . $prefix . '/foo', 'GET');
$method = new LanguageNegotiationUrl();
$method->setLanguageManager($this->languageManager);
$method->setConfig($config);
$method->setCurrentUser($this->user);
$this->assertEquals($expected_langcode, $method->getLangcode($request));
$cacheability = new BubbleableMetadata();
$options = [];
$method->processOutbound('foo', $options, $request, $cacheability);
$expected_cacheability = new BubbleableMetadata();
if ($expected_langcode) {
$this->assertSame($prefix . '/', $options['prefix']);
$expected_cacheability->setCacheContexts([
'languages:' . LanguageInterface::TYPE_URL,
]);
}
else {
$this->assertFalse(isset($options['prefix']));
}
$this->assertEquals($expected_cacheability, $cacheability);
}
/**
* Provides data for the path prefix test.
*
* @return array
* An array of data for checking path prefix negotiation.
*/
public static function providerTestPathPrefix() {
$path_prefix_configuration[] = [
'prefix' => 'de',
'prefixes' => [
'de' => 'de',
'en-uk' => 'en',
],
'expected_langcode' => 'de',
];
$path_prefix_configuration[] = [
'prefix' => 'en-uk',
'prefixes' => [
'de' => 'de',
'en' => 'en-uk',
],
'expected_langcode' => 'en',
];
// No configuration.
$path_prefix_configuration[] = [
'prefix' => 'de',
'prefixes' => [],
'expected_langcode' => FALSE,
];
// Non-matching prefix.
$path_prefix_configuration[] = [
'prefix' => 'de',
'prefixes' => [
'en-uk' => 'en',
],
'expected_langcode' => FALSE,
];
// Non-existing language.
$path_prefix_configuration[] = [
'prefix' => 'it',
'prefixes' => [
'it' => 'it',
'en-uk' => 'en',
],
'expected_langcode' => FALSE,
];
return $path_prefix_configuration;
}
/**
* Tests outbound path processing for neutral languages.
*
* @dataProvider providerNeutralLanguages
*/
public function testNeutralLanguages($langcode, $expected_langcode) : void {
if ($expected_langcode) {
$this->languageManager
->expects($this->once())
->method('getCurrentLanguage')
->willReturn($this->languages['en']);
}
$config = $this->getConfigFactoryStub([
'language.negotiation' => [
'url' => [
'source' => LanguageNegotiationUrl::CONFIG_PATH_PREFIX,
'prefixes' => [
'de' => 'de',
'en' => 'en',
],
],
],
]);
$request = Request::create('/foo', 'GET');
$method = new LanguageNegotiationUrl();
$method->setLanguageManager($this->languageManager);
$method->setConfig($config);
$method->setCurrentUser($this->user);
$this->assertNull($method->getLangcode($request));
$language = $this->createMock(LanguageInterface::class);
$language->expects($this->any())
->method('getId')
->willReturn($langcode);
$cacheability = new BubbleableMetadata();
$options = [
'language' => $language,
];
$method->processOutbound('foo', $options, $request, $cacheability);
$expected_cacheability = new BubbleableMetadata();
if ($expected_langcode) {
$this->assertSame($expected_langcode . '/', $options['prefix']);
$expected_cacheability->setCacheContexts([
'languages:' . LanguageInterface::TYPE_URL,
]);
}
else {
$this->assertFalse(isset($options['prefix']));
}
$this->assertEquals($expected_cacheability, $cacheability);
}
/**
* Provides data for the neutral language test.
*
* @return array
* An array of data for checking path prefix negotiation for neutral
* languages.
*/
public static function providerNeutralLanguages() {
return [
[
LanguageInterface::LANGCODE_NOT_APPLICABLE,
NULL,
],
[
LanguageInterface::LANGCODE_NOT_SPECIFIED,
'en',
],
];
}
/**
* Tests domain language negotiation and outbound path processing.
*
* @dataProvider providerTestDomain
*/
public function testDomain($http_host, $domains, $expected_langcode) : void {
$this->languageManager
->expects($this->any())
->method('getCurrentLanguage')
->willReturn($this->languages['en']);
$config = $this->getConfigFactoryStub([
'language.negotiation' => [
'url' => [
'source' => LanguageNegotiationUrl::CONFIG_DOMAIN,
'domains' => $domains,
],
],
]);
$request = Request::create('', 'GET', [], [], [], [
'HTTP_HOST' => $http_host,
]);
$method = new LanguageNegotiationUrl();
$method->setLanguageManager($this->languageManager);
$method->setConfig($config);
$method->setCurrentUser($this->user);
$this->assertEquals($expected_langcode, $method->getLangcode($request));
$cacheability = new BubbleableMetadata();
$options = [];
$this->assertSame('foo', $method->processOutbound('foo', $options, $request, $cacheability));
$expected_cacheability = new BubbleableMetadata();
if ($expected_langcode !== FALSE && count($domains) > 1) {
$expected_cacheability->setCacheMaxAge(Cache::PERMANENT)
->setCacheContexts([
'languages:' . LanguageInterface::TYPE_URL,
'url.site',
]);
}
$this->assertEquals($expected_cacheability, $cacheability);
}
/**
* Provides data for the domain test.
*
* @return array
* An array of data for checking domain negotiation.
*/
public static function providerTestDomain() {
$domain_configuration[] = [
'http_host' => 'example.de',
'domains' => [
'de' => 'http://example.de',
],
'expected_langcode' => 'de',
];
// No configuration.
$domain_configuration[] = [
'http_host' => 'example.de',
'domains' => [],
'expected_langcode' => FALSE,
];
// HTTP host with a port.
$domain_configuration[] = [
'http_host' => 'example.de:8080',
'domains' => [
'de' => 'http://example.de',
],
'expected_langcode' => 'de',
];
// Domain configuration with https://.
$domain_configuration[] = [
'http_host' => 'example.de',
'domains' => [
'de' => 'https://example.de',
],
'expected_langcode' => 'de',
];
// Non-matching HTTP host.
$domain_configuration[] = [
'http_host' => 'example.com',
'domains' => [
'de' => 'http://example.com',
],
'expected_langcode' => 'de',
];
// Testing a non-existing language.
$domain_configuration[] = [
'http_host' => 'example.com',
'domains' => [
'it' => 'http://example.it',
],
'expected_langcode' => FALSE,
];
// Multiple domain configurations.
$domain_configuration[] = [
'http_host' => 'example.com',
'domains' => [
'de' => 'http://example.de',
'en' => 'http://example.com',
],
'expected_langcode' => 'en',
];
return $domain_configuration;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
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. | |
LanguageNegotiationUrlTest::$languageManager | protected | property | ||
LanguageNegotiationUrlTest::$languages | protected | property | ||
LanguageNegotiationUrlTest::$user | protected | property | ||
LanguageNegotiationUrlTest::providerNeutralLanguages | public static | function | Provides data for the neutral language test. | |
LanguageNegotiationUrlTest::providerTestDomain | public static | function | Provides data for the domain test. | |
LanguageNegotiationUrlTest::providerTestPathPrefix | public static | function | Provides data for the path prefix test. | |
LanguageNegotiationUrlTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
LanguageNegotiationUrlTest::testDomain | public | function | Tests domain language negotiation and outbound path processing. | |
LanguageNegotiationUrlTest::testNeutralLanguages | public | function | Tests outbound path processing for neutral languages. | |
LanguageNegotiationUrlTest::testPathPrefix | public | function | Tests path prefix language negotiation and outbound path processing. | |
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. | |
UnitTestCase::$root | protected | property | The app root. | |
UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |
UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase::getConfigStorageStub | public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.