You are here

Home » API reference » Core Views Facets 8 » CoreViewsFacetsFilterType.php

abstract class CoreViewsFacetsFilterType in Core Views Facets 8

Base class for Core views facets filter type plugins.

Hierarchy

Expanded class hierarchy of CoreViewsFacetsFilterType

6 files declare their use of CoreViewsFacetsFilterType
Boolean.php in src/Plugin/facets/processor/exposed_filter_type/Boolean.php
Bundle.php in src/Plugin/facets/processor/exposed_filter_type/Bundle.php
Generic.php in src/Plugin/facets/processor/contextual_filter_type/Generic.php
Generic.php in src/Plugin/facets/processor/exposed_filter_type/Generic.php
NodeType.php in src/Plugin/facets/processor/contextual_filter_type/NodeType.php

... See full list

File

src/CoreViewsFacetsFilterType.php, line 16

Namespace

Drupal\core_views_facets
View source 
abstract class CoreViewsFacetsFilterType extends ProcessorPluginBase implements CoreViewsFacetsFilterTypeInterface {

  /**
   * Entity Type Manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a CoreViewsFacetsFilterType 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 mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * Retrieves the entity type manager.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The entity type manager.
   */
  protected function entityTypeManager() {
    return $this->entityTypeManager;
  }

  /**
   * Alters the facet query before execution.
   *
   * @param \Drupal\views\ViewExecutable $view
   *   The views executable the facet applies to.
   * @param \Drupal\views\Plugin\views\HandlerBase $handler
   *   The loaded views contextual filter handler.
   * @param \Drupal\facets\FacetInterface $facet
   *   The facet being executed.
   *
   * @return null|\Drupal\Core\Database\Query\Select
   *   The altered query object to be executed.
   */
  public function prepareQuery(ViewExecutable $view, HandlerBase $handler, FacetInterface $facet) {
    $filter_table_alias = [];
    $relationship = NULL;
    if (!empty($handler->options['relationship']) && $handler->options['relationship'] !== 'none') {

      /** @var \Drupal\views\Plugin\views\relationship\RelationshipPluginBase $relationship_handler */
      $relationship_handler = $view
        ->getDisplay()
        ->getHandler('relationship', $handler->options['relationship']);
      if ($relationship_handler) {
        $relationship = $relationship_handler->alias;
      }
    }

    /** @var \Drupal\views\Plugin\views\query\Sql $view_query */
    $view_query = $view->query;
    $filter_table_alias[] = $view_query
      ->ensureTable($handler->table, $relationship);

    /** @var \Drupal\Core\Database\Query\Select $query */
    $query = $view_query
      ->query();

    // The countQuery() method removes everything from the query, that doesn't
    // alter the result count. Such as all the SELECT x,y,z stuff and LEFT joins
    // not in the where clause etc.
    // The countQuery itself though, only counts the whole view, so it's not
    // useful as such, but the subquery can be combined with the facet
    // conditions.
    $query = $query
      ->countQuery();

    // The better alternative $query->prepareCountQuery() is protected, so work
    // around it.
    $query = $query
      ->getTables()['subquery']['table'];
    $select_table_alias = $filter_table_alias[0];
    $select_field = $handler->realField;
    $query
      ->addField($select_table_alias, $select_field, 'facetrawvalue');
    $fields =& $query
      ->getFields();
    $expressions =& $query
      ->getExpressions();

    // Make sure to only group by facetrawvalue.
    $group_by =& $query
      ->getGroupBy();
    foreach ($group_by as $alias => $group_entry) {
      unset($fields[$alias], $expressions[$alias]);
    }
    $group_by = [];
    $query
      ->groupBy('facetrawvalue');

    // Remove unnecessary orders.
    $orders =& $query
      ->getOrderBy();
    foreach ($orders as $alias => $order) {
      unset($fields[$alias], $expressions[$alias]);
    }
    $orders = [];
    $query
      ->addExpression('COUNT(DISTINCT ' . $view->storage
      ->get('base_table') . '.' . $view->storage
      ->get('base_field') . ')', 'facetcount');
    if (!empty($facet
      ->getHardLimit())) {
      $query
        ->orderBy('facetcount', 'DESC');
      $query
        ->range(0, $facet
        ->getHardLimit());
    }

    // The INNER JOIN should reduce the result set to only the actually
    // available facet values. So we're overriding the default LEFT JOIN.
    foreach ($filter_table_alias as $alias) {
      $tables =& $query
        ->getTables();
      if (!empty($tables[$alias]['join type'])) {
        $tables[$alias]['join type'] = 'INNER';
      }
    }
    return $query;
  }

  /**
   * Alters the result row before displaying the content.
   *
   * @param \stdClass $row
   *   The row as returned by fetchObject().
   * @param \Drupal\views\Plugin\views\HandlerBase $handler
   *   The loaded views contextual filter handler.
   * @param \Drupal\facets\FacetInterface $facet
   *   The facet being executed.
   *
   * @return \Drupal\facets\Result\Result
   *   A valid facet result entity.
   */
  public function processDatabaseRow(\stdClass $row, HandlerBase $handler, FacetInterface $facet) {
    $value = $row->facetrawvalue;
    $count = $row->facetcount;
    if (!empty($row->facetlabel)) {
      $label = $row->facetlabel;
    }
    else {
      $label = $value;
    }
    return new Result($facet, $value, $label, $count);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CoreViewsFacetsFilterType::$entityTypeManager protected property Entity Type Manager service.
CoreViewsFacetsFilterType::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CoreViewsFacetsFilterType::entityTypeManager protected function Retrieves the entity type manager.
CoreViewsFacetsFilterType::prepareQuery public function Alters the facet query before execution. Overrides CoreViewsFacetsFilterTypeInterface::prepareQuery 3
CoreViewsFacetsFilterType::processDatabaseRow public function Alters the result row before displaying the content. Overrides CoreViewsFacetsFilterTypeInterface::processDatabaseRow 6
CoreViewsFacetsFilterType::__construct public function Constructs a CoreViewsFacetsFilterType object. Overrides PluginBase::__construct 1
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
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.
ProcessorInterface::STAGE_BUILD constant Processing stage: build.
ProcessorInterface::STAGE_POST_QUERY constant Processing stage: post_query.
ProcessorInterface::STAGE_PRE_QUERY constant Processing stage: pre_query.
ProcessorInterface::STAGE_SORT constant Processing stage: sort.
ProcessorPluginBase::buildConfigurationForm public function Adds a configuration form for this processor. Overrides ProcessorInterface::buildConfigurationForm 10
ProcessorPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 8
ProcessorPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessorPluginBase::getDefaultWeight public function Returns the default weight for a specific processing stage. Overrides ProcessorInterface::getDefaultWeight
ProcessorPluginBase::getDescription public function Retrieves the processor description. Overrides ProcessorInterface::getDescription
ProcessorPluginBase::getQueryType public function Picks the preferred query type for this widget. Overrides ProcessorInterface::getQueryType 4
ProcessorPluginBase::isHidden public function Determines whether this processor should be hidden from the user. Overrides ProcessorInterface::isHidden
ProcessorPluginBase::isLocked public function Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessorPluginBase::submitConfigurationForm public function
ProcessorPluginBase::supportsFacet public function Checks if the facet is supported by this widget. Overrides ProcessorInterface::supportsFacet 6
ProcessorPluginBase::supportsStage public function Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage
ProcessorPluginBase::validateConfigurationForm public function Validates a configuration form for this processor. Overrides ProcessorInterface::validateConfigurationForm 2
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.