Newer
Older
Tim Plunkett
committed
<?php
/**
* @file
* Contains \Drupal\views\Plugin\views\style\Mapping.
Tim Plunkett
committed
*/
namespace Drupal\views\Plugin\views\style;
Dries Buytaert
committed
use Drupal\Core\Form\FormStateInterface;
Tim Plunkett
committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/**
* Allows fields to be mapped to specific use cases.
*
* @ingroup views_style_plugins
*/
abstract class Mapping extends StylePluginBase {
/**
* Do not use grouping.
*
* @var bool
*/
protected $usesGrouping = FALSE;
/**
* Use fields without a row plugin.
*
* @var bool
*/
protected $usesFields = TRUE;
/**
* Builds the list of field mappings.
*
* @return array
* An associative array, keyed by the field name, containing the following
* key-value pairs:
* - #title: The human-readable label for this field.
* - #default_value: The default value for this field. If not provided, an
* empty string will be used.
* - #description: A description of this field.
* - #required: Whether this field is required.
* - #filter: (optional) A method on the plugin to filter field options.
* - #toggle: (optional) If this select should be toggled by a checkbox.
*/
Tim Plunkett
committed
abstract protected function defineMapping();
Tim Plunkett
committed
/**
* Overrides Drupal\views\Plugin\views\style\StylePluginBase::defineOptions().
*/
protected function defineOptions() {
$options = parent::defineOptions();
// Parse the mapping and add a default for each.
foreach ($this->defineMapping() as $key => $value) {
$default = !empty($value['#multiple']) ? array() : '';
$options['mapping']['contains'][$key] = array(
'default' => isset($value['#default_value']) ? $value['#default_value'] : $default,
);
if (!empty($value['#toggle'])) {
$options['mapping']['contains']["toggle_$key"] = array(
'default' => FALSE,
);
}
}
return $options;
}
/**
* Overrides Drupal\views\Plugin\views\style\StylePluginBase::buildOptionsForm().
*/
Dries Buytaert
committed
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
Tim Plunkett
committed
parent::buildOptionsForm($form, $form_state);
// Get the mapping.
$mapping = $this->defineMapping();
// Restrict the list of defaults to the mapping, in case they have changed.
$options = array_intersect_key($this->options['mapping'], $mapping);
// Get the labels of the fields added to this display.
Daniel Wehner
committed
$field_labels = $this->displayHandler->getFieldLabels();
Tim Plunkett
committed
// Provide some default values.
$defaults = array(
'#type' => 'select',
'#required' => FALSE,
'#multiple' => FALSE,
);
// For each mapping, add a select element to the form.
foreach ($options as $key => $value) {
// If the field is optional, add a 'None' value to the top of the options.
$field_options = array();
$required = !empty($mapping[$key]['#required']);
if (!$required && empty($mapping[$key]['#multiple'])) {
$field_options = array('' => $this->t('- None -'));
Tim Plunkett
committed
}
$field_options += $field_labels;
// Optionally filter the available fields.
if (isset($mapping[$key]['#filter'])) {
$this->view->initHandlers();
Angie Byron
committed
$filter = $mapping[$key]['#filter'];
$this::$filter($field_options);
Tim Plunkett
committed
unset($mapping[$key]['#filter']);
}
// These values must always be set.
$overrides = array(
'#options' => $field_options,
'#default_value' => $options[$key],
);
// Optionally allow the select to be toggleable.
if (!empty($mapping[$key]['#toggle'])) {
$form['mapping']["toggle_$key"] = array(
'#type' => 'checkbox',
'#title' => $this->t('Use a custom %field_name', array('%field_name' => strtolower($mapping[$key]['#title']))),
Tim Plunkett
committed
'#default_value' => $this->options['mapping']["toggle_$key"],
);
$overrides['#states']['visible'][':input[name="style_options[mapping][' . "toggle_$key" . ']"]'] = array('checked' => TRUE);
}
$form['mapping'][$key] = $overrides + $mapping[$key] + $defaults;
}
}
/**
* Overrides Drupal\views\Plugin\views\style\StylePluginBase::render().
*
* Provides the mapping definition as an available variable.
*/
Alex Pott
committed
public function render() {
catch
committed
return array(
'#theme' => $this->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#rows' => $this->view->result,
'#mapping' => $this->defineMapping(),
);