https://github.com/diego-ninja/blackmine

A full featured Redmine API client written in php8 with a lot of witchcraft and black magic in it.
https://github.com/diego-ninja/blackmine

api blackmine php redmine rest-api satis-enabled

Last synced: 8 months ago
JSON representation

A full featured Redmine API client written in php8 with a lot of witchcraft and black magic in it.

• Host: GitHub
• URL: https://github.com/diego-ninja/blackmine
• Owner: diego-ninja
• License: mit
• Created: 2021-10-22T15:18:59.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-26T16:03:30.000Z (over 2 years ago)
• Last Synced: 2025-06-05T07:05:39.644Z (about 1 year ago)
• Topics: api, blackmine, php, redmine, rest-api, satis-enabled
• Language: PHP
• Homepage:
• Size: 473 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

README

          
![Blackmine Logo](docs/assets/blackmine-logo-0001.png)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/blackmine/blackmine.svg?style=flat)](https://packagist.org/packages/diego-ninja/docker)

[![Total Downloads](https://img.shields.io/packagist/dt/blackmine/blackmine.svg?style=flat)](https://packagist.org/packages/diego-ninja/docker)

![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/blackmine/blackmine) 

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/diego-ninja/blackmine/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/diego-ninja/blackmine/?branch=main)

![Scrutinizer build (GitHub/Bitbucket)](https://img.shields.io/scrutinizer/build/g/diego-ninja/blackmine/main)

![GitHub](https://img.shields.io/github/license/diego-ninja/blackmine)

![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/diego-ninja/blackmine?include_prereleases)

# Blackmine

Blackmine is a full-featured Redmine API client written in [PHP8](https://www.php.net/releases/8.0/en.php). It implements a simple interface and converts responses into models and collections. 

# Installation

composer require blackmine/blackmine


# Quick example

```php

$options = new \Blackmine\Client\ClientOptions([

    ClientOptions::CLIENT_OPTION_BASE_URL => "https://your.redmine.url",

    ClientOptions::CLIENT_OPTION_API_KEY => "your.api.key"

]);

$client = new \Blackmine\Client\Client($options);

$issues = $client->getRepository("issues");

$data = $issues

    ->addFilter(Issues::ISSUE_FILTER_ISSUE_ID, [41432, 41436])

    ->with([Issues::ISSUE_RELATION_WATCHERS])

    ->search();

$issue = new \Blackmine\Model\Issue\Issue();

$issue->setSubject("Test Issue");

$issue->setDescription("An issue description, yeah, a real one...");

$issue->setStartDate(\Carbon\CarbonImmutable::create(2021, 10, 31));

$issue->setDueDate(\Carbon\CarbonImmutable::create(2022, 10, 31));

$issues->create($issue);

```

## Status

Actually only JSON format is supported, yeah, JSON is cool and XML isn't. If you think  XML is cool enough you can fork the project, start the feature/xml_is_cool branch and pull request your coolness.

Almost all exposed Redmine APIs are supported by Blackmine. There a few bugs that we are trying to fis as soon as possible.

Blackmine uses [Requests](https://requests.ryanmccue.info/) as transport layer, in a near or not so near future, I will try to pivot to a [PSR18](https://www.php-fig.org/psr/psr-18/) implementation. If you can't wait, you can fork the project, start the feature/psr18_or_death and pull request your hurry ups. 

Blackmine uses [Carbon](https://carbon.nesbot.com/) to manage dates.

## Things that are almost complete:

 - [Issues API](https://www.redmine.org/projects/redmine/wiki/Rest_Issues)

 - [Projects API](https://www.redmine.org/projects/redmine/wiki/Rest_Projects)

 - [Users API](https://www.redmine.org/projects/redmine/wiki/Rest_Users)

 - [Time Entries API](https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries)

 - [Issue Categories API](https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories)

 - [Issue Statuses API](https://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses)

 - [Issue Relations API](https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations)

 - [Trackers API](https://www.redmine.org/projects/redmine/wiki/Rest_Trackers)

 - [Groups API](https://www.redmine.org/projects/redmine/wiki/Rest_Groups)

 - [Versions API](https://www.redmine.org/projects/redmine/wiki/Rest_Versions)

 - [Roles API](https://www.redmine.org/projects/redmine/wiki/Rest_Roles)

 - [Custom Fields API](https://www.redmine.org/projects/redmine/wiki/Rest_CustomFields)

 - [Memberships API](https://www.redmine.org/projects/redmine/wiki/Rest_Memberships)

 - [Files API](https://www.redmine.org/projects/redmine/wiki/Rest_Files)

 - [Enumerations API](https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations)

 - [Attachments API](https://www.redmine.org/projects/redmine/wiki/Rest_Attachments)

 - [Wiki Pages API](https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages) (bugged)

 - [News API](https://www.redmine.org/projects/redmine/wiki/Rest_News)

 - Caching responses (with Tag/TTL invalidation mechanism)

 - Impersonating users (for admin users)

## Things that are incomplete:

 - Documentation

 - Search fluent API (80%)

 - Error handling and exceptions (0%)

 - Model functionality (50%)

 - Unit tests (0%)

 - Magic methods signatures on models and repositories (50%)

 - Date conversion from and to CarbonImmutable objects