LoadClassInjectedAPI.php in X Autoload 7.4

Namespace

Drupal\xautoload\ClassFinder\InjectedApi

File

lib/ClassFinder/InjectedApi/LoadClassInjectedAPI.php

<?php

namespace Drupal\xautoload\ClassFinder\InjectedApi;

use Drupal\xautoload\Util;

/**
 * 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.
 */
class LoadClassInjectedAPI extends AbstractInjectedApi {

  /**
   * {@inheritdoc}
   */
  function suggestFile($file) {
    if (file_exists($file)) {
      require $file;
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  function suggestFile_skipFileExists($file) {
    require $file;
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  function suggestFile_checkNothing($file) {
    require $file;
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  function suggestFile_checkIncludePath($file) {
    if (FALSE !== ($file = Util::findFileInIncludePath($file))) {
      require $file;
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  function guessFile($file) {
    require_once $file;
    return Util::classIsDefined($this->className);
  }

  /**
   * {@inheritdoc}
   */
  function guessPath($file) {
    if (file_exists($file)) {
      require_once $file;
      return Util::classIsDefined($this->className);
    }
    else {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  function claimFile($file) {
    require $file;
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  function claimPath($file) {
    if (file_exists($file)) {
      require $file;
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

}

Classes

Name	Description
LoadClassInjectedAPI	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.