Wallogit.com
2017 © Pedro Peláez
Laravel wrapper for Alfredo
This package is merely an Alfredo wrapper written for Laravel. It will ease a lot of the tasks provided from the Alfredo client., (*1)
Documentation, (*2)
Installation, (*3)
Usage * Create payload * Add source to payload * Create payload with converter type * Create payload with callback url for queues * Create payload with sources * Convert a payload * Stream a payload or converted payload * Queue a payload * Check if a queued payload has been converted * Get converted payload from queue * Stream converted payload from queue, (*4)
License, (*5)
The full documentation on Alfredo can be found here, (*7)
Add requirement to composer.json, (*10)
"issetbv/alfredo-laravel": "dev-master"
Update dependencies, (*11)
composer update
Publish configuration file, (*12)
php artisan config:publish issetbv/alfredo-laravel
Add Service Provider to the providers array in app/config/app.php, (*13)
'IssetBv\AlfredoLaravel\AlfredoServiceProvider',
Add Facade to the facades array in app/config/app.php, (*14)
'Alfredo' => 'IssetBv\AlfredoLaravel\Facade',
app/config/packages/issetbv/alfredo-laravel/config.php
$payload = Alfredo::makePayload();
Available: addHtml, addPdf, addUrl, (*18)
$payload = Alfredo::makePayload();
$payload->addUrl('http://isset.nl');
Create payload with converter type, (*19)
$payload = Alfredo::makePayloadWithConverter('htmltopdfjava');
Create payload with callback url for queues, (*20)
$payload = Alfredo::makePayloadWithCallback('http://example.com/callback_url');
Create payload with sources, (*21)
Available: html, pdf, url, (*22)
$payload = Alfredo::makePayloadWithSources(array(
array('url', 'http://isset.nl'),
array('html', '<html><thead></thead><tbody>Create payload with sources!</tbody></html>')
));
$payload = Alfredo::makePayload();
$payload->addHtml('<html><thead></thead><tbody>Converting a payload!</tbody></html>');
$pdf = Alfredo::convert($payload);
Stream a payload or converted payload, (*24)
Stream a payload:, (*25)
$payload = Alfredo::makePayload();
$payload->addHtml('<html><thead></thead><tbody>Streaming a payload!</tbody></html>');
$response = Alfredo::stream($payload); // returns a Response object
Stream a converted payload:, (*26)
$payload = Alfredo::makePayload();
$payload->addHtml('<html><thead></thead><tbody>Streaming a converted payload!</tbody></html>');
$pdf = Alfredo::convert($payload);
$response = Alfredo::stream($pdf); // returns a Response object
When using the queue, its necessary to set the callback url., (*28)
$payload = Alfredo::makePayloadWithCallback('http://example.com/callback_url');
$payload->addHtml('<html><thead></thead><tbody>Queueing a payload!</tbody></html>');
$response = Alfredo::queue($payload); // returns a JSON response
```json { "response":"Queued", "identifier":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, (*29)
<a name="check-if-a-queued-payload-has-been-converted"/>
**Check if a queued payload has been converted**
```php
if (Alfredo::checkQueuedPayload('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')) { // returns a boolean
// Payload has been converted and is ready to be downloaded
}
Get converted payload from queue, (*30)
$pdf = Alfredo::getQueuedPayload('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
Stream converted payload from queue, (*31)
$pdf = Alfredo::getQueuedPayload('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');
$response = Alfredo::stream($pdf);
MIT, (*32)
Laravel wrapper for Alfredo