You are here

Home » API reference » Drupal 9 » LocaleStringTest.php

class LocaleStringTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/locale/tests/src/Kernel/LocaleStringTest.php \Drupal\Tests\locale\Kernel\LocaleStringTest

Tests the locale string storage, string objects and data API.

@group locale

Hierarchy

Expanded class hierarchy of LocaleStringTest

File

core/modules/locale/tests/src/Kernel/LocaleStringTest.php, line 14

Namespace

Drupal\Tests\locale\Kernel
View source 
class LocaleStringTest extends KernelTestBase {

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

  /**
   * The locale storage.
   *
   * @var \Drupal\locale\StringStorageInterface
   */
  protected $storage;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Add a default locale storage for all these tests.
    $this->storage = $this->container
      ->get('locale.storage');

    // Create two languages: Spanish and German.
    foreach ([
      'es',
      'de',
    ] as $langcode) {
      ConfigurableLanguage::createFromLangcode($langcode)
        ->save();
    }
    $this
      ->installSchema('locale', [
      'locales_location',
      'locales_source',
      'locales_target',
    ]);
  }

  /**
   * Tests CRUD API.
   */
  public function testStringCrudApi() {

    // Create source string.
    $source = $this
      ->buildSourceString()
      ->save();
    $this
      ->assertNotEmpty($source->lid);

    // Load strings by lid and source.
    $string1 = $this->storage
      ->findString([
      'lid' => $source->lid,
    ]);
    $this
      ->assertEquals($source, $string1);
    $string2 = $this->storage
      ->findString([
      'source' => $source->source,
      'context' => $source->context,
    ]);
    $this
      ->assertEquals($source, $string2);
    $string3 = $this->storage
      ->findString([
      'source' => $source->source,
      'context' => '',
    ]);
    $this
      ->assertNull($string3);

    // Check version handling and updating.
    $this
      ->assertEquals('none', $source->version);
    $string = $this->storage
      ->findTranslation([
      'lid' => $source->lid,
    ]);
    $this
      ->assertEquals(\Drupal::VERSION, $string->version);

    // Create translation and find it by lid and source.
    $langcode = 'es';
    $translation = $this
      ->createTranslation($source, $langcode);
    $this
      ->assertEquals(LOCALE_NOT_CUSTOMIZED, $translation->customized);
    $string1 = $this->storage
      ->findTranslation([
      'language' => $langcode,
      'lid' => $source->lid,
    ]);
    $this
      ->assertEquals($translation->translation, $string1->translation);
    $string2 = $this->storage
      ->findTranslation([
      'language' => $langcode,
      'source' => $source->source,
      'context' => $source->context,
    ]);
    $this
      ->assertEquals($translation->translation, $string2->translation);
    $translation
      ->setCustomized()
      ->save();
    $translation = $this->storage
      ->findTranslation([
      'language' => $langcode,
      'lid' => $source->lid,
    ]);
    $this
      ->assertEquals(LOCALE_CUSTOMIZED, $translation->customized);

    // Delete translation.
    $translation
      ->delete();
    $deleted = $this->storage
      ->findTranslation([
      'language' => $langcode,
      'lid' => $source->lid,
    ]);
    $this
      ->assertNull($deleted->translation);

    // Create some translations and then delete string and all of its
    // translations.
    $lid = $source->lid;
    $this
      ->createAllTranslations($source);
    $search = $this->storage
      ->getTranslations([
      'lid' => $source->lid,
    ]);
    $this
      ->assertCount(3, $search);
    $source
      ->delete();
    $string = $this->storage
      ->findString([
      'lid' => $lid,
    ]);
    $this
      ->assertNull($string);
    $deleted = $search = $this->storage
      ->getTranslations([
      'lid' => $lid,
    ]);
    $this
      ->assertEmpty($deleted);

    // Tests that locations of different types and arbitrary lengths can be
    // added to a source string. Too long locations will be cut off.
    $source_string = $this
      ->buildSourceString();
    $source_string
      ->addLocation('javascript', $this
      ->randomString(8));
    $source_string
      ->addLocation('configuration', $this
      ->randomString(50));
    $source_string
      ->addLocation('code', $this
      ->randomString(100));
    $source_string
      ->addLocation('path', $location = $this
      ->randomString(300));
    $source_string
      ->save();
    $rows = $this->container
      ->get('database')
      ->select('locales_location')
      ->fields('locales_location')
      ->condition('sid', $source_string->lid)
      ->execute()
      ->fetchAllAssoc('type');
    $this
      ->assertCount(4, $rows);
    $this
      ->assertEquals(substr($location, 0, 255), $rows['path']->name);
  }

  /**
   * Tests Search API loading multiple objects.
   */
  public function testStringSearchApi() {
    $language_count = 3;

    // Strings 1 and 2 will have some common prefix.
    // Source 1 will have all translations, not customized.
    // Source 2 will have all translations, customized.
    // Source 3 will have no translations.
    $prefix = $this
      ->randomMachineName(100);
    $source1 = $this
      ->buildSourceString([
      'source' => $prefix . $this
        ->randomMachineName(100),
    ])
      ->save();
    $source2 = $this
      ->buildSourceString([
      'source' => $prefix . $this
        ->randomMachineName(100),
    ])
      ->save();
    $source3 = $this
      ->buildSourceString()
      ->save();

    // Load all source strings.
    $strings = $this->storage
      ->getStrings([]);
    $this
      ->assertCount(3, $strings);

    // Load all source strings matching a given string.
    $filter_options['filters'] = [
      'source' => $prefix,
    ];
    $strings = $this->storage
      ->getStrings([], $filter_options);
    $this
      ->assertCount(2, $strings);

    // Not customized translations.
    $translate1 = $this
      ->createAllTranslations($source1);

    // Customized translations.
    $this
      ->createAllTranslations($source2, [
      'customized' => LOCALE_CUSTOMIZED,
    ]);

    // Try quick search function with different field combinations.
    $langcode = 'es';
    $found = $this->storage
      ->findTranslation([
      'language' => $langcode,
      'source' => $source1->source,
      'context' => $source1->context,
    ]);
    $this
      ->assertNotNull($found, 'Translation not found searching by source and context.');
    $this
      ->assertNotNull($found->language);
    $this
      ->assertNotNull($found->translation);
    $this
      ->assertFalse($found
      ->isNew());
    $this
      ->assertEquals($translate1[$langcode]->translation, $found->translation);

    // Now try a translation not found.
    $found = $this->storage
      ->findTranslation([
      'language' => $langcode,
      'source' => $source3->source,
      'context' => $source3->context,
    ]);
    $this
      ->assertNotNull($found);
    $this
      ->assertSame($source3->lid, $found->lid);
    $this
      ->assertNull($found->translation);
    $this
      ->assertTrue($found
      ->isNew());

    // Load all translations. For next queries we'll be loading only translated
    // strings.
    $translations = $this->storage
      ->getTranslations([
      'translated' => TRUE,
    ]);
    $this
      ->assertCount(2 * $language_count, $translations);

    // Load all customized translations.
    $translations = $this->storage
      ->getTranslations([
      'customized' => LOCALE_CUSTOMIZED,
      'translated' => TRUE,
    ]);
    $this
      ->assertCount($language_count, $translations);

    // Load all Spanish customized translations.
    $translations = $this->storage
      ->getTranslations([
      'language' => 'es',
      'customized' => LOCALE_CUSTOMIZED,
      'translated' => TRUE,
    ]);
    $this
      ->assertCount(1, $translations);

    // Load all source strings without translation (1).
    $translations = $this->storage
      ->getStrings([
      'translated' => FALSE,
    ]);
    $this
      ->assertCount(1, $translations);

    // Load Spanish translations using string filter.
    $filter_options['filters'] = [
      'source' => $prefix,
    ];
    $translations = $this->storage
      ->getTranslations([
      'language' => 'es',
    ], $filter_options);
    $this
      ->assertCount(2, $translations);
  }

  /**
   * Creates random source string object.
   *
   * @param array $values
   *   The values array.
   *
   * @return \Drupal\locale\StringInterface
   *   A locale string.
   */
  protected function buildSourceString(array $values = []) {
    return $this->storage
      ->createString($values += [
      'source' => $this
        ->randomMachineName(100),
      'context' => $this
        ->randomMachineName(20),
    ]);
  }

  /**
   * Creates translations for source string and all languages.
   *
   * @param \Drupal\locale\StringInterface $source
   *   The source string.
   * @param array $values
   *   The values array.
   *
   * @return array
   *   Translation list.
   */
  protected function createAllTranslations(StringInterface $source, array $values = []) {
    $list = [];

    /** @var \Drupal\Core\Language\LanguageManagerInterface $language_manager */
    $language_manager = $this->container
      ->get('language_manager');
    foreach ($language_manager
      ->getLanguages() as $language) {
      $list[$language
        ->getId()] = $this
        ->createTranslation($source, $language
        ->getId(), $values);
    }
    return $list;
  }

  /**
   * Creates single translation for source string.
   *
   * @param \Drupal\locale\StringInterface $source
   *   The source string.
   * @param string $langcode
   *   The language code.
   * @param array $values
   *   The values array.
   *
   * @return \Drupal\locale\StringInterface
   *   The translated string object.
   */
  protected function createTranslation(StringInterface $source, $langcode, array $values = []) {
    return $this->storage
      ->createTranslation($values + [
      'lid' => $source->lid,
      'language' => $langcode,
      'translation' => $this
        ->randomMachineName(100),
    ])
      ->save();
  }

}

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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
LocaleStringTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
LocaleStringTest::$storage protected property The locale storage.
LocaleStringTest::buildSourceString protected function Creates random source string object.
LocaleStringTest::createAllTranslations protected function Creates translations for source string and all languages.
LocaleStringTest::createTranslation protected function Creates single translation for source string.
LocaleStringTest::setUp protected function Overrides KernelTestBase::setUp
LocaleStringTest::testStringCrudApi public function Tests CRUD API.
LocaleStringTest::testStringSearchApi public function Tests Search API loading multiple objects.
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::$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.