Classes, traits, and interfaces - 8.9.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 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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\Component\FileSystem core/lib/Drupal/Component/FileSystem/FileSystem.php Provides file system functions. 9
FileSystem class Drupal\Core\File core/lib/Drupal/Core/File/FileSystem.php Provides helpers to operate on files and stream wrappers. 6 2
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 78
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. 11
FileSystemRequirementsTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileSystemRequirementsTest.php @group File @group legacy
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 Base class for file tests that adds some additional 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
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 Generates text using placeholders for dummy content to check 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 FileTransferException class. 3
FileTransferTest class Drupal\Tests\system\Functional\FileTransfer core/modules/system/tests/src/Functional/FileTransfer/FileTransferTest.php Tests that the jail is respected and that protocols using recursive file move operations work.
FileTranslation class Drupal\Core\StringTranslation\Translator core/lib/Drupal/Core/StringTranslation/Translator/FileTranslation.php File based string translation. 3
FileUpdateTest class Drupal\Tests\file\Functional\Update core/modules/file/tests/src/Functional/Update/FileUpdateTest.php Tests File update path.
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\file\Functional\Hal core/modules/file/tests/src/Functional/Hal/FileUploadHalJsonBasicAuthTest.php @group hal
FileUploadHalJsonCookieTest class Drupal\Tests\file\Functional\Hal core/modules/file/tests/src/Functional/Hal/FileUploadHalJsonCookieTest.php @group hal
FileUploadHalJsonTestBase abstract class Drupal\Tests\file\Functional\Hal core/modules/file/tests/src/Functional/Hal/FileUploadHalJsonTestBase.php Tests binary data file upload route for HAL JSON. 3 1
FileUploadHalJsonTestBase

in drupal:8.6.0 and is removed from drupal:9.0.0. Use Drupal\Tests\file\Functional\Hal\FileUploadHalJsonTestBase instead.

 abstract class Drupal\Tests\hal\Functional\EntityResource\File core/modules/hal/tests/src/Functional/EntityResource/File/FileUploadHalJsonTestBase.php
FileUploadJsonBasicAuthTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileUploadJsonBasicAuthTest.php @group file
FileUploadJsonCookieTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileUploadJsonCookieTest.php @group file
FileUploadResource class Drupal\file\Plugin\rest\resource core/modules/file/src/Plugin/rest/resource/FileUploadResource.php File upload resource.
FileUploadResourceTestBase abstract class Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/FileUploadResourceTestBase.php Tests binary data file upload route. 3 3
FileUploadTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/FileUploadTest.php Tests binary data file upload route.
FileUri class Drupal\file\Plugin\migrate\process\d6 core/modules/file/src/Plugin/migrate/process/d6/FileUri.php Process the file url into a D8 compatible URL. 1
FileUriFormatter class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileUriFormatter.php Formatter to render the file URI to its download path.
FileUriItem class Drupal\file\Plugin\Field\FieldType core/modules/file/src/Plugin/Field/FieldType/FileUriItem.php File-specific plugin implementation of a URI item to provide a full URL.
FileUriItemTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileUriItemTest.php File URI field item test.
FileUriTest class Drupal\Tests\file\Unit\Plugin\migrate\process\d6 core/modules/file/tests/src/Unit/Plugin/migrate/process/d6/FileUriTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\process\d6\FileUri @group file
FileUriUnique class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileUriUnique.php Supports validating file URIs.

Other projects

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