class CommentViewsData in Drupal 8
Same name and namespace in other branches
- 9 core/modules/comment/src/CommentViewsData.php \Drupal\comment\CommentViewsData
Provides views data for the comment entity type.
Hierarchy
- class \Drupal\views\EntityViewsData implements EntityHandlerInterface, EntityViewsDataInterface uses DeprecatedServicePropertyTrait, StringTranslationTrait
- class \Drupal\comment\CommentViewsData
Expanded class hierarchy of CommentViewsData
File
- core/
modules/ comment/ src/ CommentViewsData.php, line 11
Namespace
Drupal\commentView source
class CommentViewsData extends EntityViewsData {
/**
* {@inheritdoc}
*/
public function getViewsData() {
$data = parent::getViewsData();
$data['comment_field_data']['table']['base']['help'] = $this
->t('Comments are responses to content.');
$data['comment_field_data']['table']['base']['access query tag'] = 'comment_access';
$data['comment_field_data']['table']['wizard_id'] = 'comment';
$data['comment_field_data']['subject']['title'] = $this
->t('Title');
$data['comment_field_data']['subject']['help'] = $this
->t('The title of the comment.');
$data['comment_field_data']['subject']['field']['default_formatter'] = 'comment_permalink';
$data['comment_field_data']['name']['title'] = $this
->t('Author');
$data['comment_field_data']['name']['help'] = $this
->t("The name of the comment's author. Can be rendered as a link to the author's homepage.");
$data['comment_field_data']['name']['field']['default_formatter'] = 'comment_username';
$data['comment_field_data']['homepage']['title'] = $this
->t("Author's website");
$data['comment_field_data']['homepage']['help'] = $this
->t("The website address of the comment's author. Can be rendered as a link. Will be empty if the author is a registered user.");
$data['comment_field_data']['mail']['help'] = $this
->t('Email of user that posted the comment. Will be empty if the author is a registered user.');
$data['comment_field_data']['created']['title'] = $this
->t('Post date');
$data['comment_field_data']['created']['help'] = $this
->t('Date and time of when the comment was created.');
$data['comment_field_data']['created_fulldata'] = [
'title' => $this
->t('Created date'),
'help' => $this
->t('Date in the form of CCYYMMDD.'),
'argument' => [
'field' => 'created',
'id' => 'date_fulldate',
],
];
$data['comment_field_data']['created_year_month'] = [
'title' => $this
->t('Created year + month'),
'help' => $this
->t('Date in the form of YYYYMM.'),
'argument' => [
'field' => 'created',
'id' => 'date_year_month',
],
];
$data['comment_field_data']['created_year'] = [
'title' => $this
->t('Created year'),
'help' => $this
->t('Date in the form of YYYY.'),
'argument' => [
'field' => 'created',
'id' => 'date_year',
],
];
$data['comment_field_data']['created_month'] = [
'title' => $this
->t('Created month'),
'help' => $this
->t('Date in the form of MM (01 - 12).'),
'argument' => [
'field' => 'created',
'id' => 'date_month',
],
];
$data['comment_field_data']['created_day'] = [
'title' => $this
->t('Created day'),
'help' => $this
->t('Date in the form of DD (01 - 31).'),
'argument' => [
'field' => 'created',
'id' => 'date_day',
],
];
$data['comment_field_data']['created_week'] = [
'title' => $this
->t('Created week'),
'help' => $this
->t('Date in the form of WW (01 - 53).'),
'argument' => [
'field' => 'created',
'id' => 'date_week',
],
];
$data['comment_field_data']['changed']['title'] = $this
->t('Updated date');
$data['comment_field_data']['changed']['help'] = $this
->t('Date and time of when the comment was last updated.');
$data['comment_field_data']['changed_fulldata'] = [
'title' => $this
->t('Changed date'),
'help' => $this
->t('Date in the form of CCYYMMDD.'),
'argument' => [
'field' => 'changed',
'id' => 'date_fulldate',
],
];
$data['comment_field_data']['changed_year_month'] = [
'title' => $this
->t('Changed year + month'),
'help' => $this
->t('Date in the form of YYYYMM.'),
'argument' => [
'field' => 'changed',
'id' => 'date_year_month',
],
];
$data['comment_field_data']['changed_year'] = [
'title' => $this
->t('Changed year'),
'help' => $this
->t('Date in the form of YYYY.'),
'argument' => [
'field' => 'changed',
'id' => 'date_year',
],
];
$data['comment_field_data']['changed_month'] = [
'title' => $this
->t('Changed month'),
'help' => $this
->t('Date in the form of MM (01 - 12).'),
'argument' => [
'field' => 'changed',
'id' => 'date_month',
],
];
$data['comment_field_data']['changed_day'] = [
'title' => $this
->t('Changed day'),
'help' => $this
->t('Date in the form of DD (01 - 31).'),
'argument' => [
'field' => 'changed',
'id' => 'date_day',
],
];
$data['comment_field_data']['changed_week'] = [
'title' => $this
->t('Changed week'),
'help' => $this
->t('Date in the form of WW (01 - 53).'),
'argument' => [
'field' => 'changed',
'id' => 'date_week',
],
];
$data['comment_field_data']['status']['title'] = $this
->t('Approved status');
$data['comment_field_data']['status']['help'] = $this
->t('Whether the comment is approved (or still in the moderation queue).');
$data['comment_field_data']['status']['filter']['label'] = $this
->t('Approved comment status');
$data['comment_field_data']['status']['filter']['type'] = 'yes-no';
$data['comment']['approve_comment'] = [
'field' => [
'title' => $this
->t('Link to approve comment'),
'help' => $this
->t('Provide a simple link to approve the comment.'),
'id' => 'comment_link_approve',
],
];
$data['comment']['replyto_comment'] = [
'field' => [
'title' => $this
->t('Link to reply-to comment'),
'help' => $this
->t('Provide a simple link to reply to the comment.'),
'id' => 'comment_link_reply',
],
];
$data['comment_field_data']['entity_id']['field']['id'] = 'commented_entity';
unset($data['comment_field_data']['entity_id']['relationship']);
$data['comment']['comment_bulk_form'] = [
'title' => $this
->t('Comment operations bulk form'),
'help' => $this
->t('Add a form element that lets you run operations on multiple comments.'),
'field' => [
'id' => 'comment_bulk_form',
],
];
$data['comment_field_data']['thread']['field'] = [
'title' => $this
->t('Depth'),
'help' => $this
->t('Display the depth of the comment if it is threaded.'),
'id' => 'comment_depth',
];
$data['comment_field_data']['thread']['sort'] = [
'title' => $this
->t('Thread'),
'help' => $this
->t('Sort by the threaded order. This will keep child comments together with their parents.'),
'id' => 'comment_thread',
];
unset($data['comment_field_data']['thread']['filter']);
unset($data['comment_field_data']['thread']['argument']);
$entities_types = \Drupal::entityTypeManager()
->getDefinitions();
// Provide a relationship for each entity type except comment.
foreach ($entities_types as $type => $entity_type) {
if ($type == 'comment' || !$entity_type
->entityClassImplements(ContentEntityInterface::class) || !$entity_type
->getBaseTable()) {
continue;
}
if ($fields = \Drupal::service('comment.manager')
->getFields($type)) {
$data['comment_field_data'][$type] = [
'relationship' => [
'title' => $entity_type
->getLabel(),
'help' => $this
->t('The @entity_type to which the comment is a reply to.', [
'@entity_type' => $entity_type
->getLabel(),
]),
'base' => $entity_type
->getDataTable() ?: $entity_type
->getBaseTable(),
'base field' => $entity_type
->getKey('id'),
'relationship field' => 'entity_id',
'id' => 'standard',
'label' => $entity_type
->getLabel(),
'extra' => [
[
'field' => 'entity_type',
'value' => $type,
'table' => 'comment_field_data',
],
],
],
];
}
}
$data['comment_field_data']['uid']['title'] = $this
->t('Author uid');
$data['comment_field_data']['uid']['help'] = $this
->t('If you need more fields than the uid add the comment: author relationship');
$data['comment_field_data']['uid']['relationship']['title'] = $this
->t('Author');
$data['comment_field_data']['uid']['relationship']['help'] = $this
->t("The User ID of the comment's author.");
$data['comment_field_data']['uid']['relationship']['label'] = $this
->t('author');
$data['comment_field_data']['pid']['title'] = $this
->t('Parent CID');
$data['comment_field_data']['pid']['relationship']['title'] = $this
->t('Parent comment');
$data['comment_field_data']['pid']['relationship']['help'] = $this
->t('The parent comment');
$data['comment_field_data']['pid']['relationship']['label'] = $this
->t('parent');
// Define the base group of this table. Fields that don't have a group defined
// will go into this field by default.
$data['comment_entity_statistics']['table']['group'] = $this
->t('Comment Statistics');
// Provide a relationship for each entity type except comment.
foreach ($entities_types as $type => $entity_type) {
if ($type == 'comment' || !$entity_type
->entityClassImplements(ContentEntityInterface::class) || !$entity_type
->getBaseTable()) {
continue;
}
// This relationship does not use the 'field id' column, if the entity has
// multiple comment-fields, then this might introduce duplicates, in which
// case the site-builder should enable aggregation and SUM the comment_count
// field. We cannot create a relationship from the base table to
// {comment_entity_statistics} for each field as multiple joins between
// the same two tables is not supported.
if (\Drupal::service('comment.manager')
->getFields($type)) {
$data['comment_entity_statistics']['table']['join'][$entity_type
->getDataTable() ?: $entity_type
->getBaseTable()] = [
'type' => 'LEFT',
'left_field' => $entity_type
->getKey('id'),
'field' => 'entity_id',
'extra' => [
[
'field' => 'entity_type',
'value' => $type,
],
],
];
}
}
$data['comment_entity_statistics']['last_comment_timestamp'] = [
'title' => $this
->t('Last comment time'),
'help' => $this
->t('Date and time of when the last comment was posted.'),
'field' => [
'id' => 'comment_last_timestamp',
],
'sort' => [
'id' => 'date',
],
'filter' => [
'id' => 'date',
],
];
$data['comment_entity_statistics']['last_comment_name'] = [
'title' => $this
->t("Last comment author"),
'help' => $this
->t('The name of the author of the last posted comment.'),
'field' => [
'id' => 'comment_ces_last_comment_name',
'no group by' => TRUE,
],
'sort' => [
'id' => 'comment_ces_last_comment_name',
'no group by' => TRUE,
],
];
$data['comment_entity_statistics']['comment_count'] = [
'title' => $this
->t('Comment count'),
'help' => $this
->t('The number of comments an entity has.'),
'field' => [
'id' => 'numeric',
],
'filter' => [
'id' => 'numeric',
],
'sort' => [
'id' => 'standard',
],
'argument' => [
'id' => 'standard',
],
];
$data['comment_entity_statistics']['last_updated'] = [
'title' => $this
->t('Updated/commented date'),
'help' => $this
->t('The most recent of last comment posted or entity updated time.'),
'field' => [
'id' => 'comment_ces_last_updated',
'no group by' => TRUE,
],
'sort' => [
'id' => 'comment_ces_last_updated',
'no group by' => TRUE,
],
'filter' => [
'id' => 'comment_ces_last_updated',
],
];
$data['comment_entity_statistics']['cid'] = [
'title' => $this
->t('Last comment CID'),
'help' => $this
->t('Display the last comment of an entity'),
'relationship' => [
'title' => $this
->t('Last comment'),
'help' => $this
->t('The last comment of an entity.'),
'group' => $this
->t('Comment'),
'base' => 'comment',
'base field' => 'cid',
'id' => 'standard',
'label' => $this
->t('Last Comment'),
],
];
$data['comment_entity_statistics']['last_comment_uid'] = [
'title' => $this
->t('Last comment uid'),
'help' => $this
->t('The User ID of the author of the last comment of an entity.'),
'relationship' => [
'title' => $this
->t('Last comment author'),
'base' => 'users',
'base field' => 'uid',
'id' => 'standard',
'label' => $this
->t('Last comment author'),
],
'filter' => [
'id' => 'numeric',
],
'argument' => [
'id' => 'numeric',
],
'field' => [
'id' => 'numeric',
],
];
$data['comment_entity_statistics']['entity_type'] = [
'title' => $this
->t('Entity type'),
'help' => $this
->t('The entity type to which the comment is a reply to.'),
'field' => [
'id' => 'standard',
],
'filter' => [
'id' => 'string',
],
'argument' => [
'id' => 'string',
],
'sort' => [
'id' => 'standard',
],
];
$data['comment_entity_statistics']['field_name'] = [
'title' => $this
->t('Comment field name'),
'help' => $this
->t('The field name from which the comment originated.'),
'field' => [
'id' => 'standard',
],
'filter' => [
'id' => 'string',
],
'argument' => [
'id' => 'string',
],
'sort' => [
'id' => 'standard',
],
];
return $data;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
CommentViewsData:: |
public | function |
Returns views data for the entity type. Overrides EntityViewsData:: |
|
|
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
|
EntityViewsData:: |
protected | property | ||
|
EntityViewsData:: |
protected | property | The entity field manager. | |
|
EntityViewsData:: |
protected | property | Entity type for this views data handler instance. | |
|
EntityViewsData:: |
protected | property | The entity type manager. | |
|
EntityViewsData:: |
protected | property | The field storage definitions for all base fields of the entity type. | |
|
EntityViewsData:: |
protected | property | The module handler. | |
|
EntityViewsData:: |
protected | property | The storage used for this entity type. | |
|
EntityViewsData:: |
protected | property | The translation manager. | |
|
EntityViewsData:: |
protected | function | Sets the entity links in case corresponding link templates exist. | |
|
EntityViewsData:: |
public static | function |
Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface:: |
|
|
EntityViewsData:: |
protected | function | Gets the field storage definitions. | |
|
EntityViewsData:: |
public | function |
Gets the table of an entity type to be used as base table in views. Overrides EntityViewsDataInterface:: |
|
|
EntityViewsData:: |
protected | function | Puts the views data for a single field onto the views data. | |
|
EntityViewsData:: |
protected | function | Provides the views data for a given data type and schema field. | |
|
EntityViewsData:: |
protected | function | Processes the views data for an entity reference field. | |
|
EntityViewsData:: |
protected | function | Processes the views data for a language field. | |
|
EntityViewsData:: |
protected | function | Processes the views data for a text field with formatting. | |
|
EntityViewsData:: |
protected | function | Processes the views data for a UUID field. | |
|
EntityViewsData:: |
public | function | Constructs an EntityViewsData object. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |