Classes, traits, and interfaces - Drupal 11.1.x - Drupal Core

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
LocaleOptionsInterface interface PhpTuf\ComposerStager\API\Translation\Service vendor/php-tuf/composer-stager/src/API/Translation/Service/LocaleOptionsInterface.php Provides locale values for the translation system. 1 2
LocaleProjectStorage class Drupal\locale core/modules/locale/src/LocaleProjectStorage.php Provides the locale project storage system using a key value store. 2
LocaleProjectStorageInterface interface Drupal\locale core/modules/locale/src/LocaleProjectStorageInterface.php Defines the locale project storage interface. 1
LocaleSettingsForm class Drupal\locale\Form core/modules/locale/src/Form/LocaleSettingsForm.php Configure locale settings for this site. 1
LocaleTranslation class Drupal\locale\Plugin\QueueWorker core/modules/locale/src/Plugin/QueueWorker/LocaleTranslation.php Executes interface translation queue tasks.
LocaleTranslation class Drupal\locale core/modules/locale/src/LocaleTranslation.php String translator using the locale module. 2
LocaleTranslationCacheTag class Drupal\locale\EventSubscriber core/modules/locale/src/EventSubscriber/LocaleTranslationCacheTag.php A subscriber invalidating cache tags when translating a string. 2
LocaleValidator class Symfony\Component\Validator\Constraints vendor/symfony/validator/Constraints/LocaleValidator.php Validates whether a value is a valid locale code.
LocalFile class PHP_CodeSniffer\Files vendor/squizlabs/php_codesniffer/src/Files/LocalFile.php 1
LocalizedRouteTrait trait Symfony\Component\Routing\Loader\Configurator\Traits vendor/symfony/routing/Loader/Configurator/Traits/LocalizedRouteTrait.php @internal 2
LocalOrReservedDomain class Egulias\EmailValidator\Result\Reason vendor/egulias/email-validator/src/Result/Reason/LocalOrReservedDomain.php 1
LocalPart class Egulias\EmailValidator\Parser vendor/egulias/email-validator/src/Parser/LocalPart.php 1 1
LocalReadOnlyStream abstract class Drupal\Core\StreamWrapper core/lib/Drupal/Core/StreamWrapper/LocalReadOnlyStream.php Defines a read-only Drupal stream wrapper base class for local files.
LocalRedirectResponse class Drupal\Core\Routing core/lib/Drupal/Core/Routing/LocalRedirectResponse.php Provides a redirect response which cannot redirect to an external URL. 3
LocalRepoTransaction class Composer\DependencyResolver vendor/composer/composer/src/Composer/DependencyResolver/LocalRepoTransaction.php @author Nils Adermann <naderman@naderman.de> @internal 1
LocalRootSpan class OpenTelemetry\API\Trace vendor/open-telemetry/api/Trace/LocalRootSpan.php @experimental
LocalStream abstract class Drupal\Core\StreamWrapper core/lib/Drupal/Core/StreamWrapper/LocalStream.php Defines a Drupal stream wrapper base class for local files. 5 4
LocalTaskDefault class Drupal\Core\Menu core/lib/Drupal/Core/Menu/LocalTaskDefault.php Default object used for LocalTaskPlugins. 2 2 4
LocalTaskInterface interface Drupal\Core\Menu core/lib/Drupal/Core/Menu/LocalTaskInterface.php Defines an interface for menu local tasks. 1
LocalTaskManager class Drupal\Core\Menu core/lib/Drupal/Core/Menu/LocalTaskManager.php Provides the default local task manager using YML as primary definition.
LocalTaskManagerInterface interface Drupal\Core\Menu core/lib/Drupal/Core/Menu/LocalTaskManagerInterface.php Manages discovery and instantiation of menu local task plugins. 1 2
LocalTasksBlock class Drupal\Core\Menu\Plugin\Block core/lib/Drupal/Core/Menu/Plugin/Block/LocalTasksBlock.php Provides a "Tabs" block to display the local tasks.
LocalTooLong class Egulias\EmailValidator\Warning vendor/egulias/email-validator/src/Warning/LocalTooLong.php 1
LocalVariable final class Twig\Node\Expression\Variable vendor/twig/twig/src/Node/Expression/Variable/LocalVariable.php 4
Location final class phpDocumentor\Reflection vendor/phpdocumentor/reflection-common/src/Location.php The location where an element occurs within a file.
Location class Google\Protobuf\Internal\SourceCodeInfo vendor/google/protobuf/src/Google/Protobuf/Internal/SourceCodeInfo/Location.php Generated from protobuf message <code>google.protobuf.SourceCodeInfo.Location</code>
LocatorStrategy final class WebDriver vendor/lullabot/php-webdriver/lib/WebDriver/LocatorStrategy.php WebDriver\LocatorStrategy class
Lock final class Symfony\Component\Lock vendor/symfony/lock/Lock.php Lock is the default implementation of the LockInterface. 1
Lock final class Drupal\Core\TempStore core/lib/Drupal/Core/TempStore/Lock.php Provides a value object representing the lock from a TempStore. 1
LockableTrait trait Symfony\Component\Console\Command vendor/symfony/console/Command/LockableTrait.php Basic lock feature for commands.
LockAcquiringException class Drupal\Core\Lock core/lib/Drupal/Core/Lock/LockAcquiringException.php LockAcquiringException is thrown when a lock cannot be acquired. 4
LockAcquiringException class Symfony\Component\Lock\Exception vendor/symfony/lock/Exception/LockAcquiringException.php LockAcquiringException is thrown when an issue happens during the acquisition of a lock. 7
LockArrayRepository class Composer\Repository vendor/composer/composer/src/Composer/Repository/LockArrayRepository.php Lock array repository. 4
LockBackendAbstract abstract class Drupal\Core\Lock core/lib/Drupal/Core/Lock/LockBackendAbstract.php Non backend related common methods implementation for lock backends. 1
LockBackendInterface interface Drupal\Core\Lock core/lib/Drupal/Core/Lock/LockBackendInterface.php Lock backend interface. 4 27
LockConflictedException class Symfony\Component\Lock\Exception vendor/symfony/lock/Exception/LockConflictedException.php LockConflictedException is thrown when a lock is acquired by someone else. 19
LockedHttpException class Symfony\Component\HttpKernel\Exception vendor/symfony/http-kernel/Exception/LockedHttpException.php @author Peter Dietrich <xosofox@gmail.com>
Locker class Composer\Package vendor/composer/composer/src/Composer/Package/Locker.php Reads/writes project lockfile (composer.lock). 8
LockExpiredException class Symfony\Component\Lock\Exception vendor/symfony/lock/Exception/LockExpiredException.php LockExpiredException is thrown when a lock may conflict due to a TTL expiration. 3
LockFactory class Symfony\Component\Lock vendor/symfony/lock/LockFactory.php Factory provides method to create locks. 1
LockFileValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/LockFileValidator.php Checks that the active lock file is unchanged during stage operations.
LockInterface interface Symfony\Component\Lock vendor/symfony/lock/LockInterface.php LockInterface defines an interface to manipulate the status of a lock. 1 1
LockReleasingException class Symfony\Component\Lock\Exception vendor/symfony/lock/Exception/LockReleasingException.php LockReleasingException is thrown when an issue happens during the release of a lock. 4
LockStorageException class Symfony\Component\Lock\Exception vendor/symfony/lock/Exception/LockStorageException.php LockStorageException is thrown when an issue happens during the manipulation of a lock in a store. 3
LockTransaction class Composer\DependencyResolver vendor/composer/composer/src/Composer/DependencyResolver/LockTransaction.php @author Nils Adermann <naderman@naderman.de> @internal 1
Log class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/Log.php Logs values without changing them.
Log class Drupal\Core\Database core/lib/Drupal/Core/Database/Log.php Database query logger.
Log class WebDriver vendor/lullabot/php-webdriver/lib/WebDriver/Log.php WebDriver\Log class
Logger class Symfony\Component\HttpKernel\Log vendor/symfony/http-kernel/Log/Logger.php Minimalist PSR-3 logger designed to write in stderr or any other stream. 1
Logger class OpenTelemetry\SDK\Logs vendor/open-telemetry/sdk/Logs/Logger.php Note that this logger class is deliberately NOT psr-3 compatible, per spec: "Note: this document defines a log backend API. The API is not intended to be called by application developers directly."