ZF2配置来自没有控制器的模块

时间:2013-02-20 19:51:48

标签: php zend-framework2

我目前正在构建一个模块,作为多个项目中的可重用库,但由于它是一个库,因此不需要控制器。例如,我正在尝试做的是为Marketo soap API创建一个zf2模块。用户在/ROOT/config/autoload/local.php中添加其密钥和wsdl位置。配置包括类似'marketo'=> array(),

的内容

现在我遇到的问题是我想让自己和其他人使用该模块做类似的事情......

$marketo = new \Marketo\Client\Client();

并在\ Marketo \ Client \ Client()类中让构造函数读取$ config ['marketo']的数组键;

然而,我可以将所有这些放在一个ini文件中,但我更喜欢保持它与zf2中的其他所有内容类似的配置。

总而言之,我希望得到一个合并的zend配置的数组键,以便在类中使用...

class Marketo{
    private $key;
    private $pass;
    public function __construct(){
        $c = \Zend\Config\Config('marketo);
        $this->key = $c['key'];
        $this->pass = $c['pass'];
    }
}

============根据以下答案,从ZF 2.1.1开始全面运作解决方案=============

模块结构如下所示(使用新示例以便我可以重新开始)+表示目录名称 - 表示文件名

modules
  - Application /* Standard setup with an IndexController */
  - Cybersource /* The new module to be added */
      + config
         - module.config.php
      + src
         + Cybersource
            + Client
               - Client.php
            + ServiceFactory
               - ClientServiceFactory.php
      - Module.php
      - autoload_classmap.php

module.config.php     

return array(
    'service_manager' => array(
        'factories' => array(
            'Cybersource\Client\Client' => 'Cybersource\ServiceFactory\ClientServiceFactory',
        )
    ),
    'cybersource' => array(
        'Endpoint' => 'https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor', // test environment
        'WSDL' => 'https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_1.80.wsdl',
        'TXKey' => '',
        'MerchID' => '',
    ),
);

Client.php     

namespace Cybersource\Client;

class Client {

    private $config;

    public function __construct($config) {
        $this->config = $config;
    }

    public function getConfig() {
        return $this->config;
    }

}

ClientServiceFactory.php     

namespace Cybersource\ServiceFactory;

use Cybersource\Client\Client;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class ClientServiceFactory implements FactoryInterface {

    public function createService(ServiceLocatorInterface $serviceLocator) {
        $config = $serviceLocator->get('Config');

        return new Client($config['cybersource']);
    }

}

Module.php     

namespace Cybersource;
use Zend\ModuleManager\Feature\ConfigProviderInterface;

class Module implements ConfigProviderInterface {

    public function getAutoloaderConfig() {
        return array(
            'Zend\Loader\ClassMapAutoloader' => array(
                __DIR__ . '/autoload_classmap.php',
            )
        );
    }

    public function getConfig() {
        return include __DIR__ . '/config/module.config.php';
    }

}

autoload_classmap.php

<?php
// Generated by ZF2's ./bin/classmap_generator.php
return array(
    'Cybersource\Module'                              => __DIR__ . '/Module.php',
    'Cybersource\Client\Client'                       => __DIR__ . '/src/Cybersource/Client/Client.php',
    'Cybersource\ServiceFactory\ClientServiceFactory' => __DIR__ . '/src/ServiceFactory/ClientServiceFactory.php',
);

在application.config.php中激活模块后,我可以使用以下方法在我的应用程序模块的IndexController中使用它:

<?php


namespace Application\Controller;

use Zend\Mvc\Controller\AbstractActionController;
use Zend\View\Model\ViewModel;
class IndexController extends AbstractActionController {

    public function indexAction() {
        $c = $this->getServiceLocator()->get('Cybersource\Client\Client');
        $conf = $c->getConfig();
        var_dump($conf);
        return new ViewModel();
    }

}

上面的控制器输出会转储配置的输出,因为我将一个名为getConfig()的函数添加到Client类中以进行显示/测试。

再次感谢您的帮助。

2 个答案:

答案 0 :(得分:2)

您应该定义ServiceFactory来创建Client。 ServiceFactory可以获取合并的模块配置并在您的客户端上进行设置。你现在有了干净的分离,你的课程甚至可以在没有Zend \ Config的情况下重复使用。 如果您有许多配置选项,则可以创建一个扩展\Zend\StdLib\AbstractOptions的单独配置类,并将其传递给您的客户端。

namespace Marketo\Service;

class ClientServiceFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        //Get the merged config of all modules
        $configuration = $serviceLocator->get('Config');
        $configuration = $configuration['marketo'];

        $client = new \Marketo\Client\Client($configuration['key'], $configuration['pass']);
    }
}

现在在服务定位器中注册您的客户端工厂。在module.config.phpModule.php

中执行此操作
public function getServiceConfig()
{
    return array('factories' => array(
        'marketo_client' => 'Marketo\Service\ClientServiceFactory'
    );
}

用户现在可以从ServiceManager获取客户端。所有配置都整齐地设置。

$sm->get('marketo_client');

答案 1 :(得分:2)

您可能会定义如下的模块:

<?php

namespace Marketo;

use Zend\ModuleManager\Feature\ConfigProviderInterface;

class Module implements ConfigProviderInterface
{
    public function getConfig()
    {
        return array(
            'service_manager' => array(
                'factories' => array(
                    'Marketo\Client\Client' => 'Marketo\ServiceFactory\ClientServiceFactory',
                ),
            ),
            'marketo' => array(
                'key'  => 'DEFAULT',
                'pass' => 'DEFAULT',
            ),
        );
    }
}

注意:我更倾向于使用getConfig而不是getServiceConfig,因为它更灵活(可覆盖),并且在设置应用程序时会缓存方法调用。

然后是Marketo\ServiceFactory\ClientServiceFactory

<?php

namespace Marketo\ServiceFactory;

use Marketo\Client\Client;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class ClientServiceFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        $config = $serviceLocator->get('Config');

        return new Client($config['marketo']['key'], $value['marketo']['pass']);
    }
}

之后,您可以通过调用以下内容(例如在控制器中)从服务定位器中拉出Marketo客户端:

$marketoClient = $this->getServiceLocator()->get('Marketo\Client\Client');

此时,Marketo\Client\Client无论如何构建keypass都设置为DEFAULT

让我们继续并通过创建config/autoload/marketo.local.php文件(在您的应用程序根目录中,而不是在模块中)来覆盖它:

<?php

return array(
    'marketo' => array(
        'key'  => 'MarketoAdmin',
        'pass' => 'Pa$$w0rd',
    ),
);

这非常重要,因为您永远不应该重新发布keypass,因此请将此文件放入.gitignoresvn:ignore

所以基本上我们在这里做的是:

  1. 设置服务管理器配置以使用服务工厂实例化我们的Marketo客户端
  2. 设置服务工厂以使用合并配置(服务名称:'config')来实例化Marketo客户端
  3. 为实际应用程序实例添加本地配置
  4. 通过服务定位器检索Marketo服务。