Plugin which displays fields as raw data.
@Plugin(
id = "data_field",
module = "rest",
title = @Translation("Fields"),
help = @Translation("Use fields as row data."),
display_types = {"data"}
)
Expanded class hierarchy of DataFieldRow
class DataFieldRow extends RowPluginBase {
/**
* Overrides \Drupal\views\Plugin\views\row\RowPluginBase::$usesFields.
*/
protected $usesFields = TRUE;
/**
* Stores an array of prepared field aliases from options.
*
* @var array
*/
protected $replacementAliases = array();
/**
* Stores an array of options to determine if the raw field output is used.
*
* @var array
*/
protected $rawOutputOptions = array();
/**
* Overrides \Drupal\views\Plugin\views\row\RowPluginBase::init().
*/
public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
parent::init($view, $display, $options);
if (!empty($this->options['field_options'])) {
$options = (array) $this->options['field_options'];
// Prepare a trimmed version of replacement aliases.
$aliases = static::extractFromOptionsArray('alias', $options);
$this->replacementAliases = array_filter(array_map('trim', $aliases));
// Prepare an array of raw output field options.
$this->rawOutputOptions = static::extractFromOptionsArray('raw_output', $options);
}
}
/**
* Overrides \Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['field_options'] = array(
'default' => array(),
);
return $options;
}
/**
* Overrides \Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
*/
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($form, $form_state);
$form['field_options'] = array(
'#type' => 'table',
'#header' => array(
t('Field'),
t('Alias'),
t('Raw output'),
),
'#empty' => t('You have no fields. Add some to your view.'),
'#tree' => TRUE,
);
$options = $this->options['field_options'];
if ($fields = $this->view->display_handler
->getOption('fields')) {
foreach ($fields as $id => $field) {
$form['field_options'][$id]['field'] = array(
'#markup' => $id,
);
$form['field_options'][$id]['alias'] = array(
'#type' => 'textfield',
'#default_value' => isset($options[$id]['alias']) ? $options[$id]['alias'] : '',
'#element_validate' => array(
array(
$this,
'validateAliasName',
),
),
);
$form['field_options'][$id]['raw_output'] = array(
'#type' => 'checkbox',
'#default_value' => isset($options[$id]['raw_output']) ? $options[$id]['raw_output'] : '',
);
}
}
}
/**
* Form element validation handler for \Drupal\rest\Plugin\views\row\DataFieldRow::buildOptionsForm().
*/
public function validateAliasName($element, &$form_state) {
if (preg_match('@[^A-Za-z0-9_-]+@', $element['#value'])) {
form_error($element, t('The machine-readable name must contain only letters, numbers, dashes and underscores.'));
}
}
/**
* Overrides \Drupal\views\Plugin\views\row\RowPluginBase::validateOptionsForm().
*/
public function validateOptionsForm(&$form, &$form_state) {
// Collect an array of aliases to validate.
$aliases = static::extractFromOptionsArray('alias', $form_state['values']['row_options']['field_options']);
// If array filter returns empty, no values have been entered. Unique keys
// should only be validated if we have some.
if (($filtered = array_filter($aliases)) && array_unique($filtered) !== $filtered) {
form_set_error('aliases', t('All field aliases must be unique'));
}
}
/**
* Overrides \Drupal\views\Plugin\views\row\RowPluginBase::render().
*/
public function render($row) {
$output = array();
foreach ($this->view->field as $id => $field) {
// If this is not unknown and the raw output option has been set, just get
// the raw value.
if ($field->field_alias != 'unknown' && !empty($this->rawOutputOptions[$id])) {
$value = $field
->sanitizeValue($field
->getValue($row), 'xss_admin');
}
else {
$value = $field
->render($row);
}
$output[$this
->getFieldKeyAlias($id)] = $value;
}
return $output;
}
/**
* Return an alias for a field ID, as set in the options form.
*
* @param string $id
* The field id to lookup an alias for.
*
* @return string
* The matches user entered alias, or the original ID if nothing is found.
*/
public function getFieldKeyAlias($id) {
if (isset($this->replacementAliases[$id])) {
return $this->replacementAliases[$id];
}
return $id;
}
/**
* Extracts a set of option values from a nested options array.
*
* @param string $key
* The key to extract from each array item.
* @param array $options
* The options array to return values from.
*
* @return array
* A regular one dimensional array of values.
*/
protected static function extractFromOptionsArray($key, $options) {
return array_map(function ($item) use ($key) {
return isset($item[$key]) ? $item[$key] : NULL;
}, $options);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
DataFieldRow:: |
protected | property | Stores an array of options to determine if the raw field output is used. | |
DataFieldRow:: |
protected | property | Stores an array of prepared field aliases from options. | |
DataFieldRow:: |
protected | property |
Overrides \Drupal\views\Plugin\views\row\RowPluginBase::$usesFields. Overrides RowPluginBase:: |
|
DataFieldRow:: |
public | function |
Overrides \Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm(). Overrides RowPluginBase:: |
|
DataFieldRow:: |
protected | function |
Overrides \Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm(). Overrides RowPluginBase:: |
|
DataFieldRow:: |
protected static | function | Extracts a set of option values from a nested options array. | |
DataFieldRow:: |
public | function | Return an alias for a field ID, as set in the options form. | |
DataFieldRow:: |
public | function |
Overrides \Drupal\views\Plugin\views\row\RowPluginBase::init(). Overrides PluginBase:: |
|
DataFieldRow:: |
public | function |
Overrides \Drupal\views\Plugin\views\row\RowPluginBase::render(). Overrides RowPluginBase:: |
|
DataFieldRow:: |
public | function | Form element validation handler for \Drupal\rest\Plugin\views\row\DataFieldRow::buildOptionsForm(). | |
DataFieldRow:: |
public | function |
Overrides \Drupal\views\Plugin\views\row\RowPluginBase::validateOptionsForm(). Overrides RowPluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
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 implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. 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 | Fills up the options of the plugin with defaults. | |
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:: |
1 |
RowPluginBase:: |
function | Allow the style to do stuff before each row is rendered. | 4 | |
RowPluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides PluginBase:: |
|
RowPluginBase:: |
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 PluginBase:: |
1 |
RowPluginBase:: |
function | Returns the usesFields property. | 3 |