PHP Master | Convert HTML to PDF with Dompdf-PHP Tutorial-php.cn

Table of Contents

Key Takeaways

Getting Started

Advanced Usage

Conclusion

Frequently Asked Questions (FAQs) about Converting HTML to PDF with DOMPDF

What is DOMPDF and why is it used?

How do I install DOMPDF?

Can I use CSS with DOMPDF?

How do I add images to my PDF?

Can I generate a PDF with multiple pages?

How do I set the page size and orientation?

Can I use DOMPDF with Laravel?

How do I save the generated PDF to a file?

Can I send the generated PDF as a response in a web application?

Is DOMPDF secure?

Home

Backend Development

PHP Tutorial

PHP Master | Convert HTML to PDF with Dompdf

Lisa Kudrow

Feb 23, 2025 am 10:36 AM

PHP Master | Convert HTML to PDF with Dompdf

PDF is a standard format originally created by Adobe for representing text and images in a fixed-layout document. It’s not uncommon for a web application to support downloading data, such as invoices or reports, in PDF format, so in this article we’ll go through how we can easily generate PDF documents using PHP. Dompdf is a great library, capable of generating a PDF from HTML markup and CSS styles (it’s mostly CSS 2.1 compliant and has support for some CSS3 properties). We can decide how our content should look using these familiar technologies, and then easily convert that into a fixed document. The library has many other useful and interesting features, too.

Key Takeaways

Dompdf is a PHP library that can convert HTML markup and CSS styles into a PDF document, making it useful for web applications that need to support downloading data in PDF format.
To use Dompdf, it needs to be installed via GitHub or Composer, and it requires PHP >= 5.0 with the mbstring and DOM extensions enabled. HTML markup can be loaded as a string or from a file or URL, and then rendered into a PDF.
Dompdf provides a range of configuration options to tailor the PDF to specific needs, such as paper size, page orientation, and character encoding. It also allows for advanced usage, such as saving the generated PDF to disk, or adding headers or footers.
While Dompdf is a powerful tool, it has some limitations, such as being intolerant of poorly-formed HTML and only having limited support for CSS3. It’s recommended to review the library’s documentation and source code for a full understanding of its capabilities and potential issues.

Getting Started

Dompdf is available on GitHub and can be installed using Composer. Getting a Composer-based install up and running correctly is admittedly still a bit tricky, so I recommend just using Git to install Dompdf. The library requires PHP >= 5.0 with the mbstring and DOM extensions enabled. It also needs some fonts, which are generally available on most machines. Navigate to wherever you want to put the library and execute:

git clone https://github.com/dompdf/dompdf.git
git submodule init
git submodule update

Copy after login

With Dompdf downloaded, let’s write a short example that will generate a simple PDF.

<span><span><?php
</span></span><span><span>set_include_path(get_include_path() . PATH_SEPARATOR . "/path/to/dompdf");
</span></span><span>
</span><span><span>require_once "dompdf_config.inc.php";
</span></span><span>
</span><span><span>$dompdf = new DOMPDF();
</span></span><span>
</span><span><span>$html = <span><span><<<'ENDHTML'</span>
</span></span></span><span><span><html>
</span></span><span><span> <body>
</span></span><span><span>  <h1>Hello Dompdf</h1>
</span></span><span><span> </body>
</span></span><span><span></html>
</span></span><span><span><span>ENDHTML<span>;</span></span>
</span></span><span>
</span><span><span>$dompdf->load_html($html);
</span></span><span><span>$dompdf->render();
</span></span><span>
</span><span><span>$dompdf->stream("hello.pdf");</span></span>

Copy after login

To use the library in a project, we first pull in dompdf_config.inc.php which contains most of the Dompdf configuration. It also loads an autoloader and a custom configuration file in which we can override default configuration parameters. HTML markup is given as a string to the load_html() method. Alternatively, we can load markup from a file or URL using the load_html_file() method. It accepts a filename or the URL of a webpage as its argument. The render() method renders the HTML into PDF and we are ready to dump the PDF file. stream() sends the resulting PDF as an attachment to the browser. The stream() method has an optional second parameter, an array of options:

