class SearchApiProcessor in Search API 8

Defines a Search API processor annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\search_api\Annotation\SearchApiProcessor

See also

\Drupal\search_api\Processor\ProcessorPluginManager

\Drupal\search_api\Processor\ProcessorInterface

\Drupal\search_api\Processor\ProcessorPluginBase

Plugin API

23 classes are annotated with SearchApiProcessor

AddHierarchy in src/Plugin/search_api/processor/AddHierarchy.php

Adds all ancestors' IDs to a hierarchical field.

AddURL in src/Plugin/search_api/processor/AddURL.php

Adds the item's URL to the indexed data.

AggregatedFields in src/Plugin/search_api/processor/AggregatedFields.php

Adds customized aggregations of existing fields to the index.

ContentAccess in src/Plugin/search_api/processor/ContentAccess.php

Adds content access checks for nodes and comments.

EntityStatus in src/Plugin/search_api/processor/EntityStatus.php

Excludes unpublished nodes from node indexes.

... See full list

File

src/Annotation/SearchApiProcessor.php, line 17

Namespace

Drupal\search_api\Annotation

class SearchApiProcessor extends Plugin {

  /**
   * The processor plugin ID.
   *
   * @var string
   */
  public $id;

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

  /**
   * The description of the processor.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $description;

  /**
   * The stages this processor will run in, along with their default weights.
   *
   * This is represented as an associative array, mapping one or more of the
   * stage identifiers to the default weight for that stage. For the available
   * stages, see
   * \Drupal\search_api\Processor\ProcessorPluginManager::getProcessingStages().
   *
   * @var int[]
   */
  public $stages;

}

Members

Name	Modifiers	Type	Description	Overrides
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
SearchApiProcessor::$description	public	property	The description of the processor.
SearchApiProcessor::$id	public	property	The processor plugin ID.
SearchApiProcessor::$label	public	property	The human-readable name of the processor plugin.
SearchApiProcessor::$stages	public	property	The stages this processor will run in, along with their default weights.