class CommentGroupContentFormatter in Open Social 8.9
Same name and namespace in other branches
- 8 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.2 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.3 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.4 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.5 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.6 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.7 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 8.8 modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 10.3.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 10.0.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 10.1.x modules/custom/group_core_comments/src/Plugin/Field/FieldFormatter/CommentGroupContentFormatter.php \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- 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
- 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 implements ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait
- class \Drupal\group_core_comments\Plugin\Field\FieldFormatter\CommentGroupContentFormatter
- class \Drupal\comment\Plugin\Field\FieldFormatter\CommentDefaultFormatter implements ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of CommentGroupContentFormatter
File
- modules/
custom/ group_core_comments/ src/ Plugin/ Field/ FieldFormatter/ CommentGroupContentFormatter.php, line 24
Namespace
Drupal\group_core_comments\Plugin\Field\FieldFormatterView 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'][] = 'user.group_permissions';
$account = \Drupal::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'])) {
$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'),
],
],
'#create_placeholder' => TRUE,
];
}
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
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommentDefaultFormatter:: |
protected | property | The current user. | |
CommentDefaultFormatter:: |
protected | property | ||
CommentDefaultFormatter:: |
protected | property | The entity display repository. | |
CommentDefaultFormatter:: |
protected | property | The entity form builder. | |
CommentDefaultFormatter:: |
protected | property | ||
CommentDefaultFormatter:: |
protected | property | The comment storage. | |
CommentDefaultFormatter:: |
protected | property | The comment render controller. | |
CommentDefaultFormatter:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginSettingsBase:: |
|
CommentDefaultFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
CommentDefaultFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
CommentDefaultFormatter:: |
protected | function | Provides a list of comment view modes for the configured comment type. | |
CommentDefaultFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
CommentDefaultFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
|
CommentDefaultFormatter:: |
public | function |
Constructs a new CommentDefaultFormatter. Overrides FormatterBase:: |
|
CommentGroupContentFormatter:: |
protected | function | Checks if account was granted permission in group. | |
CommentGroupContentFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides CommentDefaultFormatter:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |