annotate core/modules/taxonomy/src/TermInterface.php @ 0:4c8ae668cc8c

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