Classes, traits, and interfaces - 11.x - 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 1518

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
CachedDiscoveryClearerInterface		interface	Drupal\Core\Plugin	core/lib/Drupal/Core/Plugin/CachedDiscoveryClearerInterface.php	Provides a way to clear static caches of all plugin managers.	2
CachedDiscoveryInterface		interface	Drupal\Component\Plugin\Discovery	core/lib/Drupal/Component/Plugin/Discovery/CachedDiscoveryInterface.php	Interface for discovery components holding a cache of plugin definitions.	4	6
CacheDecoratorInterface	in drupal:10.2.0 and is removed from drupal:11.0.0. There is no replacement.	interface	Drupal\Core\CacheDecorator	core/lib/Drupal/Core/CacheDecorator/CacheDecoratorInterface.php	Defines an interface for cache decorator implementations.
CachedStorage		class	Drupal\Core\Config	core/lib/Drupal/Core/Config/CachedStorage.php	Defines the cached storage.		2
CachedStorageTest		class	Drupal\KernelTests\Core\Config\Storage	core/tests/Drupal/KernelTests/Core/Config/Storage/CachedStorageTest.php	Tests CachedStorage operations.
CachedStorageTest		class	Drupal\Tests\Core\Config	core/tests/Drupal/Tests/Core/Config/CachedStorageTest.php	Tests the interaction of cache and file storage in CachedStorage.
CacheFactory		class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheFactory.php			2
CacheFactoryDecorator		class	Drupal\performance_test\Cache	core/modules/system/tests/modules/performance_test/src/Cache/CacheFactoryDecorator.php	Decorates a cache factory to register all calls to the cache system.			2
CacheFactoryInterface		interface	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheFactoryInterface.php	An interface defining cache factory classes.	11	4
CacheFactoryTest		class	Drupal\Tests\Core\Cache	core/tests/Drupal/Tests/Core/Cache/CacheFactoryTest.php	@coversDefaultClass \Drupal\Core\Cache\CacheFactory @group Cache
CacheItem		class	Drupal\Tests\Core\Session	core/tests/Drupal/Tests/Core/Session/AccessPolicyProcessorTest.php
CachePluginBase		abstract class	Drupal\views\Plugin\views\cache	core/modules/views/src/Plugin/views/cache/CachePluginBase.php	The base plugin to handle caching.	3	10
CacheRedirect		class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheRedirect.php	Defines a value object to represent a cache redirect.		3
CacheRouterRebuildSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/CacheRouterRebuildSubscriber.php	Clear cache tags when the router is rebuilt.
CacheTagsChecksumDecorator		class	Drupal\performance_test\Cache	core/modules/system/tests/modules/performance_test/src/Cache/CacheTagsChecksumDecorator.php	Wraps an existing cache tags checksum invalidator to track calls separately.			2
CacheTagsChecksumInterface		interface	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheTagsChecksumInterface.php	Provides checksums for cache tag invalidations.	2	2
CacheTagsChecksumTrait		trait	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheTagsChecksumTrait.php	A trait for cache tag checksum implementations.
CacheTagsInvalidator		class	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheTagsInvalidator.php	Passes cache tag events to classes that wish to respond to them.		1
CacheTagsInvalidatorInterface		interface	Drupal\Core\Cache	core/lib/Drupal/Core/Cache/CacheTagsInvalidatorInterface.php	Defines required methods for classes wanting to handle cache tag changes.	10	19
CacheTagsInvalidatorTest		class	Drupal\Tests\Core\Cache	core/tests/Drupal/Tests/Core/Cache/CacheTagsInvalidatorTest.php	@coversDefaultClass \Drupal\Core\Cache\CacheTagsInvalidator @group Cache
CacheTagTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/CacheTagTest.php	Tests tag cache plugin.
CacheTest		class	Drupal\Tests\views\Kernel\Plugin	core/modules/views/tests/src/Kernel/Plugin/CacheTest.php	Tests pluggable caching for views.
CacheTest		class	Drupal\Tests\Core\Cache	core/tests/Drupal/Tests/Core/Cache/CacheTest.php	@coversDefaultClass \Drupal\Core\Cache\Cache @group Cache
CacheTestBase		abstract class	Drupal\Tests\system\Functional\Cache	core/modules/system/tests/src/Functional/Cache/CacheTestBase.php	Provides helper methods for cache tests.	1
CacheTestController		class	Drupal\cache_test\Controller	core/modules/system/tests/modules/cache_test/src/Controller/CacheTestController.php	Controller routines for cache_test routes.
CacheWebTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/CacheWebTest.php	Tests pluggable caching for views via a web test.
CalculatedCacheContextInterface		interface	Drupal\Core\Cache\Context	core/lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php	Provides an interface for defining a calculated cache context service.	10	3
CalculatedPermissions		class	Drupal\Core\Session	core/lib/Drupal/Core/Session/CalculatedPermissions.php	Represents a calculated set of permissions with cacheable metadata.		4
CalculatedPermissionsInterface		interface	Drupal\Core\Session	core/lib/Drupal/Core/Session/CalculatedPermissionsInterface.php	Defines the calculated permissions interface.	2	1
CalculatedPermissionsItem		class	Drupal\Core\Session	core/lib/Drupal/Core/Session/CalculatedPermissionsItem.php	Represents a single entry for the calculated permissions.		9
CalculatedPermissionsItemInterface		interface	Drupal\Core\Session	core/lib/Drupal/Core/Session/CalculatedPermissionsItemInterface.php	Defines the calculated permissions item interface.	1
CalculatedPermissionsItemTest		class	Drupal\Tests\Core\Session	core/tests/Drupal/Tests/Core/Session/CalculatedPermissionsItemTest.php	Tests the CalculatedPermissionsItem value object.
CalculatedPermissionsTest		class	Drupal\Tests\Core\Session	core/tests/Drupal/Tests/Core/Session/CalculatedPermissionsTest.php	Tests the CalculatedPermissions value object.
CalculatedPermissionsTrait		trait	Drupal\Core\Session	core/lib/Drupal/Core/Session/CalculatedPermissionsTrait.php	Trait for \Drupal\Core\Session\CalculatedPermissionsInterface.
CallableClass		class	Drupal\Tests\Component\EventDispatcher	core/tests/Drupal/Tests/Component/EventDispatcher/ContainerAwareEventDispatcherTest.php
CallableResolver		class	Drupal\Core\Utility	core/lib/Drupal/Core/Utility/CallableResolver.php	Resolves PHP callables.		12
CallableResolverTest		class	Drupal\Tests\Core\Utility	core/tests/Drupal/Tests/Core/Utility/CallableResolverTest.php	@coversDefaultClass \Drupal\Core\Utility\CallableResolver @group Utility
Callback		class	Drupal\migrate\Plugin\migrate\process	core/modules/migrate/src/Plugin/migrate/process/Callback.php	Passes the source value to a callback.		1
Callbacks		class	Drupal\ajax_forms_test	core/modules/system/tests/modules/ajax_forms_test/src/Callbacks.php	Simple object for testing methods as Ajax callbacks.		3
Callbacks		class	Drupal\form_test	core/modules/system/tests/modules/form_test/src/Callbacks.php	Simple class for testing methods as Form API callbacks.		1
CallbackTest		class	Drupal\Tests\migrate\Unit\process	core/modules/migrate/tests/src/Unit/process/CallbackTest.php	Tests the callback process plugin.
CallsDestructableServiceController		final class	Drupal\destructable_test\Controller	core/modules/system/tests/modules/destructable_test/src/Controller/CallsDestructableServiceController.php	Controller to instantiate the destructable service.
CancelUser		class	Drupal\user\Plugin\Action	core/modules/user/src/Plugin/Action/CancelUser.php	Cancels a user account.
CaseInsensitivePathTest		class	Drupal\FunctionalTests\Routing	core/tests/Drupal/FunctionalTests/Routing/CaseInsensitivePathTest.php	Tests incoming path case insensitivity.
CaseSensitivityTest		class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/CaseSensitivityTest.php	Tests handling case sensitive collation.
CastedIntFieldJoin		class	Drupal\views\Plugin\views\join	core/modules/views/src/Plugin/views/join/CastedIntFieldJoin.php	Implementation for the "casted_int_field_join" join.		1
CastedIntFieldJoinTestBase		abstract class	Drupal\Tests\views\Kernel\Plugin	core/modules/views/tests/src/Kernel/Plugin/CastedIntFieldJoinTestBase.php	Tests the "casted_int_field_join" join plugin.	3	3
CastSql		class	Drupal\views\Plugin\views\query	core/modules/views/src/Plugin/views/query/CastSql.php	Cast handling in SQL.			2
CastSqlInterface		interface	Drupal\views\Plugin\views\query	core/modules/views/src/Plugin/views/query/CastSqlInterface.php	Defines an interface for defining cast expressions in SQL.	2	1
CategorizingPluginManager		class	Drupal\Tests\Core\Plugin	core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php	Class that allows testing the trait.

Other projects

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