interface/modules/zend_modules/library/Zend/ModuleManager/ModuleEvent.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\Event;
  13
  14 /**
  15  * Custom event for use with module manager
  16  * Composes Module objects
  17  */
  18 class ModuleEvent extends Event
  19 {
  20     /**
  21      * Module events triggered by eventmanager
  22      */
  23     CONST EVENT_MERGE_CONFIG        = 'mergeConfig';
  24     CONST EVENT_LOAD_MODULES        = 'loadModules';
  25     CONST EVENT_LOAD_MODULE_RESOLVE = 'loadModule.resolve';
  26     CONST EVENT_LOAD_MODULE         = 'loadModule';
  27     CONST EVENT_LOAD_MODULES_POST   = 'loadModules.post';
  28
  29     /**
  30      * @var mixed
  31      */
  32     protected $module;
  33
  34     /**
  35      * @var string
  36      */
  37     protected $moduleName;
  38
  39     /**
  40      * @var Listener\ConfigMergerInterface
  41      */
  42     protected $configListener;
  43
  44     /**
  45      * Get the name of a given module
  46      *
  47      * @return string
  48      */
  49     public function getModuleName()
  50     {
  51         return $this->moduleName;
  52     }
  53
  54     /**
  55      * Set the name of a given module
  56      *
  57      * @param  string $moduleName
  58      * @throws Exception\InvalidArgumentException
  59      * @return ModuleEvent
  60      */
  61     public function setModuleName($moduleName)
  62     {
  63         if (!is_string($moduleName)) {
  64             throw new Exception\InvalidArgumentException(sprintf(
  65                 '%s expects a string as an argument; %s provided'
  66                 ,__METHOD__, gettype($moduleName)
  67             ));
  68         }
  69         // Performance tweak, don't add it as param.
  70         $this->moduleName = $moduleName;
  71
  72         return $this;
  73     }
  74
  75     /**
  76      * Get module object
  77      *
  78      * @return null|object
  79      */
  80     public function getModule()
  81     {
  82         return $this->module;
  83     }
  84
  85     /**
  86      * Set module object to compose in this event
  87      *
  88      * @param  object $module
  89      * @throws Exception\InvalidArgumentException
  90      * @return ModuleEvent
  91      */
  92     public function setModule($module)
  93     {
  94         if (!is_object($module)) {
  95             throw new Exception\InvalidArgumentException(sprintf(
  96                 '%s expects a module object as an argument; %s provided'
  97                 ,__METHOD__, gettype($module)
  98             ));
  99         }
 100         // Performance tweak, don't add it as param.
 101         $this->module = $module;
 102
 103         return $this;
 104     }
 105
 106     /**
 107      * Get the config listener
 108      *
 109      * @return null|Listener\ConfigMergerInterface
 110      */
 111     public function getConfigListener()
 112     {
 113         return $this->configListener;
 114     }
 115
 116     /**
 117      * Set module object to compose in this event
 118      *
 119      * @param  Listener\ConfigMergerInterface $configListener
 120      * @return ModuleEvent
 121      */
 122     public function setConfigListener(Listener\ConfigMergerInterface $configListener)
 123     {
 124         $this->setParam('configListener', $configListener);
 125         $this->configListener = $configListener;
 126
 127         return $this;
 128     }
 129 }