Classes, traits, and interfaces - 9.5.x - 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 1523

Name	Deprecated	Object type	Namespace	File name	Summary	Direct uses	Use statements	Strings
FileSaveDataTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileSaveDataTest.php	Tests the file_unmanaged_save_data() function.	1
FileSaveHtaccessLoggingTest		class	Drupal\Tests\system\Functional\File	core/modules/system/tests/src/Functional/File/FileSaveHtaccessLoggingTest.php	Tests the log message added by file_save_htaccess().
FileSecurity		class	Drupal\Component\FileSecurity	core/lib/Drupal/Component/FileSecurity/FileSecurity.php	Provides file security functions.		9
FileSecurity		class	Drupal\Composer\Plugin\VendorHardening	composer/Plugin/VendorHardening/FileSecurity.php	Provides file security functions.
FileSecurityTest		class	Drupal\Tests\Component\FileSecurity	core/tests/Drupal/Tests/Component/FileSecurity/FileSecurityTest.php	Tests the file security component.
FileSelection		class	Drupal\file\Plugin\EntityReferenceSelection	core/modules/file/src/Plugin/EntityReferenceSelection/FileSelection.php	Provides specific access control for the file entity type.
FileServiceProvider		class	Drupal\file	core/modules/file/src/FileServiceProvider.php	Adds 'application/octet-stream' as a known (bin) format.
FileSize		class	Drupal\file\Plugin\Field\FieldFormatter	core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php	Formatter that shows the file size in a human readable way.
FileSize		class	Drupal\views\Plugin\views\field	core/modules/views/src/Plugin/views/field/FileSize.php	Render a numeric value as a size.
FileStorage		class	Drupal\file	core/modules/file/src/FileStorage.php	File storage for files.
FileStorage		class	Drupal\Component\PhpStorage	core/lib/Drupal/Component/PhpStorage/FileStorage.php	Stores the code as regular PHP files.	1	2
FileStorage		class	Drupal\Core\Config	core/lib/Drupal/Core/Config/FileStorage.php	Defines the file storage.	1	17	2
FileStorageFactory		class	Drupal\Core\Config	core/lib/Drupal/Core/Config/FileStorageFactory.php	Provides a factory for creating config file storage objects.		1
FileStorageFactoryTest		class	Drupal\KernelTests\Core\Config	core/tests/Drupal/KernelTests/Core/Config/FileStorageFactoryTest.php	@coversDefaultClass \Drupal\Core\Config\FileStorageFactory @group config
FileStorageInterface		interface	Drupal\file	core/modules/file/src/FileStorageInterface.php	Defines an interface for file entity storage classes.	1
FileStorageReadOnlyTest		class	Drupal\Tests\Component\PhpStorage	core/tests/Drupal/Tests/Component/PhpStorage/FileStorageReadOnlyTest.php	@coversDefaultClass \Drupal\Component\PhpStorage\FileReadOnlyStorage
FileStorageSchema		class	Drupal\file	core/modules/file/src/FileStorageSchema.php	Defines the file schema handler.
FileStorageTest		class	Drupal\Tests\Component\PhpStorage	core/tests/Drupal/Tests/Component/PhpStorage/FileStorageTest.php	@coversDefaultClass \Drupal\Component\PhpStorage\FileStorage @group Drupal @group PhpStorage
FileStorageTest		class	Drupal\KernelTests\Core\Config\Storage	core/tests/Drupal/KernelTests/Core/Config/Storage/FileStorageTest.php	Tests FileStorage operations.
FileSystem		class	Drupal\Core\File	core/lib/Drupal/Core/File/FileSystem.php	Provides helpers to operate on files and stream wrappers.		5	2
FileSystem		class	Drupal\Component\FileSystem	core/lib/Drupal/Component/FileSystem/FileSystem.php	Provides file system functions.		7
FileSystemDeprecationTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileSystemDeprecationTest.php	Tests deprecations in file.inc.
FileSystemForm		class	Drupal\system\Form	core/modules/system/src/Form/FileSystemForm.php	Configure file system settings for this site.			1
FileSystemInterface		interface	Drupal\Core\File	core/lib/Drupal/Core/File/FileSystemInterface.php	Provides an interface for helpers that operate on files and stream wrappers.	1	87
FilesystemLoader		class	Drupal\Core\Template\Loader	core/lib/Drupal/Core/Template/Loader/FilesystemLoader.php	Loads templates from the filesystem.			2
FileSystemModuleDiscoveryDataProviderTrait		trait	Drupal\KernelTests	core/tests/Drupal/KernelTests/FileSystemModuleDiscoveryDataProviderTrait.php	A trait used in testing for providing a list of modules in a dataProvider.		12
FileSystemRequirementsTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileSystemRequirementsTest.php	@group File
FileSystemTempDirectoryTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileSystemTempDirectoryTest.php	Tests for getTempDirectory on FileSystem.
FileSystemTest		class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileSystemTest.php	@coversDefaultClass \Drupal\Core\File\FileSystem @group File
FileSystemTest		class	Drupal\Tests\Core\File	core/tests/Drupal/Tests/Core/File/FileSystemTest.php	@coversDefaultClass \Drupal\Core\File\FileSystem
FileTest		class	Drupal\Tests\file\Kernel\Plugin\migrate\source\d6	core/modules/file/tests/src/Kernel/Plugin/migrate/source/d6/FileTest.php	Tests D6 file source plugin.
FileTest		class	Drupal\Tests\file\Kernel\Plugin\migrate\source\d7	core/modules/file/tests/src/Kernel/Plugin/migrate/source/d7/FileTest.php	Tests D7 file source plugin.
FileTest		class	Drupal\Tests\jsonapi\Functional	core/modules/jsonapi/tests/src/Functional/FileTest.php	JSON:API integration test for the "File" content entity type.
FileTestAccessControlHandler		class	Drupal\file_test	core/modules/file/tests/file_test/src/FileTestAccessControlHandler.php	Defines a class for an alternate file access control handler.
FileTestBase		abstract class	Drupal\KernelTests\Core\File	core/tests/Drupal/KernelTests/Core/File/FileTestBase.php	Provides file-specific assertions and helper functions.	14	2
FileTestForm		class	Drupal\file_test\Form	core/modules/file/tests/file_test/src/Form/FileTestForm.php	File test form class.	1		1
FileTestSaveUploadFromForm		class	Drupal\file_test\Form	core/modules/file/tests/file_test/src/Form/FileTestSaveUploadFromForm.php	File test form class.			1
FileTokenReplaceTest		class	Drupal\Tests\file\Functional	core/modules/file/tests/src/Functional/FileTokenReplaceTest.php	Tests file token replacement.
FileTransfer		abstract class	Drupal\Core\FileTransfer	core/lib/Drupal/Core/FileTransfer/FileTransfer.php	Defines the base FileTransfer class.	4	2
FileTransferAuthorizeForm		class	Drupal\Core\FileTransfer\Form	core/lib/Drupal/Core/FileTransfer/Form/FileTransferAuthorizeForm.php	Provides the file transfer authorization form.
FileTransferAuthorizeFormTest		class	Drupal\Tests\update\Functional	core/modules/update/tests/src/Functional/FileTransferAuthorizeFormTest.php	Tests the Update Manager module upload via authorize.php functionality.
FileTransferException		class	Drupal\Core\FileTransfer	core/lib/Drupal/Core/FileTransfer/FileTransferException.php	Exception thrown for file transfer errors.		2
FileTransferTest		class	Drupal\Tests\system\Functional\FileTransfer	core/modules/system/tests/src/Functional/FileTransfer/FileTransferTest.php	Tests recursive file copy operations with the file transfer jail.
FileTranslation		class	Drupal\Core\StringTranslation\Translator	core/lib/Drupal/Core/StringTranslation/Translator/FileTranslation.php	File based string translation.		3
FileUpload		class	Drupal\jsonapi\Controller	core/modules/jsonapi/src/Controller/FileUpload.php	Handles file upload requests.			2
FileUploadForm		class	Drupal\media_library\Form	core/modules/media_library/src/Form/FileUploadForm.php	Creates a form to create media entities from uploaded files.		2
FileUploadHalJsonBasicAuthTest		class	Drupal\Tests\hal\Functional\file	core/modules/hal/tests/src/Functional/file/FileUploadHalJsonBasicAuthTest.php	@group hal @group legacy
FileUploadHalJsonCookieTest		class	Drupal\Tests\hal\Functional\file	core/modules/hal/tests/src/Functional/file/FileUploadHalJsonCookieTest.php	@group hal @group legacy
FileUploadHalJsonTestBase		abstract class	Drupal\Tests\hal\Functional\file	core/modules/hal/tests/src/Functional/file/FileUploadHalJsonTestBase.php	Tests binary data file upload route for HAL JSON.	2
FileUploadHandler		class	Drupal\file\Upload	core/modules/file/src/Upload/FileUploadHandler.php	Handles validating and creating file entities from file uploads.			2

Other projects

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