class FacetsBlock in Facets Block 8

Provides a 'Facets Block' block.

Plugin annotation


@Block(
 id = "facets_block",
 admin_label = @Translation("Facets Block"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\facets_block\Plugin\Block\FacetsBlock implements ContainerFactoryPluginInterface uses UncacheableDependencyTrait

Expanded class hierarchy of FacetsBlock

File

src/Plugin/Block/FacetsBlock.php, line 25

Namespace

Drupal\facets_block\Plugin\Block

View source

class FacetsBlock extends BlockBase implements ContainerFactoryPluginInterface {
  use UncacheableDependencyTrait;

  /**
   * The Default Facet Manager.
   *
   * @var \Drupal\facets\FacetManager\DefaultFacetManager
   */
  protected $facetsManager;

  /**
   * The Module Handler Interface.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The Block Manager Interface.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $pluginManagerBlock;

  /**
   * The Account Proxy Interface.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * FacetsBlock constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\facets\FacetManager\DefaultFacetManager $facets_manager
   *   The Facets manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Block\BlockManagerInterface $plugin_manager_block
   *   The Plugin manager block.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   Current user.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DefaultFacetManager $facets_manager, ModuleHandlerInterface $module_handler, BlockManagerInterface $plugin_manager_block, AccountProxyInterface $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->facetsManager = $facets_manager;
    $this->moduleHandler = $module_handler;
    $this->pluginManagerBlock = $plugin_manager_block;
    $this->currentUser = $current_user;
  }

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

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['block_settings'] = [
      '#type' => 'fieldset',
      '#title' => 'Settings',
    ];
    $form['block_settings']['show_title'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show Facet titles'),
      '#default_value' => isset($this->configuration['show_title']) ? $this->configuration['show_title'] : TRUE,
    ];
    $form['block_settings']['exclude_empty_facets'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Exclude empty facets'),
      '#default_value' => isset($this->configuration['exclude_empty_facets']) ? $this->configuration['exclude_empty_facets'] : TRUE,
    ];
    $form['block_settings']['hide_empty_block'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide empty block'),
      '#description' => $this
        ->t("Don't render the Facets Block if no facets are available (for instance when no search results are found)."),
      '#default_value' => isset($this->configuration['hide_empty_block']) ? $this->configuration['hide_empty_block'] : FALSE,
    ];
    $form['block_settings']['add_js_classes'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add JS classes for Facets block'),
      '#default_value' => $this->configuration['add_js_classes'] ?? FALSE,
    ];
    $form['block_settings']['facets_to_include'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Facets to include'),
      '#default_value' => isset($this->configuration['facets_to_include']) ? $this->configuration['facets_to_include'] : [],
      '#options' => $this
        ->getAvailableFacets(),
    ];
    return $form;
  }

  /**
   * Returns a list of available facets.
   *
   * @return array
   *   An array of enabled facets.
   */
  protected function getAvailableFacets() {
    $enabled_facets = $this->facetsManager
      ->getEnabledFacets();
    uasort($enabled_facets, [
      $this,
      'sortFacetsByWeight',
    ]);
    $available_facets = [];
    if ($this->moduleHandler
      ->moduleExists('facets_summary')) {
      $available_facets['facets_summary_block:summary'] = $this
        ->t('Summary');
    }
    foreach ($enabled_facets as $facet) {

      /** @var \Drupal\facets\Entity\Facet $facet */
      $available_facets['facet_block:' . $facet
        ->id()] = $facet
        ->getName();
    }
    return $available_facets;
  }

  /**
   * Sorts array of objects by object weight property.
   *
   * @param \Drupal\facets\FacetInterface $a
   *   A facet.
   * @param \Drupal\facets\FacetInterface $b
   *   A facet.
   *
   * @return int
   *   Sort value.
   */
  protected function sortFacetsByWeight(FacetInterface $a, FacetInterface $b) {
    $a_weight = $a
      ->getWeight();
    $b_weight = $b
      ->getWeight();
    if ($a_weight == $b_weight) {
      return 0;
    }
    return $a_weight < $b_weight ? -1 : 1;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['show_title'] = $form_state
      ->getValue([
      'block_settings',
      'show_title',
    ]);
    $this->configuration['exclude_empty_facets'] = $form_state
      ->getValue([
      'block_settings',
      'exclude_empty_facets',
    ]);
    $this->configuration['hide_empty_block'] = $form_state
      ->getValue([
      'block_settings',
      'hide_empty_block',
    ]);
    $this->configuration['facets_to_include'] = $form_state
      ->getValue([
      'block_settings',
      'facets_to_include',
    ]);
    $this->configuration['add_js_classes'] = $form_state
      ->getValue([
      'block_settings',
      'add_js_classes',
    ]);
  }

  /**
   * Builds facets.
   *
   * @param array $facets_to_include
   *   A list of facets to display.
   *
   * @return array
   *   An array of facets.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  protected function buildFacets(array $facets_to_include) {
    $facets = [];
    $available_facets = $this
      ->getAvailableFacets();
    foreach ($available_facets as $plugin_id => $facet_title) {
      if (isset($facets_to_include[$plugin_id]) && $facets_to_include[$plugin_id] === $plugin_id) {
        $block_plugin = $this->pluginManagerBlock
          ->createInstance($plugin_id, []);
        if ($block_plugin && $block_plugin
          ->access($this->currentUser)) {
          $build = $block_plugin
            ->build();
          $exclude_empty_facets = !isset($this->configuration['exclude_empty_facets']) ? TRUE : $this->configuration['exclude_empty_facets'];

          // Skip empty facets.
          $is_empty = FALSE;
          if (!$build) {
            $is_empty = TRUE;
          }
          elseif (isset($build[0]['#attributes']['class']) && in_array('facet-empty', $build[0]['#attributes']['class'])) {
            $is_empty = TRUE;
          }
          elseif (isset($build['#items']) && count($build['#items']) == 0) {
            $is_empty = TRUE;
          }
          if ($exclude_empty_facets && $is_empty) {
            continue;
          }
          if (empty($build['#attributes'])) {
            $build['#attributes'] = [];
          }
          $facets[] = [
            'title' => $facet_title,
            'content' => $build,
            'attributes' => new Attribute($build['#attributes']),
          ];
        }
      }
    }
    return $facets;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $show_title = !isset($this->configuration['show_title']) ? TRUE : $this->configuration['show_title'];
    $facets_to_include = !isset($this->configuration['facets_to_include']) ? [] : $this->configuration['facets_to_include'];
    $facets = $this
      ->buildFacets($facets_to_include);

    // Allow other modules to alter the facets array.
    $this->moduleHandler
      ->alter('facets_block_facets', $facets);
    return [
      '#theme' => 'facets_block',
      '#show_title' => $show_title,
      '#facets' => $facets,
    ];
  }

}

Members

Name	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::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockValidate	public	function		3
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.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::defaultConfiguration	public	function		19
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
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::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
FacetsBlock::$currentUser	protected	property	The Account Proxy Interface.
FacetsBlock::$facetsManager	protected	property	The Default Facet Manager.
FacetsBlock::$moduleHandler	protected	property	The Module Handler Interface.
FacetsBlock::$pluginManagerBlock	protected	property	The Block Manager Interface.
FacetsBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
FacetsBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
FacetsBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FacetsBlock::buildFacets	protected	function	Builds facets.
FacetsBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FacetsBlock::getAvailableFacets	protected	function	Returns a list of available facets.
FacetsBlock::sortFacetsByWeight	protected	function	Sorts array of objects by object weight property.
FacetsBlock::__construct	public	function	FacetsBlock constructor. Overrides BlockPluginTrait::__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
UncacheableDependencyTrait::getCacheContexts	public	function
UncacheableDependencyTrait::getCacheMaxAge	public	function
UncacheableDependencyTrait::getCacheTags	public	function

You are here

class FacetsBlock in Facets Block 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation