codeinc/cloudrun-gotenberg

Wrapper to use the Gotenberg HTTP client library with a CloudRun service

Maintainers

Details

github.com/codeinchq/cloudrun-gotenberg

Homepage

Source

Issues

Installs: 44

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.4 2024-02-17 00:57 UTC

Requires

Requires (Dev)

MIT 48e17c7c54635d74fb57c9815e4882a380d0a396

This package is auto-updated.

Last update: 2024-10-17 02:32:14 UTC

README

The PHP 8.2+ library provides an authenticated Gotenberg client using codeinc/cloudrun-auth-http-client to be used with a Gotenberg service running on Google Cloud Platform Cloud Run.

Installation

The library is available on Packagist. You can install it using Composer:

composer require codeinc/cloudrun-gotenberg

Usage

This library is modeled after the official Gotenberg PHP client. The methods of the class CodeInc\CloudRunGotenberg\CloudRunGotenberg are the same as the Gotenberg\Gotenberg class (but they are not static).

The requests are authenticated using codeinc/cloudrun-auth-http-client. A service account is required to authenticate the requests. Check this page to learn how to create and authorized a service account and obtain the service account key.

The following conversion examples are extracted from Gotenberg PHP client documentation.

use CodeInc\CloudRunGotenberg\CloudRunGotenberg;
use Gotenberg\Stream;

// Creates the Cloud Run Gotenberg client 
$cloudRunGotenberg = new CloudRunGotenberg(
    // Cloud Run service URL
    'https://my-service-12345-uc.a.run.app',
    // path to your service account key or array of credentials 
    '/path/to/your/service-account-key.json' 
);

// Converts a target URL to PDF and saves it to a given directory.
$filename = $cloudRunGotenberg->save(
    $cloudRunGotenberg->chromium()->pdf()->url('https://my.url'), 
    $pathToSavingDirectory
);

// Converts Office documents to PDF and merges them.
$response = $cloudRunGotenberg->send(
    $cloudRunGotenberg->libreOffice()
        ->merge()
        ->convert(
            Stream::path($pathToDocx),
            Stream::path($pathToXlsx)
        )
);

License

The library is published under the MIT license (see LICENSE file).