README

The enflow/document-replacer package provides a easy way to modify docx templates, replace text and save it. Adds the ability to export it to PDF trough unoserver/unoconvert.

Installation

You can install the package via composer:

composer require enflow/document-replacer

PDF conversion

This package comes with an implementation to convert docx templates to PDF using unoserver. You can install this on your machine globally using:

sudo add-apt-repository ppa:libreoffice/ppa
sudo apt install libreoffice
sudo pip install unoserver

Converters

It's highly recommend using the new unoconvert converter. If you are unable to upgrade, we still provide the deprecated UnoconvConverter for the time being. UnoconvConverter is deprecated and will be removed in 3.0.

Server

Unoserver works together with unoconvert. Unoserver runs as a daemon on the server, and unoconvert connects through it to pass the files. To see why this is more efficient, see https://github.com/unoconv/unoserver/#overview

Start the server with: unoserver --daemon

It's recommended setting this up with a server like supervisord, without the --daemon flag, to auto restart the process if needed.

Usage

use Enflow\DocumentReplacer\DocumentReplacer;

DocumentReplacer::template('filename.docx')
    ->converter(UnoserverConverter::class)
    ->replace([
        '${user}' => 'Michel',
        '${address.city}' => 'Alphen aan den Rijn',
        '${company}' => 'Enflow',
    ])
    ->save('document.pdf');

Images

If you wish to replace images in your document, you can pass the Image class to the replacement array like this:

use Enflow\DocumentReplacer\DocumentReplacer;
use Enflow\DocumentReplacer\ValueTypes\Image;

DocumentReplacer::template('filename.docx')
    ->converter(UnoconvConverter::class)
    ->replace([
        '${primary}' => Image::forPath('image.png'),
        '${second}' => Image::forBase64('iVBORw0KGgoA...'),
    ])
    ->save('document.pdf');

The search-pattern model for images can be like:

${search-image-pattern}
${search-image-pattern:[width]:[height]:[ratio]}
${search-image-pattern:[width]x[height]}
${search-image-pattern:size=[width]x[height]}
${search-image-pattern:width=[width]:height=[height]:ratio=false} Where:
[width] and [height] can be just numbers or numbers with measure, which supported by Word (cm|mm|in|pt|pc|px|%|em|ex)
[ratio] uses only for false, - or f to turn off respect aspect ration of image. By default template image size uses as 'container' size.

More info can be found in the PHPWord documentation

Non-default server options

Running the server on non-default options (IP 127.0.0.1 / port 2002)? You can pass along the interface and port to the UnoserverConverter:

DocumentReplacer::template('filename.docx')
    ->converter(UnoserverConverter::class, [
        'interface' => '192.168.0.1',
        'port' => 1533,
    ])

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email michel@enflow.nl instead of using the issue tracker.

Credits

About Enflow

Enflow is a digital creative agency based in Alphen aan den Rijn, Netherlands. We specialize in developing web applications, mobile applications and websites. You can find more info on our website.

License

The MIT License (MIT). Please see License File for more information.

enflow / document-replacer

Maintainers

Details