public function ConfigurablePropertyBase::getFieldDescription in Search API 8

Retrieves the description for a field based on this property.

Parameters

\Drupal\search_api\Item\FieldInterface $field: The field.

Return value

string|null A human-readable description for the field, or NULL if the field has no description.

Overrides ConfigurablePropertyInterface::getFieldDescription

1 method overrides ConfigurablePropertyBase::getFieldDescription()

AggregatedFieldProperty::getFieldDescription in src/Plugin/search_api/processor/Property/AggregatedFieldProperty.php

Retrieves the description for a field based on this property.

File

src/Processor/ConfigurablePropertyBase.php, line 36

Class

ConfigurablePropertyBase

Provides a base class for configurable processor-defined properties.

Namespace

Drupal\search_api\Processor

Code

public function getFieldDescription(FieldInterface $field) {
  return $this
    ->getDescription();
}