Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecodingmachine/gotenberg-php-client
PHP client for the Gotenberg API
https://github.com/thecodingmachine/gotenberg-php-client
api excel gotenberg html markdown pdf pdf-converter php powerpoint word
Last synced: 29 days ago
JSON representation
PHP client for the Gotenberg API
- Host: GitHub
- URL: https://github.com/thecodingmachine/gotenberg-php-client
- Owner: thecodingmachine
- License: mit
- Archived: true
- Created: 2018-04-17T12:21:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-29T07:45:51.000Z (over 1 year ago)
- Last Synced: 2024-10-03T02:22:17.757Z (2 months ago)
- Topics: api, excel, gotenberg, html, markdown, pdf, pdf-converter, php, powerpoint, word
- Language: PHP
- Homepage:
- Size: 404 KB
- Stars: 103
- Watchers: 15
- Forks: 21
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-gotenberg - PHP - thecodingmachine/gotenberg-php-client - Gotenberg **6.x** ⚠️ (Clients)
README
⚠️ For **Gotenberg 7.x**, use [gotenberg-/gotenberg-php](https://github.com/gotenberg/gotenberg-php) instead.
_This library is unmaintained and will not receive updates. Consider migrating to *Gotenberg 7.x* and the according new library instead._
# 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`:
```bash
$ composer require php-http/guzzle6-adapter
```
Then the PHP client:
```bash
$ composer require thecodingmachine/gotenberg-php-client
```
## Usage
```php
use TheCodingMachine\Gotenberg\Client;
use TheCodingMachine\Gotenberg\ClientException;
use TheCodingMachine\Gotenberg\DocumentFactory;
use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
use TheCodingMachine\Gotenberg\RequestException;
use GuzzleHttp\Psr7\LazyOpenStream;
# create the client.
$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');
# prepare the files required for your conversion.
# from a path.
$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
# ... or from your own stream.
$stream = new LazyOpenStream('/path/to/file', 'r');
$index = DocumentFactory::makeFromStream('index.html', $stream);
// ... or from a string.
$index = DocumentFactory::makeFromString('index.html', 'Foo');
$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);
$request->setScale(0.75);
# store method allows you to... store the resulting PDF in a particular destination.
$client->store($request, 'path/you/want/the/pdf/to/be/stored.pdf');
# if you wish to redirect the response directly to the browser, you may also use:
$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.
}
```
For more complete usages, head to the [documentation](https://gotenberg.dev/).
## Badges
[](https://travis-ci.org/thecodingmachine/gotenberg-php-client)
[](https://scrutinizer-ci.com/g/thecodingmachine/gotenberg-php-client/?branch=master)