Newer
Older
* When installed, the Comment module creates a field that facilitates a
* discussion board for each Drupal entity to which a comment field is attached.
* Users can post comments to discuss a forum topic, story, collaborative
* book page, user etc.
use Drupal\comment\CommentInterface;
use Drupal\comment\Entity\CommentType;
Alex Pott
committed
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
Alex Pott
committed
use Drupal\Core\Entity\Entity\EntityViewMode;
use Drupal\Core\Entity\EntityInterface;
Dries Buytaert
committed
use Drupal\Core\Form\FormStateInterface;
Angie Byron
committed
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
Angie Byron
committed
use Drupal\Core\Render\Element;
Angie Byron
committed
use Drupal\Core\Url;
use Drupal\field\FieldConfigInterface;
use Drupal\field\FieldStorageConfigInterface;
catch
committed
use Drupal\node\NodeInterface;
use Drupal\user\RoleInterface;
* Anonymous posters cannot enter their contact information.
*
* @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
* Use \Drupal\comment\CommentInterface::ANONYMOUS_MAYNOT_CONTACT instead.
const COMMENT_ANONYMOUS_MAYNOT_CONTACT = 0;
/**
* Anonymous posters may leave their contact information.
*
* @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
* Use \Drupal\comment\CommentInterface::ANONYMOUS_MAY_CONTACT instead.
const COMMENT_ANONYMOUS_MAY_CONTACT = 1;
* Anonymous posters are required to leave their contact information.
*
* @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
* Use \Drupal\comment\CommentInterface::ANONYMOUS_MUST_CONTACT instead.
const COMMENT_ANONYMOUS_MUST_CONTACT = 2;
/**
* The time cutoff for comments marked as read for entity types other node.
*
* Comments changed before this time are always marked as read.
* Comments changed after this time may be marked new, updated, or read,
* depending on their state for the current user. Defaults to 30 days ago.
*
Jess
committed
* @todo Remove when https://www.drupal.org/node/1029708 lands.
*/
define('COMMENT_NEW_LIMIT', REQUEST_TIME - 30 * 24 * 60 * 60);
Dries Buytaert
committed
* Implements hook_help().
Angie Byron
committed
function comment_help($route_name, RouteMatchInterface $route_match) {
switch ($route_name) {
case 'help.page.comment':
Angie Byron
committed
$output = '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Comment module allows users to comment on site content, set commenting defaults and permissions, and moderate comments. For more information, see the <a href=":comment">online documentation for the Comment module</a>.', [':comment' => 'https://www.drupal.org/documentation/modules/comment']) . '</p>';
Angie Byron
committed
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
Angie Byron
committed
$output .= '<dt>' . t('Enabling commenting') . '</dt>';
$output .= '<dd>' . t('Comment functionality can be enabled for any entity sub-type (for example, a <a href=":content-type">content type</a>) by adding a <em>Comments</em> field on its <em>Manage fields page</em>. Adding or removing commenting for an entity through the user interface requires the <a href=":field_ui">Field UI</a> module to be enabled, even though the commenting functionality works without it. For more information on fields and entities, see the <a href=":field">Field module help page</a>.', [':content-type' => (\Drupal::moduleHandler()->moduleExists('node')) ? \Drupal::url('entity.node_type.collection') : '#', ':field' => \Drupal::url('help.page', ['name' => 'field']), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#']) . '</dd>';
Angie Byron
committed
$output .= '<dt>' . t('Configuring commenting settings') . '</dt>';
$output .= '<dd>' . t('Commenting settings can be configured by editing the <em>Comments</em> field on the <em>Manage fields page</em> of an entity type if the <em>Field UI module</em> is enabled. Configuration includes the label of the comments field, the number of comments to be displayed, and whether they are shown in threaded list. Commenting can be be configured as: <em>Open</em> to allow new comments, <em>Closed</em> to view existing comments, but prevent new comments, or <em>Hidden</em> to hide existing comments and prevent new comments. Changing this configuration for an entity type will not change existing entity items.') . '</dd>';
Jennifer Hodgdon
committed
$output .= '<dt>' . t('Overriding default settings') . '</dt>';
Angie Byron
committed
$output .= '<dd>' . t('Users with the appropriate permissions can override the default commenting settings of an entity type when they create an item of that type.') . '</dd>';
Jess
committed
$output .= '<dt>' . t('Adding comment types') . '</dt>';
$output .= '<dd>' . t('Additional <em>comment types</em> can be created per entity sub-type and added on the <a href=":field">Comment types page</a>. If there are multiple comment types available you can select the appropriate one after adding a <em>Comments field</em>.', [':field' => \Drupal::url('entity.comment_type.collection')]) . '</dd>';
Jennifer Hodgdon
committed
$output .= '<dt>' . t('Approving and managing comments') . '</dt>';
$output .= '<dd>' . t('Comments from users who have the <em>Skip comment approval</em> permission are published immediately. All other comments are placed in the <a href=":comment-approval">Unapproved comments</a> queue, until a user who has permission to <em>Administer comments and comment settings</em> publishes or deletes them. Published comments can be bulk managed on the <a href=":admin-comment">Published comments</a> administration page. When a comment has no replies, it remains editable by its author, as long as the author has <em>Edit own comments</em> permission.', [':comment-approval' => \Drupal::url('comment.admin_approval'), ':admin-comment' => \Drupal::url('comment.admin')]) . '</dd>';
Angie Byron
committed
$output .= '</dl>';
Dries Buytaert
committed
return $output;
Alex Pott
committed
case 'entity.comment_type.collection':
$output = '<p>' . t('This page provides a list of all comment types on the site and allows you to manage the fields, form and display settings for each.') . '</p>';
return $output;
Gábor Hojtsy
committed
}
Angie Byron
committed
/**
Angie Byron
committed
* Entity URI callback.
Angie Byron
committed
*/
Angie Byron
committed
function comment_uri(CommentInterface $comment) {
Angie Byron
committed
return new Url(
'entity.comment.canonical',
[
Alex Pott
committed
'comment' => $comment->id(),
],
['fragment' => 'comment-' . $comment->id()]
Angie Byron
committed
);
Angie Byron
committed
}
* Implements hook_entity_extra_field_info().
function comment_entity_extra_field_info() {
$return = [];
foreach (CommentType::loadMultiple() as $comment_type) {
$return['comment'][$comment_type->id()] = [
'form' => [
'author' => [
'label' => t('Author'),
'description' => t('Author textfield'),
'weight' => -2,
],
],
];
$return['comment'][$comment_type->id()]['display']['links'] = [
Dries Buytaert
committed
'label' => t('Links'),
'description' => t('Comment operation links'),
'weight' => 100,
'visible' => TRUE,
];
}
return $return;
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_theme().
Dries Buytaert
committed
*/
function comment_theme() {
return [
'comment' => [
'render element' => 'elements',
],
'field__comment' => [
Alex Pott
committed
'base hook' => 'field',
],
];
Dries Buytaert
committed
}
Alex Pott
committed
/**
* Implements hook_ENTITY_TYPE_create() for 'field_config'.
Alex Pott
committed
*/
function comment_field_config_create(FieldConfigInterface $field) {
if ($field->getType() == 'comment' && !$field->isSyncing()) {
// Assign default values for the field.
$default_value = $field->getDefaultValueLiteral();
$default_value += [[]];
$default_value[0] += [
'status' => CommentItemInterface::OPEN,
'cid' => 0,
'last_comment_timestamp' => 0,
'last_comment_name' => '',
'last_comment_uid' => 0,
'comment_count' => 0,
];
$field->setDefaultValue($default_value);
Dries Buytaert
committed
* Implements hook_ENTITY_TYPE_update() for 'field_config'.
function comment_field_config_update(FieldConfigInterface $field) {
if ($field->getType() == 'comment') {
catch
committed
// Comment field settings also affects the rendering of *comment* entities,
// not only the *commented* entities.
\Drupal::entityManager()->getViewBuilder('comment')->resetCache();
Dries Buytaert
committed
* Implements hook_ENTITY_TYPE_insert() for 'field_storage_config'.
function comment_field_storage_config_insert(FieldStorageConfigInterface $field_storage) {
if ($field_storage->getType() == 'comment') {
// Check that the target entity type uses an integer ID.
$entity_type_id = $field_storage->getTargetEntityTypeId();
if (!_comment_entity_uses_integer_id($entity_type_id)) {
throw new \UnexpectedValueException('You cannot attach a comment field to an entity with a non-integer ID field');
}
/**
* Implements hook_ENTITY_TYPE_delete() for 'field_config'.
*/
function comment_field_config_delete(FieldConfigInterface $field) {
if ($field->getType() == 'comment') {
// Delete all comments that used by the entity bundle.
Alex Pott
committed
$entity_query = \Drupal::entityQuery('comment');
$entity_query->condition('entity_type', $field->getEntityTypeId());
$entity_query->condition('field_name', $field->getName());
Alex Pott
committed
$cids = $entity_query->execute();
entity_delete_multiple('comment', $cids);
Dries Buytaert
committed
}
}
catch
committed
* Implements hook_node_links_alter().
function comment_node_links_alter(array &$links, NodeInterface $node, array &$context) {
catch
committed
// Comment links are only added to node entity type for backwards
// compatibility. Should you require comment links for other entity types you
// can do so by implementing a new field formatter.
Jess
committed
// @todo Make this configurable from the formatter. See
// https://www.drupal.org/node/1901110.
catch
committed
$comment_links = \Drupal::service('comment.link_builder')->buildCommentedEntityLinks($node, $context);
$links += $comment_links;
/**
* Implements hook_entity_view().
*/
Alex Bronstein
committed
function comment_entity_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) {
if ($entity instanceof FieldableEntityInterface && $view_mode == 'rss' && $display->getComponent('links')) {
/** @var \Drupal\comment\CommentManagerInterface $comment_manager */
$comment_manager = \Drupal::service('comment.manager');
$fields = $comment_manager->getFields($entity->getEntityTypeId());
foreach ($fields as $field_name => $detail) {
if ($entity->hasField($field_name) && $entity->get($field_name)->status != CommentItemInterface::HIDDEN) {
// Add a comments RSS element which is a URL to the comments of this
// entity.
$options = [
'fragment' => 'comments',
'absolute' => TRUE,
];
$entity->rss_elements[] = [
'key' => 'comments',
'value' => $entity->url('canonical', $options),
];
}
}
}
}
/**
* Implements hook_ENTITY_TYPE_view_alter() for node entities.
function comment_node_view_alter(array &$build, EntityInterface $node, EntityViewDisplayInterface $display) {
if (\Drupal::moduleHandler()->moduleExists('history')) {
$build['#attributes']['data-history-node-id'] = $node->id();
}
}
Dries Buytaert
committed
/**
* Generates an array for rendering a comment.
Dries Buytaert
committed
*
* @param \Drupal\comment\CommentInterface $comment
* The comment object.
* @param string $view_mode
Jennifer Hodgdon
committed
* (optional) View mode; for instance, 'full', 'teaser', etc. Defaults to
* 'full'.
* @param string $langcode
Dries Buytaert
committed
* (optional) A language code to use for rendering. Defaults to the global
* content language of the current request.
Dries Buytaert
committed
*
Angie Byron
committed
* @return array
Dries Buytaert
committed
* An array as expected by drupal_render().
*
* @deprecated in Drupal 8.x and will be removed before Drupal 9.0.
* Use \Drupal::entityManager()->getViewBuilder('comment')->view().
Dries Buytaert
committed
*/
function comment_view(CommentInterface $comment, $view_mode = 'full', $langcode = NULL) {
Angie Byron
committed
return entity_view($comment, $view_mode, $langcode);
Dries Buytaert
committed
}
/**
* Constructs render array from an array of loaded comments.
Dries Buytaert
committed
*
* @param \Drupal\comment\CommentInterface[] $comments
Angie Byron
committed
* An array of comments as returned by entity_load_multiple().
* @param string $view_mode
Jennifer Hodgdon
committed
* (optional) View mode; for instance, 'full', 'teaser', etc. Defaults to
* 'full'.
* @param string $langcode
* (optional) A string indicating the language field values are to be shown
* in. If no language is provided the current content language is used.
* Defaults to NULL.
Dries Buytaert
committed
*
Angie Byron
committed
* @return array
Dries Buytaert
committed
* An array in the format expected by drupal_render().
* @deprecated in Drupal 8.x and will be removed before Drupal 9.0.
* Use \Drupal::entityManager()->getViewBuilder('comment')->viewMultiple().
*
* @see drupal_render()
Dries Buytaert
committed
*/
Angie Byron
committed
function comment_view_multiple($comments, $view_mode = 'full', $langcode = NULL) {
return entity_view_multiple($comments, $view_mode, $langcode);
Dries Buytaert
committed
}
Angie Byron
committed
/**
Angie Byron
committed
* Implements hook_form_FORM_ID_alter() for field_ui_field_storage_add_form.
Angie Byron
committed
*/
Angie Byron
committed
function comment_form_field_ui_field_storage_add_form_alter(&$form, FormStateInterface $form_state) {
$route_match = \Drupal::routeMatch();
if ($form_state->get('entity_type_id') == 'comment' && $route_match->getParameter('commented_entity_type')) {
$form['#title'] = \Drupal::service('comment.manager')->getFieldUIPageTitle($route_match->getParameter('commented_entity_type'), $route_match->getParameter('field_name'));
Angie Byron
committed
if (!_comment_entity_uses_integer_id($form_state->get('entity_type_id'))) {
$optgroup = (string) t('General');
// You cannot use comment fields on entity types with non-integer IDs.
unset($form['add']['new_storage_type']['#options'][$optgroup]['comment']);
Angie Byron
committed
}
Angie Byron
committed
/**
* Implements hook_form_FORM_ID_alter().
Angie Byron
committed
*/
Alex Pott
committed
function comment_form_field_ui_form_display_overview_form_alter(&$form, FormStateInterface $form_state) {
$route_match = \Drupal::routeMatch();
if ($form['#entity_type'] == 'comment' && $route_match->getParameter('commented_entity_type')) {
$form['#title'] = \Drupal::service('comment.manager')->getFieldUIPageTitle($route_match->getParameter('commented_entity_type'), $route_match->getParameter('field_name'));
Dries Buytaert
committed
}
}
* Implements hook_form_FORM_ID_alter().
Alex Pott
committed
function comment_form_field_ui_display_overview_form_alter(&$form, FormStateInterface $form_state) {
$route_match = \Drupal::routeMatch();
if ($form['#entity_type'] == 'comment' && $route_match->getParameter('commented_entity_type')) {
$form['#title'] = \Drupal::service('comment.manager')->getFieldUIPageTitle($route_match->getParameter('commented_entity_type'), $route_match->getParameter('field_name'));
}
/**
* Implements hook_entity_storage_load().
* @see \Drupal\comment\Plugin\Field\FieldType\CommentItem::propertyDefinitions()
Dries Buytaert
committed
*/
function comment_entity_storage_load($entities, $entity_type) {
// Comments can only be attached to content entities, so skip others.
if (!\Drupal::entityManager()->getDefinition($entity_type)->entityClassImplements(FieldableEntityInterface::class)) {
return;
}
if (!\Drupal::service('comment.manager')->getFields($entity_type)) {
// Do not query database when entity has no comment fields.
return;
}
catch
committed
// Load comment information from the database and update the entity's
// comment statistics properties, which are defined on each CommentItem field.
$result = \Drupal::service('comment.statistics')->read($entities, $entity_type);
foreach ($result as $record) {
// Skip fields that entity does not have.
if (!$entities[$record->entity_id]->hasField($record->field_name)) {
continue;
}
$comment_statistics = $entities[$record->entity_id]->get($record->field_name);
$comment_statistics->cid = $record->cid;
$comment_statistics->last_comment_timestamp = $record->last_comment_timestamp;
$comment_statistics->last_comment_name = $record->last_comment_name;
$comment_statistics->last_comment_uid = $record->last_comment_uid;
$comment_statistics->comment_count = $record->comment_count;
Dries Buytaert
committed
}
}
Dries Buytaert
committed
Dries Buytaert
committed
/**
* Implements hook_entity_insert().
Dries Buytaert
committed
*/
function comment_entity_insert(EntityInterface $entity) {
// Allow bulk updates and inserts to temporarily disable the
// maintenance of the {comment_entity_statistics} table.
if (\Drupal::state()->get('comment.maintain_entity_statistics') &&
$fields = \Drupal::service('comment.manager')->getFields($entity->getEntityTypeId())) {
catch
committed
\Drupal::service('comment.statistics')->create($entity, $fields);
Dries Buytaert
committed
}
Dries Buytaert
committed
Dries Buytaert
committed
/**
* Implements hook_entity_predelete().
Dries Buytaert
committed
*/
function comment_entity_predelete(EntityInterface $entity) {
Angie Byron
committed
// Entities can have non-numeric IDs, but {comment} and
// {comment_entity_statistics} tables have integer columns for entity ID, and
// PostgreSQL throws exceptions if you attempt query conditions with
// mismatched types. So, we need to verify that the ID is numeric (even for an
// entity type that has an integer ID, $entity->id() might be a string
// containing a number), and then cast it to an integer when querying.
Alex Pott
committed
if ($entity instanceof FieldableEntityInterface && is_numeric($entity->id())) {
Angie Byron
committed
$entity_query = \Drupal::entityQuery('comment');
$entity_query->condition('entity_id', (int) $entity->id());
$entity_query->condition('entity_type', $entity->getEntityTypeId());
$cids = $entity_query->execute();
Angie Byron
committed
entity_delete_multiple('comment', $cids);
catch
committed
\Drupal::service('comment.statistics')->delete($entity);
Angie Byron
committed
}
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
* Determines if an entity type is using an integer-based ID definition.
*
* @param string $entity_type_id
* The ID the represents the entity type.
*
* @return bool
* Returns TRUE if the entity type has an integer-based ID definition and
* FALSE otherwise.
*/
function _comment_entity_uses_integer_id($entity_type_id) {
$entity_type = \Drupal::entityManager()->getDefinition($entity_type_id);
$entity_type_id_key = $entity_type->getKey('id');
Dries Buytaert
committed
if ($entity_type_id_key === FALSE) {
return FALSE;
}
$field_definitions = \Drupal::entityManager()->getBaseFieldDefinitions($entity_type->id());
$entity_type_id_definition = $field_definitions[$entity_type_id_key];
return $entity_type_id_definition->getType() === 'integer';
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_node_update_index().
Dries Buytaert
committed
*/
Alex Bronstein
committed
function comment_node_update_index(EntityInterface $node) {
Angie Byron
committed
$index_comments = &drupal_static(__FUNCTION__);
if ($index_comments === NULL) {
// Do not index in the following three cases:
// 1. 'Authenticated user' can search content but can't access comments.
// 2. 'Anonymous user' can search content but can't access comments.
// 3. Any role can search content but can't access comments and access
// comments is not granted by the 'authenticated user' role. In this case
// all users might have both permissions from various roles but it is also
// possible to set up a user to have only search content and so a user
// edit could change the security situation so it is not safe to index the
// comments.
Angie Byron
committed
$index_comments = TRUE;
catch
committed
$roles = \Drupal::entityManager()->getStorage('user_role')->loadMultiple();
$authenticated_can_access = $roles[RoleInterface::AUTHENTICATED_ID]->hasPermission('access comments');
foreach ($roles as $rid => $role) {
if ($role->hasPermission('search content') && !$role->hasPermission('access comments')) {
if ($rid == RoleInterface::AUTHENTICATED_ID || $rid == RoleInterface::ANONYMOUS_ID || !$authenticated_can_access) {
$index_comments = FALSE;
break;
}
Angie Byron
committed
}
}
}
$build = [];
Angie Byron
committed
if ($index_comments) {
foreach (\Drupal::service('comment.manager')->getFields('node') as $field_name => $info) {
// Skip fields that entity does not have.
if (!$node->hasField($field_name)) {
continue;
}
$field_definition = $node->getFieldDefinition($field_name);
$mode = $field_definition->getSetting('default_mode');
$comments_per_page = $field_definition->getSetting('per_page');
if ($node->get($field_name)->status) {
$comments = \Drupal::entityManager()->getStorage('comment')
->loadThread($node, $field_name, $mode, $comments_per_page);
if ($comments) {
$build[] = \Drupal::entityManager()->getViewBuilder('comment')->viewMultiple($comments);
}
Angie Byron
committed
}
Dries Buytaert
committed
}
return \Drupal::service('renderer')->renderPlain($build);
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
* Implements hook_cron().
*/
function comment_cron() {
// Store the maximum possible comments per thread (used for node search
// ranking by reply count).
catch
committed
\Drupal::state()->set('comment.node_comment_statistics_scale', 1.0 / max(1, \Drupal::service('comment.statistics')->getMaximumCount('node')));
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_node_search_result().
Dries Buytaert
committed
*
* Formats a comment count string and returns it, for display with search
* results.
Dries Buytaert
committed
*/
Angie Byron
committed
function comment_node_search_result(EntityInterface $node) {
$comment_fields = \Drupal::service('comment.manager')->getFields('node');
$comments = 0;
$open = FALSE;
foreach ($comment_fields as $field_name => $info) {
// Skip fields that entity does not have.
if (!$node->hasField($field_name)) {
continue;
}
// Do not make a string if comments are hidden.
$status = $node->get($field_name)->status;
if (\Drupal::currentUser()->hasPermission('access comments') && $status != CommentItemInterface::HIDDEN) {
if ($status == CommentItemInterface::OPEN) {
// At least one comment field is open.
$open = TRUE;
}
$comments += $node->get($field_name)->comment_count;
Dries Buytaert
committed
}
Dries Buytaert
committed
}
// Do not make a string if there are no comment fields, or no comments exist
// or all comment fields are hidden.
if ($comments > 0 || $open) {
return ['comment' => \Drupal::translation()->formatPlural($comments, '1 comment', '@count comments')];
Dries Buytaert
committed
}
Dries Buytaert
committed
Dries Buytaert
committed
* Implements hook_user_cancel().
function comment_user_cancel($edit, $account, $method) {
Angie Byron
committed
switch ($method) {
case 'user_cancel_block_unpublish':
$comments = entity_load_multiple_by_properties('comment', ['uid' => $account->id()]);
foreach ($comments as $comment) {
catch
committed
$comment->setPublished(CommentInterface::NOT_PUBLISHED);
$comment->save();
}
Angie Byron
committed
break;
case 'user_cancel_reassign':
/** @var \Drupal\comment\CommentInterface[] $comments */
$comments = entity_load_multiple_by_properties('comment', ['uid' => $account->id()]);
foreach ($comments as $comment) {
$comment->setOwnerId(0);
$comment->setAuthorName(\Drupal::config('user.settings')->get('anonymous'));
$comment->save();
}
Angie Byron
committed
break;
}
Dries Buytaert
committed
/**
* Implements hook_ENTITY_TYPE_predelete() for user entities.
Dries Buytaert
committed
*/
catch
committed
function comment_user_predelete($account) {
Angie Byron
committed
$entity_query = \Drupal::entityQuery('comment');
$entity_query->condition('uid', $account->id());
$cids = $entity_query->execute();
entity_delete_multiple('comment', $cids);
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
* Generates a comment preview.
*
* @param \Drupal\comment\CommentInterface $comment
Angie Byron
committed
* The comment entity to preview.
Dries Buytaert
committed
* @param Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
Angie Byron
committed
*
* @return array
* An array as expected by drupal_render().
Dries Buytaert
committed
*/
Dries Buytaert
committed
function comment_preview(CommentInterface $comment, FormStateInterface $form_state) {
$preview_build = [];
$entity = $comment->getCommentedEntity();
Dries Buytaert
committed
if (!$form_state->getErrors()) {
Dries Buytaert
committed
$comment->in_preview = TRUE;
Alex Pott
committed
$comment_build = \Drupal::entityTypeManager()->getViewBuilder('comment')->view($comment);
Dries Buytaert
committed
$comment_build['#weight'] = -100;
$preview_build['comment_preview'] = $comment_build;
Dries Buytaert
committed
}
Dries Buytaert
committed
if ($comment->hasParentComment()) {
$build = [];
$parent = $comment->getParentComment();
if ($parent && $parent->isPublished()) {
Alex Pott
committed
$build = \Drupal::entityTypeManager()->getViewBuilder('comment')->view($parent);
Dries Buytaert
committed
}
Dries Buytaert
committed
}
else {
// The comment field output includes rendering the parent entity of the
// thread to which the comment is a reply. The rendered entity output
// includes the comment reply form, which contains the comment preview and
// therefore the rendered parent entity. This results in an infinite loop of
// parent entity output rendering the comment form and the comment form
// rendering the parent entity. To prevent this infinite loop we temporarily
// set the value of the comment field on a clone of the entity to hidden
// before calling entity_view(). That way when the output of the commented
// entity is rendered, it excludes the comment field output.
$field_name = $comment->getFieldName();
$entity = clone $entity;
$entity->$field_name->status = CommentItemInterface::HIDDEN;
$build = entity_view($entity, 'full');
Dries Buytaert
committed
}
$preview_build['comment_output_below'] = $build;
$preview_build['comment_output_below']['#weight'] = 100;
Dries Buytaert
committed
return $preview_build;
Dries Buytaert
committed
}
/**
Angie Byron
committed
* Implements hook_preprocess_HOOK() for block templates.
*/
function comment_preprocess_block(&$variables) {
Alex Pott
committed
if ($variables['configuration']['provider'] == 'comment') {
Dries Buytaert
committed
$variables['attributes']['role'] = 'navigation';
}
}
Dries Buytaert
committed
/**
* Prepares variables for comment templates.
*
* Default template: comment.html.twig.
*
* @param array $variables
* An associative array containing:
* - elements: An associative array containing the comment and entity objects.
* Array keys: #comment, #commented_entity.
Dries Buytaert
committed
*/
function template_preprocess_comment(&$variables) {
/** @var \Drupal\comment\CommentInterface $comment */
Dries Buytaert
committed
$comment = $variables['elements']['#comment'];
$commented_entity = $comment->getCommentedEntity();
Dries Buytaert
committed
$variables['comment'] = $comment;
$variables['commented_entity'] = $commented_entity;
Alex Pott
committed
$variables['threaded'] = $variables['elements']['#comment_threaded'];
Dries Buytaert
committed
Alex Pott
committed
$account = $comment->getOwner();
$username = [
Alex Pott
committed
'#theme' => 'username',
'#account' => $account,
];
$variables['author'] = drupal_render($username);
Alex Pott
committed
$variables['author_id'] = $comment->getOwnerId();
$variables['new_indicator_timestamp'] = $comment->getChangedTime();
$variables['created'] = format_date($comment->getCreatedTime());
Dries Buytaert
committed
// Avoid calling format_date() twice on the same timestamp.
if ($comment->getChangedTime() == $comment->getCreatedTime()) {
Dries Buytaert
committed
$variables['changed'] = $variables['created'];
}
else {
$variables['changed'] = format_date($comment->getChangedTime());
Dries Buytaert
committed
}
Dries Buytaert
committed
if (theme_get_setting('features.comment_user_picture')) {
Jennifer Hodgdon
committed
// To change user picture settings (for instance, image style), edit the
// 'compact' view mode on the User entity.
$variables['user_picture'] = user_view($account, 'compact');
}
else {
$variables['user_picture'] = [];
}
Alex Pott
committed
if (isset($comment->in_preview)) {
$variables['title'] = \Drupal::l($comment->getSubject(), new Url('<front>'));
$variables['permalink'] = \Drupal::l(t('Permalink'), new Url('<front>'));
Alex Pott
committed
}
else {
$uri = $comment->permalink();
$attributes = $uri->getOption('attributes') ?: [];
$attributes += ['class' => ['permalink'], 'rel' => 'bookmark'];
Angie Byron
committed
$uri->setOption('attributes', $attributes);
$variables['title'] = \Drupal::l($comment->getSubject(), $uri);
Dries Buytaert
committed
$variables['permalink'] = \Drupal::l(t('Permalink'), $comment->permalink());
Alex Pott
committed
}
Dries Buytaert
committed
$variables['submitted'] = t('Submitted by @username on @datetime', ['@username' => $variables['author'], '@datetime' => $variables['created']]);
Angie Byron
committed
if ($comment->hasParentComment()) {
// Fetch and store the parent comment information for use in templates.
$comment_parent = $comment->getParentComment();
Alex Pott
committed
$account_parent = $comment_parent->getOwner();
$variables['parent_comment'] = $comment_parent;
$username = [
Alex Pott
committed
'#theme' => 'username',
'#account' => $account_parent,
];
$variables['parent_author'] = drupal_render($username);
$variables['parent_created'] = format_date($comment_parent->getCreatedTime());
Dries Buytaert
committed
// Avoid calling format_date() twice on the same timestamp.
if ($comment_parent->getChangedTime() == $comment_parent->getCreatedTime()) {
Dries Buytaert
committed
$variables['parent_changed'] = $variables['parent_created'];
}
else {
$variables['parent_changed'] = format_date($comment_parent->getChangedTime());
Dries Buytaert
committed
}
Alex Pott
committed
$permalink_uri_parent = $comment_parent->permalink();
$attributes = $permalink_uri_parent->getOption('attributes') ?: [];
$attributes += ['class' => ['permalink'], 'rel' => 'bookmark'];
Angie Byron
committed
$permalink_uri_parent->setOption('attributes', $attributes);
$variables['parent_title'] = \Drupal::l($comment_parent->getSubject(), $permalink_uri_parent);
$variables['parent_permalink'] = \Drupal::l(t('Parent permalink'), $permalink_uri_parent);
$variables['parent'] = t('In reply to @parent_title by @parent_username',
['@parent_username' => $variables['parent_author'], '@parent_title' => $variables['parent_title']]);
}
else {
$variables['parent_comment'] = '';
$variables['parent_author'] = '';
$variables['parent_created'] = '';
$variables['parent_changed'] = '';
$variables['parent_title'] = '';
$variables['parent_permalink'] = '';
$variables['parent'] = '';
}
Angie Byron
committed
// Helpful $content variable for templates.
Angie Byron
committed
foreach (Element::children($variables['elements']) as $key) {
Angie Byron
committed
$variables['content'][$key] = $variables['elements'][$key];
}
Dries Buytaert
committed
// Set status to a string representation of comment->status.
Dries Buytaert
committed
if (isset($comment->in_preview)) {
Dries Buytaert
committed
$variables['status'] = 'preview';
Gábor Hojtsy
committed
}
else {
$variables['status'] = $comment->isPublished() ? 'published' : 'unpublished';
Gábor Hojtsy
committed
}
// Add comment author user ID. Necessary for the comment-by-viewer library.
$variables['attributes']['data-comment-user-id'] = $comment->getOwnerId();
Alex Pott
committed
* Prepares variables for comment field templates.
Alex Pott
committed
* Default template: field--comment.html.twig.
*
* @param array $variables
* An associative array containing:
Alex Pott
committed
* - element: An associative array containing render arrays for the list of
* comments, and the comment form. Array keys: comments, comment_form.
Alex Pott
committed
*
* @todo Rename to template_preprocess_field__comment() once
* https://www.drupal.org/node/939462 is resolved.
Alex Pott
committed
function comment_preprocess_field(&$variables) {
$element = $variables['element'];
if ($element['#field_type'] == 'comment') {
// Provide contextual information.
$variables['comment_display_mode'] = $element[0]['#comment_display_mode'];
$variables['comment_type'] = $element[0]['#comment_type'];
// Append additional attributes (eg. RDFa) from the first field item.
$variables['attributes'] += $variables['items'][0]['attributes']->storage();
Alex Pott
committed
// Create separate variables for the comments and comment form.
$variables['comments'] = $element[0]['comments'];
$variables['comment_form'] = $element[0]['comment_form'];
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_ranking().
Dries Buytaert
committed
*/
function comment_ranking() {
catch
committed
return \Drupal::service('comment.statistics')->getRankingInfo();
Alex Pott
committed
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
/**
* Implements hook_ENTITY_TYPE_presave() for entity_view_display entities.
*/
function comment_entity_view_display_presave(EntityViewDisplayInterface $display) {
// Act only on comment view displays being disabled.
if ($display->isNew() || $display->getTargetEntityTypeId() !== 'comment' || $display->status()) {
return;
}
$storage = \Drupal::entityTypeManager()->getStorage('entity_view_display');
if (!$storage->loadUnchanged($display->getOriginalId())->status()) {
return;
}
// Disable the comment field formatter when the used view display is disabled.
foreach ($storage->loadMultiple() as $id => $view_display) {
$changed = FALSE;
/** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $view_display */
foreach ($view_display->getComponents() as $field => $component) {
if (isset($component['type']) && ($component['type'] === 'comment_default')) {
if ($component['settings']['view_mode'] === $display->getMode()) {
$view_display->removeComponent($field);
/** @var \Drupal\Core\Entity\EntityViewModeInterface $mode */
$mode = EntityViewMode::load($display->getTargetEntityTypeId() . '.' . $display->getMode());
$arguments = [
'@id' => $view_display->id(),
'@name' => $field,
'@display' => $mode->label(),
'@mode' => $display->getMode(),
];
\Drupal::logger('system')->warning("View display '@id': Comment field formatter '@name' was disabled because it is using the comment view display '@display' (@mode) that was just disabled.", $arguments);
$changed = TRUE;
}
}
}
if ($changed) {
$view_display->save();
}
}
}