multi-downloader-client/README.md
Mathieu 472a6da5a6
Some checks failed
continuous-integration/drone/push Build is failing
readme
2024-01-11 14:23:45 +00:00

65 lines
1.1 KiB
Markdown

# multi-downloader-client
## Installation
Add repository in composer.json
```json
{
"repositories": [{
"type": "composer",
"url": "https://git.nwb.fr/api/packages/modules-communs-php/composer"
}
]
}
```
Then run composer require
```bash
composer require nwb/multi-downloader-client
```
## Env
The following env variables are used by default
```dotenv
MULTI_DOWNLOADER_API_KEY
MULTI_DOWNLOADER_URL
```
They can be overriden in the constructor
```php
use Nwb\MultiDownloaderClient\MultiDownloaderClient;
$client = new MultiDownloaderClient([
'apiKey' => '',
'url' => '',
])
```
## Usage
Ajouter des fichiers
```php
use Nwb\MultiDownloaderClient\MultiDownloaderClient;
use Nwb\MultiDownloaderClient\FileRequest;
$client = new MultiDownloaderClient();
$client->addFiles([
new FileRequest('http://example.com/image.png')
new FileRequest('http://example.com/image1.png')
]);
```
Get zip as string
```php
$zip = $client->downloadAsString();
```
Save zip to file (stream)
```php
$client->downloadTo('/tmp/my-zip.zip');
```
Get html form
```php
$form = $client->htmlForm();
```