README

基于 Zend Framework 2 的通过 CEP 查询地址的模块，支持数据库缓存

先决条件

需要在您的 zend 项目中安装 ORM [Doctrine] (http://www.doctrine-project.org/)。
您的 ORM 必须通过 serviceLocator 使用 'doctrine.entitymanager.orm_default' 响应

模块的差异化特点

默认返回 json 格式（无需额外参数）
使用数据库进行查询缓存。

待办事项

在可用的 web 服务之间进行轮询
在某个 web 服务响应失败时进行容错

安装

通过克隆安装

将项目 BrzCepModule 克隆到您的 Zend Framework 2 项目的 "./vendor" 或 "./module" 目录下

    $ cd PASTA_DO_SKELETON_DO_ZEND_FRAMEWORK2
    $ cd vendor
    $ git clone https://github.com/fbraz3/BrzCepModule.git

通过 composer 安装

在您的 composer.json 中添加项目 BrzCepModule

     "repositories": [
         {
           "type": "git",
           "url": "https://github.com/fbraz3/BrzCepModule"
         }
       ],
       "require": {         
         "fbraz3/brz-cep-module": "dev-master"
       },

执行 composer 的 "update" 或 "install" 命令以下载 BrzCepModule

    $ php composer.phar update

方法 2

执行 composer 的 "require" 命令以更新您的 composer.json 并下载 BrzCepModule

	php composer.phar require fbraz3/infanatica-cep-module dev-master

安装后

将以下内容添加到您的 application.config.php 文件中

    <?php
    return array(
        'modules' => array(
            // ...
            'BrzCepModule',
        ),
        // ...
    );

在您的数据库中执行 table.sql 文件

服务使用

示例在 \Application\Controller\InderController 中

	<?php
	//...
	class IndexController extends AbstractActionController
	{
		public function indexAction()
	    {
			$cep = '21041020';

			// Possíveis formatos (json, xml, query, object, array)
			// null = \BrzCepModule\Response\EnderecoResponse
			$formato        = 'json';

			$serviceLocator = $this->getServiceLocator();
			$cepService     = $serviceLocator->get('BrzCepModule\Service\CepService');
			$endereco       = $cepService->getEnderecoByCep($cep,$formato);
			var_dump($endereco);

	        return new ViewModel();
	    }
    //...

控制器使用

路由示例

\BrzCepModule\Controller\CepController

http[s]://domain/cep/CEP号码

http[s]://domain/cep/21041020

http[s]://domain/cep/CEP号码/输出格式

http[s]://domain/cep/21041020/json

http[s]://domain/cep/21041020/xml

CEP 搜索适配器参考

开发者

Felipe Braz (https://braz.dev/blog/)

基于项目 [InfanaticaCepModule] (https://github.com/Infanatica/InfanaticaCepModule)

fbraz3 / brz-cep-module

维护者

详细信息