PDFPipe

Symfony / quotes

Quote PDFs in Symfony

Post your quote HTML to a render API from a controller returning StreamedResponse, then wrap the response stream in a StreamedResponse. No browser binary in your Symfony deployment.

Why quotes become PDFs

A quote is an offer with an expiry, and it gets forwarded to people who will never log into your product. It has to stand alone and it has to be fixed at the moment it was sent. That is the difference between a document and a view of a database, and it is why sales teams keep asking for this.

What a quote has to carry

Before any of the code below matters, the template has to produce a document that is actually a quote. These are the fields that make it one, and the ones a reader or an auditor will look for first.

  • a quote reference, which the eventual order will cite
  • the validity date, after which the pricing no longer stands
  • each line with the price offered, which may not be list price
  • any discount shown as a discount rather than folded into the unit price
  • the terms attached to the offer: payment schedule, lead time, exclusions

Turning your Twig template into a document

You already have the markup. $this->renderView("invoice/pdf.html.twig", $data) gives you it as a string, which is the only input the render needs. Twig's asset() reads from the request context. In a console command or a message handler there is no request, so the base URL comes out empty and the paths in your markup are relative to nothing.

The Symfony implementation

HttpClientInterface is the client most projects here already have. The render happens in a controller returning StreamedResponse, and you wrap the response stream in a StreamedResponse.

php
<?php
// src/Controller/QuoteController.php

namespace App\Controller;

use Symfony\Component\HttpFoundation\StreamedResponse;
use Symfony\Contracts\HttpClient\HttpClientInterface;

class QuoteController extends AbstractController
{
    public function __construct(private HttpClientInterface $client) {}

    #[Route('/quotes/{id}.pdf', name: 'quote_pdf')]
    public function pdf(Quote $quote): StreamedResponse
    {
        $html = $this->renderView('quote/pdf.html.twig', ['quote' => $quote]);

        $upstream = $this->client->request('POST', 'https://api.pdfpipe.xyz/v1/pdf', [
            'auth_bearer' => $this->getParameter('pdfpipe.key'),
            'json' => [
                'html' => $html,
                'options' => ['format' => 'A4', 'printBackground' => true],
            ],
            'timeout' => 60,
        ]);

        // The transfer happens here, on first read, not on request() above.
        return new StreamedResponse(
            function () use ($upstream) {
                foreach ($this->client->stream($upstream) as $chunk) {
                    echo $chunk->getContent();
                }
            },
            200,
            ['Content-Type' => 'application/pdf'],
        );
    }
}

The CSS that makes a quote page correctly

The layout problem specific to this document is that optional line items and discount blocks make the length unpredictable, so the signature area must not orphan onto a page of its own. These rules handle it.

css
/* Backgrounds are dropped unless printBackground is set on the
   request, which is the usual reason a document renders in plain
   black and white when it looked right in the browser. */
@page {
  size: A4;
  margin: 18mm 16mm;
}

table { break-inside: avoid; }
h2    { break-after: avoid; }

What goes wrong in Symfony

Symfony's HttpClient is lazy. request() returns before the response arrives, and the actual transfer happens when you first read the content. That means your timeouts and your try/catch have to be around the read, not around the call, or a failed render surfaces somewhere unexpected.

What people try first

Most Symfony projects reach for KnpSnappyBundle, a wrapper around the same wkhtmltopdf binary, with the same requirement that the binary exists everywhere the app runs. 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 quote lives afterwards

Rendering is the short part. A quote is dead once it expires or converts, so retention is short and driven by the sales system rather than by law. What matters is that the version the customer received is the one you can produce later, because a disputed price is settled by the document that was sent.

Getting the document right

  • Check the validity date, since a quote without one is an open-ended commitment.
  • Generation is triggered by a salesperson sending it, so latency is felt directly by a person waiting, 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 quotes from Symfony?

No. The render happens over HTTP, so your Symfony deployment stays the size it is now. That is the main reason to use an API rather than KnpSnappyBundle, a wrapper around the same wkhtmltopdf binary, with the same requirement that the binary exists everywhere the app runs.

How do I stop a long quote using all the memory?

Wrap the response stream in a StreamedResponse. Symfony's HttpClient is lazy. request() returns before the response arrives, and the actual transfer happens when you first read the content. That means your timeouts and your try/catch have to be around the read, not around the call, or a failed render surfaces somewhere unexpected.

What has to be on a quote?

At minimum: a quote reference, which the eventual order will cite; the validity date, after which the pricing no longer stands; each line with the price offered, which may not be list price. The one to get right before anything else is the validity date, since a quote without one is an open-ended commitment.

Do I need to store the generated quotes?

Depends on the document, and this one has a clear answer: a quote is dead once it expires or converts, so retention is short and driven by the sales system rather than by law. What matters is that the version the customer received is the one you can produce later, because a disputed price is settled by the document that was sent.

Can I keep my existing quote template?

Yes, if it produces HTML. Whatever renders your quote 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 Symfony documents, and the same quote in other stacks.

100 free documents a month, no card.