class ViewsBlock

Same name in this branch
  1. 9 core/modules/views/src/Plugin/Derivative/ViewsBlock.php \Drupal\views\Plugin\Derivative\ViewsBlock
Same name in other branches
  1. 8.9.x core/modules/views/src/Plugin/Derivative/ViewsBlock.php \Drupal\views\Plugin\Derivative\ViewsBlock
  2. 8.9.x core/modules/views/src/Plugin/Block/ViewsBlock.php \Drupal\views\Plugin\Block\ViewsBlock
  3. 10 core/modules/views/src/Plugin/Derivative/ViewsBlock.php \Drupal\views\Plugin\Derivative\ViewsBlock
  4. 10 core/modules/views/src/Plugin/Block/ViewsBlock.php \Drupal\views\Plugin\Block\ViewsBlock
  5. 11.x core/modules/views/src/Plugin/Derivative/ViewsBlock.php \Drupal\views\Plugin\Derivative\ViewsBlock
  6. 11.x core/modules/views/src/Plugin/Block/ViewsBlock.php \Drupal\views\Plugin\Block\ViewsBlock

Provides a generic Views block.

Plugin annotation


@Block(
  id = "views_block",
  admin_label = @Translation("Views Block"),
  deriver = "Drupal\views\Plugin\Derivative\ViewsBlock"
)

Hierarchy

Expanded class hierarchy of ViewsBlock

4 files declare their use of ViewsBlock
Block.php in core/modules/views/src/Plugin/views/display/Block.php
BlockComponentRenderArray.php in core/modules/layout_builder/src/EventSubscriber/BlockComponentRenderArray.php
ViewsBlockTest.php in core/modules/views/tests/src/Unit/Plugin/Block/ViewsBlockTest.php
ViewsBlockTest.php in core/modules/views/tests/src/Kernel/Plugin/ViewsBlockTest.php

File

core/modules/views/src/Plugin/Block/ViewsBlock.php, line 19

Namespace

Drupal\views\Plugin\Block
View source
class ViewsBlock extends ViewsBlockBase {
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $this->view->display_handler
            ->preBlockBuild($this);
        $args = [];
        foreach ($this->view->display_handler
            ->getHandlers('argument') as $argument_name => $argument) {
            // Initialize the argument value. Work around a limitation in
            // \Drupal\views\ViewExecutable::_buildArguments() that skips processing
            // later arguments if an argument with default action "ignore" and no
            // argument is provided.
            $args[$argument_name] = $argument->options['default_action'] == 'ignore' ? 'all' : NULL;
            if (!empty($this->context[$argument_name])) {
                if ($value = $this->context[$argument_name]
                    ->getContextValue()) {
                    // Context values are often entities, but views arguments expect to
                    // receive just the entity ID, convert it.
                    if ($value instanceof EntityInterface) {
                        $value = $value->id();
                    }
                    $args[$argument_name] = $value;
                }
            }
        }
        // We ask ViewExecutable::buildRenderable() to avoid creating a render cache
        // entry for the view output by passing FALSE, because we're going to cache
        // the whole block instead.
        if ($output = $this->view
            ->buildRenderable($this->displayID, array_values($args), FALSE)) {
            // Before returning the block output, convert it to a renderable array
            // with contextual links.
            $this->addContextualLinks($output);
            // Block module expects to get a final render array, without another
            // top-level #pre_render callback. So, here we make sure that Views'
            // #pre_render callback has already been applied.
            $output = View::preRenderViewElement($output);
            // Override the label to the dynamic title configured in the view.
            if (empty($this->configuration['views_label']) && $this->view
                ->getTitle()) {
                $output['#title'] = [
                    '#markup' => $this->view
                        ->getTitle(),
                    '#allowed_tags' => Xss::getHtmlTagList(),
                ];
            }
            // When view_build is empty, the actual render array output for this View
            // is going to be empty. In that case, return just #cache, so that the
            // render system knows the reasons (cache contexts & tags) why this Views
            // block is empty, and can cache it accordingly.
            if (empty($output['view_build'])) {
                $output = [
                    '#cache' => $output['#cache'],
                ];
            }
            return $output;
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfiguration() {
        $configuration = parent::getConfiguration();
        // Set the label to the static title configured in the view.
        if (!empty($configuration['views_label'])) {
            $configuration['label'] = $configuration['views_label'];
        }
        return $configuration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        $settings = parent::defaultConfiguration();
        if ($this->displaySet) {
            $settings += $this->view->display_handler
                ->blockSettings($settings);
        }
        // Set custom cache settings.
        if (isset($this->pluginDefinition['cache'])) {
            $settings['cache'] = $this->pluginDefinition['cache'];
        }
        return $settings;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        if ($this->displaySet) {
            return $this->view->display_handler
                ->blockForm($this, $form, $form_state);
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockValidate($form, FormStateInterface $form_state) {
        if ($this->displaySet) {
            $this->view->display_handler
                ->blockValidate($this, $form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        parent::blockSubmit($form, $form_state);
        if ($this->displaySet) {
            $this->view->display_handler
                ->blockSubmit($this, $form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMachineNameSuggestion() {
        $this->view
            ->setDisplay($this->displayID);
        return 'views_block__' . $this->view->storage
            ->id() . '_' . $this->view->current_display;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::buildConfigurationForm 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.
Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
ViewsBlock::blockForm public function Overrides BlockPluginTrait::blockForm
ViewsBlock::blockSubmit public function Overrides ViewsBlockBase::blockSubmit
ViewsBlock::blockValidate public function Overrides BlockPluginTrait::blockValidate
ViewsBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ViewsBlock::defaultConfiguration public function Overrides ViewsBlockBase::defaultConfiguration
ViewsBlock::getConfiguration public function Overrides BlockPluginTrait::getConfiguration
ViewsBlock::getMachineNameSuggestion public function Overrides BlockPluginTrait::getMachineNameSuggestion
ViewsBlockBase::$displayID protected property The display ID being used for this View.
ViewsBlockBase::$displaySet protected property Indicates whether the display was successfully set.
ViewsBlockBase::$user protected property The current user.
ViewsBlockBase::$view protected property The View executable object.
ViewsBlockBase::addContextualLinks protected function Converts Views block content to a renderable array with contextual links.
ViewsBlockBase::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
ViewsBlockBase::buildConfigurationForm public function Form constructor. Overrides BlockBase::buildConfigurationForm
ViewsBlockBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ViewsBlockBase::getPreviewFallbackString public function Overrides BlockPluginTrait::getPreviewFallbackString
ViewsBlockBase::getViewExecutable public function Gets the view executable.
ViewsBlockBase::__construct public function Constructs a \Drupal\views\Plugin\Block\ViewsBlockBase object. Overrides BlockPluginTrait::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.