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
FileManagedFileElementTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/FileManagedFileElementTest.php Tests the 'managed_file' element type.
FileManagedFileElementTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileManagedFileElementTest.php Tests the 'managed_file' element type.
FileManagedTestBase abstract class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileManagedTestBase.php Provides a base class for testing files with the file_test module. 4
FileManagedUnitTestBase abstract class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileManagedUnitTestBase.php Provides a base class for testing file uploads and hook invocations. 11
FileMediaFormatterBase abstract class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileMediaFormatterBase.php Base class for media file formatter. 2
FileMediaFormatterInterface interface Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileMediaFormatterInterface.php Defines getter methods for FileMediaFormatterBase. 1
FileMediaFormatterTestBase abstract class Drupal\Tests\file\Functional\Formatter core/modules/file/tests/src/Functional/Formatter/FileMediaFormatterTestBase.php Provides methods specifically for testing File module's media formatter's. 2
FileMigrationSetupTrait trait Drupal\Tests\file\Kernel\Migrate\d7 core/modules/file/tests/src/Kernel/Migrate/d7/FileMigrationSetupTrait.php A trait to setup the file migration. 4
FileMigrationTestTrait trait Drupal\Tests\file\Kernel\Migrate\d6 core/modules/file/tests/src/Kernel/Migrate/d6/FileMigrationTestTrait.php Helper for setting up a file migration test. 5
FilemimeFormatter class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FilemimeFormatter.php Formatter to render the file MIME type, with an optional icon.
FileModuleTestForm class Drupal\file_module_test\Form core/modules/file/tests/file_module_test/src/Form/FileModuleTestForm.php Form controller for file_module_test module. 1
FileMoveTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileMoveTest.php Tests the unmanaged file move function. 1
FileMoveTest class Drupal\Tests\image\Kernel core/modules/image/tests/src/Kernel/FileMoveTest.php Tests the file move function for images and image styles.
FileNameLengthConstraint class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileNameLengthConstraint.php File name length constraint.
FileNameLengthConstraintValidator class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileNameLengthConstraintValidator.php Validates the file name length constraint. 1
FileNameLengthConstraintValidatorTest class Drupal\Tests\file\Kernel\Plugin\Validation\Constraint core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileNameLengthConstraintValidatorTest.php Tests the FileNameLengthConstraintValidator.
FileNotExistsException class Drupal\Core\File\Exception core/lib/Drupal/Core/File/Exception/FileNotExistsException.php Exception thrown when a file is expected to exist but does not. 4
FileOnTranslatedEntityTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileOnTranslatedEntityTest.php Uploads files to translated nodes.
FileOutput final class Drupal\PHPStan\ErrorFormatter core/tests/PHPStan/ErrorFormatter/FileOutput.php Output implementation that writes to a file.
FilePathTest class Drupal\Tests\migrate_drupal_ui\Functional\d7 core/modules/migrate_drupal_ui/tests/src/Functional/d7/FilePathTest.php Tests the Drupal 7 public and private file migrations.
FilePrivateTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FilePrivateTest.php Uploads a test to a private node and checks access.
FileProcessBase abstract class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/FileProcessBase.php Provides functionality for file process plugins. 2
FileProcessOutputCallback final class Drupal\package_manager core/modules/package_manager/src/FileProcessOutputCallback.php Logs process output to a file. 3
FileReadOnlyStorage class Drupal\Component\PhpStorage core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php Reads code as regular PHP files, but won't write them. 1
FileRepository class Drupal\file core/modules/file/src/FileRepository.php Provides a file entity repository. 4 2
FileRepositoryInterface interface Drupal\file core/modules/file/src/FileRepositoryInterface.php Performs file system operations and updates database records accordingly. 1 3
FileRepositoryTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileRepositoryTest.php Tests the FileRepository.
FileRequiredTestForm class Drupal\file_test\Form core/modules/file/tests/file_test/src/Form/FileRequiredTestForm.php File required test form class. 1
FileRequirements class Drupal\file\Hook core/modules/file/src/Hook/FileRequirements.php Requirements for the File module.
FileResourceTestBase abstract class Drupal\Tests\file\Functional\Rest core/modules/file/tests/src/Functional/Rest/FileResourceTestBase.php Resource test base for file entity. 6
FileRouteProvider class Drupal\file\Entity core/modules/file/src/Entity/FileRouteProvider.php Provides routes for files.
FileSanitizationEventSubscriber class Drupal\file_validator_test\EventSubscriber core/modules/file/tests/modules/file_validator_test/src/EventSubscriber/FileSanitizationEventSubscriber.php Provides a file sanitization listener for file upload tests. 2
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 the HtaccessWriter service.
FileSaveUploadTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileSaveUploadTest.php Tests file_save_upload().
FileSecurity class Drupal\Composer\Plugin\VendorHardening composer/Plugin/VendorHardening/FileSecurity.php Provides file security functions.
FileSecurity class Drupal\Component\FileSecurity core/lib/Drupal/Component/FileSecurity/FileSecurity.php Provides file security functions. 8
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.
FileSelectionTest class Drupal\Tests\file\Kernel\Plugin\EntityReference core/modules/file/tests/src/Kernel/Plugin/EntityReference/FileSelectionTest.php Tests file selection plugin.
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 byte 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.
FileSizeLimitConstraint class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileSizeLimitConstraint.php File size max constraint.
FileSizeLimitConstraintValidator class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileSizeLimitConstraintValidator.php Validates the FileSizeLimitConstraint. 1
FileSizeLimitConstraintValidatorTest class Drupal\Tests\file\Kernel\Plugin\Validation\Constraint core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileSizeLimitConstraintValidatorTest.php Tests the FileSizeLimitConstraintValidator.
FileStorage class Drupal\file core/modules/file/src/FileStorage.php File storage for files. 1
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 19 2
FileStorageFactory class Drupal\Core\Config core/lib/Drupal/Core/Config/FileStorageFactory.php Provides a factory for creating config file storage objects. 1

Other projects


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