CommentTypeInterface.php

Same filename in other branches
  1. 9 core/modules/comment/src/CommentTypeInterface.php
  2. 8.9.x core/modules/comment/src/CommentTypeInterface.php
  3. 11.x core/modules/comment/src/CommentTypeInterface.php

Namespace

Drupal\comment

File

core/modules/comment/src/CommentTypeInterface.php

View source
<?php

namespace Drupal\comment;

use Drupal\Core\Config\Entity\ConfigEntityInterface;

/**
 * Provides an interface defining a comment type entity.
 */
interface CommentTypeInterface extends ConfigEntityInterface {
    
    /**
     * Returns the comment type description.
     *
     * @return string
     *   The comment-type description.
     */
    public function getDescription();
    
    /**
     * Sets the description of the comment type.
     *
     * @param string $description
     *   The new description.
     *
     * @return $this
     */
    public function setDescription($description);
    
    /**
     * Gets the target entity type id for this comment type.
     *
     * @return string
     *   The target entity type id.
     */
    public function getTargetEntityTypeId();

}

Interfaces

Title Deprecated Summary
CommentTypeInterface Provides an interface defining a comment type entity.

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