Download the PHP package izap/redmine-api without Composer
On this page you can find all versions of the php package izap/redmine-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download izap/redmine-api
More information about izap/redmine-api
Files in izap/redmine-api
Package redmine-api
Short Description Redmine API client
License MIT
Homepage https://github.com/kbsali/php-redmine-api
Informations about the package redmine-api
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
- OK Groups
- OK Custom Fields
- OK Issues
- OK Issue Categories
- OK Issue Priorities
- NOK Issue Relations - only partially implemented
- OK Issue Statuses
- OK News
- OK Projects
- OK Project Memberships
- OK Queries
- OK Roles
- OK Time Entries
- OK Time Entry Activities
- OK Trackers
- OK Users
- OK Versions
- OK 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
- Maybe Guzzle for handling http connections
- https://github.com/guzzle/guzzle
Limitations
Redmine is missing some APIs for a full remote management of the data :
- List of activities & roles : http://www.redmine.org/issues/11464
- ...
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.4
- The PHP cURL extension
- The PHP SimpleXML extension
- The PHP JSON extension
- PHPUnit >= 4.0 (optional) to run the test suite
- "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
Install
Composer
Composer users can simply run:
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,
Manual
It is also possible to install the library oneself, either locally to
a project or globally; say, in /usr/share/php
.
First, download and extract the library somewhere. For example, the
following steps extract v1.5.1 of the library into the
vendor/php-redmine-api-1.5.1
directory:
Now, in any scripts that will use the Redmine
classes, include the
lib/autoload.php
file from the php-redmine-api directory. For
example,
Running the test suite
If you have PHPUnit >= 4.0 installed, you can
run the test suite to make sure that the library will function
properly on your system. Simply run phpunit
in the php-redmine-api
directory. For example,
Basic usage of php-redmine-api
client
See example.php
for further examples.
User Impersonation
As of Redmine V2.2 you can impersonate user through the REST API :
Thanks!
- Thanks to Thomas Spycher for the 1st version of the class.
- Thanks to Thibault Duplessis aka. ornicar for the php-github-api library, great source of inspiration!
- And all the contributors
- specially JanMalte for his impressive contribution to the test coverage! :)
All versions of redmine-api with dependencies
ext-curl Version *