View source
<?php
namespace Drupal\comment\Plugin\Field\FieldFormatter;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\Core\Entity\EntityDisplayRepositoryInterface;
use Drupal\Core\Entity\EntityFormBuilderInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Routing\RouteMatchInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
class CommentDefaultFormatter extends FormatterBase {
public static function defaultSettings() {
return [
'view_mode' => 'default',
'pager_id' => 0,
] + parent::defaultSettings();
}
protected $storage;
protected $currentUser;
protected $viewBuilder;
protected $entityDisplayRepository;
protected $entityFormBuilder;
protected $routeMatch;
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
->get('current_user'), $container
->get('entity_type.manager'), $container
->get('entity.form_builder'), $container
->get('current_route_match'), $container
->get('entity_display.repository'));
}
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, EntityFormBuilderInterface $entity_form_builder, RouteMatchInterface $route_match, EntityDisplayRepositoryInterface $entity_display_repository) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->viewBuilder = $entity_type_manager
->getViewBuilder('comment');
$this->storage = $entity_type_manager
->getStorage('comment');
$this->currentUser = $current_user;
$this->entityFormBuilder = $entity_form_builder;
$this->routeMatch = $route_match;
$this->entityDisplayRepository = $entity_display_repository;
}
public function viewElements(FieldItemListInterface $items, $langcode) {
$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();
$elements['#cache']['contexts'][] = 'user.permissions';
if ($this->currentUser
->hasPermission('access comments') || $this->currentUser
->hasPermission('administer comments')) {
$output['comments'] = [];
if ($entity
->get($field_name)->comment_count || $this->currentUser
->hasPermission('administer comments')) {
$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';
$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;
}
}
}
if ($status == CommentItemInterface::OPEN && $comment_settings['form_location'] == CommentItemInterface::FORM_BELOW && $this->viewMode != 'print') {
$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;
}
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = [];
$view_modes = $this
->getViewModes();
$element['view_mode'] = [
'#type' => 'select',
'#title' => $this
->t('Comments view mode'),
'#description' => $this
->t('Select the view mode used to show the list of comments.'),
'#default_value' => $this
->getSetting('view_mode'),
'#options' => $view_modes,
'#access' => count($view_modes) > 1,
];
$element['pager_id'] = [
'#type' => 'select',
'#title' => $this
->t('Pager ID'),
'#options' => range(0, 10),
'#default_value' => $this
->getSetting('pager_id'),
'#description' => $this
->t("Unless you're experiencing problems with pagers related to this field, you should leave this at 0. If using multiple pagers on one page you may need to set this number to a higher value so as not to conflict within the ?page= array. Large values will add a lot of commas to your URLs, so avoid if possible."),
];
return $element;
}
public function settingsSummary() {
$view_mode = $this
->getSetting('view_mode');
$view_modes = $this
->getViewModes();
$view_mode_label = isset($view_modes[$view_mode]) ? $view_modes[$view_mode] : 'default';
$summary = [
$this
->t('Comment view mode: @mode', [
'@mode' => $view_mode_label,
]),
];
if ($pager_id = $this
->getSetting('pager_id')) {
$summary[] = $this
->t('Pager ID: @id', [
'@id' => $pager_id,
]);
}
return $summary;
}
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
if ($mode = $this
->getSetting('view_mode')) {
if ($bundle = $this
->getFieldSetting('comment_type')) {
if ($display = EntityViewDisplay::load("comment.{$bundle}.{$mode}")) {
$dependencies[$display
->getConfigDependencyKey()][] = $display
->getConfigDependencyName();
}
}
}
return $dependencies;
}
protected function getViewModes() {
return $this->entityDisplayRepository
->getViewModeOptionsByBundle('comment', $this
->getFieldSetting('comment_type'));
}
}