Classes, traits, and interfaces - main - drupal

Primary tabs

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
StringInterface interface Drupal\Core\TypedData\Type core/lib/Drupal/Core/TypedData/Type/StringInterface.php Interface for strings. 2 8
StringItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.php Defines the 'string' entity field type. 8 8
StringItemBase abstract class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItemBase.php Base class for string field types. 2
StringItemTest class Drupal\Tests\Core\Field core/tests/Drupal/Tests/Core/Field/StringItemTest.php Defines a test for the StringItem field-type.
StringListField class Drupal\options\Plugin\views\argument core/modules/options/src/Plugin/views/argument/StringListField.php Argument handler for list field to show the human readable name in summary.
StringLoader class Drupal\Core\Template\Loader core/lib/Drupal/Core/Template/Loader/StringLoader.php Loads string templates, also known as inline templates. 3 2
StringLongItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringLongItem.php Defines the 'string_long' field type.
StringNormalizer class Drupal\jsonapi_test_data_type\Normalizer core/modules/jsonapi/tests/modules/jsonapi_test_data_type/src/Normalizer/StringNormalizer.php Normalizes string data weirdly: replaces 'super' with 'NOT' and vice versa. 2
StringNormalizer class Drupal\jsonapi_test_field_type\Normalizer core/modules/jsonapi/tests/modules/jsonapi_test_field_type/src/Normalizer/StringNormalizer.php Normalizes string fields weirdly: replaces 'super' with 'NOT' and vice versa. 2
StringObject class Drupal\Tests\Component\Assertion core/tests/Drupal/Tests/Component/Assertion/InspectorTest.php Quick class for testing for objects with __toString.
StringStorageException class Drupal\locale core/modules/locale/src/StringStorageException.php Defines an exception thrown when storage operations fail. 1
StringStorageInterface interface Drupal\locale core/modules/locale/src/StringStorageInterface.php Defines the locale string storage interface. 1 4
StringTextareaWidget class Drupal\Core\Field\Plugin\Field\FieldWidget core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/StringTextareaWidget.php Plugin implementation of the 'string_textarea' widget. 1 1
StringTextfieldWidget class Drupal\Core\Field\Plugin\Field\FieldWidget core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/StringTextfieldWidget.php Plugin implementation of the 'string_textfield' widget. 2 2
StringTranslationTrait trait Drupal\Core\StringTranslation core/lib/Drupal/Core/StringTranslation/StringTranslationTrait.php Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface. 439
StringTranslationTraitTest class Drupal\Tests\Core\StringTranslation core/tests/Drupal/Tests/Core/StringTranslation/StringTranslationTraitTest.php Tests Drupal\Core\StringTranslation\StringTranslationTrait.
StubCondition class Drupal\Tests\Core\Database\Stub core/tests/Drupal/Tests/Core/Database/Stub/StubCondition.php A stub of core Condition class for testing purposes. 1
StubConfigEntity class Drupal\Tests\Core\Config\Entity core/tests/Drupal/Tests/Core/Config/Entity/StubConfigEntity.php A stub extending ConfigEntityBase for testing purposes. 1
StubConnection class Drupal\Tests\Core\Database\Stub core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php A stub of the abstract Connection class for testing purposes. 6
StubControllerBase class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/StubControllerBase.php Stubs ControllerBase.
StubEntityBase class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/StubEntityBase.php A stub base entity for testing purposes. 1 1
StubEntityHandlerBase class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/StubEntityHandlerBase.php A stub base entity handler for testing purposes.
StubEntityStorageBase class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/StubEntityStorageBase.php A stub base entity storage for testing purposes.
StubFallbackPluginManager class Drupal\Tests\Component\Plugin core/tests/Drupal/Tests/Component/Plugin/StubFallbackPluginManager.php Stubs \Drupal\Component\Plugin\FallbackPluginManagerInterface.
StubFieldItemBase class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/StubFieldItemBase.php A stub field item base entity for testing purposes.
StubForm class Drupal\Tests\system\Functional\Form core/modules/system/tests/src/Functional/Form/StubForm.php Provides a stub form for testing purposes.
StubFormSubmitter class Drupal\Tests\Core\Form core/tests/Drupal/Tests/Core/Form/StubFormSubmitter.php Provides a stub FormSubmitter that doesn't depend on batch_get().
StubLockBackendAbstract class Drupal\Tests\Core\Lock core/tests/Drupal/Tests/Core/Lock/StubLockBackendAbstract.php A stub of the abstract LockBackendAbstract class for testing purposes.
StubNegotiationMiddleware class Drupal\Tests\Core\StackMiddleware core/tests/Drupal/Tests/Core/StackMiddleware/NegotiationMiddlewareTest.php Stub class for testing NegotiationMiddleware.
StubPagerPluginBase class Drupal\Tests\views\Unit\Plugin\pager core/modules/views/tests/src/Unit/Plugin/pager/StubPagerPluginBase.php A stub pager plugin for testing purposes.
StubPathMatcher class Drupal\Tests\system\Kernel\Block core/modules/system/tests/src/Kernel/Block/StubPathMatcher.php A class extending PatchMatcher for testing purposes.
StubPDO class Drupal\Tests\Core\Database\Stub core/tests/Drupal/Tests/Core/Database/Stub/StubPDO.php A stub of \PDO for testing purposes. 5
StubPluginBase class Drupal\Tests\Component\Plugin core/tests/Drupal/Tests/Component/Plugin/StubPluginBase.php A class extending PluginBase for testing purposes.
StubPluginManagerBase class Drupal\Tests\Component\Plugin core/tests/Drupal/Tests/Component/Plugin/StubPluginManagerBase.php A class extending PluginManagerBase for testing purposes.
StubPluginManagerBaseWithMapper final class Drupal\Tests\Component\Plugin core/tests/Drupal/Tests/Component/Plugin/StubPluginManagerBaseWithMapper.php Stubs \Drupal\Component\Plugin\PluginManagerBase to take a MapperInterface.
StubReflectionFactory class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php Override ReflectionFactory because ::createInstance() calls a static method.
StubRequestHandlerResourcePlugin class Drupal\Tests\rest\Kernel core/modules/rest/tests/src/Kernel/RequestHandlerTest.php Stub class where we can prophesize methods.
StubRevisionableEntity class Drupal\Tests\Core\Entity core/tests/Drupal/Tests/Core/Entity/StubRevisionableEntity.php A stub revisionable entity for testing purposes. 1
StubSchema class Drupal\Tests\Core\Database\Stub core/tests/Drupal/Tests/Core/Database/Stub/StubSchema.php A stub of the abstract Schema class for testing purposes. 1 2
StubSourceGeneratorPlugin class Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/MigrateSourceTest.php Defines a stubbed source plugin with a generator as iterator.
StubSourcePlugin class Drupal\Tests\migrate\Unit core/modules/migrate/tests/src/Unit/StubSourcePlugin.php Stubbed source plugin for testing base class implementations. 1
StubSqlBase class Drupal\Tests\views\Unit\Plugin\pager core/modules/views/tests/src/Unit/Plugin/pager/StubSqlBase.php A stub pager plugin for testing purposes.
StubTestTrait trait Drupal\migrate_drupal\Tests core/modules/migrate_drupal/src/Tests/StubTestTrait.php Provides common functionality for testing stubbing. 8
StubTestTrait trait Drupal\Tests\migrate core/modules/migrate/tests/src/StubTestTrait.php Provides common functionality for testing stubbing. 1
StubThemeHandler class Drupal\Tests\Core\Extension core/tests/Drupal/Tests/Core/Extension/ThemeHandlerTest.php Extends the default theme handler to mock some drupal_ methods.
StubTrait trait Drupal\Component\Discovery core/lib/Drupal/Component/Discovery/StubTrait.php Defines an empty trait that can stand in for a missing trait.
StubUpsert class Drupal\Tests\Core\Database\Stub core/tests/Drupal/Tests/Core/Database/Stub/StubUpsert.php A stub of core Upsert for testing purposes.
StubVariableTestClass class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/VariableTest.php No-op test class for VariableTest::testExport().
StubVariantBase class Drupal\Tests\Core\Display core/tests/Drupal/Tests/Core/Display/DisplayVariantTest.php Provides a basic class extending VariantBase.
Style class Drupal\ckeditor5\Plugin\CKEditor5Plugin core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Style.php CKEditor 5 Style plugin configuration. 3 1

Other projects


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