README

The CodeIgniter Dompdf Library is a wrapper that assists in generating PDFs using the Dompdf library within the CodeIgniter framework.

The Dompdf library is a popular PHP library that allows you to create PDF documents from HTML markup. It converts HTML and CSS into PDF format, allowing you to generate PDF files dynamically based on your web application's data.

Using the CodeIgniter Dompdf Library, you can easily generate PDFs by passing HTML content or views to the library's methods. The library takes care of rendering the HTML, applying CSS styles, and converting it into a downloadable PDF file.

Installation

Installation is done through Composer.

composer require ictsolutions/codeigniter-dompdf

Configuration

The library's default behavior can be overridden or augmented by its config file. Copy examples/Pdf.php to app/Config/Pdf.php and follow the instructions in the comments. If no config file is found the library will use its default. In the Breadcrumb class, you can set the following configuration options:

showWarnings (boolean, default: false)

If set to true, an Exception will be thrown on warnings from dompdf.

convertEntities (boolean, default: true)

If set to true, Dejavu Sans font is used. However, this font does not have glyphs for certain entities like € and £. If you need to display these characters correctly, you can set this option to false.

defaultMediaType (string, default: 'screen')

This option specifies the target media view which should be rendered into the PDF. Possible values are:

screen
tty
tv
projection
handheld
print
braille
aural
all

defaultPaperSize (string, default: 'a4')

This option specifies the default paper size for the PDF document. It accepts standard paper sizes like 'letter', 'legal', 'A4', etc.

defaultPaperOrientation (string, default: 'portrait')

This option specifies the default paper orientation for the PDF document. Possible values are 'portrait' and 'landscape'.

defaultFont (string, default: 'serif')

This option specifies the default font family to be used if no suitable fonts can be found. The font must exist in the font folder.

fontHeightRatio (integer, default: 1)

This option applies a ratio to the font's height to make it more similar to browsers' line height.

dpi (integer, default: 96)

This option specifies the DPI (dots per inch) setting for images and fonts. This determines the default rendering resolution for the PDF document.

isPhpEnabled (boolean, default: false)

If set to true, DOMPDF will automatically evaluate inline PHP code contained within <script type="text/php"> ... </script> tags.

Note: Enabling this option for untrusted documents can be a security risk.

isRemoteEnabled (boolean, default: true)

If set to true, DOMPDF will access remote sites for images and CSS files as required.

Note: Enabling this option can be a security risk, especially when combined with other options like isPhpEnabled.

isJavascriptEnabled (boolean, default: true)

If set to true, DOMPDF will automatically insert JavaScript code contained within <script type="text/javascript"> ... </script> tags.

Usage

First, we need to load the Pdf Library:

$dompdf = new \IctSolutions\CodeIgniterDompdf\Pdf();

After creating an instance of Dompdf, we can setup the PDF properties:

$dompdf->set_option('isRemoteEnabled', TRUE);
$dompdf->setPaper('A4', 'landscape');

Then, we use it to load Html content:

$html = '<h1>Welcome to PDF Generator</h1>';
$dompdf->loadHtml($html);

We can render the Html content:

$dompdf->render();

And finally, we can stream the output:

$dompdf->stream('welcome.pdf', array("Attachment"=>0)); // stream to client side

Example: Creating a CodeIgniter Project with Dompdf

Here are general guideline steps to include Dompdf library in CodeIgniter:

Install the library through Composer in your project:

composer require ictsolutions/codeigniter-dompdf

When you need to create a PDF, load the library:

$dompdf = new \IctSolutions\CodeIgniterDompdf\Pdf();

Use the library to create PDFs. The following example shows creating a PDF from a view:

$htmlContent = $this->load->view('pdf_view',$data,TRUE);
$dompdf->loadHtml($htmlContent);
$dompdf->render();
$dompdf->stream("welcome.pdf", array("Attachment"=>0));

In this example, 'pdf_view' would be a view file that contains your HTML structure, and $data would be any data you want to pass to the view. The output would be streamed to the client with the filename welcome.pdf. If you set the Attachment option to 1, the PDF file would be downloaded by the client rather than displayed in the browser. Please modify and adjust these examples according to your actual project and codebase.

License

This project is licensed under the MIT License - see the LICENSE file for details.

ictsolutions / codeigniter-dompdf

Maintainers

Details