function xautoload_InjectedAPI_findFile::suggestFile in X Autoload 7.2

Same name and namespace in other branches

1. 7.3 lib/InjectedAPI/findFile.php \xautoload_InjectedAPI_findFile::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.

File

lib/InjectedAPI/findFile.php, line 48

Class

xautoload_InjectedAPI_findFile

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.

Code

function suggestFile($file) {
  if (file_exists($file)) {
    $this->file = $file;
    return TRUE;
  }
  else {
    return FALSE;
  }
}