Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/TypedData/MapDataDefinition.php \Drupal\Core\TypedData\MapDataDefinition
- 9 core/lib/Drupal/Core/TypedData/MapDataDefinition.php \Drupal\Core\TypedData\MapDataDefinition
A typed data definition class for defining maps.
Hierarchy
- class \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ArrayAccess, DataDefinitionInterface uses TypedDataTrait
- class \Drupal\Core\TypedData\ComplexDataDefinitionBase implements ComplexDataDefinitionInterface
- class \Drupal\Core\TypedData\MapDataDefinition
- class \Drupal\Core\TypedData\ComplexDataDefinitionBase implements ComplexDataDefinitionInterface
Expanded class hierarchy of MapDataDefinition
7 files declare their use of MapDataDefinition
- ComplexDataConstraintValidatorTest.php in core/
tests/ Drupal/ KernelTests/ Core/ TypedData/ ComplexDataConstraintValidatorTest.php - EntityBundleExistsConstraintValidatorTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Entity/ EntityBundleExistsConstraintValidatorTest.php - LinkItem.php in core/
modules/ link/ src/ Plugin/ Field/ FieldType/ LinkItem.php - MapDataNormalizerTest.php in core/
modules/ serialization/ tests/ src/ Kernel/ MapDataNormalizerTest.php - RecursiveContextualValidatorTest.php in core/
tests/ Drupal/ Tests/ Core/ TypedData/ RecursiveContextualValidatorTest.php
1 string reference to 'MapDataDefinition'
- core.data_types.schema.yml in core/
config/ schema/ core.data_types.schema.yml - core/config/schema/core.data_types.schema.yml
File
- core/
lib/ Drupal/ Core/ TypedData/ MapDataDefinition.php, line 8
Namespace
Drupal\Core\TypedDataView source
class MapDataDefinition extends ComplexDataDefinitionBase {
/**
* The name of the main property, or NULL if there is none.
*
* @var string
*/
protected $mainPropertyName = NULL;
/**
* Creates a new map definition.
*
* @param string $type
* (optional) The data type of the map. Defaults to 'map'.
*
* @return static
*/
public static function create($type = 'map') {
$definition['type'] = $type;
return new static($definition);
}
/**
* {@inheritdoc}
*/
public static function createFromDataType($data_type) {
return static::create($data_type);
}
/**
* {@inheritdoc}
*/
public function getPropertyDefinitions() {
if (!isset($this->propertyDefinitions)) {
$this->propertyDefinitions = [];
}
return $this->propertyDefinitions;
}
/**
* Sets the definition of a map property.
*
* @param string $name
* The name of the property to define.
* @param \Drupal\Core\TypedData\DataDefinitionInterface|null $definition
* (optional) The property definition to set, or NULL to unset it.
*
* @return $this
*/
public function setPropertyDefinition($name, DataDefinitionInterface $definition = NULL) {
if (isset($definition)) {
$this->propertyDefinitions[$name] = $definition;
}
else {
unset($this->propertyDefinitions[$name]);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getMainPropertyName() {
return $this->mainPropertyName;
}
/**
* Sets the main property name.
*
* @param string|null $name
* The name of the main property, or NULL if there is none.
*
* @return $this
*/
public function setMainPropertyName($name) {
$this->mainPropertyName = $name;
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComplexDataDefinitionBase:: |
protected | property | An array of data definitions. | |
ComplexDataDefinitionBase:: |
public | function |
Gets the definition of a contained property. Overrides ComplexDataDefinitionInterface:: |
|
ComplexDataDefinitionBase:: |
public | function |
Overrides DataDefinition:: |
|
DataDefinition:: |
protected | property | The array holding values for all definition keys. | |
DataDefinition:: |
public | function |
Adds a validation constraint. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns the class used for creating the typed data object. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns a validation constraint. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns an array of validation constraints. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns the data type of the data. Overrides DataDefinitionInterface:: |
2 |
DataDefinition:: |
public | function |
Returns a human readable description. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Returns a human readable label. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns the value of a given setting. Overrides DataDefinitionInterface:: |
2 |
DataDefinition:: |
public | function |
Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface:: |
2 |
DataDefinition:: |
public | function |
Determines whether the data value is computed. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Determines whether the data value is internal. Overrides DataDefinitionInterface:: |
1 |
DataDefinition:: |
public | function |
Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Determines whether the data is read-only. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function |
Determines whether a data value is required. Overrides DataDefinitionInterface:: |
|
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | ||
DataDefinition:: |
public | function | Sets the class used for creating the typed data object. | |
DataDefinition:: |
public | function | Sets whether the data is computed. | |
DataDefinition:: |
public | function | Sets an array of validation constraints. | |
DataDefinition:: |
public | function | Sets the data type. | 1 |
DataDefinition:: |
public | function | Sets the human-readable description. | |
DataDefinition:: |
public | function | Sets the whether the data value should be internal. | |
DataDefinition:: |
public | function | Sets the human-readable label. | |
DataDefinition:: |
public | function | Sets whether the data is read-only. | |
DataDefinition:: |
public | function | Sets whether the data is required. | |
DataDefinition:: |
public | function | Sets a definition setting. | 2 |
DataDefinition:: |
public | function | Sets the array of settings, as required by the used class. | 2 |
DataDefinition:: |
public | function | Returns all definition values as array. | |
DataDefinition:: |
public | function | Constructs a new data definition object. | 1 |
MapDataDefinition:: |
protected | property | The name of the main property, or NULL if there is none. | |
MapDataDefinition:: |
public static | function |
Creates a new map definition. Overrides DataDefinition:: |
|
MapDataDefinition:: |
public static | function |
Creates a new data definition object. Overrides DataDefinition:: |
|
MapDataDefinition:: |
public | function |
Returns the name of the main property, if any. Overrides ComplexDataDefinitionBase:: |
|
MapDataDefinition:: |
public | function |
Gets an array of property definitions of contained properties. Overrides ComplexDataDefinitionBase:: |
|
MapDataDefinition:: |
public | function | Sets the main property name. | |
MapDataDefinition:: |
public | function | Sets the definition of a map property. | |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 1 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 1 |