Classes, traits, and interfaces - main - 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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
InvokableUntrustedObject class Drupal\Tests\Core\Security core/tests/Drupal/Tests/Core/Security/DoTrustedCallbackTraitTest.php Invokable untrusted test class.
InvokeCommand class Drupal\Core\Ajax core/lib/Drupal/Core/Ajax/InvokeCommand.php AJAX command for invoking an arbitrary jQuery method. 6
IpCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/IpCacheContext.php Defines the IpCacheContext service, for "per IP address" caching. 2
IsFrontPathCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php Defines a cache context for whether the URL is the front page of the site. 1 2
IsFrontPathCacheContextTest class Drupal\Tests\Core\Cache\Context core/tests/Drupal/Tests/Core/Cache/Context/IsFrontPathCacheContextTest.php Tests Drupal\Core\Cache\Context\IsFrontPathCacheContext.
IsNullConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/IsNullConstraint.php Null constraint.
IsNullConstraintValidator class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/IsNullConstraintValidator.php Null constraint validator.
IsSuperUserCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php Defines the IsSuperUserCacheContext service, for "super user or not" caching. 2
Item class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Item.php Provides a display-only form element with an optional title and description.
ItemLayoutFieldBlockTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/ItemLayoutFieldBlockTest.php Field blocks tests for the override layout.
ItemList class Drupal\Core\TypedData\Plugin\DataType core/lib/Drupal/Core/TypedData/Plugin/DataType/ItemList.php A generic list class. 1 3
ItemsPerPageTest class Drupal\Tests\views\Functional\Wizard core/modules/views/tests/src/Functional/Wizard/ItemsPerPageTest.php Tests that the views wizard can specify the number of items per page.
JavascriptDeprecationTest class Drupal\FunctionalJavascriptTests core/tests/Drupal/FunctionalJavascriptTests/JavascriptDeprecationTest.php Tests Javascript deprecation notices.
JavascriptErrorsSuppressionTest class Drupal\FunctionalJavascriptTests core/tests/Drupal/FunctionalJavascriptTests/JavascriptErrorsSuppressionTest.php Tests that Drupal.throwError can be suppressed to allow a test to pass.
JavascriptErrorsTest class Drupal\FunctionalJavascriptTests core/tests/Drupal/FunctionalJavascriptTests/JavascriptErrorsTest.php Tests that Drupal.throwError will cause a test failure.
JavascriptGetDrupalSettingsTest class Drupal\FunctionalJavascriptTests core/tests/Drupal/FunctionalJavascriptTests/JavascriptGetDrupalSettingsTest.php Tests Drupal settings retrieval in WebDriverTestBase tests.
JavascriptStatesForm class Drupal\form_test\Form core/modules/system/tests/modules/form_test/src/Form/JavascriptStatesForm.php Builds a simple form to test states. 1
JavascriptStatesTest class Drupal\FunctionalJavascriptTests\Core\Form core/tests/Drupal/FunctionalJavascriptTests/Core/Form/JavascriptStatesTest.php Tests the state of elements based on another elements.
JoinPluginBase class Drupal\views\Plugin\views\join core/modules/views/src/Plugin/views/join/JoinPluginBase.php Represents a join and creates the SQL necessary to implement the join. 5 4
JoinPluginInterface interface Drupal\views\Plugin\views\join core/modules/views/src/Plugin/views/join/JoinPluginInterface.php Represents a join and creates the SQL necessary to implement the join. 1 2
JoinTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/JoinTest.php Tests the join plugin.
JoinTest class Drupal\views_test_data\Plugin\views\join core/modules/views/tests/modules/views_test_data/src/Plugin/views/join/JoinTest.php Defines a join test plugin. 2
JqueryUiLibraryAssetsTest class Drupal\FunctionalTests\Libraries core/tests/Drupal/FunctionalTests/Libraries/JqueryUiLibraryAssetsTest.php Tests the loading of jQuery UI CSS and JS assets.
JqueryUiTestAssetsController class Drupal\jqueryui_library_assets_test\Controller core/modules/system/tests/modules/jqueryui_library_assets_test/src/Controller/JqueryUiTestAssetsController.php Controller for testing jQuery UI asset loading order.
JsAssetController class Drupal\system\Controller core/modules/system/src/Controller/JsAssetController.php Defines a controller to serve Javascript aggregates.
JsCollectionGrouper class Drupal\Core\Asset core/lib/Drupal/Core/Asset/JsCollectionGrouper.php Groups JavaScript assets. 1 2
JsCollectionOptimizerLazy class Drupal\Core\Asset core/lib/Drupal/Core/Asset/JsCollectionOptimizerLazy.php Optimizes JavaScript assets. 2
JsCollectionRenderer class Drupal\Core\Asset core/lib/Drupal/Core/Asset/JsCollectionRenderer.php Renders JavaScript assets. 2
JsDeprecationTestController class Drupal\js_deprecation_test\Controller core/modules/system/tests/modules/js_deprecation_test/src/Controller/JsDeprecationTestController.php Test Controller to show message links.
JsDeprecationTestHooks class Drupal\js_deprecation_test\Hook core/modules/system/tests/modules/js_deprecation_test/src/Hook/JsDeprecationTestHooks.php Hook implementations for js_deprecation_test.
JsDisplaceThemeHooks class Drupal\js_displace\Hook core/modules/system/tests/modules/js_displace/src/Hook/JsDisplaceThemeHooks.php Theme hook implementations for js_displace module.
JsErrorsTestController class Drupal\js_errors_test\Controller core/modules/system/tests/modules/js_errors_test/src/Controller/JsErrorsTestController.php Test Controller loading js_errors_test/errors_test library.
JSInteractionTest class Drupal\FunctionalJavascriptTests\Tests core/tests/Drupal/FunctionalJavascriptTests/Tests/JSInteractionTest.php Tests fault tolerant interactions.
JSInteractionTestForm class Drupal\js_interaction_test\Controller core/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php Controller for testing fault tolerant JavaScript interactions. 1
JsMessageTest class Drupal\FunctionalJavascriptTests\Core core/tests/Drupal/FunctionalJavascriptTests/Core/JsMessageTest.php Tests core/drupal.message library. 1 1
JSMessageTestController class Drupal\js_message_test\Controller core/modules/system/tests/modules/js_message_test/src/Controller/JSMessageTestController.php Test Controller to show message links. 2
Json class Drupal\Component\Serialization core/lib/Drupal/Component/Serialization/Json.php Default serialization for JSON. 113 3
JsonApiDocumentTopLevel class Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/JsonApiDocumentTopLevel.php Represents a JSON:API document's "top level". 9
JsonApiDocumentTopLevelNormalizer class Drupal\jsonapi\Normalizer core/modules/jsonapi/src/Normalizer/JsonApiDocumentTopLevelNormalizer.php Normalizes the top-level document according to the JSON:API specification. 2 2
JsonApiDocumentTopLevelNormalizerTest class Drupal\Tests\jsonapi\Unit\Normalizer core/modules/jsonapi/tests/src/Unit/Normalizer/JsonApiDocumentTopLevelNormalizerTest.php Tests Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer.
JsonApiFilter final class Drupal\jsonapi core/modules/jsonapi/src/JsonApiFilter.php JsonApi filter options. 4
JsonApiFilterRegressionTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFilterRegressionTest.php JSON:API regression tests.
JsonApiFunctionalDateFieldTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalDateFieldTest.php JSON:API integration test for the "Date" field.
JsonApiFunctionalMultilingualTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalMultilingualTest.php Tests JSON:API multilingual support.
JsonApiFunctionalTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTest.php General functional test class.
JsonApiFunctionalTestBase abstract class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/JsonApiFunctionalTestBase.php Provides helper methods for the JSON:API module's functional tests. 7
JsonapiHooks class Drupal\jsonapi\Hook core/modules/jsonapi/src/Hook/JsonapiHooks.php Hook implementations for jsonapi.
JsonApiJsonSchemaTestTrait trait Drupal\Tests\jsonapi\Traits core/modules/jsonapi/tests/src/Traits/JsonApiJsonSchemaTestTrait.php Support methods for testing JSON API schema. 1
JsonapiKernelTestBase abstract class Drupal\Tests\jsonapi\Kernel core/modules/jsonapi/tests/src/Kernel/JsonapiKernelTestBase.php Contains shared test utility methods. 11 11
JsonapiMaintenanceModeSubscriber class Drupal\jsonapi\EventSubscriber core/modules/jsonapi/src/EventSubscriber/JsonapiMaintenanceModeSubscriber.php Maintenance mode subscriber for JSON:API requests. 2

Other projects

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