class xautoload_InjectedAPI_hookXautoload in X Autoload 7.2

An instance of this class is passed around to implementations of hook_xautoload().

Hierarchy

• class \xautoload_InjectedAPI_hookXautoload

File

lib/InjectedAPI/hookXautoload.php, line 8

class xautoload_InjectedAPI_hookXautoload {
  protected $finder;
  protected $extensionDir;

  /**
   * @param xautoload_ClassFinder $finder
   *   The class finder object.
   */
  function __construct($finder) {
    $this->finder = $finder;
  }

  /**
   * Register an additional namespace for this module.
   * Note: Drupal\<module name>\ is already registered for <module dir>/lib.
   *
   * @param string $namespace
   *   The namespace
   * @param string $psr_0_root_dir
   *   PSR-0 root dir.
   *   If $relative is TRUE, this is relative to the current module dir.
   *   If $relative is FALSE, this is an absolute path.
   * @param boolean $relative
   *   Whether or not the path is relative to the current extension dir.
   */
  function namespaceRoot($namespace, $psr_0_root_dir = NULL, $relative = TRUE) {
    $psr_0_root_dir = $this
      ->processDir($psr_0_root_dir, $relative);
    $this->finder
      ->registerNamespaceRoot($namespace, $psr_0_root_dir);
  }

  /**
   * Register an additional namespace for this module.
   * Note: Drupal\<module name>\ is already registered for <module dir>/lib.
   *
   * @param string $namespace
   *   The namespace
   * @param string $prefix_root_dir
   *   Prefix root dir.
   *   If $relative is TRUE, this is relative to the extension module dir.
   *   If $relative is FALSE, this is an absolute path.
   * @param boolean $relative
   *   Whether or not the path is relative to the current extension dir.
   */
  function prefixRoot($prefix, $prefix_root_dir = NULL, $relative = TRUE) {
    $prefix_root_dir = $this
      ->processDir($prefix_root_dir, $relative);
    $this->finder
      ->registerPrefixRoot($prefix, $prefix_root_dir);
  }

  /**
   * Register an additional namespace for this module.
   * Note: Drupal\<module name>\ is already registered for <module dir>/lib.
   *
   * @param string $namespace
   *   The namespace
   * @param string $psr_0_root_dir
   *   PSR-0 root dir.
   *   If $relative is TRUE, this is relative to the current extension dir.
   *   If $relative is FALSE, this is an absolute path.
   * @param boolean $relative
   *   Whether or not the path is relative to the current extension dir.
   */
  function namespaceDeep($namespace, $namespace_deep_dir = NULL, $relative = TRUE) {
    $namespace_deep_dir = $this
      ->processDir($namespace_deep_dir, $relative);
    $this->finder
      ->registerNamespaceDeep($namespace, $namespace_deep_dir);
  }

  /**
   * Register an additional namespace for this module.
   * Note: Drupal\<module name>\ is already registered for <module dir>/lib.
   *
   * @param string $namespace
   *   The namespace
   * @param string $prefix_deep_dir
   *   PSR-0 root dir.
   *   If $relative is TRUE, this is relative to the current extension dir.
   *   If $relative is FALSE, this is an absolute path.
   * @param boolean $relative
   *   Whether or not the path is relative to the current extension dir.
   */
  function prefixDeep($prefix, $prefix_deep_dir = NULL, $relative = TRUE) {
    $prefix_root_dir = $this
      ->processDir($prefix_deep_dir, $relative);
    $this->finder
      ->registerPrefixDeep($prefix, $prefix_deep_dir);
  }

  /**
   * Legacy: Plugins were called "Handler" before.
   */
  function namespaceHandler($namespace, $plugin) {
    $this->finder
      ->registerNamespacePlugin($namespace, $plugin);
  }

  /**
   * Legacy: Plugins were called "Handler" before.
   */
  function prefixHandler($prefix, $plugin) {
    $this->finder
      ->registerPrefixPlugin($prefix, $plugin);
  }

  /**
   * Register a namespace plugin object
   */
  function namespacePlugin($namespace, $plugin) {
    $this->finder
      ->registerNamespacePlugin($namespace, $plugin);
  }

  /**
   * Register a prefix plugin object
   */
  function prefixPlugin($prefix, $plugin) {
    $this->finder
      ->registerPrefixPlugin($prefix, $plugin);
  }