Accept-Ranges – boolean, send “Accept-Ranges” header (false by default).
Attachment – boolean, send “Content-Disposition: attachment” header forcing the browser to display a save prompt (true by default).
compress – boolean, enable content compression (true by default).

We’ve generated a very simple PDF here, but that’s not very practical. In reality we’ll often have requirements about paper size, page orientation, character encoding, etc. There are number of configuration options that we can set to make Dompdf more suitable for our real-world needs. All of them are listed and explained in dompdf_config.inc.php which sets them to their default values. You can change these values by updating the the custom configuration file dompdf_config.custom.inc.php. Some of the important settings are:

DOMPDF_DEFAULT_PAPER_SIZE – sets the default paper size for the PDF document. Supported paper sizes can be found in include/cpdf_adapter.cls.php (the default value is “letter”).
DOMPDF_TEMP_DIR – specifies the temporary directory used by Dompdf. Make sure this location is writable by the web server account.
DOMPDF_UNICODE_ENABLED – sets whether the PDF uses Unicode fonts (the default is true).
DOMPDF_ENABLE_REMOTE – enables the inclusion of images or CSS styles from remote sites (default is false).
DEBUG_LAYOUT – whether to render a box around each HTML block in the PDF file which is useful for debugging the layout (default is false).

Advanced Usage

Now let’s talk about some advanced uses of Dompdf. Perhaps we want to save the generated PDF document to disk instead of sending it to the browser. Here’s how:

git clone https://github.com/dompdf/dompdf.git
git submodule init
git submodule update

Copy after login

Instead of calling stream() like in the previous example, we use output() which returns the PDF as a string. It too accepts an optional options array, but the only option available is compress (the default is true). Dompdf also allows us to add a header or footer to the generated PDF by embedding a PHP script in the HTML that it renders. But because processing arbitrary code can pose a security risk if you’re not careful, the configuration value that controls this functionality is off by default. We need to first set the DOMPDF_ENABLE_PHP option true. Once we’ve enabled inline PHP execution, the PDF object will be made available within the script, which we can use to manipulate the page. We can add text, lines, images, rectangles, etc. anywhere inside the page.

<span><span><?php
</span></span><span><span>set_include_path(get_include_path() . PATH_SEPARATOR . "/path/to/dompdf");
</span></span><span>
</span><span><span>require_once "dompdf_config.inc.php";
</span></span><span>
</span><span><span>$dompdf = new DOMPDF();
</span></span><span>
</span><span><span>$html = <span><span><<<'ENDHTML'</span>
</span></span></span><span><span><html>
</span></span><span><span> <body>
</span></span><span><span>  <h1>Hello Dompdf</h1>
</span></span><span><span> </body>
</span></span><span><span></html>
</span></span><span><span><span>ENDHTML<span>;</span></span>
</span></span><span>
</span><span><span>$dompdf->load_html($html);
</span></span><span><span>$dompdf->render();
</span></span><span>
</span><span><span>$dompdf->stream("hello.pdf");</span></span>

Copy after login

The script is embedded directly into the HTML markup, and first opens an object so we can affect the rendering. All drawing will be recorded into that object and we can add this object to all or selected pages (though there are limitations). Next we fetch the actual width and height of the page to calculate the coordinates of the footer we intend to add. Also, we need to provide a font object while we add text contents. Font_Metrics::get_font() lets us to create the object we need. We also take the height of the given font at its font size using get_font_height()to calculate positioning for the footer’s contents. The method get_font_width() returns the width of our text for the given font and font size which is also used in our calculations. The line() method draws a line from point (X1,Y1) to (X2,X2). Notice that the color value we provided is not an actual RGB value. The underlying PDF class requires values between 0 and 1 and so we convert the RGB values into these new values. To get a better approximation, you can divide it by 255. We add the page number for each page using the page_text() method, which accepts an X and Y position, the text to be added, a font object, font size, and color. Dompdf automatically replaces the values for {PAGE_NUM} and {PAGE_COUNT} in each page, and makes $pdf available to us. When the PDF renders, the footer section will look like this:

