interface/modules/zend_modules/library/Zend/ModuleManager/ModuleManagerInterface.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\ModuleManager;
  11
  12 use Zend\EventManager\EventManagerAwareInterface;
  13
  14 /**
  15  * Module manager interface
  16  */
  17 interface ModuleManagerInterface extends EventManagerAwareInterface
  18 {
  19     /**
  20      * Load the provided modules.
  21      *
  22      * @return ModuleManagerInterface
  23      */
  24     public function loadModules();
  25
  26     /**
  27      * Load a specific module by name.
  28      *
  29      * @param  string $moduleName
  30      * @return mixed Module's Module class
  31      */
  32     public function loadModule($moduleName);
  33
  34     /**
  35      * Get an array of the loaded modules.
  36      *
  37      * @param  bool $loadModules If true, load modules if they're not already
  38      * @return array An array of Module objects, keyed by module name
  39      */
  40     public function getLoadedModules($loadModules);
  41
  42     /**
  43      * Get the array of module names that this manager should load.
  44      *
  45      * @return array
  46      */
  47     public function getModules();
  48
  49     /**
  50      * Set an array or Traversable of module names that this module manager should load.
  51      *
  52      * @param  mixed $modules array or Traversable of module names
  53      * @return ModuleManagerInterface
  54      */
  55     public function setModules($modules);
  56 }