kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[Docs] How to customize the invoice logo - updated cookbook

Browse source
This commit is contained in:
Rafikooo 2021-12-26 16:51:55 +01:00
parent 907fcc0e96
commit b56af8d517
No known key found for this signature in database
GPG key ID: 4A26D8327BC2442B
2 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_images/cookbook/custom-invoice/pdf_with_custom_logo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 113 KiB

27
docs/cookbook/payments/custom-invoice.rst
View file

@ -23,10 +23,35 @@ Before you start make sure that you have:
#. `Sylius/InvoicingPlugin <https://github.com/Sylius/InvoicingPlugin/>`_ installed.
#. `Wkhtmltopdf <https://wkhtmltopdf.org/>`_ package installed, because most of pdf generation is done with it.
How to change the logo in the Invoice?
----------------------------------------
In order to change the logo on the invoice, set up the ``SYLIUS_INVOICING_LOGO_FILE`` environment variable.
Example custom configuration:
.. code-block:: text
SYLIUS_INVOICING_LOGO_FILE=%kernel.project_dir%/assets/custom-logo.png
Make sure to clear the cache each time the configuration is changed.
If you have a permission issue when generating an invoice, you may also need to update the ``config/packages/knp_snappy.yaml`` configuration file:
.. code-block:: yaml
knp_snappy:
pdf:
options:
allow: '%env(resolve:SYLIUS_INVOICING_LOGO_FILE)%'
.. image:: ../../_images/cookbook/custom-invoice/pdf_with_custom_logo.png
How to customize the invoice appearance?
----------------------------------------
There might be need to change how the invoices look like, f.e. shop is using its own logo, there might be some colours changed
There might be need to change how the invoices look like, f.e. there might be different logo dimension, some colours changed
on the tables, or maybe the order of fields might be changed.
First let's prepare the HTML's so we can modify them. This command will copy only the PDF template: