soliantconsulting/jira-issue-collector

此包已被弃用且不再维护。未建议替代包。

这是一个将 Jira 问题收集器注入到 Zend\Mvc 响应体中的 Zend 框架模块。

1.0.0 2015-11-30 03:09 UTC

This package is auto-updated.

Last update: 2022-05-16 01:50:48 UTC


README

Build Status Code Climate Test Coverage Latest Stable Version Latest Unstable Version Total Downloads License

Jira 问题收集器模块是一个快速、方便且免费的 Zend 框架模块,由 Soliant Consulting, Inc. 设计,旨在通过配置动态添加 Jira 问题收集器。

Jira 问题收集器模块是一个轻量级包,允许在触发标准 EVENT_FINISH 时将 Jira 问题收集器 注入到 Zend\Mvc 响应体中。

Jira 问题收集器模块兼容 Composer,因此很容易将其添加到任何现有的 Zend 框架 MVC 应用程序中。

易于集成

  • PSR-0 自动加载 (Composer 适配)。
  • 根据环境特定的要求,使用严格的 config/autoload/ 设置进行安装。

系统要求

  • PHP 5.5+
  • Zend Framework 2.5+

理论上,在最小努力的情况下,它应该可以使用更旧的 PHP 和 Zend Framework 2 版本,但是向后兼容性未经过验证或维护。如果您需要回退到 PHP 5.4 之前,那么除非您重构它,否则使用短数组语法肯定会阻止您。

许可证

Jira 问题收集器模块可用于商业和非商业用途,并许可在商业友好的标准 MIT 许可证下。

Jira 问题收集器模块文档

创建您的 Jira 问题收集器

请参阅 Jira 问题收集器 文档进行基本设置。一旦配置完成,您需要复制 Jira 为问题收集器创建的代码片段中的 URL。Jira UI 中的文字可能会变化,但您将有两个类似以下选项

  • 嵌入到 HTML 中
  • 嵌入到 JavaScript 中

实际上,它们都使用 JavaScript,如果它们被标记为这样会更为明确

  • 不要使用 Jquery
  • 使用 Jquery

不必担心配置的细节,直到我们到达下一节,但在这里提供您在设置 Jira 问题收集器时需要了解的基本细节。

假设 Jquery 可能不是您项目的一部分,默认且最基本配置如下所示

'soliant-jira-issue-collector' => [
    'enabled'       => true,
    'collector'     => [
        'url'       => "https://jira.myserver.com/really-long-url",
    ],
],

如果您打算使用 Jquery,并且想要访问高级选项,您需要启用 Jquery 支持

'soliant-jira-issue-collector' => [
    'enabled'       => true,
    'collector'     => [
        'useJquery' => true,
        'url'       => "https://jira.myserver.com/really-long-url",
    ],
],

注意:每个问题收集器的URL都是唯一的,并且在两个选项之间略有不同,因此如果您更改问题收集器的设置,请确保同时更新模块配置。您需要从Jira为您创建的代码片段中复制URL,因为您不需要配置中的其余代码。

基本安装

Jira问题收集器模块的安装方式与任何标准的Zend Framework模块相同。

Composer

通过将模块添加到您的composer.json或通过运行以下命令来安装模块:

composer require soliantconsulting/jira-issue-collector:~1.0

添加模块命名空间

Soliant\JiraIssueCollector模块添加到您的config/application.config.php的模块部分。

添加模块配置

将此模块中的config/soliant-jira-issue-collector.local.php.dist复制到您的项目中的config/autoload/soliant-jira-issue-collector.local.php。根据您的需求更改其中的任何设置。

高级选项

config/soliant-jira-issue-collector.local.php.dist中的注释提供了有关模块提供的详细高级设置。简而言之,模块为以下功能提供可选支持

  • 为Jira问题选择器中的该选项自定义CSS选择器
  • 自定义脚本模板
  • 注入自定义的div标签模板
  • 注入自定义的CSS样式标签模板