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

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
FileFormatterBase abstract class Drupal\file\Plugin\Field\FieldFormatter core/modules/file/src/Plugin/Field/FieldFormatter/FileFormatterBase.php Base class for file formatters. 5 1
FileHalJsonAnonTest class Drupal\Tests\file\Functional\Hal core/modules/file/tests/src/Functional/Hal/FileHalJsonAnonTest.php @group hal 2
FileHalJsonBasicAuthTest class Drupal\Tests\file\Functional\Hal core/modules/file/tests/src/Functional/Hal/FileHalJsonBasicAuthTest.php @group hal
FileHalJsonCookieTest class Drupal\Tests\file\Functional\Hal core/modules/file/tests/src/Functional/Hal/FileHalJsonCookieTest.php @group hal
FileInterface interface Drupal\file core/modules/file/src/FileInterface.php Defines getter and setter methods for file entity base fields. 1 32
FileItem class Drupal\file\Plugin\Field\FieldType core/modules/file/src/Plugin/Field/FieldType/FileItem.php Plugin implementation of the 'file' field type. 1 3
FileItemTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileItemTest.php Tests using entity fields of the file field type.
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
FileLegacyTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileLegacyTest.php Tests file deprecations.
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

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

abstract class Drupal\file\Tests core/modules/file/src/Tests/FileManagedTestBase.php Base class for file tests that use the file_test module to test uploads and hooks.
FileManagedTestBase abstract class Drupal\Tests\file\Functional core/modules/file/tests/src/Functional/FileManagedTestBase.php Base class for file tests that use the file_test module to test uploads and hooks. 3
FileManagedUnitTestBase abstract class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileManagedUnitTestBase.php Base class for file unit tests that use the file_test module to test uploads and hooks. 12
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. 6
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.
FileModuleTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/FileModuleTest.php Tests file.module methods.
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\Functional core/modules/image/tests/src/Functional/FileMoveTest.php Tests the file move function for images and image styles.
FileNormalizeTest class Drupal\Tests\hal\Kernel core/modules/hal/tests/src/Kernel/FileNormalizeTest.php Tests that file entities can be normalized in HAL.
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.
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
FileReadOnlyStorage class Drupal\Component\PhpStorage core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php Reads code as regular PHP files, but won't write them. 1
FileResourceTestBase

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

abstract class Drupal\Tests\rest\Functional\EntityResource\File core/modules/rest/tests/src/Functional/EntityResource/File/FileResourceTestBase.php
FileResourceTestBase abstract class Drupal\Tests\file\Functional\Rest core/modules/file/tests/src/Functional/Rest/FileResourceTestBase.php 8 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 file_save_htaccess().
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. 11
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.
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 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.
FileStorage class Drupal\file core/modules/file/src/FileStorage.php File storage for files.
FileStorage class Drupal\Component\PhpStorage core/lib/Drupal/Component/PhpStorage/FileStorage.php Stores the code as regular PHP files. 1 3
FileStorage class Drupal\Core\Config core/lib/Drupal/Core/Config/FileStorage.php Defines the file storage. 1 20 2
FileStorageDeprecationTest class Drupal\Tests\Component\PhpStorage core/tests/Drupal/Tests/Component/PhpStorage/FileStorageDeprecationTest.php Tests FileStorage deprecations.

Other projects


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