You are here

Home » API reference » MEFIBS - More exposed forms in blocks 8 » MefibsExposedFilterBlock.php

class MefibsExposedFilterBlock in MEFIBS - More exposed forms in blocks 8

Same name in this branch
  1. 8 lib/Drupal/mefibs/Plugin/Derivative/MefibsExposedFilterBlock.php \Drupal\mefibs\Plugin\Derivative\MefibsExposedFilterBlock
  2. 8 lib/Drupal/mefibs/Plugin/Block/MefibsExposedFilterBlock.php \Drupal\mefibs\Plugin\Block\MefibsExposedFilterBlock

Provides an extra 'Views Exposed Filter' block.

Plugin annotation


@Block(
  id = "mefibs_exposed_filter_block",
  admin_label = @Translation("Mefibs Exposed Filter Block"),
  category = @Translation("Views"),
  derivative = "Drupal\mefibs\Plugin\Derivative\MefibsExposedFilterBlock"
)

Hierarchy

Expanded class hierarchy of MefibsExposedFilterBlock

File

lib/Drupal/mefibs/Plugin/Block/MefibsExposedFilterBlock.php, line 23
Contains \Drupal\mefibs\Plugin\Block\MefibsExposedFilterBlock.

Namespace

Drupal\mefibs\Plugin\Block
View source 
class MefibsExposedFilterBlock extends ViewsBlockBase {

  /**
   * The internal block id for a mefibs block.
   *
   * @var string
   */
  protected $block_id;

  /**
   * Constructs a \Drupal\views\Plugin\Block\ViewsBlockBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\views\ViewExecutableFactory $executable_factory
   *   The view executable factory.
   * @param \Drupal\Core\Entity\EntityStorageControllerInterface $storage_controller
   *   The views storage controller.
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The current user.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, ViewExecutableFactory $executable_factory, EntityStorageControllerInterface $storage_controller, AccountInterface $user) {
    $this->pluginId = $plugin_id;
    $delta = $this
      ->getDerivativeId();
    list($name, $this->displayID, $block_id) = explode('-', $delta, 3);

    // Load the view.
    $view = $storage_controller
      ->load($name);
    $this->view = $executable_factory
      ->get($view);
    $this->displaySet = $this->view
      ->setDisplay($this->displayID);
    $this->block_id = $block_id;
    $this->user = $user;

    // Don't call parent here because we already have replicated appropriate
    // logic from ViewsBlockBase::__construct.
    BlockBase::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $display = $this->view->displayHandlers
      ->get($this->displayID);
    $output = $display->extender['mefibs']
      ->renderExposedForm($this->block_id);

    // Before returning the block output, convert it to a renderable array with
    // contextual links.
    // $this->addContextualLinks($output, 'exposed_filter');
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue 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.
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::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
MefibsExposedFilterBlock::$block_id protected property The internal block id for a mefibs block.
MefibsExposedFilterBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
MefibsExposedFilterBlock::__construct public function Constructs a \Drupal\views\Plugin\Block\ViewsBlockBase object. Overrides ViewsBlockBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
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.
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
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::blockSubmit public function Overrides BlockPluginTrait::blockSubmit 1
ViewsBlockBase::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. Overrides BlockPluginTrait::buildConfigurationForm
ViewsBlockBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ViewsBlockBase::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration 1
ViewsBlockBase::getPreviewFallbackString public function Overrides BlockPluginTrait::getPreviewFallbackString
ViewsBlockBase::getViewExecutable public function Gets the view executable.