blob: a4b2783b624d2ccb1631d9beae92b92bf9d35ccc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\ModuleManager;
use Zend\EventManager\Event;
/**
* Custom event for use with module manager
* Composes Module objects
*/
class ModuleEvent extends Event
{
/**
* Module events triggered by eventmanager
*/
const EVENT_MERGE_CONFIG = 'mergeConfig';
const EVENT_LOAD_MODULES = 'loadModules';
const EVENT_LOAD_MODULE_RESOLVE = 'loadModule.resolve';
const EVENT_LOAD_MODULE = 'loadModule';
const EVENT_LOAD_MODULES_POST = 'loadModules.post';
/**
* @var mixed
*/
protected $module;
/**
* @var string
*/
protected $moduleName;
/**
* @var Listener\ConfigMergerInterface
*/
protected $configListener;
/**
* Get the name of a given module
*
* @return string
*/
public function getModuleName()
{
return $this->moduleName;
}
/**
* Set the name of a given module
*
* @param string $moduleName
* @throws Exception\InvalidArgumentException
* @return ModuleEvent
*/
public function setModuleName($moduleName)
{
if (!is_string($moduleName)) {
throw new Exception\InvalidArgumentException(
sprintf(
'%s expects a string as an argument; %s provided',
__METHOD__,
gettype($moduleName)
)
);
}
// Performance tweak, don't add it as param.
$this->moduleName = $moduleName;
return $this;
}
/**
* Get module object
*
* @return null|object
*/
public function getModule()
{
return $this->module;
}
/**
* Set module object to compose in this event
*
* @param object $module
* @throws Exception\InvalidArgumentException
* @return ModuleEvent
*/
public function setModule($module)
{
if (!is_object($module)) {
throw new Exception\InvalidArgumentException(
sprintf(
'%s expects a module object as an argument; %s provided',
__METHOD__,
gettype($module)
)
);
}
// Performance tweak, don't add it as param.
$this->module = $module;
return $this;
}
/**
* Get the config listener
*
* @return null|Listener\ConfigMergerInterface
*/
public function getConfigListener()
{
return $this->configListener;
}
/**
* Set module object to compose in this event
*
* @param Listener\ConfigMergerInterface $configListener
* @return ModuleEvent
*/
public function setConfigListener(Listener\ConfigMergerInterface $configListener)
{
$this->setParam('configListener', $configListener);
$this->configListener = $configListener;
return $this;
}
}
|
