README

本版本已停止维护（请勿使用！！）请使用 sped-nfe

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

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

在此存储库中，仅接受与 BUG 和由 SEFAZ 推动的更改相关的纠正的 "PULL REQUESTS"。

不再接受代码更改、改进或新功能或新服务的添加，所有这些改进都应发送到新的存储库 SPED-XXX。

不久（2017 年中旬之前），此存储库将停止接收任何贡献并停止维护，以利于新的存储库！为了保持新版本（4.1.x-dev）中的 API 完整性，将保持 "namespaces"、方法调用及其参数不变，除非是 "force majeure" 的情况，如 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

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

但如果你认为在这里获得的信息对你有用，并且这值得一些金钱，并且你愿意捐赠一些东西，你可以自由地通过

[![](https://stc.pagseguro.uol.com.br/public/img/botoes/doacoes/209x48-doar-assina.gif)](https://pag.ae/bkXPq4)

IMPORTANT

从本版本开始，版本号将遵循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

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

条件

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

NFe系统操作文档 SEFAZ NFe
CTe系统操作文档 SEFAZ CTe
MDFe系统操作文档 SEFAZ MDfe
Composer 文档构建composer.json 文档
重要 PHP do Jeito Certo
编码风格指南 PSR-2
自动加载 PSR-4

注意：电子服务发票（NFSe）没有唯一的格式标准，API只提供了一些构建此类系统示例的示例，但没有真正可用的API用于此类税务文件。

目标

该API允许NFe发行程序与SEFAZ通信。API不是为其自身发行NFe而创建的，考虑到所需信息的巨大数量以及每个发行者的特征和特定性。

依赖

composer https://getcomposer.org.cn/
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>。
修复错误和其他更改，推进<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 - 未定义

Pull Request

为了您的Pull Request被接受，它必须遵循本文件中描述的标准http://www.walkeralencar.com/PHPCodeStandards.pdf

softcomtecnologia / nfephp

维护者

详细信息