public function RenderedItem::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/RenderedItem.php, line 214

Class

RenderedItem

Adds an additional field containing the rendered item.

Namespace

Drupal\search_api\Plugin\search_api\processor

Code

public function getPropertyDefinitions(DatasourceInterface $datasource = NULL) {
  $properties = [];
  if (!$datasource) {
    $definition = [
      'label' => $this
        ->t('Rendered HTML output'),
      'description' => $this
        ->t('The complete HTML which would be displayed when viewing the item'),
      'type' => 'search_api_html',
      'processor_id' => $this
        ->getPluginId(),
    ];
    $properties['rendered_item'] = new RenderedItemProperty($definition);
  }
  return $properties;
}