TaxonomyTestTrait.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\taxonomy\Traits;

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

/**
 * Provides common helper methods for Taxonomy module tests.
 */
trait TaxonomyTestTrait {
    
    /**
     * Returns a new vocabulary with random properties.
     *
     * @param array $values
     *   (optional) Default values for the Vocabulary::create() method.
     *
     * @return \Drupal\taxonomy\VocabularyInterface
     *   A vocabulary used for testing.
     */
    public function createVocabulary(array $values = []) {
        $values += [
            'name' => $this->randomMachineName(),
            'description' => $this->randomMachineName(),
            'vid' => $this->randomMachineName(),
            'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
            'weight' => mt_rand(0, 10),
        ];
        $vocabulary = Vocabulary::create($values);
        $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;
    }
    
    /**
     * Creates a new revision for a given taxonomy term.
     *
     * @param \Drupal\taxonomy\TermInterface $term
     *   A taxonomy term object.
     *
     * @return \Drupal\taxonomy\TermInterface
     *   The new taxonomy term object.
     */
    protected function createTaxonomyTermRevision(TermInterface $term) {
        $term->set('name', $this->randomMachineName());
        $term->setNewRevision();
        $term->save();
        return $term;
    }

}