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
Query class Drupal\Core\Config\Entity\Query core/lib/Drupal/Core/Config/Entity/Query/Query.php Defines the entity query for configuration entities.
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 Tests Drupal\Core\Cache\Context\QueryArgsCacheContext.
QueryBase abstract class Drupal\Core\Entity\Query core/lib/Drupal/Core/Entity/Query/QueryBase.php The base entity query class. 4 9
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. 8
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\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\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\pgsql\EntityQuery core/modules/pgsql/src/EntityQuery/QueryFactory.php PostgreSQL specific entity query implementation. 2
QueryFactory class Drupal\workspaces\EntityQuery core/modules/workspaces/src/EntityQuery/QueryFactory.php Workspaces-specific entity query implementation. 1 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 Tests Drupal\Core\Config\Entity\Query\QueryFactory.
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 19
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 Tests Drupal\views\Plugin\views\argument_default\QueryParameter.
QueryParameterWorkspaceNegotiator class Drupal\workspaces\Negotiator core/modules/workspaces/src/Negotiator/QueryParameterWorkspaceNegotiator.php Defines the query parameter workspace negotiator. 2 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 14
QueryTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/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
QueryTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/QueryTest.php Tests query plugins.
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\Core\Entity\Query\Sql core/tests/Drupal/Tests/Core/Entity/Query/Sql/QueryTest.php Tests Drupal\Core\Entity\Query\Sql\Query.
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 queue factory for the database backend. 2
QueueExceptionsTest class Drupal\Tests\Core\Queue core/tests/Drupal/Tests/Core/Queue/QueueExceptionsTest.php Tests queue exceptions.
QueueFactory class Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueFactory.php Defines the queue factory. 9 2
QueueFactoryInterface interface Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueFactoryInterface.php An interface defining queue factory classes. 1 1
QueueGarbageCollectionInterface interface Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueGarbageCollectionInterface.php Queue garbage collection interface. 1 1
QueueInterface interface Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueInterface.php Interface for a queue. 3 4
QueueSerializationTest class Drupal\KernelTests\Core\Queue core/tests/Drupal/KernelTests/Core/Queue/QueueSerializationTest.php Tests serializing a form with an injected DatabaseQueue instance.
QueueTest class Drupal\KernelTests\Core\Queue core/tests/Drupal/KernelTests/Core/Queue/QueueTest.php Queues and unqueues a set of items to check the basic queue functionality.
QueueWorker class Drupal\Core\Annotation core/lib/Drupal/Core/Annotation/QueueWorker.php Declare a worker class for processing a queue item.
QueueWorker class Drupal\Core\Queue\Attribute core/lib/Drupal/Core/Queue/Attribute/QueueWorker.php Declare a worker class for processing a queue item. 11
QueueWorkerBase abstract class Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueWorkerBase.php Provides a base implementation for a QueueWorker plugin. 10 10
QueueWorkerInterface interface Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueWorkerInterface.php Defines an interface for a QueueWorker plugin. 1 2
QueueWorkerManager class Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueWorkerManager.php Defines the queue worker manager. 2
QueueWorkerManagerInterface interface Drupal\Core\Queue core/lib/Drupal/Core/Queue/QueueWorkerManagerInterface.php Provides an interface for a queue worker manager. 1 3
QuickStartCommand class Drupal\Core\Command core/lib/Drupal/Core/Command/QuickStartCommand.php Installs a Drupal site and starts a webserver for local testing/development.
QuickStartTest class Drupal\BuildTests\QuickStart core/tests/Drupal/BuildTests/QuickStart/QuickStartTest.php Tests the quick-start commands.
QuickStartTestBase abstract class Drupal\BuildTests\QuickStart core/tests/Drupal/BuildTests/QuickStart/QuickStartTestBase.php Helper methods for using the quickstart feature of Drupal. 3 3

Other projects


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