You are here

Home » API reference » Block Tabs 8 » BlockTab.php

class BlockTab in Block Tabs 8

Block tab.

Plugin annotation


@Tab(
  id = "block_tab",
  label = @Translation("block plugin tab"),
  description = @Translation("block plugin tab.")
)

Hierarchy

Expanded class hierarchy of BlockTab

File

src/Plugin/Tab/BlockTab.php, line 21

Namespace

Drupal\blocktabs\Plugin\Tab
View source 
class BlockTab extends ConfigurableTabBase {

  /**
   * The block manager.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * The block plugin.
   *
   * @var \Drupal\Core\Block\BlockPluginInterface
   */
  protected $blockPlugin;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.factory')
      ->get('blocktabs'), $container
      ->get('plugin.manager.block'));
  }

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger, BlockManagerInterface $block_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $logger);
    $config = $this->configuration['config'];
    $this->blockManager = $block_manager;
    $this->blockPlugin = $this->blockManager
      ->createInstance($this->configuration['block_id'], $config);
  }

  /**
   * {@inheritdoc}
   */
  public function addTab(BlocktabsInterface $blocktabs) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = [
      '#markup' => '(' . $this
        ->t('Block plugin id:') . $this->configuration['block_id'] . ')',
    ];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'block_id' => NULL,
      'config' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $definitions = $this->blockManager
      ->getGroupedDefinitions();
    $options = [];
    foreach ($definitions as $group => $blocks) {
      $options[$group] = [];
      foreach ($blocks as $id => $block) {
        $options[$group][$id] = $block['admin_label'];
      }
    }
    $form['block_id'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Block id'),
      '#options' => $options,
      '#default_value' => $this->configuration['block_id'],
      '#required' => TRUE,
    ];
    if ($this->configuration['block_id']) {
      $form += $this->blockPlugin
        ->blockForm([], $form_state);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['block_id'] = $form_state
      ->getValue('block_id');
    $this->blockPlugin
      ->blockSubmit($form, $form_state);
    $this->configuration['config'] = $this->blockPlugin
      ->getConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function getContent() {
    return $this->blockPlugin
      ->build();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return $this->blockPlugin
      ->getCacheContexts();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return $this->blockPlugin
      ->getCacheTags();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return $this->blockPlugin
      ->getCacheMaxAge();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockTab::$blockManager protected property The block manager.
BlockTab::$blockPlugin protected property The block plugin.
BlockTab::addTab public function Applies a tab to the blocktabs. Overrides TabInterface::addTab
BlockTab::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
BlockTab::create public static function Creates an instance of the plugin. Overrides TabBase::create
BlockTab::defaultConfiguration public function Gets default configuration for this plugin. Overrides TabBase::defaultConfiguration
BlockTab::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
BlockTab::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides ContextAwarePluginBase::getCacheMaxAge
BlockTab::getCacheTags public function The cache tags associated with this object. Overrides ContextAwarePluginBase::getCacheTags
BlockTab::getContent public function Returns the content of the tab. Overrides TabBase::getContent
BlockTab::getSummary public function Returns a render array summarizing the configuration of the tab. Overrides TabBase::getSummary
BlockTab::submitConfigurationForm public function Form submission handler. Overrides ConfigurableTabBase::submitConfigurationForm
BlockTab::__construct public function Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides TabBase::__construct
ConfigurableTabBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
TabBase::$logger protected property A logger instance.
TabBase::$title protected property The title of the tab.
TabBase::$uuid protected property The tab ID.
TabBase::$weight protected property The weight of the tab.
TabBase::calculateDependencies public function
TabBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TabBase::getDerivativeExtension public function Returns the extension the derivative would have have after adding this tab. Overrides TabInterface::getDerivativeExtension
TabBase::getTitle public function Returns the title of the tab. Overrides TabInterface::getTitle
TabBase::getUuid public function Returns the unique ID representing the tab. Overrides TabInterface::getUuid
TabBase::getWeight public function Returns the weight of the tab. Overrides TabInterface::getWeight
TabBase::label public function Returns the tab label. Overrides TabInterface::label
TabBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TabBase::setTitle public function Sets the title for this tab. Overrides TabInterface::setTitle
TabBase::setWeight public function Sets the weight for this tab. Overrides TabInterface::setWeight
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2