class CommentGroupContentFormatter in Open Social 10.2.x

Plugin implementation of the 'comment_group_content' formatter.

Plugin annotation

@FieldFormatter(
  id = "comment_group_content",
  label = @Translation("Comment on group content"),
  field_types = {
    "comment"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
      • class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
        • class \Drupal\comment\Plugin\Field\FieldFormatter\CommentDefaultFormatter
          • class \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter

File

modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php, line 31

Namespace

Drupal\group_core_comments\Plugin\Field\FieldFormatter

class CommentGroupContentFormatter extends CommentDefaultFormatter {

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * TRUE if the request is a XMLHttpRequest.
   *
   * @var bool
   */
  private $isXmlHttpRequest;

  /**
   * {@inheritdoc}
   */
  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'), $container
      ->get('renderer'), $container
      ->get('request_stack')
      ->getCurrentRequest()
      ->isXmlHttpRequest());
  }

  /**
   * Constructs a new CommentDefaultFormatter.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Third party settings.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityFormBuilderInterface $entity_form_builder
   *   The entity form builder.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match object.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer interface.
   * @param bool $is_xml_http_request
   *   TRUE if the request is a XMLHttpRequest.
   */
  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, RendererInterface $renderer, $is_xml_http_request) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $entity_type_manager, $entity_form_builder, $route_match, $entity_display_repository);
    $this->renderer = $renderer;
    $this->isXmlHttpRequest = $is_xml_http_request;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $output = parent::viewElements($items, $langcode);
    $entity = $items
      ->getEntity();

    // Exclude entities without the set id.
    if (!empty($entity
      ->id())) {
      $group_contents = GroupContent::loadByEntity($entity);
    }
    if (!empty($group_contents)) {

      // Add cache contexts.
      $output['#cache']['contexts'][] = 'group.type';
      $output['#cache']['contexts'][] = 'user.group_permissions';
      $account = $this->currentUser;

      /** @var \Drupal\group\Entity\GroupInterface $group */
      $group = reset($group_contents)
        ->getGroup();
      $group_url = $group
        ->toUrl('canonical', [
        'language' => $group
          ->language(),
      ]);
      $access_post_comments = $this
        ->getPermissionInGroups('post comments', $account, $group_contents, $output);
      if ($access_post_comments
        ->isForbidden()) {
        $join_directly_bool = FALSE;
        if ($group
          ->getGroupType()
          ->id() === 'flexible_group') {
          if (social_group_flexible_group_can_join_directly($group)) {
            $join_directly_bool = TRUE;
          }
        }
        elseif ($group
          ->hasPermission('join group', $account)) {
          $join_directly_bool = TRUE;
        }

        // If a user can't join directly, about page makes more sense.
        if (!$join_directly_bool) {
          $group_url = Url::fromRoute('view.group_information.page_group_about', [
            'group' => $group
              ->id(),
          ]);
        }
        if ($join_directly_bool) {
          $action = [
            'type' => 'join_directly',
            'label' => $this
              ->t('Join group'),
            'url' => Url::fromRoute('group_core_comments.quick_join_group', [
              'group' => $group
                ->id(),
            ]),
            'class' => 'btn btn-accent',
          ];
        }
        elseif ($group
          ->hasPermission('request group membership', $account)) {
          $url = Url::fromRoute('entity.group.canonical', [
            'group' => $group
              ->id(),
          ]);
          $url = $url
            ->setOption('query', [
            'requested-membership' => $group
              ->id(),
          ]);
          $action = [
            'type' => 'request_only',
            'label' => $this
              ->t('Request only'),
            'url' => $url,
            'class' => 'btn btn-accent',
          ];
        }
        else {
          $action = [
            'type' => 'invitation_only',
            'label' => $this
              ->t('Invitation only'),
            'url' => NULL,
            'class' => 'btn btn-accent disabled',
          ];
        }
        $description = $this
          ->t('You are not allowed to comment on content in a group you are not member of.');
        $group_image = NULL;
        if ($group
          ->hasField('field_group_image') && !$group
          ->get('field_group_image')
          ->isEmpty()) {

          /** @var \Drupal\file\FileInterface $image_file */
          $image_file = $group
            ->get('field_group_image')->entity;
          $group_image = [
            '#theme' => 'image_style',
            '#style_name' => 'social_xx_large',
            '#uri' => $image_file
              ->getFileUri(),
          ];
        }
        $output[0]['comment_form'] = [
          '#theme' => 'comments_join_group',
          '#description' => $description,
          '#group_info' => [
            'image' => $group_image,
            'label' => $group
              ->label(),
            'type' => $group
              ->getGroupType()
              ->label(),
            'members_count' => count($group
              ->getMembers()),
            'url' => $group_url
              ->toString(),
          ],
          '#action' => $action,
        ];
      }
      $access_view_comments = $this
        ->getPermissionInGroups('access comments', $account, $group_contents, $output);
      if ($access_view_comments
        ->isForbidden()) {
        $description = $this
          ->t('You are not allowed to view comments on content in a group you are not member of. You can join the group @group_link.', [
          '@group_link' => Link::fromTextAndUrl($this
            ->t('here'), $group_url)
            ->toString(),
        ]);
        unset($output[0]);
        $output[0]['comments'] = [
          '#markup' => $description,
        ];
      }
    }
    if (!empty($output[0]['comments']) && !$this->isXmlHttpRequest) {
      $comment_settings = $this
        ->getFieldSettings();
      $output[0]['comments'] = [
        '#lazy_builder' => [
          'social_comment.lazy_renderer:renderComments',
          [
            $entity
              ->getEntityTypeId(),
            $entity
              ->id(),
            $comment_settings['default_mode'],
            $items
              ->getName(),
            $comment_settings['per_page'],
            $this
              ->getSetting('pager_id'),
            $this
              ->getSetting('view_mode'),
          ],
        ],
        '#create_placeholder' => TRUE,
      ];
    }
    return $output;
  }

  /**
   * Checks if account was granted permission in group.
   */
  protected function getPermissionInGroups($perm, AccountInterface $account, $group_contents, &$output) {
    foreach ($group_contents as $group_content) {
      $group = $group_content
        ->getGroup();

      // Add cacheable dependency.
      $membership = $group
        ->getMember($account);
      $this->renderer
        ->addCacheableDependency($output, $membership);
      if ($group
        ->hasPermission($perm, $account)) {
        return AccessResult::allowed()
          ->cachePerUser();
      }
    }

    // Fallback.
    return AccessResult::forbidden()
      ->cachePerUser();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommentDefaultFormatter::$currentUser	protected	property	The current user.
CommentDefaultFormatter::$entityDisplayRepository	protected	property	The entity display repository.
CommentDefaultFormatter::$entityFormBuilder	protected	property	The entity form builder.
CommentDefaultFormatter::$routeMatch	protected	property
CommentDefaultFormatter::$storage	protected	property	The comment storage.
CommentDefaultFormatter::$viewBuilder	protected	property	The comment render controller.
CommentDefaultFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
CommentDefaultFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
CommentDefaultFormatter::getViewModes	protected	function	Provides a list of comment view modes for the configured comment type.
CommentDefaultFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
CommentDefaultFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
CommentGroupContentFormatter::$isXmlHttpRequest	private	property	TRUE if the request is a XMLHttpRequest.
CommentGroupContentFormatter::$renderer	protected	property	The renderer.
CommentGroupContentFormatter::create	public static	function	Creates an instance of the plugin. Overrides CommentDefaultFormatter::create
CommentGroupContentFormatter::getPermissionInGroups	protected	function	Checks if account was granted permission in group.
CommentGroupContentFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides CommentDefaultFormatter::viewElements
CommentGroupContentFormatter::__construct	public	function	Constructs a new CommentDefaultFormatter. Overrides CommentDefaultFormatter::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.