Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] Document invoice renderer #7639

Merged
merged 3 commits into from
Jan 31, 2022
Merged

[8.x] Document invoice renderer #7639

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dcd972d
Update billing.md
driesvints Jan 31, 2022
317464e
Update billing.md
taylorotwell Jan 31, 2022
7e62515
Update billing.md
taylorotwell Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update billing.md
  • Loading branch information
@taylorotwell
taylorotwell authored Jan 31, 2022
commit 317464e459ddc8ed3fc6d1ba5d72cfa68e965208
17 changes: 12 additions & 5 deletions billing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1589,24 +1589,31 @@ The `downloadInvoice` method also allows for a custom filename via its third arg
<a name="custom-invoice-render"></a>
#### Custom Invoice Renderer

Cashier also makes it possible to use a custom invoice renderer. By default, the `DompdfInvoiceRenderer` is used which makes use of [dompdf](https://github.com/dompdf/dompdf) to generate Cashier's invoices. However, you may implement any renderer you wish.

Say, for example, you want to render an invoice PDF using an API call:
Cashier also makes it possible to use a custom invoice renderer. By default, Cashier uses the `DompdfInvoiceRenderer` implementation, which makes use of the [dompdf](https://github.com/dompdf/dompdf) PHP library to generate Cashier's invoices. However, you may use any renderer you wish by implementing the `Laravel\Cashier\Contracts\InvoiceRenderer` interface. For example, you may wish to render an invoice PDF using an API call to a third-party PDF rendering service:

use Illuminate\Support\Facades\Http;
use Laravel\Cashier\Contracts\InvoiceRenderer;
use Laravel\Cashier\Invoice;

class ApiInvoiceRenderer implements InvoiceRenderer
{
/**
* Render the given invoice and return the raw PDF bytes.
*
* @param \Laravel\Cashier\Invoice. $invoice
* @param array $data
* @param array $options
* @return string
*/
public function render(Invoice $invoice, array $data = [], array $options = []): string
{
$html = $invoice->view($data)->render();

return Http::get('https://example.com/html-to-pdf', ['html' => $html])->get()->body();
}
}
Then replace the `cashier.invoices.renderer` config option with your new class.

Once you have implemented the invoice renderer contract, you should update the `cashier.invoices.renderer` configuration value in your application's `config/cashier.php` configuration file. This configuration value should be set to the class name of your custom renderer implementation.

<a name="checkout"></a>
## Checkout
Expand Down