2017 © Pedro Peláez
 

library redmine

Access layer for for Redmine. Available Clients: REST Api, Database

image

se/redmine

Access layer for for Redmine. Available Clients: REST Api, Database

  • Saturday, September 14, 2013
  • by sveneisenschmidt
  • Repository
  • 1 Watchers
  • 1 Stars
  • 6 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

redmine

Latest Stable Version, (*1)

Access layer for for Redmine, written in PHP., (*2)

Dev branch is master branch.

Build Status, (*3)

Installation

The recommended way to install is through Composer., (*4)

{
    "require": {
        "se/redmine": "dev-master"
    }
}

Usage

Pick a Client

``` php <?php, (*5)

use SE\Component\Redmine\Client\RestClient();, (*6)

$client = new RestClient('www.example.org/redmine', 'apiKey=c42ahcfg');, (*7)

// Or coming soon use SE\Component\Redmine\Client\DbClient();, (*8)

$client = new DbClient('www.example.org:3306', 'redmine_v21', 'user', 'pass');, (*9)


##### Unified API for all Clients
``` php
<?php

$repository = $client->getRepository('issues');

// Find all by criteria
$issues = $repository->findAll(array('status_id' => 'closed')); 
// $issues instanceof SE\Component\Redmine\Entity\Collection\Issues

// Find one by id & persist changes
$issue = $repository->find(2); // find by id
$issue->setSubject('New Title');
$repository->persist($issue);

// Create new Issue & save it
use SE\Component\Redmine\Entity\Issue;

$issue = new Issue();
$issue->setSubject('My First Issue');
$repository->persist($issue);

print $issue->getId(); // returns Id of newly create Issue, similar to Doctrine

Implemented Entities

  • [Issues] (https://github.com/sveneisenschmidt/redmine/blob/master/src/SE/Component/Redmine/Entity/Issue.php)
  • [News] (https://github.com/sveneisenschmidt/redmine/blob/master/src/SE/Component/Redmine/Entity/News.php)

Running Tests

vendor/bin/phpunit -c phpunit.xml.dist

Run a set of tests against a running redmine via editing constants in test/config.dist.php and calling phpunit with --group=live., (*10)

vendor/bin/phpunit -c phpunit.xml.dist --group=live

The Versions

14/09 2013

dev-master

9999999-dev https://github.com/sveneisenschmidt/redmine

Access layer for for Redmine. Available Clients: REST Api, Database

  Sources   Download

MIT

The Requires

 

The Development Requires

by Sven Eisenschmidt

database xml rest client redmine