class Generic in Core Views Facets 8

A generic filter type for core views.

Plugin annotation

@CoreViewsFacetsExposedFilterType(
  id = "generic",
  label = "Generic solution"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\facets\Processor\ProcessorPluginBase implements ProcessorInterface uses DependencyTrait
      • class \Drupal\core_views_facets\CoreViewsFacetsFilterType implements CoreViewsFacetsFilterTypeInterface
        • class \Drupal\core_views_facets\Plugin\facets\processor\exposed_filter_type\Generic

File

src/Plugin/facets/processor/exposed_filter_type/Generic.php, line 19

Namespace

Drupal\core_views_facets\Plugin\facets\processor\exposed_filter_type

class Generic extends CoreViewsFacetsFilterType {

  /**
   * {@inheritdoc}
   */
  public function prepareQuery(ViewExecutable $view, HandlerBase $handler, FacetInterface $facet) {
    try {
      return parent::prepareQuery($view, $handler, $facet);
    } catch (\Exception $e) {
      watchdog_exception('facets', $e, t('The core_views_facets module tried at least once to generically handle the unknown views filter type %filter_type and failed.'), [
        '%filter_type' => $handler->pluginId,
      ], RfcLogLevel::NOTICE);
      return NULL;
    }
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Exception
   */
  public function processDatabaseRow(\stdClass $row, HandlerBase $handler, FacetInterface $facet) {
    $result = parent::processDatabaseRow($row, $handler, $facet);
    $exception = NULL;
    if (!empty($handler
      ->getEntityType())) {
      try {
        $entities = $this
          ->entityTypeManager()
          ->getStorage($handler
          ->getEntityType())
          ->loadByProperties([
          $handler->realField => $row->facetrawvalue,
        ]);
        $entity = reset($entities);
        if ($entity) {
          $bundle = $entity
            ->bundle();
          if ($bundle != $entity
            ->getEntityTypeId() && $bundle == $result
            ->getRawValue()) {
            $result
              ->setDisplayValue($result
              ->getRawValue());
          }
          else {
            $result
              ->setDisplayValue($entity
              ->label());
          }
        }
      } catch (\Exception $e) {
        $exception = $e;
      }
    }
    if ($exception) {
      watchdog_exception('facets', $exception, t('The core_views_facets module tried at least once to generically handle the unknown views filter type %filter_type and failed.'), [
        '%filter_type' => $handler->pluginId,
      ], RfcLogLevel::NOTICE);
    }
    return $result;
  }

}

Members

Name	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::__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.
Generic::prepareQuery	public	function	Alters the facet query before execution. Overrides CoreViewsFacetsFilterType::prepareQuery
Generic::processDatabaseRow	public	function	Overrides CoreViewsFacetsFilterType::processDatabaseRow
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.