You are here

Home » API reference » Views (for Drupal 7) 8.3 » HtmlList.php

class HtmlList in Views (for Drupal 7) 8.3

Style plugin to render each item in an ordered or unordered list.

Plugin annotation


@Plugin(
  id = "html_list",
  title = @Translation("HTML List"),
  help = @Translation("Displays rows as HTML list."),
  theme = "views_view_list",
  type = "normal"
)

Hierarchy

Expanded class hierarchy of HtmlList

Related topics

Views style plugins
Style plugins control how a view is rendered. For example, they can choose to display a collection of fields, node_view() output, table output, or any kind of crazy output they want.

File

lib/Drupal/views/Plugin/views/style/HtmlList.php, line 26
Definition of Drupal\views\Plugin\views\style\List.

Namespace

Drupal\views\Plugin\views\style
View source 
class HtmlList extends StylePluginBase {

  /**
   * Does the style plugin allows to use style plugins.
   *
   * @var bool
   */
  protected $usesRowPlugin = TRUE;

  /**
   * Does the style plugin support custom css class for the rows.
   *
   * @var bool
   */
  protected $usesRowClass = TRUE;

  /**
   * Set default options
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['type'] = array(
      'default' => 'ul',
    );
    $options['class'] = array(
      'default' => '',
    );
    $options['wrapper_class'] = array(
      'default' => 'item-list',
    );
    return $options;
  }

  /**
   * Render the given style.
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['type'] = array(
      '#type' => 'radios',
      '#title' => t('List type'),
      '#options' => array(
        'ul' => t('Unordered list'),
        'ol' => t('Ordered list'),
      ),
      '#default_value' => $this->options['type'],
    );
    $form['wrapper_class'] = array(
      '#title' => t('Wrapper class'),
      '#description' => t('The class to provide on the wrapper, outside the list.'),
      '#type' => 'textfield',
      '#size' => '30',
      '#default_value' => $this->options['wrapper_class'],
    );
    $form['class'] = array(
      '#title' => t('List class'),
      '#description' => t('The class to provide on the list element itself.'),
      '#type' => 'textfield',
      '#size' => '30',
      '#default_value' => $this->options['class'],
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
HtmlList::$usesRowClass protected property Does the style plugin support custom css class for the rows. Overrides StylePluginBase::$usesRowClass
HtmlList::$usesRowPlugin protected property Does the style plugin allows to use style plugins. Overrides StylePluginBase::$usesRowPlugin
HtmlList::buildOptionsForm public function Render the given style. Overrides StylePluginBase::buildOptionsForm
HtmlList::defineOptions protected function Set default options Overrides StylePluginBase::defineOptions
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::submitOptionsForm public function Handle any special handling on the validate form. 10
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct 2
StylePluginBase::$row_plugin property Contains the row plugin, if it's initialized and the style itself supports it.
StylePluginBase::$row_tokens property Store all available tokens row rows.
StylePluginBase::$usesFields protected property Does the style plugin for itself support to add fields to it's output. 2
StylePluginBase::$usesGrouping protected property Does the style plugin support grouping of rows. 1
StylePluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
StylePluginBase::build_sort function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
StylePluginBase::build_sort_post function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
StylePluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::even_empty function Should the output of the style plugin be rendered even if it's a empty view. 1
StylePluginBase::get_field function Get a rendered field.
StylePluginBase::get_field_value function Get the raw field value.
StylePluginBase::get_row_class function Return the token replaced row class for the specified row.
StylePluginBase::init public function Initialize a style plugin.
StylePluginBase::pre_render function Allow the style to do stuff before each row is rendered.
StylePluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 1
StylePluginBase::render function Render the display in this style. 4
StylePluginBase::render_fields function Render all of the fields for a given style and store them on the object.
StylePluginBase::render_grouping function Group records as needed for rendering.
StylePluginBase::render_grouping_sets function Render the grouping sets.
StylePluginBase::tokenize_value function Take a value and apply token replacement logic to it.
StylePluginBase::usesFields function Return TRUE if this style also uses fields. 2
StylePluginBase::usesGrouping function Returns the usesGrouping property. 1
StylePluginBase::usesRowClass function Returns the usesRowClass property. 4
StylePluginBase::usesRowPlugin function Returns the usesRowPlugin property. 6
StylePluginBase::uses_tokens function Return TRUE if this style uses tokens.
StylePluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizard_form function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizard_submit function Alter the options of a display before they are added to the view. 1