  /**
   * Process a given directory to make it relative to Drupal root,
   * instead of relative to the current extension dir.
   *
   * @param string $dir
   *   The directory path that we want to make absolute.
   * @param boolean $relative
   *   If TRUE, the $dir will be transformed from relative to absolute.
   *   If FALSE, the $dir is assumed to already be absolute, and remain unchanged.
   *
   * @return string
   *   The modified (absolute) directory path.
   */
  protected function processDir($dir, $relative) {
    if (!isset($dir)) {
      $dir = $this->extensionDir . '/lib';
    }
    elseif ($relative) {

      // Root dir is relative to module root.
      if (empty($dir)) {
        $dir = $this->extensionDir;
      }
      else {
        $dir = $this->extensionDir . '/' . $dir;
      }
    }
    else {

      // Leave the $dir as it is.
    }
    return $dir;
  }

  /**
   * Set a module to use as base for relative paths.
   * This is typically called before each invocation of hook_xautoload() on a
   * module.
   * It can also be called by a module or theme that implements hook_xautoload(),
   * to register class loading information on behalf of another module.
   *
   * @param string $module
   *   Machine name of the module.
   */
  function setModule($module) {
    $this->extensionDir = drupal_get_path('module', $module);
  }

  /**
   * Set a theme to use as base for relative paths.
   * This is typically called before each invocation of hook_xautoload() on a
   * theme.
   * It can also be called by a module or theme that implements hook_xautoload(),
   * to register class loading information on behalf of another theme.
   *
   * @param string $theme
   *   Machine name of the theme.
   */
  function setTheme($theme) {
    $this->extensionDir = drupal_get_path('theme', $theme);
  }

  /**
   * Set a library to use as base for relative paths.
   * This is called e.g. in libraries_xautoload(), before passing the $api
   * object to library xautoload callbacks.
   *
   * @param string $library
   *   Machine name of the library.
   */
  function setLibrary($library) {
    if (!module_exists('libraries')) {
      throw new Exception('Libraries module not installed.');
    }
    $this->extensionDir = libraries_get_path($library);
  }

  /**
   * Explicitly set the base for relative paths.
   *
   * @param string $dir
   *   New relative base path.
   */
  function setExtensionDir($dir) {
    $this->extensionDir = $dir;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
xautoload_InjectedAPI_hookXautoload::$extensionDir	protected	property
xautoload_InjectedAPI_hookXautoload::$finder	protected	property
xautoload_InjectedAPI_hookXautoload::namespaceDeep		function	Register an additional namespace for this module. Note: Drupal\<module name>\ is already registered for <module dir>/lib.
xautoload_InjectedAPI_hookXautoload::namespaceHandler		function	Legacy: Plugins were called "Handler" before.
xautoload_InjectedAPI_hookXautoload::namespacePlugin		function	Register a namespace plugin object
xautoload_InjectedAPI_hookXautoload::namespaceRoot		function	Register an additional namespace for this module. Note: Drupal\<module name>\ is already registered for <module dir>/lib.
xautoload_InjectedAPI_hookXautoload::prefixDeep		function	Register an additional namespace for this module. Note: Drupal\<module name>\ is already registered for <module dir>/lib.
xautoload_InjectedAPI_hookXautoload::prefixHandler		function	Legacy: Plugins were called "Handler" before.
xautoload_InjectedAPI_hookXautoload::prefixPlugin		function	Register a prefix plugin object
xautoload_InjectedAPI_hookXautoload::prefixRoot		function	Register an additional namespace for this module. Note: Drupal\<module name>\ is already registered for <module dir>/lib.
xautoload_InjectedAPI_hookXautoload::processDir	protected	function	Process a given directory to make it relative to Drupal root, instead of relative to the current extension dir.
xautoload_InjectedAPI_hookXautoload::setExtensionDir		function	Explicitly set the base for relative paths.
xautoload_InjectedAPI_hookXautoload::setLibrary		function	Set a library to use as base for relative paths. This is called e.g. in libraries_xautoload(), before passing the $api object to library xautoload callbacks.
xautoload_InjectedAPI_hookXautoload::setModule		function	Set a module to use as base for relative paths. This is typically called before each invocation of hook_xautoload() on a module. It can also be called by a module or theme that implements hook_xautoload(), to register class loading information on…
xautoload_InjectedAPI_hookXautoload::setTheme		function	Set a theme to use as base for relative paths. This is typically called before each invocation of hook_xautoload() on a theme. It can also be called by a module or theme that implements hook_xautoload(), to register class loading information on behalf…
xautoload_InjectedAPI_hookXautoload::__construct		function