class Mapping
Same name in this branch
- 10 core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping
Same name in other branches
- 9 core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
- 9 core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping
- 8.9.x core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
- 8.9.x core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping
- 11.x core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
- 11.x core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping
Allows fields to be mapped to specific use cases.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\style\Mapping extends \Drupal\views\Plugin\views\style\StylePluginBase
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Mapping
Related topics
1 file declares its use of Mapping
- MappingTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ style/ MappingTest.php
92 string references to 'Mapping'
- action.schema.yml in core/
modules/ action/ config/ schema/ action.schema.yml - core/modules/action/config/schema/action.schema.yml
- action_bulk_test.schema.yml in core/
modules/ views/ tests/ modules/ action_bulk_test/ config/ schema/ action_bulk_test.schema.yml - core/modules/views/tests/modules/action_bulk_test/config/schema/action_bulk_test.schema.yml
- book.schema.yml in core/
modules/ book/ config/ schema/ book.schema.yml - core/modules/book/config/schema/book.schema.yml
- ckeditor5.pair.schema.yml in core/
modules/ ckeditor5/ config/ schema/ ckeditor5.pair.schema.yml - core/modules/ckeditor5/config/schema/ckeditor5.pair.schema.yml
- ckeditor5.schema.yml in core/
modules/ ckeditor5/ config/ schema/ ckeditor5.schema.yml - core/modules/ckeditor5/config/schema/ckeditor5.schema.yml
File
-
core/
modules/ views/ src/ Plugin/ views/ style/ Mapping.php, line 12
Namespace
Drupal\views\Plugin\views\styleView source
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.
*/
protected abstract function defineMapping();
/**
* {@inheritdoc}
*/
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']) ? [] : '';
$options['mapping']['contains'][$key] = [
'default' => $value['#default_value'] ?? $default,
];
if (!empty($value['#toggle'])) {
$options['mapping']['contains']["toggle_{$key}"] = [
'default' => FALSE,
];
}
}
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
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.
$field_labels = $this->displayHandler
->getFieldLabels();
// Provide some default values.
$defaults = [
'#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 = [];
$required = !empty($mapping[$key]['#required']);
if (!$required && empty($mapping[$key]['#multiple'])) {
$field_options = [
'' => $this->t('- None -'),
];
}
$field_options += $field_labels;
// Optionally filter the available fields.
if (isset($mapping[$key]['#filter'])) {
$this->view
->initHandlers();
$filter = $mapping[$key]['#filter'];
$this::$filter($field_options);
unset($mapping[$key]['#filter']);
}
// These values must always be set.
$overrides = [
'#options' => $field_options,
'#default_value' => $options[$key],
];
// Optionally allow the select to be toggleable.
if (!empty($mapping[$key]['#toggle'])) {
$form['mapping']["toggle_{$key}"] = [
'#type' => 'checkbox',
'#title' => $this->t('Use a custom %field_name', [
'%field_name' => strtolower($mapping[$key]['#title']),
]),
'#default_value' => $this->options['mapping']["toggle_{$key}"],
];
$overrides['#states']['visible'][':input[name="style_options[mapping][' . "toggle_{$key}" . ']"]'] = [
'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.
*/
public function render() {
return [
'#theme' => $this->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#rows' => $this->view->result,
'#mapping' => $this->defineMapping(),
];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
Mapping::$usesFields | protected | property | Use fields without a row plugin. | Overrides StylePluginBase::$usesFields | ||
Mapping::$usesGrouping | protected | property | Do not use grouping. | Overrides StylePluginBase::$usesGrouping | ||
Mapping::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides StylePluginBase::buildOptionsForm | ||
Mapping::defineMapping | abstract protected | function | Builds the list of field mappings. | 1 | ||
Mapping::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides StylePluginBase::defineOptions | ||
Mapping::render | public | function | Overrides Drupal\views\Plugin\views\style\StylePluginBase::render(). | Overrides StylePluginBase::render | ||
PluginBase::$definition | public | property | Plugins' definition. | |||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | |||
PluginBase::$options | public | property | Options for this plugin will be held here. | |||
PluginBase::$position | public | property | The handler position. | |||
PluginBase::$renderer | protected | property | Stores the render API renderer. | 3 | ||
PluginBase::$view | public | property | The top object of a view. | 1 | ||
PluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 | |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 60 | |
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | ||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | ||
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | ||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | ||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | ||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
PluginBase::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides ViewsPluginInterface::submitOptionsForm | 16 | |
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 | |
PluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 | |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
PluginBase::__construct | public | function | Constructs a PluginBase object. | 19 | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | ||
StylePluginBase::$defaultFieldLabels | protected | property | Should field labels be enabled by default. | 1 | ||
StylePluginBase::$groupingTheme | protected | property | The theme function used to render the grouping set. | |||
StylePluginBase::$rendered_fields | protected | property | ||||
StylePluginBase::$render_tokens | public | property | ||||
StylePluginBase::$rowTokens | protected | property | Store all available tokens row rows. | |||
StylePluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | ||
StylePluginBase::$usesRowClass | protected | property | Does the style plugin support custom css class for the rows. | 3 | ||
StylePluginBase::$usesRowPlugin | protected | property | Whether or not this style uses a row plugin. | 11 | ||
StylePluginBase::buildSort | public | function | Determines if the style handler should interfere with sorts. | 1 | ||
StylePluginBase::buildSortPost | public | function | Allows the view builder to build a second set of sorts. | 1 | ||
StylePluginBase::defaultFieldLabels | public | function | Return TRUE if this style enables field labels by default. | 1 | ||
StylePluginBase::destroy | public | function | Clears a plugin. | Overrides PluginBase::destroy | ||
StylePluginBase::elementPreRenderRow | public | function | #pre_render callback for view row field rendering. | |||
StylePluginBase::evenEmpty | public | function | Determines if the style plugin is rendered even if the view is empty. | 2 | ||
StylePluginBase::getField | public | function | Gets a rendered field. | |||
StylePluginBase::getFieldValue | public | function | Get the raw field value. | |||
StylePluginBase::getRowClass | public | function | Return the token replaced row class for the specified row. | |||
StylePluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\PluginBase::init(). | Overrides PluginBase::init | ||
StylePluginBase::preRender | public | function | Allow the style to do stuff before each row is rendered. | |||
StylePluginBase::query | public | function | Add anything to the query that we might need to. | Overrides PluginBase::query | 1 | |
StylePluginBase::renderFields | protected | function | Renders all of the fields for a given style and store them on the object. | |||
StylePluginBase::renderGrouping | public | function | Group records as needed for rendering. | |||
StylePluginBase::renderGroupingSets | public | function | Render the grouping sets. | |||
StylePluginBase::renderRowGroup | protected | function | Renders a group of rows of the grouped view. | |||
StylePluginBase::tokenizeValue | public | function | Take a value and apply token replacement logic to it. | |||
StylePluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | ||
StylePluginBase::usesFields | public | function | Return TRUE if this style also uses fields. | 3 | ||
StylePluginBase::usesGrouping | public | function | Returns the usesGrouping property. | 3 | ||
StylePluginBase::usesRowClass | public | function | Returns the usesRowClass property. | 3 | ||
StylePluginBase::usesRowPlugin | public | function | Returns the usesRowPlugin property. | 11 | ||
StylePluginBase::usesTokens | public | function | Return TRUE if this style uses tokens. | |||
StylePluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | ||
StylePluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | ||
StylePluginBase::wizardSubmit | public | function | Alter the options of a display before they are added to the view. | 1 | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.