IntegrationModuleTrait::setModuleManager() - Code Metrics - Inspection of "Merge pull request #1 from nnx-skelet/feature" - nnx-framework/module - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 10bbaf...0fa0d2 )

by Андрей

created 2016-06-01 06:36 UTC

IntegrationModuleTrait::setModuleManager() A

↳ Parent: IntegrationModuleTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php
/**
 * @link    https://github.com/nnx-framework/module
 * @author  Malofeykin Andrey  <[email protected]>
 */
namespace Nnx\Module;

use Nnx\Module\Event\IntegrationModuleEvent;
use Zend\ModuleManager\ModuleManagerInterface;
use Zend\EventManager\EventManagerInterface;
use Zend\ModuleManager\ModuleEvent;
use Nnx\Module\Event\IntegrationModuleEventInterface;
use ReflectionClass;

/**
 * Class IntegrationModuleTrait
 *
 * @package Nnx\Module\Options
 */
trait IntegrationModuleTrait
{
    /**
     * @see \Zend\EventManager\EventManagerAwareTrait::setEventManager
     *
     * @var array
     */
    protected $eventIdentifier = [
        IntegrationModuleInterface::class
    ];

    /**
     * Протип объекта, испольуземый для создания события бросаемого при инициализации интеграционного модуля
     *
     * @var IntegrationModuleEventInterface
     */
    protected $prototypeIntegrationModuleEvent;

    /**
     * Имя класса, который должен имплементировать \Nnx\Module\Event\IntegrationModuleEventInterface. Данный класс
     * используется для создания объекта прототипа события (@see \Nnx\Module\IntegrationModuleTrait::$prototypeIntegrationModuleEvent)
     *
     * @var string
     */
    protected $prototypeIntegrationModuleEventClassName = IntegrationModuleEvent::class;

    /**
     * Менеджер модулей
     *
     * @var ModuleManagerInterface
     */
    protected $moduleManager;

    /**
     * Приоритет обработчки отвечающего за проксирование события пост загрузки всех модулей. Для корректной работы
     * интеграционного модуля, это значение должно быть больше, по приоритету чем значение свойства 
     * @see \Nnx\Module\Listener\IntegrationModuleListener::$configuringServiceModulesHandlerPriority
     *
     *
     * при подписке на onLoadModulesPost в ServiceListener
     * (@see \Zend\ModuleManager\Listener\ServiceListener::attach) и меньше чем 
     *
     *
     *
     * @var int
     */
    protected $loadModulesPostProxyHandlerPriority = 100;

    /**
     * @return EventManagerInterface
     */
    abstract public function getEventManager();

    /**
     * Initialize workflow
     *
     * @param  ModuleManagerInterface $manager
     * @return void
     */
    public function init(ModuleManagerInterface $manager)
    {
        $this->initIntegrationModule($manager);
    }

    /**
     * Инициализация интеграционного модуля
     *
     * @param ModuleManagerInterface $manager
     */
    public function initIntegrationModule(ModuleManagerInterface $manager)
    {
        $this->setModuleManager($manager);
        $this->preInitIntegrationModule();

        $manager->getEventManager()->attach(
            ModuleEvent::EVENT_LOAD_MODULES_POST,
            [$this, 'onLoadModulesPostProxyHandler'],
            $this->loadModulesPostProxyHandlerPriority
        );
    }

    /**
     * Метод вызывается перед стандартным механизмом инициализаци. Используется для перегрузки в конкретном модуле.
     *
     * @return void
     */
    protected function preInitIntegrationModule()
    {
    }

    /**
     * Обработчик события возникающего после загрузки модулей
     *
     * @throws Exception\ErrorCreateIntegrationModuleEventException
     *
     * @throws Exception\InvalidModuleManagerException
     */
    public function onLoadModulesPostProxyHandler()
    {
        $event = clone $this->getPrototypeIntegrationModuleEvent();
        $event->setName(IntegrationModuleEventInterface::INIT_INTEGRATION_MODULE_EVENT);
        $event->setTarget($this);

        $moduleManager = $this->getModuleManager();
        $event->setModuleManager($moduleManager);

        $event->setModule($this);

        $this->getEventManager()->trigger($event);
    }

