VocabularyInterface.php

Same filename in other branches
  1. 8.9.x core/modules/taxonomy/src/VocabularyInterface.php
  2. 10 core/modules/taxonomy/src/VocabularyInterface.php
  3. 11.x core/modules/taxonomy/src/VocabularyInterface.php

Namespace

Drupal\taxonomy

File

core/modules/taxonomy/src/VocabularyInterface.php

View source
<?php

namespace Drupal\taxonomy;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a taxonomy vocabulary entity.
 */
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 description.
     *
     * @return string
     *   The vocabulary description.
     */
    public function getDescription();

}

Interfaces

Title Deprecated Summary
VocabularyInterface Provides an interface defining a taxonomy vocabulary entity.

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