public function SearchApiQuery::addRetrievedProperty in Search API 8

Adds a property to be retrieved.

Currently doesn't serve any purpose, but might be added to the search query in the future to help backends that support returning fields determine which of the fields should actually be returned.

Parameters

string $combined_property_path: The combined property path of the property that should be retrieved.

Return value

$this

See also

https://www.drupal.org/node/3011060

File

src/Plugin/views/query/SearchApiQuery.php, line 291

Class

SearchApiQuery

Defines a Views query class for searching on Search API indexes.

Namespace

Drupal\search_api\Plugin\views\query

Code

public function addRetrievedProperty($combined_property_path) {
  @trigger_error('\\Drupal\\search_api\\Plugin\\views\\query\\SearchApiQuery::addRetrievedProperty() is deprecated in search_api:8.x-1.11 and is removed from search_api:2.0.0. Use addRetrievedFieldValue() instead. See https://www.drupal.org/node/3011060', E_USER_DEPRECATED);
  $this
    ->addField(NULL, $combined_property_path);
  return $this;
}