interface TextValueInterface in Search API 8

Provides an interface for fulltext field values.

Hierarchy

• interface \Drupal\search_api\Plugin\search_api\data_type\value\TextValueInterface

5 files declare their use of TextValueInterface

FieldsProcessorPluginBase.php in src/Processor/FieldsProcessorPluginBase.php

HtmlFilter.php in src/Plugin/search_api/processor/HtmlFilter.php

IgnoreCase.php in src/Plugin/search_api/processor/IgnoreCase.php

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

Tokenizer.php in src/Plugin/search_api/processor/Tokenizer.php

File

src/Plugin/search_api/data_type/value/TextValueInterface.php, line 8

Namespace

Drupal\search_api\Plugin\search_api\data_type\value

interface TextValueInterface {

  /**
   * Retrieves the currently stored text value.
   *
   * @return string
   *   The currently stored text value.
   *
   * @see \Drupal\search_api\Plugin\search_api\data_type\value\TextValue::toText()
   */
  public function getText();

  /**
   * Retrieves the current effective text value.
   *
   * This will be a concatenation of all tokens' text values, if tokens have
   * been set, or the currently stored text value otherwise.
   *
   * @return string
   *   The effective text value for this object.
   */
  public function toText();

  /**
   * Sets the currently stored text value.
   *
   * @param string $text
   *   The new text value.
   *
   * @return $this
   */
  public function setText($text);

  /**
   * Retrieves the original text value.
   *
   * @return string
   *   The original text value.
   */
  public function getOriginalText();

  /**
   * Sets the original text value.
   *
   * @param string $originalText
   *   The new original text value.
   *
   * @return $this
   */
  public function setOriginalText($originalText);

  /**
   * Retrieves the text tokens this text value was split into, if any.
   *
   * @return \Drupal\search_api\Plugin\search_api\data_type\value\TextTokenInterface[]|null
   *   The text tokens this text value was split into, or NULL if the value has
   *   not been tokenized in any way yet.
   */
  public function getTokens();

  /**
   * Sets the text tokens for the text value.
   *
   * @param \Drupal\search_api\Plugin\search_api\data_type\value\TextTokenInterface[]|null $tokens
   *   The new text tokens, or NULL to remove them.
   *
   * @return $this
   */
  public function setTokens(array $tokens = NULL);

  /**
   * Retrieves the properties set for this text value.
   *
   * @return array
   *   An associative array of properties. Known properties include:
   *   - lowercase: Whether the value has been lowercased (type: bool)
   *   - tokenized: Whether the value has been tokenized into individual words
   *     (type: bool)
   *   - strip_html: Whether HTML has been stripped from this value (type: bool)
   */
  public function getProperties();

  /**
   * Retrieves a specific property of this text value.
   *
   * @param string $name
   *   The property's name.
   * @param mixed $default
   *   (optional) The default to return if the property wasn't set yet.
   *
   * @return mixed
   *   Either the property's value, or the given $default if it wasn't set yet.
   */
  public function getProperty($name, $default = NULL);

  /**
   * Sets the properties of this text value.
   *
   * @param array $properties
   *   An associative array of property values.
   *
   * @return $this
   */
  public function setProperties(array $properties);

  /**
   * Sets the properties of this text value.
   *
   * @param string $name
   *   The property's name.
   * @param mixed $value
   *   (optional) The value to set for the property.
   *
   * @return $this
   */
  public function setProperty($name, $value = TRUE);

}

Members

Name	Modifiers	Type	Description	Overrides
TextValueInterface::getOriginalText	public	function	Retrieves the original text value.	1
TextValueInterface::getProperties	public	function	Retrieves the properties set for this text value.	1
TextValueInterface::getProperty	public	function	Retrieves a specific property of this text value.	1
TextValueInterface::getText	public	function	Retrieves the currently stored text value.	1
TextValueInterface::getTokens	public	function	Retrieves the text tokens this text value was split into, if any.	1
TextValueInterface::setOriginalText	public	function	Sets the original text value.	1
TextValueInterface::setProperties	public	function	Sets the properties of this text value.	1
TextValueInterface::setProperty	public	function	Sets the properties of this text value.	1
TextValueInterface::setText	public	function	Sets the currently stored text value.	1
TextValueInterface::setTokens	public	function	Sets the text tokens for the text value.	1
TextValueInterface::toText	public	function	Retrieves the current effective text value.	1