You are here

SocialLazyCommentDefaultFormatter.php in Open Social 10.0.x

File

modules/social_features/social_comment/src/Plugin/Field/FieldFormatter/SocialLazyCommentDefaultFormatter.php
View source
<?php

namespace Drupal\social_comment\Plugin\Field\FieldFormatter;

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

/**
 * Provides a default comment formatter.
 *
 * @FieldFormatter(
 *   id = "social_lazy_comment_default",
 *   module = "social_comment",
 *   label = @Translation("Social comment list(Lazy build)"),
 *   field_types = {
 *     "comment"
 *   },
 *   quickedit = {
 *     "editor" = "disabled"
 *   }
 * )
 */
class SocialLazyCommentDefaultFormatter extends CommentDefaultFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    // Elements from core comment formatter.
    $elements = parent::viewElements($items, $langcode);

    // Check if comments exists.
    if (!empty($elements[0]['comments'])) {
      $comment_settings = $this
        ->getFieldSettings();

      // Replace comments with lazy builder.
      $elements[0]['comments'] = [
        '#lazy_builder' => [
          'social_comment.lazy_renderer:renderComments',
          [
            $items
              ->getEntity()
              ->getEntityTypeId(),
            $items
              ->getEntity()
              ->id(),
            $comment_settings['default_mode'],
            $items
              ->getName(),
            $comment_settings['per_page'],
            $this
              ->getSetting('pager_id'),
          ],
        ],
        '#create_placeholder' => TRUE,
      ];
    }
    return $elements;
  }

}

Classes

Namesort descending Description
SocialLazyCommentDefaultFormatter Provides a default comment formatter.