function CollectFilesInjectedApi::claimFile in X Autoload 7.5
Same name and namespace in other branches
- 7.4 lib/ClassFinder/InjectedApi/CollectFilesInjectedApi.php \Drupal\xautoload\ClassFinder\InjectedApi\CollectFilesInjectedApi::claimFile()
Suggest a file that MUST exist, and if so, MUST declare the class we are looking for.
This is useful if a plugin already did the is_file() check by itself.
Parameters
string $file: The file that is supposed to declare the class.
Return value
boolean|NULL TRUE, if we are not interested in further candidates. FALSE|NULL, if we are interested in further candidates.
Overrides InjectedApiInterface::claimFile
File
- src/
ClassFinder/ InjectedApi/ CollectFilesInjectedApi.php, line 135
Class
- CollectFilesInjectedApi
- To help testability, we use an injected API instead of just a return value. The injected API can be mocked to provide a mocked file_exists(), and to monitor all suggested candidates, not just the correct return value.
Namespace
Drupal\xautoload\ClassFinder\InjectedApiCode
function claimFile($file) {
$this->suggestions[] = array(
__FUNCTION__,
$file,
);
return TRUE;
}