TermInterface.php

Same filename in other branches
  1. 8.9.x core/modules/taxonomy/src/TermInterface.php
  2. 10 core/modules/taxonomy/src/TermInterface.php
  3. 11.x core/modules/taxonomy/src/TermInterface.php

Namespace

Drupal\taxonomy

File

core/modules/taxonomy/src/TermInterface.php

View source
<?php

namespace Drupal\taxonomy;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityChangedInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\RevisionLogInterface;

/**
 * Provides an interface defining a taxonomy term entity.
 */
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);

}

Interfaces

Title Deprecated Summary
TermInterface Provides an interface defining a taxonomy term entity.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.