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"，方法调用及其参数，除非出于“特殊情况”，如 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 系统集成的框架（稳定版）

贡献

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

但是，如果您认为在这里获得的信息对您有所帮助，并且这值得一些金钱，并且愿意捐赠，请随时通过以下方式捐赠任何金额：

[![](重要

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

在本版本（4.0.x）中，仅 NFe 功能性，对于 CTe 和 MDFe，应使用 3.10-Obsoleta 标签，至少直到其他贡献者愿意协助重构

开发版本

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

稳定版本

由于国家议会、各州 SEFAZ 和 Web 服务提供商不断进行的 schemas、webservice 和立法变化，MASTER 版本和最新标签是最稳定和功能性的。

使用 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正确方式
编码风格指南 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

memocashweb / nfephp

维护者

详细信息