Skip to content
A simple PHP Redmine API client, Object Oriented
Find file
Pull request Compare This branch is 332 commits behind kbsali:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib/Redmine
README.markdown
composer.json
example.php

README.markdown

PHP Redmine API

A simple Object Oriented wrapper for Redmine API, written with PHP5.

Uses Redmine API.

Features

  • Follows PSR-0 conventions and coding standard: autoload friendly
  • API entry points implementation state :
    • OK Attachments
    • NOK Groups - only partially implemented
    • OK Issues
    • OK Issue Categories
    • OK Issue Priorities
    • NOK Issue Relations - only partially implemented
    • OK Issue Statuses
    • OK News
    • OK Projects
    • NOK Project Memberships - only partially implemented
    • OK Queries
    • OK Roles
    • OK Time Entries
    • OK Time Entry Activities
    • OK Trackers
    • OK Users
    • OK Versions
    • NOK Wiki - only partially implemented

Todo

Limitations

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

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 >= 5.3.2 with cURL extension,

Autoload

The first step to use php-redmine-api is to download composer:

$ curl -s http://getcomposer.org/installer | php

Then create a composer.json file in the root of your project:

{
    "require": {
        "kbsali/redmine-api": "dev-master"
    }
}

... and install your dependencies using:

$ php composer.phar install

Basic usage of php-redmine-api client

<?php

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

$client = new Redmine\Client('http://redmine.example.com', '1234567890abcdfgh');

$client->api('user')->all();
$client->api('user')->listing();

$client->api('issue')->create(array(
    'project_id'  => 'test',
    'subject'     => 'some subject',
    'description' => 'a long description blablabla',
    'assigned_to' => 'user1',
));

see example.php

Thanks!

Contributors

  • Kevin Saliou (@kbsali)
  • William Suffill (@wsuff)
  • @marloscarmo
Something went wrong with that request. Please try again.