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
FileAccessControlHandler class Drupal\file core/modules/file/src/FileAccessControlHandler.php Provides a File access control handler. 1 1
FileAccessFormatterControlHandlerInterface interface Drupal\file core/modules/file/src/FileAccessFormatterControlHandlerInterface.php Defines an interface for file access handlers that need to run on file formatters. 1 1
FileAudioFormatter class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileAudioFormatter.php Plugin implementation of the 'file_audio' formatter.
FileAudioFormatterTest class Drupal\Tests\file\Functional\Formatter core/modules/file/tests/src/Functional/Formatter/FileAudioFormatterTest.php @coversDefaultClass \Drupal\file\Plugin\Field\FieldFormatter\FileAudioFormatter @group file
FileCache class Drupal\Component\FileCache core/lib/Drupal/Component/FileCache/FileCache.php Allows to cache data based on file modification dates. 3
FileCacheBackendInterface interface Drupal\Component\FileCache core/lib/Drupal/Component/FileCache/FileCacheBackendInterface.php Defines an interface inspired by APCu for FileCache backends. 2 1
FileCacheFactory class Drupal\Component\FileCache core/lib/Drupal/Component/FileCache/FileCacheFactory.php Creates a FileCache object. 20
FileCacheFactoryTest class Drupal\Tests\Component\FileCache core/tests/Drupal/Tests/Component/FileCache/FileCacheFactoryTest.php @coversDefaultClass \Drupal\Component\FileCache\FileCacheFactory @group FileCache
FileCacheInterface interface Drupal\Component\FileCache core/lib/Drupal/Component/FileCache/FileCacheInterface.php Interface for objects that allow caching file data. 2
FileCacheTest class Drupal\Tests\Component\FileCache core/tests/Drupal/Tests/Component/FileCache/FileCacheTest.php @coversDefaultClass \Drupal\Component\FileCache\FileCache @group FileCache
FileCckTest class Drupal\Tests\file\Unit\Plugin\migrate\cckfield\d6 core/modules/file/tests/src/Unit/Plugin/migrate/cckfield/d6/FileCckTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\cckfield\d6\FileField @group file @group legacy
FileCckTest class Drupal\Tests\file\Unit\Plugin\migrate\cckfield\d7 core/modules/file/tests/src/Unit/Plugin/migrate/cckfield/d7/FileCckTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\cckfield\d7\FileField @group file @group legacy
FileCopy class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/FileCopy.php Copies or moves a local file from one place into another. 1 2
FileCopyTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/FileCopyTest.php Tests the file copy process plugin.
FileCopyTest class Drupal\Tests\migrate\Kernel\process core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php Tests the file_copy process plugin.
FileCopyTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileCopyTest.php Tests the unmanaged file copy function. 1
FileDeleteRecursiveTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileDeleteRecursiveTest.php Tests the unmanaged file delete recursive function. 1
FileDeleteTest class Drupal\KernelTests\Core\File core/tests/Drupal/KernelTests/Core/File/FileDeleteTest.php Tests the unmanaged file delete function. 1
FileDownloadController class Drupal\system core/modules/system/src/FileDownloadController.php System file controller. 1 2
FileElementTest class Drupal\Tests\system\Kernel\Form core/modules/system/tests/src/Kernel/Form/FileElementTest.php Tests for the 'file' form element.
FileEntityFormatterTest class Drupal\Tests\file\Kernel\Formatter core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php Tests the default file formatter.
FileEntityNormalizer class Drupal\hal\Normalizer core/modules/hal/src/Normalizer/FileEntityNormalizer.php Converts the Drupal entity object structure to a HAL array structure. 2
FileException class Drupal\Core\File\Exception core/lib/Drupal/Core/File/Exception/FileException.php Base class for exceptions related to file handling operations. 6 31
FileExistsException class Drupal\Core\File\Exception core/lib/Drupal/Core/File/Exception/FileExistsException.php Exception thrown when a file unexpectedly exists. 3
FileExtensionFormatter class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileExtensionFormatter.php Formatter to render a filename as file extension.
FileField class Drupal\file\Plugin\migrate\field\d6 core/modules/file/src/Plugin/migrate/field/d6/FileField.php Plugin annotation @MigrateField( id = "filefield", core = {6}, source_module = "filefield", destination_module = "file" ) 2 3
FileField class Drupal\file\Plugin\migrate\field\d7 core/modules/file/src/Plugin/migrate/field/d7/FileField.php Plugin annotation @MigrateField( id = "file", core = {7}, source_module = "file", destination_module = "file" ) 1
FileField

