开源软件名称：

开源软件地址：

开源编程语言：

开源软件介绍：

PHP Redmine API

A simple PHP Object Oriented wrapper for Redmine API.

Uses Redmine API.

Features

• Follows PSR-4 conventions and coding standard: autoload friendly
• Choose between using native cURL function or any PSR-18 http client like Guzzle for handling http connections
• API entry points implementation state:
  • ✔️ Attachments
  • ✔️ Groups
  • ✔️ Custom Fields
  • ✔️ Issues
  • ✔️ Issue Categories
  • ✔️ Issue Priorities
  • ❌ Issue Relations - only partially implemented
  • ✔️ Issue Statuses
  • ✔️ News
  • ✔️ Projects
  • ✔️ Project Memberships
  • ✔️ Queries
  • ✔️ Roles
  • ✔️ Time Entries
  • ✔️ Time Entry Activities
  • ✔️ Trackers
  • ✔️ Users
  • ✔️ Versions
  • ✔️ Wiki

Todo

• Check header's response code (especially for POST/PUT/DELETE requests)
• See http://stackoverflow.com/questions/9183178/php-curl-retrieving-response-headers-and-body-in-a-single-request/9183272#9183272

Limitations / Missing Redmine-API

Redmine is missing some APIs for a full remote management of the data:

• List of activities & roles: http://www.redmine.org/issues/11464
• Closing a project: https://www.redmine.org/issues/13725

A possible solution to this would be to create an extra APIs implementing the missing entry points. See existing effort in doing so: https://github.com/rschobbert/redmine-miss-api

Requirements

• PHP ^7.4 || ^8.0
• The PHP SimpleXML extension
• The PHP JSON extension
• "Enable REST web service" for your Redmine project (/settings/edit?tab=authentication)
• then obtain your API access key in your profile page : /my/account
• or use your username & password (not recommended)

Optional

• The PHP cURL extension if you want to use the native cURL functions.
• PHPUnit >= 9.0 (optional) to run the test suite

Install

Composer

Composer users can simply run:

$ php composer.phar require kbsali/redmine-api

at the root of their projects. To utilize the library, include Composer's vendor/autoload.php in the scripts that will use the Redmine classes.

For example,

<?php
// This file is generated by Composer
require_once 'vendor/autoload.php';

$client = new \Redmine\Client\NativeCurlClient('http://redmine.example.com', 'username', 'password');

Manual

It is also possible to install the library oneself, either locally to a project or globally; say, in /usr/share/php.

Download the library from php-download.com. The advantage of using this site is that no Composer installation is required. This service will resolve all composer dependencies for you and create a zip archive with vendor/autoload.php for you.

Than extract the library somewhere. For example, the following steps extract v1.6.0 of the library into the vendor/php-redmine-api-1.6.0 directory:

$ unzip kbsali_redmine_api_1.6.0.0_require.zip
$ rm kbsali_redmine_api_1.6.0.0_require.zip

Now, in any scripts that will use the Redmine classes, include the vendor/autoload.php file from the php-redmine-api directory. For example,

<?php
// This file ships with php-redmine-api
require 'vendor/php-redmine-api-1.6.0/vendor/autoload.php';

$client = new \Redmine\Client\NativeCurlClient('http://redmine.example.com', 'username', 'password');

Running the test suite

You can run test suite to make sure the library will work properly on your system. Simply run vendor/bin/phpunit in the project's directory :

$ vendor/bin/phpunit
PHPUnit 9.5.4 by Sebastian Bergmann and contributors.

Warning:       No code coverage driver available

...............................................................  63 / 432 ( 14%)
............................................................... 126 / 432 ( 29%)
............................................................... 189 / 432 ( 43%)
............................................................... 252 / 432 ( 58%)
............................................................... 315 / 432 ( 72%)
............................................................... 378 / 432 ( 87%)
......................................................          432 / 432 (100%)

Time: 00:00.149, Memory: 14.00 MB

OK (432 tests, 1098 assertions)

Basic usage of php-redmine-api client

Start your project

Create your project e.g. in the index.php by require the vendor/autoload.php file.

+<?php
+
+require_once 'vendor/autoload.php';

Instantiate a Redmine Client

You can choose between:

1. a native curl client or
2. the PSR-18 compatible client.

1. Native curl Client Redmine\Client\NativeCurlClient