    /**
     * Возвращает протип объекта, испольуземый для создания события бросаемого при инициализации интеграционного модуля
     *
     * @return IntegrationModuleEventInterface
     *
     * @throws Exception\ErrorCreateIntegrationModuleEventException
     */
    public function getPrototypeIntegrationModuleEvent()
    {
        if ($this->prototypeIntegrationModuleEvent instanceof IntegrationModuleEventInterface) {
            return $this->prototypeIntegrationModuleEvent;
        }

        $eventClassName = $this->getPrototypeIntegrationModuleEventClassName();

        $r = new ReflectionClass($eventClassName);
        $event = $r->newInstance();

        if (!$event instanceof IntegrationModuleEventInterface) {
            $errMsg = sprintf('Integration module event not implement %s', IntegrationModuleEventInterface::class);
            throw new Exception\ErrorCreateIntegrationModuleEventException($errMsg);
        }

        $this->prototypeIntegrationModuleEvent = $event;

        return $this->prototypeIntegrationModuleEvent;
    }

    /**
     * Устанавливает протип объекта, испольуземый для создания события бросаемого при инициализации интеграционного модуля
     *
     * @param IntegrationModuleEventInterface $prototypeIntegrationModuleEvent
     *
     * @return $this
     */
    public function setPrototypeIntegrationModuleEvent(IntegrationModuleEventInterface $prototypeIntegrationModuleEvent)
    {
        $this->prototypeIntegrationModuleEvent = $prototypeIntegrationModuleEvent;

        return $this;
    }

    /**
     * Возвращает имя класса, который должен имплементировать \Nnx\Module\Event\IntegrationModuleEventInterface. Данный класс
     * используется для создания объекта прототипа события (@see \Nnx\Module\IntegrationModuleTrait::$prototypeIntegrationModuleEvent)
     *
     * @return string
     */
    public function getPrototypeIntegrationModuleEventClassName()
    {
        return $this->prototypeIntegrationModuleEventClassName;
    }

    /**
     * Устанавливает имя класса, который должен имплементировать \Nnx\Module\Event\IntegrationModuleEventInterface. Данный класс
     * используется для создания объекта прототипа события (@see \Nnx\Module\IntegrationModuleTrait::$prototypeIntegrationModuleEvent)
     *
     * @param string $prototypeIntegrationModuleEventClassName
     *
     * @return $this
     */
    public function setPrototypeIntegrationModuleEventClassName($prototypeIntegrationModuleEventClassName)
    {
        $this->prototypeIntegrationModuleEventClassName = $prototypeIntegrationModuleEventClassName;

        return $this;
    }

    /**
     * Возвращает менеджер модулей
     *
     * @return ModuleManagerInterface
     *
     * @throws Exception\InvalidModuleManagerException
     */
    public function getModuleManager()
    {
        if (!$this->moduleManager instanceof ModuleManagerInterface) {
            $errMsg = 'Module manager not installed';
            throw new Exception\InvalidModuleManagerException($errMsg);
        }
        return $this->moduleManager;
    }

    /**
     * Устанавливает менеджер модулей
     *
     * @param ModuleManagerInterface $moduleManager
     *
     * @return $this
     */
    public function setModuleManager(ModuleManagerInterface $moduleManager)
    {
        $this->moduleManager = $moduleManager;

        return $this;
    }
}


