class Block in Zircon Profile 8
Same name in this branch
- 8 core/modules/block/src/Entity/Block.php \Drupal\block\Entity\Block
- 8 core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
- 8 core/modules/views/src/Plugin/views/display/Block.php \Drupal\views\Plugin\views\display\Block
- 8 core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block
Same name and namespace in other branches
- 8.0 core/modules/views/src/Plugin/views/display/Block.php \Drupal\views\Plugin\views\display\Block
The plugin that handles a block.
Plugin annotation
@ViewsDisplay(
id = "block",
title = @Translation("Block"),
help = @Translation("Display the view as a block."),
theme = "views_view",
register_theme = FALSE,
uses_hook_block = TRUE,
contextual_links_locations = {"block"},
admin = @Translation("Block")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\display\DisplayPluginBase implements DependentPluginInterface, DisplayPluginInterface uses PluginDependencyTrait
- 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, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of Block
See also
\Drupal\views\Plugin\block\block\ViewsBlock
\Drupal\views\Plugin\Derivative\ViewsBlock
Related topics
23 string references to 'Block'
- block.info.yml in core/
modules/ block/ block.info.yml - core/modules/block/block.info.yml
- block.schema.yml in core/
modules/ block/ config/ schema/ block.schema.yml - core/modules/block/config/schema/block.schema.yml
- BlockLibraryController::listBlocks in core/
modules/ block/ src/ Controller/ BlockLibraryController.php - Shows a list of blocks that can be added to a theme's layout.
- BlockListBuilder::buildBlocksForm in core/
modules/ block/ src/ BlockListBuilder.php - Builds the main "Blocks" portion of the form.
- book.schema.yml in core/
modules/ book/ config/ schema/ book.schema.yml - core/modules/book/config/schema/book.schema.yml
File
- core/
modules/ views/ src/ Plugin/ views/ display/ Block.php, line 34 - Contains \Drupal\views\Plugin\views\display\Block.
Namespace
Drupal\views\Plugin\views\displayView source
class Block extends DisplayPluginBase {
/**
* Whether the display allows attachments.
*
* @var bool
*/
protected $usesAttachments = TRUE;
/**
* The entity manager.
*
* @var \Drupal\Core\Entity\EntityManagerInterface
*/
protected $entityManager;
/**
* 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\EntityManagerInterface $entity_manager
* The entity manager.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityManager = $entity_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity.manager'));
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['block_description'] = array(
'default' => '',
);
$options['block_category'] = array(
'default' => $this
->t('Lists (Views)'),
);
$options['block_hide_empty'] = array(
'default' => FALSE,
);
$options['allow'] = array(
'contains' => array(
'items_per_page' => array(
'default' => 'items_per_page',
),
),
);
return $options;
}
/**
* Returns plugin-specific settings for the block.
*
* @param array $settings
* The settings of the block.
*
* @return array
* An array of block-specific settings to override the defaults provided in
* \Drupal\views\Plugin\Block\ViewsBlock::defaultConfiguration().
*
* @see \Drupal\views\Plugin\Block\ViewsBlock::defaultConfiguration()
*/
public function blockSettings(array $settings) {
$settings['items_per_page'] = 'none';
return $settings;
}
/**
* The display block handler returns the structure necessary for a block.
*/
public function execute() {
// Prior to this being called, the $view should already be set to this
// display, and arguments should be set on the view.
$element = $this->view
->render();
if ($this
->outputIsEmpty() && $this
->getOption('block_hide_empty') && empty($this->view->style_plugin->definition['even empty'])) {
return array();
}
else {
return $element;
}
}
/**
* Provide the summary for page options in the views UI.
*
* This output is returned as an array.
*/
public function optionsSummary(&$categories, &$options) {
parent::optionsSummary($categories, $options);
$categories['block'] = array(
'title' => $this
->t('Block settings'),
'column' => 'second',
'build' => array(
'#weight' => -10,
),
);
$block_description = strip_tags($this
->getOption('block_description'));
if (empty($block_description)) {
$block_description = $this
->t('None');
}
$block_category = $this
->getOption('block_category');
$options['block_description'] = array(
'category' => 'block',
'title' => $this
->t('Block name'),
'value' => views_ui_truncate($block_description, 24),
);
$options['block_category'] = array(
'category' => 'block',
'title' => $this
->t('Block category'),
'value' => views_ui_truncate($block_category, 24),
);
$filtered_allow = array_filter($this
->getOption('allow'));
$options['allow'] = array(
'category' => 'block',
'title' => $this
->t('Allow settings'),
'value' => empty($filtered_allow) ? $this
->t('None') : $this
->t('Items per page'),
);
$options['block_hide_empty'] = array(
'category' => 'other',
'title' => $this
->t('Hide block if the view output is empty'),
'value' => $this
->getOption('block_hide_empty') ? $this
->t('Yes') : $this
->t('No'),
);
}
/**
* Provide the default form for setting options.
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
switch ($form_state
->get('section')) {
case 'block_description':
$form['#title'] .= $this
->t('Block admin description');
$form['block_description'] = array(
'#type' => 'textfield',
'#description' => $this
->t('This will appear as the name of this block in administer >> structure >> blocks.'),
'#default_value' => $this
->getOption('block_description'),
);
break;
case 'block_category':
$form['#title'] .= $this
->t('Block category');
$form['block_category'] = array(
'#type' => 'textfield',
'#autocomplete_route_name' => 'block.category_autocomplete',
'#description' => $this
->t('The category this block will appear under on the <a href=":href">blocks placement page</a>.', array(
':href' => \Drupal::url('block.admin_display'),
)),
'#default_value' => $this
->getOption('block_category'),
);
break;
case 'block_hide_empty':
$form['#title'] .= $this
->t('Block empty settings');
$form['block_hide_empty'] = array(
'#title' => $this
->t('Hide block if no result/empty text'),
'#type' => 'checkbox',
'#description' => $this
->t('Hide the block if there is no result and no empty text and no header/footer which is shown on empty result'),
'#default_value' => $this
->getOption('block_hide_empty'),
);
break;
case 'exposed_form_options':
$this->view
->initHandlers();
if (!$this
->usesExposed() && parent::usesExposed()) {
$form['exposed_form_options']['warning'] = array(
'#weight' => -10,
'#markup' => '<div class="messages messages--warning">' . $this
->t('Exposed filters in block displays require "Use AJAX" to be set to work correctly.') . '</div>',
);
}
break;
case 'allow':
$form['#title'] .= $this
->t('Allow settings in the block configuration');
$options = array(
'items_per_page' => $this
->t('Items per page'),
);
$allow = array_filter($this
->getOption('allow'));
$form['allow'] = array(
'#type' => 'checkboxes',
'#default_value' => $allow,
'#options' => $options,
);
break;
}
}
/**
* Perform any necessary changes to the form values prior to storage.
* There is no need for this function to actually store the data.
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
parent::submitOptionsForm($form, $form_state);
$section = $form_state
->get('section');
switch ($section) {
case 'block_description':
case 'block_category':
case 'allow':
case 'block_hide_empty':
$this
->setOption($section, $form_state
->getValue($section));
break;
}
}
/**
* Adds the configuration form elements specific to this views block plugin.
*
* This method allows block instances to override the views items_per_page.
*
* @param \Drupal\views\Plugin\Block\ViewsBlock $block
* The ViewsBlock plugin.
* @param array $form
* The form definition array for the block configuration form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return array $form
* The renderable form array representing the entire configuration form.
*
* @see \Drupal\views\Plugin\Block\ViewsBlock::blockForm()
*/
public function blockForm(ViewsBlock $block, array &$form, FormStateInterface $form_state) {
$allow_settings = array_filter($this
->getOption('allow'));
$block_configuration = $block
->getConfiguration();
foreach ($allow_settings as $type => $enabled) {
if (empty($enabled)) {
continue;
}
switch ($type) {
case 'items_per_page':
$form['override']['items_per_page'] = array(
'#type' => 'select',
'#title' => $this
->t('Items per block'),
'#options' => array(
'none' => $this
->t('@count (default setting)', array(
'@count' => $this
->getPlugin('pager')
->getItemsPerPage(),
)),
5 => 5,
10 => 10,
20 => 20,
40 => 40,
),
'#default_value' => $block_configuration['items_per_page'],
);
break;
}
}
return $form;
}
/**
* Handles form validation for the views block configuration form.
*
* @param \Drupal\views\Plugin\Block\ViewsBlock $block
* The ViewsBlock plugin.
* @param array $form
* The form definition array for the block configuration form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @see \Drupal\views\Plugin\Block\ViewsBlock::blockValidate()
*/
public function blockValidate(ViewsBlock $block, array $form, FormStateInterface $form_state) {
}
/**
* Handles form submission for the views block configuration form.
*
* @param \Drupal\views\Plugin\Block\ViewsBlock $block
* The ViewsBlock plugin.
* @param array $form
* The form definition array for the full block configuration form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* * @see \Drupal\views\Plugin\Block\ViewsBlock::blockSubmit()
*/
public function blockSubmit(ViewsBlock $block, $form, FormStateInterface $form_state) {
if ($items_per_page = $form_state
->getValue(array(
'override',
'items_per_page',
))) {
$block
->setConfigurationValue('items_per_page', $items_per_page);
}
$form_state
->unsetValue(array(
'override',
'items_per_page',
));
}
/**
* Allows to change the display settings right before executing the block.
*
* @param \Drupal\views\Plugin\Block\ViewsBlock $block
* The block plugin for views displays.
*/
public function preBlockBuild(ViewsBlock $block) {
$config = $block
->getConfiguration();
if ($config['items_per_page'] !== 'none') {
$this->view
->setItemsPerPage($config['items_per_page']);
}
}
/**
* Block views use exposed widgets only if AJAX is set.
*/
public function usesExposed() {
if ($this
->ajaxEnabled()) {
return parent::usesExposed();
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function remove() {
parent::remove();
if ($this->entityManager
->hasDefinition('block')) {
$plugin_id = 'views_block:' . $this->view->storage
->id() . '-' . $this->display['id'];
foreach ($this->entityManager
->getStorage('block')
->loadByProperties([
'plugin' => $plugin_id,
]) as $block) {
$block
->delete();
}
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Block:: |
protected | property | The entity manager. | |
Block:: |
protected | property |
Whether the display allows attachments. Overrides DisplayPluginBase:: |
|
Block:: |
public | function | Adds the configuration form elements specific to this views block plugin. | |
Block:: |
public | function | Returns plugin-specific settings for the block. | |
Block:: |
public | function | Handles form submission for the views block configuration form. | |
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 static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
Block:: |
protected | function |
Information about options for all kinds of purposes will be held here. 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 | Allows to change the display settings right before executing the block. | |
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 |
Block views use exposed widgets only if AJAX is set. Overrides DisplayPluginBase:: |
|
Block:: |
public | function |
Constructs a new Block instance. Overrides DisplayPluginBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | 1 |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. | |
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:: |
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:: |
|
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:: |
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:: |
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 | 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:: |
5 |
DisplayPluginBase:: |
public | function |
Checks to see if the display can put the exposed form in a block. Overrides DisplayPluginInterface:: |
|
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:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
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. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Stores the render API renderer. | 2 |
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:: |
|
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:: |
8 |
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 |
StringTranslationTrait:: |
protected | property | The string translation service. | |
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. |