class MapDataDefinition
Same name in other branches
- 9 core/lib/Drupal/Core/TypedData/MapDataDefinition.php \Drupal\Core\TypedData\MapDataDefinition
- 8.9.x core/lib/Drupal/Core/TypedData/MapDataDefinition.php \Drupal\Core\TypedData\MapDataDefinition
- 11.x 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\DataDefinitionInterface, \Drupal\Core\TypedData\ArrayAccess uses \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\ComplexDataDefinitionBase extends \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ComplexDataDefinitionInterface
- class \Drupal\Core\TypedData\MapDataDefinition extends \Drupal\Core\TypedData\ComplexDataDefinitionBase
- class \Drupal\Core\TypedData\ComplexDataDefinitionBase extends \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ComplexDataDefinitionInterface
Expanded class hierarchy of MapDataDefinition
13 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 - Map.php in core/
lib/ Drupal/ Core/ TypedData/ Plugin/ DataType/ Map.php - MapDataNormalizerTest.php in core/
modules/ serialization/ tests/ src/ Kernel/ MapDataNormalizerTest.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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ComplexDataDefinitionBase::$propertyDefinitions | protected | property | An array of data definitions. | ||
ComplexDataDefinitionBase::getPropertyDefinition | public | function | Gets the definition of a contained property. | Overrides ComplexDataDefinitionInterface::getPropertyDefinition | |
ComplexDataDefinitionBase::__sleep | public | function | Overrides DataDefinition::__sleep | ||
DataDefinition::$definition | protected | property | The array holding values for all definition keys. | ||
DataDefinition::addConstraint | public | function | Adds a validation constraint. | Overrides DataDefinitionInterface::addConstraint | |
DataDefinition::getClass | public | function | Returns the class used for creating the typed data object. | Overrides DataDefinitionInterface::getClass | 1 |
DataDefinition::getConstraint | public | function | Returns a validation constraint. | Overrides DataDefinitionInterface::getConstraint | |
DataDefinition::getConstraints | public | function | Returns an array of validation constraints. | Overrides DataDefinitionInterface::getConstraints | 1 |
DataDefinition::getDataType | public | function | Returns the data type of the data. | Overrides DataDefinitionInterface::getDataType | 2 |
DataDefinition::getDescription | public | function | Returns a human readable description. | Overrides DataDefinitionInterface::getDescription | |
DataDefinition::getLabel | public | function | Returns a human readable label. | Overrides DataDefinitionInterface::getLabel | 1 |
DataDefinition::getSetting | public | function | Returns the value of a given setting. | Overrides DataDefinitionInterface::getSetting | 2 |
DataDefinition::getSettings | public | function | Returns the array of settings, as required by the used class. | Overrides DataDefinitionInterface::getSettings | 2 |
DataDefinition::isComputed | public | function | Determines whether the data value is computed. | Overrides DataDefinitionInterface::isComputed | |
DataDefinition::isInternal | public | function | Determines whether the data value is internal. | Overrides DataDefinitionInterface::isInternal | 1 |
DataDefinition::isList | public | function | Returns whether the data is multi-valued, i.e. a list of data items. | Overrides DataDefinitionInterface::isList | |
DataDefinition::isReadOnly | public | function | Determines whether the data is read-only. | Overrides DataDefinitionInterface::isReadOnly | |
DataDefinition::isRequired | public | function | Determines whether a data value is required. | Overrides DataDefinitionInterface::isRequired | |
DataDefinition::offsetExists | public | function | This is for BC support only. @todo Remove in https://www.drupal.org/node/1928868. |
||
DataDefinition::offsetGet | public | function | This is for BC support only. @todo Remove in https://www.drupal.org/node/1928868. |
||
DataDefinition::offsetSet | public | function | This is for BC support only. @todo Remove in https://www.drupal.org/node/1928868. |
||
DataDefinition::offsetUnset | public | function | This is for BC support only. @todo Remove in https://www.drupal.org/node/1928868. |
||
DataDefinition::setClass | public | function | Sets the class used for creating the typed data object. | ||
DataDefinition::setComputed | public | function | Sets whether the data is computed. | ||
DataDefinition::setConstraints | public | function | Sets an array of validation constraints. | ||
DataDefinition::setDataType | public | function | Sets the data type. | 1 | |
DataDefinition::setDescription | public | function | Sets the human-readable description. | ||
DataDefinition::setInternal | public | function | Sets the whether the data value should be internal. | ||
DataDefinition::setLabel | public | function | Sets the human-readable label. | ||
DataDefinition::setReadOnly | public | function | Sets whether the data is read-only. | ||
DataDefinition::setRequired | public | function | Sets whether the data is required. | ||
DataDefinition::setSetting | public | function | Sets a definition setting. | 2 | |
DataDefinition::setSettings | public | function | Sets the array of settings, as required by the used class. | 2 | |
DataDefinition::toArray | public | function | Returns all definition values as array. | ||
DataDefinition::__construct | public | function | Constructs a new data definition object. | 1 | |
MapDataDefinition::$mainPropertyName | protected | property | The name of the main property, or NULL if there is none. | ||
MapDataDefinition::create | public static | function | Creates a new map definition. | Overrides DataDefinition::create | |
MapDataDefinition::createFromDataType | public static | function | Creates a new data definition object. | Overrides DataDefinition::createFromDataType | |
MapDataDefinition::getMainPropertyName | public | function | Returns the name of the main property, if any. | Overrides ComplexDataDefinitionBase::getMainPropertyName | |
MapDataDefinition::getPropertyDefinitions | public | function | Gets an array of property definitions of contained properties. | Overrides ComplexDataDefinitionBase::getPropertyDefinitions | |
MapDataDefinition::setMainPropertyName | public | function | Sets the main property name. | ||
MapDataDefinition::setPropertyDefinition | public | function | Sets the definition of a map property. | ||
TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | ||
TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | |
TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.