Laravel / contracts
Contract PDFs in Laravel
Post your contract HTML to a render API from a controller returning streamDownload, then return response()->streamDownload, which never holds the file. No browser binary in your Laravel deployment.
Why contracts become PDFs
A contract has to be fixed at signature. Both parties need to be certain they are looking at identical words, which a rendered page cannot guarantee. That is the difference between a document and a view of a database, and it is why legal and sales operations keep asking for this.
What a contract has to carry
Before any of the code below matters, the template has to produce a document that is actually a contract. These are the fields that make it one, and the ones a reader or an auditor will look for first.
- the parties, by legal entity name and registered number
- the effective date and the term
- numbered clauses with stable numbering, since amendments reference them
- the commercial schedule, usually as an annexe rather than in the body
- signature blocks with name, title and date for each party
Turning your Blade template into a document
You already have the markup. View("invoices.pdf", $data)->render() gives you it as a string, which is the only input the render needs. asset() and mix()/vite() emit URLs built from APP_URL. If APP_URL is still http://localhost in the environment that renders, every stylesheet and image in the document silently fails to load and you get a plain-text-looking PDF with no error.
The Laravel implementation
the Http facade is the client most projects here already have. The render happens in a controller returning streamDownload, and you return response()->streamDownload, which never holds the file.
<?php
// app/Http/Controllers/ContractController.php
namespace App\Http\Controllers;
use App\Models\Contract;
use Illuminate\Support\Facades\Http;
class ContractController extends Controller
{
public function pdf(Contract $contract)
{
// A Blade view built for print. Do not reuse the on-screen view: it pulls
// in the app layout and the asset tags, which cannot resolve here.
$html = view('contracts.pdf', ['contract' => $contract])->render();
$upstream = Http::withToken(config('services.pdfpipe.key'))
->timeout(60)
->withOptions(['stream' => true])
->post('https://api.pdfpipe.xyz/v1/pdf', [
'html' => $html,
'options' => ['format' => 'A4', 'printBackground' => true],
])
->throw();
return response()->streamDownload(
fn () => fpassthru($upstream->getBody()->detach()),
"contract-{$contract->reference}.pdf",
['Content-Type' => 'application/pdf'],
);
}
}The CSS that makes a contract page correctly
The layout problem specific to this document is that numbered clauses with cross-references, where a page break in the wrong place separates a clause from the term it defines. These rules handle it.
/* A clause must not be separated from the term it defines, and a
signature block alone on a final page invites a dispute. */
.clause { break-inside: avoid; }
.signatures { break-inside: avoid; break-before: avoid; }
p { orphans: 3; widows: 3; }
@page { size: A4; margin: 25mm 20mm; }What goes wrong in Laravel
Blade views for PDFs get built by copying the on-screen view, which brings @vite, the app layout and the Livewire scripts with it. Those either fail to resolve or render as visible artefacts. Start the PDF view from an empty file.
What people try first
Most Laravel projects reach for barryvdh/laravel-dompdf, which is convenient because it installs with Composer and needs nothing else, and limiting because dompdf implements its own layout engine with no support for flexbox or grid. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.
Where the contract lives afterwards
Rendering is the short part. A contract is retained for the term plus the limitation period, which typically means well over a decade. Immutability matters more here than anywhere else on this list: both parties must be able to prove the words have not moved.
Getting the document right
- Check the parties and the effective date, which is what every later dispute turns on.
- Generation is triggered by agreement being reached, often with a signature workflow following, so size the timeout for that path rather than for a health check.
- These are produced one at a time by a person who is waiting, so latency is felt directly.
- Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.
Frequently asked
Do I need Chromium installed to generate contracts from Laravel?
No. The render happens over HTTP, so your Laravel deployment stays the size it is now. That is the main reason to use an API rather than barryvdh/laravel-dompdf, which is convenient because it installs with Composer and needs nothing else, and limiting because dompdf implements its own layout engine with no support for flexbox or grid.
How do I stop a long contract using all the memory?
Return response()->streamDownload, which never holds the file. Blade views for PDFs get built by copying the on-screen view, which brings @vite, the app layout and the Livewire scripts with it. Those either fail to resolve or render as visible artefacts. Start the PDF view from an empty file.
What has to be on a contract?
At minimum: the parties, by legal entity name and registered number; the effective date and the term; numbered clauses with stable numbering, since amendments reference them. The one to get right before anything else is the parties and the effective date, which is what every later dispute turns on.
Do I need to store the generated contracts?
Depends on the document, and this one has a clear answer: a contract is retained for the term plus the limitation period, which typically means well over a decade. Immutability matters more here than anywhere else on this list: both parties must be able to prove the words have not moved.
Can I keep my existing contract template?
Yes, if it produces HTML. Whatever renders your contract view today can render the same markup for the PDF, which is why the CSS above is the only new thing you write.
Related
Other Laravel documents, and the same contract in other stacks.
Invoice PDFs in Laravel
an invoice is a legal record of a demand for payment
Receipt PDFs in Laravel
a receipt is proof a payment happened
Report PDFs in Laravel
a report is a snapshot of numbers at a moment in time. Its whole value is that it does not change when the underlying dashboard does.
Contract PDFs in Node.js
Using fetch, in a route handler that returns the response body directly.
Contract PDFs in Python
Using httpx, in an async endpoint that returns a streaming response.
Contract PDFs in PHP
Using cURL, in a controller action that echoes the body with a PDF Content-Type.
The same thing in plain PHP
Without the framework, using cURL directly.
When the output is wrong
Blank pages, missing backgrounds, breaks in the wrong place, by symptom.
All stacks and documents
The full grid of what this covers.
100 free documents a month, no card.