interface/modules/zend_modules/library/Zend/Loader/PluginClassLocator.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Loader;
  11
  12 use IteratorAggregate;
  13 use Traversable;
  14
  15 /**
  16  * Plugin class locator interface
  17  */
  18 interface PluginClassLocator extends ShortNameLocator, IteratorAggregate
  19 {
  20     /**
  21      * Register a class to a given short name
  22      *
  23      * @param  string $shortName
  24      * @param  string $className
  25      * @return PluginClassLocator
  26      */
  27     public function registerPlugin($shortName, $className);
  28
  29     /**
  30      * Unregister a short name lookup
  31      *
  32      * @param  mixed $shortName
  33      * @return void
  34      */
  35     public function unregisterPlugin($shortName);
  36
  37     /**
  38      * Get a list of all registered plugins
  39      *
  40      * @return array|Traversable
  41      */
  42     public function getRegisteredPlugins();
  43 }