Download the PHP package fr3nch13/cakephp-jira without Composer

CakePHP Jira Plugin

This is a CakePHP 4.x plugin to interact with your Jira Server.

This makes heavy use of lesstif/php-jira-rest-client's project as essentially a CakePHP specific wrapper around that project.

Installation

You can install this plugin into your CakePHP application using composer.

Either run the following command (may vary on how you have composer installed):

Or add the below to your composer.json file:

Then run:

Setup

In your src/Application.php's bootstrap() method, add the following:

Load the helper in your src/View/AppView.php's initialize() method:

This plugin makes use of josegonzalez/dotenv. If you're using his extension, than put the below in your config/.env file:

This plugin's src/Plugin.php's bootstrap() will automatically read these into Cakephp's Configure static class.

If you're not using dotenv, then put this in your config/app.php file:

Usage

The primary entry point is the Jira Helper.

I have also added the ability to send Issues to your Jira server.

The 2 default/preconfigured Issues are Bugs and Feature Requests, but you can configure your own as well.

To create your own Issue setup, see these as examples:

• Fr3nch\Jira\Controller\TestsController
• Fr3nch\Jira\Form\TestForm <-- How you define another Issue type. see the __construct() method.
• templates/Tests/add.php
• templates/Tests/thankyou.php

In my particular instance, I have the links as part of a dropdown menu in my apps' header. My apps use the AdmilLte/bootstrap template/frontend, so if you want, you can include the element existing here like so:

In case you want to see how I'm creating the link to the pages, see the templates/element/nav-links.php file.

If you want to overwrite the plugin templates, do so like you're supposed according to the CakePHP Documentation.

Version compatibility

The major versions are locked to the major versions of CakePHP.

• Jira 1.x is locked to CakePHP ^3.8
• Jira 2.x is locked to CakePHP ^4.0

Contributing

Rules are simple:

• New feature needs tests.

• All tests must pass.

• 1 feature per PR

We would be happy to merge your feature then.

Notes

• I've inlcuded the composer.lock file, and if you're forking/pull requesting, you should use it/update it as well. This way our environment is as close as possible. This helps in debugging/replicating an issue.