typesetsh/laravel-wrapper

Typeset.sh wrapper for laravel 7-11

11.0.0 2024-03-13 11:18 UTC

Requires

• laravel/framework: ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0
• typesetsh/typesetsh: ^0.26.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ~v3.4.0

MIT

• Jacob Siefer
• Rouven Alexander Rieker

README

Typeset.sh wrapper for Laravel 7, 8, 9, 10 and 11

This is a laravel typeset.sh wrapper that lets you easily configure and use typeset.sh in your laravel project. Typeset.sh is a printcss layout and rendering engine written in PHP.

Installation

Make sure you have access to a valid composer token from typeset.sh.

Add typeset.sh package repository to composer and install the package via composer:

composer config repositories.typesetsh composer https://packages.typeset.sh
composer require typesetsh/laravel-wrapper

The package will be automatically discovered in your application thanks to package auto-discovery.

Usage

The wrapper works similar to the view. Technically it wraps the view and uses its html output and renders it as pdf.

Facade

You can use the facade pattern. Similar as you would render a view.

use Typesetsh\LaravelWrapper\Facades\Pdf;

Route::get('/invoice/print', function () {
    $invoice = new stdClass();

    return Pdf::make('invoice', ['invoice' => $invoice]);
});

Helper

Alternative you can use the helper.

Route::get('/invoice/print', function () {
    $invoice = new stdClass();

    return Typesetsh\pdf('invoice', ['invoice' => $invoice]);
});

or force a download

Route::get('/invoice/print', function () {
    $invoice = new stdClass();

    return Typesetsh\pdf('invoice', ['invoice' => $invoice])->forceDownload('invoice.pdf');
});

Configuration

Typeset.sh does not require much configuration. The only important aspect to understand is that by default typeset.sh does not allow including any external resources (image, css, fonts,...) unless specified.

See the configuration file config/typesetsh.php for more information. By default, typeset.sh has access to the public directory and any http(s) resources.

You can also publish the file using:

php artisan vendor:publish --provider="Typesetsh\LaravelWrapper\ServiceProvider"

License

This extension is under the MIT license.

However, it requires a version of typeset.sh to work.