class PrerenderList

Field handler to provide a list of items.

The items are expected to be loaded by a child object during pre_render, and 'my field' is expected to be the pointer to the items in the list.

Items to render should be in a list in $this->items

Plugin annotation

@PluginID("prerender_list");

Hierarchy

Expanded class hierarchy of PrerenderList

Related topics

3 files declare their use of PrerenderList
Permissions.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/field/Permissions.php
Definition of Drupal\user\Plugin\views\field\Permissions.
Roles.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/field/Roles.php
Definition of Drupal\user\Plugin\views\field\Roles.
TaxonomyIndexTid.php in drupal/core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/views/field/TaxonomyIndexTid.php
Definition of Drupal\taxonomy\Plugin\views\field\TaxonomyIndexTid.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/field/PrerenderList.php, line 24
Definition of Drupal\views\Plugin\views\field\PrerenderList.

Namespace

Drupal\views\Plugin\views\field
View source
class PrerenderList extends FieldPluginBase {

  /**
   * Stores all items which are used to render the items.
   * It should be keyed first by the id of the base table, for example nid.
   * The second key is the id of the thing which is displayed multiple times
   * per row, for example the tid.
   *
   * @var array
   */
  var $items = array();
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['type'] = array(
      'default' => 'separator',
    );
    $options['separator'] = array(
      'default' => ', ',
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    $form['type'] = array(
      '#type' => 'radios',
      '#title' => t('Display type'),
      '#options' => array(
        'ul' => t('Unordered list'),
        'ol' => t('Ordered list'),
        'separator' => t('Simple separator'),
      ),
      '#default_value' => $this->options['type'],
    );
    $form['separator'] = array(
      '#type' => 'textfield',
      '#title' => t('Separator'),
      '#default_value' => $this->options['separator'],
      '#states' => array(
        'visible' => array(
          ':input[name="options[type]"]' => array(
            'value' => 'separator',
          ),
        ),
      ),
    );
    parent::buildOptionsForm($form, $form_state);
  }

  /**
   * Render all items in this field together.
   *
   * When using advanced render, each possible item in the list is rendered
   * individually. Then the items are all pasted together.
   */
  protected function renderItems($items) {
    if (!empty($items)) {
      if ($this->options['type'] == 'separator') {
        return implode($this
          ->sanitizeValue($this->options['separator'], 'xss_admin'), $items);
      }
      else {
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $items,
          '#title' => NULL,
          '#type' => $this->options['type'],
        );
        return drupal_render($item_list);
      }
    }
  }

  /**
   * Return an array of items for the field.
   *
   * Items should be stored in the result array, if possible, as an array
   * with 'value' as the actual displayable value of the item, plus
   * any items that might be found in the 'alter' options array for
   * creating links, such as 'path', 'fragment', 'query' etc, such a thing
   * is to be made. Additionally, items that might be turned into tokens
   * should also be in this array.
   */
  public function getItems($values) {
    $field = $this
      ->getValue($values);
    if (!empty($this->items[$field])) {
      return $this->items[$field];
    }
    return array();
  }

  /**
   * Determine if advanced rendering is allowed.
   *
   * By default, advanced rendering will NOT be allowed if the class
   * inheriting from this does not implement a 'renderItems' method.
   */
  protected function allowAdvancedRender() {

    // Note that the advanced render bits also use the presence of
    // this method to determine if it needs to render items as a list.
    return method_exists($this, 'render_item');
  }

}

Members

