interface/modules/zend_modules/library/Zend/ModuleManager/Listener/ModuleLoaderListener.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\Listener;
  11
  12 use Zend\EventManager\EventManagerInterface;
  13 use Zend\EventManager\ListenerAggregateInterface;
  14 use Zend\Loader\ModuleAutoloader;
  15 use Zend\ModuleManager\ModuleEvent;
  16
  17 /**
  18  * Module loader listener
  19  */
  20 class ModuleLoaderListener extends AbstractListener implements ListenerAggregateInterface
  21 {
  22     /**
  23      * @var array
  24      */
  25     protected $moduleLoader;
  26
  27     /**
  28      * @var bool
  29      */
  30     protected $generateCache;
  31
  32     /**
  33      * @var array
  34      */
  35     protected $callbacks = array();
  36
  37     /**
  38      * Constructor.
  39      *
  40      * Creates an instance of the ModuleAutoloader and injects the module paths
  41      * into it.
  42      *
  43      * @param  ListenerOptions $options
  44      */
  45     public function __construct(ListenerOptions $options = null)
  46     {
  47         parent::__construct($options);
  48
  49         $this->generateCache = $this->options->getModuleMapCacheEnabled();
  50         $this->moduleLoader  = new ModuleAutoloader($this->options->getModulePaths());
  51
  52         if ($this->hasCachedClassMap()) {
  53             $this->generateCache = false;
  54             $this->moduleLoader->setModuleClassMap($this->getCachedConfig());
  55         }
  56     }
  57
  58     /**
  59      * {@inheritDoc}
  60      */
  61     public function attach(EventManagerInterface $events)
  62     {
  63         $this->callbacks[] = $events->attach(
  64             ModuleEvent::EVENT_LOAD_MODULES,
  65             array($this->moduleLoader, 'register'),
  66             9000
  67         );
  68
  69         if ($this->generateCache) {
  70             $this->callbacks[] = $events->attach(
  71                 ModuleEvent::EVENT_LOAD_MODULES_POST,
  72                 array($this, 'onLoadModulesPost')
  73             );
  74         }
  75     }
  76
  77     /**
  78      * {@inheritDoc}
  79      */
  80     public function detach(EventManagerInterface $events)
  81     {
  82         foreach ($this->callbacks as $index => $callback) {
  83             if ($events->detach($callback)) {
  84                 unset($this->callbacks[$index]);
  85             }
  86         }
  87     }
  88
  89     /**
  90      * @return bool
  91      */
  92     protected function hasCachedClassMap()
  93     {
  94         if (
  95             $this->options->getModuleMapCacheEnabled()
  96             && file_exists($this->options->getModuleMapCacheFile())
  97         ) {
  98             return true;
  99         }
 100
 101         return false;
 102     }
 103
 104     /**
 105      * @return array
 106      */
 107     protected function getCachedConfig()
 108     {
 109         return include $this->options->getModuleMapCacheFile();
 110     }
 111
 112     /**
 113      * loadModulesPost
 114      *
 115      * Unregisters the ModuleLoader and generates the module class map cache.
 116      *
 117      * @param  ModuleEvent $event
 118      */
 119     public function onLoadModulesPost(ModuleEvent $event)
 120     {
 121         $this->moduleLoader->unregister();
 122         $this->writeArrayToFile(
 123             $this->options->getModuleMapCacheFile(),
 124             $this->moduleLoader->getModuleClassMap()
 125         );
 126     }
 127 }