interface CoreViewsFacetsFilterTypeInterface in Core Views Facets 8

Defines an interface for Core views facets filter type plugins.

Hierarchy

• interface \Drupal\facets\Processor\ProcessorInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\core_views_facets\CoreViewsFacetsFilterTypeInterface

File

src/CoreViewsFacetsFilterTypeInterface.php, line 14

Namespace

Drupal\core_views_facets

interface CoreViewsFacetsFilterTypeInterface extends ProcessorInterface, ContainerFactoryPluginInterface {

  /**
   * 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);

  /**
   * 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);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
CoreViewsFacetsFilterTypeInterface::prepareQuery	public	function	Alters the facet query before execution.	1
CoreViewsFacetsFilterTypeInterface::processDatabaseRow	public	function	Alters the result row before displaying the content.	1
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
ProcessorInterface::buildConfigurationForm	public	function	Adds a configuration form for this processor.	2
ProcessorInterface::getDefaultWeight	public	function	Returns the default weight for a specific processing stage.	2
ProcessorInterface::getDescription	public	function	Retrieves the processor description.	2
ProcessorInterface::getQueryType	public	function	Picks the preferred query type for this widget.	1
ProcessorInterface::isHidden	public	function	Determines whether this processor should be hidden from the user.	2
ProcessorInterface::isLocked	public	function	Determines whether this processor should always be enabled.	2
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.
ProcessorInterface::supportsFacet	public	function	Checks if the facet is supported by this widget.	1
ProcessorInterface::supportsStage	public	function	Checks whether this processor implements a particular stage.	2
ProcessorInterface::validateConfigurationForm	public	function	Validates a configuration form for this processor.	2