README

Jira PHP for Laravel is a supercharged PHP API client that allows you to interact with the Jira API and the Service Desk API.

Note

This repository contains the integration code of the Jira PHP for Laravel. If you want to use the Jira PHP client in a framework-agnostic way, take a look at the devmoath/jira-php repository.

Get Started

Requires PHP 8.1+

First, install devmoath/jira-laravel via the Composer package manager:

composer require devmoath/jira-laravel

Next, publish the configuration file:

php artisan vendor:publish --provider="Jira\Laravel\ServiceProvider"

This will create a config/jira.php configuration file in your project, which you can modify to your needs using environment variables:

JIRA_USERNAME=USERNAME
JIRA_PASSWORD=PASSWORD
JIRA_HOST=jira.domain.com

Finally, you may use the Jira facade to access the available functions:

use Jira\Laravel\Facades\Jira;

$result = Jira::issues()->search();

echo $result['issues'][0]['key']; // KEY-1000

Usage

For usage examples, take a look at the devmoath/jira-php repository.

Contributing

Thank you for considering contributing to the Jira PHP for Laravel! The contribution guide can be found in the CONTRIBUTING.

Security Vulnerabilities

If you discover any security-related issues, please email hey@moath.dev instead of using the issue tracker.

License

Jira PHP for Laravel is an open-sourced software licensed under the MIT license.