class ModeBlock in Open Social 10.2.x
Same name and namespace in other branches
- 8.9 modules/social_features/social_activity/src/Plugin/views/display/ModeBlock.php \Drupal\social_activity\Plugin\views\display\ModeBlock
- 8.8 modules/social_features/social_activity/src/Plugin/views/display/ModeBlock.php \Drupal\social_activity\Plugin\views\display\ModeBlock
- 10.3.x modules/social_features/social_activity/src/Plugin/views/display/ModeBlock.php \Drupal\social_activity\Plugin\views\display\ModeBlock
- 10.0.x modules/social_features/social_activity/src/Plugin/views/display/ModeBlock.php \Drupal\social_activity\Plugin\views\display\ModeBlock
- 10.1.x modules/social_features/social_activity/src/Plugin/views/display/ModeBlock.php \Drupal\social_activity\Plugin\views\display\ModeBlock
The plugin that handles a block.
Plugin annotation
@ViewsDisplay(
id = "mode_block",
title = @Translation("Mode Block"),
help = @Translation("Display the view as a mode block."),
theme = "views_view",
register_theme = FALSE,
uses_hook_block = TRUE,
contextual_links_locations = {"block"},
admin = @Translation("Mode Block")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\display\DisplayPluginBase implements DependentPluginInterface, DisplayPluginInterface uses PluginDependencyTrait
- class \Drupal\views\Plugin\views\display\Block
- class \Drupal\social_activity\Plugin\views\display\ModeBlock uses DeprecatedServicePropertyTrait
- class \Drupal\views\Plugin\views\display\Block
- class \Drupal\views\Plugin\views\display\DisplayPluginBase implements DependentPluginInterface, DisplayPluginInterface uses PluginDependencyTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ModeBlock
See also
\Drupal\views\Plugin\Block\ViewsBlock
\Drupal\views\Plugin\Derivative\ViewsBlock
1 file declares its use of ModeBlock
- FilterBlock.php in modules/
social_features/ social_activity/ modules/ social_activity_filter/ src/ Plugin/ views/ display/ FilterBlock.php
File
- modules/
social_features/ social_activity/ src/ Plugin/ views/ display/ ModeBlock.php, line 33
Namespace
Drupal\social_activity\Plugin\views\displayView source
class ModeBlock extends Block {
use DeprecatedServicePropertyTrait;
/**
* Configuration Factory.
*
* @var \Drupal\Core\Config\ConfigFactory
*/
protected $configFactory;
/**
* Constructs a new Block instance.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity manager.
* @param \Drupal\Core\Block\BlockManagerInterface $block_manager
* The block manager.
* @param \Drupal\Core\Config\ConfigFactory $configFactory
* The config factory.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, BlockManagerInterface $block_manager, ConfigFactory $configFactory) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $block_manager);
$this->configFactory = $configFactory;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager'), $container
->get('plugin.manager.block'), $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['view_mode'] = [
'contains' => [
'type' => [
'default' => 'type',
],
],
];
return $options;
}
/**
* {@inheritdoc}
*/
public function blockSettings(array $settings) {
$settings = parent::blockSettings($settings);
$settings['type'] = 'none';
return $settings;
}
/**
* {@inheritdoc}
*/
public function blockForm(ViewsBlock $block, array &$form, FormStateInterface $form_state) {
parent::blockForm($block, $form, $form_state);
$info = $form_state
->getBuildInfo();
$allow_settings = $this
->getOption('view_mode');
$block_configuration = $block
->getConfiguration();
// Override default view mode only for layout_builder.
if (in_array($info['form_id'], [
'layout_builder_add_block',
'layout_builder_update_block',
])) {
$block_configuration['type'] = 'dashboard';
}
foreach ($allow_settings as $type => $enabled) {
if (empty($enabled)) {
continue;
}
switch ($type) {
case 'type':
$form['override']['type'] = [
'#type' => 'hidden',
'#value' => $block_configuration['type'],
];
break;
}
}
return $form;
}
/**
* {@inheritdoc}
*/
public function blockSubmit(ViewsBlock $block, $form, FormStateInterface $form_state) {
parent::blockSubmit($block, $form, $form_state);
if ($value = $form_state
->getValue([
'override',
'type',
])) {
$block
->setConfigurationValue('type', $value);
}
$form_state
->unsetValue([
'override',
'type',
]);
}
/**
* {@inheritdoc}
*/
public function preBlockBuild(ViewsBlock $block) {
parent::preBlockBuild($block);
// Prepare values to use it in the views filter.
$block_configuration = $block
->getConfiguration();
if (isset($block_configuration['type'])) {
$this->view->filter_type = $block_configuration['type'];
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Block:: |
protected | property | The block manager. | |
Block:: |
protected | property | The entity type manager. | |
Block:: |
protected | property |
Whether the display allows attachments. Overrides DisplayPluginBase:: |
|
Block:: |
public | function | Handles form validation for the views block configuration form. | |
Block:: |
public | function |
Provide the default form for setting options. Overrides DisplayPluginBase:: |
|
Block:: |
public | function |
The display block handler returns the structure necessary for a block. Overrides DisplayPluginBase:: |
|
Block:: |
public | function |
Provide the summary for page options in the views UI. Overrides DisplayPluginBase:: |
|
Block:: |
public | function |
Reacts on deleting a display. Overrides DisplayPluginBase:: |
|
Block:: |
public | function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides DisplayPluginBase:: |
|
Block:: |
public | function |
Checks to see if the display can put the exposed form in a block. Overrides DisplayPluginBase:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
DisplayPluginBase:: |
public | property | The display information coming directly from the view entity. | |
DisplayPluginBase:: |
protected | property | Stores all available display extenders. | |
DisplayPluginBase:: |
public | property | An array of instantiated handlers used in this display. | |
DisplayPluginBase:: |
public | property | Stores the rendered output of the display. | |
DisplayPluginBase:: |
protected | property | An array of instantiated plugins used in this display. | |
DisplayPluginBase:: |
protected static | property | Static cache for unpackOptions, but not if we are in the UI. | |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of AJAX or not. | 2 |
DisplayPluginBase:: |
protected | property | Whether the display allows area plugins. | 2 |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a 'more' link or not. | 1 |
DisplayPluginBase:: |
protected | property |
Denotes whether the plugin has an additional options form. Overrides PluginBase:: |
1 |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a pager or not. | 4 |
DisplayPluginBase:: |
public | property |
The top object of a view. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function |
Determines whether this display can use attachments. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Determines if the user has access to this display of the view. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Whether the display is actually using AJAX or not. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
protected | function | Applies the cacheability of the current display to the given render array. | |
DisplayPluginBase:: |
public | function |
Allows displays to attach to other views. Overrides DisplayPluginInterface:: |
2 |
DisplayPluginBase:: |
public static | function |
Builds a basic render array which can be properly render cached. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Builds a renderable array of the view. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
protected | function | Returns the available rendering strategies for language-aware entities. | |
DisplayPluginBase:: |
public | function |
Calculates the display's cache metadata by inspecting each handler/plugin. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
2 |
DisplayPluginBase:: |
public | function |
Lists the 'defaultable' sections and what items each section contains. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Clears a plugin. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function |
Determines if this display should display the exposed filters widgets. Overrides DisplayPluginInterface:: |
2 |
DisplayPluginBase:: |
public | function |
#pre_render callback for view display rendering. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
protected | function | Gets all the handlers used by the display. | |
DisplayPluginBase:: |
protected | function | Gets all the plugins used by the display. | |
DisplayPluginBase:: |
public | function |
Returns to tokens for arguments. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Provides help text for the arguments. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Find out all displays which are attached to this display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Gets the cache metadata. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Gets the display extenders. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Retrieves a list of fields for the current display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Get the handler object for a single handler. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Get a full array of handlers for $type. This caches them. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Returns the ID of the display to use when making links. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
protected | function | Get the more URL for this view. | |
DisplayPluginBase:: |
public | function |
Gets an option, from this display or the default display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Provides help text for pagers. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Returns the base path to use for this display. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Get the instance of a plugin, for example style or row. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Points to the display which can be linked by this display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Provides the block system with any exposed widget blocks for this display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Returns the display type that this display requires. Overrides DisplayPluginInterface:: |
4 |
DisplayPluginBase:: |
public | function |
Returns a URL to $this display or its configured linked display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Checks to see if the display has a 'path' field. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Initializes the display plugin. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
protected | function | Returns whether the base table is of a translatable entity type. | |
DisplayPluginBase:: |
public | function |
Determines if this display is the 'default' display. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Determines if an option is set to use the default or current display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Whether the display is enabled. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Checks if the provided identifier is unique. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Whether the display is using the 'more' link or not. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Whether the display is using a pager or not. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Merges default values for all plugin types. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
protected | function | Merges handlers default values. | |
DisplayPluginBase:: |
protected | function | Merges plugins default values. | |
DisplayPluginBase:: |
public | function |
Reacts on adding a display. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Returns a link to a section of a form. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
If override/revert was clicked, perform the proper toggle. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Is the output of the view empty. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Set an option and force it to be an override. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Sets up any variables on the view prior to execution. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Renders the display for the purposes of a live preview. Overrides DisplayPluginInterface:: |
3 |
DisplayPluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides PluginBase:: |
1 |
DisplayPluginBase:: |
public | function |
Renders this display. Overrides DisplayPluginInterface:: |
3 |
DisplayPluginBase:: |
public | function |
Renders one of the available areas. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Does nothing (obsolete function). Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Renders the 'more' link. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Checks to see if the display plugins support pager rendering. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Sets an option, on this display or the default display. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Flip the override setting for the given section. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function |
Does the display have groupby enabled? Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Should the enabled display more link be shown when no more items? Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Does the display have custom link text? Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Whether the display allows the use of AJAX or not. Overrides DisplayPluginInterface:: |
2 |
DisplayPluginBase:: |
public | function |
Returns whether the display can use areas. Overrides DisplayPluginInterface:: |
2 |
DisplayPluginBase:: |
public | function |
Returns whether the display can use attachments. Overrides DisplayPluginInterface:: |
6 |
DisplayPluginBase:: |
public | function |
Determines if this display uses exposed filters. Overrides DisplayPluginInterface:: |
3 |
DisplayPluginBase:: |
public | function |
Determines if the display's style uses fields. Overrides DisplayPluginInterface:: |
|
DisplayPluginBase:: |
public | function |
Checks to see if the display has some need to link to another display. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Whether the display allows the use of a 'more' link or not. Overrides DisplayPluginInterface:: |
1 |
DisplayPluginBase:: |
public | function |
Whether the display allows the use of a pager or not. Overrides DisplayPluginInterface:: |
4 |
DisplayPluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides PluginBase:: |
3 |
DisplayPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
2 |
DisplayPluginBase:: |
public | function |
Renders the exposed form as block. Overrides DisplayPluginInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
ModeBlock:: |
protected | property | Configuration Factory. | |
ModeBlock:: |
public | function |
Adds the configuration form elements specific to this views block plugin. Overrides Block:: |
1 |
ModeBlock:: |
public | function |
Returns plugin-specific settings for the block. Overrides Block:: |
1 |
ModeBlock:: |
public | function |
Handles form submission for the views block configuration form. Overrides Block:: |
1 |
ModeBlock:: |
public static | function |
Creates an instance of the plugin. Overrides Block:: |
|
ModeBlock:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides Block:: |
1 |
ModeBlock:: |
public | function |
Allows to change the display settings right before executing the block. Overrides Block:: |
1 |
ModeBlock:: |
public | function |
Constructs a new Block instance. Overrides Block:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 3 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
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:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
public | function |
Initialize the plugin. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | |
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. |