Classes, traits, and interfaces - 9.5.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 1523

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
ProxyBuilder		class	Drupal\Component\ProxyBuilder	core/lib/Drupal/Component/ProxyBuilder/ProxyBuilder.php	Generates the string representation of the proxy service.	1	5
ProxyBuilder		class	Drupal\Core\ProxyBuilder	core/lib/Drupal/Core/ProxyBuilder/ProxyBuilder.php	Extend the component proxy builder by using the DependencySerializationTrait.		2
ProxyBuilderTest		class	Drupal\Tests\Core\ProxyBuilder	core/tests/Drupal/Tests/Core/ProxyBuilder/ProxyBuilderTest.php	@coversDefaultClass \Drupal\Core\ProxyBuilder\ProxyBuilder[[api-linebreak]] @group proxy_builder
ProxyBuilderTest		class	Drupal\Tests\Component\ProxyBuilder	core/tests/Drupal/Tests/Component/ProxyBuilder/ProxyBuilderTest.php	@coversDefaultClass \Drupal\Component\ProxyBuilder\ProxyBuilder[[api-linebreak]] @group proxy_builder
ProxyServicesPass		class	Drupal\Core\DependencyInjection\Compiler	core/lib/Drupal/Core/DependencyInjection/Compiler/ProxyServicesPass.php	Replaces all services with a lazy flag.		2
ProxyServicesPassTest		class	Drupal\Tests\Core\DependencyInjection\Compiler	core/tests/Drupal/Tests/Core/DependencyInjection/Compiler/ProxyServicesPassTest.php	@coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\ProxyServicesPass[[api-linebreak]] @group DependencyInjection
Psr7RequestValueResolver		final class	Drupal\Core\Controller\ArgumentResolver	core/lib/Drupal/Core/Controller/ArgumentResolver/Psr7RequestValueResolver.php	Yields a PSR7 request object based on the request object passed along.			2
PsrResponseSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/PsrResponseSubscriber.php	Response subscriber for handling PSR-7 responses.		1	2
PsrResponseSubscriberTest		class	Drupal\Tests\Core\EventSubscriber	core/tests/Drupal/Tests/Core/EventSubscriber/PsrResponseSubscriberTest.php	@coversDefaultClass \Drupal\Core\EventSubscriber\PsrResponseSubscriber[[api-linebreak]] @group EventSubscriber
PublicStream		class	Drupal\Core\StreamWrapper	core/lib/Drupal/Core/StreamWrapper/PublicStream.php	Defines a Drupal public (public://) stream wrapper class.	1	18	2
PublishAction		class	Drupal\Core\Action\Plugin\Action	core/lib/Drupal/Core/Action/Plugin/Action/PublishAction.php	Publishes an entity.	1	2
PublishActionTest		class	Drupal\KernelTests\Core\Action	core/tests/Drupal/KernelTests/Core/Action/PublishActionTest.php	@group Action
Query		class	Drupal\Core\Config\Entity\Query	core/lib/Drupal/Core/Config/Entity/Query/Query.php	Defines the entity query for configuration entities.
Query		abstract class	Drupal\Core\Database\Query	core/lib/Drupal/Core/Database/Query/Query.php	Base class for query builders.	7
Query		class	Drupal\Core\Entity\Query\Sql	core/lib/Drupal/Core/Entity/Query/Sql/Query.php	The SQL storage entity query class.	2	2
Query		class	Drupal\Core\Entity\Query\Null	core/lib/Drupal/Core/Entity/Query/Null/Query.php	Defines the entity query for configuration entities.
Query		class	Drupal\Core\Entity\KeyValueStore\Query	core/lib/Drupal/Core/Entity/KeyValueStore/Query/Query.php	Defines the entity query for entities stored in a key value backend.
Query		class	Drupal\workspaces\EntityQuery	core/modules/workspaces/src/EntityQuery/Query.php	Alters entity queries to use a workspace revision instead of the default one.
QueryAggregate		class	Drupal\workspaces\EntityQuery	core/modules/workspaces/src/EntityQuery/QueryAggregate.php	Alters aggregate entity queries to use a workspace revision if possible.
QueryAggregate		class	Drupal\Core\Entity\Query\Sql	core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php	The SQL storage entity query aggregate class.	1	1
QueryAggregateInterface		interface	Drupal\Core\Entity\Query	core/lib/Drupal/Core/Entity/Query/QueryAggregateInterface.php	Defines an interface for aggregated entity queries.	2	3
QueryArgsCacheContext		class	Drupal\Core\Cache\Context	core/lib/Drupal/Core/Cache/Context/QueryArgsCacheContext.php	Defines the QueryArgsCacheContext service, for "per query args" caching.		1	2
QueryArgsCacheContextTest		class	Drupal\Tests\Core\Cache\Context	core/tests/Drupal/Tests/Core/Cache/Context/QueryArgsCacheContextTest.php	@coversDefaultClass \Drupal\Core\Cache\Context\QueryArgsCacheContext[[api-linebreak]] @group Cache
QueryBase		abstract class	Drupal\Core\Entity\Query	core/lib/Drupal/Core/Entity/Query/QueryBase.php	The base entity query class.	4	10
QueryBatchTest		class	Drupal\Tests\migrate\Kernel	core/modules/migrate/tests/src/Kernel/QueryBatchTest.php	Tests query batching.
QueryBatchTest		class	Drupal\migrate_query_batch_test\Plugin\migrate\source	core/modules/migrate/tests/modules/migrate_query_batch_test/src/Plugin/migrate/source/QueryBatchTest.php	Source plugin for migration high water tests.
QueryConditionTrait		trait	Drupal\Core\Database\Query	core/lib/Drupal/Core/Database/Query/QueryConditionTrait.php	Provides an implementation of ConditionInterface.
QueryException		class	Drupal\Core\Entity\Query	core/lib/Drupal/Core/Entity/Query/QueryException.php	Exception thrown by Query() on unsupported query syntax.		6
QueryFactory		class	Drupal\Core\Config\Entity\Query	core/lib/Drupal/Core/Config/Entity/Query/QueryFactory.php	Provides a factory for creating entity query objects for the config backend.		2	2
QueryFactory		class	Drupal\Core\Entity\Query\Sql	core/lib/Drupal/Core/Entity/Query/Sql/QueryFactory.php	Factory class creating entity query objects for the SQL backend.	2	2	2
QueryFactory		class	Drupal\Core\Entity\Query\Sql\pgsql	core/lib/Drupal/Core/Entity/Query/Sql/pgsql/QueryFactory.php	PostgreSQL specific entity query implementation.	1	1	2
QueryFactory		class	Drupal\Core\Entity\Query\Null	core/lib/Drupal/Core/Entity/Query/Null/QueryFactory.php	Provides a factory for creating entity query objects for the null backend.			2
QueryFactory		class	Drupal\Core\Entity\KeyValueStore\Query	core/lib/Drupal/Core/Entity/KeyValueStore/Query/QueryFactory.php	Provides a factory for creating the key value entity query.			2
QueryFactory		class	Drupal\workspaces\EntityQuery	core/modules/workspaces/src/EntityQuery/QueryFactory.php	Workspaces-specific entity query implementation.			2
QueryFactoryInterface		interface	Drupal\Core\Entity\Query	core/lib/Drupal/Core/Entity/Query/QueryFactoryInterface.php	Defines an interface for QueryFactory classes.	4	6
QueryFactoryTest		class	Drupal\Tests\Core\Config\Entity\Query	core/tests/Drupal/Tests/Core/Config/Entity/Query/QueryFactoryTest.php	@coversDefaultClass \Drupal\Core\Config\Entity\Query\QueryFactory[[api-linebreak]] @group Config
QueryGroupByTest		class	Drupal\Tests\views\Kernel	core/modules/views/tests/src/Kernel/QueryGroupByTest.php	Tests aggregate functionality of views, for example count.
QueryInterface		interface	Drupal\Core\Entity\Query	core/lib/Drupal/Core/Entity/Query/QueryInterface.php	Interface for entity queries.	5	13
QueryOptionsTest		class	Drupal\Tests\views\Functional\Plugin	core/modules/views/tests/src/Functional/Plugin/QueryOptionsTest.php	Tests setting the query options.
QueryParameter		class	Drupal\views\Plugin\views\argument_default	core/modules/views/src/Plugin/views/argument_default/QueryParameter.php	A query parameter argument default handler.		1
QueryParameterTest		class	Drupal\Tests\views\Unit\Plugin\argument_default	core/modules/views/tests/src/Unit/Plugin/argument_default/QueryParameterTest.php	@coversDefaultClass \Drupal\views\Plugin\views\argument_default\QueryParameter[[api-linebreak]] @group views
QueryParameterWorkspaceNegotiator		class	Drupal\workspaces\Negotiator	core/modules/workspaces/src/Negotiator/QueryParameterWorkspaceNegotiator.php	Defines the query parameter workspace negotiator.			2
QueryPluginBase		abstract class	Drupal\views\Plugin\views\query	core/modules/views/src/Plugin/views/query/QueryPluginBase.php	Base plugin class for Views queries.	2	12
QueryTest		class	Drupal\Tests\views\Kernel\Plugin	core/modules/views/tests/src/Kernel/Plugin/QueryTest.php	Tests query plugins.
QueryTest		class	Drupal\Tests\Core\Entity\Query\Sql	core/tests/Drupal/Tests/Core/Entity/Query/Sql/QueryTest.php	@coversDefaultClass \Drupal\Core\Entity\Query\Sql\Query[[api-linebreak]] @group Entity
QueryTest		class	Drupal\KernelTests\Core\Database	core/tests/Drupal/KernelTests/Core/Database/QueryTest.php	Tests Drupal's extended prepared statement syntax..
QueryTest		class	Drupal\Tests\views_ui\Functional	core/modules/views_ui/tests/src/Functional/QueryTest.php	Tests query plugins.
QueryTest		class	Drupal\views_test_data\Plugin\views\query	core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php	Defines a query test plugin.		1
QueryTrait		trait	Drupal\workspaces\EntityQuery	core/modules/workspaces/src/EntityQuery/QueryTrait.php	Provides workspaces-specific helpers for altering entity queries.
QueueDatabaseFactory		class	Drupal\Core\Queue	core/lib/Drupal/Core/Queue/QueueDatabaseFactory.php	Defines the key/value store factory for the database backend.			2

Other projects

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