class SocialGroupTagsBlock in Open Social 8.4
Same name and namespace in other branches
- 8.9 modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 8.5 modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 8.6 modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 8.7 modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 8.8 modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 10.3.x modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 10.0.x modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 10.1.x modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
- 10.2.x modules/social_features/social_tagging/src/Plugin/Block/SocialGroupTagsBlock.php \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock
Provides a 'SocialGroupTags' block.
Plugin annotation
@Block(
id = "social_group_tags_block",
admin_label = @Translation("Social Group Tags block"),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
- class \Drupal\social_tagging\Plugin\Block\SocialGroupTagsBlock implements ContainerFactoryPluginInterface
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Expanded class hierarchy of SocialGroupTagsBlock
File
- modules/
social_features/ social_tagging/ src/ Plugin/ Block/ SocialGroupTagsBlock.php, line 24
Namespace
Drupal\social_tagging\Plugin\BlockView source
class SocialGroupTagsBlock extends BlockBase implements ContainerFactoryPluginInterface {
/**
* The route match.
*
* @var \Drupal\Core\Routing\RouteMatchInterface
*/
protected $routeMatch;
/**
* The route match.
*
* @var \Drupal\social_tagging\SocialTaggingService
*/
protected $tagService;
/**
* EventAddBlock constructor.
*
* @param array $configuration
* The given configuration.
* @param string $plugin_id
* The given plugin id.
* @param mixed $plugin_definition
* The given plugin definition.
* @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
* The route match.
* @param \Drupal\social_tagging\SocialTaggingService $tagging_service
* The tag service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $routeMatch, SocialTaggingService $tagging_service) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->routeMatch = $routeMatch;
$this->tagService = $tagging_service;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('current_route_match'), $container
->get('social_tagging.tag_service'));
}
/**
* {@inheritdoc}
*
* Logic to display the block in the sidebar.
*/
protected function blockAccess(AccountInterface $account) {
// If tagging is off, deny access always.
if (!$this->tagService
->active() || !$this->tagService
->groupActive()) {
return AccessResult::forbidden();
}
// Routes we don't want to display the tag block on.
$ignore_routes = [
'entity.group.join',
'entity.group.leave',
'entity.group.edit_form',
'entity.group.delete_form',
'entity.group_content.collection',
];
// Don't display on group edit.
if (in_array($this->routeMatch
->getRouteName(), $ignore_routes)) {
return AccessResult::forbidden();
}
// Get group from route.
$group = $this->routeMatch
->getParameter('group');
if ($group instanceof Group) {
if ($group
->hasField('social_tagging')) {
if (!empty($group
->get('social_tagging')
->getValue())) {
// We only show the block if the field contains values.
return AccessResult::allowed();
}
}
}
return AccessResult::forbidden();
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
$cache_tags = parent::getCacheTags();
$group = $this->routeMatch
->getParameter('group');
if ($group instanceof GroupInterface) {
$cache_tags[] = 'group:' . $group
->id();
}
return $cache_tags;
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
$contexts = parent::getCacheContexts();
$group = $this->routeMatch
->getParameter('group');
if ($group instanceof GroupInterface) {
$contexts = Cache::mergeContexts($contexts, [
'group',
]);
}
return $contexts;
}
/**
* {@inheritdoc}
*/
public function build() {
$build = [];
$group = $this->routeMatch
->getParameter('group');
if ($group instanceof GroupInterface) {
$build['content']['#markup'] = social_tagging_process_tags($group);
}
return $build;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockPluginInterface:: |
constant | Indicates the block label (title) should be displayed to end users. | ||
BlockPluginTrait:: |
protected | property | The transliteration service. | |
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
protected | function | Returns generic default configuration for block plugins. | |
BlockPluginTrait:: |
public | function | 16 | |
BlockPluginTrait:: |
public | function | 13 | |
BlockPluginTrait:: |
public | function | 3 | |
BlockPluginTrait:: |
public | function | Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. | 2 |
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | 19 | |
BlockPluginTrait:: |
public | function | 1 | |
BlockPluginTrait:: |
public | function | 1 | |
BlockPluginTrait:: |
public | function | 3 | |
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | ||
BlockPluginTrait:: |
public | function | Sets the transliteration service. | |
BlockPluginTrait:: |
public | function | Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). | |
BlockPluginTrait:: |
protected | function | Wraps the transliteration service. | |
BlockPluginTrait:: |
public | function | Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). | 1 |
ContextAwarePluginAssignmentTrait:: |
protected | function | Builds a form element for assigning a context to a given slot. | |
ContextAwarePluginAssignmentTrait:: |
protected | function | Wraps the context handler. | |
ContextAwarePluginBase:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginBase:: |
private | property | Data objects representing the contexts passed in the plugin configuration. | |
ContextAwarePluginBase:: |
protected | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
7 |
ContextAwarePluginBase:: |
public | function |
This code is identical to the Component in order to pick up a different
Context class. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the value for a defined context. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the values for all defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Set a context on this plugin. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Sets the value for a defined context. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function | Implements magic __get() method. | |
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 | |
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. | |
PluginWithFormsTrait:: |
public | function | ||
PluginWithFormsTrait:: |
public | function | ||
SocialGroupTagsBlock:: |
protected | property | The route match. | |
SocialGroupTagsBlock:: |
protected | property | The route match. | |
SocialGroupTagsBlock:: |
protected | function |
Logic to display the block in the sidebar. Overrides BlockPluginTrait:: |
|
SocialGroupTagsBlock:: |
public | function |
Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface:: |
|
SocialGroupTagsBlock:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
SocialGroupTagsBlock:: |
public | function |
The cache contexts associated with this object. Overrides ContextAwarePluginBase:: |
|
SocialGroupTagsBlock:: |
public | function |
The cache tags associated with this object. Overrides ContextAwarePluginBase:: |
|
SocialGroupTagsBlock:: |
public | function |
EventAddBlock constructor. Overrides BlockPluginTrait:: |
|
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. | |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |