replaceVariableText

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

transform

XLSXUTILITIES

INDEXER

indexer

PERFORMANCE

zipStream

CRYPTO

DIGITAL SIGNATURE

sign (XLSX)

replaceVariableText

BASIC / ADVANCED / PREMIUM

Replaces placeholder variables with text.

Description

public replaceVariableText($variables, $options = array())

This method replaces a set of placeholder variables with plain text.

Remember that the phpxlsx template variables should be surrounded by $ symbols or whatever symbol you have chosen via the setTemplateSymbol method.

Parameters

variables

Array with the names of the placeholder template variables as keys and the plain text that should replace them as values.

options

The possible keys and values of this array are:

Key	Type	Description
target	string	sheets (default) [sharedStrings XML content], headers, footers, comments.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsxFromTemplate('template.xlsx');

// replace variables in the sheets target
$xlsx->replaceVariableText(array('VAR_1' => 'New value 1', 'VAR_2' => 'New value 2', 'VAR_SHEET_2' => 'internal descr', 'VAR_SHEET_2_B' => 'info content', 'IMAGE_TITLE' => 'Title image'), array('target' => 'sheets'));

// replace variables in the footers and headers targets
$xlsx->replaceVariableText(array('VAR_HEADER_2' => 'Header content', 'HEADERS_1_1' => 'Header A', 'HEADERS_1_2' => 'Header B'), array('target' => 'headers'));
$xlsx->replaceVariableText(array('VAR_FOOTER_2' => 'Footer content', 'FOOTER_1_3' => 'Footer A', 'FOOTER_3_3' => 'Footer C'), array('target' => 'footers'));

// replace variables in the comments target
$xlsx->replaceVariableText(array('VAR_COMMENT' => 'More content in the comment'), array('target' => 'comments'));

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 2.5:
- applied htmlspecialchars to content values.

phpxlsx 1.0:
- new method.