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
OutboundPathProcessorInterface interface Drupal\Core\PathProcessor core/lib/Drupal/Core/PathProcessor/OutboundPathProcessorInterface.php Defines an interface for classes that process the outbound path. 8 11
OutboundRouteProcessorInterface interface Drupal\Core\RouteProcessor core/lib/Drupal/Core/RouteProcessor/OutboundRouteProcessorInterface.php Defines an interface for classes that process the outbound route. 3 2
OutputStrategyInterface interface Drupal\Component\Render core/lib/Drupal/Component/Render/OutputStrategyInterface.php Provides an output strategy that formats HTML strings for a given context. 1
OverlapWithTopLevelDependenciesTest class Drupal\Tests\Composer\Generator core/tests/Drupal/Tests/Composer/Generator/OverlapWithTopLevelDependenciesTest.php Tests DrupalCoreRecommendedBuilder.
OverriddenConfigImportTest class Drupal\Tests\language\Kernel core/modules/language/tests/src/Kernel/OverriddenConfigImportTest.php Tests importing of config with language overrides.
OverriddenConfigurationTest class Drupal\Tests\settings_tray\FunctionalJavascript core/modules/settings_tray/tests/src/FunctionalJavascript/OverriddenConfigurationTest.php Tests handling of configuration overrides.
OverrideDisplaysTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/OverrideDisplaysTest.php Tests that displays can be correctly overridden via the user interface.
OverrideMenuLinks final class Drupal\Core\Menu\Plugin\ConfigAction core/lib/Drupal/Core/Menu/Plugin/ConfigAction/OverrideMenuLinks.php Overrides static menu links defined in code. 1
OverrideMenuLinksConfigActionTest final class Drupal\KernelTests\Core\Menu core/tests/Drupal/KernelTests/Core/Menu/OverrideMenuLinksConfigActionTest.php Tests overriding static menu links with config actions.
OverrideSectionsTest class Drupal\Tests\layout_builder\Functional\Rest core/modules/layout_builder/tests/src/Functional/Rest/OverrideSectionsTest.php Tests that override layout sections are not exposed via the REST API.
OverridesEntityForm class Drupal\layout_builder\Form core/modules/layout_builder/src/Form/OverridesEntityForm.php Provides a form containing the Layout Builder UI for overrides. 1
OverridesSectionStorage class Drupal\layout_builder\Plugin\SectionStorage core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php Defines the 'overrides' section storage type. 16
OverridesSectionStorageInterface interface Drupal\layout_builder core/modules/layout_builder/src/OverridesSectionStorageInterface.php Defines an interface for an object that stores layout sections for overrides. 1 7
OverridesSectionStorageTest class Drupal\Tests\layout_builder\Unit core/modules/layout_builder/tests/src/Unit/OverridesSectionStorageTest.php Tests Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage.
OverridesSectionStorageTest class Drupal\Tests\layout_builder\Kernel core/modules/layout_builder/tests/src/Kernel/OverridesSectionStorageTest.php Tests Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage.
OverviewForm class Drupal\migrate_drupal_ui\Form core/modules/migrate_drupal_ui/src/Form/OverviewForm.php Migrate Upgrade Overview form. 1
OverviewTerms class Drupal\taxonomy\Form core/modules/taxonomy/src/Form/OverviewTerms.php Provides terms overview form for a taxonomy vocabulary. 1 2
OverviewTermsOverride class Drupal\taxonomy_overview_override_test\Form core/modules/taxonomy/tests/modules/taxonomy_overview_override_test/src/Form/OverviewTermsOverride.php Provides an overview form to test overriding it via hook_entity_type_alter. 1
OverwriteExistingPackagesValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/OverwriteExistingPackagesValidator.php Validates that newly installed packages don't overwrite existing directories. 1
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. 50 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\views\Plugin\views\display core/modules/views/src/Plugin/views/display/Page.php The plugin that handles a full page. 4
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.
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.

Other projects


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