TaxonomyTestTrait.php

Same filename in other branches
  1. 8.9.x core/modules/taxonomy/src/Tests/TaxonomyTestTrait.php
  2. 8.9.x core/modules/taxonomy/tests/src/Functional/TaxonomyTestTrait.php
  3. 8.9.x core/modules/taxonomy/tests/src/Traits/TaxonomyTestTrait.php
  4. 10 core/modules/taxonomy/tests/src/Traits/TaxonomyTestTrait.php
  5. 11.x core/modules/taxonomy/tests/src/Traits/TaxonomyTestTrait.php

Namespace

Drupal\Tests\taxonomy\Traits

File

core/modules/taxonomy/tests/src/Traits/TaxonomyTestTrait.php

View source
<?php

namespace Drupal\Tests\taxonomy\Traits;

use Drupal\Core\Language\LanguageInterface;
use Drupal\taxonomy\Entity\Vocabulary;
use Drupal\taxonomy\Entity\Term;
use Drupal\taxonomy\VocabularyInterface;

/**
 * Provides common helper methods for Taxonomy module tests.
 */
trait TaxonomyTestTrait {
    
    /**
     * Returns a new vocabulary with random properties.
     *
     * @return \Drupal\taxonomy\VocabularyInterface
     *   A vocabulary used for testing.
     */
    public function createVocabulary() {
        $vocabulary = Vocabulary::create([
            'name' => $this->randomMachineName(),
            'description' => $this->randomMachineName(),
            'vid' => mb_strtolower($this->randomMachineName()),
            'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
            'weight' => mt_rand(0, 10),
        ]);
        $vocabulary->save();
        return $vocabulary;
    }
    
    /**
     * Returns a new term with random properties given a vocabulary.
     *
     * @param \Drupal\taxonomy\VocabularyInterface $vocabulary
     *   The vocabulary object.
     * @param array $values
     *   (optional) An array of values to set, keyed by property name.
     *
     * @return \Drupal\taxonomy\TermInterface
     *   The new taxonomy term object.
     */
    public function createTerm(VocabularyInterface $vocabulary, $values = []) {
        $term = Term::create($values + [
            'name' => $this->randomMachineName(),
            'description' => [
                'value' => $this->randomMachineName(),
                // Use the fallback text format.
'format' => filter_fallback_format(),
            ],
            'vid' => $vocabulary->id(),
            'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
        ]);
        $term->save();
        return $term;
    }

}

Traits

Title Deprecated Summary
TaxonomyTestTrait Provides common helper methods for Taxonomy module tests.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.