PHP Master | Convert HTML to PDF with Dompdf

It’s possible to avoid using inline PHP and achieve the same effect directly from PHP, like so:

git clone https://github.com/dompdf/dompdf.git
git submodule init
git submodule update

Copy after login

Note that we place the code after calling $dompdf->render() because we are essentially modifying the rendered PDF.

Conclusion

In this article we discussed how to easily convert HTML to PDF using Dompdf. Although Dompdf is a great library, it’s not a bulletproof solution for generating PDF documents; it does has some limitations and issues. Dompdf is not really tolerant of poorly-formed HTML, and large tables can easily cause you to run out of memory. Some basic CSS features like float are not completely supported and there is only limited support for CSS3. If you need features which are not supported by Dompdf, something like wkhtmltopdf might be a better solution for you. Still, Dompdf is fairly simple and suitable for the majority of PDF export needs. It’s really difficult to explain all of the features provided by a library in article such as this, so be sure to check out the documentation and source code as well to learn about cool features like adding callbacks, using custom fonts, etc. Also, I’m happy to help you within my limited expertise. Feel free to leave your questions and share your experiences in the comments section. Image via Fotolia And if you enjoyed reading this post, you’ll love Learnable; the place to learn fresh skills and techniques from the masters. Members get instant access to all of SitePoint’s ebooks and interactive online courses, like Jump Start PHP. Comments on this article are closed. Have a question about PHP? Why not ask it on our forums?

Frequently Asked Questions (FAQs) about Converting HTML to PDF with DOMPDF

What is DOMPDF and why is it used?

DOMPDF is a PHP library that provides a simple way to convert HTML to PDF. It is used because it can handle complex HTML layouts, including CSS styles, JavaScript, and images. It’s a powerful tool for developers who need to generate PDF documents from HTML content. It’s easy to use, flexible, and can be integrated into any PHP application.

How do I install DOMPDF?

DOMPDF can be installed using Composer, a dependency management tool for PHP. You can install Composer and then run the command ‘composer require dompdf/dompdf’. This will download and install the DOMPDF library in your project.

Can I use CSS with DOMPDF?

Yes, DOMPDF supports CSS. You can use inline CSS in your HTML, or you can link to an external CSS file. DOMPDF will apply the styles when generating the PDF. However, please note that not all CSS properties are supported.

How do I add images to my PDF?

You can add images to your PDF by including an ‘img’ tag in your HTML. The ‘src’ attribute should point to the image file. DOMPDF will include the image in the generated PDF.

Can I generate a PDF with multiple pages?

Yes, DOMPDF can generate a PDF with multiple pages. If your HTML content is long enough to span multiple pages, DOMPDF will automatically split it into pages. You can also manually add page breaks using CSS.

How do I set the page size and orientation?

You can set the page size and orientation using the ‘set_paper’ method. For example, you can use ‘$dompdf->set_paper(‘A4’, ‘landscape’)’ to set the page size to A4 and the orientation to landscape.

Can I use DOMPDF with Laravel?

Yes, DOMPDF can be used with Laravel. There is a Laravel package called ‘laravel-dompdf’ that provides an easy way to use DOMPDF in a Laravel application.

How do I save the generated PDF to a file?

You can save the generated PDF to a file using the ‘output’ method and the ‘file_put_contents’ function. For example, you can use ‘file_put_contents(‘mypdf.pdf’, $dompdf->output())’ to save the PDF to a file named ‘mypdf.pdf’.

Can I send the generated PDF as a response in a web application?

Yes, you can send the generated PDF as a response in a web application. You can use the ‘stream’ method to send the PDF directly to the browser.

Is DOMPDF secure?

