interface VocabularyInterface

Same name and namespace in other branches
  1. 11.x core/modules/taxonomy/src/VocabularyInterface.php \Drupal\taxonomy\VocabularyInterface
  2. 10 core/modules/taxonomy/src/VocabularyInterface.php \Drupal\taxonomy\VocabularyInterface
  3. 9 core/modules/taxonomy/src/VocabularyInterface.php \Drupal\taxonomy\VocabularyInterface

Provides an interface defining a taxonomy vocabulary entity.

Hierarchy

Expanded class hierarchy of VocabularyInterface

All classes that implement VocabularyInterface

13 files declare their use of VocabularyInterface
forum.module in core/modules/forum/forum.module
Provides discussion forums.
ForumUninstallValidator.php in core/modules/forum/src/ForumUninstallValidator.php
MigrateTaxonomyVocabularyTest.php in core/modules/taxonomy/tests/src/Kernel/Migrate/d7/MigrateTaxonomyVocabularyTest.php
Overview.php in core/modules/forum/src/Form/Overview.php
OverviewTerms.php in core/modules/taxonomy/src/Form/OverviewTerms.php

... See full list

File

core/modules/taxonomy/src/VocabularyInterface.php, line 10

Namespace

Drupal\taxonomy
View source
interface VocabularyInterface extends ConfigEntityInterface {
  
  /**
   * Denotes that no term in the vocabulary has a parent.
   */
  const HIERARCHY_DISABLED = 0;
  
  /**
   * Denotes that one or more terms in the vocabulary has a single parent.
   */
  const HIERARCHY_SINGLE = 1;
  
  /**
   * Denotes that one or more terms in the vocabulary have multiple parents.
   */
  const HIERARCHY_MULTIPLE = 2;
  
  /**
   * Returns the vocabulary hierarchy.
   *
   * @return int
   *   The vocabulary hierarchy.
   *
   * @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Use
   *   \Drupal\taxonomy\TermStorage::getVocabularyHierarchyType() instead.
   */
  public function getHierarchy();
  
  /**
   * Sets the vocabulary hierarchy.
   *
   * @param int $hierarchy
   *   The hierarchy type of vocabulary.
   *   Possible values:
   *    - VocabularyInterface::HIERARCHY_DISABLED: No parents.
   *    - VocabularyInterface::HIERARCHY_SINGLE: Single parent.
   *    - VocabularyInterface::HIERARCHY_MULTIPLE: Multiple parents.
   *
   * @return $this
   *
   * @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Reset
   *   the cache of the taxonomy_term storage handler instead.
   */
  public function setHierarchy($hierarchy);
  
  /**
   * Returns the vocabulary description.
   *
   * @return string
   *   The vocabulary description.
   */
  public function getDescription();

}

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