class views_plugin_row_fields in Views (for Drupal 7) 6.2

The basic 'fields' row plugin

This displays fields one after another, giving options for inline or not.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_row
      • class \views_plugin_row_fields

Related topics

Views' row plugins

Row plugins control how Views outputs an individual record. They are tightly coupled to style plugins, in that a style plugin is what calls the row plugin.

1 string reference to 'views_plugin_row_fields'

views_views_plugins in includes/plugins.inc

Implementation of hook_views_plugins

File

plugins/views_plugin_row_fields.inc, line 15

Contains the base row style plugin.

class views_plugin_row_fields extends views_plugin_row {
  function option_definition() {
    $options = parent::option_definition();
    $options['inline'] = array(
      'default' => array(),
    );
    $options['separator'] = array(
      'default' => '',
    );
    $options['hide_empty'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  function options_form(&$form, &$form_state) {
    $options = $this->display->handler
      ->get_field_labels();
    if (empty($this->options['inline'])) {
      $this->options['inline'] = array();
    }
    $form['inline'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Inline fields'),
      '#options' => $options,
      '#default_value' => $this->options['inline'],
      '#description' => t('Inline fields will be displayed next to each other rather than one after another.'),
    );
    $form['separator'] = array(
      '#title' => t('Separator'),
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => isset($this->options['separator']) ? $this->options['separator'] : '',
      '#description' => t('The separator may be placed between inline fields to keep them from squishing up next to each other. You can use HTML in this field.'),
    );
    $form['hide_empty'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide empty fields'),
      '#default_value' => $this->options['hide_empty'],
      '#description' => t('Do not display fields, labels or markup for fields that are empty.'),
    );
  }

  /**
   * Perform any necessary changes to the form values prior to storage.
   * There is no need for this function to actually store the data.
   */
  function options_submit(&$form, &$form_state) {
    $form_state['values']['row_options']['inline'] = array_filter($form_state['values']['row_options']['inline']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::construct		function	Views handlers use a special construct function so that we can more easily construct them with variable arguments.	5
views_object::destroy		function		2
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults		function		1
views_plugin::additional_theme_functions		function	Provide a list of additional theme functions for the theme information page
views_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style.
views_plugin::validate		function	Validate that the plugin is correct and can be saved.	2
views_plugin_row::init		function	Initialize the row plugin. Overrides views_plugin::init	1
views_plugin_row::options_validate		function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::pre_render		function	Allow the style to do stuff before each row is rendered.	1
views_plugin_row::query		function	Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::render		function	Render a row object. This usually passes through to a theme template of some form, but not always.	4
views_plugin_row::uses_fields		function
views_plugin_row_fields::options_form		function	Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_fields::options_submit		function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_plugin_row::options_submit
views_plugin_row_fields::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition