You are here

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

class ViewsTab in Block Tabs 8

Views tab.

Plugin annotation


@Tab(
  id = "views_tab",
  label = @Translation("views tab"),
  description = @Translation("views tab.")
)

Hierarchy

Expanded class hierarchy of ViewsTab

File

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

Namespace

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

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

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $markup = $this
      ->t('view name:') . $this->configuration['view_name'] . '; ';
    $markup .= $this
      ->t('display:') . $this->configuration['view_display'] . '; ';
    if (!empty($this->configuration['view_arg'])) {
      $markup .= $this
        ->t('argument:') . $this->configuration['view_arg'];
    }
    $summary = [
      '#markup' => '(' . $markup . ')',
    ];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'view_name' => NULL,
      'view_display' => NULL,
      'view_arg' => NULL,
      'display_tab' => NULL,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $view_options = Views::getViewsAsOptions(TRUE, 'enabled', NULL, FALSE, TRUE);
    $user_input = $form_state
      ->getUserInput();
    $data = isset($user_input['data']) ? $user_input['data'] : [];
    $default_view_name = isset($data['view_name']) ? $data['view_name'] : $this->configuration['view_name'];
    $form['view_name'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('view name'),
      '#options' => $view_options,
      '#default_value' => $default_view_name,
      // '#field_suffix' => '',
      // Drupal\blocktabs\Plugin\Tab\ViewsTab.
      '#ajax' => [
        'callback' => [
          $this,
          'updateDisplay',
        ],
        'wrapper' => 'edit-view-display-wrapper',
        'event' => 'change',
      ],
      '#required' => TRUE,
    ];
    $display_options = [];
    if ($default_view_name) {
      $view = Views::getView($default_view_name);
      foreach ($view->storage
        ->get('display') as $name => $display) {
        $display_options[$name] = $display['display_title'] . ' (' . $display['id'] . ')';
      }
    }
    $form['view_display'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Display'),
      '#default_value' => $this->configuration['view_display'],
      '#prefix' => '<div id="edit-view-display-wrapper">',
      '#suffix' => '</div>',
      '#options' => $display_options,
      // '#validated' => TRUE,
      '#required' => TRUE,
    ];
    $form['view_arg'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Argument'),
      '#default_value' => $this->configuration['view_arg'],
    ];
    $form['display_tab'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display tab even if the view has no result'),
      '#default_value' => isset($this->configuration['display_tab']) ? $this->configuration['display_tab'] : 0,
    ];
    return $form;
  }

  /**
   * Update display option.
   */
  public function updateDisplay(array &$form, FormStateInterface $form_state) {
    return $form['data']['view_display'];
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['view_name'] = $form_state
      ->getValue('view_name');
    $this->configuration['view_display'] = $form_state
      ->getValue('view_display');
    $this->configuration['view_arg'] = $form_state
      ->getValue('view_arg');
    $this->configuration['display_tab'] = $form_state
      ->getValue('display_tab');
  }

  /**
   * {@inheritdoc}
   */
  public function getContent() {
    $tab_content = '';
    $view_name = $this->configuration['view_name'];
    $view_display = $this->configuration['view_display'];
    $view_arg = !empty($this->configuration['view_arg']) ? $this->configuration['view_arg'] : NULL;
    $view = Views::getView($view_name);
    $view
      ->setDisplay($view_display);
    $view
      ->setArguments($view_arg);
    $view
      ->execute();
    $count = count($view->result);

    //$tab_view = $view->render();
    if (!empty($this->configuration['display_tab']) || $count > 0) {

      //$view_arg = !empty($this->configuration['view_arg']) ? $this->configuration['view_arg'] : NULL;
      $tab_content = views_embed_view($view_name, $view_display, $view_arg);
    }
    else {
      $tab_content = NULL;
    }
    return $tab_content;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
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
TabBase::__construct public function Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct 1
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
ViewsTab::addTab public function Applies a tab to the blocktabs. Overrides TabInterface::addTab
ViewsTab::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ViewsTab::defaultConfiguration public function Gets default configuration for this plugin. Overrides TabBase::defaultConfiguration
ViewsTab::getContent public function Returns the content of the tab. Overrides TabBase::getContent
ViewsTab::getSummary public function Returns a render array summarizing the configuration of the tab. Overrides TabBase::getSummary
ViewsTab::submitConfigurationForm public function Form submission handler. Overrides ConfigurableTabBase::submitConfigurationForm
ViewsTab::updateDisplay public function Update display option.