You are here

public function TestFileUsage::add in Drupal 8

Same name in this branch
  1. 8 core/modules/file/tests/src/Unit/LegacyFileTest.php \Drupal\Tests\file\Unit\TestFileUsage::add()
  2. 8 core/modules/system/tests/modules/service_provider_test/src/TestFileUsage.php \Drupal\service_provider_test\TestFileUsage::add()

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.

string $id: The unique ID of the object containing the referenced file.

int $count: (optional) The number of references to add to the object. Defaults to 1.

Overrides FileUsageBase::add

File

core/modules/file/tests/src/Unit/LegacyFileTest.php, line 92

Class

TestFileUsage
Provides a pass through to the abstract FileUsageBase() constructor.

Namespace

Drupal\Tests\file\Unit

Code

public function add(FileInterface $file, $module, $type, $id, $count = 1) {
}