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
FileFieldFormatterAccessTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldFormatterAccessTest.php Tests file formatter access. @group file
FileFieldItemList class Drupal\file\Plugin\Field\FieldType core/modules/file/src/Plugin/Field/FieldType/FileFieldItemList.php Represents a configurable entity file field. 4
FileFieldPathTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldPathTest.php Tests that files are uploaded to proper locations.
FileFieldRevisionTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldRevisionTest.php Tests creating and deleting revisions with files attached.
FileFieldRSSContentTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldRSSContentTest.php Ensure that files added to nodes appear correctly in RSS feeds.
FileFieldTest class Drupal\Tests\file\Unit\Plugin\migrate\field\d6 core/modules/file/tests/src/Unit/Plugin/migrate/field/d6/FileFieldTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\field\d6\FileField[[api-linebreak]] @group file
FileFieldTest class Drupal\Tests\file\Unit\Plugin\migrate\field\d7 core/modules/file/tests/src/Unit/Plugin/migrate/field/d7/FileFieldTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\field\d7\FileField[[api-linebreak]] @group file
FileFieldTestBase abstract class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldTestBase.php Provides methods specifically for testing File module's field handling. 14
FileFieldValidateTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/FileFieldValidateTest.php Tests file field validation functions.
FileFieldValidateTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldValidateTest.php Tests file field validation functions.
FileFieldWidgetClaroThemeTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/FileFieldWidgetClaroThemeTest.php Tests the widget visibility settings for the Claro theme.
FileFieldWidgetTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/FileFieldWidgetTest.php Tests the file field widget, single and multi-valued, using AJAX upload. 1
FileFieldWidgetTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldWidgetTest.php Tests the file field widget with public and private files.
FileFormatterBase abstract class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileFormatterBase.php Base class for file formatters. 5 1
FileImageDimensionsConstraint class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileImageDimensionsConstraint.php File extension dimensions constraint.
FileImageDimensionsConstraintValidator class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileImageDimensionsConstraintValidator.php Validator for the FileImageDimensionsConstraint.
FileImageDimensionsConstraintValidatorTest class Drupal\Tests\file\Kernel\Plugin\Validation\Constraint core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileImageDimensionsConstraintValidatorTest.php Tests the FileImageDimensionsConstraintValidator.
FileInterface interface Drupal\file core/modules/file/src/FileInterface.php Defines getter and setter methods for file entity base fields. 1 45
FileIsImageConstraint class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileIsImageConstraint.php File is image constraint.
FileIsImageConstraintValidator class Drupal\file\Plugin\Validation\Constraint core/modules/file/src/Plugin/Validation/Constraint/FileIsImageConstraintValidator.php Validator for the FileIsImageConstraint.
FileIsImageConstraintValidatorTest class Drupal\Tests\file\Kernel\Plugin\Validation\Constraint core/modules/file/tests/src/Kernel/Plugin/Validation/Constraint/FileIsImageConstraintValidatorTest.php Tests the FileIsImageConstraintValidator.
FileItem class Drupal\file\Plugin\Field\FieldType core/modules/file/src/Plugin/Field/FieldType/FileItem.php Plugin implementation of the 'file' field type. 1 4
FileItemTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileItemTest.php Tests using entity fields of the file field type. 1 1
FileItemValidationTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileItemValidationTest.php Tests that files referenced in file and image fields are always validated.
FileJsonAnonTest class Drupal\Tests\file\Functional\Rest core/modules/file/tests/src/Functional/Rest/FileJsonAnonTest.php @group rest
FileJsonBasicAuthTest class Drupal\Tests\file\Functional\Rest core/modules/file/tests/src/Functional/Rest/FileJsonBasicAuthTest.php @group rest
FileJsonCookieTest class Drupal\Tests\file\Functional\Rest core/modules/file/tests/src/Functional/Rest/FileJsonCookieTest.php @group rest
FileListingTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileListingTest.php Tests file listing page functionality.
FileManagedAccessTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileManagedAccessTest.php Tests access to managed files.
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. 3
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. 13
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\Tests\image\Kernel core/modules/image/tests/src/Kernel/FileMoveTest.php Tests the file move function for images and image styles.
FileMoveTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileMoveTest.php Tests the unmanaged file move function. 1
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.
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.
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

Other projects

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