class TermTranslationTest in Drupal 10

Tests for proper breadcrumb translation.

@group taxonomy

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\taxonomy\Functional\TaxonomyTestBase uses EntityReferenceTestTrait, TaxonomyTestTrait
    • class \Drupal\Tests\taxonomy\Functional\TermTranslationTest uses AssertBreadcrumbTrait, TaxonomyTranslationTestTrait

File

core/modules/taxonomy/tests/src/Functional/TermTranslationTest.php, line 13

Namespace

Drupal\Tests\taxonomy\Functional

class TermTranslationTest extends TaxonomyTestBase {
  use AssertBreadcrumbTrait;
  use TaxonomyTranslationTestTrait;

  /**
   * Term to translated term mapping.
   *
   * @var array
   */
  protected $termTranslationMap = [
    'one' => 'translatedOne',
    'two' => 'translatedTwo',
    'three' => 'translatedThree',
  ];

  /**
   * Created terms.
   *
   * @var \Drupal\taxonomy\Entity\Term[]
   */
  protected $terms = [];

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

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->setupLanguages();
    $this->vocabulary = $this
      ->createVocabulary();
    $this
      ->enableTranslation();
    $this
      ->setUpTerms();
    $this
      ->setUpTermReferenceField();
  }

  /**
   * Tests translated breadcrumbs.
   */
  public function testTranslatedBreadcrumbs() {

    // Ensure non-translated breadcrumb is correct.
    $breadcrumb = [
      Url::fromRoute('<front>')
        ->toString() => 'Home',
    ];
    foreach ($this->terms as $term) {
      $breadcrumb[$term
        ->toUrl()
        ->toString()] = $term
        ->label();
    }

    // The last item will not be in the breadcrumb.
    array_pop($breadcrumb);

    // Check the breadcrumb on the leaf term page.
    $term = $this
      ->getLeafTerm();
    $this
      ->assertBreadcrumb($term
      ->toUrl(), $breadcrumb, $term
      ->label());
    $languages = \Drupal::languageManager()
      ->getLanguages();

    // Construct the expected translated breadcrumb.
    $breadcrumb = [
      Url::fromRoute('<front>', [], [
        'language' => $languages[$this->translateToLangcode],
      ])
        ->toString() => 'Home',
    ];
    foreach ($this->terms as $term) {
      $translated = $term
        ->getTranslation($this->translateToLangcode);
      $url = $translated
        ->toUrl('canonical', [
        'language' => $languages[$this->translateToLangcode],
      ])
        ->toString();
      $breadcrumb[$url] = $translated
        ->label();
    }
    array_pop($breadcrumb);

    // Check for the translated breadcrumb on the translated leaf term page.
    $term = $this
      ->getLeafTerm();
    $translated = $term
      ->getTranslation($this->translateToLangcode);
    $this
      ->assertBreadcrumb($translated
      ->toUrl('canonical', [
      'language' => $languages[$this->translateToLangcode],
    ]), $breadcrumb, $translated
      ->label());
  }

  /**
   * Tests translation of terms are showed in the node.
   */
  public function testTermsTranslation() {

    // Set the display of the term reference field on the article content type
    // to "Check boxes/radio buttons".
    \Drupal::service('entity_display.repository')
      ->getFormDisplay('node', 'article')
      ->setComponent($this->termFieldName, [
      'type' => 'options_buttons',
    ])
      ->save();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'create article content',
    ]));

    // Test terms are listed.
    $this
      ->drupalget('node/add/article');
    $this
      ->assertSession()
      ->pageTextContains('one');
    $this
      ->assertSession()
      ->pageTextContains('two');
    $this
      ->assertSession()
      ->pageTextContains('three');

    // Test terms translated are listed.
    $this
      ->drupalget('hu/node/add/article');
    $this
      ->assertSession()
      ->pageTextContains('translatedOne');
    $this
      ->assertSession()
      ->pageTextContains('translatedTwo');
    $this
      ->assertSession()
      ->pageTextContains('translatedThree');
  }

  /**
   * Setup translated terms in a hierarchy.
   */
  protected function setUpTerms() {
    $parent_vid = 0;
    foreach ($this->termTranslationMap as $name => $translation) {
      $term = $this
        ->createTerm($this->vocabulary, [
        'name' => $name,
        'langcode' => $this->baseLangcode,
        'parent' => $parent_vid,
      ]);
      $term
        ->addTranslation($this->translateToLangcode, [
        'name' => $translation,
      ]);
      $term
        ->save();

      // Each term is nested under the last.
      $parent_vid = $term
        ->id();
      $this->terms[] = $term;
    }
  }

  /**
   * Get the final (leaf) term in the hierarchy.
   *
   * @return \Drupal\taxonomy\Entity\Term
   *   The final term in the hierarchy.
   */
  protected function getLeafTerm() {
    return $this->terms[count($this->termTranslationMap) - 1];
  }

}