interface ConditionInterface in Search API 8

Represents a single (field operator value) condition in a search query.

Hierarchy

• interface \Drupal\search_api\Query\ConditionInterface

1 file declares its use of ConditionInterface

FieldsProcessorPluginBase.php in src/Processor/FieldsProcessorPluginBase.php

File

src/Query/ConditionInterface.php, line 8

Namespace

Drupal\search_api\Query

interface ConditionInterface {

  /**
   * Retrieves the field.
   *
   * @return string
   *   The field this condition checks.
   */
  public function getField();

  /**
   * Sets the field.
   *
   * @param string $field
   *   The new field.
   *
   * @return $this
   */
  public function setField($field);

  /**
   * Retrieves the value.
   *
   * @return mixed
   *   The value being compared to the field.
   */
  public function getValue();

  /**
   * Sets the value.
   *
   * @param mixed $value
   *   The new value.
   *
   * @return $this
   */
  public function setValue($value);

  /**
   * Retrieves the operator.
   *
   * @return string
   *   The operator that combined field and value in this condition.
   */
  public function getOperator();

  /**
   * Sets the operator.
   *
   * @param string $operator
   *   The new operator.
   *
   * @return $this
   */
  public function setOperator($operator);

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionInterface::getField	public	function	Retrieves the field.	1
ConditionInterface::getOperator	public	function	Retrieves the operator.	1
ConditionInterface::getValue	public	function	Retrieves the value.	1
ConditionInterface::setField	public	function	Sets the field.	1
ConditionInterface::setOperator	public	function	Sets the operator.	1
ConditionInterface::setValue	public	function	Sets the value.	1