The basic 'fields' row plugin
This displays fields one after another, giving options for inline or not.
@Plugin(
id = "fields",
title = @Translation("Fields"),
help = @Translation("Displays the fields with an optional template."),
theme = "views_view_fields",
type = "normal"
)
Expanded class hierarchy of Fields
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']);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Fields:: |
protected | property |
Does the row plugin support to add fields to it's output. Overrides RowPluginBase:: |
|
Fields:: |
public | function |
Provide a form for setting options. Overrides RowPluginBase:: |
|
Fields:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides RowPluginBase:: |
|
Fields:: |
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:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Validate that the plugin is correct and can be saved. | 4 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
RowPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
RowPluginBase:: |
public | function | Initialize the row plugin. | 1 |
RowPluginBase:: |
function | Allow the style to do stuff before each row is rendered. | 3 | |
RowPluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides PluginBase:: |
|
RowPluginBase:: |
function | Render a row object. This usually passes through to a theme template of some form, but not always. | 6 | |
RowPluginBase:: |
function | Returns the usesFields property. | 2 | |
RowPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |