1. 8.5.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping
  2. 8.5.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  3. 8.0.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping
  4. 8.0.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  5. 8.1.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  6. 8.1.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping
  7. 8.2.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  8. 8.2.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping
  9. 8.3.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping
  10. 8.3.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  11. 8.4.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping
  12. 8.4.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  13. 8.6.x core/modules/views/src/Plugin/views/style/Mapping.php Mapping
  14. 8.6.x core/lib/Drupal/Core/Config/Schema/Mapping.php Mapping

Allows fields to be mapped to specific use cases.


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
3 string references to 'Mapping'
ConfigSchemaTest::testSchemaMapping in core/tests/Drupal/KernelTests/Core/Config/ConfigSchemaTest.php
Tests the basic metadata retrieval layer.
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
views_test_data.views.schema.yml in core/modules/views/tests/modules/views_test_data/config/schema/views_test_data.views.schema.yml


core/modules/views/src/Plugin/views/style/Mapping.php, line 12


View 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']) ? 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;

   * {@inheritdoc}
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Get the mapping.
    $mapping = $this

    // 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

    // 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 -'),
      $field_options += $field_labels;

      // Optionally filter the available fields.
      if (isset($mapping[$key]['#filter'])) {
        $filter = $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']),
          '#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.
  public function render() {
    return array(
      '#theme' => $this
      '#view' => $this->view,
      '#options' => $this->options,
      '#rows' => $this->view->result,
      '#mapping' => $this



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function
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.
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::$configuration protected property Configuration information passed into the plugin.
PluginBase::$definition public property Plugins's 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::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
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::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer.
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
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginBase::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StylePluginBase::$defaultFieldLabels protected property Should field labels be enabled by default.
StylePluginBase::$groupingTheme protected property The theme function used to render the grouping set.
StylePluginBase::$rendered_fields protected property Stores the rendered field values, keyed by the row index and field name.
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.
StylePluginBase::$usesRowPlugin protected property Does the style plugin allows to use style plugins.
StylePluginBase::buildSort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.
StylePluginBase::buildSortPost public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.
StylePluginBase::defaultFieldLabels public function Return TRUE if this style enables field labels by default.
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 Should the output of the style plugin be rendered even if it's a empty view.
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
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::usesFields function Return TRUE if this style also uses fields.
StylePluginBase::usesGrouping function Returns the usesGrouping property.
StylePluginBase::usesRowClass function Returns the usesRowClass property.
StylePluginBase::usesRowPlugin function Returns the usesRowPlugin property.
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::wizardForm public function Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit public function Alter the options of a display before they are added to the view.