CommentForumFormatter.php in Forum Access 8

Namespace

Drupal\forum_access\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/CommentForumFormatter.php

<?php

namespace Drupal\forum_access\Plugin\Field\FieldFormatter;

use Drupal\comment\Plugin\Field\FieldFormatter\CommentDefaultFormatter;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\Core\Field\FieldItemListInterface;

/**
 * Provides a forum comment formatter.
 *
 * @FieldFormatter(
 *   id = "comment_forum",
 *   module = "forum_access",
 *   label = @Translation("Forum Access comments"),
 *   field_types = {
 *     "comment"
 *   },
 *   quickedit = {
 *     "editor" = "disabled"
 *   }
 * )
 */
class CommentForumFormatter extends CommentDefaultFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    module_load_include('inc', 'forum_access', 'includes/forum_access.common');
    $elements = [];
    $output = [];
    $field_name = $this->fieldDefinition
      ->getName();
    $entity = $items
      ->getEntity();
    $status = $items->status;
    if ($status != CommentItemInterface::HIDDEN && empty($entity->in_preview) && !in_array($this->viewMode, [
      'search_result',
      'search_index',
    ])) {
      $comment_settings = $this
        ->getFieldSettings();

      // Only attempt to render comments if the entity has visible comments.
      // Unpublished comments are not included in
      // $entity->get($field_name)->comment_count, but unpublished comments
      // should display if the user is an administrator.
      $elements['#cache']['contexts'][] = 'user.permissions';
      $elements['#cache']['contexts'][] = 'user.node_grants:operation';
      if ($this->currentUser
        ->hasPermission('access comments') || $this->currentUser
        ->hasPermission('administer comments')) {
        $output['comments'] = [];
        $tid = forum_access_get_tid($entity);
        if ($entity
          ->get($field_name)->comment_count || $this->currentUser
          ->hasPermission('administer comments') || forum_access_access('update', $tid) || forum_access_access('delete', $tid)) {
          $mode = $comment_settings['default_mode'];
          $comments_per_page = $comment_settings['per_page'];
          $comments = $this->storage
            ->loadThread($entity, $field_name, $mode, $comments_per_page, $this
            ->getSetting('pager_id'));
          if ($comments) {
            $build = $this->viewBuilder
              ->viewMultiple($comments, $this
              ->getSetting('view_mode'));
            $build['pager']['#type'] = 'pager';

            // CommentController::commentPermalink() calculates the page number
            // where a specific comment appears and does a subrequest pointing
            // to that page, we need to pass that subrequest route to our pager
            // to keep the pager working.
            $build['pager']['#route_name'] = $this->routeMatch
              ->getRouteObject();
            $build['pager']['#route_parameters'] = $this->routeMatch
              ->getRawParameters()
              ->all();
            if ($this
              ->getSetting('pager_id')) {
              $build['pager']['#element'] = $this
                ->getSetting('pager_id');
            }
            $output['comments'] += $build;
          }
        }
      }

      // Append comment form if the comments are open and the form is set to
      // display below the entity. Do not show the form for the print view mode.
      if ($status == CommentItemInterface::OPEN && $comment_settings['form_location'] == CommentItemInterface::FORM_BELOW && $this->viewMode != 'print') {

        // Only show the add comment form if the user has permission.
        $elements['#cache']['contexts'][] = 'user.roles';
        if ($this->currentUser
          ->hasPermission('post comments')) {
          $output['comment_form'] = [
            '#lazy_builder' => [
              'comment.lazy_builders:renderForm',
              [
                $entity
                  ->getEntityTypeId(),
                $entity
                  ->id(),
                $field_name,
                $this
                  ->getFieldSetting('comment_type'),
              ],
            ],
            '#create_placeholder' => TRUE,
          ];
        }
      }
      $elements[] = $output + [
        '#comment_type' => $this
          ->getFieldSetting('comment_type'),
        '#comment_display_mode' => $this
          ->getFieldSetting('default_mode'),
        'comments' => [],
        'comment_form' => [],
      ];
    }
    return $elements;
  }

}

Classes

Name	Description
CommentForumFormatter	Provides a forum comment formatter.