Download the PHP package popphp/pop-pdf without Composer

pop-pdf

• Overview
• Install
• Quickstart
• PDF
  • Write to File
  • Output to HTTP
  • Import from File
  • Import from Raw Data
  • Import from Images
• Documents
  • Compression
  • Page Origin
• Pages
• Fonts
  • Standard
  • Embedded
• Text
  • Alignment
  • String Width
• Styles
• Images
  • Image Size
• Paths
• Annotations
  • URLs
  • Internal
• Forms
• HTML

Overview

Pop PDF is a robust PDF processing component that's simple to use. With it, you can create PDF documents from scratch, or import existing ones and add to or modify them. It supports embedding images, fonts and URLs, as well as a set of drawing, effect and type features.

pop-pdf is a component of the Pop PHP Framework.

Top

Install

Install pop-pdf using Composer.

composer require popphp/pop-pdf

Or, require it in your composer.json file

"require": {
    "popphp/pop-pdf" : "^5.0.0"
}

Top

Quickstart

Create a simple PDF

Create a simple 1-page PDF document with the text "Hello World" on the page. The page size will be letter. The text string will be positioned (50, 50) from the top left and use the standard Arial font.

Embed an image

Using the same example from above, let's add an image to it:

Top

PDF

The PDF format specification is a vast and comprehensive format that has been around for a long time. It is comprised of other various media specifications such as fonts and images. The pop-pdf attempts to present all of these various components in an intuitive, object-oriented way so that a developer can assemble, build and compile valid PDF documents programmatically.

The main Pop\Pdf\Pdf class serves as a simple processing class with a set of static methods to route the various object components to the right place to be processed.

• writeToFile($document, $filename = 'pop.pdf'): void
• outputToHttp($document, $filename = 'pop.pdf', $forceDownload = false, $headers = []): void
• importFromFile($file, $pages = null): AbstractDocument
• importRawData($data, $pages = null): AbstractDocument
• importFromImages($images, $quality = 70): AbstractDocument

Write to File

Once a PDF document has been assembled, you can pass it to the writeToFile() method to compile the PDF and save it to a file on disk:

Output to HTTP

Alternatively, you can push the PDF document out to an HTTP client. Giving it a filename sets the Content-Disposition filename value. Setting $forceDownload to true sets the Content-Disposition value to "attachment" to force a download (vs display inline.) A fourth $headers parameter is available to output any additional HTTP headers.

Import from File

You can take an existing PDF and import it to add new content to it. It will translate the PDF document's content into the appropriate objects such as pages, fonts, images and text. From there, you can add more content to the PDF document object and save it.

You can also choose which pages of a PDF document to import:

Import from Raw Data

If you have a stream of raw data from a PDF file, you can import that as well. This method supports optional page selection as well

Import from Images

If you have an array of images, you can convert them into a PDF document object where each image becomes a page in the PDF document.

Top

Documents

The document object serves as the main collection object of all of the components that go into building and compiling a PDF document. This includes pages, fonts and forms.

Compression

A PDF document can be compressed if needed to attempt to reduce file size.

Page Origin

A potentially confusing aspect of PDF documents is that the default page origin is the bottom left. This means that all coordinates and any math based on the coordinates has to be calculated from the bottom left.

If you'd prefer to calculate the origin from a different place, you can set that with the setOrigin() method on the document object. This will automatically translate your preferred origin to the native PDF origin.

Options for setting the origin of the document are:

• ORIGIN_TOP_LEFT
• ORIGIN_TOP_RIGHT
• ORIGIN_BOTTOM_LEFT
• ORIGIN_BOTTOM_RIGHT
• ORIGIN_CENTER

Top

Pages

Pages can be virtually any size, but there are a number of pre-defined sizes available as constants in the Pop\Pdf\Document\Page class:

Alternatively, you can use the document object as a page factory, which will create a page object, automatically add the page to the document object and return the new page:

There are a number of other methods within the document object to assist with managing various components:

• addPage(Page $page): Document
• addPages(array $pages): Document
• createPage(mixed $size, ?int $height = null): Page
• copyPage(int $p, bool $preserveContent = true): Page
• orderPages(array $pages): Document
• deletePage(int $p): Document
• addFont(Font|string $font, bool $embedOverride = false): Document
• embedFont(Font $font, bool $embedOverride = false): Document
• setCurrentPage(int $p): Document
• setCurrentFont(string $name): Document

