[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Zend Framework
   4   *
   5   * LICENSE
   6   *
   7   * This source file is subject to the new BSD license that is bundled
   8   * with this package in the file LICENSE.txt.
   9   * It is also available through the world-wide-web at this URL:
  10   * http://framework.zend.com/license/new-bsd
  11   * If you did not receive a copy of the license and are unable to
  12   * obtain it through the world-wide-web, please send an email
  13   * to [email protected] so we can send you a copy immediately.
  14   *
  15   * @category   Zend
  16   * @package    Zend_Loader
  17   * @subpackage PluginLoader
  18   * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  19   * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20   * @version    $Id$
  21   */
  22  
  23  /**
  24   * Plugin class loader interface
  25   *
  26   * @category   Zend
  27   * @package    Zend_Loader
  28   * @subpackage PluginLoader
  29   * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  30   * @license    http://framework.zend.com/license/new-bsd     New BSD License
  31   */
  32  interface Zend_Loader_PluginLoader_Interface
  33  {
  34      /**
  35       * Add prefixed paths to the registry of paths
  36       *
  37       * @param string $prefix
  38       * @param string $path
  39       * @return Zend_Loader_PluginLoader
  40       */
  41      public function addPrefixPath($prefix, $path);
  42  
  43      /**
  44       * Remove a prefix (or prefixed-path) from the registry
  45       *
  46       * @param string $prefix
  47       * @param string $path OPTIONAL
  48       * @return Zend_Loader_PluginLoader
  49       */
  50      public function removePrefixPath($prefix, $path = null);
  51  
  52      /**
  53       * Whether or not a Helper by a specific name
  54       *
  55       * @param string $name
  56       * @return Zend_Loader_PluginLoader
  57       */
  58      public function isLoaded($name);
  59  
  60      /**
  61       * Return full class name for a named helper
  62       *
  63       * @param string $name
  64       * @return string
  65       */
  66      public function getClassName($name);
  67  
  68      /**
  69       * Load a helper via the name provided
  70       *
  71       * @param string $name
  72       * @return string
  73       */
  74      public function load($name);
  75  }