README

用于生成 Sped 标准中使用的辅助文档的类

注意：此仓库包含“遗留”类，用于创建原始 NFePHP 项目的 PDF。但是，这些类已进行调整，一些功能可能缺失或与原始版本不同。

将从类中移除所有被认为不属于其范围的功能，并且不再接受与任何系统特定性相关的方法的添加。这些类应尽可能通用。

开发中（尚未完全准备就绪）

指南

以下是一般指南，供希望为代码构建和改进做出贡献的开发者参考。

由 Nicola Azuni 开发的一个基于 TCPDF 的新项目正在开发中。此新项目是 TCPDF 的一个进化版本，并且正在按照最先进的 PHP 实践进行构建。

因此，这些来自 sped-da 的类，作为 NFePHP 项目的遗留版本，将在 tc-lib-pdf tc-lib-pdf 达到可使用版本后进行重构。

类的结构

生成辅助文档时，应考虑以下因素：

• 此库应编写为 PHP7，将不会测试或接受在低于 PHP 5.6 的环境中使用（至少在其开发期间），并且从第一个稳定版本开始，只接受 PHP >= 7.0。
• 此包 "sped-da" 将成为其他包的（建议）依赖项，开发者有责任使用 composer 将其作为其应用的依赖项或不是。
• 主要类的渲染（Danfe、Dacte、Damdfe、Dacce 以及 NFCe，但有一些保留意见）应使用 PDF 或 HTML 进行。
• 这些主要类必须扩展 Da.php 类，这是基本构造器。
• 辅助文档可以从 XML 或每个包中设置的构造器类中渲染。也就是说，可以传递包含文档数据的类，也可以传递 XML 格式的文档。
• 应允许并简化创建包含多个文档的 PDF。
• 所有类都必须遵守 S.O.L.I.D. 原则，并符合 PSR-2 和 PSR-4。
• 所有方法都必须使用 phpunit 进行单元测试，以避免破坏类的功能。
• 将建立一种方案，只有在单元测试未失败的情况下才允许“拉取请求”。
• 对于特定的 NFC-e（消费者发票）情况，存在另一个可能用到的包，即 "posprint"，因为此辅助文档通常在 POS 打印机上打印，而 POS 打印机不适用于 PDF，并且需要接收其自己的语言（原始数据）。因此，“posprint”包可能成为此包的依赖项之一。
• 将数据转换为PDF需要使用一个积极维护的库，该库被大量程序员使用，并且至少满足PSR规范。对此点应给予高度关注，因为随着PHP7的引入，可能存在与未及时更新的库不兼容的问题。

贡献

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

此包已在Packgist上列出，是为了与Composer一起使用而开发的，因此不会提供任何替代安装方法。

在开发和测试阶段，此包应使用以下方式安装

composer require nfephp-org/sped-da:dev-master

或者还可以通过修改您的应用程序的composer.json文件来安装

"require": {
    "nfephp-org/sped-da" : "dev-master"
}

注意：在开发阶段使用此包时，别忘了将应用程序的composer.json文件中的"minimum-stability"属性从"stable"更改为"dev"，以接受开发包。

"minimum-stability": "dev"

稳定版本已可用（但某些类仍在开发中），可以安装如下

composer require nfephp-org/sped-da

或者还可以通过修改您的应用程序的composer.json文件来安装

"require": {
    "nfephp-org/sped-da" : "^0.1"
}

使用方法

DANFE

变更日志和版本信息

请关注CHANGELOG以获取有关最新更改的更多信息。

测试

所有测试都是针对PHPUNIT开发的

安全

如果您发现任何与安全相关的问题，请直接向包维护者发送电子邮件，而不是打开一个ISSUE。

致谢

Roberto L. Machado（所有者和开发者）

许可协议

此包可在LGPLv3或MIT许可（MIT）下使用。请参阅许可文件以获取更多信息。