Top

Fonts

Fonts are required to be added to a document for any text that might be added to any page. The font that a text object uses will be defined when adding the text to a page object, but that font will need to be present in the document object. Once fonts are added to a document, they can be used repeatedly by any text objects on any pages of the document.

There are two types of supported fonts: standard and embedded.

Top

Standard

Part of the PDF specification is that a total of 25 standard fonts that are supported by PDF and PDF readers. This means that no additional font files have to be embedded and the fonts are available by default.

References to each of these standard fonts are available as constants on the main font class, Pop\Pdf\Document\Font:

• Font::ARIAL
• Font::ARIAL_ITALIC
• Font::ARIAL_BOLD
• Font::ARIAL_BOLD_ITALIC
• Font::COURIER
• Font::COURIER_OBLIQUE
• Font::COURIER_BOLD
• Font::COURIER_BOLD_OBLIQUE
• Font::COURIER_NEW
• Font::COURIER_NEW_ITALIC
• Font::COURIER_NEW_BOLD
• Font::COURIER_NEW_BOLD_ITALIC
• Font::HELVETICA
• Font::HELVETICA_OBLIQUE
• Font::HELVETICA_BOLD
• Font::HELVETICA_BOLD_OBLIQUE
• Font::SYMBOL
• Font::TIMES_ROMAN
• Font::TIMES_BOLD
• Font::TIMES_ITALIC
• Font::TIMES_BOLD_ITALIC
• Font::TIMES_NEW_ROMAN
• Font::TIMES_NEW_ROMAN_ITALIC
• Font::TIMES_NEW_ROMAN_BOLD
• Font::TIMES_NEW_ROMAN_BOLDITALIC
• Font::ZAPF_DINGBATS

Top

Embedded

If you require a font outside of the set of standard fonts, the PDF specification supports embedding a number of different external font formats:

• TrueType (ttf)
• OpenType (otf)
• Type1 (pfb)

Most fonts of these types should work, but there are situations were the font may not be parsable, such as when a font's embeddable flag is set to false.

Top

Text

Once font objects have been added to a document object, text objects can then be added to page objects, while referencing the available font objects in the document.

The constructor of the text object takes the string and the size:

There are a number of methods to assist in modifying the text object:

• setSize(int|float $size): Text
• setFillColor(ColorInterface $color): Text
• setStrokeColor(ColorInterface $color): Text
• setStroke(int $width, ?int $dashLength = null, ?int $dashGap = null): Text
• setRotation(int $rotation): Text
• setCharWrap(int $charWrap, ?int $leading = null): Text
• setLeading(int $leading): Text

A basic character wrap can be set with the setCharWrap() method. The leading of the wrapped text can be either set with the second parameter or by the setLeading() method.

Top

Styles

Style objects can be added to the document to provide easier management of text and font styles used in multiple places across the PDF document and its pages.

So any text added to any page referencing the same style can easily be changed across the entire document by only changing the style object.

Top

Alignment

Alignment objects are objects that assist with handling more advanced alignment and wrapping of text based on geometric positioning. When creating an alignment object, you define a bounding areas to which the text will be confined.

Left-aligned box

Right-aligned box

Center-aligned box

Top

String Width

An important and useful tool with working with text and fonts to the ability to calculate the width of a string of characters rendered in a particular font. This is very helpful when attempting to correctly position text on the page.

There is a method on the font object that will allow you pass a string of text to it, as well as the desired size, to give you the approximate width those characters will take up rendered in that font at that size.

This works for both standard and embedded fonts.

This will give us the approximate width in points of the string Hello World in 12pt Helvetica Bold:

Top

Images

Images can be easily added to page objects. However, in a PDF document, the origin of an image is the bottom of the image. You will have to consider how the image's height affects the placement of the image on the page in relation to the page origin.

In this example below, the image is 320 x 320. If you place the $y value at 742 (top origin 792 - 50), then only the bottom 50 pixels of the image would display at the top of the page, while the remainder bleeds off the top page border. Therefore, the height should be taken into account and the $y value should be a value like 422 (top origin 792 - 50 - 320). This would make the image appear with the top of it starting at 50 pixels from the top of the page, and you would be able to safely see the entire image on the page.

