Log in
Contact
Forum
replaceVariableByText
- addBibliography
- addBookmark
- addBreak
- addChart
- addCitation
- addComment
- addCrossReference
- addDateAndHour
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addLink
- addList
- addMathEquation
- addMergeField
- addOLE
- addOnlineVideo
- addPageNumber
- addShape
- addSimpleField
- addSource
- addStructuredDocumentTag
- addSVG
- addTab
- addTable
- addTableContents
- addTableFigures
- addText
- addTextBox
- addWordFragment
- addWordML
- embedHTML
- addBackgroundImage
- addFooter
- addFooterSection
- addHeader
- addHeaderSection
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createDocx
- createDocxAndDownload
- createCharacterStyle
- createListStyle
- createParagraphStyle
- createTableStyle
- docxSettings
- embedFont
- importChartStyle
- importHeadersAndFooters
- importListStyle
- importStyles
- importStylesWordDefault
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- setDecimalSymbol
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
- setRTL
- clearBlocks
- cloneBlock
- deleteBlock
- getTemplateVariables
- getTemplateVariablesType
- modifyInputFields
- modifyMergeFields
- processTemplate
- removeTemplateVariable
- removeTemplateVariableImage
- replaceBlock
- replaceListVariable
- replacePlaceholderImage
- replaceTableVariable
- replaceVariableByExternalFile
- replaceVariableByHtml
- replaceVariableByText
- replaceVariableByWordFragment
- replaceVariableByWordML
- setTemplateSymbol
- setTemplateBlockSymbol
- tickCheckboxes
replaceVariableByText
TRIAL / ADVANCED / PREMIUM
Replaces placeholder variables by text.
Description
public replaceVariableByText (array $variables[, array $options])
This method is designed to replace a set of placeholder variables by plain text.
Remember that the phpdocx template variables should be surrounded by $ symbols or whatever symbol you have chosen via the setTemplateSymbol method.
Parameters
variables
This must be an 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 |
|---|---|---|
| firstMatch | bool | If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only replace the first occurrence of the variable within the Word document. |
| parseLineBreaks | bool | If true (default is false) parses the line breaks to include them in the Word document. |
| target | string | Possible values are: document (default), header, footer, footnote, endnote, comment. This option sets the scope of the replacement procedure. |
| raw | bool | if true (default is false) replaces the variable by a string regardless the variable scope (tag values, attributes...). Only allows to replace a variable by a plain string. Use with caution. |
Code samples
Example #1
The resulting Word document looks like:
Release notes
- phpdocx 6.0:
- supported literals like '\n' and carriage returns like "\n" with the parseLineBreaks option.
- raw option.