PHPackages                             snicholson/docxtemplates - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. snicholson/docxtemplates

ActiveLibrary[Utility & Helpers](/categories/utility)

snicholson/docxtemplates
========================

Merge data into .docx templates in a similar fashion to mailmerge

1.1(10y ago)310.2k—0%2PHPPHP >=5.4.0CI failing

Since Aug 8Pushed 4y ago1 watchersCompare

[ Source](https://github.com/SamNicholson/PHPDocxTemplates)[ Packagist](https://packagist.org/packages/snicholson/docxtemplates)[ RSS](/packages/snicholson-docxtemplates/feed)WikiDiscussions master Synced yesterday

READMEChangelog (4)Dependencies (1)Versions (3)Used By (0)

PHPDocxTemplates
================

[](#phpdocxtemplates)

A PHP Library For Using Docx Files As Fillable Templates

Installation
------------

[](#installation)

Can be installed via composer, simply require the following -

```
require: "snicholson/docxtemplates": "dev-master"
```

Usage
-----

[](#usage)

Using PHPDocxTemplates is simple, to run a merge on a document, you first need to define a rule collection. This is done in the following fashion, rules are a target/data combination. Target is the string to be replaced, and data is the value to replace it. You can perform a SimpleMerge using the below class (in namepsace SNicholson/PHPDocXTemplate), you need to provide it with the filepath to your template, and a filepath for the output file, it will save it in place for you. The below is an example of Simple merge using only simple rules -

```
$ruleCollection = new RuleCollection();
$ruleTarget = '#texttoreplace#';
$ruleData = function(){
    return 'a test value from a closure';
};
$ruleCollection->addSimpleRule($ruleTarget,$ruleData);
$ruleCollection->addSimpleRule('#someMoreTextToReplace#','Some text that needs replacing!');
DocXTemplate::merge('input.docx','output.docx',$ruleCollection);
```

### Simple Rules

[](#simple-rules)

A simple rule is a simple string replace, the target is the string to be replaced, and the data is either a string or closure to replace it with, SimpleRules are added to Rule Collections as in the example below

```
$ruleCollection = new RuleCollection();
$ruleTarget = '#texttoreplace#';
$ruleData = function(){
    return 'a test value from a closure';
};
$ruleCollection->addSimpleRule($ruleTarget,$ruleData);
$ruleCollection->addSimpleRule(
 '#someMoreTextToReplace#',
 'Some text that needs replacing!'
);
```

### Regexp Rules

[](#regexp-rules)

Regular Expression rules are slightly more advanced, they allow you to specify a regular expression to match, receive matches in a closure and act on their values accordingly -

```
$ruleCollection = new RuleCollection();
$ruleTarget = '/ARegularExpression/';
$ruleData = function($match){
    //I can perform logic on the $match value in here
    return substr($match,0,3);
};o
$ruleCollection->addRegexpRule($ruleTarget,$ruleData);
```

### Merging RuleCollections into Word Documents

[](#merging-rulecollections-into-word-documents)

Merging can be done simply using the Static simpleMerge class, it is intended to add more advanced merge Classes in the future. You must provide an inbound filepath and an outbound filepath, along with a RuleCollection. The outbound filepath needs to be writable to PHP.

```
DocXTemplate::merge('input.docx','output.docx',$ruleCollection);
```

TODO
----

[](#todo)

Outstanding

- Be able to replace text with images
- Be able to generate an insert tables in place of text
- Support Basic formatting (bold, italic, line returns) from HTML input to the XML format

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity28

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3982d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/46399f5ed7a2433a8b13df9bc3298329ba2f7e321c498463d0cf1653de7ac7d8?d=identicon)[SamNicholson](/maintainers/SamNicholson)

---

Top Contributors

[![SamNicholson](https://avatars.githubusercontent.com/u/9439200?v=4)](https://github.com/SamNicholson "SamNicholson (46 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/snicholson-docxtemplates/health.svg)

```
[![Health](https://phpackages.com/badges/snicholson-docxtemplates/health.svg)](https://phpackages.com/packages/snicholson-docxtemplates)
```

###  Alternatives

[mihaildev/yii2-ckeditor

Yii2 CKEditor

120579.4k50](/packages/mihaildev-yii2-ckeditor)[vipx/bot-detect

Bot detector library

45349.6k1](/packages/vipx-bot-detect)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)