CommentType.php

Same filename in this branch
  1. 9 core/modules/comment/src/Plugin/migrate/source/CommentType.php
Same filename in other branches
  1. 8.9.x core/modules/comment/src/Entity/CommentType.php
  2. 8.9.x core/modules/comment/src/Plugin/migrate/source/d7/CommentType.php
  3. 10 core/modules/comment/src/Entity/CommentType.php
  4. 10 core/modules/comment/src/Plugin/migrate/source/CommentType.php
  5. 11.x core/modules/comment/src/Entity/CommentType.php
  6. 11.x core/modules/comment/src/Plugin/migrate/source/CommentType.php

Namespace

Drupal\comment\Entity

File

core/modules/comment/src/Entity/CommentType.php

View source
<?php

namespace Drupal\comment\Entity;

use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
use Drupal\comment\CommentTypeInterface;

/**
 * Defines the comment type entity.
 *
 * @ConfigEntityType(
 *   id = "comment_type",
 *   label = @Translation("Comment type"),
 *   label_singular = @Translation("comment type"),
 *   label_plural = @Translation("comment types"),
 *   label_count = @PluralTranslation(
 *     singular = "@count comment type",
 *     plural = "@count comment types",
 *   ),
 *   handlers = {
 *     "form" = {
 *       "default" = "Drupal\comment\CommentTypeForm",
 *       "add" = "Drupal\comment\CommentTypeForm",
 *       "edit" = "Drupal\comment\CommentTypeForm",
 *       "delete" = "Drupal\comment\Form\CommentTypeDeleteForm"
 *     },
 *     "route_provider" = {
 *       "permissions" = "Drupal\user\Entity\EntityPermissionsRouteProviderWithCheck",
 *     },
 *     "list_builder" = "Drupal\comment\CommentTypeListBuilder"
 *   },
 *   admin_permission = "administer comment types",
 *   config_prefix = "type",
 *   bundle_of = "comment",
 *   entity_keys = {
 *     "id" = "id",
 *     "label" = "label"
 *   },
 *   links = {
 *     "delete-form" = "/admin/structure/comment/manage/{comment_type}/delete",
 *     "edit-form" = "/admin/structure/comment/manage/{comment_type}",
 *     "add-form" = "/admin/structure/comment/types/add",
 *     "entity-permissions-form" = "/admin/structure/comment/manage/{comment_type}/permissions",
 *     "collection" = "/admin/structure/comment",
 *   },
 *   config_export = {
 *     "id",
 *     "label",
 *     "target_entity_type_id",
 *     "description",
 *   }
 * )
 */
class CommentType extends ConfigEntityBundleBase implements CommentTypeInterface {
    
    /**
     * The comment type ID.
     *
     * @var string
     */
    protected $id;
    
    /**
     * The comment type label.
     *
     * @var string
     */
    protected $label;
    
    /**
     * The description of the comment type.
     *
     * @var string
     */
    protected $description;
    
    /**
     * The target entity type.
     *
     * @var string
     */
    protected $target_entity_type_id;
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->description;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setDescription($description) {
        $this->description = $description;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTargetEntityTypeId() {
        return $this->target_entity_type_id;
    }

}

Classes

Title Deprecated Summary
CommentType Defines the comment type entity.

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