ownercoder/ru-php-stamp

A library for true XSL-way templating of XML-based Office documents. Supports MS Word docx.

0.1.6 2017-12-25 05:16 UTC

Requires (Dev)

• phpunit/phpunit: ^5.7

MIT

• Oleg

• template
• word
• docx

README

PHPStamp is a simple PHP templating library for XML-based Microsoft Word documents.
Library aims to provide native XML-way of templating this documents as an altenative to treating DOM document as a string for regex replacing, which has a lot of downsides.

Basically it tries to clean messy WYSIWYG-generated code and create reusable XSL stylesheet from document.
Some additional information:
(EN) https://redd.it/30conp
(RU) http://habrahabr.ru/post/244421/

Features

• Current version supports Microsoft Office OpenXML DOCX format.
• Configurable brackets for tags-placeholders.
• Basic extension system, which helps generating content blocks such as Cells or ListItems.
• Caching XSL template to filesystem.

Requirements

Library requires PHP 5.3+ with DOM, XSL and Zip extensions.
Also depends on doctrine2/Lexer package.

Installation

Install with Composer.

composer require shadz3rg/php-stamp

or

{
    "require": {
        "shadz3rg/php-stamp": "0.1.*"
    }
}

Usage

Template.

<?php
    require 'vendor/autoload.php';
    
    use PHPStamp\Templator;
    use PHPStamp\Document\WordDocument;
    
    $cachePath = 'path/to/writable/directory/';
    $templator = new Templator($cachePath);
    
    $documentPath = 'path/to/document.docx';
    $document = new WordDocument($documentPath);
    
    $values = array(
        'library' => 'PHPStamp 0.1',
        'simpleValue' => 'I am simple value',
        'nested' => array(
            'firstValue' => 'First child value',
            'secondValue' => 'Second child value'
        ),
        'header' => 'test of a table row',
        'students' => array(
            array('id' => 1, 'name' => 'Student 1', 'mark' => '10'),
            array('id' => 2, 'name' => 'Student 2', 'mark' => '4'),
            array('id' => 3, 'name' => 'Student 3', 'mark' => '7')
        ),
        'maxMark' => 10,
        'todo' => array(
            'TODO 1',
            'TODO 2',
            'TODO 3'
        )
    );
    $result = $templator->render($document, $values);
    $result->download();

Result.