Classes, traits, and interfaces - 10.3.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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
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\Unit\FileTransfer core/modules/system/tests/src/Unit/FileTransfer/FileTransferTest.php @group FileTransfer
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. 1 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
FileUploadHandler class Drupal\file\Upload core/modules/file/src/Upload/FileUploadHandler.php Handles validating and creating file entities from file uploads. 4 2
FileUploadHandlerTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileUploadHandlerTest.php Tests the file upload handler.
FileUploadJsonBasicAuthTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileUploadJsonBasicAuthTest.php @group file @group #slow
FileUploadJsonCookieTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileUploadJsonCookieTest.php @group file @group #slow
FileUploadLocationTrait trait Drupal\file\Upload core/modules/file/src/Upload/FileUploadLocationTrait.php Resolves the file upload location from a file field definition. 3
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. 2 2
FileUploadResult class Drupal\file\Upload core/modules/file/src/Upload/FileUploadResult.php Value object for a file upload result. 1
FileUploadSanitizeNameEvent class Drupal\Core\File\Event core/lib/Drupal/Core/File/Event/FileUploadSanitizeNameEvent.php An event during file upload that lets subscribers sanitize the filename. 9
FileUploadSanitizeNameEventTest class Drupal\Tests\Core\File core/tests/Drupal/Tests/Core/File/FileUploadSanitizeNameEventTest.php FileUploadSanitizeNameEvent tests.
FileUploadTest class Drupal\Tests\jsonapi\Kernel\Controller core/modules/jsonapi/tests/src/Kernel/Controller/FileUploadTest.php @coversDefaultClass \Drupal\jsonapi\Controller\FileUpload[[api-linebreak]] @group jsonapi
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[[api-linebreak]] @group file
FileUriUnique class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileUriUnique.php Supports validating file URIs.
FileUrlGenerator class Drupal\Core\File core/lib/Drupal/Core/File/FileUrlGenerator.php Default implementation for the file URL generator service. 2
FileUrlGeneratorInterface interface Drupal\Core\File core/lib/Drupal/Core/File/FileUrlGeneratorInterface.php Generates file URLs for a stream to an external or local file. 1 17
FileUrlGeneratorTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileUrlGeneratorTest.php @coversDefaultClass \Drupal\Core\File\FileUrlGenerator[[api-linebreak]]
FileUrlTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileUrlTest.php Tests the file URL.
FileUsageBase abstract class Drupal\file\FileUsage core/modules/file/src/FileUsage/FileUsageBase.php Defines the base class for database file usage backend. 2 1
FileUsageInterface interface Drupal\file\FileUsage core/modules/file/src/FileUsage/FileUsageInterface.php File usage backend interface. 1 3
FileUsed class Drupal\file_test_get_ids\Plugin\migrate\source\d7 core/modules/file/tests/modules/file_test_get_ids/src/Plugin/migrate/source/d7/FileUsed.php Drupal 7 file source from database restricted to used files.
FileValidationConstraint class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileValidationConstraint.php Validation File constraint.
FileValidationConstraintValidator class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileValidationConstraintValidator.php Checks that a file referenced in a file field is valid.
FileValidationEvent class Drupal\file\Validation core/modules/file/src/Validation/FileValidationEvent.php Event for file validations. 1
FileValidationException class Drupal\file\Upload core/modules/file/src/Upload/FileValidationException.php Provides an exception for upload validation errors.
FileValidationTestSubscriber class Drupal\file_validator_test\EventSubscriber core/modules/file/tests/modules/file_validator_test/src/EventSubscriber/FileValidationTestSubscriber.php Provides a validation listener for file validation tests. 2
FileValidator class Drupal\file\Validation core/modules/file/src/Validation/FileValidator.php Provides a class for file validation. 2
FileValidatorInterface interface Drupal\file\Validation core/modules/file/src/Validation/FileValidatorInterface.php Provides a file validator that supports a list of validations. 1 6
FileValidatorSettingsTrait trait Drupal\file\Validation core/modules/file/src/Validation/FileValidatorSettingsTrait.php Provides a trait to create validators from settings. 4
FileValidatorTest class Drupal\Tests\file\Kernel\Validation core/modules/file/tests/src/Kernel/Validation/FileValidatorTest.php Tests the file validator.
FileValidatorTestBase abstract class Drupal\Tests\file\Kernel\Validation core/modules/file/tests/src/Kernel/Validation/FileValidatorTestBase.php Provides a base file constraint validator test. 7 6
FileVideoFormatter class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileVideoFormatter.php Plugin implementation of the 'file_video' formatter.
FileVideoFormatterTest class Drupal\Tests\file\Functional\Formatter core/modules/file/tests/src/Functional/Formatter/FileVideoFormatterTest.php @coversDefaultClass \Drupal\file\Plugin\Field\FieldFormatter\FileVideoFormatter[[api-linebreak]] @group file @group #slow
FileViewsData class Drupal\file core/modules/file/src/FileViewsData.php Provides views data for the file entity type.
FileViewsDataTest class Drupal\Tests\options\Kernel\Views core/modules/options/tests/src/Kernel/Views/FileViewsDataTest.php Tests file views data.
FileViewsFieldAccessTest class Drupal\Tests\file\Kernel\Views core/modules/file/tests/src/Kernel/Views/FileViewsFieldAccessTest.php Tests base field access in Views for the file entity.
FileWidget class Drupal\file\Plugin\Field\FieldWidget core/modules/file/src/Plugin/Field/FieldWidget/FileWidget.php Plugin implementation of the 'file_generic' widget. 1 1
FileWidgetAjaxController class Drupal\file\Controller core/modules/file/src/Controller/FileWidgetAjaxController.php Defines a controller to respond to file widget AJAX requests.

Other projects

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