interface ProcessorPropertyInterface in Search API 8

Provides an interface for processor-defined properties.

Hierarchy

• interface \Drupal\Core\TypedData\DataDefinitionInterface
  • interface \Drupal\search_api\Processor\ProcessorPropertyInterface

5 files declare their use of ProcessorPropertyInterface

FieldsHelper.php in src/Utility/FieldsHelper.php

IndexAddFieldsForm.php in src/Form/IndexAddFieldsForm.php

Item.php in src/Item/Item.php

ReverseEntityReferencesTest.php in tests/src/Kernel/Processor/ReverseEntityReferencesTest.php

SearchApiFieldTrait.php in src/Plugin/views/field/SearchApiFieldTrait.php

File

src/Processor/ProcessorPropertyInterface.php, line 10

Namespace

Drupal\search_api\Processor

interface ProcessorPropertyInterface extends DataDefinitionInterface {

  /**
   * Retrieves the ID of the processor which defines this property.
   *
   * @return string
   *   The defining processor's plugin ID.
   */
  public function getProcessorId();

  /**
   * Determines whether this property should be hidden from the UI.
   *
   * @return bool
   *   TRUE if this property should not be displayed in the UI, FALSE otherwise.
   */
  public function isHidden();

}

Members

Name	Modifiers	Type	Description	Overrides
DataDefinitionInterface::addConstraint	public	function	Adds a validation constraint.	2
DataDefinitionInterface::createFromDataType	public static	function	Creates a new data definition object.	2
DataDefinitionInterface::getClass	public	function	Returns the class used for creating the typed data object.	2
DataDefinitionInterface::getConstraint	public	function	Returns a validation constraint.	2
DataDefinitionInterface::getConstraints	public	function	Returns an array of validation constraints.	2
DataDefinitionInterface::getDataType	public	function	Returns the data type of the data.	2
DataDefinitionInterface::getDescription	public	function	Returns a human readable description.	2
DataDefinitionInterface::getLabel	public	function	Returns a human readable label.	2
DataDefinitionInterface::getSetting	public	function	Returns the value of a given setting.	2
DataDefinitionInterface::getSettings	public	function	Returns the array of settings, as required by the used class.	2
DataDefinitionInterface::isComputed	public	function	Determines whether the data value is computed.	3
DataDefinitionInterface::isInternal	public	function	Determines whether the data value is internal.	2
DataDefinitionInterface::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items.	2
DataDefinitionInterface::isReadOnly	public	function	Determines whether the data is read-only.	3
DataDefinitionInterface::isRequired	public	function	Determines whether a data value is required.	2
ProcessorPropertyInterface::getProcessorId	public	function	Retrieves the ID of the processor which defines this property.	2
ProcessorPropertyInterface::isHidden	public	function	Determines whether this property should be hidden from the UI.	2