2021-03-08 01:07:47 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Documentation< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< base href = "../" >
< link rel = "icon" href = "images/favicon.ico" / >
< link rel = "stylesheet" href = "css/normalize.css" >
< link rel = "stylesheet" href = "css/base.css" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
< link rel = "stylesheet" href = "css/template.css" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity = "sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin = "anonymous" / >
< script src = "https://cdn.jsdelivr.net/npm/fuse.js@3.4.6" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity = "sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin = "anonymous" > < / script >
< script src = "js/search.js" > < / script >
< script defer src = "js/searchIndex.js" > < / script >
< / head >
< body id = "top" >
< header class = "phpdocumentor-header phpdocumentor-section" >
< h1 class = "phpdocumentor-title" > < a href = "" class = "phpdocumentor-title__link" > Documentation< / a > < / h1 >
< input class = "phpdocumentor-header__menu-button" type = "checkbox" id = "menu-button" name = "menu-button" / >
< label class = "phpdocumentor-header__menu-icon" for = "menu-button" >
< i class = "fas fa-bars" > < / i >
< / label >
< section data-search-form class = "phpdocumentor-search" >
< label >
< span class = "visually-hidden" > Search for< / span >
< svg class = "phpdocumentor-search__icon" width = "21" height = "20" viewBox = "0 0 21 20" fill = "none" xmlns = "http://www.w3.org/2000/svg" >
< circle cx = "7.5" cy = "7.5" r = "6.5" stroke = "currentColor" stroke-width = "2" / >
< line x1 = "12.4892" y1 = "12.2727" x2 = "19.1559" y2 = "18.9393" stroke = "currentColor" stroke-width = "3" / >
< / svg >
< input type = "search" class = "phpdocumentor-field phpdocumentor-search__field" placeholder = "Loading .." disabled / >
< / label >
< / section >
< nav class = "phpdocumentor-topnav" >
< ul class = "phpdocumentor-topnav__menu" >
< / ul >
< / nav >
< / header >
< main class = "phpdocumentor" >
< div class = "phpdocumentor-section" >
< input class = "phpdocumentor-sidebar__menu-button" type = "checkbox" id = "sidebar-button" name = "sidebar-button" / >
< label class = "phpdocumentor-sidebar__menu-icon" for = "sidebar-button" >
Menu
< / label >
< aside class = "phpdocumentor-column -four phpdocumentor-sidebar" >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Namespaces< / h2 >
< h3 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/default.html" > < abbr title = "\" > Global< / abbr > < / a > < / h3 >
< h4 class = "phpdocumentor-sidebar__root-namespace" > < a href = "namespaces/phpoffice.html" > < abbr title = "\PhpOffice" > PhpOffice< / abbr > < / a > < / h4 >
< ul class = "phpdocumentor-list" >
< li > < a href = "namespaces/phpoffice-phpword.html" > < abbr title = "\PhpOffice\PhpWord" > PhpWord< / abbr > < / a > < / li >
< / ul >
< / section >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Reports< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/deprecated.html" > Deprecated< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/errors.html" > Errors< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/markers.html" > Markers< / a > < / h3 >
< / section >
< section class = "phpdocumentor-sidebar__category" >
< h2 class = "phpdocumentor-sidebar__category-header" > Indices< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "indices/files.html" > Files< / a > < / h3 >
< / section >
< / aside >
< div class = "phpdocumentor-column -eight phpdocumentor-content" >
< ul class = "phpdocumentor-breadcrumbs" >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/phpoffice.html" > PhpOffice< / a > < / li >
< li class = "phpdocumentor-breadcrumb" > < a href = "namespaces/phpoffice-phpword.html" > PhpWord< / a > < / li >
< / ul >
< article class = "phpdocumentor-element -class" >
< h2 class = "phpdocumentor-content__title" >
TemplateProcessor
< / h2 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 32< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< h3 id = "toc" >
Table of Contents
< a href = "#toc" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< dl class = "phpdocumentor-table-of-contents" >
< dt class = "phpdocumentor-table-of-contents__entry -constant -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#constant_MAXIMUM_REPLACEMENTS_DEFAULT" > MAXIMUM_REPLACEMENTS_DEFAULT< / a >
< span >
= -1 < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentContentTypes" > $tempDocumentContentTypes< / a >
< span >
: string < / span >
< / dt >
< dd > Document content types (in XML format) of the temporary document.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentFilename" > $tempDocumentFilename< / a >
< span >
: string < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentFooters" > $tempDocumentFooters< / a >
< span >
: array< string|int, string> < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Content of footers (in XML format) of the temporary document.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentHeaders" > $tempDocumentHeaders< / a >
< span >
: array< string|int, string> < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Content of headers (in XML format) of the temporary document.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentMainPart" > $tempDocumentMainPart< / a >
< span >
: string < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Content of main document part (in XML format) of the temporary document.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentNewImages" > $tempDocumentNewImages< / a >
< span >
: array< string|int, string> < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > new inserted images list.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentRelations" > $tempDocumentRelations< / a >
< span >
: array< string|int, string> < / span >
< / dt >
< dd > Document relations (in XML format) of the temporary document.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentSettingsPart" > $tempDocumentSettingsPart< / a >
< span >
: string < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Content of settings part (in XML format) of the temporary document.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -property -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_zipClass" > $zipClass< / a >
< span >
: mixed < / span >
< / dt >
< dd > ZipArchive object.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method___construct" > __construct()< / a >
< span >
: mixed < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_applyXslStyleSheet" > applyXslStyleSheet()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Applies XSL style sheet to template' s parts.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_cloneBlock" > cloneBlock()< / a >
< span >
2022-11-15 20:28:31 +00:00
: null|string < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Clone a block.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_cloneRow" > cloneRow()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Clone a table row in a template document.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_cloneRowAndSetValues" > cloneRowAndSetValues()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Clones a table row and populates it' s values from a two-dimensional array in a template document.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_deleteBlock" > deleteBlock()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Delete a block of text.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getVariableCount" > getVariableCount()< / a >
< span >
: array< string|int, mixed> < / span >
< / dt >
< dd > Returns count of all variables in template.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getVariables" > getVariables()< / a >
< span >
: array< string|int, string> < / span >
< / dt >
< dd > Returns array of all variables in template.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_replaceBlock" > replaceBlock()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Replace a block.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_replaceXmlBlock" > replaceXmlBlock()< / a >
< span >
: < a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html" > < abbr title = "\PhpOffice\PhpWord\TemplateProcessor" > TemplateProcessor< / abbr > < / a > < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Replace an XML block surrounding a macro with a new block.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_save" > save()< / a >
< span >
: string < / span >
< / dt >
< dd > Saves the result document.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_saveAs" > saveAs()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Saves the result document to the user defined file.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setChart" > setChart()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setComplexBlock" > setComplexBlock()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setComplexValue" > setComplexValue()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setImageValue" > setImageValue()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setUpdateFields" > setUpdateFields()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Automatically Recalculate Fields on Open.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setValue" > setValue()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setValues" > setValues()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > Set values from a one-dimensional array of " variable => value" -pairs.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -public" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_zip" > zip()< / a >
< span >
: < a href = "classes/PhpOffice-PhpWord-Shared-ZipArchive.html" > < abbr title = "\PhpOffice\PhpWord\Shared\ZipArchive" > ZipArchive< / abbr > < / a > < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Expose zip class.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_ensureMacroCompleted" > ensureMacroCompleted()< / a >
< span >
: string < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_ensureUtf8Encoded" > ensureUtf8Encoded()< / a >
< span >
: string < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findContainingXmlBlockForMacro" > findContainingXmlBlockForMacro()< / a >
< span >
: bool|array< string|int, int> < / span >
< / dt >
< dd > Find start and end of XML block containing the given macro
2022-11-15 20:28:31 +00:00
e.g. < w:p> ...${macro}...< /w:p> .< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findMacro" > findMacro()< / a >
< span >
: int < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Find the position of (the start of) a macro.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findRowEnd" > findRowEnd()< / a >
< span >
: int < / span >
< / dt >
< dd > Find the end position of the nearest table row after $offset.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findRowStart" > findRowStart()< / a >
< span >
: int < / span >
< / dt >
< dd > Find the start position of the nearest table row before $offset.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findXmlBlockEnd" > findXmlBlockEnd()< / a >
< span >
: int < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Find the nearest block end position after $offset.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findXmlBlockStart" > findXmlBlockStart()< / a >
< span >
: int < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Find the start position of the nearest XML block start before $offset.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_fixBrokenMacros" > fixBrokenMacros()< / a >
< span >
: string < / span >
< / dt >
< dd > Finds parts of broken macros and sticks them together.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getDocumentContentTypesName" > getDocumentContentTypesName()< / a >
< span >
: string < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getFooterName" > getFooterName()< / a >
< span >
: string < / span >
< / dt >
< dd > Get the name of the footer file for $index.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getHeaderName" > getHeaderName()< / a >
< span >
: string < / span >
< / dt >
< dd > Get the name of the header file for $index.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getMainPartName" > getMainPartName()< / a >
< span >
: string < / span >
< / dt >
< dd > Usually, the name of main part document will be ' document.xml' . However, some .docx files (possibly those from Office 365, experienced also on documents from Word Online created from blank templates) have file ' document22.xml' in their zip archive instead of ' document.xml' . This method searches content types file to correctly determine the file name.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getNextRelationsIndex" > getNextRelationsIndex()< / a >
< span >
: mixed < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getRelationsName" > getRelationsName()< / a >
< span >
: string < / span >
< / dt >
< dd > Get the name of the relations file for document part.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getSettingsPartName" > getSettingsPartName()< / a >
< span >
: string < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > The name of the file containing the Settings part.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getSlice" > getSlice()< / a >
< span >
: string < / span >
< / dt >
< dd > Get a slice of a string.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getVariablesForPart" > getVariablesForPart()< / a >
< span >
: array< string|int, string> < / span >
< / dt >
< dd > Find all variables in $documentPartXML.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_indexClonedVariables" > indexClonedVariables()< / a >
< span >
: string < / span >
< / dt >
< dd > Replaces variable names in cloned
2022-11-15 20:28:31 +00:00
rows/blocks with indexed names.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_readPartWithRels" > readPartWithRels()< / a >
< span >
: string < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_replaceClonedVariables" > replaceClonedVariables()< / a >
< span >
: array< string|int, string> < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Raplaces variables with values from array, array keys are the variable names.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_savePartWithRels" > savePartWithRels()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setValueForPart" > setValueForPart()< / a >
< span >
: string < / span >
< / dt >
< dd > Find and replace macros in the given XML section.< / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_splitTextIntoTexts" > splitTextIntoTexts()< / a >
< span >
: string < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Splits a w:r/w:t into a list of w:r where each ${macro} is in a separate w:r.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_textNeedsSplitting" > textNeedsSplitting()< / a >
< span >
: bool < / span >
< / dt >
2022-11-15 20:28:31 +00:00
< dd > Returns true if string contains a macro that is not in it' s own w:r.< / dd >
2021-03-08 01:07:47 +00:00
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_transformSingleXml" > transformSingleXml()< / a >
< span >
: string < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -protected" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_transformXml" > transformXml()< / a >
< span >
: mixed < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_addImageToRelations" > addImageToRelations()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_chooseImageDimension" > chooseImageDimension()< / a >
< span >
: mixed < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_fixImageWidthHeightRatio" > fixImageWidthHeightRatio()< / a >
< span >
2022-11-15 20:28:31 +00:00
: void < / span >
2021-03-08 01:07:47 +00:00
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getImageArgs" > getImageArgs()< / a >
< span >
: mixed < / span >
< / dt >
< dd > < / dd >
< dt class = "phpdocumentor-table-of-contents__entry -method -private" >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_prepareImageAttrs" > prepareImageAttrs()< / a >
< span >
: mixed < / span >
< / dt >
< dd > < / dd >
< / dl >
< section class = "phpdocumentor-constants" >
< h3 class = "phpdocumentor-elements__header" id = "constants" >
Constants
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#constants" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article class = "phpdocumentor-element -constant -public " >
< h4 class = "phpdocumentor-element__name" id = "constant_MAXIMUM_REPLACEMENTS_DEFAULT" >
MAXIMUM_REPLACEMENTS_DEFAULT
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#constant_MAXIMUM_REPLACEMENTS_DEFAULT" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 34< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-signature phpdocumentor-code " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__type" > mixed< / span >
< span class = "phpdocumentor-signature__name" > MAXIMUM_REPLACEMENTS_DEFAULT< / span >
= < span class = "phpdocumentor-signature__default-value" > -1< / span >
< / code >
< / article >
< / section >
< section class = "phpdocumentor-properties" >
< h3 class = "phpdocumentor-elements__header" id = "properties" >
Properties
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#properties" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentContentTypes" >
$tempDocumentContentTypes
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentContentTypes" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 88< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Document content types (in XML format) of the temporary document.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentContentTypes< / span >
= < span class = "phpdocumentor-signature__default-value" > ' ' < / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentFilename" >
$tempDocumentFilename
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentFilename" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 46< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentFilename< / span >
< / code >
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentFooters" >
$tempDocumentFooters
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentFooters" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 74< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Content of footers (in XML format) of the temporary document.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, string> < / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentFooters< / span >
2022-11-15 20:28:31 +00:00
= < span class = "phpdocumentor-signature__default-value" > []< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentHeaders" >
$tempDocumentHeaders
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentHeaders" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 67< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Content of headers (in XML format) of the temporary document.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, string> < / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentHeaders< / span >
2022-11-15 20:28:31 +00:00
= < span class = "phpdocumentor-signature__default-value" > []< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentMainPart" >
$tempDocumentMainPart
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentMainPart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 53< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Content of main document part (in XML format) of the temporary document.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentMainPart< / span >
< / code >
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentNewImages" >
$tempDocumentNewImages
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentNewImages" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 95< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > new inserted images list.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, string> < / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentNewImages< / span >
2022-11-15 20:28:31 +00:00
= < span class = "phpdocumentor-signature__default-value" > []< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentRelations" >
$tempDocumentRelations
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentRelations" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 81< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Document relations (in XML format) of the temporary document.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > array< string|int, string> < / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentRelations< / span >
2022-11-15 20:28:31 +00:00
= < span class = "phpdocumentor-signature__default-value" > []< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_tempDocumentSettingsPart" >
$tempDocumentSettingsPart
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_tempDocumentSettingsPart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 60< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Content of settings part (in XML format) of the temporary document.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > string< / span >
< span class = "phpdocumentor-signature__name" > $tempDocumentSettingsPart< / span >
< / code >
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="
phpdocumentor-element
-property
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "property_zipClass" >
$zipClass
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#property_zipClass" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< span class = "phpdocumentor-element__modifiers" >
< / span >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 41< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > ZipArchive object.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__type" > mixed< / span >
< span class = "phpdocumentor-signature__name" > $zipClass< / span >
< / code >
< section class = "phpdocumentor-description" > < / section >
< / article >
< / section >
< section class = "phpdocumentor-methods" >
< h3 class = "phpdocumentor-elements__header" id = "methods" >
Methods
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#methods" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h3 >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method___construct" >
__construct()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method___construct" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 102< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > __construct< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $documentTemplate< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $documentTemplate< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The fully qualified template filename< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 0.12.0< / span >
< section class = "phpdocumentor-description" > < p > Throws CreateTemporaryFileException and CopyFileException instead of Exception< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_applyXslStyleSheet" >
applyXslStyleSheet()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_applyXslStyleSheet" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 220< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Applies XSL style sheet to template' s parts.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > applyXslStyleSheet< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > < abbr title = "\DOMDocument" > DOMDocument< / abbr > < / span > < span class = "phpdocumentor-signature__argument__name" > $xslDomDocument< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $xslOptions< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > []< / span > < span > ]< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $xslOptionsUri< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > ' ' < / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < p > 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.< / p >
< / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xslDomDocument< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < abbr title = "\DOMDocument" > DOMDocument< / abbr > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xslOptions< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
2022-11-15 20:28:31 +00:00
= < span class = "phpdocumentor-signature__argument__default-value" > []< / span > < / dt >
2021-03-08 01:07:47 +00:00
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xslOptionsUri< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > ' ' < / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_cloneBlock" >
cloneBlock()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_cloneBlock" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 791< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Clone a block.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > cloneBlock< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockname< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $clones< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > 1< / span > < span > ]< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > bool < / span > < span class = "phpdocumentor-signature__argument__name" > $replace< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > true< / span > < span > ]< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > bool < / span > < span class = "phpdocumentor-signature__argument__name" > $indexVariables< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > false< / span > < span > ]< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $variableReplacements< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > null< / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > null|string< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockname< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $clones< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > 1< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > How many time the block should be cloned< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $replace< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > bool< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > true< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $indexVariables< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > bool< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > false< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > If true, any variables inside the block will be indexed (postfixed with #1, #2, ...)< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $variableReplacements< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
= < span class = "phpdocumentor-signature__argument__default-value" > null< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Array containing replacements for macros found inside the block to clone< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > null|string< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_cloneRow" >
cloneRow()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_cloneRow" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 716< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Clone a table row in a template document.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > cloneRow< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $numberOfClones< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $numberOfClones< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_cloneRowAndSetValues" >
cloneRowAndSetValues()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_cloneRowAndSetValues" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 768< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Clones a table row and populates it' s values from a two-dimensional array in a template document.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > cloneRowAndSetValues< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $values< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $values< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_deleteBlock" >
deleteBlock()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_deleteBlock" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 855< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Delete a block of text.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > deleteBlock< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockname< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockname< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getVariableCount" >
getVariableCount()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getVariableCount" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 679< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns count of all variables in template.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > getVariableCount< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, mixed> < / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, mixed> < / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getVariables" >
getVariables()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getVariables" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 705< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Returns array of all variables in template.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > getVariables< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, string> < / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, string> < / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_replaceBlock" >
replaceBlock()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_replaceBlock" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 832< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Replace a block.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > replaceBlock< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockname< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $replacement< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockname< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $replacement< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_replaceXmlBlock" >
replaceXmlBlock()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_replaceXmlBlock" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1182< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Replace an XML block surrounding a macro with a new block.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > replaceXmlBlock< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $macro< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $block< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockType< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > ' w:p' < / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > < a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html" > < abbr title = "\PhpOffice\PhpWord\TemplateProcessor" > TemplateProcessor< / abbr > < / a > < / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $macro< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Name of macro< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $block< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > New block content< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > ' w:p' < / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > XML tag type of block< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > < a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html" > < abbr title = "\PhpOffice\PhpWord\TemplateProcessor" > TemplateProcessor< / abbr > < / a > < / span >
—
< section class = "phpdocumentor-description" > < p > Fluent interface< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_save" >
save()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_save" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 881< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Saves the result document.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > save< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_saveAs" >
saveAs()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_saveAs" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 924< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Saves the result document to the user defined file.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > saveAs< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $fileName< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $fileName< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-tag-list__heading" id = "tags" >
Tags
< a href = "#tags" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h5 >
< dl class = "phpdocumentor-tag-list" >
< dt class = "phpdocumentor-tag-list__entry" >
< span class = "phpdocumentor-tag__name" > since< / span >
< / dt >
< dd class = "phpdocumentor-tag-list__definition" >
< span class = "phpdocumentor-tag-link" > 0.8.0< / span >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setChart" >
setChart()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setChart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 355< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setChart< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/PhpOffice-PhpWord-Element-AbstractElement.html" > < abbr title = "\PhpOffice\PhpWord\Element\AbstractElement" > AbstractElement< / abbr > < / a > < / span > < span class = "phpdocumentor-signature__argument__name" > $chart< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $chart< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/PhpOffice-PhpWord-Element-AbstractElement.html" > < abbr title = "\PhpOffice\PhpWord\Element\AbstractElement" > AbstractElement< / abbr > < / a > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setComplexBlock" >
setComplexBlock()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setComplexBlock" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 294< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setComplexBlock< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/PhpOffice-PhpWord-Element-AbstractElement.html" > < abbr title = "\PhpOffice\PhpWord\Element\AbstractElement" > AbstractElement< / abbr > < / a > < / span > < span class = "phpdocumentor-signature__argument__name" > $complexType< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $complexType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/PhpOffice-PhpWord-Element-AbstractElement.html" > < abbr title = "\PhpOffice\PhpWord\Element\AbstractElement" > AbstractElement< / abbr > < / a > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setComplexValue" >
setComplexValue()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setComplexValue" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 266< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setComplexValue< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/PhpOffice-PhpWord-Element-AbstractElement.html" > < abbr title = "\PhpOffice\PhpWord\Element\AbstractElement" > AbstractElement< / abbr > < / a > < / span > < span class = "phpdocumentor-signature__argument__name" > $complexType< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $complexType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < a href = "classes/PhpOffice-PhpWord-Element-AbstractElement.html" > < abbr title = "\PhpOffice\PhpWord\Element\AbstractElement" > AbstractElement< / abbr > < / a > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setImageValue" >
setImageValue()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setImageValue" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 598< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setImageValue< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $replace< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $limit< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > self::MAXIMUM_REPLACEMENTS_DEFAULT< / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $replace< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Path to image, or array(" path" => xx, " width" => yy, " height" => zz)< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $limit< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > self::MAXIMUM_REPLACEMENTS_DEFAULT< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setUpdateFields" >
setUpdateFields()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setUpdateFields" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 865< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Automatically Recalculate Fields on Open.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setUpdateFields< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span class = "phpdocumentor-signature__argument__return-type" > bool < / span > < span class = "phpdocumentor-signature__argument__name" > $update< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > true< / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $update< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > bool< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > true< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setValue" >
setValue()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setValue" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 312< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setValue< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $replace< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $limit< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > self::MAXIMUM_REPLACEMENTS_DEFAULT< / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $replace< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $limit< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > self::MAXIMUM_REPLACEMENTS_DEFAULT< / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setValues" >
setValues()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setValues" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 345< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Set values from a one-dimensional array of " variable => value" -pairs.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > setValues< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $values< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $values< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
2022-11-15 20:28:31 +00:00
2021-03-08 01:07:47 +00:00
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-public
"
>
< h4 class = "phpdocumentor-element__name" id = "method_zip" >
zip()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_zip" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 142< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Expose zip class.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > public< / span >
< span class = "phpdocumentor-signature__name" > zip< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > < a href = "classes/PhpOffice-PhpWord-Shared-ZipArchive.html" > < abbr title = "\PhpOffice\PhpWord\Shared\ZipArchive" > ZipArchive< / abbr > < / a > < / span > < / code >
< section class = "phpdocumentor-description" > < p > To replace an image: $templateProcessor-> zip()-> AddFromString(" word/media/image1.jpg" , file_get_contents($file));< br >
To read a file: $templateProcessor-> zip()-> getFromName(" word/media/image1.jpg" );< / p >
< / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > < a href = "classes/PhpOffice-PhpWord-Shared-ZipArchive.html" > < abbr title = "\PhpOffice\PhpWord\Shared\ZipArchive" > ZipArchive< / abbr > < / a > < / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
-static "
>
< h4 class = "phpdocumentor-element__name" id = "method_ensureMacroCompleted" >
ensureMacroCompleted()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_ensureMacroCompleted" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 239< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__static" > static< / span > < span class = "phpdocumentor-signature__name" > ensureMacroCompleted< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $macro< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $macro< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
-static "
>
< h4 class = "phpdocumentor-element__name" id = "method_ensureUtf8Encoded" >
ensureUtf8Encoded()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_ensureUtf8Encoded" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 253< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__static" > static< / span > < span class = "phpdocumentor-signature__name" > ensureUtf8Encoded< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $subject< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $subject< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_findContainingXmlBlockForMacro" >
findContainingXmlBlockForMacro()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findContainingXmlBlockForMacro" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1203< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Find start and end of XML block containing the given macro
2022-11-15 20:28:31 +00:00
e.g. < w:p> ...${macro}...< /w:p> .< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > findContainingXmlBlockForMacro< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $macro< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > [< / span > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockType< / span > < span > = < / span > < span class = "phpdocumentor-signature__argument__default-value" > ' w:p' < / span > < span > ]< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > bool|array< string|int, int> < / span > < / code >
< section class = "phpdocumentor-description" > < p > Note that only the first instance of the macro will be found< / p >
< / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $macro< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Name of macro< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
= < span class = "phpdocumentor-signature__argument__default-value" > ' w:p' < / span > < / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > XML tag for block< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > bool|array< string|int, int> < / span >
—
< section class = "phpdocumentor-description" > < p > FALSE if not found, otherwise array with start and end< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_findMacro" >
findMacro()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findMacro" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1234< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Find the position of (the start of) a macro.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > findMacro< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $offset< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
< section class = "phpdocumentor-description" > < p > Returns -1 if not found, otherwise position of opening $< / p >
< p > Note that only the first instance of the macro will be found< / p >
< / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Macro name< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $offset< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Offset from which to start searching< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< section class = "phpdocumentor-description" > < p > -1 if macro not found< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_findRowEnd" >
findRowEnd()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findRowEnd" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1110< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Find the end position of the nearest table row after $offset.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > findRowEnd< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $offset< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $offset< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_findRowStart" >
findRowStart()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findRowStart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1089< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Find the start position of the nearest table row before $offset.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > findRowStart< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $offset< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $offset< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_findXmlBlockEnd" >
findXmlBlockEnd()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findXmlBlockEnd" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1272< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Find the nearest block end position after $offset.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > findXmlBlockEnd< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $offset< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockType< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $offset< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Search position< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > XML Block tag< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< section class = "phpdocumentor-description" > < p > -1 if block end not found< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_findXmlBlockStart" >
findXmlBlockStart()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_findXmlBlockStart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1250< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Find the start position of the nearest XML block start before $offset.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > findXmlBlockStart< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $offset< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $blockType< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > int< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $offset< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > Search position< / p >
< / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $blockType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > XML Block tag< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > int< / span >
—
< section class = "phpdocumentor-description" > < p > -1 if block start not found< / p >
< / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_fixBrokenMacros" >
fixBrokenMacros()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_fixBrokenMacros" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 950< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Finds parts of broken macros and sticks them together.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > fixBrokenMacros< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $documentPart< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < p > Macros, while being edited, could be implicitly broken by some of the word processors.< / p >
< / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $documentPart< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < p > The document part in XML representation< / p >
< / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getDocumentContentTypesName" >
getDocumentContentTypesName()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getDocumentContentTypesName" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1077< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getDocumentContentTypesName< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getFooterName" >
getFooterName()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getFooterName" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1043< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Get the name of the footer file for $index.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getFooterName< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $index< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $index< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getHeaderName" >
getHeaderName()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getHeaderName" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1004< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Get the name of the header file for $index.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getHeaderName< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $index< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $index< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getMainPartName" >
getMainPartName()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getMainPartName" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1014< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Usually, the name of main part document will be ' document.xml' . However, some .docx files (possibly those from Office 365, experienced also on documents from Word Online created from blank templates) have file ' document22.xml' in their zip archive instead of ' document.xml' . This method searches content types file to correctly determine the file name.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getMainPartName< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getNextRelationsIndex" >
getNextRelationsIndex()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getNextRelationsIndex" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1060< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getNextRelationsIndex< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $documentPartName< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $documentPartName< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getRelationsName" >
getRelationsName()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getRelationsName" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1055< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Get the name of the relations file for document part.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getRelationsName< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $documentPartName< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $documentPartName< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getSettingsPartName" >
getSettingsPartName()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getSettingsPartName" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1031< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > The name of the file containing the Settings part.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getSettingsPartName< / span > < span > (< / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getSlice" >
getSlice()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getSlice" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1123< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Get a slice of a string.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getSlice< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $startPosition< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $endPosition< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $startPosition< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $endPosition< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getVariablesForPart" >
getVariablesForPart()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getVariablesForPart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 989< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Find all variables in $documentPartXML.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > getVariablesForPart< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $documentPartXML< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, string> < / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $documentPartXML< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, string> < / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_indexClonedVariables" >
indexClonedVariables()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_indexClonedVariables" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1141< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Replaces variable names in cloned
2022-11-15 20:28:31 +00:00
rows/blocks with indexed names.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > indexClonedVariables< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $count< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $xmlBlock< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $count< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xmlBlock< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_readPartWithRels" >
readPartWithRels()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_readPartWithRels" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 152< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > readPartWithRels< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $fileName< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $fileName< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_replaceClonedVariables" >
replaceClonedVariables()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_replaceClonedVariables" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1159< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Raplaces variables with values from array, array keys are the variable names.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > replaceClonedVariables< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span > < span class = "phpdocumentor-signature__argument__name" > $variableReplacements< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $xmlBlock< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > array< string|int, string> < / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $variableReplacements< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > array< string|int, mixed> < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xmlBlock< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > array< string|int, string> < / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_savePartWithRels" >
savePartWithRels()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_savePartWithRels" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 908< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > savePartWithRels< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $fileName< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $xml< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $fileName< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xml< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_setValueForPart" >
setValueForPart()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_setValueForPart" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 971< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< p class = "phpdocumentor-summary" > Find and replace macros in the given XML section.< / p >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > setValueForPart< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $search< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $replace< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $documentPartXML< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > int < / span > < span class = "phpdocumentor-signature__argument__name" > $limit< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $search< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $replace< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $documentPartXML< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $limit< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > int< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_splitTextIntoTexts" >
splitTextIntoTexts()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_splitTextIntoTexts" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1287< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Splits a w:r/w:t into a list of w:r where each ${macro} is in a separate w:r.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > splitTextIntoTexts< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $text< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $text< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_textNeedsSplitting" >
textNeedsSplitting()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_textNeedsSplitting" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 1312< / span >
2021-03-08 01:07:47 +00:00
< / aside >
2022-11-15 20:28:31 +00:00
< p class = "phpdocumentor-summary" > Returns true if string contains a macro that is not in it' s own w:r.< / p >
2021-03-08 01:07:47 +00:00
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > textNeedsSplitting< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $text< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > bool< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $text< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > bool< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_transformSingleXml" >
transformSingleXml()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_transformSingleXml" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 169< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > transformSingleXml< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > string < / span > < span class = "phpdocumentor-signature__argument__name" > $xml< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > < abbr title = "\XSLTProcessor" > XSLTProcessor< / abbr > < / span > < span class = "phpdocumentor-signature__argument__name" > $xsltProcessor< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > string< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xml< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > string< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xsltProcessor< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < abbr title = "\XSLTProcessor" > XSLTProcessor< / abbr > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > string< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-protected
"
>
< h4 class = "phpdocumentor-element__name" id = "method_transformXml" >
transformXml()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_transformXml" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 196< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > protected< / span >
< span class = "phpdocumentor-signature__name" > transformXml< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $xml< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > < abbr title = "\XSLTProcessor" > XSLTProcessor< / abbr > < / span > < span class = "phpdocumentor-signature__argument__name" > $xsltProcessor< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< section class = "phpdocumentor-description" > < / section >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xml< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $xsltProcessor< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > < abbr title = "\XSLTProcessor" > XSLTProcessor< / abbr > < / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< section class = "phpdocumentor-description" > < / section >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "method_addImageToRelations" >
addImageToRelations()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_addImageToRelations" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 544< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > addImageToRelations< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $partFileName< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $rid< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $imgPath< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $imageMimeType< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $partFileName< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $rid< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $imgPath< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $imageMimeType< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "method_chooseImageDimension" >
chooseImageDimension()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_chooseImageDimension" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 430< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > chooseImageDimension< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $baseValue< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $inlineValue< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $defaultValue< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $baseValue< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $inlineValue< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $defaultValue< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "method_fixImageWidthHeightRatio" >
fixImageWidthHeightRatio()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_fixImageWidthHeightRatio" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 449< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__name" > fixImageWidthHeightRatio< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__reference-operator" > & < / span > < span class = "phpdocumentor-signature__argument__name" > $width< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__reference-operator" > & < / span > < span class = "phpdocumentor-signature__argument__name" > $height< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $actualWidth< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $actualHeight< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > void< / span > < / code >
2021-03-08 01:07:47 +00:00
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $width< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $height< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $actualWidth< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $actualHeight< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-signature__response_type" > void< / span >
2021-03-08 01:07:47 +00:00
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "method_getImageArgs" >
getImageArgs()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_getImageArgs" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 391< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > getImageArgs< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $varNameWithArgs< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $varNameWithArgs< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< article
class="phpdocumentor-element
-method
-private
"
>
< h4 class = "phpdocumentor-element__name" id = "method_prepareImageAttrs" >
prepareImageAttrs()
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#method_prepareImageAttrs" class = "headerlink" > < i class = "fas fa-link" > < / i > < / a >
< / h4 >
< aside class = "phpdocumentor-element-found-in" >
< abbr class = "phpdocumentor-element-found-in__file" title = "src/PhpWord/TemplateProcessor.php" > < a href = "files/src-phpword-templateprocessor.html" > < abbr title = "src/PhpWord/TemplateProcessor.php" > TemplateProcessor.php< / abbr > < / a > < / abbr >
:
2022-11-15 20:28:31 +00:00
< span class = "phpdocumentor-element-found-in__line" > 489< / span >
2021-03-08 01:07:47 +00:00
< / aside >
< code class = "phpdocumentor-code phpdocumentor-signature " >
< span class = "phpdocumentor-signature__visibility" > private< / span >
< span class = "phpdocumentor-signature__name" > prepareImageAttrs< / span > < span > (< / span > < span class = "phpdocumentor-signature__argument" > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $replaceImage< / span > < / span > < span class = "phpdocumentor-signature__argument" > < span > , < / span > < span class = "phpdocumentor-signature__argument__return-type" > mixed < / span > < span class = "phpdocumentor-signature__argument__name" > $varInlineArgs< / span > < / span > < span > )< / span > < span > : < / span > < span class = "phpdocumentor-signature__response_type" > mixed< / span > < / code >
< h5 class = "phpdocumentor-argument-list__heading" > Parameters< / h5 >
< dl class = "phpdocumentor-argument-list" >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $replaceImage< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< dt class = "phpdocumentor-argument-list__entry" >
< span class = "phpdocumentor-signature__argument__name" > $varInlineArgs< / span >
: < span class = "phpdocumentor-signature__argument__return-type" > mixed< / span >
< / dt >
< dd class = "phpdocumentor-argument-list__definition" >
< / dd >
< / dl >
< h5 class = "phpdocumentor-return-value__heading" > Return values< / h5 >
< span class = "phpdocumentor-signature__response_type" > mixed< / span >
—
< section class = "phpdocumentor-description" > < / section >
< / article >
< / section >
< / article >
< section data-search-results class = "phpdocumentor-search-results phpdocumentor-search-results--hidden" >
< section class = "phpdocumentor-search-results__dialog" >
< header class = "phpdocumentor-search-results__header" >
< h2 class = "phpdocumentor-search-results__title" > Search results< / h2 >
< button class = "phpdocumentor-search-results__close" > < i class = "fas fa-times" > < / i > < / button >
< / header >
< section class = "phpdocumentor-search-results__body" >
< ul class = "phpdocumentor-search-results__entries" > < / ul >
< / section >
< / section >
< / section >
< / div >
< / div >
< a href = "classes/PhpOffice-PhpWord-TemplateProcessor.html#top" class = "phpdocumentor-back-to-top" > < i class = "fas fa-chevron-circle-up" > < / i > < / a >
< / main >
< script >
cssVars({});
< / script >
< / body >
< / html >
