airlst/headless-browser-client

AirLST Headless Browser PHP Client

3.0.0 2024-11-14 16:09 UTC

Requires

• php: ^8.3
• guzzlehttp/guzzle: ^7.9.2

Requires (Dev)

• airlst/php-cs-fixer-config: ^2.3.0
• airlst/phpstan-config: ^7.0.0
• airlst/rector-config: ^4.3.2
• ergebnis/composer-normalize: ^2.43
• mockery/mockery: ^1.6.12
• phpunit/phpunit: ^11.2.8

MIT

• Orkhan Ahmadov

• airlst
• headless-browser
• headless-browser-client
• headless-browser-client-php

README

PHP Client to interact with AirLST Headless Browser service.

Installation

You can install the package via Composer:

composer require airlst/headless-browser-client

Usage

Initialize the headless browser client with your API key.

$headlessBrowser = new \AirLST\HeadlessBrowserClient\AirlstHeadlessBrowser('api-key-here');

Generate PDF from HTML

Using standard format

$headlessBrowser->pdf(
    '<p>html</p>', // html content
    [10, 10, 10, 10] // margins
    'A4', // page size
);

Using custom size

$headlessBrowser->pdf(
    '<p>html</p>', // html content
    [10, 10, 10, 10] // margins
    null, // Page size must be null otherwise it will override the custom width and height
    '80mm', // width
    '60mm', // height
);

Generate JPEG from HTML

$headlessBrowser->jpeg(
    '<p>html</p>', // html content
    80, // quality
);

Response

All methods return the \Airlst\HeadlessBrowserClient\Response object. Provides 2 public methods:

• temporaryUrl() - returns a temporary file URL stored in the S3 bucket. Expires in 5 minutes after generation
• contents() - downloads file from S3 bucket and returns contents of the file as string

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Orkhan Ahmadov
• All Contributors

License

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