function CollectFilesInjectedApi::guessFile in X Autoload 7.5

Same name and namespace in other branches

1. 7.4 lib/ClassFinder/InjectedApi/CollectFilesInjectedApi.php \Drupal\xautoload\ClassFinder\InjectedApi\CollectFilesInjectedApi::guessFile()

Suggest a file that MUST exists, and that MAY 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::guessFile

File

src/ClassFinder/InjectedApi/CollectFilesInjectedApi.php, line 119

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

Code

function guessFile($file) {
  $this->suggestions[] = array(
    __FUNCTION__,
    $file,
  );
  return __FUNCTION__ == $this->methodName && $file === $this->file;
}