m1guelpf / satis-api
Simple PHP Client for interacting with Satis instances
Fund package maintenance!
m1guelpf
Requires
- php: ^5.5|^7.0
- guzzlehttp/guzzle: ^6.1
This package is auto-updated.
Last update: 2024-10-17 05:16:24 UTC
README
This package makes it easy to interact with a instance.
Installation
You can install the package via composer:
composer require m1guelpf/satis-api
Usage
You can pass the Satis Instance URL when initializing the class
$satis = new \M1guelpf\SatisAPI\Satis('URL_TO_YOUR_SATIS_INSTANCE');
or you can skip the URL and use the url()
method later
$satis = new \M1guelpf\SatisAPI\Satis; $satis->url('URL_TO_YOUR_SATIS_INSTANCE');
you can also pass an array of headers to use, or use the headers() method
$satis = new \M1guelpf\SatisAPI\Satis('URL_TO_YOUR_SATIS_INSTANCE', $headers); // or $satis->headers($headers);
Get Packages
$satis->getPackages();
Get Composer File
$satis->getComposer();
Get Includes
$satis->getIncludes();
Get Custom
$satis->getCustom($relativeUrl, $parameters);
Get the Guzzle Client
$satis->getClient();
Set the Guzzle Client
$client = new \GuzzleHttp\Client(); // Example Guzzle client $satis->setClient($client);
where $client is an instance of \GuzzleHttp\Client
.
Changelog
Please see CHANGELOG for more information what has changed recently.
Security
If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker.
Credits
License
The Mozilla Public License 2.0 (MPL-2.0). Please see License File for more information.