MultiItemsFieldHandlerInterface.php

Same filename in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/field/MultiItemsFieldHandlerInterface.php
  2. 10 core/modules/views/src/Plugin/views/field/MultiItemsFieldHandlerInterface.php
  3. 11.x core/modules/views/src/Plugin/views/field/MultiItemsFieldHandlerInterface.php

Namespace

Drupal\views\Plugin\views\field

File

core/modules/views/src/Plugin/views/field/MultiItemsFieldHandlerInterface.php

View source
<?php

namespace Drupal\views\Plugin\views\field;

use Drupal\views\ResultRow;

/**
 * Defines a field handler which renders multiple items per row.
 */
interface MultiItemsFieldHandlerInterface extends FieldHandlerInterface {
    
    /**
     * 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);
    
    /**
     * 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);
    
    /**
     * 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);

}

Interfaces

Title Deprecated Summary
MultiItemsFieldHandlerInterface Defines a field handler which renders multiple items per row.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.