Mercurial > hg > isophonics-drupal-site
diff core/modules/taxonomy/src/VocabularyInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children | af1871eacc83 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/modules/taxonomy/src/VocabularyInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,57 @@ +<?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 hierarchy. + * + * @return int + * The vocabulary hierarchy. + */ + 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 + */ + public function setHierarchy($hierarchy); + + /** + * Returns the vocabulary description. + * + * @return string + * The vocabulary description. + */ + public function getDescription(); + +}