1			<?php
2			/**
3			* @link https://github.com/nnx-framework/module
4			* @author Malofeykin Andrey <[email protected]>
5			*/
6			namespace Nnx\Module;
7
8			use Nnx\Module\Event\IntegrationModuleEvent;
9			use Zend\ModuleManager\ModuleManagerInterface;
10			use Zend\EventManager\EventManagerInterface;
11			use Zend\ModuleManager\ModuleEvent;
12			use Nnx\Module\Event\IntegrationModuleEventInterface;
13			use ReflectionClass;
14
15			/**
16			* Class IntegrationModuleTrait
17			*
18			* @package Nnx\Module\Options
19			*/
20			trait IntegrationModuleTrait
21			{
22			/**
23			* @see \Zend\EventManager\EventManagerAwareTrait::setEventManager
24			*
25			* @var array
26			*/
27			protected $eventIdentifier = [
28			IntegrationModuleInterface::class
29			];
30
31			/**
32			* Протип объекта, испольуземый для создания события бросаемого при инициализации интеграционного модуля
33			*
34			* @var IntegrationModuleEventInterface
35			*/
36			protected $prototypeIntegrationModuleEvent;
37
38			/**
39			* Имя класса, который должен имплементировать \Nnx\Module\Event\IntegrationModuleEventInterface. Данный класс
40			* используется для создания объекта прототипа события (@see \Nnx\Module\IntegrationModuleTrait::$prototypeIntegrationModuleEvent)
41			*
42			* @var string
43			*/
44			protected $prototypeIntegrationModuleEventClassName = IntegrationModuleEvent::class;
45
46			/**
47			* Менеджер модулей
48			*
49			* @var ModuleManagerInterface
50			*/
51			protected $moduleManager;
52
53			/**
54			* Приоритет обработчки отвечающего за проксирование события пост загрузки всех модулей. Для корректной работы
55			* интеграционного модуля, это значение должно быть больше, по приоритету чем значение свойства
56			* @see \Nnx\Module\Listener\IntegrationModuleListener::$configuringServiceModulesHandlerPriority
57			*
58			*
59			* при подписке на onLoadModulesPost в ServiceListener
60			* (@see \Zend\ModuleManager\Listener\ServiceListener::attach) и меньше чем
61			*
62			*
63			*
64			* @var int
65			*/
66			protected $loadModulesPostProxyHandlerPriority = 100;
67
68			/**
69			* @return EventManagerInterface
70			*/
71			abstract public function getEventManager();
72
73			/**
74			* Initialize workflow
75			*
76			* @param ModuleManagerInterface $manager
77			* @return void
78			*/
79			public function init(ModuleManagerInterface $manager)
80			{
81			$this->initIntegrationModule($manager);
82			}
83
84			/**
85			* Инициализация интеграционного модуля
86			*
87			* @param ModuleManagerInterface $manager
88			*/
89			public function initIntegrationModule(ModuleManagerInterface $manager)
90			{
91			$this->setModuleManager($manager);
92			$this->preInitIntegrationModule();
93
94			$manager->getEventManager()->attach(
95			ModuleEvent::EVENT_LOAD_MODULES_POST,
96			[$this, 'onLoadModulesPostProxyHandler'],
97			$this->loadModulesPostProxyHandlerPriority
98			);
99			}
100
101			/**
102			* Метод вызывается перед стандартным механизмом инициализаци. Используется для перегрузки в конкретном модуле.
103			*
104			* @return void
105			*/
106			protected function preInitIntegrationModule()
107			{
108			}
109
110			/**
111			* Обработчик события возникающего после загрузки модулей
112			*
113			* @throws Exception\ErrorCreateIntegrationModuleEventException
114			*
115			* @throws Exception\InvalidModuleManagerException
116			*/
117			public function onLoadModulesPostProxyHandler()
118			{
119			$event = clone $this->getPrototypeIntegrationModuleEvent();
120			$event->setName(IntegrationModuleEventInterface::INIT_INTEGRATION_MODULE_EVENT);
121			$event->setTarget($this);
122
123			$moduleManager = $this->getModuleManager();
124			$event->setModuleManager($moduleManager);
125
126			$event->setModule($this);
127
128			$this->getEventManager()->trigger($event);
129			}
130
131			/**
132			* Возвращает протип объекта, испольуземый для создания события бросаемого при инициализации интеграционного модуля
133			*
134			* @return IntegrationModuleEventInterface
135			*
136			* @throws Exception\ErrorCreateIntegrationModuleEventException
137			*/
138			public function getPrototypeIntegrationModuleEvent()
139			{
140			if ($this->prototypeIntegrationModuleEvent instanceof IntegrationModuleEventInterface) {
141			return $this->prototypeIntegrationModuleEvent;
142			}
143
144			$eventClassName = $this->getPrototypeIntegrationModuleEventClassName();
145
146			$r = new ReflectionClass($eventClassName);
147			$event = $r->newInstance();
148
149			if (!$event instanceof IntegrationModuleEventInterface) {
150			$errMsg = sprintf('Integration module event not implement %s', IntegrationModuleEventInterface::class);
151			throw new Exception\ErrorCreateIntegrationModuleEventException($errMsg);
152			}
153
154			$this->prototypeIntegrationModuleEvent = $event;
155
156			return $this->prototypeIntegrationModuleEvent;
157			}
158
159			/**
160			* Устанавливает протип объекта, испольуземый для создания события бросаемого при инициализации интеграционного модуля
161			*
162			* @param IntegrationModuleEventInterface $prototypeIntegrationModuleEvent
163			*
164			* @return $this
165			*/
166			public function setPrototypeIntegrationModuleEvent(IntegrationModuleEventInterface $prototypeIntegrationModuleEvent)
167			{
168			$this->prototypeIntegrationModuleEvent = $prototypeIntegrationModuleEvent;
169
170			return $this;
171			}
172
173			/**
174			* Возвращает имя класса, который должен имплементировать \Nnx\Module\Event\IntegrationModuleEventInterface. Данный класс
175			* используется для создания объекта прототипа события (@see \Nnx\Module\IntegrationModuleTrait::$prototypeIntegrationModuleEvent)
176			*
177			* @return string
178			*/
179			public function getPrototypeIntegrationModuleEventClassName()
180			{
181			return $this->prototypeIntegrationModuleEventClassName;
182			}
183
184			/**
185			* Устанавливает имя класса, который должен имплементировать \Nnx\Module\Event\IntegrationModuleEventInterface. Данный класс
186			* используется для создания объекта прототипа события (@see \Nnx\Module\IntegrationModuleTrait::$prototypeIntegrationModuleEvent)
187			*
188			* @param string $prototypeIntegrationModuleEventClassName
189			*
190			* @return $this
191			*/
192			public function setPrototypeIntegrationModuleEventClassName($prototypeIntegrationModuleEventClassName)
193			{
194			$this->prototypeIntegrationModuleEventClassName = $prototypeIntegrationModuleEventClassName;
195
196			return $this;
197			}
198
199			/**
200			* Возвращает менеджер модулей
201			*
202			* @return ModuleManagerInterface
203			*
204			* @throws Exception\InvalidModuleManagerException
205			*/
206			public function getModuleManager()
207			{
208			if (!$this->moduleManager instanceof ModuleManagerInterface) {
209			$errMsg = 'Module manager not installed';
210			throw new Exception\InvalidModuleManagerException($errMsg);
211			}
212			return $this->moduleManager;
213			}
214
215			/**
216			* Устанавливает менеджер модулей
217			*
218			* @param ModuleManagerInterface $moduleManager
219			*
220			* @return $this
221			*/
222			public function setModuleManager(ModuleManagerInterface $moduleManager)
223			{
224			$this->moduleManager = $moduleManager;
225
226			return $this;
227			}
228			}
229

nnx-framework / module

Push — master ( 10bbaf...0fa0d2 )

IntegrationModuleTrait::setModuleManager() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like