You are here

trait ElasticsearchViewsFieldTrait in Elasticsearch Connector 8.2

Same name and namespace in other branches
  1. 8.7 modules/elasticsearch_connector_views/src/Plugin/views/field/ElasticsearchViewsFieldTrait.php \Drupal\elasticsearch_connector_views\Plugin\views\field\ElasticsearchViewsFieldTrait
  2. 8.5 modules/elasticsearch_connector_views/src/Plugin/views/field/ElasticsearchViewsFieldTrait.php \Drupal\elasticsearch_connector_views\Plugin\views\field\ElasticsearchViewsFieldTrait
  3. 8.6 modules/elasticsearch_connector_views/src/Plugin/views/field/ElasticsearchViewsFieldTrait.php \Drupal\elasticsearch_connector_views\Plugin\views\field\ElasticsearchViewsFieldTrait

Provides a trait to use for Elasticsearch Views field handlers.

Multi-valued field handling is taken from \Drupal\views\Plugin\views\field\PrerenderList.

Hierarchy

File

modules/elasticsearch_connector_views/src/Plugin/views/field/ElasticsearchViewsFieldTrait.php, line 14

Namespace

Drupal\elasticsearch_connector_views\Plugin\views\field
View source
trait ElasticsearchViewsFieldTrait {
  use ElasticsearchViewsHandlerTrait;

  /**
   * Renders a single item of a row.
   *
   * @param int $count
   *   The index of the item inside the row.
   * @param mixed $item
   *   The item for the field to render.
   *
   * @return string
   *   The rendered output.
   */
  public function render_item($count, $item) {
    return 'render item';
  }

  /**
   * Gets an array of items for the field.
   *
   * @param \Drupal\views\ResultRow $values
   *   The result row object containing the values.
   *
   * @return array
   *   An array of items for the field.
   */
  public function getItems(ResultRow $values) {

    // TODO: Implement in Elasticsearch way.
    return array();
  }

  /**
   * Render all items in this field together.
   *
   * @param array $items
   *   The items provided by getItems for a single row.
   *
   * @return string
   *   The rendered items.
   */
  public function renderItems($items) {
    return 'render items';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ElasticsearchViewsFieldTrait::getItems public function Gets an array of items for the field. 1
ElasticsearchViewsFieldTrait::renderItems public function Render all items in this field together. 1
ElasticsearchViewsFieldTrait::render_item public function Renders a single item of a row. 1
ElasticsearchViewsHandlerTrait::ensureMyTable public function Overrides the Views handlers' ensureMyTable() method.
ElasticsearchViewsHandlerTrait::getEntityType public function Determines the entity type used by this handler.
ElasticsearchViewsHandlerTrait::getIndex protected function Returns the active search index.
ElasticsearchViewsHandlerTrait::getQuery public function Retrieves the query plugin.