class Enum

Same name in this branch
  1. main core/lib/Drupal/Component/Annotation/Doctrine/Annotation/Enum.php \Drupal\Component\Annotation\Doctrine\Annotation\Enum
Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Component/Annotation/Doctrine/Annotation/Enum.php \Drupal\Component\Annotation\Doctrine\Annotation\Enum
  2. 11.x core/lib/Drupal/Core/TypedData/Plugin/DataType/Enum.php \Drupal\Core\TypedData\Plugin\DataType\Enum

The "enum" data type.

Attributes

#[DataType(id: "enum", label: new TranslatableMarkup("Enum"))]

Hierarchy

Expanded class hierarchy of Enum

Related topics

Typed Data API
API for describing data based on a set of available data types.
1 file declares its use of Enum
SchemaCheckTrait.php in core/lib/Drupal/Core/Config/Schema/SchemaCheckTrait.php
6 string references to 'Enum'
config_enum_dependency_test.schema.yml in core/modules/config/tests/config_enum_dependency_test/config/schema/config_enum_dependency_test.schema.yml
core/modules/config/tests/config_enum_dependency_test/config/schema/config_enum_dependency_test.schema.yml
config_enum_test.schema.yml in core/modules/config/tests/config_enum_test/config/schema/config_enum_test.schema.yml
core/modules/config/tests/config_enum_test/config/schema/config_enum_test.schema.yml
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
core/config/schema/core.data_types.schema.yml
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
core/config/schema/core.data_types.schema.yml
Enum::getConstraints in core/lib/Drupal/Core/TypedData/Plugin/DataType/Enum.php
Gets a list of validation constraints.

... See full list

File

View on git.drupalcode.org

core/lib/Drupal/Core/TypedData/Plugin/DataType/Enum.php, line 16

Namespace

Drupal\Core\TypedData\Plugin\DataType
View source 
class Enum extends PrimitiveBase {
  
  /**
   * {@inheritdoc}
   */
  public function getConstraints() : array {
    $constraints = parent::getConstraints();
    $constraints[] = $this->getTypedDataManager()
      ->getValidationConstraintManager()
      ->create('Enum', []);
    return $constraints;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCastedValue() {
    return $this->getValue();
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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 2
DependencySerializationTrait::__wakeup public function 2
Enum::getCastedValue public function Gets the primitive data value casted to the correct PHP type. Overrides PrimitiveInterface::getCastedValue
Enum::getConstraints public function Gets a list of validation constraints. Overrides TypedData::getConstraints
PrimitiveBase::$value protected property The data value. 1
PrimitiveBase::getValue public function Gets the data value. Overrides TypedData::getValue 2
PrimitiveBase::setValue public function Sets the data value. Overrides TypedData::setValue 2
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language. 1
TypedData::$definition protected property The data definition. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::applyDefaultValue public function Applies the default value. Overrides TypedDataInterface::applyDefaultValue 3
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin ID of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString public function Returns a string representation of the data. Overrides TypedDataInterface::getString 6
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct public function Constructs a TypedData object given its definition and context. 4
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.