DOMPDF is generally considered secure, but like any software, it may have vulnerabilities. It’s important to keep your DOMPDF installation up to date and to review the security guidelines provided by the DOMPDF team.

The above is the detailed content of PHP Master | Convert HTML to PDF with Dompdf. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website

The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress images for free

Clothoff.io

AI clothes remover

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Assassin's Creed Shadows: Seashell Riddle Solution

3 weeks ago By DDD

What's New in Windows 11 KB5054979 & How to Fix Update Issues

2 weeks ago By DDD

Assassin's Creed Shadows - How To Find The Blacksmith And Unlock Weapon And Armour Customisation

1 months ago By DDD

Where to find the Crane Control Keycard in Atomfall

3 weeks ago By DDD

Roblox: Dead Rails - How To Complete Every Challenge

3 weeks ago By DDD

Hot Tools

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Hot Topics

Where is the login entrance for gmail email?

7644

CakePHP Tutorial

1392

What is the format of the account name of steam

win11 activation key permanent

nyt connections hints and answers

152

Related knowledge

Alipay PHP SDK transfer error: How to solve the problem of 'Cannot declare class SignData'? Apr 01, 2025 am 07:21 AM

Alipay PHP...

Explain JSON Web Tokens (JWT) and their use case in PHP APIs. Apr 05, 2025 am 12:04 AM

JWT is an open standard based on JSON, used to securely transmit information between parties, mainly for identity authentication and information exchange. 1. JWT consists of three parts: Header, Payload and Signature. 2. The working principle of JWT includes three steps: generating JWT, verifying JWT and parsing Payload. 3. When using JWT for authentication in PHP, JWT can be generated and verified, and user role and permission information can be included in advanced usage. 4. Common errors include signature verification failure, token expiration, and payload oversized. Debugging skills include using debugging tools and logging. 5. Performance optimization and best practices include using appropriate signature algorithms, setting validity periods reasonably,

How does session hijacking work and how can you mitigate it in PHP? Apr 06, 2025 am 12:02 AM

Session hijacking can be achieved through the following steps: 1. Obtain the session ID, 2. Use the session ID, 3. Keep the session active. The methods to prevent session hijacking in PHP include: 1. Use the session_regenerate_id() function to regenerate the session ID, 2. Store session data through the database, 3. Ensure that all session data is transmitted through HTTPS.

Describe the SOLID principles and how they apply to PHP development. Apr 03, 2025 am 12:04 AM

The application of SOLID principle in PHP development includes: 1. Single responsibility principle (SRP): Each class is responsible for only one function. 2. Open and close principle (OCP): Changes are achieved through extension rather than modification. 3. Lisch's Substitution Principle (LSP): Subclasses can replace base classes without affecting program accuracy. 4. Interface isolation principle (ISP): Use fine-grained interfaces to avoid dependencies and unused methods. 5. Dependency inversion principle (DIP): High and low-level modules rely on abstraction and are implemented through dependency injection.

How to automatically set permissions of unixsocket after system restart? Mar 31, 2025 pm 11:54 PM

How to automatically set the permissions of unixsocket after the system restarts. Every time the system restarts, we need to execute the following command to modify the permissions of unixsocket: sudo...

How to debug CLI mode in PHPStorm? Apr 01, 2025 pm 02:57 PM

How to debug CLI mode in PHPStorm? When developing with PHPStorm, sometimes we need to debug PHP in command line interface (CLI) mode...

Explain late static binding in PHP (static::). Apr 03, 2025 am 12:04 AM

Static binding (static::) implements late static binding (LSB) in PHP, allowing calling classes to be referenced in static contexts rather than defining classes. 1) The parsing process is performed at runtime, 2) Look up the call class in the inheritance relationship, 3) It may bring performance overhead.

How to send a POST request containing JSON data using PHP's cURL library? Apr 01, 2025 pm 03:12 PM

Sending JSON data using PHP's cURL library In PHP development, it is often necessary to interact with external APIs. One of the common ways is to use cURL library to send POST�...

See all articles