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
OverwriteExistingPackagesValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/OverwriteExistingPackagesValidatorTest.php Tests Overwrite Existing Packages Validator.
PackageGenerator class Drupal\Composer\Generator composer/Generator/PackageGenerator.php Generates metapackages. 2
PackageInstallDirectWriteTest class Drupal\Tests\package_manager\Build core/modules/package_manager/tests/src/Build/PackageInstallDirectWriteTest.php Tests installing packages with direct write mode enabled.
PackageInstallSubmoduleTest class Drupal\Tests\package_manager\Build core/modules/package_manager/tests/src/Build/PackageInstallSubmoduleTest.php Tests installing packages in a stage directory.
PackageInstallTest class Drupal\Tests\package_manager\Build core/modules/package_manager/tests/src/Build/PackageInstallTest.php Tests installing packages in a stage directory.
PackageManagerBypassServiceProvider final class Drupal\package_manager_bypass core/modules/package_manager/tests/modules/package_manager_bypass/src/PackageManagerBypassServiceProvider.php Defines services to bypass Package Manager's core functionality.
PackageManagerBypassTestTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/PackageManagerBypassTestTrait.php Common functions for testing using the package_manager_bypass module.
PackageManagerFixtureCreator final class core/scripts/PackageManagerFixtureCreator.php Creates fixture at 'core/modules/package_manager/tests/fixtures/fake_site'.
PackageManagerHooks class Drupal\package_manager\Hook core/modules/package_manager/src/Hook/PackageManagerHooks.php Hook implementations for package_manager.
PackageManagerKernelTestBase abstract class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/PackageManagerKernelTestBase.php Base class for kernel tests of Package Manager's functionality. 47 8
PackageManagerRequirements class Drupal\package_manager\Install\Requirements core/modules/package_manager/src/Install/Requirements/PackageManagerRequirements.php Install time requirements for the package_manager module.
PackageManagerRequirementsHooks class Drupal\package_manager\Hook core/modules/package_manager/src/Hook/PackageManagerRequirementsHooks.php Requirements checks for Package Manager.
PackageManagerTestBase abstract class Drupal\Tests\package_manager\Functional core/modules/package_manager/tests/src/Functional/PackageManagerTestBase.php Base class for Package Manager Functional tests. 2
PackageManagerTestValidationServiceProvider class Drupal\package_manager_test_validation core/modules/package_manager/tests/modules/package_manager_test_validation/src/PackageManagerTestValidationServiceProvider.php Modifies container services for testing.
PackageManagerUninstallValidator final class Drupal\package_manager core/modules/package_manager/src/PackageManagerUninstallValidator.php Prevents any module from being uninstalled if update is in process. 3
PackageManagerUpdateProcessor final class Drupal\package_manager core/modules/package_manager/src/PackageManagerUpdateProcessor.php Extends the Update Status update processor allow fetching any project.
PackageUpdateTest class Drupal\Tests\package_manager\Build core/modules/package_manager/tests/src/Build/PackageUpdateTest.php Tests updating packages in a stage directory.
Page class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Page.php Provides a render element for the content of an HTML page.
Page class Drupal\views\Plugin\views\display core/modules/views/src/Plugin/views/display/Page.php The plugin that handles a full page. 4
PageActions final class Drupal\navigation\Plugin\TopBarItem core/modules/navigation/src/Plugin/TopBarItem/PageActions.php Provides the Page Actions basic top bar item.
PageAttachmentsHook final class Drupal\system\Hook core/modules/system/src/Hook/PageAttachmentsHook.php Implements hook_page_attachments() for the system module.
PageCache class Drupal\page_cache\StackMiddleware core/modules/page_cache/src/StackMiddleware/PageCache.php Executes the page caching before the main kernel takes over the request. 1 2
PageCacheAcceptHeaderController class Drupal\system_test\Controller core/modules/system/tests/modules/system_test/src/Controller/PageCacheAcceptHeaderController.php Defines a controller to respond the page cache accept header test.
PageCacheHooks class Drupal\page_cache\Hook core/modules/page_cache/src/Hook/PageCacheHooks.php Hook implementations for page_cache.
PageCacheLegacyTest class Drupal\Tests\page_cache\Unit core/modules/page_cache/tests/src/Unit/PageCacheLegacyTest.php Tests \Drupal\page_cache\StackMiddleware\PageCache.
PageCachePolicyTrait trait Drupal\Tests\Traits\Core\Cache core/tests/Drupal/Tests/Traits/Core/Cache/PageCachePolicyTrait.php Trait for using page caching modules in Kernel tests. 2
PageCacheTagsIntegrationTest class Drupal\Tests\page_cache\Functional core/modules/page_cache/tests/src/Functional/PageCacheTagsIntegrationTest.php Enables the page cache and tests its cache tags in various scenarios.
PageCacheTagsTestBase abstract class Drupal\Tests\system\Functional\Cache core/modules/system/tests/src/Functional/Cache/PageCacheTagsTestBase.php Provides helper methods for page cache tags tests. 7 7
PageCacheTest class Drupal\Tests\page_cache\Functional core/modules/page_cache/tests/src/Functional/PageCacheTest.php Enables the page cache and tests it with various HTTP requests.
PageContext class Drupal\navigation\Plugin\TopBarItem core/modules/navigation/src/Plugin/TopBarItem/PageContext.php Provides the Page Context top bar item. 1
PageContextTest class Drupal\Tests\navigation\Unit core/modules/navigation/tests/src/Unit/PageContextTest.php Tests the PageContext Top Bar item build output.
PageDisplayVariant class Drupal\Core\Display\Attribute core/lib/Drupal/Core/Display/Attribute/PageDisplayVariant.php Defines a page display variant attribute object. 2
PageDisplayVariant class Drupal\Core\Display\Annotation core/lib/Drupal/Core/Display/Annotation/PageDisplayVariant.php Defines a page display variant annotation object.
PageDisplayVariantSelectionEvent class Drupal\Core\Render core/lib/Drupal/Core/Render/PageDisplayVariantSelectionEvent.php Event fired when rendering main content, to select a page display variant. 5
PageEditTest class Drupal\Tests\block_content\Functional core/modules/block_content/tests/src/Functional/PageEditTest.php Create a block and test block edit functionality.
PageNotFoundTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/PageNotFoundTest.php Tests page not found functionality, including custom 404 pages.
PagePreviewTest class Drupal\Tests\node\Functional core/modules/node/tests/src/Functional/PagePreviewTest.php Tests the node entity preview functionality.
Pager class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Pager.php Provides a render element for a pager.
Pager class Drupal\Core\Pager core/lib/Drupal/Core/Pager/Pager.php A value object that represents a pager. 1
PageRenderTest class Drupal\Tests\system\Kernel\Common core/modules/system/tests/src/Kernel/Common/PageRenderTest.php Test page rendering hooks.
PagerKernelTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/PagerKernelTest.php Tests pager-related APIs.
PagerManager class Drupal\Core\Pager core/lib/Drupal/Core/Pager/PagerManager.php Provides a manager for pagers. 2 2
PagerManagerInterface interface Drupal\Core\Pager core/lib/Drupal/Core/Pager/PagerManagerInterface.php This is a service for pager information. 1 6
PagerManagerTest class Drupal\KernelTests\Core\Pager core/tests/Drupal/KernelTests/Core/Pager/PagerManagerTest.php Tests Drupal\Core\Pager\PagerManager.
PagerModalTest class Drupal\Tests\system\FunctionalJavascript\Pager core/modules/system/tests/src/FunctionalJavascript/Pager/PagerModalTest.php Tests pager functionality in a modal.
PagerParameters class Drupal\Core\Pager core/lib/Drupal/Core/Pager/PagerParameters.php Provides pager information contained within the current request. 1 2
PagerParametersInterface interface Drupal\Core\Pager core/lib/Drupal/Core/Pager/PagerParametersInterface.php Interface describing pager information contained within the request. 1 5
PagerPluginBase abstract class Drupal\views\Plugin\views\pager core/modules/views/src/Plugin/views/pager/PagerPluginBase.php Base class for views pager plugins. 4 5 1
PagerPluginBaseTest class Drupal\Tests\views\Unit\Plugin\pager core/modules/views/tests/src/Unit/Plugin/pager/PagerPluginBaseTest.php Tests Drupal\views\Plugin\views\pager\PagerPluginBase.
PagerPreprocess class Drupal\Core\Pager core/lib/Drupal/Core/Pager/PagerPreprocess.php Pager theme preprocess. 2 2

Other projects


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