In the above example, the image is pulled from a file. You can also import an image from a raw stream:

Top

Image Size

You can resize a larger image when adding it to a page.

The following methods are available to resize an image:

• resizeToWidth(int $width, bool $preserveResolution = false): Image
• resizeToHeight(int $height, bool $preserveResolution = false): Image
• resize(int $pixel, bool $preserveResolution = false): Image
• scale(float $scale, bool $preserveResolution = false): Image

The $preserveResolution flag is set to false by default. This will resize the image resource, which will reduce it in not only dimensional size, but also reduce its data size as well.

If you wish to keep the image in its original higher quality, and only reduce the dimensions, you can set the $preserveResolution flag to true. This is typically a good method to keep the image clean and crisp when being reduced to a smaller dimension.

Top

Paths

You can add path objects to a page to draw vector lines and shapes on the page object.

The methods to control color and style include:

• setFillColor(Color\ColorInterface $color): Path
• setStrokeColor(Color\ColorInterface $color): Path
• setStroke(int $width, ?int $dashLength = null, ?int $dashGap = null): Path
• setStyle(string $style): Path

The setStyle() method can take one of the available style constants as its parameter:

• Path::STROKE
• Path::STROKE_CLOSE
• Path::FILL
• Path::FILL_EVEN_ODD
• Path::FILL_STROKE
• Path::FILL_STROKE_EVEN_ODD
• Path::FILL_STROKE_CLOSE
• Path::FILL_STROKE_CLOSE_EVEN_ODD
• Path::CLIPPING
• Path::CLIPPING_FILL
• Path::CLIPPING_NO_STYLE
• Path::CLIPPING_EVEN_ODD
• Path::CLIPPING_EVEN_ODD_FILL
• Path::CLIPPING_EVEN_ODD_NO_STYLE
• Path::NO_STYLE

The basic methods available to draw paths and shapes are:

• drawLine(int $x1, int $y1, int $x2, int $y2): Path
• drawRectangle(int $x, int $y, int $w, ?int $h = null): Path
• drawRoundedRectangle(int $x, int $y, int $w, ?int $h = null, int $rx = 10, ?int $ry = null): Path
• drawSquare(int $x, int $y, int $w): Path
• drawRoundedSquare(int $x, int $y, int $w, int $rx = 10, ?int $ry = null): Path
• drawPolygon(array $points): Path
• drawEllipse(int $x, int $y, int $w, ?int $h = null): Path
• drawCircle(int $x, int $y, int $w): Path
• drawArc(int $x, int $y, int $start, int $end, int $w, ?int $h = null): Path
• drawChord(int $x, int $y, int $start, int $end, int $w, ?int $h = null): Path
• drawPie(int $x, int $y, int $start, int $end, int $w, ?int $h = null): Path

Top

Annotations

Annotation objects provide a way to link to external URLs or an internal pointer within the document.

URLs

The following example will generate an invisible annotation box area over the text Visit Google that links to Google's home page:

Top

Internal

The following example will add 2 pages to the document and link from the first page to the second page. When creating an internal link, you can define the following:

• The X and Y coordinates to navigate to
• The Z (Zoom) target
• The page target

Top

Forms

Forms and form fields are supported in Pop PDF, however, please note that not all browsers consistently support forms and form fields in their default PDF readers. It is recommended that if you generate a PDF with a form in it using Pop PDF, that your end user views it in an Adobe product.

The types of fields that are currently supported in Pop PDF are:

• Single-line text fields
• Multi-line text fields
• Single-select choice fields (e.g., an HTML select drop-down)
• Multi-select choice fields (e.g., an HTML multi-select drop-down)
• Push buttons (by default, display and act like a checkbox)
• Radio buttons

NOTE: A group of radio buttons is not supported at this time.

The following script below demonstrates how to add the various fields to a form in a PDF object. While lengthy, it includes text and graphic support for field names and borders:

The above code produces a PDF with a form like this:

Top

HTML

HTML rendering is available in pop-pdf, however it is still in an experimental beta stage.

Parsing HTML from a file:

If you have an HTML file, it will parse all of the HTML in it, as well as any linked CSS and images:

You can also parse HTML and CSS strings directly. The directory path is needed to give the parser a base folder to attempt to access other assets, such as images.

Top