class Mapping

Same name in this branch
  1. 9 core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
Same name and namespace in other branches
  1. 11.x core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
  2. 11.x core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping
  3. 10 core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
  4. 10 core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping
  5. 8.9.x core/modules/views/src/Plugin/views/style/Mapping.php \Drupal\views\Plugin\views\style\Mapping
  6. 8.9.x core/lib/Drupal/Core/Config/Schema/Mapping.php \Drupal\Core\Config\Schema\Mapping

Defines a mapping configuration element.

This object may contain any number and type of nested properties and each property key may have its own definition in the 'mapping' property of the configuration schema.

Properties in the configuration value that are not defined in the mapping will get the 'undefined' data type.

Read https://www.drupal.org/node/1905070 for more details about configuration schema, types and type resolution.

Hierarchy

Expanded class hierarchy of Mapping

3 files declare their use of Mapping
ConfigEntityAdapterTest.php in core/tests/Drupal/KernelTests/Core/Entity/ConfigEntityAdapterTest.php
ConfigSchemaTest.php in core/tests/Drupal/KernelTests/Core/Config/ConfigSchemaTest.php
StorableConfigBase.php in core/lib/Drupal/Core/Config/StorableConfigBase.php
93 string references to 'Mapping'
aggregator.schema.yml in core/modules/aggregator/config/schema/aggregator.schema.yml
core/modules/aggregator/config/schema/aggregator.schema.yml
aggregator_test.schema.yml in core/modules/aggregator/tests/modules/aggregator_test/config/schema/aggregator_test.schema.yml
core/modules/aggregator/tests/modules/aggregator_test/config/schema/aggregator_test.schema.yml
book.schema.yml in core/modules/book/config/schema/book.schema.yml
core/modules/book/config/schema/book.schema.yml
ckeditor.schema.yml in core/modules/ckeditor/config/schema/ckeditor.schema.yml
core/modules/ckeditor/config/schema/ckeditor.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

... See full list

File

core/lib/Drupal/Core/Config/Schema/Mapping.php, line 18

Namespace

Drupal\Core\Config\Schema
View on git.drupalcode.org
View source 
class Mapping extends ArrayElement {
  
  /**
   * {@inheritdoc}
   */
  protected function getElementDefinition($key) {
    $value = $this->value[$key] ?? NULL;
    $definition = $this->definition['mapping'][$key] ?? [];
    return $this->buildDataDefinition($definition, $value, $key);
  }

}

Members

Title Modifiers Object type Summary Overriden Title
ArrayElement::$elements protected property Parsed elements.
ArrayElement::buildDataDefinition protected function Creates a new data definition object from an array and configuration.
ArrayElement::createElement protected function Creates a contained typed configuration object.
ArrayElement::get public function
ArrayElement::getAllKeys protected function Gets valid configuration data keys.
ArrayElement::getElements public function
ArrayElement::getIterator public function #[\ReturnTypeWillChange]
ArrayElement::getProperties public function
ArrayElement::isEmpty public function
ArrayElement::isNullable public function Determines if this element allows NULL as a value.
ArrayElement::onChange public function
ArrayElement::parse protected function Builds an array of contained elements.
ArrayElement::set public function
ArrayElement::toArray public function
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
Element::$value protected property The configuration value.
Element::getTypedDataManager public function Gets the typed configuration manager.
Element::setTypedDataManager public function Sets the typed config manager.
Mapping::getElementDefinition protected function Gets data definition object for contained element. Overrides ArrayElement::getElementDefinition
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
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::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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TypedData::$definition protected property The data definition.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::applyDefaultValue public function
TypedData::createInstance public static function
TypedData::getConstraints public function
TypedData::getDataDefinition public function
TypedData::getName public function
TypedData::getParent public function
TypedData::getPluginDefinition public function
TypedData::getPluginId public function
TypedData::getPropertyPath public function
TypedData::getRoot public function
TypedData::getString public function
TypedData::getValue public function
TypedData::setContext public function
TypedData::setValue public function
TypedData::validate public function
TypedData::__construct public function Constructs a TypedData object given its definition and context.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.