yaffs.net Git - yaffs-website/blob - web/core/modules/taxonomy/src/TermInterface.php

   1 <?php
   2
   3 namespace Drupal\taxonomy;
   4
   5 use Drupal\Core\Entity\ContentEntityInterface;
   6 use Drupal\Core\Entity\EntityChangedInterface;
   7 use Drupal\Core\Entity\EntityPublishedInterface;
   8
   9 /**
  10  * Provides an interface defining a taxonomy term entity.
  11  */
  12 interface TermInterface extends ContentEntityInterface, EntityChangedInterface, EntityPublishedInterface {
  13
  14   /**
  15    * Gets the term's description.
  16    *
  17    * @return string
  18    *   The term description.
  19    */
  20   public function getDescription();
  21
  22   /**
  23    * Sets the term's description.
  24    *
  25    * @param string $description
  26    *   The term's description.
  27    *
  28    * @return $this
  29    */
  30   public function setDescription($description);
  31
  32   /**
  33    * Gets the text format name for the term's description.
  34    *
  35    * @return string
  36    *   The text format name.
  37    */
  38   public function getFormat();
  39
  40   /**
  41    * Sets the text format name for the term's description.
  42    *
  43    * @param string $format
  44    *   The term's description text format.
  45    *
  46    * @return $this
  47    */
  48   public function setFormat($format);
  49
  50   /**
  51    * Gets the name of the term.
  52    *
  53    * @return string
  54    *   The name of the term.
  55    */
  56   public function getName();
  57
  58   /**
  59    * Sets the name of the term.
  60    *
  61    * @param string $name
  62    *   The term's name.
  63    *
  64    * @return $this
  65    */
  66   public function setName($name);
  67
  68   /**
  69    * Gets the weight of this term.
  70    *
  71    * @return int
  72    *   The weight of the term.
  73    */
  74   public function getWeight();
  75
  76   /**
  77    * Gets the weight of this term.
  78    *
  79    * @param int $weight
  80    *   The term's weight.
  81    *
  82    * @return $this
  83    */
  84   public function setWeight($weight);
  85
  86   /**
  87    * Get the taxonomy vocabulary id this term belongs to.
  88    *
  89    * @return string
  90    *   The id of the vocabulary.
  91    *
  92    * @deprecated Scheduled for removal before Drupal 9.0.0. Use
  93    *   TermInterface::bundle() instead.
  94    */
  95   public function getVocabularyId();
  96
  97 }