natmars/yii2-word

Helper and wrapper class for PHPWord for simple communication

1.1 2019-11-25 13:20 UTC

Requires

• php: >=5.4
• phpoffice/phpword: 0.17.*
• yiisoft/yii2: *

BSD-3-Clause

• Denis A. Tatarnikov

• word
• yii2
• PhpWord

README

Helper and wrapper class for PHPWord for simple communication.

Installation

Either run

$ php composer.phar require natmars/yii2-word "@dev"

or add

"natmars/yii2-word": "@dev"

Creating a multi-line file using the word template

1. Creating Your First Template

Create a Microsoft Word file.

Use ${variableName} to set variables. Use ${tableName}, ${itemName} to generate a table (the value of ${tableName} is set to empty, but the values ​​of ${itemName} are set to match a data in an array). Result will look like this:

2. Saving template

Set the file name as $fileName, put the file in the template directory $templatesDir and determine the location to save the finished file $tmpDir

3. Generating the report

use natmars\word\Word;

$templateFullPath = $templatesDir . $fileName;
$outputFullPath = $tmpDir . $fileName;
        
$phpWord = new Word();

// create a file using a template
$phpWord->saveFromMultiLineTemplate($templateFullPath, $outputFullPath, [
    'variableName' => 'variableValue',
    'tableName' => [
        ['itemName' => 'itemValue1'],
        ['itemName' => 'itemValue2'],
        ['itemName' => 'itemValue3'],
    ],
]);

// download file
$phpWord->downloadTemplate($outputFullPath);

4. Check your output report document

Your output should look something like below:

Run for example:

\natmars\example\Test::generate();