Download the PHP package d36dak/docx-builder without Composer

docx-builder

docx-builder is a small PHP library for creating DOCX documents programmatically. It provides a fluent builder API for composing paragraphs, tables, images, page breaks, headers, and footers, then writing the result as a .docx file, or returning the generated document contents as a string.

The package is designed around a lightweight document model and bundled OpenXML resources, so simple documents can be generated without preparing a separate template file.

Features

• Create DOCX documents from PHP code.
• Add styled paragraphs with font family, font size, color, bold, italic, and underline options.
• Configure paragraph alignment, spacing before and after, and line spacing.
• Build paragraphs from multiple text runs.
• Add page number and total page count fields.
• Add page breaks.
• Add tables with configurable header rows and cell styling.
• Add images with width, height, alignment, and alt text.
• Add default and first-page headers and footers.
• Configure page format and margins.
• Save documents to disk or return generated DOCX contents as a string.

Requirements

• PHP 8.2 or newer
• PHP zip extension
• PHP dom extension

Public API

The supported public API is limited to DocxBuilder, ParagraphBuilder, and ParagraphElement. ParagraphElement is public as the value returned by ParagraphBuilder::build() and accepted by DocxBuilder. Other classes are implementation details and are marked @internal; they may change without a backward compatibility promise.

Installation

This package is installed via Composer. To add a dependency to docx-builder in your project run the following command:

Usage examples

The following example can be used in any PHP project after installing the package with Composer. This example is also available as examples/basic.php and can be run from the project root:

Examples of each feature

Feature index:

• Creating a document
• Adding paragraphs
• Building paragraphs with multiple text runs
• Adding page numbers
• Adding page breaks
• Adding tables
• Adding images
• Adding headers and footers
• Saving a document
• Returning document contents

Creating a document

Create a new DOCX document builder with optional page format and margin settings.

Method:

new DocxBuilder(array $documentOptions = [])

Parameters:

Options for $documentOptions:

Options for margins:

Back to feature index

Adding paragraphs

Add a paragraph to the document from plain text or from a prepared ParagraphElement.

Method:

$builder->addParagraph(string|ParagraphElement $paragraph, array $options = []): self

Parameters:

Options for $options:

Back to feature index

Building paragraphs with multiple text runs

Build one paragraph from multiple text runs when different parts of the same paragraph need different text styling.

Methods:

new ParagraphBuilder(array $defaultOptions = [])

$paragraphBuilder->addTextRun(string $text, array $options = []): self

$paragraphBuilder->build(): ParagraphElement

Parameters:

Options for $defaultOptions:

Options for addTextRun() $options:

Back to feature index

Adding page numbers

Add Word page number fields inside a paragraph, usually for headers or footers.

Methods:

$paragraphBuilder->addPageNumber(array $options = []): self

$paragraphBuilder->addTotalPagesNumber(array $options = []): self

Parameters:

Options for $options:

Back to feature index

Adding page breaks

Insert a page break so following content starts on a new page.

Method:

$builder->addPageBreak(): self

Parameters: none.

Back to feature index

Adding tables

Add a simple DOCX table from an array of rows.

Method:

$builder->addTable(array $rows, array $options = []): self

Parameters:

Options for $options:

Options for cellOptions and headerCellOptions:

Back to feature index

Adding images

Embed a local image file into the document.

Method:

$builder->addImage(string $imagePath, array $options): self

Parameters:

Options for $options:

Back to feature index

Adding headers and footers

Set default or first-page headers and footers for the document.

Methods:

$builder->addHeader(string|ParagraphElement $header, array $options = []): self

$builder->addFirstPageHeader(string|ParagraphElement $header, array $options = []): self

$builder->addFooter(string|ParagraphElement $footer, array $options = []): self

$builder->addFirstPageFooter(string|ParagraphElement $footer, array $options = []): self

Parameters:

Options for $options:

Calling the same header or footer method multiple times replaces the previous value.

Back to feature index

Saving a document

Write the generated DOCX document to disk.

Method:

$builder->save(string $outputPath): void

Parameters:

Back to feature index

Returning document contents

Return the generated DOCX document as a binary string.

Method:

$builder->getContents(): string

Parameters: none.

Back to feature index

License

This project is released under the MIT License.