owenvoke/unit3d

An object oriented PHP wrapper for the UNIT3D API

v0.1.0 2021-10-20 16:19 UTC

This package is auto-updated.

Last update: 2022-09-28 17:34:09 UTC


README

Latest Version on Packagist Software License Build Status Style CI Total Downloads Buy us a tree

An object oriented PHP wrapper for the UNIT3D API

Requirements

Install

Via Composer

composer require owenvoke/gitea guzzlehttp/guzzle:^7.4 http-interop/http-factory-guzzle:^1.2

We are decoupled from any HTTP messaging client with help by HTTPlug.

Usage

Basic usage

// Include the Composer autoloader
require_once __DIR__ . '/vendor/autoload.php';

$client = new \OwenVoke\UNIT3D\Client();
$repositories = $client->torrents()->all();

Authentication

use OwenVoke\UNIT3D\Client;
$client = new Client();
$client->authenticate($apiToken, null, Client::AUTH_ACCESS_TOKEN);

Self-hosted UNIT3D instances

The UNIT3D PHP wrapper can be configured to use a custom-hosted instance, rather than blutopia.xyz.

// Specify the URL of the UNIT3D instance on client initialization
$client = new \OwenVoke\UNIT3D\Client(null, 'https://unit3d.example.com');

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.