m1guelpf/satis-api

Simple PHP Client for interacting with Satis instances

PHP Satis API Client

, _(*1)

This package makes it easy to interact with a instance., _(*2)

Installation

You can install the package via composer:, _(*3)

``` bash composer require m1guelpf/satis-api, <sub>(*4)</sub>

## Usage

You can pass the Satis Instance URL when initializing the class

``` php
$satis = new \M1guelpf\SatisAPI\Satis('URL_TO_YOUR_SATIS_INSTANCE');

or you can skip the URL and use the url() method later, <sub>(*5)</sub>

``` php $satis = new \M1guelpf\SatisAPI\Satis;, <sub>(*6)</sub>

$satis->url('URL_TO_YOUR_SATIS_INSTANCE');, <sub>(*7)</sub>

you can also pass an array of headers to use, or use the headers() method

``` php
$satis = new \M1guelpf\SatisAPI\Satis('URL_TO_YOUR_SATIS_INSTANCE', $headers);

// or

$satis->headers($headers);

Get Packages

``` php $satis->getPackages();, <sub>(*8)</sub>

### Get Composer File
``` php
$satis->getComposer();

Get Includes

``` php $satis->getIncludes();, <sub>(*9)</sub>

### Get Custom
``` php
$satis->getCustom($relativeUrl, $parameters);

Get the Guzzle Client

``` php $satis->getClient();, <sub>(*10)</sub>

### Set the Guzzle Client

``` php
$client = new \GuzzleHttp\Client(); // Example Guzzle client
$satis->setClient($client);

where $client is an instance of \GuzzleHttp\Client., <sub>(*11)</sub>

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*12)</sub>

Security

If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker., <sub>(*13)</sub>

Credits

• Miguel Piedrafita
• All Contributors

License

The Mozilla Public License 2.0 (MPL-2.0). Please see License File for more information., <sub>(*14)</sub>