www.aleph1.co.uk 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
   8 /**
   9  * Provides an interface defining a taxonomy term entity.
  10  */
  11 interface TermInterface extends ContentEntityInterface, EntityChangedInterface {
  12
  13   /**
  14    * Gets the term's description.
  15    *
  16    * @return string
  17    *   The term description.
  18    */
  19   public function getDescription();
  20
  21   /**
  22    * Sets the term's description.
  23    *
  24    * @param string $description
  25    *   The term's description.
  26    *
  27    * @return $this
  28    */
  29   public function setDescription($description);
  30
  31   /**
  32    * Gets the text format name for the term's description.
  33    *
  34    * @return string
  35    *   The text format name.
  36    */
  37   public function getFormat();
  38
  39   /**
  40    * Sets the text format name for the term's description.
  41    *
  42    * @param string $format
  43    *   The term's description text format.
  44    *
  45    * @return $this
  46    */
  47   public function setFormat($format);
  48
  49   /**
  50    * Gets the name of the term.
  51    *
  52    * @return string
  53    *   The name of the term.
  54    */
  55   public function getName();
  56
  57   /**
  58    * Sets the name of the term.
  59    *
  60    * @param int $name
  61    *   The term's name.
  62    *
  63    * @return $this
  64    */
  65   public function setName($name);
  66
  67   /**
  68    * Gets the weight of this term.
  69    *
  70    * @return int
  71    *   The weight of the term.
  72    */
  73   public function getWeight();
  74
  75   /**
  76    * Gets the weight of this term.
  77    *
  78    * @param int $weight
  79    *   The term's weight.
  80    *
  81    * @return $this
  82    */
  83   public function setWeight($weight);
  84
  85   /**
  86    * Get the taxonomy vocabulary id this term belongs to.
  87    *
  88    * @return string
  89    *   The id of the vocabulary.
  90    */
  91   public function getVocabularyId();
  92
  93 }