class Fields

The basic 'fields' row plugin

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

Plugin annotation


@Plugin(
  id = "fields",
  title = @Translation("Fields"),
  help = @Translation("Displays the fields with an optional template."),
  theme = "views_view_fields",
  type = "normal"
)

Hierarchy

Expanded class hierarchy of Fields

Related topics

3 string references to 'Fields'
ContextualLinks::buildOptionsForm in drupal/core/modules/contextual/lib/Drupal/contextual/Plugin/views/field/ContextualLinks.php
Default options form that provides the label widget that all fields should have.
DisplayPluginBase::optionsSummary in drupal/core/modules/views/lib/Drupal/views/Plugin/views/display/DisplayPluginBase.php
Provide the default summary for options in the views UI.
ViewExecutable::viewsHandlerTypes in drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php
Provide a list of views handler types used in a view, with some information about them.

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/row/Fields.php, line 29
Definition of Drupal\views\Plugin\views\row\Fields.

Namespace

Drupal\views\Plugin\views\row
View source
class Fields extends RowPluginBase {

  /**
   * Does the row plugin support to add fields to it's output.
   *
   * @var bool
   */
  protected $usesFields = TRUE;
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['inline'] = array(
      'default' => array(),
    );
    $options['separator'] = array(
      'default' => '',
    );
    $options['hide_empty'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    $options['default_field_elements'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $options = $this->displayHandler
      ->getFieldLabels();
    if (empty($this->options['inline'])) {
      $this->options['inline'] = array();
    }
    $form['default_field_elements'] = array(
      '#type' => 'checkbox',
      '#title' => t('Provide default field wrapper elements'),
      '#default_value' => $this->options['default_field_elements'],
      '#description' => t('If not checked, fields that are not configured to customize their HTML elements will get no wrappers at all for their field, label and field + label wrappers. You can use this to quickly reduce the amount of markup the view provides by default, at the cost of making it more difficult to apply CSS.'),
    );
    $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. Note that some fields will ignore this if they are block elements, particularly body fields and other formatted HTML.'),
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[default_field_elements]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $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.'),
      '#states' => array(
        'visible' => array(
          ':input[name="row_options[default_field_elements]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $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.
   */
  public function submitOptionsForm(&$form, &$form_state) {
    $form_state['values']['row_options']['inline'] = array_filter($form_state['values']['row_options']['inline']);
  }

}

Members

Name Modifiers Typesort descending Description Overrides
Fields::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides RowPluginBase::defineOptions
Fields::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
Fields::submitOptionsForm 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. Overrides RowPluginBase::submitOptionsForm
RowPluginBase::init public function Initialize the row plugin. 1
RowPluginBase::usesFields function Returns the usesFields property. 2
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query
RowPluginBase::pre_render function Allow the style to do stuff before each row is rendered. 3
RowPluginBase::render function Render a row object. This usually passes through to a theme template of some form, but not always. 6
PluginBase::__construct public function Constructs a Plugin object. Overrides PluginBase::__construct
PluginBase::setOptionDefaults protected function
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::validate public function Validate that the plugin is correct and can be saved. 4
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::usesOptions public function Returns the usesOptions property. 8
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 Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
Fields::$usesFields protected property Does the row plugin support to add fields to it's output. Overrides RowPluginBase::$usesFields
RowPluginBase::$usesOptions protected property Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$view public property The top object of a view. 1
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$definition public property Plugins's definition
PluginBase::$discovery protected property The discovery object.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1