You are here

public function ProcessorInterface::getPropertyDefinitions in Search API 8

Retrieves the properties this processor defines for the given datasource.

Property names have to start with a letter or an underscore, followed by any number of letters, numbers and underscores. To avoid collisions, it is also recommended to prefix the property name with the identifier of the module defining the processor.

Parameters

\Drupal\search_api\Datasource\DatasourceInterface|null $datasource: (optional) The datasource this set of properties belongs to. If NULL, the datasource-independent properties should be added (or modified).

Return value

\Drupal\search_api\Processor\ProcessorPropertyInterface[] An array of property definitions for that datasource, keyed by property names.

1 method overrides ProcessorInterface::getPropertyDefinitions()
ProcessorPluginBase::getPropertyDefinitions in src/Processor/ProcessorPluginBase.php
Retrieves the properties this processor defines for the given datasource.

File

src/Processor/ProcessorInterface.php, line 151

Class

ProcessorInterface
Provides an interface for Search API processor plugins.

Namespace

Drupal\search_api\Processor

Code

public function getPropertyDefinitions(DatasourceInterface $datasource = NULL);