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
InstallConfiguratorTest class Drupal\KernelTests\Core\Recipe core/tests/Drupal/KernelTests/Core/Recipe/InstallConfiguratorTest.php Tests Install Configurator.
InstalledPackage final class Drupal\package_manager core/modules/package_manager/src/InstalledPackage.php A value object that represents an installed Composer package. 5
InstalledPackagesList final class Drupal\package_manager core/modules/package_manager/src/InstalledPackagesList.php Defines a class to list installed Composer packages. 6
InstalledPackagesListTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/InstalledPackagesListTest.php Tests Drupal\package_manager\InstalledPackagesList.
InstalledPackagesListTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/InstalledPackagesListTest.php Tests Drupal\package_manager\InstalledPackagesList.
InstalledPackagesListTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/InstalledPackagesListTrait.php A trait for comparing InstalledPackagesList objects. 2
InstalledPackageTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/InstalledPackageTest.php Tests Drupal\package_manager\InstalledPackage.
InstallerAccessPolicy final class Drupal\Core\Installer core/lib/Drupal/Core/Installer/InstallerAccessPolicy.php Grants user 1 an all access pass during install.
InstallerBrokenDatabaseCredentialsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerBrokenDatabaseCredentialsTest.php Tests the installer with incorrect connection info in settings.php.
InstallerBrokenDatabasePortSettingsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerBrokenDatabasePortSettingsTest.php Tests the installer with incorrect connection info in settings.php.
InstallerConfigDirectorySetNoDirectoryErrorTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerConfigDirectorySetNoDirectoryErrorTest.php Tests installation when a config_sync_directory is set up but does not exist.
InstallerConfigDirectorySetNoDirectoryTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerConfigDirectorySetNoDirectoryTest.php Tests the installer when a custom config directory set up but does not exist.
InstallerConfigDirectoryTestBase abstract class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerConfigDirectoryTestBase.php Provides a base class for testing installing from existing configuration. 8
InstallerDatabaseErrorMessagesTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerDatabaseErrorMessagesTest.php Tests the installer with database errors.
InstallerDependenciesResolutionTest class Drupal\Tests\system\Kernel\Installer core/modules/system/tests/src/Kernel/Installer/InstallerDependenciesResolutionTest.php Tests that we handle module dependency resolution during install.
InstallerEmptySettingsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerEmptySettingsTest.php Tests the installer with empty settings file.
InstallerException class Drupal\Core\Installer\Exception core/lib/Drupal/Core/Installer/Exception/InstallerException.php Base class for exceptions thrown by installer. 2 1
InstallerExistingBrokenDatabaseSettingsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingBrokenDatabaseSettingsTest.php Tests the installer with broken database connection info in settings.php.
InstallerExistingConfigDirectoryTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigDirectoryTest.php Tests installation when a config_sync_directory exists and is set up.
InstallerExistingConfigExistingSettingsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigExistingSettingsTest.php Verifies that installing from existing configuration works.
InstallerExistingConfigMultilingualTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigMultilingualTest.php Verifies that installing from existing configuration works.
InstallerExistingConfigNoConfigTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigNoConfigTest.php Verifies that profiles invalid config can not be installed.
InstallerExistingConfigNoProfileTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigNoProfileTest.php Verifies that installing from existing configuration without a profile works.
InstallerExistingConfigNoSystemSiteTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigNoSystemSiteTest.php Testing installing from config without system.site.
InstallerExistingConfigProfileHookInstallTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigProfileHookInstallTest.php Verifies that profiles with hook_install() can't be installed from config.
InstallerExistingConfigSyncDirectoryMultilingualTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryMultilingualTest.php Verifies that installing from existing configuration works.
InstallerExistingConfigSyncDirectoryProfileHookInstallTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryProfileHookInstallTest.php Verifies that profiles with hook_install() can't be installed from config.
InstallerExistingConfigSyncDirectoryProfileMismatchTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigSyncDirectoryProfileMismatchTest.php Verifies that installing from existing configuration works.
InstallerExistingConfigTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigTest.php Verifies that installing from existing configuration works. 2
InstallerExistingConfigTestBase

