Class kartik\wordreport\TemplateReport

Repeating block of values - similar to tabular values but with enhanced control.

For example,

// template setting
// ${customer_block}
// Customer: ${customer_name}
// Address: ${customer_address}
// ${/customer_block}
// ${block_2}
// Some text inside the block
// @{/block_2}
// ${block_3}
// @{/block_3}

'blocks' => [
     // loops array and replaces variables inside the block
     'customer_block' => [
         [
              'customer_name' => 'John',
              'customer_address' => 'Address for John',
         ],
         [
              'customer_name' => 'Bill',
              'customer_address' => 'Address for Bill',
         ],
     ],

     // replaces the block with the block text mentioned
     'block_2' => 'Replace this text inside the block',

     // deletes the block if the block variable is set to false
     'block_3' => false
]

Key value pairs of template variable chart names and their values which will be replaced. This must be a two dimensional array of chart variable names as keys and the chart object as the value.

For example,

// template setting
// CHART 1:
// ${chart1}
// CHART 2:
// ${chart2}

use PhpOffice\PhpWord\Element\Chart;
$categories = array('A', 'B', 'C', 'D', 'E');
$series1 = array(1, 3, 2, 5, 4);
$series2 = array(3, 1, 7, 2, 6);
$series3 = array(8, 3, 2, 5, 4);

$chart1 = new Chart('pie', $categories, $series1);
$chart2 = new Chart('bar', $categories, $series1);
$chart2->addSeries($series2);
$chart3->addSeries($series2);

'charts' => [
     'chart1' => $chart1,
     'chart2' => $chart2,
]

Key value pairs of template variable block names and their values which will be replaced.

This must be a two dimensional array of block variable names as keys and the complex object as the value.

For example,

// template setting
// ${table}
// ${/table}

$table = new \PhpOffice\PhpWord\Element\Table(['borderSize' => 12, 'borderColor' => 'green', 'width' => 6000,
    'unit' => TblWidth::TWIP]);
$table->addRow();
$table->addCell(150)->addText('Cell A1');
$table->addCell(150)->addText('Cell A2');
$table->addRow();
$table->addCell(150)->addText('Cell B1');
$table->addCell(150)->addText('Cell B2');

'complexBlocks' => [
     'table' => $table,
]

Key value pairs of template variable names and their values which will be replaced.

This must be a two dimensional array of variable names as keys and the complex object as the value.

For example,

// template setting
// Content: ${inline}

 $object = new \PhpOffice\PhpWord\Element\TextRun();
 $object->addText('by a red italic text', ['italic' => true, 'color' => 'red']);
'complexValues' => [
     'inline' => $object,
]

The output format whether 'docx' or 'pdf' or 'both'

Key value pairs of template image variable names and their values which will be replaced. The value must be full path to the image on the server.

// template setting
// ${company_logo}
// Company Name

'images' => [
     'company_logo' => '@webroot/uploads/company/logo.jpg'
]

The name of the template file with the extension (docx, odt, rtf)

The path where the Microsoft Word template files exist

The name of the output file without the PDF or DOCX extension

The path where the Microsoft Word output files will be saved

The pdf converter class to use. Defaults to kartik\wordreport\pdf\LibreOffice if not provided.

Key value pairs of template variable names in a table in the document and their values which will be replaced.

Each value must be an array of $values which will be repeated for number of items in the array. The key should typically match the first table column's variable name.

For example,

// template setting
// ----------+-------------+-----------
// ${item}   |    {$name}  | ${price}
// ----------+-------------+-----------
'rows' => [
     'item' => [
         [
              'item' => 1,
              'name' => 'Potato',
              'price' => '$10.00',
         ],
         [
              'item' => 2,
              'name' => 'Tomato',
              'price' => '$20.00',
         ],
     ]
]

the template processor object

Key value pairs of template variable names and their values which will be replaced. This must be a two dimensional array (which means a variable value must be string/int and cannot be an array).

// template setting
// Invoice No.: ${invoice_number}
// Invoice Dt: ${invoice_date}

'values' => [
     'invoice_number' => '1000',
     'invoice_date' => '22-Feb-2021',
]

Path to any custom XSL style sheet to apply if applicable