function InjectedApiInterface::claimFile in X Autoload 7.4
Same name and namespace in other branches
- 7.5 src/ClassFinder/InjectedApi/InjectedApiInterface.php \Drupal\xautoload\ClassFinder\InjectedApi\InjectedApiInterface::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.
3 methods override InjectedApiInterface::claimFile()
- CollectFilesInjectedApi::claimFile in lib/
ClassFinder/ InjectedApi/ CollectFilesInjectedApi.php - Suggest a file that MUST exist, and if so, MUST declare the class we are looking for.
- FindFileInjectedApi::claimFile in lib/
ClassFinder/ InjectedApi/ FindFileInjectedApi.php - Suggest a file that MUST exist, and if so, MUST declare the class we are looking for.
- LoadClassInjectedAPI::claimFile in lib/
ClassFinder/ InjectedApi/ LoadClassInjectedAPI.php - Suggest a file that MUST exist, and if so, MUST declare the class we are looking for.
File
- lib/
ClassFinder/ InjectedApi/ InjectedApiInterface.php, line 121
Class
- InjectedApiInterface
- 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);