class MefibsExposedFilterBlock in MEFIBS - More exposed forms in blocks 8

Provides block plugin definitions for all Views exposed filters.

Hierarchy

• class \Drupal\mefibs\Plugin\Derivative\MefibsExposedFilterBlock implements \Drupal\Core\Plugin\Discovery\ContainerDerivativeInterface

See also

\Drupal\mefibs\Plugin\Block\MefibsExposedFilterBlock

File

lib/Drupal/mefibs/Plugin/Derivative/MefibsExposedFilterBlock.php, line 19

Contains \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock.

Namespace

Drupal\mefibs\Plugin\Derivative

class MefibsExposedFilterBlock implements ContainerDerivativeInterface {

  /**
   * List of derivative definitions.
   *
   * @var array
   */
  protected $derivatives = array();

  /**
   * The view storage controller.
   *
   * @var \Drupal\Core\Entity\EntityStorageControllerInterface
   */
  protected $viewStorageController;

  /**
   * The base plugin ID that the derivative is for.
   *
   * @var string
   */
  protected $basePluginId;

  /**
   * Constructs a MefibsExposedFilterBlock object.
   *
   * @param string $base_plugin_id
   *   The base plugin ID.
   * @param \Drupal\Core\Entity\EntityStorageControllerInterface $view_storage_controller
   *   The entity storage controller to load views.
   */
  public function __construct($base_plugin_id, EntityStorageControllerInterface $view_storage_controller) {
    $this->basePluginId = $base_plugin_id;
    $this->viewStorageController = $view_storage_controller;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static($base_plugin_id, $container
      ->get('entity.manager')
      ->getStorageController('view'));
  }

  /**
   * Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinition().
   */
  public function getDerivativeDefinition($derivative_id, array $base_plugin_definition) {
    if (!empty($this->derivatives) && !empty($this->derivatives[$derivative_id])) {
      return $this->derivatives[$derivative_id];
    }
    $this
      ->getDerivativeDefinitions($base_plugin_definition);
    return $this->derivatives[$derivative_id];
  }

  /**
   * Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinitions().
   */
  public function getDerivativeDefinitions(array $base_plugin_definition) {

    // Check all Views for displays with an exposed filter block.
    foreach ($this->viewStorageController
      ->loadMultiple() as $view) {

      // Do not return results for disabled views.
      if (!$view
        ->status()) {
        continue;
      }
      $executable = $view
        ->getExecutable();
      $executable
        ->initDisplay();
      foreach ($executable->displayHandlers as $display) {
        if (isset($display) && $display
          ->getOption('exposed_block')) {

          // Add a block definition for the block.
          if ($display
            ->usesExposedFormInBlock()) {
            $mefibs = $display
              ->getOption('mefibs');
            if (isset($mefibs['blocks']) && count($mefibs['blocks'])) {
              foreach ($mefibs['blocks'] as $block) {
                $delta = $view
                  ->id() . '-' . $display->display['id'] . '-' . $block['machine_name'];
                $desc = t('Exposed form: @view-@display_id: @block', array(
                  '@view' => $view
                    ->id(),
                  '@display_id' => $display->display['id'],
                  '@block' => $block['name'],
                ));
                $this->derivatives[$delta] = array(
                  'admin_label' => $desc,
                  'cache' => DRUPAL_NO_CACHE,
                );
                $this->derivatives[$delta] += $base_plugin_definition;
              }
            }
          }
        }
      }
    }
    return $this->derivatives;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MefibsExposedFilterBlock::$basePluginId	protected	property	The base plugin ID that the derivative is for.
MefibsExposedFilterBlock::$derivatives	protected	property	List of derivative definitions.
MefibsExposedFilterBlock::$viewStorageController	protected	property	The view storage controller.
MefibsExposedFilterBlock::create	public static	function
MefibsExposedFilterBlock::getDerivativeDefinition	public	function	Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinition().
MefibsExposedFilterBlock::getDerivativeDefinitions	public	function	Implements \Drupal\Component\Plugin\Derivative\DerivativeInterface::getDerivativeDefinitions().
MefibsExposedFilterBlock::__construct	public	function	Constructs a MefibsExposedFilterBlock object.