class FacetsQueryType in Facets 8

Defines a Facets query type annotation.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\facets\Annotation\FacetsQueryType

See also

\Drupal\facets\QueryType\QueryTypePluginManager

Plugin API

1 file declares its use of FacetsQueryType

QueryTypePluginManager.php in src/QueryType/QueryTypePluginManager.php

4 classes are annotated with FacetsQueryType

SearchApiDate in src/Plugin/facets/query_type/SearchApiDate.php

Support for date facets within the Search API scope.

SearchApiGranular in src/Plugin/facets/query_type/SearchApiGranular.php

Basic support for numeric facets grouping by a granularity value.

SearchApiRange in src/Plugin/facets/query_type/SearchApiRange.php

Provides support for range facets within the Search API scope.

SearchApiString in src/Plugin/facets/query_type/SearchApiString.php

Provides support for string facets within the Search API scope.

File

src/Annotation/FacetsQueryType.php, line 17

Namespace

Drupal\facets\Annotation

class FacetsQueryType extends Plugin {

  /**
   * The query type plugin id.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the query type plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * Class used to retrieve derivative definitions of the facet_manager.
   *
   * @var string
   */
  public $derivative = '';

}

Members

Name	Modifiers	Type	Description	Overrides
FacetsQueryType::$derivative	public	property	Class used to retrieve derivative definitions of the facet_manager.
FacetsQueryType::$id	public	property	The query type plugin id.
FacetsQueryType::$label	public	property	The human-readable name of the query type plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2