You are here

class CommentGroupContentFormatter in Open Social 8

Same name and namespace in other branches
  1. 8.9 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  2. 8.2 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  3. 8.3 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  4. 8.4 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  5. 8.5 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  6. 8.6 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  7. 8.7 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  8. 8.8 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  9. 10.3.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  10. 10.0.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  11. 10.1.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
  12. 10.2.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter

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

Expanded class hierarchy of CommentGroupContentFormatter

File

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

Namespace

Drupal\group_core_comments\Plugin\Field\FieldFormatter
View source
class CommentGroupContentFormatter extends CommentDefaultFormatter {

  /**
   * {@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'][] = 'group_membership';
      $account = \Drupal::currentUser();
      $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()) {
        $description = $this
          ->t('You are not allowed to comment 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(),
        ]);
        $output[0]['comment_form'] = [
          '#prefix' => '<hr>',
          '#markup' => $description,
        ];
      }
      $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,
        ];
      }
    }
    return $output;
  }

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

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

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

}

Members

Namesort descending Modifiers Type Description Overrides
CommentDefaultFormatter::$currentUser protected property The current user.
CommentDefaultFormatter::$deprecatedProperties protected property
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::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
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
CommentDefaultFormatter::__construct public function Constructs a new CommentDefaultFormatter. Overrides FormatterBase::__construct
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
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 1
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.