README

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

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

将从类中移除所有被认为是与类范围不符的资源，并且不再接受与任何系统特定性相关的方法的添加。应该记住，这些辅助文档（Danfe、Dacte 和 Damdfe）的唯一目的是在运输过程中跟踪标记。它们不打算用作行政或操作信息的来源。对于这些功能，XML 更合适。这些类应尽可能遵循 SEFAZ 的指导方针。这些类应该尽可能通用和简单。如果您需要 DANFE 或任何其他文档在功能上与提供的不同，请创建自己的 PDF 生成器。

指导方针

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

此仓库中的类将被重构并分为 4 个其他仓库

• sped-da-common（包含用于创建 PDF 的通用类）
• sped-da-nfe（包含创建 NFe 文档 PDF 的类）
• sped-da-cte（包含创建 CTe 文档 PDF 的类）
• sped-da-mdfe（包含创建 MDFe 文档 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 进行单元测试，以避免破坏类的功能。
• 将建立一种方案，仅当单元测试通过时才允许“pull request”。
• 在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.3"
}

使用方法

DANFE

变更日志和版本

有关最近更改的更多信息，请关注CHANGELOG。

测试

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

安全

如果您发现任何安全问题，请直接向包维护者发送电子邮件，而不是创建ISSUE。

致谢

Roberto L. Machado（所有者和开发者）Newton Pasqualini Filho（简化版DANFE）

许可证

此包可供选择使用LGPLv3或MIT许可证（MIT）。有关更多信息，请参阅许可证文件。