function FindFileInjectedApi::suggestFile in X Autoload 7.4

Same name and namespace in other branches

1. 7.5 src/ClassFinder/InjectedApi/FindFileInjectedApi.php \Drupal\xautoload\ClassFinder\InjectedApi\FindFileInjectedApi::suggestFile()

Suggest a file that, if the file exists, has to declare the class we are looking for. Only keep the class on success.

Parameters

string $file: The file that is supposed to declare the class.

Return value

bool TRUE, if the file exists. FALSE, otherwise.

Overrides InjectedApiInterface::suggestFile

1 method overrides FindFileInjectedApi::suggestFile()

LoadClassGetFileInjectedApi::suggestFile in lib/ClassFinder/InjectedApi/LoadClassGetFileInjectedApi.php

Suggest a file that, if the file exists, has to declare the class we are looking for. Only keep the class on success.

File

lib/ClassFinder/InjectedApi/FindFileInjectedApi.php, line 42

Class

FindFileInjectedApi

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 suggestFile($file) {
  if (file_exists($file)) {
    $this->file = $file;
    return TRUE;
  }
  else {
    return FALSE;
  }
}