README

Jira的PHP客户端

安装

通过Composer安装包

composer require scaramuccio/jira-php-client

使用方法

<?php

use Scaramuccio\Jira\JiraClientFactory;
use Scaramuccio\Jira\JiraClientOptions;
use Scaramuccio\Jira\JiraIssue;
use Scaramuccio\Jira\JiraIssueOptions;

$client = JiraClientFactory::create([
    JiraClientOptions::BASE_URI => 'https://mycompany.atlassian.net',
    JiraClientOptions::AUTHENTICATION_SCHEME => 'Basic',
    JiraClientOptions::AUTHENTICATION_CREDENTIALS => base64_encode('user:key'),
]);

$issue = new JiraIssue([
    JiraIssueOptions::PROJECT_KEY => 'PROJECT-1',
    JiraIssueOptions::TYPE => 'Bug',
    JiraIssueOptions::SUMMARY => 'Yet another test bug',
    JiraIssueOptions::DESCRIPTION => 'Created with the PHP Jira client.',
]);

$response = $client->createIssue($issue);

客户端选项

以下配置选项可用于实例化JiraClient

选项	类型	必需	描述
`JiraClientOptions::AUTHENTICATION_CREDENTIALS`	字符串	✔️	Bearer令牌，base64编码的用户名和密码，...
`JiraClientOptions::AUTHENTICATION_SCHEME`	字符串	✔️	`Basic`，`Bearer`，...
`JiraClientOptions::BASE_URI`	字符串	✔️	Jira实例的基础URI。例如：`https://mycompany.atlassian.net`
`JiraClientOptions::CONNECTION_TIMEOUT`	整数		连接超时的时间（秒）。默认为5。
`JiraClientOptions::HTTP_PROXY`	字符串		要使用的HTTP代理。例如：`user:pass@192.168.0.1`
`JiraClientOptions::HTTPS_PROXY`	字符串		要使用的HTTPS代理。例如：`user:pass@192.168.0.1`
`JiraClientOptions::NO_PROXY`	字符串		不使用代理的地址，为数组。例如：`["192.168.0.2", "192.168.0.3"]`

问题选项

以下配置选项可用于实例化JiraClient

选项	类型	必需	描述
`JiraIssueOptions::AFFECTS_VERSIONS`	字符串数组		受影响版本字段的值。例如：`["3.1", "3.2"]`
`JiraIssueOptions::CODE_BLOCK`	字符串		描述后的代码块。使用`\n`进行换行。
`JiraIssueOptions::COMPONENTS`	字符串数组		例如：`backend`
`JiraIssueOptions::DESCRIPTION`	字符串	✔️	问题描述。使用`\n`进行换行。
`JiraIssueOptions::PROJECT_KEY`	字符串	✔️	创建问题的项目的键。例如：`PROJECT-1`
`JiraIssueOptions::SUMMARY`	字符串	✔️	问题摘要。
`JiraIssueOptions::TYPE`	字符串	✔️	Jira问题类型。例如：`Bug`

scaramuccio / jira-php-client

维护者

详细信息

README

安装

使用方法

客户端选项

问题选项