in drupal:8.3.0 and is removed from drupal:9.0.0. Use \Drupal\file\Plugin\migrate\field\d6\FileField instead.

 class Drupal\file\Plugin\migrate\cckfield\d6 core/modules/file/src/Plugin/migrate/cckfield/d6/FileField.php Plugin annotation @MigrateCckField( id = "filefield", core = {6}, source_module = "filefield", destination_module = "file" ) 1
FileField

in drupal:8.3.0 and is removed from drupal:9.0.0. Use \Drupal\file\Plugin\migrate\field\d7\FileField instead.

 class Drupal\file\Plugin\migrate\cckfield\d7 core/modules/file/src/Plugin/migrate/cckfield/d7/FileField.php Plugin annotation @MigrateCckField( id = "file", core = {7}, source_module = "file", destination_module = "file" ) 1
FileFieldAnonymousSubmissionTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldAnonymousSubmissionTest.php Confirm that file field submissions work correctly for anonymous visitors.
FileFieldAttributesTest class Drupal\Tests\rdf\Functional core/modules/rdf/tests/src/Functional/FileFieldAttributesTest.php Tests the RDFa markup of filefields.
FileFieldCreationTrait trait Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldCreationTrait.php Provides methods for creating file fields. 6
FileFieldDisplayTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldDisplayTest.php Tests the display of file fields in node and views.
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. 2
FileFieldLegacyTest class Drupal\Tests\file\Unit\Plugin\migrate\field\d6 core/modules/file/tests/src/Unit/Plugin/migrate/field/d6/FileFieldLegacyTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\field\d6\FileField @group legacy @group file
FileFieldLegacyTest class Drupal\Tests\file\Unit\Plugin\migrate\field\d7 core/modules/file/tests/src/Unit/Plugin/migrate/field/d7/FileFieldLegacyTest.php @coversDefaultClass \Drupal\file\Plugin\migrate\field\d7\FileField @group legacy @group file
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 @group file 1
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 @group file 1
FileFieldTestBase

in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\file\Functional\FileFieldTestBase instead.

 abstract class Drupal\file\Tests core/modules/file/src/Tests/FileFieldTestBase.php Provides methods specifically for testing File module's field handling.
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. 15 1
FileFieldTestBaseTrait trait Drupal\TestTools\PhpUnitCompatibility\PhpUnit6 core/tests/Drupal/TestTools/PhpUnitCompatibility/PhpUnit6/FileFieldTestBaseTrait.php Makes Drupal's test API forward compatible with multiple versions of PHPUnit.
FileFieldTestBaseTrait trait Drupal\TestTools\PhpUnitCompatibility\PhpUnit7 core/tests/Drupal/TestTools/PhpUnitCompatibility/PhpUnit7/FileFieldTestBaseTrait.php Makes Drupal's test API forward compatible with multiple versions of PHPUnit.
FileFieldValidateTest class Drupal\Tests\file\FunctionalJavascript core/modules/file/tests/src/FunctionalJavascript/FileFieldValidateTest.php Tests validation functions such as file type, max file size, max size per node, and required.
FileFieldValidateTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldValidateTest.php Tests validation functions such as file type, max file size, max size per node, and required.
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.
FileFieldWidgetTest class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileFieldWidgetTest.php Tests the file field widget with public and private files.

Other projects

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