interface TermInterface
Same name in other branches
- 9 core/modules/taxonomy/src/TermInterface.php \Drupal\taxonomy\TermInterface
- 8.9.x core/modules/taxonomy/src/TermInterface.php \Drupal\taxonomy\TermInterface
- 10 core/modules/taxonomy/src/TermInterface.php \Drupal\taxonomy\TermInterface
Provides an interface defining a taxonomy term entity.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable \Drupal\Core\Entity\FieldableEntityInterface \Drupal\Core\Entity\TranslatableRevisionableInterface \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityChangedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\EntityPublishedInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\RevisionLogInterface extends \Drupal\Core\Entity\RevisionableInterface
- interface \Drupal\taxonomy\TermInterface extends \Drupal\Core\Entity\ContentEntityInterface \Drupal\Core\Entity\EntityChangedInterface \Drupal\Core\Entity\EntityPublishedInterface \Drupal\Core\Entity\RevisionLogInterface
Expanded class hierarchy of TermInterface
All classes that implement TermInterface
19 files declare their use of TermInterface
- ArgumentSummaryTest.php in core/
modules/ views/ tests/ src/ Kernel/ Handler/ ArgumentSummaryTest.php - ContentImportTest.php in core/
tests/ Drupal/ FunctionalTests/ DefaultContent/ ContentImportTest.php - DeleteForm.php in core/
modules/ forum/ src/ Form/ DeleteForm.php - EntityReferenceItemTest.php in core/
modules/ field/ tests/ src/ Kernel/ EntityReference/ EntityReferenceItemTest.php - ForumController.php in core/
modules/ forum/ src/ Controller/ ForumController.php
File
-
core/
modules/ taxonomy/ src/ TermInterface.php, line 13
Namespace
Drupal\taxonomyView source
interface TermInterface extends ContentEntityInterface, EntityChangedInterface, EntityPublishedInterface, RevisionLogInterface {
/**
* Gets the term description.
*
* @return string
* The term description.
*/
public function getDescription();
/**
* Sets the term description.
*
* @param string $description
* The term description.
*
* @return $this
*/
public function setDescription($description);
/**
* Gets the text format name for the term description.
*
* @return string
* The text format name.
*/
public function getFormat();
/**
* Sets the text format name for the term description.
*
* @param string $format
* The text format name.
*
* @return $this
*/
public function setFormat($format);
/**
* Gets the term name.
*
* @return string
* The term name.
*/
public function getName();
/**
* Sets the term name.
*
* @param string $name
* The term name.
*
* @return $this
*/
public function setName($name);
/**
* Gets the term weight.
*
* @return int
* The term weight.
*/
public function getWeight();
/**
* Sets the term weight.
*
* @param int $weight
* The term weight.
*
* @return $this
*/
public function setWeight($weight);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 |
EntityChangedInterface::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface::getChangedTimeAcrossTranslations | public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface::id | public | function | Gets the identifier. | 2 |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 |
EntityInterface::label | public | function | Gets the label of the entity. | 2 |
EntityInterface::language | public | function | Gets the language of the entity. | 2 |
EntityInterface::load | public static | function | Loads an entity. | 2 |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface::save | public | function | Saves an entity permanently. | 2 |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 |
EntityInterface::toArray | public | function | Gets an array of all property values. | 3 |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
EntityPublishedInterface::isPublished | public | function | Returns whether or not the entity is published. | |
EntityPublishedInterface::setPublished | public | function | Sets the entity as published. | |
EntityPublishedInterface::setUnpublished | public | function | Sets the entity as unpublished. | |
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
RevisionableInterface::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | |
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | |
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | |
RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | |
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | |
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | |
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | |
RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | |
RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | |
RevisionLogInterface::getRevisionCreationTime | public | function | Gets the entity revision creation timestamp. | 1 |
RevisionLogInterface::getRevisionLogMessage | public | function | Returns the entity revision log message. | |
RevisionLogInterface::getRevisionUser | public | function | Gets the entity revision author. | |
RevisionLogInterface::getRevisionUserId | public | function | Gets the entity revision author ID. | |
RevisionLogInterface::setRevisionCreationTime | public | function | Sets the entity revision creation timestamp. | 1 |
RevisionLogInterface::setRevisionLogMessage | public | function | Sets the entity revision log message. | |
RevisionLogInterface::setRevisionUser | public | function | Sets the entity revision author. | |
RevisionLogInterface::setRevisionUserId | public | function | Sets the entity revision author by ID. | |
TermInterface::getDescription | public | function | Gets the term description. | 1 |
TermInterface::getFormat | public | function | Gets the text format name for the term description. | 1 |
TermInterface::getName | public | function | Gets the term name. | 1 |
TermInterface::getWeight | public | function | Gets the term weight. | 1 |
TermInterface::setDescription | public | function | Sets the term description. | 1 |
TermInterface::setFormat | public | function | Sets the text format name for the term description. | 1 |
TermInterface::setName | public | function | Sets the term name. | 1 |
TermInterface::setWeight | public | function | Sets the term weight. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.