PHP JIRA Rest Client 使用教程

PHP JIRA Rest Client 使用教程

php-jira-rest-client PHP classes interact Jira with the REST API. 项目地址: https://gitcode.com/gh_mirrors/ph/php-jira-rest-client

1. 项目介绍

PHP JIRA Rest Client 是一个开源项目，它提供了一个 PHP 库来与 JIRA 的 REST API 进行交互。这个库可以让你方便地在 PHP 应用程序中创建、读取、更新和删除 JIRA 中的问题、项目和其他实体。

2. 项目快速启动

在开始使用 PHP JIRA Rest Client 前，请确保你的开发环境已经安装了 PHP 和 Composer。

安装

首先，使用 Composer 安装 PHP JIRA Rest Client：

composer require lesstif/php-jira-rest-client

然后，在你的 PHP 代码中引入 Composer 的自动加载文件：

require 'vendor/autoload.php';

配置

在 .env 文件中配置你的 JIRA 实例的必要信息：

JIRA_HOST=https://your-jira.host.com
JIRA_USER=jira-username
JIRA_PASS=jira-password-OR-api-token
TOKEN_BASED_AUTH=true
PERSONAL_ACCESS_TOKEN=your-access-token-here

使用 vlucas/phpdotenv 库来加载 .env 文件中的环境变量：

composer require vlucas/phpdotenv

在你的 PHP 代码中加载环境变量：

use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->load();

示例：创建一个 JIRA 问题

use JiraRestApi\Issue\IssueService;
use JiraRestApi\JiraException;

try {
    $issueService = new IssueService();

    $issue = new \JiraRestApi\Issue\Issue();
    $issue->setProjectKey('YOUR_PROJECT_KEY');
    $issue->setIssueType('1'); // 1 is the id of the 'Bug' issue type
    $issue->setSummary('A simple issue');
    $issue->setDescription('A simple description');

    $createIssue = $issueService->createIssue($issue);

    echo "Created issue ID: " . $createIssue->key;
} catch (JiraException $e) {
    echo 'Error Occured!' . $e->getMessage();
}

3. 应用案例和最佳实践

创建和管理 JIRA 项目

使用 PHP JIRA Rest Client，你可以轻松创建和管理 JIRA 项目。以下是一个创建新项目的例子：

use JiraRestApi\Project\ProjectService;
use JiraRestApi\Project\Project;
use JiraRestApi\JiraException;

try {
    $project = new Project();
    $project->setKey('NEW_PROJECT_KEY')
            ->setName('New Project')
            ->setDescription('This is a new project.');

    $projectService = new ProjectService();
    $newProject = $projectService->createProject($project);

    echo "New project created with ID: " . $newProject->id;
} catch (JiraException $e) {
    echo 'Error Occured!' . $e->getMessage();
}

搜索和管理 JIRA 问题

你可以使用 JQL (JIRA Query Language) 来执行复杂的问题搜索：

use JiraRestApi\Issue\Search;
use JiraRestApi\JiraException;

try {
    $search = new Search('project = YOUR_PROJECT_KEY');
    $issues = $search->doSearch();

    foreach ($issues->getIssues() as $issue) {
        echo "Issue: " . $issue->key . "\n";
    }
} catch (JiraException $e) {
    echo 'Error Occured!' . $e->getMessage();
}

4. 典型生态项目

PHP JIRA Rest Client 可以与多个生态系统项目集成，例如 Laravel、Symfony 等。以下是在 Laravel 中使用 PHP JIRA Rest Client 的基本步骤：

use JiraRestApi\Issue\IssueService;
use JiraRestApi\JiraException;

try {
    // 注册 JiraRestApiServiceProvider
    app()->register(JiraRestApi\JiraRestApiServiceProvider::class);

    // 创建 IssueService 实例
    $issueService = app()->make(IssueService::class);

    // 创建和管理 JIRA 问题...
} catch (JiraException $e) {
    echo 'Error Occured!' . $e->getMessage();
}

请确保在你的 config/app.php 文件中注册了服务提供者和门面。

php-jira-rest-client PHP classes interact Jira with the REST API. 项目地址: https://gitcode.com/gh_mirrors/ph/php-jira-rest-client