You are here

public function AddURL::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.

Overrides ProcessorPluginBase::getPropertyDefinitions

File

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

Class

AddURL
Adds the item's URL to the indexed data.

Namespace

Drupal\search_api\Plugin\search_api\processor

Code

public function getPropertyDefinitions(DatasourceInterface $datasource = NULL) {
  $properties = [];
  if (!$datasource) {
    $definition = [
      'label' => $this
        ->t('URI'),
      'description' => $this
        ->t('A URI where the item can be accessed'),
      'type' => 'string',
      'processor_id' => $this
        ->getPluginId(),
    ];
    $properties['search_api_url'] = new AddURLProperty($definition);
  }
  return $properties;
}