Classes, traits, and interfaces - main - drupal

Introduction to classes

A lot of the PHP code in Drupal is object oriented (OO), making use of PHP classes, interfaces, and traits. See the Objected-oriented programming conventions for more information.

See also

Objected-oriented programming conventions

File

core/core.api.php, line 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
UuidConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/UuidConstraint.php Validates a UUID.
UuidFormatterTest class Drupal\Tests\field\Kernel\KernelString core/modules/field/tests/src/Kernel/KernelString/UuidFormatterTest.php Tests the output of a UUID field.
UuidInterface interface Drupal\Component\Uuid core/lib/Drupal/Component/Uuid/UuidInterface.php Interface for generating UUIDs. 3 27
UuidItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/UuidItem.php Defines the 'uuid' entity field type.
UuidItemTest class Drupal\Tests\field\Kernel\KernelString core/modules/field/tests/src/Kernel/KernelString/UuidItemTest.php Tests the UUID field.
UuidReferenceInterface interface Drupal\serialization\EntityResolver core/modules/serialization/src/EntityResolver/UuidReferenceInterface.php Interface for extracting UUID from entity reference data when denormalizing.
UuidResolver class Drupal\serialization\EntityResolver core/modules/serialization/src/EntityResolver/UuidResolver.php Resolves entities from data that contains an entity UUID. 1 2
UuidResolverTest class Drupal\Tests\serialization\Unit\EntityResolver core/modules/serialization/tests/src/Unit/EntityResolver/UuidResolverTest.php Tests Drupal\serialization\EntityResolver\UuidResolver.
UuidTest class Drupal\Tests\Component\Uuid core/tests/Drupal/Tests/Component/Uuid/UuidTest.php Tests the handling of Universally Unique Identifiers (UUIDs).
UuidValidatorTest class Drupal\KernelTests\Core\Validation core/tests/Drupal/KernelTests/Core/Validation/UuidValidatorTest.php Tests the UUID validator.
ValidateHostnameTest class Drupal\Tests\Core\DrupalKernel core/tests/Drupal/Tests/Core/DrupalKernel/ValidateHostnameTest.php Tests Drupal\Core\DrupalKernel.
ValidateMigrationStateTest class Drupal\Tests\migrate_drupal\Kernel\d6 core/modules/migrate_drupal/tests/src/Kernel/d6/ValidateMigrationStateTest.php Tests the migration state information in module.migrate_drupal.yml.
ValidateMigrationStateTest class Drupal\Tests\migrate_drupal\Kernel\d7 core/modules/migrate_drupal/tests/src/Kernel/d7/ValidateMigrationStateTest.php Tests the migration state information in module.migrate_drupal.yml.
ValidateMigrationStateTestTrait trait Drupal\Tests\migrate_drupal\Traits core/modules/migrate_drupal/tests/src/Traits/ValidateMigrationStateTestTrait.php Tests the migration state information in module.migrate_drupal.yml. 2
ValidationErrorBlock class Drupal\settings_tray_test\Plugin\Block core/modules/settings_tray/tests/modules/settings_tray_test/src/Plugin/Block/ValidationErrorBlock.php Provides a 'Block with validation error' test block.
ValidationResult final class Drupal\package_manager core/modules/package_manager/src/ValidationResult.php A value object to contain the results of a validation. 31
ValidationResultTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/ValidationResultTest.php Tests Drupal\package_manager\ValidationResult.
ValidationTest class Drupal\Tests\system\FunctionalJavascript\Form core/modules/system/tests/src/FunctionalJavascript/Form/ValidationTest.php Tests form validation handlers and messages.
ValidationTest class Drupal\Tests\system\Functional\Form core/modules/system/tests/src/Functional/Form/ValidationTest.php Tests form processing and alteration via form validation handlers.
ValidationTestTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/ValidationTestTrait.php Contains helpful methods for testing stage validators. 2
ValidatorsTest class Drupal\Tests\ckeditor5\Kernel core/modules/ckeditor5/tests/src/Kernel/ValidatorsTest.php Tests Validators.
ValidConsumer class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/TaggedHandlersPassTest.php Test class of a valid consumer.
ValidConsumerWithExtraArguments class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/TaggedHandlersPassTest.php Test class of a valid consumer with extra arguments.
ValidHandler class Drupal\Tests\Core\DependencyInjection\Compiler core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/TaggedHandlersPassTest.php Test handler class with interface implemented.
ValidKeysConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ValidKeysConstraint.php Checks that all the keys of a mapping are valid and required keys present. 1
ValidKeysConstraintValidator class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ValidKeysConstraintValidator.php Validates the ValidKeys constraint. 1
ValidKeysConstraintValidatorTest class Drupal\KernelTests\Core\TypedData core/tests/Drupal/KernelTests/Core/TypedData/ValidKeysConstraintValidatorTest.php Tests the ValidKeys validation constraint.
ValidPathConstraint class Drupal\Core\Path\Plugin\Validation\Constraint core/lib/Drupal/Core/Path/Plugin/Validation/Constraint/ValidPathConstraint.php Validation constraint for valid system paths.
ValidPathConstraintValidator class Drupal\Core\Path\Plugin\Validation\Constraint core/lib/Drupal/Core/Path/Plugin/Validation/Constraint/ValidPathConstraintValidator.php Constraint validator for validating system paths.
ValidReferenceConstraint class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/ValidReferenceConstraint.php Entity Reference valid reference constraint.
ValidReferenceConstraintValidator class Drupal\Core\Entity\Plugin\Validation\Constraint core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/ValidReferenceConstraintValidator.php Checks if referenced entities are valid.
ValidReferenceConstraintValidatorTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/ValidReferenceConstraintValidatorTest.php Tests validation constraints for ValidReferenceConstraintValidator.
ValidSequenceKeysConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ValidSequenceKeysConstraint.php Checks that all the keys of a sequence match the specified constraints. 1
ValidSequenceKeysConstraintValidator class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/ValidSequenceKeysConstraintValidator.php Validates that all the keys of a sequence match the specified constraints. 1
ValidSequenceKeysValidatorTest class Drupal\KernelTests\Core\Validation core/tests/Drupal/KernelTests/Core/Validation/ValidSequenceKeysValidatorTest.php Tests ValidSequenceKeys validation constraint with both valid and invalid values.
Value class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Value.php Provides a form element for storage of internal information.
Variable class Drupal\Component\Utility core/lib/Drupal/Component/Utility/Variable.php Provides helpers for dealing with variables. 10
Variable class Drupal\migrate_drupal\Plugin\migrate\source core/modules/migrate_drupal/src/Plugin/migrate/source/Variable.php Drupal 6/7 variable source from database. 4 5
VariableMultiRow class Drupal\migrate_drupal\Plugin\migrate\source core/modules/migrate_drupal/src/Plugin/migrate/source/VariableMultiRow.php Drupal 6/7 multiple variables source from database. 1 2
VariableMultiRowTest class Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/VariableMultiRowTest.php Tests the variable multirow source plugin.
VariableTest class Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/VariableTest.php Tests the variable source plugin.
VariableTest class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/VariableTest.php Test variable export functionality in Variable component.
VariableTestMock class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/VariableTest.php A class for testing Variable::callableToString().
VariableTranslation class Drupal\migrate_drupal\Plugin\migrate\source\d6 core/modules/migrate_drupal/src/Plugin/migrate/source/d6/VariableTranslation.php Drupal 6 i18n_variable source from database. 1
VariableTranslation class Drupal\migrate_drupal\Plugin\migrate\source\d7 core/modules/migrate_drupal/src/Plugin/migrate/source/d7/VariableTranslation.php Drupal 7 variable_store source from database. 1
VariableTranslationCheckRequirementsTest class Drupal\Tests\migrate_drupal\Kernel\d6 core/modules/migrate_drupal/tests/src/Kernel/d6/VariableTranslationCheckRequirementsTest.php Tests check requirements for variable translation source plugin.
VariableTranslationTest class Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\d6 core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/d6/VariableTranslationTest.php Tests the variable source plugin.
VariableTranslationTest class Drupal\Tests\migrate_drupal\Kernel\Plugin\migrate\source\d7 core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/d7/VariableTranslationTest.php Tests the variable source plugin.
VariantBase abstract class Drupal\Core\Display core/lib/Drupal/Core/Display/VariantBase.php Provides a base class for DisplayVariant plugins. 4 4
VariantInterface interface Drupal\Core\Display core/lib/Drupal/Core/Display/VariantInterface.php Provides an interface for DisplayVariant plugins. 3

Other projects

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