🐘 📜 PHP client for the Gotenberg API
Switch branches/tags
Nothing to show
Clone or download

README.md

Gotenberg PHP client

A simple PHP client for interacting with a Gotenberg API.

Install

Unless your project already have a PSR7 HttpClient, install php-http/guzzle6-adapter:

$ composer require php-http/guzzle6-adapter

Then the PHP client:

$ composer require thecodingmachine/gotenberg-php-client

Usage

<?php

namespace YourAwesomeNamespace;

use TheCodingMachine\Gotenberg\Client;
use TheCodingMachine\Gotenberg\ClientException;
use TheCodingMachine\Gotenberg\DocumentFactory;
use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
use TheCodingMachine\Gotenberg\RequestException;

class YourAwesomeClass {
    
    public function yourAwesomeMethod()
    {
        $client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
        # or the following if you want the client to discover automatically an installed implementation of the PSR7 `HttpClient`.
        $client = new Client('http://localhost:3000');
        
        # HTML conversion example.
        $index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
        $header = DocumentFactory::makeFromPath('header.html', '/path/to/file');
        $footer = DocumentFactory::makeFromPath('footer.html', '/path/to/file');
        $assets = [
            DocumentFactory::makeFromPath('style.css', '/path/to/file'),
            DocumentFactory::makeFromPath('img.png', '/path/to/file'),
        ];
        
        try {
            $request = new HTMLRequest($index);
            $request->setHeader($header);
            $request->setFooter($footer);
            $request->setAssets($assets);
            $request->setPaperSize(Request::A4);
            $request->setMargins(Request::NO_MARGINS);
            
            # store method allows you to... store the resulting PDF in a particular folder.
            # this method also returns the resulting PDF path.
            $filePath = $client->store($request, 'path/to/folder/you/want/the/pdf/to/be/store');
            
            # if you wish to redirect the response directly to the browser, you may also use:
            $response = $client->post($request);
            
        } catch (RequestException $e) {
            # this exception is thrown if given paper size or margins are not correct.
        } catch (ClientException $e) {
            # this exception is thrown by the client if the API has returned a code != 200.
        } catch (\Exception $e) {
            # some (random?) exception.
        }
    }  
}

For more complete usages, head to the documentation.

Badges

Travis CI Scrutinizer