README

本版本已停用（请勿使用!!）请使用sped-nfe

NFePHP是一个用于管理NFe发行者与各州SEFAZ服务之间通信的API。完全用PHP构建，可在任何操作系统上运行。要开始，请查看我们的Wiki页面。

不要忘记在NFePHP讨论组注册！

PULL REQUESTS（nfephp仓库已冻结版本，将不再更新）

尊敬的，在此仓库中，只接受与BUG和由SEFAZ推动的变更相关的修正的"PULL REQUESTS"。

不再接受对代码的更改、改进或新增功能和服务，所有这些改进都应提交到新的仓库SPED-XXX。

不久（至2017年中），此仓库将停止接受任何贡献并将被停用，以利于新的仓库!!! 为了保持新版本（4.1.x-dev）API的完整性，将保持"namespaces"，方法调用及其参数，除非是“非常规”原因，如SEFAZ强制这种变化。在使用新版本时，应注意类名命名，它已简化，以及资源如打印已被转移到其他仓库。

仓库重构

CTe、MDFe和其他结构已从本仓库移除，并迁移到其新的仓库，请参阅

SPED NFe 新的NFe类仓库（测试阶段）

SPED CTe 新的CTe类仓库（开发中）

SPED MDFe 新的MDFe类仓库（开发中）

SPED NFSe 新的NFSe类仓库（开发中）

其他组件也将有新的仓库，但暂时仍在此处。

SPED COMMON 新的通用类仓库，用于所有或多个项目。

SPED DA 生成文档打印的新仓库

POSPRINT 用于POS热敏打印机打印的框架（开发中）

SPED GNRE GNRE类仓库（稳定版）

除此之外，其他仓库也在建设中或已提供库

SPED EFD Sped EFD税务类仓库（开发中）

SPED RESTFUL 用于生成Sped文档的RestFul应用程序（开发中）

SPED CONSOLE 线命令资源集（开发中）

SPED DOCS NFePHP包的文档集合（过时，不完整和部分）

SPED EMISSOR 用于文档发射的“前端”应用程序（未开始）

SPED eSOCIAL eSocial类库的存储库（仅文档）

SPED SERIALIZER XML序列化的类库存储库（概念）

其他相关项目，但具有特定目的

SPED eFINANCEIRA eFinanceira类的存储库（稳定版本）

SPED eSFINGE 用于与TCE/SC的eSfinge系统集成框架（稳定版本）

CONTRIBUINDO

这是一个完全的开源项目，使用和修改它您无需支付任何费用。但是，为了继续维护它，需要有人做出贡献，无论是协助编码、编写文档还是进行测试和错误识别。

但是，如果您认为这里获得的信息对您有用，并且认为这值得一定的金钱，并愿意捐赠，请随时通过

重要

从本版本开始，版本号将遵循API自己的序列，而不再引用NFe、CTe等布局的版本。

在本版本（4.0.x）中，仅NFe功能正常，对于CTe和MDFe，必须使用3.10-Obsoleta标签，至少直到其他合作者愿意协助重构

开发版本

版本 4.0.x-dev（注意SEFAZ的3.10布局版本）

稳定版本

由于国会、州SEFAZ和Web服务提供商不断推动schema、web服务和法律的变更，因此MASTER版本和最新的TAG是最稳定和功能最齐全的。

使用Composer安装

在终端中，前往您项目的根目录，然后执行

composer require nfephp-org/nfephp

这会将API的依赖项添加到您的composer.json文件中。API将被下载并放置在“vendor”文件夹中，而autoload.php文件将被更新。

条件

要使用此API，需要具备PHP编程知识，了解语言的当前标准，并具备税务法规的基础。强烈建议研究以下网站的以下内容。

• NFe系统工作原理的文档 SEFAZ NFe
• CTe系统工作原理的文档 SEFAZ CTe
• MDFe系统工作原理的文档 SEFAZ MDfe
• Composer 文档 构建一个 composer.json
• 重要 PHP的正确方式
• Coding Style Guide PSR-2
• Autoload PSR-4

注意：电子服务发票（NFSe）没有统一的格式，API仅包含一些用于该目的的系统组装示例，但没有针对此类税务文件的真正功能API。

目标

API允许NFe发射程序与SEFAZ进行通信。API不是为了它自己发射NFe而创建的，考虑到所需的大量信息和每个发射者的特点和具体要求。

依赖

• composer https://getcomposer.org/
• Apache: https://httpd.apache.ac.cn/
• PHP 5.5+: https://php.ac.cn
• 第三方库
• FPDF：暂时用于生成PDF文档。请参阅http://www.fpdf.org/。应替换为ZendPdf类（由于PSR标准趋势、更活跃的维护和通过composer分发）。
• zendframework/zend-mail (v.2.x)：用于向电子税务文件的收件人发送电子邮件。
• zendframework/zend-barcode (v.2.x)：用于在PDF税务文件中生成128位条形码。
• soundasleep/html2text (v.0.2)：用于将电子邮件中的HTML消息转换为纯文本。用于电子邮件发送类。
• endroid/qrcode (v.1.x)：用于在NFCe中生成打印的QRCode。
• PHP扩展
• cURL：通常已随PHP 5.3+启用。请参阅http://br2.php.net/manual/book.curl.php和http://curl.haxx.se/。
• OpenSSL：通常已随PHP 5.3+启用。请参阅http://br2.php.net/manual/book.openssl.php和http://www.openssl.org/。
• mcrypt：通常已随PHP 5.3+启用。请参阅https://php.ac.cn/manual/book.mcrypt.php。
• imap：通常已随PHP 5.3+启用。请参阅https://php.ac.cn/manual/book.imap.php
• GD：通常已随PHP 5.3+启用。请参阅https://php.ac.cn/manual/book.image.php
• ZIP：需要从SEFAZ下载NFe。请参阅https://php.ac.cn/manual/en/book.zip.php
• Zlib：下载NFe后需要解压缩。请参阅https://php.ac.cn/manual/en/book.zlib.php

安装

有关安装的更多详细信息，请参阅https://github.com/nfephp-org/nfephp/wiki/Instalação。

快速入门

使用git clone --branch=develop https://github.com/nfephp-org/nfephp.git或下载最新稳定版本克隆存储库。

$ composer install
$ ./vendor/bin/phpunit

版本控制

为了透明度和对发布周期的清晰理解，并寻求保持与旧版本的兼容性，NFePHP的版本号将尽可能遵守以下标准。

发布将按以下格式编号

<major>.<minor>.<patch>

构建时将遵循以下指南

• 与旧版本不兼容的更改，将增加<major>。
• 在不破坏与旧版本兼容性的情况下添加新功能，将增加<minor>。
• 修复bug和其他更改，将增加<patch>。

如需更多信息，请访问 http://semver.org/。

开发

所有开发、错误修复、新增功能和测试应使用 develop 分支。在 master 分支上将是被认为稳定的代码。根据需求可能会出现新的分支，无论是为了维护旧版本还是为了进行错误修复。但只有这两个已建立的分支将永久维护。

错误跟踪器

发现了错误？请在这里告诉我们 GitHub！

https://github.com/nfephp-org/nfephp/issues

维护者（正在审查）

• NFe - Roberto L. Machado
• NFCe - Roberto L. Machado
• NFSe - 未定义
• CTe - 未定义
• MDFe - 未定义
• CLe - 未定义

拉取请求

为了您的拉取请求被接受，它必须遵循本文档中描述的标准 http://www.walkeralencar.com/PHPCodeStandards.pdf