aedart/athenaeum-redmine

Redmine API Client for Laravel

Maintainers

Package info

github.com/aedart/athenaeum-redmine

Homepage

pkg:composer/aedart/athenaeum-redmine

Statistics

Installs: 20

Dependents: 0

Suggesters: 0

Stars: 0


README

A Laravel Redmine API Client, that has been designed to look and feel like an active record.

Example:

use Aedart\Redmine\Issue;
use Aedart\Redmine\Project;
use Aedart\Redmine\IssueCategory;
use Aedart\Contracts\Http\Clients\Requests\Builder;

// Create resources
$project = Project::create([
    'name' => 'Deus Ex',
    'identifier' => 'deus-ex'
]);

// Fetch list of resources, apply filters to http request...
$issues = Issue::fetchMultiple(function(Builder $request) {
    return $request->where('assigned_to_id', 'me');
});

// Change existing resources
$category = IssueCategory::findOrFail(1344);
$category->update([
    'name' => 'Business Goals'
]);

// ...or remove them
Issue::findOrFail(9874)
    ->delete();

Compatibility and Limitations

Please consult yourself with Redmine's Api documentation, and this package's documentation for details concerning compatibility and limitations.

Documentation

Please read the official documentation for additional information.

Repository

The mono repository is located at github.com/aedart/athenaeum

Versioning

This package follows Semantic Versioning 2.0.0

License

BSD-3-Clause, Read the LICENSE file included in this package