Name Modifiers Type Description Overridessort ascending
FieldPluginBase::render function Render the field. 35
FieldPluginBase::query public function Called to add the field to a query. Overrides PluginBase::query 22
FieldPluginBase::init public function Overrides Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase::init 19
ContainerFactoryPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
FieldPluginBase::pre_render function Run before any fields are rendered. 7
HandlerBase::access public function Check whether current user has access to this handler. 6
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
HandlerBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 5
FieldPluginBase::addSelfTokens protected function Add any special tokens this field might use for itself. 4
HandlerBase::validateExposed public function Validate the exposed handler form 4
FieldPluginBase::clickSortable public function Determine if this field is click sortable. 3
FieldPluginBase::documentSelfTokens protected function Document any special tokens this field might use for itself. 3
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct 3
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
PluginBase::destroy public function Clears a plugin. 2
PrerenderList::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FieldPluginBase::defineOptions 1
PrerenderList::buildOptionsForm public function Default options form that provides the label widget that all fields should have. Overrides FieldPluginBase::buildOptionsForm 1
FieldPluginBase::clickSort public function Called to determine what to tell the clicksorter. 1
FieldPluginBase::elementType public function Return an HTML element based upon the field's element type. 1
FieldPluginBase::getValue public function Get the value that's supposed to be rendered. 1
FieldPluginBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides HandlerBase::adminLabel 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting 1
HandlerBase::validateExposeForm public function Validate the options form. 1
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. 1
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::validate public function Validates the handler against the complete View. Overrides PluginBase::validate 1
HandlerBase::$query public property Where the $query object will reside: 1
PluginBase::$view public property The top object of a view. 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PrerenderList::renderItems protected function Render all items in this field together.
PrerenderList::getItems public function Return an array of items for the field.
PrerenderList::allowAdvancedRender protected function Determine if advanced rendering is allowed. Overrides FieldPluginBase::allowAdvancedRender
FieldPluginBase::addAdditionalFields protected function Add 'additional' fields to the query.
FieldPluginBase::label public function Get this field's label.
FieldPluginBase::elementLabelType public function Return an HTML element for the label based upon the field's element type.
FieldPluginBase::elementWrapperType public function Return an HTML element for the wrapper based upon the field's element type.
FieldPluginBase::getElements public function Provide a list of elements valid for field HTML.
FieldPluginBase::elementClasses public function Return the class of the field.
FieldPluginBase::tokenizeValue public function Replace a value with tokens from the last field.
FieldPluginBase::elementLabelClasses public function Return the class of the field's label.
FieldPluginBase::elementWrapperClasses public function Return the class of the field's wrapper.
FieldPluginBase::getEntity public function Gets the entity matching the current row and relationship.
FieldPluginBase::useStringGroupBy public function Determines if this field will be available as an option to group the result by in the style settings.
FieldPluginBase::submitOptionsForm public function Performs some cleanup tasks on the options array before saving it. Overrides HandlerBase::submitOptionsForm
FieldPluginBase::getPreviousFieldLabels protected function Returns all field lables of fields before this field.
FieldPluginBase::adminSummary public function Provide extra data to the administration form Overrides HandlerBase::adminSummary
FieldPluginBase::advancedRender public function Render a field using advanced settings.
FieldPluginBase::isValueEmpty public function Checks if a field value is empty.
FieldPluginBase::renderText public function Perform an advanced text render for the item.
FieldPluginBase::renderAltered protected function Render this field as altered text, from a fieldset set by the user.
FieldPluginBase::renderTrimText public function Trim the field down to the specified length.
FieldPluginBase::renderAsLink protected function Render this field as a link, with the info from a fieldset set by the user.
FieldPluginBase::getRenderTokens public function Get the 'render' tokens to use for advanced rendering.
FieldPluginBase::getTokenValuesRecursive protected function Recursive function to add replacements for nested query string parameters.
FieldPluginBase::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
FieldPluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides PluginBase::themeFunctions
FieldPluginBase::trimText public static function Trims the field down to the specified length.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::sanitizeValue public function Sanitize the value for output.
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting.
HandlerBase::getDateField public function Creates cross-database SQL dates.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::submitTemporaryForm public function A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PrerenderList::$items property Stores all items which are used to render the items. It should be keyed first by the id of the base table, for example nid. The second key is the id of the thing which is displayed multiple times per row, for example the tid.
FieldPluginBase::$field_alias property
FieldPluginBase::$aliases property
FieldPluginBase::$original_value public property The field value prior to any rewriting.
FieldPluginBase::$additional_fields property Stores additional fields which get's added to the query. The generated aliases are stored in $aliases.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$relationship public property The relationship used for this field.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$definition public property Plugins's definition
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$pluginDefinition protected property The plugin implementation definition.