public FileUsageBase::add(FileInterface $file, $module, $type, $id, $count = 1)
Records that a module is using a file.
Examples:
- A module that associates files with nodes, so $type would be 'node' and $id would be the node's nid. Files for all revisions are stored within a single nid.
- The User module associates an image with a user, so $type would be 'user' and the $id would be the user's uid.
Parameters
\Drupal\file\FileInterface $file: A file entity.
string $module: The name of the module using the file.
string $type: The type of the object that contains the referenced file.
int $id: The unique, numeric ID of the object containing the referenced file.
int $count: (optional) The number of references to add to the object. Defaults to 1.
Overrides FileUsageInterface::add
File
- core/modules/file/src/FileUsage/FileUsageBase.php, line 15
Class
- FileUsageBase
- Defines the base class for database file usage backend.
Namespace
Drupal\file\FileUsage
Code
public function add(FileInterface $file, $module, $type, $id, $count = 1) { // Make sure that a used file is permanent. if (!$file->isPermanent()) { $file->setPermanent(); $file->save(); } }
Please login to continue.