in drupal:10.4.0 and is removed from drupal:12.0.0. Use \Drupal\FunctionalTests\Installer\InstallerConfigDirectoryTestBase instead.

abstract class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingConfigTestBase.php Provides a base class for testing installing from existing configuration.
InstallerExistingDatabaseSettingsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingDatabaseSettingsTest.php Tests installation with database information in an existing settings file.
InstallerExistingInstallationTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingInstallationTest.php Tests the installer with an existing Drupal installation.
InstallerExistingSettingsNoProfileTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingSettingsNoProfileTest.php Tests the installer with an existing settings file but no install profile.
InstallerExistingSettingsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerExistingSettingsTest.php Tests the installer with an existing settings file. 1 1
InstallerExtensionListDeprecationTest class Drupal\Tests\Core\Installer core/tests/Drupal/Tests/Core/Installer/InstallerExtensionListDeprecationTest.php Tests deprecations for installer extension list compatibility layers.
InstallerIsolationLevelExistingSettingsTest class Drupal\Tests\mysql\Functional core/modules/mysql/tests/src/Functional/InstallerIsolationLevelExistingSettingsTest.php Tests the isolation_level setting with existing database settings.
InstallerIsolationLevelNoDatabaseSettingsTest class Drupal\Tests\mysql\Functional core/modules/mysql/tests/src/Functional/InstallerIsolationLevelNoDatabaseSettingsTest.php Tests the isolation_level setting with no database settings.
InstallerKernel class Drupal\Core\Installer core/lib/Drupal/Core/Installer/InstallerKernel.php Extend DrupalKernel to handle force some kernel behaviors. 20
InstallerLanguageDirectionTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerLanguageDirectionTest.php Verifies that the early installer uses the correct language direction.
InstallerLanguagePageTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerLanguagePageTest.php Verifies that the installer language list uses local and remote languages.
InstallerLanguageTest class Drupal\KernelTests\Core\Installer core/tests/Drupal/KernelTests/Core/Installer/InstallerLanguageTest.php Tests for installer language support.
InstallerLanguageTrait trait Drupal\Tests\Traits\Core\Locale core/tests/Drupal/Tests/Traits/Core/Locale/InstallerLanguageTrait.php A trait to install Drupal in a specific language. 4
InstallerModuleExtensionList

in drupal:11.5.0 and is removed from drupal:13.0.0. Use \Drupal\Core\Extension\ModuleExtensionList instead.

class Drupal\Core\Installer core/lib/Drupal/Core/Installer/InstallerModuleExtensionList.php Backward-compatibility wrapper for the installer module extension list.
InstallerNonDefaultDatabaseDriverTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerNonDefaultDatabaseDriverTest.php Tests the interactive installer.
InstallerNonEnglishProfileWithoutLocaleModuleTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerNonEnglishProfileWithoutLocaleModuleTest.php Tests installing a profile with non-English language and no locale module.
InstallerPerformanceTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerPerformanceTest.php Tests the interactive installer.
InstallerPostInstallTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerPostInstallTest.php Tests re-visiting the installer after a successful installation.
InstallerProfileRequirementsTest class Drupal\FunctionalTests\Installer core/tests/Drupal/FunctionalTests/Installer/InstallerProfileRequirementsTest.php Tests that an install profile can implement hook_requirements().
InstallerRedirectTrait trait Drupal\Core\Installer core/lib/Drupal/Core/Installer/InstallerRedirectTrait.php Provides methods for checking if Drupal is already installed. 4
InstallerRedirectTraitMockableClass class Drupal\KernelTests\Core\Installer core/tests/Drupal/KernelTests/Core/Installer/InstallerRedirectTraitMockableClass.php A class using the InstallerRedirectTrait for mocking purposes.

Other projects


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