function FileManagedTestBase::assertFileHookCalled
Same name in other branches
- 9 core/modules/file/tests/src/Functional/FileManagedTestBase.php \Drupal\Tests\file\Functional\FileManagedTestBase::assertFileHookCalled()
- 8.9.x core/modules/file/src/Tests/FileManagedTestBase.php \Drupal\file\Tests\FileManagedTestBase::assertFileHookCalled()
- 8.9.x core/modules/file/tests/src/Functional/FileManagedTestBase.php \Drupal\Tests\file\Functional\FileManagedTestBase::assertFileHookCalled()
- 10 core/modules/file/tests/src/Functional/FileManagedTestBase.php \Drupal\Tests\file\Functional\FileManagedTestBase::assertFileHookCalled()
Assert that a hook_file_* hook was called a certain number of times.
Parameters
string $hook: String with the hook name; for instance, 'load', 'save', 'insert', etc.
int $expected_count: Optional integer count.
string|null $message: Optional translated string message.
File
-
core/
modules/ file/ tests/ src/ Functional/ FileManagedTestBase.php, line 73
Class
- FileManagedTestBase
- Provides a base class for testing files with the file_test module.
Namespace
Drupal\Tests\file\FunctionalCode
public function assertFileHookCalled($hook, $expected_count = 1, $message = NULL) {
$actual_count = count(FileTestHelper::getCalls($hook));
if (!isset($message)) {
if ($actual_count == $expected_count) {
$message = "hook_file_{$hook} was called correctly.";
}
elseif ($expected_count == 0) {
$message = "hook_file_{$hook} was not expected to be called but was actually called {$actual_count} time(s).";
}
else {
$message = "hook_file_{$hook} was expected to be called {$expected_count} time(s) but was called {$actual_count} time(s).";
}
}
$this->assertEquals($expected_count, $actual_count, $message);
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.