\PhpOffice\PhpWordTemplateProcessor

__construct()

__construct(string  $documentTemplate) 

Parameters

Throws

\PhpOffice\PhpWord\Exception\CreateTemporaryFileException

\PhpOffice\PhpWord\Exception\CopyFileException

applyXslStyleSheet()

applyXslStyleSheet(\DOMDocument  $xslDomDocument, array  $xslOptions = array(), string  $xslOptionsUri = '') 

Applies XSL style sheet to template's parts.

Note: since the method doesn't make any guess on logic of the provided XSL style sheet, make sure that output is correctly escaped. Otherwise you may get broken document.

Parameters

Throws

\PhpOffice\PhpWord\Exception\Exception

setValue()

setValue(mixed  $search, mixed  $replace, integer  $limit = self::MAXIMUM_REPLACEMENTS_DEFAULT) 

Parameters

getVariables()

getVariables() : array<mixed,string>

Returns array of all variables in template.

Returns

cloneRow()

cloneRow(string  $search, integer  $numberOfClones) 

Clone a table row in a template document.

Parameters

Throws

\PhpOffice\PhpWord\Exception\Exception

cloneBlock()

cloneBlock(string  $blockname, integer  $clones = 1, boolean  $replace = true) : string|null

Clone a block.

Parameters

Returns

replaceBlock()

replaceBlock(string  $blockname, string  $replacement) 

Replace a block.

Parameters

deleteBlock()

deleteBlock(string  $blockname) 

Delete a block of text.

Parameters

save()

save() : string

Saves the result document.

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

saveAs()

saveAs(string  $fileName) 

Saves the result document to the user defined file.

Parameters

transformSingleXml()

transformSingleXml(string  $xml, \XSLTProcessor  $xsltProcessor) : string

Parameters

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

transformXml()

transformXml(mixed  $xml, \XSLTProcessor  $xsltProcessor) : mixed

Parameters

Returns

ensureMacroCompleted()

ensureMacroCompleted(string  $macro) : string

Parameters

Returns

ensureUtf8Encoded()

ensureUtf8Encoded(string  $subject) : string

Parameters

Returns

fixBrokenMacros()

fixBrokenMacros(string  $documentPart) : string

Finds parts of broken macros and sticks them together.

Macros, while being edited, could be implicitly broken by some of the word processors.

Parameters

Returns

setValueForPart()

setValueForPart(mixed  $search, mixed  $replace, string  $documentPartXML, integer  $limit) : string

Find and replace macros in the given XML section.

Parameters

Returns

getVariablesForPart()

getVariablesForPart(string  $documentPartXML) : array<mixed,string>

Find all variables in $documentPartXML.

Parameters

Returns

getHeaderName()

getHeaderName(integer  $index) : string

Get the name of the header file for $index.

Parameters

Returns

getMainPartName()

getMainPartName() : string

Returns

getFooterName()

getFooterName(integer  $index) : string

Get the name of the footer file for $index.

Parameters

Returns

findRowStart()

findRowStart(integer  $offset) : integer

Find the start position of the nearest table row before $offset.

Parameters

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

findRowEnd()

findRowEnd(integer  $offset) : integer

Find the end position of the nearest table row after $offset.

Parameters

Returns

getSlice()

getSlice(integer  $startPosition, integer  $endPosition) : string

Get a slice of a string.

Parameters

Returns