Доступ к конфигурации модуля в Zend Framework 2

Question

Как я могу получить доступ к конфигурации моего модуля из контроллера?

Answer 1

Я действительно удивлен тем, насколько это неясно, потому что у меня была точно такая же проблема, и я не мог найти окончательный ответ.Можно подумать, что документация ZF2 скажет что-то об этом.В любом случае, используя метод проб и ошибок, я наткнулся на этот чрезвычайно простой ответ:

Внутренние функции контроллера:

$config = $this->getServiceLocator()->get('Config');

Внутренние функции класса модуля (файл Module.php):

$config = $e->getApplication()->getServiceManager()->get('Config');

, тогда как $e является экземпляром Zend\Mvc\MvcEvent

---

Как правило, конфигурация доступна из любого места, где у вас есть доступ к глобальному диспетчеру служб, так какКонфигурационный массив зарегистрирован как сервис с именем Config. (обратите внимание на верхний регистр C.)

Возвращает массив объединения application.config.php (глобального и локального) и вашего module.config.php.После этого вы можете получить доступ к элементам массива так, как вам нужно.

Несмотря на то, что ОП уже устарел, я надеюсь, что это сэкономит кому-то час или больше, которые понадобились мне, чтобы получить этот ответ.

Answer 2

Что именно вы хотите сделать в своем контроллере с конфигурацией модуля? Это что-то, что нельзя сделать, если контейнер DI вставит полностью сконфигурированный объект в ваш контроллер?

Например, В книге Роберта Аллена «Начало работы с Zend Framework 2» приведен пример внедрения сконфигурированного экземпляра Zend \ Db \ Table в контроллер:

return array(
'di' => array(
    'instance' => array(
        'alias' => array(
            'album' => 'Album\Controller\AlbumController',
        ),
        'Album\Controller\AlbumController' => array(
            'parameters' => array(
                'albumTable' => 'Album\Model\AlbumTable',
            ),
        ),
        'Album\Model\AlbumTable' => array(
            'parameters' => array(
                'config' => 'Zend\Db\Adapter\Mysqli',
        )),
        'Zend\Db\Adapter\Mysqli' => array(
            'parameters' => array(
                'config' => array(
                    'host' => 'localhost',
                    'username' => 'rob',
                    'password' => '123456',
                    'dbname' => 'zf2tutorial',
                ),
            ),
        ),
        ...

Если вам нужно выполнить дополнительную инициализацию после полной загрузки приложения, вы можете присоединить метод init к событию начальной загрузки в вашем классе Module. сообщение в блоге Мэтью Вейера О'Финни приводит следующий пример:

use Zend\EventManager\StaticEventManager,
Zend\Module\Manager as ModuleManager

class Module
{
    public function init(ModuleManager $manager)
    {
        $events = StaticEventManager::getInstance();
        $events->attach('bootstrap', 'bootstrap', array($this, 'doMoarInit'));
    }

    public function doMoarInit($e)
    {
        $application = $e->getParam('application');
        $modules     = $e->getParam('modules');

        $locator = $application->getLocator();
        $router  = $application->getRouter();
        $config  = $modules->getMergedConfig();

        // do something with the above!
    }
}

Подойдет ли любой из этих подходов?

Answer 3

Для чтения конфигурации только для модуля ваш модуль должен просто реализовать LocatorRegisteredInterface

До:

namespace Application;

class Module
{
   // ...
}

После:

namespace Application;

use Zend\ModuleManager\Feature\LocatorRegisteredInterface;

class Module implements LocatorRegisteredInterface
{
   // ...
}

Эта реализация говорит LocatorRegistrationListener для сохранения модуляintance в сервисном локаторе в виде пространства имен \ Module

Тогда в любом месте вы можете получить доступ к вашему модулю:

class IndexController extends AbstractActionController
{
    public function indexAction()
    {
        /** @var \Application\Module $module */
        $module = $this->getServiceLocator()->get('Application\Module');
        $moduleOnlyConfig = $module->getConfig();

        // ...
    }
} 

Answer 4

для Beta5, вы можете добавить такую ​​функцию в Module.php

public function init(ModuleManager $moduleManager)
{ 
    $sharedEvents = $moduleManager->getEventManager()->getSharedManager();
    $sharedEvents->attach(__NAMESPACE__, 'dispatch', function($e) {
          $config = $e->getApplication()->getConfiguration();
          $controller = $e->getTarget();
          $controller->config = $config;
    });
 }

в контроллере, вы можете получить конфигурацию:

print_r($this->config); 

Answer 5

Вам необходимо реализовать ServiceLocatorAwareInterface из вашей модели. И тогда вы можете установить setServiceLocator () и getServiceLocator (), которые дают вам прямой доступ к менеджеру сервиса. Взгляните на этот пример кода https://gist.github.com/ppeiris/7308289

Answer 6

Существует готовый запрос на извлечение , который извлекает класс модуля (т.е. модуля modules / foo / Module.php Foo\Module) из контейнера DI.Это дает несколько преимуществ, но вы также можете получить этот экземпляр модуля в другой раз, если у вас есть доступ к Zend\Di\Locator.

Если ваш контроллер действий расширяет Zend\Mvc\Controller\ActionController, тогда ваш контроллер - LocatorAware.Это означает, что при создании экземпляра ваш контроллер вводится локатором, который знает о модулях.Таким образом, вы можете извлечь класс модуля из DIC в вашем контроллере.Теперь, когда ваш модуль использует файл конфигурации и сохраняет его в экземпляре класса модуля, вы можете создать метод получения доступа к этим данным конфигурации из любого класса с помощью локатора.Возможно, у вас уже есть аксессор с вашим модулем Foo\Module::getConfig()

Хотя ZF2 находится в стадии разработки и, возможно, этот код изменится позже, эта функция в настоящее время охвачена этим тестом , с этимсамая важная часть:

$sharedInstance = $locator->instanceManager()->getSharedInstance('ListenerTestModule\Module');

$this->assertInstanceOf('ListenerTestModule\Module', $sharedInstance);

Таким образом, с $sharedInstance классом вашего модуля вы можете получить доступ к конфигурации оттуда.Я ожидаю сокращения для этой функции в ближайшее время, но это может быть сделано только после того, как PR # 786 был объединен с мастером ZF2.

Answer 7

вы также можете получить доступ к любому значению конфигурации в любом месте с помощью этого хака / хитрости

$configReader = new ConfigReader();
$configData = $configReader->fromFile('./config.ini');
$config = new Config($configData, true);

Answer 8

Я создал модуль с плагином контроллера и помощником вида для чтения конфигурации в контроллерах и представлениях. Ссылка GitHub __ Ссылка композитора

Установите его через композитор

composer require tasmaniski/zf2-config-helper

Зарегистрировать новый модуль " ConfigHelper"в вашем config / application.config.php файле

'modules' => array(
    '...',
    'ConfigHelper'
),

Используйте его в контроллере и просматривайте файлы

echo $this->configHelp('key_from_config'); // read specific key from config 

$config = $this->configHelp(); // return config object Zend\Config\Config
echo $config->key_from_config;