function InjectedApiInterface::claimPath in X Autoload 7.5

Same name and namespace in other branches

1. 7.4 lib/ClassFinder/InjectedApi/InjectedApiInterface.php \Drupal\xautoload\ClassFinder\InjectedApi\InjectedApiInterface::claimPath()

Suggest a file that MAY 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::claimPath()

CollectFilesInjectedApi::claimPath in src/ClassFinder/InjectedApi/CollectFilesInjectedApi.php

Suggest a file that MAY exist, and if so, MUST declare the class we are looking for.

FindFileInjectedApi::claimPath in src/ClassFinder/InjectedApi/FindFileInjectedApi.php

Suggest a file that MAY exist, and if so, MUST declare the class we are looking for.

LoadClassInjectedAPI::claimPath in src/ClassFinder/InjectedApi/LoadClassInjectedAPI.php

Suggest a file that MAY exist, and if so, MUST declare the class we are looking for.

File

src/ClassFinder/InjectedApi/InjectedApiInterface.php, line 136

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\InjectedApi

Code

function claimPath($file);