comparison core/modules/taxonomy/src/TermInterface.php @ 18:af1871eacc83

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