public function DummyFields::getPropertyDefinitions in Search API Solr 8.2

Same name and namespace in other branches

1. 8.3 src/Plugin/search_api/processor/DummyFields.php \Drupal\search_api_solr\Plugin\search_api\processor\DummyFields::getPropertyDefinitions()
2. 4.x src/Plugin/search_api/processor/DummyFields.php \Drupal\search_api_solr\Plugin\search_api\processor\DummyFields::getPropertyDefinitions()

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.

Overrides ProcessorPluginBase::getPropertyDefinitions

File

src/Plugin/search_api/processor/DummyFields.php, line 29

Class

DummyFields

Adds dummy fields to the indexed data.

Namespace

Drupal\search_api_solr\Plugin\search_api\processor

Code

public function getPropertyDefinitions(DatasourceInterface $datasource = NULL) {
  $properties = [];
  if ($datasource) {
    $definition = [
      'label' => $this
        ->t('Dummy field'),
      'description' => $this
        ->t('Adds dummy field that gets its values via API, for example hook_search_api_solr_documents_alter().'),
      'type' => 'string',
      'processor_id' => $this
        ->getPluginId(),
      'is_list' => TRUE,
    ];
    $properties['dummy_field'] = new DummyFieldProperty($definition);
  }
  return $properties;
}