www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/src/Plugin/views/field/MultiItemsFieldHandlerInterface.php

   1 <?php
   2
   3 namespace Drupal\views\Plugin\views\field;
   4
   5 use Drupal\views\ResultRow;
   6
   7 /**
   8  * Defines a field handler which renders multiple items per row.
   9  */
  10 interface MultiItemsFieldHandlerInterface extends FieldHandlerInterface {
  11
  12   /**
  13    * Renders a single item of a row.
  14    *
  15    * @param int $count
  16    *   The index of the item inside the row.
  17    * @param mixed $item
  18    *   The item for the field to render.
  19    *
  20    * @return string
  21    *   The rendered output.
  22    */
  23   public function render_item($count, $item);
  24
  25   /**
  26    * Gets an array of items for the field.
  27    *
  28    * @param \Drupal\views\ResultRow $values
  29    *   The result row object containing the values.
  30    *
  31    * @return array
  32    *   An array of items for the field.
  33    */
  34   public function getItems(ResultRow $values);
  35
  36   /**
  37    * Render all items in this field together.
  38    *
  39    * @param array $items
  40    *   The items provided by getItems for a single row.
  41    *
  42    * @return string
  43    *   The rendered items.
  44    */
  45   public function renderItems($items);
  46
  47 }