README

此包实现了一种解决方案，提供从 shell 输入创建发票的 Symfony 命令，并使用发票模板填写最终客户的发票。

版本

• BC 按小时发票的当前版本为 0.1.0

• 上次重大更新：2017年1月17日

版权

• BC 按小时发票版权所有 1999 - 2017 Brookins Consulting

• 更多信息请参阅 COPYRIGHT.md

许可证

BC 按小时发票受 GNU Affero 通用公共许可证的许可。

完整的许可证协议包含在 LICENSE 文件中。

BC 按小时发票是免费软件：您可以在 GNU Affero 通用公共许可证的条款下重新分发和/或修改它，该许可证由自由软件基金会发布，无论是许可证的第 3 版，还是（根据您的选择）任何较新版本。

BC 文档阅读器分发的目的是希望它是有用的，但没有任何保证；甚至没有关于其可销售性或适合特定用途的暗示性保证。有关详细信息，请参阅 GNU Affero 通用公共许可证。

您应已随 BC 按小时发票收到 GNU Affero 通用公共许可证的副本。如果没有，请参阅 https://gnu.ac.cn/licenses/。

GNU AGPL赋予您在特定条件下使用、修改和重新分发 BC 按小时发票的权利。GNU AGPL 许可证随软件一起分发，请参阅许可证文件。

它也可以在 https://gnu.ac.cn/licenses/agpl.txt 上找到

在 GNU GPL 的条款下使用 BC 按小时发票是免费的（指自由）。

有关更多信息或疑问，请联系：license@brookinsconsulting.com

要求

使用 BC 按小时发票扩展需要以下要求

Symfony 版本

• 请确保您使用 Symfony 版本 2.8+（必需）或更高版本。

• 设计和测试使用 Symfony 3.1.x

PHP 版本

• 请确保您有 PHP 7.x 或更高版本。

特性

命令

此解决方案提供以下 symfony 命令

• 命令：bc:hi:di:create

• 命令：bc:hi:di:dump

服务

• 帮助生成按小时发票文档的服务

依赖关系

• 此解决方案以任何方式都不依赖于 eZ 平台

用例要求

此解决方案旨在满足客户时间卡账单的一些常见需求。

我们通常将每日咨询时间以 15 分钟（行业标准）的增量记录在纯文本文件中。

此解决方案旨在通过简单的命令行命令简化这种会计。

安装

通过 Composer 安装包

从项目根目录运行以下命令以安装包

bash$ composer require brookinsconsulting/bchourlyinvoicebundle dev-master;

包激活

在文件 app/AppKernel.php 中的 registerBundles 方法中，将以下内容添加到 $bundles = array( 变量定义中。

// Brookins Consulting : BcHourlyInvoiceBundle Requirements
new BrookinsConsulting\BcHourlyInvoiceBundle\BcHourlyInvoiceBundle(),

安装变量

在 symfony 项目根目录下运行以下命令。

cd var;
ln -s ../vendor/brookinsconsulting/bchourlyinvoicebundle/Resources/var/bchourlyinvoice .;

这为 symfony 命令创建了一个 var 目录子目录结构，用于访问发票模板并存储生成的发票。

清除缓存

清除 eZ Publish Platform / eZ 平台缓存（必需）。

php bin/console cache:clear;

参数 / 发票定制

支持的文件扩展名和 MIME 类型

请查看 Resources/config/hourlyinvoice.yml 和 Resources/config/services.yml，了解默认支持的发票文档类型。

如果您希望支持更多文件格式和发票模板，请将它们添加到 yaml 设置中，并清除所有缓存（必需）。

注意：截至发布时，仅支持 PDF 发票。

用法

默认情况下，该解决方案在安装正确后配置为虚拟工作。

运行导出命令

要导出您的发票模板支持的表单字段变量，只需运行

php bin/console bc:hi:di:create;

运行创建命令

要从您的发票模板创建新的发票，只需运行

php bin/console bc:hi:di:create;

运行创建命令带 shell 参数

对于相同的输入的重复使用，您可以使用 shell 参数更快地生成发票。只需运行

php bin/console -vvv bc:hi:di:create --invoiceCustomerName="Manpow" --invoiceFileNameExtension="pdf" --invoiceStorageDirectory="var/bchourlyinvoice/generated/" --invoiceFileNameDateTimeStamp="true" --invoiceFlatten="true" --invoiceLineItemDate="01/01/2017" --invoiceCustomerAddressField1="1201 South Sherman St Ste 212" --invoiceCustomerAddressCity="Richerson" --invoiceCustomerAddressCountry="USA" --invoiceCustomerAddressRegion="Texas" --invoiceCustomerAddressPostalCode="75081" --invoiceLineItemDescription="Development of Invoice Creator" --invoiceLineItemPrice="75.00" --invoiceLineItemHours="10" --invoiceCustomerIdentifier="Manpow" --invoiceComment="Payment Due Upon Reciept" --invoiceFileName="bc_invoice_" --invoiceLineItemDeveloper="Brookins Consulting" --invoiceNumber="00001" --invoiceTaxPercentage="0" --invoiceMonetaryLocale="en_US"

测试

该解决方案配置为在安装和配置正确后工作。

注意：截至编写时，尚未实现 XSS 测试和适当的单元测试。

故障排除

阅读常见问题解答

一些问题比其他问题更常见。最常见的列表在 Resources/doc/FAQ.md 中。

支持

如果您在此文档或常见问题解答中发现了任何未处理的问题，您可以通过支持系统联系 Brookins Consulting： http://brookinsconsulting.com/contact