Classes, traits, and interfaces - 8.9.x - 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 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
CacheablePreconditionFailedHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheablePreconditionFailedHttpException.php A cacheable PreconditionFailedHttpException.
CacheablePreconditionRequiredHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheablePreconditionRequiredHttpException.php A cacheable PreconditionRequiredHttpException.
CacheableRedirectResponse class Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableRedirectResponse.php A RedirectResponse that contains and can expose cacheability metadata. 2
CacheableResponse class Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableResponse.php A response that contains and can expose cacheability metadata. 1 11
CacheableResponseInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableResponseInterface.php Defines an interface for responses that can expose cacheability metadata. 8 23
CacheableResponseTrait trait Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheableResponseTrait.php Provides an implementation of CacheableResponseInterface. 6
CacheableRouteProviderInterface interface Drupal\Core\Routing core/lib/Drupal/Core/Routing/CacheableRouteProviderInterface.php Extends the router provider interface to provide caching support. 1 2
CacheableSecuredRedirectResponse abstract class Drupal\Core\Routing core/lib/Drupal/Core/Routing/CacheableSecuredRedirectResponse.php Provides a common base class for cacheable safe redirects. 2
CacheableServiceUnavailableHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableServiceUnavailableHttpException.php A cacheable ServiceUnavailableHttpException.
CacheableTestDomainObject class Drupal\early_rendering_controller_test core/modules/system/tests/modules/early_rendering_controller_test/src/CacheableTestDomainObject.php
CacheableTestResponse class Drupal\early_rendering_controller_test core/modules/system/tests/modules/early_rendering_controller_test/src/CacheableTestResponse.php
CacheableTooManyRequestsHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableTooManyRequestsHttpException.php A cacheable TooManyRequestsHttpException.
CacheableUnauthorizedHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableUnauthorizedHttpException.php A cacheable UnauthorizedHttpException. 1
CacheableUnprocessableEntityHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableUnprocessableEntityHttpException.php A cacheable UnprocessableEntityHttpException.
CacheableUnsupportedMediaTypeHttpException class Drupal\Core\Http\Exception core/lib/Drupal/Core/Http/Exception/CacheableUnsupportedMediaTypeHttpException.php A cacheable UnsupportedMediaTypeHttpException.
CacheBackendInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheBackendInterface.php Defines an interface for cache implementations. 8 115 25
CacheCollector abstract class Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheCollector.php Default implementation for CacheCollectorInterface. 7 7
CacheCollectorHelper class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/CacheCollectorHelper.php Helper class to test the cache collector. 1
CacheCollectorInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheCollectorInterface.php Provides a caching wrapper to be used in place of large structures. 2 2
CacheCollectorTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/CacheCollectorTest.php @coversDefaultClass \Drupal\Core\Cache\CacheCollector @group Cache
CacheCollectorTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/CacheCollectorTest.php Tests DatabaseBackend cache tag implementation.
CacheContextInterface interface Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/CacheContextInterface.php Provides an interface for defining a cache context service. 23 8
CacheContextOptimizationTest class Drupal\KernelTests\Core\Cache core/tests/Drupal/KernelTests/Core/Cache/CacheContextOptimizationTest.php Tests the cache context optimization.
CacheContextsManager class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/CacheContextsManager.php Converts cache context tokens into cache keys. 28 2
CacheContextsManagerTest class Drupal\Tests\Core\Cache\Context core/tests/Drupal/Tests/Core/Cache/Context/CacheContextsManagerTest.php @coversDefaultClass \Drupal\Core\Cache\Context\CacheContextsManager @group Cache
CacheContextsPass class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/CacheContextsPass.php Adds cache_contexts parameter to the container. 1
CachedDataUITest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/CachedDataUITest.php Tests the shared tempstore cache in the UI.
CachedDiscoveryClearer class Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/CachedDiscoveryClearer.php Defines a class which is capable of clearing the cache on plugin managers. 2
CachedDiscoveryClearer class Drupal\Core\ProxyClass\Plugin core/lib/Drupal/Core/ProxyClass/Plugin/CachedDiscoveryClearer.php Provides a proxy class for \Drupal\Core\Plugin\CachedDiscoveryClearer.
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. 3 6
CacheDecoratorInterface interface Drupal\Core\CacheDecorator core/lib/Drupal/Core/CacheDecorator/CacheDecoratorInterface.php Defines an interface for cache decorator implementations. 1 1
CachedStorage class Drupal\Core\Config core/lib/Drupal/Core/Config/CachedStorage.php Defines the cached storage. 2 2
CachedStorageTest class Drupal\Tests\Core\Config core/tests/Drupal/Tests/Core/Config/CachedStorageTest.php Tests the interaction of cache and file storage in CachedStorage.
CachedStorageTest class Drupal\KernelTests\Core\Config\Storage core/tests/Drupal/KernelTests/Core/Config/Storage/CachedStorageTest.php Tests CachedStorage operations.
CacheFactory class Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheFactory.php 1 2
CacheFactoryInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheFactoryInterface.php An interface defining cache factory classes. 8 3
CacheFactoryTest class Drupal\Tests\Core\Cache core/tests/Drupal/Tests/Core/Cache/CacheFactoryTest.php @coversDefaultClass \Drupal\Core\Cache\CacheFactory @group Cache
CachePluginBase abstract class Drupal\views\Plugin\views\cache core/modules/views/src/Plugin/views/cache/CachePluginBase.php The base plugin to handle caching. 3 7
CacheRouterRebuildSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/CacheRouterRebuildSubscriber.php Clear cache tags when the router is rebuilt. 2
CacheTagsChecksumInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheTagsChecksumInterface.php Provides checksums for cache tag invalidations. 1 1
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 2
CacheTagsInvalidatorInterface interface Drupal\Core\Cache core/lib/Drupal/Core/Cache/CacheTagsInvalidatorInterface.php Defines required methods for classes wanting to handle cache tag changes. 6 16
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

in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\system\Functional\Cache\CacheTestBase instead.

abstract class Drupal\system\Tests\Cache core/modules/system/src/Tests/Cache/CacheTestBase.php Provides helper methods for cache tests.
CacheTestBase abstract class Drupal\Tests\system\Functional\Cache core/modules/system/tests/src/Functional/Cache/CacheTestBase.php Provides helper methods for cache tests. 1

Other projects


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