TermTest.php in Zircon Profile 8
Same filename in this branch
Same filename and directory in other branches
Contains \Drupal\taxonomy\Tests\TermTest.
Namespace
Drupal\taxonomy\TestsFile
core/modules/taxonomy/src/Tests/TermTest.phpView source
<?php
/**
* @file
* Contains \Drupal\taxonomy\Tests\TermTest.
*/
namespace Drupal\taxonomy\Tests;
use Drupal\Component\Utility\Tags;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\field\Entity\FieldConfig;
use Drupal\taxonomy\Entity\Term;
use Drupal\taxonomy\Entity\Vocabulary;
/**
* Tests load, save and delete for taxonomy terms.
*
* @group taxonomy
*/
class TermTest extends TaxonomyTestBase {
/**
* Vocabulary for testing.
*
* @var \Drupal\taxonomy\VocabularyInterface
*/
protected $vocabulary;
/**
* Taxonomy term reference field for testing.
*
* @var \Drupal\field\FieldConfigInterface
*/
protected $field;
/**
* Modules to enable.
*
* @var string[]
*/
public static $modules = [
'block',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this
->drupalPlaceBlock('local_actions_block');
$this
->drupalPlaceBlock('local_tasks_block');
$this
->drupalPlaceBlock('page_title_block');
$this
->drupalLogin($this
->drupalCreateUser([
'administer taxonomy',
'bypass node access',
]));
$this->vocabulary = $this
->createVocabulary();
$field_name = 'taxonomy_' . $this->vocabulary
->id();
$handler_settings = array(
'target_bundles' => array(
$this->vocabulary
->id() => $this->vocabulary
->id(),
),
'auto_create' => TRUE,
);
$this
->createEntityReferenceField('node', 'article', $field_name, NULL, 'taxonomy_term', 'default', $handler_settings, FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
$this->field = FieldConfig::loadByName('node', 'article', $field_name);
entity_get_form_display('node', 'article', 'default')
->setComponent($field_name, array(
'type' => 'options_select',
))
->save();
entity_get_display('node', 'article', 'default')
->setComponent($field_name, array(
'type' => 'entity_reference_label',
))
->save();
}
/**
* Test terms in a single and multiple hierarchy.
*/
function testTaxonomyTermHierarchy() {
// Create two taxonomy terms.
$term1 = $this
->createTerm($this->vocabulary);
$term2 = $this
->createTerm($this->vocabulary);
// Get the taxonomy storage.
$taxonomy_storage = $this->container
->get('entity.manager')
->getStorage('taxonomy_term');
// Check that hierarchy is flat.
$vocabulary = Vocabulary::load($this->vocabulary
->id());
$this
->assertEqual(0, $vocabulary
->getHierarchy(), 'Vocabulary is flat.');
// Edit $term2, setting $term1 as parent.
$edit = array();
$edit['parent[]'] = array(
$term1
->id(),
);
$this
->drupalPostForm('taxonomy/term/' . $term2
->id() . '/edit', $edit, t('Save'));
// Check the hierarchy.
$children = $taxonomy_storage
->loadChildren($term1
->id());
$parents = $taxonomy_storage
->loadParents($term2
->id());
$this
->assertTrue(isset($children[$term2
->id()]), 'Child found correctly.');
$this
->assertTrue(isset($parents[$term1
->id()]), 'Parent found correctly.');
// Load and save a term, confirming that parents are still set.
$term = Term::load($term2
->id());
$term
->save();
$parents = $taxonomy_storage
->loadParents($term2
->id());
$this
->assertTrue(isset($parents[$term1
->id()]), 'Parent found correctly.');
// Create a third term and save this as a parent of term2.
$term3 = $this
->createTerm($this->vocabulary);
$term2->parent = array(
$term1
->id(),
$term3
->id(),
);
$term2
->save();
$parents = $taxonomy_storage
->loadParents($term2
->id());
$this
->assertTrue(isset($parents[$term1
->id()]) && isset($parents[$term3
->id()]), 'Both parents found successfully.');
}
/**
* Tests that many terms with parents show on each page
*/
function testTaxonomyTermChildTerms() {
// Set limit to 10 terms per page. Set variable to 9 so 10 terms appear.
$this
->config('taxonomy.settings')
->set('terms_per_page_admin', '9')
->save();
$term1 = $this
->createTerm($this->vocabulary);
$terms_array = '';
$taxonomy_storage = $this->container
->get('entity.manager')
->getStorage('taxonomy_term');
// Create 40 terms. Terms 1-12 get parent of $term1. All others are
// individual terms.
for ($x = 1; $x <= 40; $x++) {
$edit = array();
// Set terms in order so we know which terms will be on which pages.
$edit['weight'] = $x;
// Set terms 1-20 to be children of first term created.
if ($x <= 12) {
$edit['parent'] = $term1
->id();
}
$term = $this
->createTerm($this->vocabulary, $edit);
$children = $taxonomy_storage
->loadChildren($term1
->id());
$parents = $taxonomy_storage
->loadParents($term
->id());
$terms_array[$x] = Term::load($term
->id());
}
// Get Page 1.
$this
->drupalGet('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview');
$this
->assertText($term1
->getName(), 'Parent Term is displayed on Page 1');
for ($x = 1; $x <= 13; $x++) {
$this
->assertText($terms_array[$x]
->getName(), $terms_array[$x]
->getName() . ' found on Page 1');
}
// Get Page 2.
$this
->drupalGet('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview', array(
'query' => array(
'page' => 1,
),
));
$this
->assertText($term1
->getName(), 'Parent Term is displayed on Page 2');
for ($x = 1; $x <= 18; $x++) {
$this
->assertText($terms_array[$x]
->getName(), $terms_array[$x]
->getName() . ' found on Page 2');
}
// Get Page 3.
$this
->drupalGet('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview', array(
'query' => array(
'page' => 2,
),
));
$this
->assertNoText($term1
->getName(), 'Parent Term is not displayed on Page 3');
for ($x = 1; $x <= 17; $x++) {
$this
->assertNoText($terms_array[$x]
->getName(), $terms_array[$x]
->getName() . ' not found on Page 3');
}
for ($x = 18; $x <= 25; $x++) {
$this
->assertText($terms_array[$x]
->getName(), $terms_array[$x]
->getName() . ' found on Page 3');
}
}
/**
* Test that hook_node_$op implementations work correctly.
*
* Save & edit a node and assert that taxonomy terms are saved/loaded properly.
*/
function testTaxonomyNode() {
// Create two taxonomy terms.
$term1 = $this
->createTerm($this->vocabulary);
$term2 = $this
->createTerm($this->vocabulary);
// Post an article.
$edit = array();
$edit['title[0][value]'] = $this
->randomMachineName();
$edit['body[0][value]'] = $this
->randomMachineName();
$edit[$this->field
->getName() . '[]'] = $term1
->id();
$this
->drupalPostForm('node/add/article', $edit, t('Save'));
// Check that the term is displayed when the node is viewed.
$node = $this
->drupalGetNodeByTitle($edit['title[0][value]']);
$this
->drupalGet('node/' . $node
->id());
$this
->assertText($term1
->getName(), 'Term is displayed when viewing the node.');
$this
->clickLink(t('Edit'));
$this
->assertText($term1
->getName(), 'Term is displayed when editing the node.');
$this
->drupalPostForm(NULL, array(), t('Save'));
$this
->assertText($term1
->getName(), 'Term is displayed after saving the node with no changes.');
// Edit the node with a different term.
$edit[$this->field
->getName() . '[]'] = $term2
->id();
$this
->drupalPostForm('node/' . $node
->id() . '/edit', $edit, t('Save'));
$this
->drupalGet('node/' . $node
->id());
$this
->assertText($term2
->getName(), 'Term is displayed when viewing the node.');
// Preview the node.
$this
->drupalPostForm('node/' . $node
->id() . '/edit', $edit, t('Preview'));
$this
->assertUniqueText($term2
->getName(), 'Term is displayed when previewing the node.');
$this
->drupalPostForm('node/' . $node
->id() . '/edit', NULL, t('Preview'));
$this
->assertUniqueText($term2
->getName(), 'Term is displayed when previewing the node again.');
}
/**
* Test term creation with a free-tagging vocabulary from the node form.
*/
function testNodeTermCreationAndDeletion() {
// Enable tags in the vocabulary.
$field = $this->field;
entity_get_form_display($field
->getTargetEntityTypeId(), $field
->getTargetBundle(), 'default')
->setComponent($field
->getName(), array(
'type' => 'entity_reference_autocomplete_tags',
'settings' => array(
'placeholder' => 'Start typing here.',
),
))
->save();
// Prefix the terms with a letter to ensure there is no clash in the first
// three letters.
// @see https://www.drupal.org/node/2397691
$terms = array(
'term1' => 'a' . $this
->randomMachineName(),
'term2' => 'b' . $this
->randomMachineName(),
'term3' => 'c' . $this
->randomMachineName() . ', ' . $this
->randomMachineName(),
'term4' => 'd' . $this
->randomMachineName(),
);
$edit = array();
$edit['title[0][value]'] = $this
->randomMachineName();
$edit['body[0][value]'] = $this
->randomMachineName();
// Insert the terms in a comma separated list. Vocabulary 1 is a
// free-tagging field created by the default profile.
$edit[$field
->getName() . '[target_id]'] = Tags::implode($terms);
// Verify the placeholder is there.
$this
->drupalGet('node/add/article');
$this
->assertRaw('placeholder="Start typing here."', 'Placeholder is present.');
// Preview and verify the terms appear but are not created.
$this
->drupalPostForm(NULL, $edit, t('Preview'));
foreach ($terms as $term) {
$this
->assertText($term, 'The term appears on the node preview.');
}
$tree = $this->container
->get('entity.manager')
->getStorage('taxonomy_term')
->loadTree($this->vocabulary
->id());
$this
->assertTrue(empty($tree), 'The terms are not created on preview.');
// taxonomy.module does not maintain its static caches.
taxonomy_terms_static_reset();
// Save, creating the terms.
$this
->drupalPostForm('node/add/article', $edit, t('Save'));
$this
->assertRaw(t('@type %title has been created.', array(
'@type' => t('Article'),
'%title' => $edit['title[0][value]'],
)), 'The node was created successfully.');
foreach ($terms as $term) {
$this
->assertText($term, 'The term was saved and appears on the node page.');
}
// Get the created terms.
$term_objects = array();
foreach ($terms as $key => $term) {
$term_objects[$key] = taxonomy_term_load_multiple_by_name($term);
$term_objects[$key] = reset($term_objects[$key]);
}
// Get the node.
$node = $this
->drupalGetNodeByTitle($edit['title[0][value]']);
// Test editing the node.
$this
->drupalPostForm('node/' . $node
->id() . '/edit', $edit, t('Save'));
foreach ($terms as $term) {
$this
->assertText($term, 'The term was retained after edit and still appears on the node page.');
}
// Delete term 1 from the term edit page.
$this
->drupalGet('taxonomy/term/' . $term_objects['term1']
->id() . '/edit');
$this
->clickLink(t('Delete'));
$this
->drupalPostForm(NULL, NULL, t('Delete'));
// Delete term 2 from the term delete page.
$this
->drupalGet('taxonomy/term/' . $term_objects['term2']
->id() . '/delete');
$this
->drupalPostForm(NULL, array(), t('Delete'));
$term_names = array(
$term_objects['term3']
->getName(),
$term_objects['term4']
->getName(),
);
$this
->drupalGet('node/' . $node
->id());
foreach ($term_names as $term_name) {
$this
->assertText($term_name, format_string('The term %name appears on the node page after two terms, %deleted1 and %deleted2, were deleted.', array(
'%name' => $term_name,
'%deleted1' => $term_objects['term1']
->getName(),
'%deleted2' => $term_objects['term2']
->getName(),
)));
}
$this
->assertNoText($term_objects['term1']
->getName(), format_string('The deleted term %name does not appear on the node page.', array(
'%name' => $term_objects['term1']
->getName(),
)));
$this
->assertNoText($term_objects['term2']
->getName(), format_string('The deleted term %name does not appear on the node page.', array(
'%name' => $term_objects['term2']
->getName(),
)));
}
/**
* Save, edit and delete a term using the user interface.
*/
function testTermInterface() {
\Drupal::service('module_installer')
->install(array(
'views',
));
$edit = array(
'name[0][value]' => $this
->randomMachineName(12),
'description[0][value]' => $this
->randomMachineName(100),
);
// Explicitly set the parents field to 'root', to ensure that
// TermForm::save() handles the invalid term ID correctly.
$edit['parent[]'] = array(
0,
);
// Create the term to edit.
$this
->drupalPostForm('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/add', $edit, t('Save'));
$terms = taxonomy_term_load_multiple_by_name($edit['name[0][value]']);
$term = reset($terms);
$this
->assertNotNull($term, 'Term found in database.');
// Submitting a term takes us to the add page; we need the List page.
$this
->drupalGet('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview');
$this
->clickLink(t('Edit'));
$this
->assertRaw($edit['name[0][value]'], 'The randomly generated term name is present.');
$this
->assertText($edit['description[0][value]'], 'The randomly generated term description is present.');
$edit = array(
'name[0][value]' => $this
->randomMachineName(14),
'description[0][value]' => $this
->randomMachineName(102),
);
// Edit the term.
$this
->drupalPostForm('taxonomy/term/' . $term
->id() . '/edit', $edit, t('Save'));
// Check that the term is still present at admin UI after edit.
$this
->drupalGet('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview');
$this
->assertText($edit['name[0][value]'], 'The randomly generated term name is present.');
$this
->assertLink(t('Edit'));
// Check the term link can be clicked through to the term page.
$this
->clickLink($edit['name[0][value]']);
$this
->assertResponse(200, 'Term page can be accessed via the listing link.');
// View the term and check that it is correct.
$this
->drupalGet('taxonomy/term/' . $term
->id());
$this
->assertText($edit['name[0][value]'], 'The randomly generated term name is present.');
$this
->assertText($edit['description[0][value]'], 'The randomly generated term description is present.');
// Did this page request display a 'term-listing-heading'?
$this
->assertTrue($this
->xpath('//div[contains(@class, "field--name-description")]'), 'Term page displayed the term description element.');
// Check that it does NOT show a description when description is blank.
$term
->setDescription(NULL);
$term
->save();
$this
->drupalGet('taxonomy/term/' . $term
->id());
$this
->assertFalse($this
->xpath('//div[contains(@class, "field--entity-taxonomy-term--description")]'), 'Term page did not display the term description when description was blank.');
// Check that the description value is processed.
$value = $this
->randomMachineName();
$term
->setDescription($value);
$term
->save();
$this
->assertEqual($term->description->processed, "<p>{$value}</p>\n");
// Check that the term feed page is working.
$this
->drupalGet('taxonomy/term/' . $term
->id() . '/feed');
// Delete the term.
$this
->drupalGet('taxonomy/term/' . $term
->id() . '/edit');
$this
->clickLink(t('Delete'));
$this
->drupalPostForm(NULL, NULL, t('Delete'));
// Assert that the term no longer exists.
$this
->drupalGet('taxonomy/term/' . $term
->id());
$this
->assertResponse(404, 'The taxonomy term page was not found.');
}
/**
* Save, edit and delete a term using the user interface.
*/
function testTermReorder() {
$this
->createTerm($this->vocabulary);
$this
->createTerm($this->vocabulary);
$this
->createTerm($this->vocabulary);
$taxonomy_storage = $this->container
->get('entity.manager')
->getStorage('taxonomy_term');
// Fetch the created terms in the default alphabetical order, i.e. term1
// precedes term2 alphabetically, and term2 precedes term3.
$taxonomy_storage
->resetCache();
list($term1, $term2, $term3) = $taxonomy_storage
->loadTree($this->vocabulary
->id(), 0, NULL, TRUE);
$this
->drupalGet('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview');
// Each term has four hidden fields, "tid:1:0[tid]", "tid:1:0[parent]",
// "tid:1:0[depth]", and "tid:1:0[weight]". Change the order to term2,
// term3, term1 by setting weight property, make term3 a child of term2 by
// setting the parent and depth properties, and update all hidden fields.
$edit = array(
'terms[tid:' . $term2
->id() . ':0][term][tid]' => $term2
->id(),
'terms[tid:' . $term2
->id() . ':0][term][parent]' => 0,
'terms[tid:' . $term2
->id() . ':0][term][depth]' => 0,
'terms[tid:' . $term2
->id() . ':0][weight]' => 0,
'terms[tid:' . $term3
->id() . ':0][term][tid]' => $term3
->id(),
'terms[tid:' . $term3
->id() . ':0][term][parent]' => $term2
->id(),
'terms[tid:' . $term3
->id() . ':0][term][depth]' => 1,
'terms[tid:' . $term3
->id() . ':0][weight]' => 1,
'terms[tid:' . $term1
->id() . ':0][term][tid]' => $term1
->id(),
'terms[tid:' . $term1
->id() . ':0][term][parent]' => 0,
'terms[tid:' . $term1
->id() . ':0][term][depth]' => 0,
'terms[tid:' . $term1
->id() . ':0][weight]' => 2,
);
$this
->drupalPostForm(NULL, $edit, t('Save'));
$taxonomy_storage
->resetCache();
$terms = $taxonomy_storage
->loadTree($this->vocabulary
->id());
$this
->assertEqual($terms[0]->tid, $term2
->id(), 'Term 2 was moved above term 1.');
$this
->assertEqual($terms[1]->parents, array(
$term2
->id(),
), 'Term 3 was made a child of term 2.');
$this
->assertEqual($terms[2]->tid, $term1
->id(), 'Term 1 was moved below term 2.');
$this
->drupalPostForm('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview', array(), t('Reset to alphabetical'));
// Submit confirmation form.
$this
->drupalPostForm(NULL, array(), t('Reset to alphabetical'));
// Ensure form redirected back to overview.
$this
->assertUrl('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/overview');
$taxonomy_storage
->resetCache();
$terms = $taxonomy_storage
->loadTree($this->vocabulary
->id(), 0, NULL, TRUE);
$this
->assertEqual($terms[0]
->id(), $term1
->id(), 'Term 1 was moved to back above term 2.');
$this
->assertEqual($terms[1]
->id(), $term2
->id(), 'Term 2 was moved to back below term 1.');
$this
->assertEqual($terms[2]
->id(), $term3
->id(), 'Term 3 is still below term 2.');
$this
->assertEqual($terms[2]->parents, array(
$term2
->id(),
), 'Term 3 is still a child of term 2.');
}
/**
* Test saving a term with multiple parents through the UI.
*/
function testTermMultipleParentsInterface() {
// Add a new term to the vocabulary so that we can have multiple parents.
$parent = $this
->createTerm($this->vocabulary);
// Add a new term with multiple parents.
$edit = array(
'name[0][value]' => $this
->randomMachineName(12),
'description[0][value]' => $this
->randomMachineName(100),
'parent[]' => array(
0,
$parent
->id(),
),
);
// Save the new term.
$this
->drupalPostForm('admin/structure/taxonomy/manage/' . $this->vocabulary
->id() . '/add', $edit, t('Save'));
// Check that the term was successfully created.
$terms = taxonomy_term_load_multiple_by_name($edit['name[0][value]']);
$term = reset($terms);
$this
->assertNotNull($term, 'Term found in database.');
$this
->assertEqual($edit['name[0][value]'], $term
->getName(), 'Term name was successfully saved.');
$this
->assertEqual($edit['description[0][value]'], $term
->getDescription(), 'Term description was successfully saved.');
// Check that the parent tid is still there. The other parent (<root>) is
// not added by \Drupal\taxonomy\TermStorageInterface::loadParents().
$parents = $this->container
->get('entity.manager')
->getStorage('taxonomy_term')
->loadParents($term
->id());
$parent = reset($parents);
$this
->assertEqual($edit['parent[]'][1], $parent
->id(), 'Term parents were successfully saved.');
}
/**
* Test taxonomy_term_load_multiple_by_name().
*/
function testTaxonomyGetTermByName() {
$term = $this
->createTerm($this->vocabulary);
// Load the term with the exact name.
$terms = taxonomy_term_load_multiple_by_name($term
->getName());
$this
->assertTrue(isset($terms[$term
->id()]), 'Term loaded using exact name.');
// Load the term with space concatenated.
$terms = taxonomy_term_load_multiple_by_name(' ' . $term
->getName() . ' ');
$this
->assertTrue(isset($terms[$term
->id()]), 'Term loaded with extra whitespace.');
// Load the term with name uppercased.
$terms = taxonomy_term_load_multiple_by_name(strtoupper($term
->getName()));
$this
->assertTrue(isset($terms[$term
->id()]), 'Term loaded with uppercased name.');
// Load the term with name lowercased.
$terms = taxonomy_term_load_multiple_by_name(strtolower($term
->getName()));
$this
->assertTrue(isset($terms[$term
->id()]), 'Term loaded with lowercased name.');
// Try to load an invalid term name.
$terms = taxonomy_term_load_multiple_by_name('Banana');
$this
->assertFalse($terms, 'No term loaded with an invalid name.');
// Try to load the term using a substring of the name.
$terms = taxonomy_term_load_multiple_by_name(Unicode::substr($term
->getName(), 2), 'No term loaded with a substring of the name.');
$this
->assertFalse($terms);
// Create a new term in a different vocabulary with the same name.
$new_vocabulary = $this
->createVocabulary();
$new_term = entity_create('taxonomy_term', array(
'name' => $term
->getName(),
'vid' => $new_vocabulary
->id(),
));
$new_term
->save();
// Load multiple terms with the same name.
$terms = taxonomy_term_load_multiple_by_name($term
->getName());
$this
->assertEqual(count($terms), 2, 'Two terms loaded with the same name.');
// Load single term when restricted to one vocabulary.
$terms = taxonomy_term_load_multiple_by_name($term
->getName(), $this->vocabulary
->id());
$this
->assertEqual(count($terms), 1, 'One term loaded when restricted by vocabulary.');
$this
->assertTrue(isset($terms[$term
->id()]), 'Term loaded using exact name and vocabulary machine name.');
// Create a new term with another name.
$term2 = $this
->createTerm($this->vocabulary);
// Try to load a term by name that doesn't exist in this vocabulary but
// exists in another vocabulary.
$terms = taxonomy_term_load_multiple_by_name($term2
->getName(), $new_vocabulary
->id());
$this
->assertFalse($terms, 'Invalid term name restricted by vocabulary machine name not loaded.');
// Try to load terms filtering by a non-existing vocabulary.
$terms = taxonomy_term_load_multiple_by_name($term2
->getName(), 'non_existing_vocabulary');
$this
->assertEqual(count($terms), 0, 'No terms loaded when restricted by a non-existing vocabulary.');
}
/**
* Tests that editing and saving a node with no changes works correctly.
*/
function testReSavingTags() {
// Enable tags in the vocabulary.
$field = $this->field;
entity_get_form_display($field
->getTargetEntityTypeId(), $field
->getTargetBundle(), 'default')
->setComponent($field
->getName(), array(
'type' => 'entity_reference_autocomplete_tags',
))
->save();
// Create a term and a node using it.
$term = $this
->createTerm($this->vocabulary);
$edit = array();
$edit['title[0][value]'] = $this
->randomMachineName(8);
$edit['body[0][value]'] = $this
->randomMachineName(16);
$edit[$this->field
->getName() . '[target_id]'] = $term
->getName();
$this
->drupalPostForm('node/add/article', $edit, t('Save'));
// Check that the term is displayed when editing and saving the node with no
// changes.
$this
->clickLink(t('Edit'));
$this
->assertRaw($term
->getName(), 'Term is displayed when editing the node.');
$this
->drupalPostForm(NULL, array(), t('Save'));
$this
->assertRaw($term
->getName(), 'Term is displayed after saving the node with no changes.');
}
}