README

🚨 THIS PACKAGE HAS BEEN ABANDONED 🚨

We don't use this package anymore in our own projects and there is an official package with Composer support, so that's why we have chosen to abandon it. We suggest using the official pdfcrowd/pdfcrowd package instead. Feel free to fork our code and maintain your own copy.

This is a API client for pdfcrowd.com. It is based on the pdfcrowd/pdfcrowd-php project but adjusted for usage with Composer. It also includes a Laravel service provider and unit tests.

Work in progress

This client is still under active development. What needs to be done:

Improve docs: in what way does this package differ from the original class?
Improve docs: add docblocks to all setters.
Improve docs: try to generate docs for complete class?
Tag a version and release!

Install

In order to make requests to the API you need to enable the PHP cURL library.

Via Composer

$ composer require swisnl/pdfcrowd-client

Laravel

We provide a service provider so you can use dependency injection of the Pdfcrowd class within your Laravel projects. If you don't use package auto-discovery, add the ServiceProvider to the providers array in config/app.php

Swis\PdfcrowdClient\PdfcrowdServiceProvider::class,

Then, publish the config file using:

php artisan vendor:publish --provider="Swis\PdfcrowdClient\PdfcrowdServiceProvider"

Usage

# instantiate client, Laravel users can use dependency injection
$client = new Pdfcrowd('username', 'api_key');
 
# convert HTML to PDF and output
echo $client->convertHtml($someHtml);
 
# convert URI to PDF and output
echo $client->convertUri('https://google.com');
 
# convert to PDF and write to file
$client->setOutputDestination(fopen('path/to/output.pdf', 'w');
$client->convertHtml($someHtml);
 
# retrieve the amount of available tokens
$tokens = $client->availableTokens();
 
# retrieve the amount of tokens used by the previous conversion
$tokens = $client->getUsedTokens();

A complete reference by Pdfcrowd is available at http://pdfcrowd.com/web-html-to-pdf-php/.

Basic examples are available in /examples.

Change log

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

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

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

Credits

License

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

swisnl / pdfcrowd-client

Maintainers

Details