Project Risks
diff --git a/coverage/Writer/index.html b/coverage/Writer/index.html index ce896b3de8..e48b624723 100644 --- a/coverage/Writer/index.html +++ b/coverage/Writer/index.html @@ -404,7 +404,7 @@Legend
High: 90% to 100%- Generated by php-code-coverage 9.2.29 using PHP 8.1.27 and PHPUnit 9.6.14 at Thu Dec 28 9:53:54 UTC 2023. + Generated by php-code-coverage 9.2.29 using PHP 8.1.27 and PHPUnit 9.6.14 at Sat Jan 6 17:42:38 UTC 2024.
diff --git a/coverage/dashboard.html b/coverage/dashboard.html index 3e344952da..dd807eaf59 100644 --- a/coverage/dashboard.html +++ b/coverage/dashboard.html @@ -230,7 +230,7 @@Project Risks
diff --git a/coverage/index.html b/coverage/index.html index d697ac4ff7..78bdf12974 100644 --- a/coverage/index.html +++ b/coverage/index.html @@ -528,7 +528,7 @@Legend
High: 90% to 100%- Generated by php-code-coverage 9.2.29 using PHP 8.1.27 and PHPUnit 9.6.14 at Thu Dec 28 9:53:54 UTC 2023. + Generated by php-code-coverage 9.2.29 using PHP 8.1.27 and PHPUnit 9.6.14 at Sat Jan 6 17:42:38 UTC 2024.
diff --git a/search/search_index.json b/search/search_index.json index f892e6e968..d6f515d3aa 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"index.html","title":"Introduction","text":"PHPWord is a library written in pure PHP that provides a set ofclasses to write to different document file formats, i.e. Microsoft Office Open XML(.docx), OASIS Open Document Format for Office Applications (.odt), Rich Text Format (.rtf), Microsoft Word Binary File (.doc), HTML (.html), and PDF (.pdf).
PHPWord is an open source project licensed under the terms of LGPL version 3. PHPWord is aimed to be a high quality software product by incorporating continuous integration and unit testing. You can learn more about PHPWord by reading this Developers'Documentation.
"},{"location":"index.html#features","title":"Features","text":"- Set document properties, e.g. title, subject, and creator.
- Create document sections with different settings, e.g. portrait/landscape, page size, and page numbering
- Create header and footer for each sections
- Set default font type, font size, and paragraph style
- Use UTF-8 and East Asia fonts/characters
- Define custom font styles (e.g. bold, italic, color) and paragraph styles (e.g. centered, multicolumns, spacing) either as named style or inline in text
- Insert paragraphs, either as a simple text or complex one (a text run) that contains other elements
- Insert titles (headers) and table of contents
- Insert text breaks and page breaks
- Insert and format images, either local, remote, or as page watermarks
- Insert binary OLE Objects such as Excel or Visio
- Insert and format table with customized properties for each rows (e.g. repeat as header row) and cells (e.g. background color, rowspan, colspan)
- Insert list items as bulleted, numbered, or multilevel
- Insert hyperlinks
- Insert footnotes and endnotes
- Insert drawing shapes (arc, curve, line, polyline, rect, oval)
- Insert charts (pie, doughnut, bar, line, area, scatter, radar)
- Insert form fields (textinput, checkbox, and dropdown)
- Create document from templates
- Use XSL 1.0 style sheets to transform headers, main document part, and footers of an OOXML template
- ... and many more features on progress
Below are the supported features for each file formats.
"},{"location":"index.html#writers","title":"Writers","text":"Features OOXML ODF RTF HTML PDF Document Properties Standard Custom Element Type Text Text Run Title Link Preserve Text Text Break Page Break List Table Image Object Watermark Table of Contents Header Footer Footnote Endnote Comments Graphs 2D basic graphs 2D advanced graphs 3D graphs Math OMML support MathML support Bonus Encryption Protection"},{"location":"index.html#readers","title":"Readers","text":"Features OOXML DOC ODF RTF HTML Document Properties Standard Custom Element Type Text Text Run Title Link Preserve Text Text Break Page Break List Table Image Object Watermark Table of Contents Header Footer Footnote Endnote Comments Graphs 2D basic graphs 2D advanced graphs 3D graphs Math OMML support MathML support Bonus Encryption Protection"},{"location":"index.html#contributing","title":"Contributing","text":"We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute:
- Read our contributing guide
- Fork us and request a pull to the master branch
- Submit bug reports or feature requests to GitHub
- Follow @PHPOffice on Twitter
Images from chart page come from the LibreOffice Core.
Some definitions come from the Office Open XML.
"},{"location":"credits.html#references","title":"References","text":""},{"location":"credits.html#openxml","title":"OpenXML","text":"Known as \"ISO/IEC 29500, Third edition, 2012-09-01\"
ISO :
- Part 1: Fundamentals and Markup Language Reference
- Part 2: Open Packaging Conventions
- Part 3: Markup Compatibility and Extensibility
- Part 4: Transitional Migration Features
MSDN :
- Open XML SDK 2.5 with Validator
- DocumentFormat.OpenXml.Wordprocessing Namespace on MSDN
Library of Congress :
- OOXML Format Family -- ISO/IEC 29500 and ECMA 376
- Schemas in W3C XML Schema language and in RELAX NG for the Strict variant of PPTX, etc.
- Oasis OpenDocument Standard Version 1.2
- Schema Central Open Document 1.1
- Rich Text Format (RTF) Specification, version 1.9.1
- Improve the documentation
Use absolute positioning relative to margin horizontally and to line vertically.
<?php\n\n$imageStyle = array(\n 'width' => 40,\n 'height' => 40,\n 'wrappingStyle' => 'square',\n 'positioning' => 'absolute',\n 'posHorizontalRel' => 'margin',\n 'posVerticalRel' => 'line',\n);\n$textrun->addImage('resources/_earth.jpg', $imageStyle);\nUse php://output as the filename.
<?php\n\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n$section = $phpWord->addSection();\n$section->addText('Hello World!');\n$file = 'HelloWorld.docx';\nheader(\"Content-Description: File Transfer\");\nheader('Content-Disposition: attachment; filename=\"' . $file . '\"');\nheader('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document');\nheader('Content-Transfer-Encoding: binary');\nheader('Cache-Control: must-revalidate, post-check=0, pre-check=0');\nheader('Expires: 0');\n$xmlWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'Word2007');\n$xmlWriter->save(\"php://output\");\nDefine a numbering style and title styles, and match the two styles (with pStyle and numStyle) like below.
<?php\n\n$phpWord->addNumberingStyle(\n 'hNum',\n array('type' => 'multilevel', 'levels' => array(\n array('pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'),\n array('pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'),\n array('pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'),\n )\n )\n);\n$phpWord->addTitleStyle(1, array('size' => 16), array('numStyle' => 'hNum', 'numLevel' => 0));\n$phpWord->addTitleStyle(2, array('size' => 14), array('numStyle' => 'hNum', 'numLevel' => 1));\n$phpWord->addTitleStyle(3, array('size' => 12), array('numStyle' => 'hNum', 'numLevel' => 2));\n\n$section->addTitle('Heading 1', 1);\n$section->addTitle('Heading 2', 2);\n$section->addTitle('Heading 3', 3);\nApply 'HeadingN' paragraph style to TextRun or Link. Sample code:
<?php\n\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n$phpWord->addTitleStyle(1, array('size' => 16, 'bold' => true));\n$phpWord->addTitleStyle(2, array('size' => 14, 'bold' => true));\n$phpWord->addFontStyle('Link', array('color' => '0000FF', 'underline' => 'single'));\n\n$section = $phpWord->addSection();\n\n// Textrun\n$textrun = $section->addTextRun('Heading1');\n$textrun->addText('The ');\n$textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord', 'Link');\n\n// Link\n$section->addLink('https://github.com/', 'GitHub', 'Link', 'Heading2');\nUse the Metadata\\Compatibility\\setOoxmlVersion(n) method with n is the version of Office:
- 14 = Office 2010
- 15 = Office 2013
<?php\n\n$phpWord->getCompatibility()->setOoxmlVersion(15);\nMandatory:
- PHP 7.1+
- PHP DOM extension
- PHP JSON extension
- PHP XML Parser extension
- PHP XMLWriter extension
There are two ways to install PHPWord, i.e. via Composer or manually by downloading the library.
"},{"location":"install.html#using-composer","title":"Using Composer","text":"To install via Composer, add the following lines to your composer.json:
{\n \"require\": {\n \"phpoffice/phpword\": \"dev-master\"\n }\n}\nTo install manually:
- download PHPOffice\\PHPWord package from GitHub
- download PHPOffice\\Common package from GitHub
- extract the package and put the contents to your machine.
<?php\n\nrequire_once 'path/to/PHPWord/src/PhpWord/Autoloader.php';\n\\PhpOffice\\PhpWord\\Autoloader::register();\n\nrequire_once 'path/to/PhpOffice/Common/src/Common/Autoloader.php';\n\\PhpOffice\\Common\\Autoloader::register();\nAfter installation, you can browse and use the samples that we've provided, either by command line or using browser. If you can access your PhpWord library folder using browser, point your browser to the samples folder, e.g. http://localhost/PhpWord/samples/.
This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. Element subnamespace is introduced in this release to replace Section. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. Basic HTML and PDF writing support is enabled. Basic ODText reader is introduced.
- Image: Get image dimensions without EXIF extension - @andrew-kzoo #184
- Table: Add
tblGridelement for Libre/Open Office table sizing - @gianis6 #183 - Footnote: Ability to insert textbreak in footnote
$footnote->addTextBreak()- @ivanlanin - Footnote: Ability to style footnote reference mark by using
FootnoteReferencestyle - @ivanlanin - Font: Add
bgColorto font style to define background using HEX color - @jcarignan #168 - Table: Add
exactHeightto row style to define whether row height should be exact or atLeast - @jcarignan #168 - Element: New
CheckBoxelement for sections and table cells - @ozilion #156 - Settings: Ability to use PCLZip as alternative to ZipArchive - @bskrtich @ivanlanin #106, #140, #185
- Template: Ability to find & replace variables in headers & footers - @dgudgeon #190
- Template: Ability to clone & delete block of text using
cloneBlockanddeleteBlock- @diego-vieira #191 - TOC: Ability to have two or more TOC in one document and to set min and max depth for TOC - @Pyreweb #189
- Table: Ability to add footnote in table cell - @ivanlanin #187
- Footnote: Ability to add image in footnote - @ivanlanin #187
- ListItem: Ability to add list item in header/footer - @ivanlanin #187
- CheckBox: Ability to add checkbox in header/footer - @ivanlanin #187
- Link: Ability to add link in header/footer - @ivanlanin #187
- Object: Ability to add object in header, footer, textrun, and footnote - @ivanlanin #187
- Media: Add
Media::resetElements()to reset all media data - @juzi #19 - General: Add
Style::resetStyles()- @ivanlanin #187 - DOCX Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, list, image, and title - @ivanlanin
- Endnote: Ability to add endnotes - @ivanlanin
- ListItem: Ability to create custom list and reset list number - @ivanlanin #10, #198
- ODT Writer: Basic table writing support - @ivanlanin
- Image: Keep image aspect ratio if only 1 dimension styled - @japonicus #194
- HTML Writer: Basic HTML writer: text, textrun, link, title, textbreak, table, image (as Base64), footnote, endnote - @ivanlanin #203, #67, #147
- PDF Writer: Basic PDF writer using DomPDF: All HTML element except image - @ivanlanin #68
- DOCX Writer: Change
docProps/app.xmlApplicationtoPHPWord- @ivanlanin - DOCX Writer: Create
word/settings.xmlandword/webSettings.xmldynamically - @ivanlanin - ODT Writer: Basic image writing - @ivanlanin
- ODT Writer: Link writing - @ivanlanin
- ODT Reader: Basic ODText Reader - @ivanlanin #71
- Section: Ability to define gutter and line numbering - @ivanlanin
- Font: Small caps, all caps, and double strikethrough - @ivanlanin #151
- Settings: Ability to use measurement unit other than twips with
setMeasurementUnit- @ivanlanin #199 - Style: Remove
bgColorfromFont,Table, andCelland put it into the newShadingstyle - @ivanlanin - Style: New
IndentationandSpacingstyle - @ivanlanin - Paragraph: Ability to define first line and right indentation - @ivanlanin
- Footnote: Footnote content doesn't show footnote reference number - @ivanlanin #170
- Documentation: Error in a function - @theBeerNut #195
createTextRunreplaced byaddTextRuncreateFootnotereplaced byaddFootnotecreateHeaderreplaced byaddHeadercreateFooterreplaced byaddFootercreateSectionreplaced byaddSectionElement\\Footnote::getReferenceIdreplaced byElement\\AbstractElement::getRelationIdElement\\Footnote::setReferenceIdreplaced byElement\\AbstractElement::setRelationIdFootnote::addFootnoteLinkElementreplaced byMedia::addElementFootnote::getFootnoteLinkElementsreplaced byMedia::getElements- All current methods on
Media Element\\Link::getLinkSrcreplaced byElement\\Link::getTargetElement\\Link::getLinkNamereplaced byElement\\Link::getTextStyle\\Cell::getDefaultBorderColor
- Documentation: Simplify page level docblock - @ivanlanin #179
- Writer: Refactor writer classes and create a new
Write\\AbstractWriterabstract class - @ivanlanin #160 - General: Refactor folders:
ElementandException- @ivanlanin #187 - General: Remove legacy
HashTableandShared\\ZipStreamWrapperand all related properties/methods - @ivanlanin #187 - Element: New
AbstractElementabstract class - @ivanlanin #187 - Media: Refactor media class to use one method for all docPart (section, header, footer, footnote) - @ivanlanin #187
- General: Remove underscore prefix from all private properties name - @ivanlanin #187
- General: Move Section
SettingstoStyle\\Section- @ivanlanin #187 - General: Give
Abstractprefix andInterfacesuffix for all abstract classes and interfaces as per PHP-FIG recommendation - @ivanlanin #187 - Style: New
Style\\AbstractStyleabstract class - @ivanlanin #187 - Writer: New 'ODText\\Base` class - @ivanlanin #187
- General: Rename
FootnotetoFootnotesto reflect the nature of collection - @ivanlanin - General: Add some unit tests for Shared & Element (100%!) - @Progi1984
- Test: Add some samples and tests for image wrapping style - @brunocasado #59
- Refactor: Remove Style\\Tabs - @ivanlanin
- Refactor: Apply composite pattern for writers - @ivanlanin
- Refactor: Split
AbstractContainerfromAbstractElement- @ivanlanin - Refactor: Apply composite pattern for Word2007 reader - @ivanlanin
This is a bugfix release for php-zip requirement in Composer.
- Change Composer requirements for php-zip from
requiretosuggest- @bskrtich #246
This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Four new elements were added: TextBox, ListItemRun, Field, and Line. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemented. RTF and HTML reader were initiated.
"},{"location":"changes/0.x/0.11.0.html#features","title":"Features","text":"- Image: Ability to define relative and absolute positioning - @basjan #217
- Footer: Conform footer with header by adding firstPage, evenPage and by inheritance - @basjan @ivanlanin #219
- Element: New
TextBoxelement - @basjan @ivanlanin #228, #229, #231 - HTML: Ability to add elements to PHPWord object via html - @basjan #231
- Element: New
ListItemRunelement that can add a list item with inline formatting like a textrun - @basjan #235 - Table: Ability to add table inside a cell (nested table) - @ivanlanin #149
- RTF Writer: UTF8 support for RTF: Internal UTF8 text is converted to Unicode before writing - @ivanlanin #158
- Table: Ability to define table width (in percent and twip) and position - @ivanlanin #237
- RTF Writer: Ability to add links and page breaks in RTF - @ivanlanin #196
- ListItemRun: Remove fontStyle parameter because ListItemRun is inherited from TextRun and TextRun doesn't have fontStyle - @ivanlanin
- Config: Ability to use a config file to store various common settings - @ivanlanin #200
- ODT Writer: Enable inline font style in TextRun - @ivanlanin
- ODT Writer: Enable underline, strike/doublestrike, smallcaps/allcaps, superscript/subscript font style - @ivanlanin
- ODT Writer: Enable section and column - @ivanlanin
- PDF Writer: Add TCPDF and mPDF as optional PDF renderer library - @ivanlanin
- ODT Writer: Enable title element and custom document properties - @ivanlanin
- ODT Reader: Ability to read standard and custom document properties - @ivanlanin
- Word2007 Writer: Enable the missing custom document properties writer - @ivanlanin
- Image: Enable \"image float left\" - @ivanlanin #244
- RTF Writer: Ability to write document properties - @ivanlanin
- RTF Writer: Ability to write image - @ivanlanin
- Element: New
Fieldelement - @basjan #251 - RTF Reader: Basic RTF reader - @ivanlanin #72, #252
- Element: New
Lineelement - @basjan #253 - Title: Ability to apply numbering in heading - @ivanlanin #193
- HTML Reader: Basic HTML reader - @ivanlanin #80, #254
- RTF Writer: Basic table writing - @ivanlanin #245
- Header: All images added to the second header were assigned to the first header - @basjan #222
- Conversion: Fix conversion from cm to pixel, pixel to cm, and pixel to point - @basjan #233, #234
- PageBreak: Page break adds new line in the beginning of the new page - @ivanlanin #150
- Image:
marginLeftandmarginTopcannot accept float value - @ivanlanin #248 - Title: Orphan
w:fldCharcaused OpenOffice to crash when opening DOCX - @ivanlanin #236
- Static classes
Footnotes,Endnotes, andTOC Writer\\Word2007\\Part:Numbering::writeNumbering(),Settings::writeSettings(),WebSettings::writeWebSettings(),ContentTypes::writeContentTypes(),Styles::writeStyles(),Document::writeDocument()all changed intowrite()Writer\\Word2007\\Part\\DocProps: Split intoWriter\\Word2007\\Part\\DocPropsCoreandWriter\\Word2007\\Part\\DocPropsAppElement\\Title::getBookmarkId()replaced byElement\\Title::getRelationId()Writer\\HTML::writeDocument: Replaced byWriter\\HTML::getContent
- License: Change the project license from LGPL 2.1 into LGPL 3.0 - #211
- Word2007 Writer: New
Style\\Imageclass - @ivanlanin - Refactor: Replace static classes
Footnotes,Endnotes, andTOCwithCollections- @ivanlanin #206 - QA: Reactivate
phpcpdandphpmdon Travis - @ivanlanin - Refactor: PHPMD recommendation: Change all
get...method that returnsbooleanintois...orhas...- @ivanlanin - Docs: Create gh-pages branch for API documentation - @Progi1984 #154
- QA: Add
.scrutinizer.ymland includecomposer.lockfor preparation to Scrutinizer - @ivanlanin #186 - Writer: Refactor writer parts using composite pattern - @ivanlanin
- Docs: Show code quality and test code coverage badge on README
- Style: Change behaviour of
set...function of boolean properties; when none is defined, assumed true - @ivanlanin - Shared: Unify PHP ZipArchive and PCLZip features into PhpWord ZipArchive - @ivanlanin
- Docs: Create VERSION file - @ivanlanin
- QA: Improve dan update requirement check in
samplesfolder - @ivanlanin
This is an immediate bugfix release for HTML reader.
- HTML Reader:
<p>and header tags puts no output - @canyildiz @ivanlanin #257
This release added form fields (textinput, checkbox, and dropdown), drawing shapes (arc, curve, line, polyline, rect, oval), and basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) elements along with some new styles. Basic MsDoc reader is introduced.
"},{"location":"changes/0.x/0.12.0.html#features","title":"Features","text":"- Element: Ability to add drawing shapes (arc, curve, line, polyline, rect, oval) using new
Shapeelement - @ivanlanin #123 - Font: New
scale,spacing, andkerningproperty of font style - @ivanlanin - Paragraph: Added shading to the paragraph style for full width shading - @lrobert #264
- RTF Writer: Support for sections, margins, and borders - @ivanlanin #249
- Section: Ability to set paper size, e.g. A4, A3, and Legal - @ivanlanin #249
- General: New
PhpWord::save()method to encapsulateIOFactory- @ivanlanin - General: New
Shared\\Converterstatic class - @ivanlanin - Chart: Basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) - @ivanlanin #278
- Chart: 3D charts and ability to set width and height - @ivanlanin
- FormField: Ability to add textinput, checkbox, and dropdown form elements - @ivanlanin #266
- Setting: Ability to define document protection (readOnly, comments, trackedChanges, forms) - @ivanlanin
- Setting: Ability to remove [Compatibility Mode] text in the MS Word title bar - @ivanlanin
- SDT: Ability to add structured document tag elements (comboBox, dropDownList, date) - @ivanlanin
- Paragraph: Support for paragraph with borders - @ivanlanin #294
- Word2007 Writer : Support for RTL - @Progi1984 #331
- MsDOC Reader: Basic MsDOC Reader - @Progi1984 #23, #287
- \"absolute\" horizontal and vertical positioning of Frame - @basjan #302
- Add new-page function for PDF generation. For multiple PDF-backends - @chc88 #426
- Report style options enumerated when style unknown - @h6w
- Fix rare PclZip/realpath/PHP version problem - @andrew-kzoo #261
addHTMLencoding and ampersand fixes for PHP 5.3 - @bskrtich #270- Page breaks on titles and tables - @ivanlanin #274
- Table inside vertical border does not rendered properly - @ivanlanin #280
add<elementName>of container should be case insensitive, e.g.addTocshould be accepted, not onlyaddTOC- @ivanlanin #294- Fix specific borders (and margins) were not written correctly in word2007 writer - @pscheit #327
- \"HTML is not a valid writer\" exception while running \"Sample_36_RTL.php\" - @RomanSyroeshko #340
- \"addShape()\" magic method in AbstractContainer is mistakenly named as \"addObject()\" - @GMTA #356
Element\\Section::setPageSizeW()andElement\\Section::setPageSizeH()were mentioned in the docs but not implemented.- Special Characters (ampersand) in Title break docx output - @RomanSyroeshko #401
<th>tag is closed with</td>tag: - @franzholz #438
Element\\Link::getTarget()replaced byElement\\Link::getSource()Element\\Section::getSettings()andElement\\Section::setSettings()replaced byElement\\Section::getStyle()andElement\\Section::setStyle()Shared\\DrawingandShared\\Fontmerged intoShared\\ConverterDocumentPropertiesreplaced byMetadata\\DocInfoTemplatereplaced byTemplateProcessorPhpWord->loadTemplate($filename)
- Docs: Add known issue on
READMEabout requirement for temporary folder to be writable and updatesamples/index.phpfor this requirement check - @ivanlanin #238 - Docs: Correct elements.rst about Line - @chrissharkman #292
- PclZip: Remove temporary file after used - @andrew-kzoo #265
- Autoloader: Add the ability to set the autoloader options - @bskrtich #267
- Element: Refactor elements to move set relation Id from container to element - @ivanlanin
- Introduced CreateTemporaryFileException, CopyFileException - @RomanSyroeshko
- Settings: added method to set user defined temporary directory - @RomanSyroeshko #310
- Renamed
TemplateintoTemplateProcessor- @RomanSyroeshko #216 - Reverted #51. All text escaping must be performed out of the library - @RomanSyroeshko #51
v
"},{"location":"changes/0.x/0.12.1.html","title":"0.12.1 (30 August 2015)","text":"Maintenance release. This release is focused primarily on TemplateProcessor.
- Changed visibility of all private properties and methods of
TemplateProcessortoprotected. - @RomanSyroeshko #498 - Improved performance of
TemplateProcessor::setValue(). - @RomanSyroeshko @nicoSWD #513
- Fixed issue with \"Access denied\" message while opening
Sample_07_TemplateCloneRow.docxandSample_23_TemplateBlock.docxresult files on Windows platform. - @RomanSyroeshko @AshSat #532 - Fixed
PreserveTextelement alignment in footer (seeSample_12_HeaderFooter.php). - @RomanSyroeshko @SSchwaiger #495
This release brings several improvements in TemplateProcessor, automatic output escaping feature for OOXML, ODF, HTML, and RTF (turned off, by default). It also introduces constants for horizontal alignment options, and resolves some issues with PHP 7. Manual installation feature has been dropped since the release. Please, use Composer to install PHPWord.
- Introduced the
\\PhpOffice\\PhpWord\\SimpleType\\Jcsimple type. - @RomanSyroeshko - Introduced the
\\PhpOffice\\PhpWord\\SimpleType\\JcTablesimple type. - @RomanSyroeshko - Introduced writer for the \"Paragraph Alignment\" element (see
\\PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\ParagraphAlignment). - @RomanSyroeshko - Introduced writer for the \"Table Alignment\" element (see
\\PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\TableAlignment). - @RomanSyroeshko - Supported indexed arrays in arguments of
TemplateProcessor::setValue(). - @RomanSyroeshko #618 - Introduced automatic output escaping for OOXML, ODF, HTML, and RTF. To turn the feature on use
phpword.inior\\PhpOffice\\PhpWord\\Settings. - @RomanSyroeshko #483 - Supported processing of headers and footers in
TemplateProcessor::applyXslStyleSheet(). - @RomanSyroeshko #335
- Improved error message for the case when
autoload.phpis not found. - @RomanSyroeshko #371 - Renamed the
alignoption ofNumberingLevel,Frame,Table, andParagraphstyles intoalignment. - @RomanSyroeshko - Improved performance of
TemplateProcessor::setValue(). - @kazitanvirahsan #614, #617 - Fixed some HTML tags not rendering any output (p, header & table) - #257, #324 - @twmobius and @garethellis
getAlignandsetAlignmethods ofNumberingLevel,Frame,Table, andParagraphstyles. Use the correspondentgetAlignmentandsetAlignmentmethods instead. - @RomanSyroeshkoleft,right, andjustifyalignment options for paragraphs (now are mapped toJc::START,Jc::END, andJc::BOTH). - @RomanSyroeshkoleft,right, andjustifyalignment options for tables (now are mapped toJc::START,Jc::END, andJc::CENTER). - @RomanSyroeshkoTCPDFdue to its limited HTML support. UseDomPDForMPDFwriter instead. - @RomanSyroeshko #399
\\PhpOffice\\PhpWord\\Style\\Alignment. Style properties, which previously stored instances of this class, now deal with strings. In each case set of available string values is defined by the correspondent simple type. - @RomanSyroeshko- Manual installation support. Since the release we have dependencies on third party libraries, so installation via ZIP-archive download is not an option anymore. To install PHPWord use Composer. We also removed
\\PhpOffice\\PhpWord\\Autoloader, because the latter change made it completely useless. Autoloaders provided by Composer are in use now (seebootstrap.php). - @RomanSyroeshko \\PhpOffice\\PhpWord\\Shared\\Drawingreplaced by\\PhpOffice\\Common\\Drawing. - @Progi1984 #658\\PhpOffice\\PhpWord\\Shared\\Font. - @Progi1984 #658\\PhpOffice\\PhpWord\\Shared\\Stringreplaced by\\PhpOffice\\Common\\Text. - @Progi1984 @RomanSyroeshko #658\\PhpOffice\\PhpWord\\Shared\\XMLReaderreplaced by\\PhpOffice\\Common\\XMLReader. - @Progi1984 #658\\PhpOffice\\PhpWord\\Shared\\XMLWriterreplaced by\\PhpOffice\\Common\\XMLWriter. - @Progi1984 @RomanSyroeshko #658AbstractContainer::addMemoryImage(). UseAbstractContainer::addImage()instead.
Undefined propertyerror while reading MS-DOC documents. - @jaberu #610- Corrupted OOXML template issue in case when its names is broken immediately after
$sign. That case wasn't taken into account in implementation ofTemplateProcessor::fixBrokenMacros(). - @RomanSyroeshko @d-damien #548
This release fixes several bugs and adds some new features. This version brings compatibility with PHP 7.0 & 7.1
"},{"location":"changes/0.x/0.14.0.html#added","title":"Added","text":"- Possibility to control the footnote numbering -by @troosan in #1068
- Image creation from string -by @troosan in #937
- Introduced the
\\PhpOffice\\PhpWord\\SimpleType\\NumberFormatsimple type. - @troosan - Support for ContextualSpacing -by @postHawk in #1088
- Possiblity to hide spelling and/or grammatical errors -by @troosan in #542
- Possiblity to set default document language as well as changing the language for each text element -by @troosan in #1108
- Support for Comments -by @troosan in #1067
- Support for paragraph textAlignment -by @troosan in #1165
- Add support for HTML underline tag
<u>in addHtml -by @zNightFalLz in #1186 - Add support for HTML
<br>in addHtml - @anrikunby @troosan in #659 - Allow to change cell width unit - guillaume-ro-fr #986
- Allow to change the line height rule @troosan
- Implement PageBreak for odt writerby @cookiekiller in #863 #824
- Allow to force an update of all fields on opening a document -by @troosan in #951
- Allow adding a CheckBox in a TextRun -by @irond in #727
- Add support for HTML img tag -by @srggroup in #934
- Add support for password protection for docx -by @mariahaubner in #1019
- Loosen dependency to Zend
- Images are not being printed when generating PDF -by @hubertinio in #1074 #431
- Fixed some PHP 7 warnings - @ likeuntomurphy #927
- Fixed PHP 7.2 compatibility (renamed
Objectclass names toObjectElement) -by @SailorMax in #1185 - Fixed Word 97 reader - @alsofronie @Benpxpxby @mario-rivera in #912 #920 #892
- Fixed image loading over https -by @troosan in #988
- Impossibility to set different even and odd page headers -by @troosan in #981
- Fixed Word2007 reader where unnecessary paragraphs were being created -by @donghaobo in #1043 #620
- Fixed Word2007 reader where margins were not being read correctly -by @slowprog in #885 #1008
- Impossible to add element PreserveText in Section -by @rvanlaak in #452
- Added missing options for numbering format -by @troosan in #1041
- Fixed impossibility to set a different footer for first page -by @ctrlaltca in #1116,by @aoloe in #875
- Fixed styles not being applied by HTML writer, better pdf output -by @sarke in #1047 #500 #1139
- Fixed read docx error when document contains image from remote url -by @FBnil in #1173 #1176
- Padded the $args array to remove error -by @kaigoh in #1150,by @reformed in #870
- Fix incorrect image size between windows and mac -by @bskrtich in #874
- Fix adding HTML table to document - @mogilvieby @arivanbastos in #324
- Fix parsing on/off values (w:val=\"true|false|1|0|on|off\") -by @troosan in #1221 #1219
- Fix error on Empty Dropdown Entry -by @ComputerTinker in #592
- PhpWord->getProtection(), get it from the settings instead PhpWord->getSettings()->getDocumentProtection();
- Parsing of
alignHTML attribute -by @troosan in #1231 - Parse formatting inside HTML lists - @troosanby @samimussbach in #1239 / #945 / #1215 / #508
- Parsing of CSS
directioninstruction, HTMLlangattribute, formatting inside table cell -by @troosan in #1273 / #1252 / #1254 - Add support for Track changes @Cipby @troosan in #354 / #1262
- Add support for fixed Table Layout @aoloe @ekopachby @troosan in #841 / #1276
- Add support for Cell Spacing @dox07by @troosan in #1040
- Add parsing of formatting inside lists @atomicalnetby @troosan in #594
- Added support for Vertically Raised or Lowered Text (w:position) @anrikunby @troosan in #640
- Add support for MACROBUTTON field @phryneasby @troosan in #1021
- Add support for Hyphenationby @Trainmaster in #1282 (Document:
autoHyphenation,consecutiveHyphenLimit,hyphenationZone,doNotHyphenateCaps, Paragraph:suppressAutoHyphens) - Added support for Floating Table Positioning (tblpPr)by @anrikun in #639
- Added support for Image text wrapping distanceby @troosan in #1310
- Added parsing of CSS line-height and text-indent in HTML readerby @troosan in #1316
- Added the ability to enable gridlines and axislabels on chartsby @FrankMeyer in #576
- Add support for table indent (tblInd)by @Trainmaster in #1343
- Added parsing of internal links in HTML readerby @lalop in #1336
- Several improvements to chartsby @JAEK-S in #1332
- Add parsing of html image in base64 formatby @jgpATs2w in #1382
- Added Support for Indentation & Tabs on RTF Writer.by @smaug1985 in #1405
- Allows decimal numbers in HTML line-height styleby @jgpATs2w in #1413
- Fix reading of docx default style -by @troosan in #1238
- Fix the size unit of when parsing html images -by @troosan in #1254
- Fixed HTML parsing of nested lists -by @troosan in #1265
- Save PNG alpha information when using remote images.by @samsullivan in #779
- Fix parsing of
<w:br/>tag.by @troosan in #1274 - Bookmark are not writton as internal link in html writerby @troosan in #1263
- It should be possible to add a Footnote in a ListItemRunby @troosan in #1287 #1287
- Fix colspan and rowspan for tables in HTML Writerby @mattbolt in #1292
- Fix parsing of Heading and Title formating @troosanby @gthomas2 in #465
- Fix Dateformat typo, fix hours casing, add Month-Day-Year formatsby @ComputerTinker in #591
- Support reading of w:drawing for documents produced by word 2011+by @gthomas2 in #464 #1324
- Fix missing column width in ODText writerby @potofcoffee in #413
- Disable entity loader before parsing XML to avoid XXE injectionby @Tom4t0 in #1427
- Remove zend-stdlib dependencyby @Trainmaster in #1284
- The default unit for
\\PhpOffice\\PhpWord\\Style\\Imagechanged frompxtopt.
- Drop GitHub pages, switch to coveralls for code coverage analysisby @czosel in #1360
- Add getVariableCount method in TemplateProcessor.by @nicoder in #1272
- Add setting Chart Title and Legend visibilityby @Tom-Magill in #1433
- Add ability to pass a Style object in Section constructorby @ndench in #1416
- Add support for hidden textby @Alexmg86 in #1527
- Add support for setting images in TemplateProcessorby @SailorMax in #1170
- Add \"Plain Text\" type to SDT (Structured Document Tags)by @morrisdj in #1541
- Added possibility to index variables inside cloned block in TemplateProcessorby @JPBetley in #817
- Added possibility to replace variables inside cloned block with values in TemplateProcessorby @DIDoS in #1392
- Fix regex in
cloneBlockfunctionby @nicoder in #1269 - HTML Title Writer loses text when Title contains a TextRun instead a string.by @begnini in #1436
- Fix regex in fixBrokenMacros, make it less greedy @MuriloSo @brainwoodby @yurii-sio2 in #1502 / #1345
- 240 twips are being added to line spacing, should not happen when using lineRule fixedby @troosan in #1509 / #1505
- Adding table layout to the generated HTMLby @aarangara in #1441
- Fix loading of Sharepoint documentby @Garrcomm in #1498
- RTF writer: Round getPageSizeW and getPageSizeH to avoid decimalsby @Patrick64 in #1493
- Fix parsing of Office 365 documentsby @Timanx in #1485
- For RTF writers, sizes should should never have decimalsby @Samuel-BF in #1536
- Style Name Parsing fails if document generated by a non-english word versionby @begnini in #1434
- Get rid of duplicated code in TemplateProcessorby @abcdmitry in #1161
- Add methods setValuesFromArray and cloneRowFromArray to the TemplateProcessor @geraldb-nicat GH-670
- Set complex type in template @troosan GH-1565
- implement support for section vAlign @troosan GH-1569
- ParseStyle for border-color @Gllrm0 GH-1551
- Html writer auto invert text color @SailorMax GH-1387
- Add RightToLeft table presentation. @troosan GH-1550
- Add support for page vertical alignment. @troosan GH-672 GH-1569
- Adding setNumId method for ListItem style @eweso GH-1329
- Add support for basic fields in RTF writer. @Samuel-BF GH-1717
- Fix HTML border-color parsing. @troosan GH-1551 / GH-1570
- Language::validateLocale should pass with locale 'zxx'. @efpapado GH-1558
- can't align center vertically with the text @ter987 GH-672
- fix parsing of border-color and add test @troosan GH-1570
- TrackChange doesn't handle all return types of \\DateTime::createFromFormat(...) @superhaggis GH-1584
- To support PreserveText inside sub container @bhattnishant GH-1637
- No nested w:pPr elements in ListItemRun. @waltertamboer GH-1628
- Ensure that entity_loader disable variable is re-set back to the original setting @seamuslee001 GH-1585
- Use embedded http server to test loading of remote images @troosan GH-1544
- Change private to protected to be able extending class Html @SpinyMan GH-1646
- Fix apt-get crash in Travis CI for PHP 5.3 @mdupont GH-1707
Full Changelog
"},{"location":"changes/0.x/0.18.0.html#enhancements","title":"Enhancements","text":"- Add support for charts in template processor #2012 (@dbarzin)
- add/setting page element border style. #1986 (@emnabs)
- allow to use customized pdf library #1983 (@SailorMax)
- feat: Update addHtml to handle style inheritance #1965 (@Julien1138)
- Add parsing of Shape node values #1924 (@sven-ahrens)
- Allow to redefine TCPDF object #1907 (@SailorMax)
- Enhancements to addHTML parser #1902 (@lubosdz)
- Make Default Paper Configurable #1851 (@oleibman)
- Implement various missing features for the ODT writer #1796 (@oleibman)
- Added support for \"cloudConvert\" images #1794 (@ErnestStaug)
- Add support for several features for the RTF writer #1775 (@oleibman)
- Add font style for Field elements #1774 (@oleibman)
- Add support for ListItemRun in HTML writer #1766 (@stefan-91)
- Improvements in RTF writer #1755 (@oleibman)
- Allow a closure to be passed with image replacement tags #1716 (@mbardelmeijer)
- Add Option for Dynamic Chart Legend Position #1699 (@Stephan212)
- Add parsing of HTML checkbox input field #1832 (@Matze2010)
- Fix image stroke in libreoffice 7.x #1992 (@Adizbek)
- Fix deprecated warning for non-hexadecimal number #1988 (@Ciki)
- Fix limit not taken into account when adding image in template #1967 (@jsochor)
- Add null check when setComplexValue is not found #1936 (@YannikFirre)
- Some document have non-standard locale code #1824 (@ErnestStaug)
- Fixes PHPDoc @param and @return types for several Converter methods #1818 (@caugner)
- Update the regexp to avoid catastrophic backtracking #1809 (@juzser)
- Fix PHPUnit tests on develop branch #1771 (@mdupont)
- TemplateProcessor cloneBlock wrongly clones images #1763 (@alarai)
- Compatibility with PHP 7.4, PHP 8.0 and migrate to Laminas Escaper #1946 (@liborm85)
- Remove legacy PHPOffice/Common package, fix PHP 8.0 compatibility #1996 (@liborm85)
- Improve Word2007 Test Coverage #1858 (@oleibman)
- Fix typo in docs. Update templates-processing.rst #1952 (@mnvx)
- Fix documentation and method name for FootnoteProperties #1776 (@mdupont)
- fix: documentation about paragraph indentation #1764 (@mdupont)
- Update templates-processing.rst #1745 (@igronus)
- Unused variables $rows, $cols in sample #1877 (@ThanasisMpalatsoukas)
- Add unit test for NumberingStyle #1744 (@Manunchik)
- Add unit test for PhpWord Settings #1743 (@Manunchik)
- Add unit test for Media elements #1742 (@Manunchik)
- Update templates processing docs #1729 (@hcdias)
Full Changelog
"},{"location":"changes/0.x/0.18.1.html#bug-fixes","title":"Bug fixes","text":"- Fix BC break in GH-1946. This package does not replace laminas/laminas-zendframework-bridge by @mussbach in #2032
Full Changelog
"},{"location":"changes/0.x/0.18.2.html#bug-fixes","title":"Bug fixes","text":"- when adding image to relationship first check that the generated RID is actually unique by @tpv-ebben in #2063
- Update chart, don't write 'c:overlap' if grouping is 'clustered' by @dfsd534 in #2052
- Update Html parser to accept line-height:normal by @joelgo in #2041
- Fix image border in Word2007 Writer for LibreOffice 7 by k@amilmmach in #2021
- Corrected namespace for Language class in docs by @MegaChriz in #2087
- Added support for Garamond font by @artemkolotilkin in #2078
- Add BorderStyle for Cell Style to documentation by @DShkrabak in #2090
Full Changelog
"},{"location":"changes/0.x/0.18.3.html#bug-fixes","title":"Bug fixes","text":"- PHP 8.1 compatibility
This is the first release after a long development hiatus in CodePlex. This release initialized ODT and RTF Writer, along with some other new features for the existing Word2007 Writer, e.g. tab, multiple header, rowspan and colspan. Composer and Travis were added.
"},{"location":"changes/0.x/0.7.0.html#features","title":"Features","text":"- Implement RTF Writer - @Progi1984 #1
- Implement ODT Writer - @Progi1984 #2
- Word2007: Add rowspan and colspan to cells - @kaystrobach
- Word2007: Support for tab stops - @RLovelett
- Word2007: Support Multiple headers - @RLovelett
- Word2007: Wrapping Styles to Images - @gabrielbull
- Added support for image wrapping style - @gabrielbull
- \"Warning: Invalid error type specified in ...\\PHPWord.php on line 226\" is thrown when the specified template file is not found - @RomanSyroeshko #32
- PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input - @RomanSyroeshko #34
- Temporary files naming logic in PHPWord_Template can lead to a collision - @RomanSyroeshko #38
- Add superscript/subscript styling in Excel2007 Writer - @MarkBaker
- add indentation support to paragraphs - @deds
- Support for Composer - @Progi1984 #27
- Basic CI with Travis - @Progi1984
- Added PHPWord_Exception and exception when could not copy the template - @Progi1984
- IMPROVED: Moved examples out of Classes directory - @Progi1984
- IMPROVED: Advanced string replace in setValue for Template - @Esmeraldo #49
This release merged a lot of improvements from the community. Unit tests introduced in this release and has reached 90% code coverage.
"},{"location":"changes/0.x/0.8.0.html#features","title":"Features","text":"- Template: Permit to save a template generated as a file (PHPWord_Template::saveAs()) - @RomanSyroeshko #56, #57
- Word2007: Support sections page numbering - @gabrielbull
- Word2007: Added line height methods to mirror the line height settings in Word in the paragraph styling - @gabrielbull
- Word2007: Added support for page header & page footer height - @JillElaine #5
- General: Add ability to manage line breaks after image insertion - @bskrtich #6, #66, #84
- Template: Ability to limit number of replacements performed by setValue() method of Template class - @RomanSyroeshko #52, #53, #85
- Table row: Repeat as header row & allow row to break across pages - @ivanlanin #48, #86
- Table: Table width in percentage - @ivanlanin #48, #86
- Font: Superscript and subscript - @ivanlanin #48, #86
- Paragraph: Hanging paragraph - @ivanlanin #48, #86
- Section: Multicolumn and section break - @ivanlanin #48, #86
- Template: Ability to apply XSL style sheet to Template - @RomanSyroeshko #46, #47, #83
- General: PHPWord_Shared_Font::pointSizeToTwips() converter - @ivanlanin #87
- Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() - @ivanlanin #87
- Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) - @ivanlanin #87
- Clone table rows on the fly when using a template document - @jeroenmoors #44, #88
- Initial addition of basic footnote support - @deds #16
- Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before - @ivanlanin #92
- General: PHPWord_Style_Font refactoring - @ivanlanin #93
- Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. - @ivanlanin #93
- Paragraph: setTabs() function - @ivanlanin #92
- General: Basic support for TextRun on ODT and RTF - @ivanlanin #99
- Reader: Basic Reader for Word2007 - @ivanlanin #104
- TextRun: Allow Text Break in Text Run - @bskrtich #109
- General: Support for East Asian fontstyle - @jhfangying #111, #118
- Image: Use exif_imagetype to check image format instead of extension name - @gabrielbull #114
- General: Setting for XMLWriter Compatibility option - @bskrtich #103
- MemoryImage: Allow remote image when allow_url_open = on - @ivanlanin #122
- TextBreak: Allow font and paragraph style for text break - @ivanlanin #18
- Fixed bug with cell styling - @gabrielbull
- Fixed bug list items inside of cells - @gabrielbull
- Adding a value that contains \"&\" in a template breaks it - @SiebelsTim #51
- Example in README.md is broken - @Progi1984 #89
- General: PHPWord_Shared_Drawing::centimetersToPixels() conversion - @ivanlanin #94
- Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote - @ivanlanin #125
- UnitTests - @Progi1984
This is a bugfix release for image detection functionality.
- Added fallback for computers that do not have exif_imagetype - @bskrtich, @gabrielbull
This release marked the transformation to namespaces (PHP 5.3+).
"},{"location":"changes/0.x/0.9.0.html#features","title":"Features","text":"- Image: Ability to use remote or GD images using
addImage()on sections, headers, footer, cells, and textruns - @ivanlanin - Header: Ability to use remote or GD images using
addWatermark()- @ivanlanin
- Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin
- Move documentation to Read The Docs - by @Progi1984 & @ivanlanin in #82
- Reorganize and redesign samples folder - @ivanlanin #137
- Use
PhpOffice\\PhpWordnamespace for PSR compliance - @RomanSyroeshko @gabrielbull #159, #58 - Restructure folders and change folder name
ClassestosrcandTeststotestfor PSR compliance - @RomanSyroeshko @gabrielbull - Compliance to phpDocumentor - @ivanlanin
- Merge Style\\TableFull into Style\\Table. Style\\TableFull is deprecated - @ivanlanin #160
- Merge Section\\MemoryImage into Section\\Image. Section\\Image is deprecated - @ivanlanin #160
This is a bugfix release for PSR-4 compatibility.
- Fixed PSR-4 composer autoloader - @AntonTyutin
Full Changelog
"},{"location":"changes/1.x/1.0.0.html#breaking-change","title":"BREAKING CHANGE","text":"Most deprecated things were dropped. See details in https://github.com/PHPOffice/PHPWord/commit/b9f1151bc6f90c276153c3c9dca10a5fc7f355fb.
"},{"location":"changes/1.x/1.0.0.html#dropped-classes","title":"Dropped classes:","text":"PhpOffice\\PhpWord\\Template
PhpOffice\\PhpWord\\Style\\Font::UNDERLINE_DOTHASHPhpOffice\\PhpWord\\Style\\Font::UNDERLINE_DOTHASHHEAVYPhpOffice\\PhpWord\\Style\\Cell::VALIGN_TOPPhpOffice\\PhpWord\\Style\\Cell::VALIGN_CENTERPhpOffice\\PhpWord\\Style\\Cell::VALIGN_BOTTOMPhpOffice\\PhpWord\\Style\\Cell::VALIGN_BOTHPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_DOTPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_UNDERSCOREPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_LINEPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_NONEPhpOffice\\PhpWord\\Style\\Table::WIDTH_AUTOPhpOffice\\PhpWord\\Style\\Table::WIDTH_PERCENTPhpOffice\\PhpWord\\Style\\Table::WIDTH_TWIPPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_NAMEPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_SIZEPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_COLORPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_CONTENT_TYPE
PhpOffice\\PhpWord\\Ekement\\AbstractContainer::createTextRun()PhpOffice\\PhpWord\\Ekement\\AbstractContainer::createFootnote()PhpOffice\\PhpWord\\Ekement\\Footnote::getReferenceId()PhpOffice\\PhpWord\\Ekement\\Footnote::setReferenceId()PhpOffice\\PhpWord\\Ekement\\Image::getIsWatermark()PhpOffice\\PhpWord\\Ekement\\Image::getIsMemImage()PhpOffice\\PhpWord\\Ekement\\Link::getTarget()PhpOffice\\PhpWord\\Ekement\\Link::getLinkSrc()PhpOffice\\PhpWord\\Ekement\\Link::getLinkName()PhpOffice\\PhpWord\\Ekement\\OLEObject::getObjectId()PhpOffice\\PhpWord\\Ekement\\OLEObject::setObjectId()PhpOffice\\PhpWord\\Ekement\\Section::getFootnotePropoperties()PhpOffice\\PhpWord\\Ekement\\Section::setSettings()PhpOffice\\PhpWord\\Ekement\\Section::getSettings()PhpOffice\\PhpWord\\Ekement\\Section::createHeader()PhpOffice\\PhpWord\\Ekement\\Section::createFooter()PhpOffice\\PhpWord\\Ekement\\Section::getFooter()PhpOffice\\PhpWord\\Media::addSectionMediaElement()PhpOffice\\PhpWord\\Media::addSectionLinkElement()PhpOffice\\PhpWord\\Media::getSectionMediaElements()PhpOffice\\PhpWord\\Media::countSectionMediaElements()PhpOffice\\PhpWord\\Media::addHeaderMediaElement()PhpOffice\\PhpWord\\Media::countHeaderMediaElements()PhpOffice\\PhpWord\\Media::getHeaderMediaElements()PhpOffice\\PhpWord\\Media::addFooterMediaElement()PhpOffice\\PhpWord\\Media::countFooterMediaElements()PhpOffice\\PhpWord\\Media::getFooterMediaElements()PhpOffice\\PhpWord\\PhpWord::getProtection()PhpOffice\\PhpWord\\PhpWord::loadTemplate()PhpOffice\\PhpWord\\PhpWord::createSection()PhpOffice\\PhpWord\\PhpWord::getDocumentProperties()PhpOffice\\PhpWord\\PhpWord::setDocumentProperties()PhpOffice\\PhpWord\\Reader\\AbstractReader::getReadDataOnly()PhpOffice\\PhpWord\\Settings::getCompatibility()PhpOffice\\PhpWord\\Style\\AbstractStyle::setArrayStyle()PhpOffice\\PhpWord\\Style\\Cell::getDefaultBorderColor()PhpOffice\\PhpWord\\Style\\Font::getBold()PhpOffice\\PhpWord\\Style\\Font::getItalic()PhpOffice\\PhpWord\\Style\\Font::getSuperScript()PhpOffice\\PhpWord\\Style\\Font::getSubScript()PhpOffice\\PhpWord\\Style\\Font::getStrikethrough()PhpOffice\\PhpWord\\Style\\Font::getParagraphStyle()PhpOffice\\PhpWord\\Style\\Frame::getAlign()PhpOffice\\PhpWord\\Style\\Frame::setAlign()PhpOffice\\PhpWord\\Style\\NumberingLevel::getAlign()PhpOffice\\PhpWord\\Style\\NumberingLevel::setAlign()PhpOffice\\PhpWord\\Style\\Paragraph::getAlign()PhpOffice\\PhpWord\\Style\\Paragraph::setAlign()PhpOffice\\PhpWord\\Style\\Paragraph::getWidowControl()PhpOffice\\PhpWord\\Style\\Paragraph::getKeepNext()PhpOffice\\PhpWord\\Style\\Paragraph::getKeepLines()PhpOffice\\PhpWord\\Style\\Paragraph::getPageBreakBefore()PhpOffice\\PhpWord\\Style\\Row::getTblHeader()PhpOffice\\PhpWord\\Style\\Row::isTblHeader()PhpOffice\\PhpWord\\Style\\Row::getCantSplit()PhpOffice\\PhpWord\\Style\\Row::getExactHeight()PhpOffice\\PhpWord\\Style\\Spacing::getRule()PhpOffice\\PhpWord\\Style\\Spacing::setRule()PhpOffice\\PhpWord\\Style\\Table::getAlign()PhpOffice\\PhpWord\\Style\\Table::setAlign()PhpOffice\\PhpWord\\Writer\\AbstractWriter::getUseDiskCaching()PhpOffice\\PhpWord\\Writer\\HTML::writeDocument()
- Multiple PHP 8.1 fixes
loadConfigreturns config that was actually applied- HTML Reader : Override inline style on HTML attribute for table
- HTML Reader : Use
borderattribute for tables - HTML Reader : Style page-break-after in paragraph
- HTML Reader : Heading in Text Run is not allowed
- Drop support for PHP 7.0 and older
Full Changelog
"},{"location":"changes/1.x/1.1.0.html#enhancements","title":"Enhancements","text":"- Introduce deleteRow() method for TemplateProcessor
- HTML Reader: Add basic support for CSS Style Tag
- Allow customizing macro syntax in TemplateProcessor
- Add background color support for textboxes
- Add softhyphen support to word reader
- Add support table row height when importing HTML
- Add support for fractional font sizes
- Added image quality support, with the maximum quality as default
- Support for reading nested tables
- DOCX reader: Read empty vmerge
- Fixed setting width of Cell Style
masteris the new default branch
Full Changelog
"},{"location":"changes/1.x/1.2.0.html#enhancements","title":"Enhancements","text":"- Word2007 Reader/Writer : Added noWrap table cell property by @kernusr in GH-2359
- HTML Reader : Support for
font-variant: small-capsby @cambraca in GH-2117 - Improved TextDirection for styling a cell by @terryzwt in GH-2429
- Word2007 Reader : Added option to disable loading images by @aelliott1485 in GH-2450
- HTML Writer : Added border-spacing to default styles for table by @kernusr in GH-2451
- Word2007 Reader : Support for table cell borders and margins by @kernusr in GH-2454
- PDF Writer : Add config for defining the default font by @MikeMaldini in #2262 & #2468
- Word2007 Reader : Added support for Comments by @shaedrich in #2161 & #2469
- Word2007 Reader/Writer: Permit book-fold printing by @potofcoffee in #2225 & #2470
- Word2007 Writer : Add PageNumber to TOC by @jet-desk in #1652 & #2471
- Word2007 Reader/Writer + ODText Reader/Writer : Add Element Formula in by @Progi1984 in #2477
- Add Support for Various Missing Features in HTML Writer by @oleibman in #2475
- Fixed addHTML (text-align:right in html is not handled correctly) in #2467
- HTML Writer : Added ability to specify generic fallback font
- HTML Writer : Added ability to specify handling of whitespace
- HTML Writer : Added support for Table Border style, color, and size
- HTML Writer : Added support for empty paragraphs (Word writer permits, browsers generally suppress)
- HTML Writer : Paragraph style should support indentation, line-height, page-break-before
- HTML Writer : Removed margin-top/bottom when spacing is null in Paragraph style
- HTML Writer : Added default paragraph style to all paragraphs, as well as class Normal
- HTML Writer : Use css @page and page declarations for sections
- HTML Writer : Wrap sections in div, with page break before each (except first)
- PDF Writer : Added support for PageBreak
- PDF Writer : Added callback for modifying the HTML
- Added Support for Language, both for document overall and individual text elements
- Template : Set a checkbox by @nxtpge in #2509
- ODText / RTF / Word2007 Writer : Add field FILENAME by @milkyway-git in #2510
- ODText Reader : Improve Section Reader by @oleibman in #2507
- Fixed wrong mimetype for docx files by @gamerlv in GH-2416
- Word2007 Reader : Read hyperlingks in headings by @hannesdorn in GH-2433
- PclZip : strtr using empty string by @spl1nes in GH-2432
- Fixed PHP 8.2 deprecated about Allow access to an undefined property by @DAdq26 in GH-2440
- Template Processor : Fixed choose dimention for Float Value by @gdevilbat in GH-2449
- HTML Parser : Fix image parsing from url without extension by @JokubasR in GH-2459
- Word2007 Reader : Fixed reading of Office365 DocX file by @filippotoso & @lfglopes in #2506
- Word2007 Reader : Check for null on $fontDefaultStyle by @spatialfree in #2513
- Added PHPStan by @PowerKiKi in GH-2405
- Bump symfony/process from 4.4.44 to 5.4.26 by @dependabot in GH-2431
- Bump phpunit/phpunit from 9.6.8 to 9.6.10 by @dependabot in GH-2430
- Added Coveralls.io by @Progi1984 in GH-2452
- Added support for PHP 8.2 & PHP 8.3 by @Progi1984 in GH-2453
- Moved documention from ReadTheDocs to MkDocs & Github Pages by @Progi1984 in GH-2465
- Bump phpstan/phpstan-phpunit from 1.3.13 to 1.3.14 by @dependabot in #2457
- Bump symfony/process from 5.4.26 to 5.4.28 by @dependabot in #2456
- Bump phpunit/phpunit from 9.6.10 to 9.6.11 by @dependabot in #2455
- Remove deprecated utf8_encode in PHP 8.2 by @mhcwebdesign in #2447 & #2472
- Bump mpdf/mpdf from 8.1.6 to 8.2.0 by @dependabot in #2480
- Bump phpunit/phpunit from 9.6.11 to 9.6.13 by @dependabot in #2481
- Bump tecnickcom/tcpdf from 6.6.2 to 6.6.5 by @dependabot in #2482
- Bump phpmd/phpmd from 2.13.0 to 2.14.1 by @dependabot in #2483
- Bump phpstan/phpstan-phpunit from 1.3.14 to 1.3.15 by @dependabot in #2494
- Removed dependency
laminas/laminas-escaper
Full Changelog
"},{"location":"changes/2.x/2.0.0.html#enhancements","title":"Enhancements","text":""},{"location":"changes/2.x/2.0.0.html#bug-fixes","title":"Bug fixes","text":"- MsDoc Reader : Correct Font Size Calculation by @oleibman fixing #2526 in #2531
- Bump dompdf/dompdf from 2.0.3 to 2.0.4 by @dependabot in #2530
- Bump phpunit/phpunit from 9.6.13 to 9.6.14 by @dependabot in #2519
- Bump mpdf/mpdf from 8.2.0 to 8.2.2 by @dependabot in #2518
Containers are objects where you can put elements (texts, lists, tables, etc). There are 3 main containers, i.e. sections, headers, and footers.There are 3 elements that can also act as containers, i.e. textruns, table cells, and footnotes.
"},{"location":"usage/containers.html#sections","title":"Sections","text":"Every visible element in word is placed inside of a section. To create a section, use the following code:
<?php\n\n$section = $phpWord->addSection($sectionStyle);\nThe $sectionStyle is an optional associative array that sets the section. Example:
<?php\n\n$sectionStyle = array(\n 'orientation' => 'landscape',\n 'marginTop' => 600,\n 'colsNum' => 2,\n);\nYou can change a section page number by using the pageNumberingStart style of the section.
<?php\n\n// Method 1\n$section = $phpWord->addSection(array('pageNumberingStart' => 1));\n\n// Method 2\n$section = $phpWord->addSection();\n$section->getStyle()->setPageNumberingStart(1);\nYou can change a section layout to multicolumn (like in a newspaper) by using the breakType and colsNum style of the section.
<?php\n\n// Method 1\n$section = $phpWord->addSection(array('breakType' => 'continuous', 'colsNum' => 2));\n\n// Method 2\n$section = $phpWord->addSection();\n$section->getStyle()->setBreakType('continuous');\n$section->getStyle()->setColsNum(2);\nYou can apply line numbering to a section by using the lineNumbering style of the section.
<?php\n\n// Method 1\n$section = $phpWord->addSection(array('lineNumbering' => array()));\n\n// Method 2\n$section = $phpWord->addSection();\n$section->getStyle()->setLineNumbering(array());\nBelow are the properties of the line numbering style.
startLine numbering starting valueincrementLine number incrementsdistanceDistance between text and line numbering in twiprestartLine numbering restart setting continuous|newPage|newSection
Each section can have its own header reference. To create a header use the addHeader method:
<?php\n\n$header = $section->addHeader();\nBe sure to save the result in a local object. You can use all elements that are available for the footer. See \"Footer\" section for detail. Additionally, only inside of the header reference you can add watermarks or background pictures. See \"Watermarks\" section.
You can pass an optional parameter to specify where the header/footer should be applied, it can be
Footer::AUTOdefault, all pages except if overridden by first or evenFooter::FIRSTeach first page of the sectionFooter::EVENeach even page of the section. Will only be applied if the evenAndOddHeaders is set to true in phpWord->settings
To change the evenAndOddHeaders use the getSettings method to return the Settings object, and then call the setEvenAndOddHeaders method:
<?php\n\n$phpWord->getSettings()->setEvenAndOddHeaders(true);\nEach section can have its own footer reference. To create a footer, use the addFooter method:
<?php\n\n$footer = $section->addFooter();\nBe sure to save the result in a local object to add elements to a footer. You can add the following elements to footers:
- Texts
addTextandcreateTextrun - Text breaks
- Images
- Tables
- Preserve text
See the \"Elements\" section for the detail of each elements.
"},{"location":"usage/containers.html#other-containers","title":"Other containers","text":"Textruns, table cells, and footnotes are elements that can also act as containers. See the corresponding \"Elements\" section for the detail of each elements.
"},{"location":"usage/introduction.html","title":"Introduction","text":""},{"location":"usage/introduction.html#basic-example","title":"Basic example","text":"The following is a basic example of the PHPWord library. More examples are provided in the samples folder.
<?php\nrequire_once 'bootstrap.php';\n\n// Creating the new document...\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n\n/* Note: any element you append to a document must reside inside of a Section. */\n\n// Adding an empty Section to the document...\n$section = $phpWord->addSection();\n// Adding Text element to the Section having font styled by default...\n$section->addText(\n '\"Learn from yesterday, live for today, hope for tomorrow. '\n . 'The important thing is not to stop questioning.\" '\n . '(Albert Einstein)'\n);\n\n/*\n * Note: it's possible to customize font style of the Text element you add in three ways:\n * - inline;\n * - using named font style (new font style object will be implicitly created);\n * - using explicitly created font style object.\n */\n\n// Adding Text element with font customized inline...\n$section->addText(\n '\"Great achievement is usually born of great sacrifice, '\n . 'and is never the result of selfishness.\" '\n . '(Napoleon Hill)',\n array('name' => 'Tahoma', 'size' => 10)\n);\n\n// Adding Text element with font customized using named font style...\n$fontStyleName = 'oneUserDefinedStyle';\n$phpWord->addFontStyle(\n $fontStyleName,\n array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true)\n);\n$section->addText(\n '\"The greatest accomplishment is not in never falling, '\n . 'but in rising again after you fall.\" '\n . '(Vince Lombardi)',\n $fontStyleName\n);\n\n// Adding Text element with font customized using explicitly created font style object...\n$fontStyle = new \\PhpOffice\\PhpWord\\Style\\Font();\n$fontStyle->setBold(true);\n$fontStyle->setName('Tahoma');\n$fontStyle->setSize(13);\n$myTextElement = $section->addText('\"Believe you can and you\\'re halfway there.\" (Theodor Roosevelt)');\n$myTextElement->setFontStyle($fontStyle);\n\n// Saving the document as OOXML file...\n$objWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'Word2007');\n$objWriter->save('helloWorld.docx');\n\n// Saving the document as ODF file...\n$objWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'ODText');\n$objWriter->save('helloWorld.odt');\n\n// Saving the document as HTML file...\n$objWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'HTML');\n$objWriter->save('helloWorld.html');\n\n/* Note: we skip RTF, because it's not XML-based and requires a different example. */\n/* Note: we skip PDF, because \"HTML-to-PDF\" approach is used to create PDF documents. */\nThe PhpOffice\\PhpWord\\Settings class provides some options that will affect the behavior of PHPWord. Below are the options.
This option sets XMLWriter::setIndent and XMLWriter::setIndentString. The default value of this option is true (compatible), which is required for OpenOffice to render OOXML document correctly. You can set this option to false during development to make the resulting XML file easier to read.
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setCompatibility(false);\nBy default, PHPWord uses Zip extension to deal with ZIP compressed archives and files inside them. If you can't have Zip extension installed on your server, you can use pure PHP library alternative, `PclZip``, which is included in PHPWord.
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setZipClass(\\PhpOffice\\PhpWord\\Settings::PCLZIP);\nWriting documents of some formats, especially XML-based, requires correct output escaping. Without it your document may become broken when you put special characters like ampersand, quotes, and others in it.
Escaping can be performed in two ways: outside of the library by a software developer and inside of the library by built-in mechanism. By default, the built-in mechanism is disabled for backward compatibility with versions prior to v0.13.0. To turn it on set outputEscapingEnabled option to true in your PHPWord configuration file or use the following instruction at runtime:
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setOutputEscapingEnabled(true);\nBy default, all sections of the document will print on A4 paper. You can alter the default paper by using the following function:
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setDefaultPaper('Letter');\nBy default, every text appears in Arial 10 point. You can alter the default font by using the following two functions:
<?php\n\n$phpWord->setDefaultFontName('Times New Roman');\n$phpWord->setDefaultFontSize(12);\nSettings for the generated document can be set using $phpWord->getSettings()
The default zoom value is 100 percent. This can be changed either to another percentage
<?php\n\n$phpWord->getSettings()->setZoom(75);\nOr to predefined values fullPage, bestFit, textFit
<?php\n\n$phpWord->getSettings()->setZoom(Zoom::BEST_FIT);\nUse mirror margins to set up facing pages for double-sided documents, such as books or magazines.
<?php\n\n$phpWord->getSettings()->setMirrorMargins(true);\nDon't forget to set both paper size and page size
For example, to print a document on A4 paper (landscape) and fold it into A5 pages (portrait), use this section style:
<?php\n\nuse PhpOffice\\PhpWord\\Shared\\Converter;\n\n$phpWord->getSettings()->setMirrorMargins(true);\n$phpWord->addSection([\n 'paperSize' => 'A4',\n 'orientation' => 'landscape',\n 'pageSizeW' => Converter::cmToTwip(14.85),\n 'pageSizeH' => Converter::cmToTwip(21),\n]);\nUse book-fold printing to set up documents to be printed as foldable pages.
<?php\n\n$phpWord->getSettings()->setBookFoldPrinting(true);\nBy default spelling and grammatical errors are shown as soon as you open a word document. For big documents this can slow down the opening of the document. You can hide the spelling and/or grammatical errors with:
<?php\n\n$phpWord->getSettings()->setHideGrammaticalErrors(true);\n$phpWord->getSettings()->setHideSpellingErrors(true);\nYou can also specify the status of the spell and grammar checks, marking spelling or grammar as dirty will force a re-check when opening the document.
<?php\n\n$proofState = new \\PhpOffice\\PhpWord\\ComplexType\\ProofState();\n$proofState->setGrammar(\\PhpOffice\\PhpWord\\ComplexType\\ProofState::CLEAN);\n$proofState->setSpelling(\\PhpOffice\\PhpWord\\ComplexType\\ProofState::DIRTY);\n\n$phpWord->getSettings()->setProofState($proofState);\nTrack changes can be activated using setTrackRevisions, you can furture specify
- Not to use move syntax, instead moved items will be seen as deleted in one place and added in another
- Not track formatting revisions
<?php\n\n$phpWord->getSettings()->setTrackRevisions(true);\n$phpWord->getSettings()->setDoNotTrackMoves(true);\n$phpWord->getSettings()->setDoNotTrackFormatting(true);\nThe default symbol to represent a decimal figure is the . in english. In french you might want to change it to , for instance.
<?php\n\n$phpWord->getSettings()->setDecimalSymbol(',');\nThe default language of the document can be change with the following.
<?php\n\n$phpWord->getSettings()->setThemeFontLang(new Language(Language::FR_BE));\nLanguage has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages. A couple of language codes are provided in the PhpOffice\\PhpWord\\Style\\Language class but any valid code/ID can be used.
In case you are generating an RTF document the language need to be set differently.
<?php\n\n$lang = new Language();\n$lang->setLangId(Language::EN_GB_ID);\n$phpWord->getSettings()->setThemeFontLang($lang);\nYou can set the document information such as title, creator, and company name. Use the following functions:
<?php\n\n$properties = $phpWord->getDocInfo();\n$properties->setCreator('My name');\n$properties->setCompany('My factory');\n$properties->setTitle('My title');\n$properties->setDescription('My description');\n$properties->setCategory('My category');\n$properties->setLastModifiedBy('My name');\n$properties->setCreated(mktime(0, 0, 0, 3, 12, 2014));\n$properties->setModified(mktime(0, 0, 0, 3, 14, 2014));\n$properties->setSubject('My subject');\n$properties->setKeywords('my, key, word');\nThe base length unit in Open Office XML is twip. Twip means \"TWentieth of an Inch Point\", i.e. 1 twip = 1/1440 inch.
You can use PHPWord helper functions to convert inches, centimeters, or points to twip.
<?php\n\n// Paragraph with 6 points space after\n$phpWord->addParagraphStyle('My Style', array(\n 'spaceAfter' => \\PhpOffice\\PhpWord\\Shared\\Converter::pointToTwip(6))\n);\n\n$section = $phpWord->addSection();\n$sectionStyle = $section->getStyle();\n// half inch left margin\n$sectionStyle->setMarginLeft(\\PhpOffice\\PhpWord\\Shared\\Converter::inchToTwip(.5));\n// 2 cm right margin\n$sectionStyle->setMarginRight(\\PhpOffice\\PhpWord\\Shared\\Converter::cmToTwip(2));\nThe document (or parts of it) can be password protected.
<?php\n\n$documentProtection = $phpWord->getSettings()->getDocumentProtection();\n$documentProtection->setEditing(DocProtect::READ_ONLY);\n$documentProtection->setPassword('myPassword');\nTo force an update of the fields present in the document, set updateFields to true
<?php\n\n$phpWord->getSettings()->setUpdateFields(true);\nHyphenation describes the process of breaking words with hyphens. There are several options to control hyphenation.
"},{"location":"usage/introduction.html#auto-hyphenation","title":"Auto hyphenation","text":"To automatically hyphenate text set autoHyphenation to true.
<?php\n\n$phpWord->getSettings()->setAutoHyphenation(true);\nThe maximum number of consecutive lines of text ending with a hyphen can be controlled by the consecutiveHyphenLimit option. There is no limit if the option is not set or the provided value is 0.
<?php\n\n$phpWord->getSettings()->setConsecutiveHyphenLimit(2);\nThe hyphenation zone (in twip) is the allowed amount of whitespace before hyphenation is applied. The smaller the hyphenation zone the more words are hyphenated. Or in other words, the wider the hyphenation zone the less words are hyphenated.
<?php\n\n$phpWord->getSettings()->setHyphenationZone(\\PhpOffice\\PhpWord\\Shared\\Converter::cmToTwip(1));\nTo control whether or not words in all capital letters shall be hyphenated use the doNotHyphenateCaps option.
<?php\n\n$phpWord->getSettings()->setDoNotHyphenateCaps(true);\nThe name of the reader is HTML.
<?php\n\n$reader = IOFactory::createReader('HTML');\n$reader->load(__DIR__ . '/sample.html');\nThe name of the reader is MsDoc.
<?php\n\n$reader = IOFactory::createReader('MsDoc');\n$reader->load(__DIR__ . '/sample.doc');\nThe name of the reader is ODText.
<?php\n\n$reader = IOFactory::createReader('ODText');\n$reader->load(__DIR__ . '/sample.odt');\nThe name of the reader is RTF.
<?php\n\n$reader = IOFactory::createReader('RTF');\n$reader->load(__DIR__ . '/sample.rtf');\nThe name of the reader is Word2007.
<?php\n\n$reader = IOFactory::createReader('Word2007');\n$reader->load(__DIR__ . '/sample.docx');\nYou can create an OOXML document template with included search-patterns (macros) which can be replaced by any value you wish. Only single-line values can be replaced. By default Macros are defined like this: ${search-pattern} but you can define custom macros. To load a template file, create a new instance of the TemplateProcessor.
<?php\n\n$templateProcessor = new TemplateProcessor('Template.docx');\nGiven a template containing
Hello ${firstname} ${lastname}!\nThe following will replace ${firstname} with John, and ${lastname} with Doe . The resulting document will now contain Hello John Doe!
<?php\n\n$templateProcessor->setValue('firstname', 'John');\n$templateProcessor->setValue('lastname', 'Doe');\nYou can also set multiple values by passing all of them in an array.
<?php\n\n$templateProcessor->setValues(array('firstname' => 'John', 'lastname' => 'Doe'));\nGiven a template containing a checkbox control with the title or tag named:
${checkbox}\n<?php\n\n$templateProcessor->setCheckbox('checkbox', true);\nTo add a checkbox and set its title or tag in a template
- Go to Developer tab > Controls group
- Select the Check Box Content Control
- Right-click on your checkbox
- Click on Properties
- Set the title or the tag
These steps may change regarding the version of Microsoft Word used.
"},{"location":"usage/template.html#setmacroopeningchars","title":"setMacroOpeningChars","text":"You can define a custom opening macro. The following will set {# as the opening search pattern.
<?php\n\n$templateProcessor->setMacroOpeningChars('{#');\nYou can define a custom closing macro. The following will set #} as the closing search pattern.
<?php\n\n$templateProcessor->setMacroClosingChars('#}');\nYou can define a custom opening and closing macro at the same time . The following will set the search-pattern like this: {#search-pattern#} .
<?php\n\n$templateProcessor->setMacroChars('{#', '#}');\nThe search-pattern model for images can be like: - ${search-image-pattern} - ${search-image-pattern:[width]:[height]:[ratio]} - ${search-image-pattern:[width]x[height]} - ${search-image-pattern:size=[width]x[height]} - ${search-image-pattern:width=[width]:height=[height]:ratio=false}
Where: - [width] and [height] can be just numbers or numbers with measure, which supported by Word (cm, mm, in, pt, pc, px, %, em, ex) - [ratio] uses only for false, - or f to turn off respect aspect ration of image. By default template image size uses as 'container' size.
Example:
${CompanyLogo}\n${UserLogo:50:50} ${Name} - ${City} - ${Street}\n<?php\n\n$templateProcessor = new TemplateProcessor('Template.docx');\n$templateProcessor->setValue('Name', 'John Doe');\n$templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street'));\n\n$templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png');\n$templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false));\n$templateProcessor->setImageValue('FeatureImage', function () {\n // Closure will only be executed if the replacement tag is found in the template\n\n return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false);\n});\nGiven a template containing See Sample_23_TemplateBlock.php for an example.
${block_name}\nCustomer: ${customer_name}\nAddress: ${customer_address}\n${/block_name}\nThe following will duplicate everything between ${block_name} and ${/block_name} 3 times.
<?php\n\n$templateProcessor->cloneBlock('block_name', 3, true, true);\nThe last parameter will rename any macro defined inside the block and add #1, #2, #3 ... to the macro name. The result will be
Customer: ${customer_name#1}\nAddress: ${customer_address#1}\n\nCustomer: ${customer_name#2}\nAddress: ${customer_address#2}\n\nCustomer: ${customer_name#3}\nAddress: ${customer_address#3}\nIt is also possible to pass an array with the values to replace the marcros with. If an array with replacements is passed, the count argument is ignored, it is the size of the array that counts.
<?php\n\n$replacements = array(\n array('customer_name' => 'Batman', 'customer_address' => 'Gotham City'),\n array('customer_name' => 'Superman', 'customer_address' => 'Metropolis'),\n);\n$templateProcessor->cloneBlock('block_name', 0, true, false, $replacements);\nThe result will then be
Customer: Batman\nAddress: Gotham City\n\nCustomer: Superman\nAddress: Metropolis\nGiven a template containing
${block_name}\nThis block content will be replaced\n${/block_name}\nThe following will replace everything between ${block_name} and ${/block_name} with the value passed.
<?php\n\n$templateProcessor->replaceBlock('block_name', 'This is the replacement text.');\nSame as previous, but it deletes the block
<?php\n\n$templateProcessor->deleteBlock('block_name');\nClones a table row in a template document. See Sample_07_TemplateCloneRow.php for an example.
+-----------+----------------+\n| ${userId} | ${userName} |\n| |----------------+\n| | ${userAddress} |\n+-----------+----------------+\n<?php\n\n$templateProcessor->cloneRow('userId', 2);\nWill result in
+-------------+------------------+\n| ${userId#1} | ${userName#1} |\n| |------------------+\n| | ${userAddress#1} |\n+-------------+------------------+\n| ${userId#2} | ${userName#2} |\n| |------------------+\n| | ${userAddress#2} |\n+-------------+------------------+\nFinds a row in a table row identified by $search param and clones it as many times as there are entries in $values.
+-----------+----------------+\n| ${userId} | ${userName} |\n| |----------------+\n| | ${userAddress} |\n+-----------+----------------+\n<?php\n\n$values = [\n ['userId' => 1, 'userName' => 'Batman', 'userAddress' => 'Gotham City'],\n ['userId' => 2, 'userName' => 'Superman', 'userAddress' => 'Metropolis'],\n];\n$templateProcessor->cloneRowAndSetValues('userId', $values);\nWill result in
+---+-------------+\n| 1 | Batman |\n| |-------------+\n| | Gotham City |\n+---+-------------+\n| 2 | Superman |\n| |-------------+\n| | Metropolis |\n+---+-------------+\nApplies the XSL stylesheet passed to header part, footer part and main part
<?php\n\n$xslDomDocument = new \\DOMDocument();\n$xslDomDocument->load('/path/to/my/stylesheet.xsl');\n$templateProcessor->applyXslStyleSheet($xslDomDocument);\nReplaces a ${macro} with the ComplexType passed. See Sample_40_TemplateSetComplexValue.php for examples.
<?php\n\n$inline = new TextRun();\n$inline->addText('by a red italic text', array('italic' => true, 'color' => 'red'));\n$templateProcessor->setComplexValue('inline', $inline);\nReplaces a ${macro} with the ComplexType passed. See Sample_40_TemplateSetComplexValue.php for examples.
<?php\n\n$table = new Table(array('borderSize' => 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP));\n$table->addRow();\n$table->addCell(150)->addText('Cell A1');\n$table->addCell(150)->addText('Cell A2');\n$table->addCell(150)->addText('Cell A3');\n$table->addRow();\n$table->addCell(150)->addText('Cell B1');\n$table->addCell(150)->addText('Cell B2');\n$table->addCell(150)->addText('Cell B3');\n$templateProcessor->setComplexBlock('table', $table);\nReplace a variable by a chart.
<?php\n\n$categories = array('A', 'B', 'C', 'D', 'E');\n$series1 = array(1, 3, 2, 5, 4);\n$chart = new Chart('doughnut', $categories, $series1);\n$templateProcessor->setChartValue('myChart', $chart);\nSaves the loaded template within the current directory. Returns the file path.
<?php\n\n$filepath = $templateProcessor->save();\nSaves a copy of the loaded template in the indicated path.
<?php\n\n$pathToSave = 'path/to/save/file.ext';\n$templateProcessor->saveAs($pathToSave);\nThe name of the writer is HTML.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'HTML');\n$writer->save(__DIR__ . '/sample.html');\nWhen generating html/pdf, you can alter the default handling of white space (normal), and/or supply a fallback generic font as follows:
$writer = IOFactory::createWriter($oPhpWord, 'HTML');\n$writer->setDefaultGenericFont('serif');\n$writer->setDefaultWhiteSpace('pre-wrap');\n$writer->save(__DIR__ . '/sample.html');\nThe name of the writer is ODText.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'ODText');\n$writer->save(__DIR__ . '/sample.docx');\nThe name of the writer is PDF.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'PDF');\n$writer->save(__DIR__ . '/sample.pdf');\nTo generate a PDF, the PhpWord object passes through HTML before generating the PDF. This HTML can be modified using a callback.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'PDF');\n$writer->setEditCallback('cbEditHTML');\n$writer->save(__DIR__ . '/sample.pdf');\n\n/**\n * Add a meta tag generator\n */\nfunction cbEditHTML(string $inputHTML): string\n{\n $beforeBody = '<meta name=\"generator\" content=\"PHPWord\" />';\n $needle = '</head>';\n\n $pos = strpos($inputHTML, $needle);\n if ($pos !== false) {\n $inputHTML = (string) substr_replace($inputHTML, \"$beforeBody\\n$needle\", $pos, strlen($needle));\n }\n\n return $inputHTML;\n}\nYou can define options like : * font: default font
Options must be defined before creating the writer.
<?php\n\nuse PhpOffice\\PhpWord\\Settings;\n\nSettings::setPdfRendererOptions([\n 'font' => 'Arial'\n]);\n\n$writer = IOFactory::createWriter($oPhpWord, 'PDF');\n$writer->save(__DIR__ . '/sample.pdf');\nThe name of the writer is RTF.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'RTF');\n$writer->save(__DIR__ . '/sample.rtf');\nThe name of the writer is Word2007.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'Word2007');\n$writer->save(__DIR__ . '/sample.docx');\nYou can change the ZIP Adapter for the writer. By default, the ZIP Adapter is ZipArchiveAdapter.
<?php\n\nuse PhpOffice\\Common\\Adapter\\Zip\\PclZipAdapter;\nuse PhpOffice\\Common\\Adapter\\Zip\\ZipArchiveAdapter;\n\n$writer = IOFactory::createWriter($oPhpWord, 'Word2007');\n$writer->setZipAdapter(new PclZipAdapter());\n$writer->save(__DIR__ . '/sample.docx');\nBelow are the matrix of element availability in each container. The column shows the containers while the rows lists the elements.
Num Element Section Header Footer Cell Text Run Footnote 1 Text 2 Text Run 3 Link 4 Title 5 Preserve Text 6 Text Break 7 Page Break 8 List 9 Table 10 Image 11 Watermark 12 OLEObject 13 TOC 14 Footnote 15 Endnote 16 CheckBox 17 TextBox 18 Field 19 Line 20 ChartLegend:
- : Available.
- : Available only when inside header/footer.
- : Available only when inside section.
- : Not available.
- : Should be available.
Charts can be added using
<?php\n\n$categories = array('A', 'B', 'C', 'D', 'E');\n$series = array(1, 3, 2, 5, 4);\n$chart = $section->addChart('line', $categories, $series, $style);\nFor available styling options, see Styles > Chart.
Check out the Sample_32_Chart.php for more options and styling.
"},{"location":"usage/elements/checkbox.html","title":"Checkbox","text":"Checkbox elements can be added to sections or table cells by using addCheckBox.
<?php\n\n$section->addCheckBox($name, $text, [$fontStyle], [$paragraphStyle]);\n$name. Name of the check box.$text. Text to be displayed in the document.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
Comments can be added to a document by using addComment. The comment can contain formatted text. Once the comment has been added, it can be linked to any element with setCommentStart.
<?php\n\n// first create a comment\n$comment= new \\PhpOffice\\PhpWord\\Element\\Comment('Authors name', new \\DateTime(), 'my_initials');\n$comment->addText('Test', array('bold' => true));\n\n// add it to the document\n$phpWord->addComment($comment);\n\n$textrun = $section->addTextRun();\n$textrun->addText('This ');\n$text = $textrun->addText('is');\n// link the comment to the text you just created\n$text->setCommentStart($comment);\nIf no end is set for a comment using the setCommentEnd, the comment will be ended automatically at the end of the element it is started on.
Currently the following fields are supported:
- PAGE
- NUMPAGES
- DATE
- XE
- INDEX
- FILENAME
<?php\n\n$section->addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle])\n$fontStyle. SeeStyles > Font.
See \\PhpOffice\\PhpWord\\Element\\Field for list of properties and options available for each field type. Options which are not specifically defined can be added. Those must start with a \\.
For instance for the INDEX field, you can do the following (See Index Field for list of available options <https://support.office.com/en-us/article/Field-codes-Index-field-adafcf4a-cb30-43f6-85c7-743da1635d9e?ui=en-US&rs=en-US&ad=US>_ ):
<?php\n\n//the $fieldText can be either a simple string\n$fieldText = 'The index value';\n\n//or a 'TextRun', to be able to format the text you want in the index\n$fieldText = new TextRun();\n$fieldText->addText('My ');\n$fieldText->addText('bold index', ['bold' => true]);\n$fieldText->addText(' entry');\n$section->addField('XE', array(), array(), $fieldText);\n\n//this actually adds the index\n$section->addField('INDEX', array(), array('\\\\e \" \" \\\\h \"A\" \\\\c \"3\"'), 'right click to update index');\nFormula can be added using
<?php\n\nuse PhpOffice\\Math\\Element;\nuse PhpOffice\\Math\\Math;\n\n$fraction = new Element\\Fraction();\n$fraction\n ->setDenominator(new Element\\Numeric(2))\n ->setNumerator(new Element\\Identifier('\u03c0'))\n;\n\n$math = new Math();\n$math->add($fraction);\n\n$formula = $section->addFormula($math);\nTo add an image, use the addImage method to sections, headers, footers, textruns, or table cells.
<?php\n\n$section->addImage($src, [$style]);\n$src. String path to a local image, URL of a remote image or the image data, as a string. Warning: Do not pass user-generated strings here, as that would allow an attacker to read arbitrary files or perform server-side request forgery by passing file paths or URLs instead of image data.$style. SeeStyles > Image.
Examples:
<?php\n\n$section = $phpWord->addSection();\n$section->addImage(\n 'mars.jpg',\n array(\n 'width' => 100,\n 'height' => 100,\n 'marginTop' => -1,\n 'marginLeft' => -1,\n 'wrappingStyle' => 'behind'\n )\n);\n$footer = $section->addFooter();\n$footer->addImage('http://example.com/image.php');\n$textrun = $section->addTextRun();\n$textrun->addImage('http://php.net/logo.jpg');\n$source = file_get_contents('/path/to/my/images/earth.jpg');\n$textrun->addImage($source);\nLine elements can be added to sections by using addLine.
<?php\n\n$lineStyle = array('weight' => 1, 'width' => 100, 'height' => 0, 'color' => 635552);\n$section->addLine($lineStyle);\nAvailable line style attributes:
weight. Line width in twip.color. Defines the color of stroke.dash. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot.beginArrow. Start type of arrow: block, open, classic, diamond, oval.endArrow. End type of arrow: block, open, classic, diamond, oval.width. Line-object width in pt.height. Line-object height in pt.flip. Flip the line element: true, false.
You can add Hyperlinks to the document by using the function addLink:
<?php\n\n$section->addLink($linkSrc, [$linkName], [$fontStyle], [$paragraphStyle]);\n$linkSrc. The URL of the link.$linkName. Placeholder of the URL that appears in the document.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
Lists can be added by using addListItem and addListItemRun methods. addListItem is used for creating lists that only contain plain text. addListItemRun is used for creating complex list items that contains texts with different style (some bold, other italics, etc) or other elements, e.g. images or links. The syntaxes are as follow:
Basic usage:
<?php\n\n$section->addListItem($text, [$depth], [$fontStyle], [$listStyle], [$paragraphStyle]);\n$listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle])\nParameters:
$text. Text that appears in the document.$depth. Depth of list item.$fontStyle. SeeStyles > Font..$listStyle. List style of the current element TYPE_NUMBER, TYPE_ALPHANUM, TYPE_BULLET_FILLED, etc. See list of constants in PHPWord\\Style\\ListItem.$paragraphStyle. SeeStyles > Paragraph..
See Sample_14_ListItem.php for more code sample.
Advanced usage:
You can also create your own numbering style by changing the $listStyle parameter with the name of your numbering style.
<?php\n\n$phpWord->addNumberingStyle(\n 'multilevel',\n array(\n 'type' => 'multilevel',\n 'levels' => array(\n array('format' => 'decimal', 'text' => '%1.', 'left' => 360, 'hanging' => 360, 'tabPos' => 360),\n array('format' => 'upperLetter', 'text' => '%2.', 'left' => 720, 'hanging' => 360, 'tabPos' => 720),\n )\n )\n);\n$section->addListItem('List Item I', 0, null, 'multilevel');\n$section->addListItem('List Item I.a', 1, null, 'multilevel');\n$section->addListItem('List Item I.b', 1, null, 'multilevel');\n$section->addListItem('List Item II', 0, null, 'multilevel');\nFor available styling options see Styles > Numbering Level.
You can create footnotes with addFootnote and endnotes withaddEndnote in texts or textruns, but it's recommended to use textrun to have better layout. You can use addText, addLink,addTextBreak, addImage, addOLEObject on footnotes and endnotes.
On textrun:
<?php\n\n$textrun = $section->addTextRun();\n$textrun->addText('Lead text.');\n$footnote = $textrun->addFootnote();\n$footnote->addText('Footnote text can have ');\n$footnote->addLink('http://test.com', 'links');\n$footnote->addText('.');\n$footnote->addTextBreak();\n$footnote->addText('And text break.');\n$textrun->addText('Trailing text.');\n$endnote = $textrun->addEndnote();\n$endnote->addText('Endnote put at the end');\nOn text:
<?php\n\n$section->addText('Lead text.');\n$footnote = $section->addFootnote();\n$footnote->addText('Footnote text.');\nBy default the footnote reference number will be displayed with decimal number starting from 1. This number uses the FooterReference style which you can redefine with the addFontStyle method. Default value for this style is array('superScript' => true);
The footnote numbering can be controlled by setting the FootnoteProperties on the Section.
<?php\n\n$fp = new \\PhpOffice\\PhpWord\\ComplexType\\FootnoteProperties();\n//sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd)\n$fp->setPos(\\PhpOffice\\PhpWord\\ComplexType\\FootnoteProperties::POSITION_BENEATH_TEXT);\n//set the number format to use (decimal (default), upperRoman, upperLetter, ...)\n$fp->setNumFmt(\\PhpOffice\\PhpWord\\SimpleType\\NumberFormat::LOWER_ROMAN);\n//force starting at other than 1\n$fp->setNumStart(2);\n//when to restart counting (continuous (default), eachSect, eachPage)\n$fp->setNumRestart(\\PhpOffice\\PhpWord\\ComplexType\\FootnoteProperties::RESTART_NUMBER_EACH_PAGE);\n//And finaly, set it on the Section\n$section->setFootnoteProperties($fp);\nYou can add OLE embeddings, such as Excel spreadsheets or PowerPoint presentations to the document by using addOLEObject method.
<?php\n\n$section->addOLEObject($src, [$style]);\nThere are two ways to insert a page break, using the addPageBreak method or using the pageBreakBefore style of paragraph.
<?php\n\n$section->addPageBreak();\nThe addPreserveText method is used to add a page number or page count to headers or footers.
<?php\n\n$footer->addPreserveText('Page {PAGE} of {NUMPAGES}.');\nTo add tables, rows, and cells, use the addTable, addRow, and addCell methods:
<?php\n\n$table = $section->addTable([$tableStyle]);\n$table->addRow([$height], [$rowStyle]);\n$cell = $table->addCell($width, [$cellStyle]);\nTable style can be defined with addTableStyle:
<?php\n\n$tableStyle = array(\n 'borderColor' => '006699',\n 'borderSize' => 6,\n 'cellMargin' => 50\n);\n$firstRowStyle = array('bgColor' => '66BBFF');\n$phpWord->addTableStyle('myTable', $tableStyle, $firstRowStyle);\n$table = $section->addTable('myTable');\nFor available styling options see Styles > Table.
You can span a cell on multiple columns by using gridSpan or multiple rows by using vMerge.
<?php\n\n$cell = $table->addCell(200);\n$cell->getStyle()->setGridSpan(5);\nSee Sample_09_Tables.php for more code sample.
Text can be added by using addText and addTextRun methods. addText is used for creating simple paragraphs that only contain texts with the same style. addTextRun is used for creating complex paragraphs that contain text with different style (some bold, other italics, etc) or other elements, e.g. images or links. The syntaxes are as follow:
<?php\n\n$section->addText($text, [$fontStyle], [$paragraphStyle]);\n$textrun = $section->addTextRun([$paragraphStyle]);\n$text. Text to be displayed in the document.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
For available styling options, see Styles > Font and Styles > Paragraph.
If you want to enable track changes on added text you can mark it as INSERTED or DELETED by a specific user at a given time:
<?php\n\n$text = $section->addText('Hello World!');\n$text->setChanged(\\PhpOffice\\PhpWord\\Element\\ChangedElement::TYPE_INSERTED, 'Fred', (new \\DateTime()));\nTo Be Completed...
"},{"location":"usage/elements/textbreak.html","title":"Text breaks","text":"Text breaks are empty new lines. To add text breaks, use the following syntax. All parameters are optional.
<?php\n\n$section->addTextBreak([$breakCount], [$fontStyle], [$paragraphStyle]);\n$breakCount. How many lines.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
If you want to structure your document or build table of contents, you need titles or headings. To add a title to the document, use the addTitleStyle and addTitle method. If depth is 0, a Title will be inserted, otherwise a Heading1, Heading2, ...
<?php\n\n$phpWord->addTitleStyle($depth, [$fontStyle], [$paragraphStyle]);\n$section->addTitle($text, $depth, $pageNumber);\naddTitleStyle : - $depth - $fontStyle: See Styles > Font. - $paragraphStyle: See Styles > Paragraph.
addTitle : - $text. Text to be displayed in the document. This can be string or a \\PhpOffice\\PhpWord\\Element\\TextRun - $depth - $pageNumber : Number of the page
It's necessary to add a title style to your document because otherwise the title won't be detected as a real title.
"},{"location":"usage/elements/toc.html","title":"Table of contents","text":"To add a table of contents (TOC), you can use the addTOC method. Your TOC can only be generated if you have add at least one title (See \"Title\").
<?php\n\n$section->addTOC([$fontStyle], [$tocStyle], [$minDepth], [$maxDepth]);\n$fontStyle. See font style section.$tocStyle. See available options below.$minDepth. Minimum depth of header to be shown. Default 1.$maxDepth. Maximum depth of header to be shown. Default 9.
Options for $tocStyle:
tabLeader. Fill type between the title text and the page number. Use the defined constants in\\PhpOffice\\PhpWord\\Style\\TOC.tabPos. The position of the tab where the page number appears in twip.indent. The indent factor of the titles in twip.
Track changes can be set on text elements. There are 2 ways to set the change information on an element. Either by calling the setChangeInfo(), or by setting the TrackChange instance on the element with setTrackChange().
<?php\n\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n\n// New portrait section\n$section = $phpWord->addSection();\n$textRun = $section->addTextRun();\n\n$text = $textRun->addText('Hello World! Time to ');\n\n$text = $textRun->addText('wake ', array('bold' => true));\n$text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800);\n\n$text = $textRun->addText('up');\n$text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred'));\n\n$text = $textRun->addText('go to sleep');\n$text->setChangeInfo(TrackChange::DELETED, 'Barney', new \\DateTime('@' . (time() - 3600)));\nTo add a watermark (or page background image), your section needs a header reference. After creating a header, you can use the addWatermark method to add a watermark.
<?php\n\n$section = $phpWord->addSection();\n$header = $section->addHeader();\n$header->addWatermark('resources/_earth.jpg', array('marginTop' => 200, 'marginLeft' => 55));\nAvailable Chart style options:
width. Width (in EMU).height. Height (in EMU).3d. Is 3D; applies to pie, bar, line, area, true or false.colors. A list of colors to use in the chart.title. The title for the chart.showLegend. Show legend, true or false.LegendPosition. Legend position, r (default), b, t, l or tr.categoryLabelPosition. Label position for categories, nextTo (default), low or high.valueLabelPosition. Label position for values, nextTo (default), low or high.categoryAxisTitle. The title for the category axis.valueAxisTitle. The title for the values axis.majorTickMarkPos. The position for major tick marks, in, out, cross, none (default).showAxisLabels. Show labels for axis, true or false.gridX. Show Gridlines for X-Axis, true or false.gridY. Show Gridlines for Y-Axis, true or false.
Available Font style options:
allCaps. All caps, true or false.bgColor. Font background color, e.g. FF0000.bold. Bold, true or false.color. Font color, e.g. FF0000.doubleStrikethrough. Double strikethrough, true or false.fgColor. Font highlight color, e.g. yellow, green, blue. See\\PhpOffice\\PhpWord\\Style\\Font::FGCOLOR_...class constants for possible valueshint. Font content type, default, eastAsia, or cs.italic. Italic, true or false.name. Font name, e.g. Arial.rtl. Right to Left language, true or false.size. Font size, e.g. 20, 22.smallCaps. Small caps, true or false.strikethrough. Strikethrough, true or false.subScript. Subscript, true or false.superScript. Superscript, true or false.underline. Underline, single, dash, dotted, etc. See\\PhpOffice\\PhpWord\\Style\\Font::UNDERLINE_...class constants for possible valueslang. Language, either a language code like en-US, fr-BE, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages See\\PhpOffice\\PhpWord\\Style\\Languageclass for some language codes.position. The text position, raised or lowered, in half pointshidden. Hidden text, true or false.whiteSpace. How white space is handled when generating html/pdf. Possible values are pre-wrap and normal (other css values for white space are accepted, but are not expected to be useful).fallbackFont. Fallback generic font for html/pdf. Possible values are sans-serif, serif, and monospace (other css values for generic fonts are accepted).
Available Image style options:
alignment. See\\PhpOffice\\PhpWord\\SimpleType\\Jcclass for the details.height. Height in pt.marginLeft. Left margin in inches, can be negative.marginTop. Top margin in inches, can be negative.width. Width in pt.wrappingStyle. Wrapping style, inline, square, tight, behind, or infront.wrapDistanceTop. Top text wrapping in pixels.wrapDistanceBottom. Bottom text wrapping in pixels.wrapDistanceLeft. Left text wrapping in pixels.wrapDistanceRight. Right text wrapping in pixels.
Available NumberingLevel style options:
alignment. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. See\\PhpOffice\\PhpWord\\SimpleType\\Jcclass constants for possible values.font. Font name.format. Numbering format bullet|decimal|upperRoman|lowerRoman|upperLetter|lowerLetter.hanging. See paragraph style.hint. See font style.left. See paragraph style.restart. Restart numbering level symbol.start. Starting value.suffix. Content between numbering symbol and paragraph text tab|space|nothing.tabPos. See paragraph style.text. Numbering level text e.g. %1 for nonbullet or bullet character.
Available Paragraph style options:
alignment. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. See\\PhpOffice\\PhpWord\\SimpleType\\Jcclass constants for possible values.basedOn. Parent style.hanging. Hanging indentation in half inches.indent. Indent (left indentation) in half inches.indentation. An array of indentation key => value pairs in twip. Supports left, right, firstLine and hanging indentation. See\\PhpOffice\\PhpWord\\Style\\Indentationfor possible identation types.keepLines. Keep all lines on one page, true or false.keepNext. Keep paragraph with next paragraph, true or false.lineHeight. Text line height, e.g. 1.0, 1.5, etc.next. Style for next paragraph.pageBreakBefore. Start paragraph on next page, true or false.spaceBefore. Space before paragraph in twip.spaceAfter. Space after paragraph in twip.spacing. Space between lines in twip. If spacingLineRule is auto, 240 (height of 1 line) will be added, so if you want a double line height, set this to 240.spacingLineRule. Line Spacing Rule. auto, exact, atLeast See\\PhpOffice\\PhpWord\\SimpleType\\LineSpacingRuleclass constants for possible values.suppressAutoHyphens. Hyphenation for paragraph, true or false.tabs. Set of custom tab stops.widowControl. Allow first/last line to display on a separate page, true or false.contextualSpacing. Ignore Spacing Above and Below When Using Identical Styles, true or false.bidi. Right to Left Paragraph Layout, true or false.shading. Paragraph Shading.textAlignment. Vertical Character Alignment on Line. See\\PhpOffice\\PhpWord\\SimpleType\\TextAlignmentclass constants for possible values.
Available Section style options:
borderBottomColor. Border bottom color.borderBottomSize. Border bottom size in twip.borderLeftColor. Border left color.borderLeftSize. Border left size in twip.borderRightColor. Border right color.borderRightSize. Border right size in twip.borderTopColor. Border top color.borderTopSize. Border top size in twip.breakType. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage).colsNum. Number of columns.colsSpace. Spacing between columns.footerHeight. Spacing to bottom of footer.gutter. Page gutter spacing.headerHeight. Spacing to top of header.marginTop. Page margin top in twip.marginLeft. Page margin left in twip.marginRight. Page margin right in twip.marginBottom. Page margin bottom in twip.orientation. Page orientation (portrait, which is default, orlandscape). See\\PhpOffice\\PhpWord\\Style\\Section::ORIENTATION_...class constants for possible valuespageSizeH. Page height in twip. Implicitly defined byorientationoption. Any changes are discouraged.pageSizeW. Page width in twip. Implicitly defined byorientationoption. Any changes are discouraged.vAlign. Vertical Page Alignment See\\PhpOffice\\PhpWord\\SimpleType\\VerticalJcfor possible values
Available Table style options:
alignment. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. See\\PhpOffice\\PhpWord\\SimpleType\\JcTableand\\PhpOffice\\PhpWord\\SimpleType\\Jcclass constants for possible values.bgColor. Background color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Color. Border color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Size. Border size in twip.cellMargin(Top|Right|Bottom|Left). Cell margin in twip.indent. Table indent from leading margin. Must be an instance of\\PhpOffice\\PhpWord\\ComplexType\\TblWidth.width. Table width in Fiftieths of a Percent or Twentieths of a Point.unit. The unit to use for the width. One of\\PhpOffice\\PhpWord\\SimpleType\\TblWidth. Defaults to auto.layout. Table layout, either fixed or autofit See\\PhpOffice\\PhpWord\\Style\\Tablefor constants.cellSpacingCell spacing in twippositionFloating Table Positioning, see below for optionsbidiVisualPresent table as Right-To-Left
Floating Table Positioning options:
leftFromTextDistance From Left of Table to Text in twiprightFromTextDistance From Right of Table to Text in twiptopFromTextDistance From Top of Table to Text in twipbottomFromTextDistance From Top of Table to Text in twipvertAnchorTable Vertical Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::VANCHOR_*horzAnchorTable Horizontal Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::HANCHOR_*tblpXSpecRelative Horizontal Alignment From Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::XALIGN_*tblpXAbsolute Horizontal Distance From Anchorin twiptblpYSpecRelative Vertical Alignment From Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::YALIGN_*tblpYAbsolute Vertical Distance From Anchorin twip
Available Row style options:
cantSplit. Table row cannot break across pages, true or false.exactHeight. Row height is exact or at least.tblHeader. Repeat table row on every new page, true or false.
Available Cell style options:
bgColor. Background color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Color. Border color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Size. Border size in twip.border(Top|Right|Bottom|Left)Style. Border style. You can use constants from\\PhpOffice\\PhpWord\\SimpleType\\BordergridSpan. Number of columns spanned.textDirection(btLr|tbRl). Direction of text. You can use constants\\PhpOffice\\PhpWord\\Style\\Cell::TEXT_DIR_BTLRand\\PhpOffice\\PhpWord\\Style\\Cell::TEXT_DIR_TBRLvalign. Vertical alignment, top, center, both, bottom.vMerge. restart or continue.width. Cell width in twip.
PHPWord is a library written in pure PHP that provides a set ofclasses to write to different document file formats, i.e. Microsoft Office Open XML(.docx), OASIS Open Document Format for Office Applications (.odt), Rich Text Format (.rtf), Microsoft Word Binary File (.doc), HTML (.html), and PDF (.pdf).
PHPWord is an open source project licensed under the terms of LGPL version 3. PHPWord is aimed to be a high quality software product by incorporating continuous integration and unit testing. You can learn more about PHPWord by reading this Developers'Documentation.
"},{"location":"index.html#features","title":"Features","text":"- Set document properties, e.g. title, subject, and creator.
- Create document sections with different settings, e.g. portrait/landscape, page size, and page numbering
- Create header and footer for each sections
- Set default font type, font size, and paragraph style
- Use UTF-8 and East Asia fonts/characters
- Define custom font styles (e.g. bold, italic, color) and paragraph styles (e.g. centered, multicolumns, spacing) either as named style or inline in text
- Insert paragraphs, either as a simple text or complex one (a text run) that contains other elements
- Insert titles (headers) and table of contents
- Insert text breaks and page breaks
- Insert and format images, either local, remote, or as page watermarks
- Insert binary OLE Objects such as Excel or Visio
- Insert and format table with customized properties for each rows (e.g. repeat as header row) and cells (e.g. background color, rowspan, colspan)
- Insert list items as bulleted, numbered, or multilevel
- Insert hyperlinks
- Insert footnotes and endnotes
- Insert drawing shapes (arc, curve, line, polyline, rect, oval)
- Insert charts (pie, doughnut, bar, line, area, scatter, radar)
- Insert form fields (textinput, checkbox, and dropdown)
- Create document from templates
- Use XSL 1.0 style sheets to transform headers, main document part, and footers of an OOXML template
- ... and many more features on progress
Below are the supported features for each file formats.
"},{"location":"index.html#writers","title":"Writers","text":"Features OOXML ODF RTF HTML PDF Document Properties Standard Custom Element Type Text Text Run Title Link Preserve Text Text Break Page Break List Table Image Object Watermark Table of Contents Header Footer Footnote Endnote Comments Graphs 2D basic graphs 2D advanced graphs 3D graphs Math OMML support MathML support Bonus Encryption Protection"},{"location":"index.html#readers","title":"Readers","text":"Features OOXML DOC ODF RTF HTML Document Properties Standard Custom Element Type Text Text Run Title Link Preserve Text Text Break Page Break List Table Image Object Watermark Table of Contents Header Footer Footnote Endnote Comments Graphs 2D basic graphs 2D advanced graphs 3D graphs Math OMML support MathML support Bonus Encryption Protection"},{"location":"index.html#contributing","title":"Contributing","text":"We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute:
- Read our contributing guide
- Fork us and request a pull to the master branch
- Submit bug reports or feature requests to GitHub
- Follow @PHPOffice on Twitter
Images from chart page come from the LibreOffice Core.
Some definitions come from the Office Open XML.
"},{"location":"credits.html#references","title":"References","text":""},{"location":"credits.html#openxml","title":"OpenXML","text":"Known as \"ISO/IEC 29500, Third edition, 2012-09-01\"
ISO :
- Part 1: Fundamentals and Markup Language Reference
- Part 2: Open Packaging Conventions
- Part 3: Markup Compatibility and Extensibility
- Part 4: Transitional Migration Features
MSDN :
- Open XML SDK 2.5 with Validator
- DocumentFormat.OpenXml.Wordprocessing Namespace on MSDN
Library of Congress :
- OOXML Format Family -- ISO/IEC 29500 and ECMA 376
- Schemas in W3C XML Schema language and in RELAX NG for the Strict variant of PPTX, etc.
- Oasis OpenDocument Standard Version 1.2
- Schema Central Open Document 1.1
- Rich Text Format (RTF) Specification, version 1.9.1
- Improve the documentation
Use absolute positioning relative to margin horizontally and to line vertically.
<?php\n\n$imageStyle = array(\n 'width' => 40,\n 'height' => 40,\n 'wrappingStyle' => 'square',\n 'positioning' => 'absolute',\n 'posHorizontalRel' => 'margin',\n 'posVerticalRel' => 'line',\n);\n$textrun->addImage('resources/_earth.jpg', $imageStyle);\nUse php://output as the filename.
<?php\n\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n$section = $phpWord->addSection();\n$section->addText('Hello World!');\n$file = 'HelloWorld.docx';\nheader(\"Content-Description: File Transfer\");\nheader('Content-Disposition: attachment; filename=\"' . $file . '\"');\nheader('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document');\nheader('Content-Transfer-Encoding: binary');\nheader('Cache-Control: must-revalidate, post-check=0, pre-check=0');\nheader('Expires: 0');\n$xmlWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'Word2007');\n$xmlWriter->save(\"php://output\");\nDefine a numbering style and title styles, and match the two styles (with pStyle and numStyle) like below.
<?php\n\n$phpWord->addNumberingStyle(\n 'hNum',\n array('type' => 'multilevel', 'levels' => array(\n array('pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'),\n array('pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'),\n array('pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'),\n )\n )\n);\n$phpWord->addTitleStyle(1, array('size' => 16), array('numStyle' => 'hNum', 'numLevel' => 0));\n$phpWord->addTitleStyle(2, array('size' => 14), array('numStyle' => 'hNum', 'numLevel' => 1));\n$phpWord->addTitleStyle(3, array('size' => 12), array('numStyle' => 'hNum', 'numLevel' => 2));\n\n$section->addTitle('Heading 1', 1);\n$section->addTitle('Heading 2', 2);\n$section->addTitle('Heading 3', 3);\nApply 'HeadingN' paragraph style to TextRun or Link. Sample code:
<?php\n\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n$phpWord->addTitleStyle(1, array('size' => 16, 'bold' => true));\n$phpWord->addTitleStyle(2, array('size' => 14, 'bold' => true));\n$phpWord->addFontStyle('Link', array('color' => '0000FF', 'underline' => 'single'));\n\n$section = $phpWord->addSection();\n\n// Textrun\n$textrun = $section->addTextRun('Heading1');\n$textrun->addText('The ');\n$textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord', 'Link');\n\n// Link\n$section->addLink('https://github.com/', 'GitHub', 'Link', 'Heading2');\nUse the Metadata\\Compatibility\\setOoxmlVersion(n) method with n is the version of Office:
- 14 = Office 2010
- 15 = Office 2013
<?php\n\n$phpWord->getCompatibility()->setOoxmlVersion(15);\nMandatory:
- PHP 7.1+
- PHP DOM extension
- PHP JSON extension
- PHP XML Parser extension
- PHP XMLWriter extension
There are two ways to install PHPWord, i.e. via Composer or manually by downloading the library.
"},{"location":"install.html#using-composer","title":"Using Composer","text":"To install via Composer, add the following lines to your composer.json:
{\n \"require\": {\n \"phpoffice/phpword\": \"dev-master\"\n }\n}\nTo install manually:
- download PHPOffice\\PHPWord package from GitHub
- download PHPOffice\\Common package from GitHub
- extract the package and put the contents to your machine.
<?php\n\nrequire_once 'path/to/PHPWord/src/PhpWord/Autoloader.php';\n\\PhpOffice\\PhpWord\\Autoloader::register();\n\nrequire_once 'path/to/PhpOffice/Common/src/Common/Autoloader.php';\n\\PhpOffice\\Common\\Autoloader::register();\nAfter installation, you can browse and use the samples that we've provided, either by command line or using browser. If you can access your PhpWord library folder using browser, point your browser to the samples folder, e.g. http://localhost/PhpWord/samples/.
This release marked heavy refactorings on internal code structure with the creation of some abstract classes to reduce code duplication. Element subnamespace is introduced in this release to replace Section. Word2007 reader capability is greatly enhanced. Endnote is introduced. List numbering is now customizable. Basic HTML and PDF writing support is enabled. Basic ODText reader is introduced.
- Image: Get image dimensions without EXIF extension - @andrew-kzoo #184
- Table: Add
tblGridelement for Libre/Open Office table sizing - @gianis6 #183 - Footnote: Ability to insert textbreak in footnote
$footnote->addTextBreak()- @ivanlanin - Footnote: Ability to style footnote reference mark by using
FootnoteReferencestyle - @ivanlanin - Font: Add
bgColorto font style to define background using HEX color - @jcarignan #168 - Table: Add
exactHeightto row style to define whether row height should be exact or atLeast - @jcarignan #168 - Element: New
CheckBoxelement for sections and table cells - @ozilion #156 - Settings: Ability to use PCLZip as alternative to ZipArchive - @bskrtich @ivanlanin #106, #140, #185
- Template: Ability to find & replace variables in headers & footers - @dgudgeon #190
- Template: Ability to clone & delete block of text using
cloneBlockanddeleteBlock- @diego-vieira #191 - TOC: Ability to have two or more TOC in one document and to set min and max depth for TOC - @Pyreweb #189
- Table: Ability to add footnote in table cell - @ivanlanin #187
- Footnote: Ability to add image in footnote - @ivanlanin #187
- ListItem: Ability to add list item in header/footer - @ivanlanin #187
- CheckBox: Ability to add checkbox in header/footer - @ivanlanin #187
- Link: Ability to add link in header/footer - @ivanlanin #187
- Object: Ability to add object in header, footer, textrun, and footnote - @ivanlanin #187
- Media: Add
Media::resetElements()to reset all media data - @juzi #19 - General: Add
Style::resetStyles()- @ivanlanin #187 - DOCX Reader: Ability to read header, footer, footnotes, link, preservetext, textbreak, pagebreak, table, list, image, and title - @ivanlanin
- Endnote: Ability to add endnotes - @ivanlanin
- ListItem: Ability to create custom list and reset list number - @ivanlanin #10, #198
- ODT Writer: Basic table writing support - @ivanlanin
- Image: Keep image aspect ratio if only 1 dimension styled - @japonicus #194
- HTML Writer: Basic HTML writer: text, textrun, link, title, textbreak, table, image (as Base64), footnote, endnote - @ivanlanin #203, #67, #147
- PDF Writer: Basic PDF writer using DomPDF: All HTML element except image - @ivanlanin #68
- DOCX Writer: Change
docProps/app.xmlApplicationtoPHPWord- @ivanlanin - DOCX Writer: Create
word/settings.xmlandword/webSettings.xmldynamically - @ivanlanin - ODT Writer: Basic image writing - @ivanlanin
- ODT Writer: Link writing - @ivanlanin
- ODT Reader: Basic ODText Reader - @ivanlanin #71
- Section: Ability to define gutter and line numbering - @ivanlanin
- Font: Small caps, all caps, and double strikethrough - @ivanlanin #151
- Settings: Ability to use measurement unit other than twips with
setMeasurementUnit- @ivanlanin #199 - Style: Remove
bgColorfromFont,Table, andCelland put it into the newShadingstyle - @ivanlanin - Style: New
IndentationandSpacingstyle - @ivanlanin - Paragraph: Ability to define first line and right indentation - @ivanlanin
- Footnote: Footnote content doesn't show footnote reference number - @ivanlanin #170
- Documentation: Error in a function - @theBeerNut #195
createTextRunreplaced byaddTextRuncreateFootnotereplaced byaddFootnotecreateHeaderreplaced byaddHeadercreateFooterreplaced byaddFootercreateSectionreplaced byaddSectionElement\\Footnote::getReferenceIdreplaced byElement\\AbstractElement::getRelationIdElement\\Footnote::setReferenceIdreplaced byElement\\AbstractElement::setRelationIdFootnote::addFootnoteLinkElementreplaced byMedia::addElementFootnote::getFootnoteLinkElementsreplaced byMedia::getElements- All current methods on
Media Element\\Link::getLinkSrcreplaced byElement\\Link::getTargetElement\\Link::getLinkNamereplaced byElement\\Link::getTextStyle\\Cell::getDefaultBorderColor
- Documentation: Simplify page level docblock - @ivanlanin #179
- Writer: Refactor writer classes and create a new
Write\\AbstractWriterabstract class - @ivanlanin #160 - General: Refactor folders:
ElementandException- @ivanlanin #187 - General: Remove legacy
HashTableandShared\\ZipStreamWrapperand all related properties/methods - @ivanlanin #187 - Element: New
AbstractElementabstract class - @ivanlanin #187 - Media: Refactor media class to use one method for all docPart (section, header, footer, footnote) - @ivanlanin #187
- General: Remove underscore prefix from all private properties name - @ivanlanin #187
- General: Move Section
SettingstoStyle\\Section- @ivanlanin #187 - General: Give
Abstractprefix andInterfacesuffix for all abstract classes and interfaces as per PHP-FIG recommendation - @ivanlanin #187 - Style: New
Style\\AbstractStyleabstract class - @ivanlanin #187 - Writer: New 'ODText\\Base` class - @ivanlanin #187
- General: Rename
FootnotetoFootnotesto reflect the nature of collection - @ivanlanin - General: Add some unit tests for Shared & Element (100%!) - @Progi1984
- Test: Add some samples and tests for image wrapping style - @brunocasado #59
- Refactor: Remove Style\\Tabs - @ivanlanin
- Refactor: Apply composite pattern for writers - @ivanlanin
- Refactor: Split
AbstractContainerfromAbstractElement- @ivanlanin - Refactor: Apply composite pattern for Word2007 reader - @ivanlanin
This is a bugfix release for php-zip requirement in Composer.
- Change Composer requirements for php-zip from
requiretosuggest- @bskrtich #246
This release marked the change of PHPWord license from LGPL 2.1 to LGPL 3. Four new elements were added: TextBox, ListItemRun, Field, and Line. Relative and absolute positioning for images and textboxes were added. Writer classes were refactored into parts, elements, and styles. ODT and RTF features were enhanced. Ability to add elements to PHPWord object via HTML were implemented. RTF and HTML reader were initiated.
"},{"location":"changes/0.x/0.11.0.html#features","title":"Features","text":"- Image: Ability to define relative and absolute positioning - @basjan #217
- Footer: Conform footer with header by adding firstPage, evenPage and by inheritance - @basjan @ivanlanin #219
- Element: New
TextBoxelement - @basjan @ivanlanin #228, #229, #231 - HTML: Ability to add elements to PHPWord object via html - @basjan #231
- Element: New
ListItemRunelement that can add a list item with inline formatting like a textrun - @basjan #235 - Table: Ability to add table inside a cell (nested table) - @ivanlanin #149
- RTF Writer: UTF8 support for RTF: Internal UTF8 text is converted to Unicode before writing - @ivanlanin #158
- Table: Ability to define table width (in percent and twip) and position - @ivanlanin #237
- RTF Writer: Ability to add links and page breaks in RTF - @ivanlanin #196
- ListItemRun: Remove fontStyle parameter because ListItemRun is inherited from TextRun and TextRun doesn't have fontStyle - @ivanlanin
- Config: Ability to use a config file to store various common settings - @ivanlanin #200
- ODT Writer: Enable inline font style in TextRun - @ivanlanin
- ODT Writer: Enable underline, strike/doublestrike, smallcaps/allcaps, superscript/subscript font style - @ivanlanin
- ODT Writer: Enable section and column - @ivanlanin
- PDF Writer: Add TCPDF and mPDF as optional PDF renderer library - @ivanlanin
- ODT Writer: Enable title element and custom document properties - @ivanlanin
- ODT Reader: Ability to read standard and custom document properties - @ivanlanin
- Word2007 Writer: Enable the missing custom document properties writer - @ivanlanin
- Image: Enable \"image float left\" - @ivanlanin #244
- RTF Writer: Ability to write document properties - @ivanlanin
- RTF Writer: Ability to write image - @ivanlanin
- Element: New
Fieldelement - @basjan #251 - RTF Reader: Basic RTF reader - @ivanlanin #72, #252
- Element: New
Lineelement - @basjan #253 - Title: Ability to apply numbering in heading - @ivanlanin #193
- HTML Reader: Basic HTML reader - @ivanlanin #80, #254
- RTF Writer: Basic table writing - @ivanlanin #245
- Header: All images added to the second header were assigned to the first header - @basjan #222
- Conversion: Fix conversion from cm to pixel, pixel to cm, and pixel to point - @basjan #233, #234
- PageBreak: Page break adds new line in the beginning of the new page - @ivanlanin #150
- Image:
marginLeftandmarginTopcannot accept float value - @ivanlanin #248 - Title: Orphan
w:fldCharcaused OpenOffice to crash when opening DOCX - @ivanlanin #236
- Static classes
Footnotes,Endnotes, andTOC Writer\\Word2007\\Part:Numbering::writeNumbering(),Settings::writeSettings(),WebSettings::writeWebSettings(),ContentTypes::writeContentTypes(),Styles::writeStyles(),Document::writeDocument()all changed intowrite()Writer\\Word2007\\Part\\DocProps: Split intoWriter\\Word2007\\Part\\DocPropsCoreandWriter\\Word2007\\Part\\DocPropsAppElement\\Title::getBookmarkId()replaced byElement\\Title::getRelationId()Writer\\HTML::writeDocument: Replaced byWriter\\HTML::getContent
- License: Change the project license from LGPL 2.1 into LGPL 3.0 - #211
- Word2007 Writer: New
Style\\Imageclass - @ivanlanin - Refactor: Replace static classes
Footnotes,Endnotes, andTOCwithCollections- @ivanlanin #206 - QA: Reactivate
phpcpdandphpmdon Travis - @ivanlanin - Refactor: PHPMD recommendation: Change all
get...method that returnsbooleanintois...orhas...- @ivanlanin - Docs: Create gh-pages branch for API documentation - @Progi1984 #154
- QA: Add
.scrutinizer.ymland includecomposer.lockfor preparation to Scrutinizer - @ivanlanin #186 - Writer: Refactor writer parts using composite pattern - @ivanlanin
- Docs: Show code quality and test code coverage badge on README
- Style: Change behaviour of
set...function of boolean properties; when none is defined, assumed true - @ivanlanin - Shared: Unify PHP ZipArchive and PCLZip features into PhpWord ZipArchive - @ivanlanin
- Docs: Create VERSION file - @ivanlanin
- QA: Improve dan update requirement check in
samplesfolder - @ivanlanin
This is an immediate bugfix release for HTML reader.
- HTML Reader:
<p>and header tags puts no output - @canyildiz @ivanlanin #257
This release added form fields (textinput, checkbox, and dropdown), drawing shapes (arc, curve, line, polyline, rect, oval), and basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) elements along with some new styles. Basic MsDoc reader is introduced.
"},{"location":"changes/0.x/0.12.0.html#features","title":"Features","text":"- Element: Ability to add drawing shapes (arc, curve, line, polyline, rect, oval) using new
Shapeelement - @ivanlanin #123 - Font: New
scale,spacing, andkerningproperty of font style - @ivanlanin - Paragraph: Added shading to the paragraph style for full width shading - @lrobert #264
- RTF Writer: Support for sections, margins, and borders - @ivanlanin #249
- Section: Ability to set paper size, e.g. A4, A3, and Legal - @ivanlanin #249
- General: New
PhpWord::save()method to encapsulateIOFactory- @ivanlanin - General: New
Shared\\Converterstatic class - @ivanlanin - Chart: Basic 2D chart (pie, doughnut, bar, line, area, scatter, radar) - @ivanlanin #278
- Chart: 3D charts and ability to set width and height - @ivanlanin
- FormField: Ability to add textinput, checkbox, and dropdown form elements - @ivanlanin #266
- Setting: Ability to define document protection (readOnly, comments, trackedChanges, forms) - @ivanlanin
- Setting: Ability to remove [Compatibility Mode] text in the MS Word title bar - @ivanlanin
- SDT: Ability to add structured document tag elements (comboBox, dropDownList, date) - @ivanlanin
- Paragraph: Support for paragraph with borders - @ivanlanin #294
- Word2007 Writer : Support for RTL - @Progi1984 #331
- MsDOC Reader: Basic MsDOC Reader - @Progi1984 #23, #287
- \"absolute\" horizontal and vertical positioning of Frame - @basjan #302
- Add new-page function for PDF generation. For multiple PDF-backends - @chc88 #426
- Report style options enumerated when style unknown - @h6w
- Fix rare PclZip/realpath/PHP version problem - @andrew-kzoo #261
addHTMLencoding and ampersand fixes for PHP 5.3 - @bskrtich #270- Page breaks on titles and tables - @ivanlanin #274
- Table inside vertical border does not rendered properly - @ivanlanin #280
add<elementName>of container should be case insensitive, e.g.addTocshould be accepted, not onlyaddTOC- @ivanlanin #294- Fix specific borders (and margins) were not written correctly in word2007 writer - @pscheit #327
- \"HTML is not a valid writer\" exception while running \"Sample_36_RTL.php\" - @RomanSyroeshko #340
- \"addShape()\" magic method in AbstractContainer is mistakenly named as \"addObject()\" - @GMTA #356
Element\\Section::setPageSizeW()andElement\\Section::setPageSizeH()were mentioned in the docs but not implemented.- Special Characters (ampersand) in Title break docx output - @RomanSyroeshko #401
<th>tag is closed with</td>tag: - @franzholz #438
Element\\Link::getTarget()replaced byElement\\Link::getSource()Element\\Section::getSettings()andElement\\Section::setSettings()replaced byElement\\Section::getStyle()andElement\\Section::setStyle()Shared\\DrawingandShared\\Fontmerged intoShared\\ConverterDocumentPropertiesreplaced byMetadata\\DocInfoTemplatereplaced byTemplateProcessorPhpWord->loadTemplate($filename)
- Docs: Add known issue on
READMEabout requirement for temporary folder to be writable and updatesamples/index.phpfor this requirement check - @ivanlanin #238 - Docs: Correct elements.rst about Line - @chrissharkman #292
- PclZip: Remove temporary file after used - @andrew-kzoo #265
- Autoloader: Add the ability to set the autoloader options - @bskrtich #267
- Element: Refactor elements to move set relation Id from container to element - @ivanlanin
- Introduced CreateTemporaryFileException, CopyFileException - @RomanSyroeshko
- Settings: added method to set user defined temporary directory - @RomanSyroeshko #310
- Renamed
TemplateintoTemplateProcessor- @RomanSyroeshko #216 - Reverted #51. All text escaping must be performed out of the library - @RomanSyroeshko #51
v
"},{"location":"changes/0.x/0.12.1.html","title":"0.12.1 (30 August 2015)","text":"Maintenance release. This release is focused primarily on TemplateProcessor.
- Changed visibility of all private properties and methods of
TemplateProcessortoprotected. - @RomanSyroeshko #498 - Improved performance of
TemplateProcessor::setValue(). - @RomanSyroeshko @nicoSWD #513
- Fixed issue with \"Access denied\" message while opening
Sample_07_TemplateCloneRow.docxandSample_23_TemplateBlock.docxresult files on Windows platform. - @RomanSyroeshko @AshSat #532 - Fixed
PreserveTextelement alignment in footer (seeSample_12_HeaderFooter.php). - @RomanSyroeshko @SSchwaiger #495
This release brings several improvements in TemplateProcessor, automatic output escaping feature for OOXML, ODF, HTML, and RTF (turned off, by default). It also introduces constants for horizontal alignment options, and resolves some issues with PHP 7. Manual installation feature has been dropped since the release. Please, use Composer to install PHPWord.
- Introduced the
\\PhpOffice\\PhpWord\\SimpleType\\Jcsimple type. - @RomanSyroeshko - Introduced the
\\PhpOffice\\PhpWord\\SimpleType\\JcTablesimple type. - @RomanSyroeshko - Introduced writer for the \"Paragraph Alignment\" element (see
\\PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\ParagraphAlignment). - @RomanSyroeshko - Introduced writer for the \"Table Alignment\" element (see
\\PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\TableAlignment). - @RomanSyroeshko - Supported indexed arrays in arguments of
TemplateProcessor::setValue(). - @RomanSyroeshko #618 - Introduced automatic output escaping for OOXML, ODF, HTML, and RTF. To turn the feature on use
phpword.inior\\PhpOffice\\PhpWord\\Settings. - @RomanSyroeshko #483 - Supported processing of headers and footers in
TemplateProcessor::applyXslStyleSheet(). - @RomanSyroeshko #335
- Improved error message for the case when
autoload.phpis not found. - @RomanSyroeshko #371 - Renamed the
alignoption ofNumberingLevel,Frame,Table, andParagraphstyles intoalignment. - @RomanSyroeshko - Improved performance of
TemplateProcessor::setValue(). - @kazitanvirahsan #614, #617 - Fixed some HTML tags not rendering any output (p, header & table) - #257, #324 - @twmobius and @garethellis
getAlignandsetAlignmethods ofNumberingLevel,Frame,Table, andParagraphstyles. Use the correspondentgetAlignmentandsetAlignmentmethods instead. - @RomanSyroeshkoleft,right, andjustifyalignment options for paragraphs (now are mapped toJc::START,Jc::END, andJc::BOTH). - @RomanSyroeshkoleft,right, andjustifyalignment options for tables (now are mapped toJc::START,Jc::END, andJc::CENTER). - @RomanSyroeshkoTCPDFdue to its limited HTML support. UseDomPDForMPDFwriter instead. - @RomanSyroeshko #399
\\PhpOffice\\PhpWord\\Style\\Alignment. Style properties, which previously stored instances of this class, now deal with strings. In each case set of available string values is defined by the correspondent simple type. - @RomanSyroeshko- Manual installation support. Since the release we have dependencies on third party libraries, so installation via ZIP-archive download is not an option anymore. To install PHPWord use Composer. We also removed
\\PhpOffice\\PhpWord\\Autoloader, because the latter change made it completely useless. Autoloaders provided by Composer are in use now (seebootstrap.php). - @RomanSyroeshko \\PhpOffice\\PhpWord\\Shared\\Drawingreplaced by\\PhpOffice\\Common\\Drawing. - @Progi1984 #658\\PhpOffice\\PhpWord\\Shared\\Font. - @Progi1984 #658\\PhpOffice\\PhpWord\\Shared\\Stringreplaced by\\PhpOffice\\Common\\Text. - @Progi1984 @RomanSyroeshko #658\\PhpOffice\\PhpWord\\Shared\\XMLReaderreplaced by\\PhpOffice\\Common\\XMLReader. - @Progi1984 #658\\PhpOffice\\PhpWord\\Shared\\XMLWriterreplaced by\\PhpOffice\\Common\\XMLWriter. - @Progi1984 @RomanSyroeshko #658AbstractContainer::addMemoryImage(). UseAbstractContainer::addImage()instead.
Undefined propertyerror while reading MS-DOC documents. - @jaberu #610- Corrupted OOXML template issue in case when its names is broken immediately after
$sign. That case wasn't taken into account in implementation ofTemplateProcessor::fixBrokenMacros(). - @RomanSyroeshko @d-damien #548
This release fixes several bugs and adds some new features. This version brings compatibility with PHP 7.0 & 7.1
"},{"location":"changes/0.x/0.14.0.html#added","title":"Added","text":"- Possibility to control the footnote numbering -by @troosan in #1068
- Image creation from string -by @troosan in #937
- Introduced the
\\PhpOffice\\PhpWord\\SimpleType\\NumberFormatsimple type. - @troosan - Support for ContextualSpacing -by @postHawk in #1088
- Possiblity to hide spelling and/or grammatical errors -by @troosan in #542
- Possiblity to set default document language as well as changing the language for each text element -by @troosan in #1108
- Support for Comments -by @troosan in #1067
- Support for paragraph textAlignment -by @troosan in #1165
- Add support for HTML underline tag
<u>in addHtml -by @zNightFalLz in #1186 - Add support for HTML
<br>in addHtml - @anrikunby @troosan in #659 - Allow to change cell width unit - guillaume-ro-fr #986
- Allow to change the line height rule @troosan
- Implement PageBreak for odt writerby @cookiekiller in #863 #824
- Allow to force an update of all fields on opening a document -by @troosan in #951
- Allow adding a CheckBox in a TextRun -by @irond in #727
- Add support for HTML img tag -by @srggroup in #934
- Add support for password protection for docx -by @mariahaubner in #1019
- Loosen dependency to Zend
- Images are not being printed when generating PDF -by @hubertinio in #1074 #431
- Fixed some PHP 7 warnings - @ likeuntomurphy #927
- Fixed PHP 7.2 compatibility (renamed
Objectclass names toObjectElement) -by @SailorMax in #1185 - Fixed Word 97 reader - @alsofronie @Benpxpxby @mario-rivera in #912 #920 #892
- Fixed image loading over https -by @troosan in #988
- Impossibility to set different even and odd page headers -by @troosan in #981
- Fixed Word2007 reader where unnecessary paragraphs were being created -by @donghaobo in #1043 #620
- Fixed Word2007 reader where margins were not being read correctly -by @slowprog in #885 #1008
- Impossible to add element PreserveText in Section -by @rvanlaak in #452
- Added missing options for numbering format -by @troosan in #1041
- Fixed impossibility to set a different footer for first page -by @ctrlaltca in #1116,by @aoloe in #875
- Fixed styles not being applied by HTML writer, better pdf output -by @sarke in #1047 #500 #1139
- Fixed read docx error when document contains image from remote url -by @FBnil in #1173 #1176
- Padded the $args array to remove error -by @kaigoh in #1150,by @reformed in #870
- Fix incorrect image size between windows and mac -by @bskrtich in #874
- Fix adding HTML table to document - @mogilvieby @arivanbastos in #324
- Fix parsing on/off values (w:val=\"true|false|1|0|on|off\") -by @troosan in #1221 #1219
- Fix error on Empty Dropdown Entry -by @ComputerTinker in #592
- PhpWord->getProtection(), get it from the settings instead PhpWord->getSettings()->getDocumentProtection();
- Parsing of
alignHTML attribute -by @troosan in #1231 - Parse formatting inside HTML lists - @troosanby @samimussbach in #1239 / #945 / #1215 / #508
- Parsing of CSS
directioninstruction, HTMLlangattribute, formatting inside table cell -by @troosan in #1273 / #1252 / #1254 - Add support for Track changes @Cipby @troosan in #354 / #1262
- Add support for fixed Table Layout @aoloe @ekopachby @troosan in #841 / #1276
- Add support for Cell Spacing @dox07by @troosan in #1040
- Add parsing of formatting inside lists @atomicalnetby @troosan in #594
- Added support for Vertically Raised or Lowered Text (w:position) @anrikunby @troosan in #640
- Add support for MACROBUTTON field @phryneasby @troosan in #1021
- Add support for Hyphenationby @Trainmaster in #1282 (Document:
autoHyphenation,consecutiveHyphenLimit,hyphenationZone,doNotHyphenateCaps, Paragraph:suppressAutoHyphens) - Added support for Floating Table Positioning (tblpPr)by @anrikun in #639
- Added support for Image text wrapping distanceby @troosan in #1310
- Added parsing of CSS line-height and text-indent in HTML readerby @troosan in #1316
- Added the ability to enable gridlines and axislabels on chartsby @FrankMeyer in #576
- Add support for table indent (tblInd)by @Trainmaster in #1343
- Added parsing of internal links in HTML readerby @lalop in #1336
- Several improvements to chartsby @JAEK-S in #1332
- Add parsing of html image in base64 formatby @jgpATs2w in #1382
- Added Support for Indentation & Tabs on RTF Writer.by @smaug1985 in #1405
- Allows decimal numbers in HTML line-height styleby @jgpATs2w in #1413
- Fix reading of docx default style -by @troosan in #1238
- Fix the size unit of when parsing html images -by @troosan in #1254
- Fixed HTML parsing of nested lists -by @troosan in #1265
- Save PNG alpha information when using remote images.by @samsullivan in #779
- Fix parsing of
<w:br/>tag.by @troosan in #1274 - Bookmark are not writton as internal link in html writerby @troosan in #1263
- It should be possible to add a Footnote in a ListItemRunby @troosan in #1287 #1287
- Fix colspan and rowspan for tables in HTML Writerby @mattbolt in #1292
- Fix parsing of Heading and Title formating @troosanby @gthomas2 in #465
- Fix Dateformat typo, fix hours casing, add Month-Day-Year formatsby @ComputerTinker in #591
- Support reading of w:drawing for documents produced by word 2011+by @gthomas2 in #464 #1324
- Fix missing column width in ODText writerby @potofcoffee in #413
- Disable entity loader before parsing XML to avoid XXE injectionby @Tom4t0 in #1427
- Remove zend-stdlib dependencyby @Trainmaster in #1284
- The default unit for
\\PhpOffice\\PhpWord\\Style\\Imagechanged frompxtopt.
- Drop GitHub pages, switch to coveralls for code coverage analysisby @czosel in #1360
- Add getVariableCount method in TemplateProcessor.by @nicoder in #1272
- Add setting Chart Title and Legend visibilityby @Tom-Magill in #1433
- Add ability to pass a Style object in Section constructorby @ndench in #1416
- Add support for hidden textby @Alexmg86 in #1527
- Add support for setting images in TemplateProcessorby @SailorMax in #1170
- Add \"Plain Text\" type to SDT (Structured Document Tags)by @morrisdj in #1541
- Added possibility to index variables inside cloned block in TemplateProcessorby @JPBetley in #817
- Added possibility to replace variables inside cloned block with values in TemplateProcessorby @DIDoS in #1392
- Fix regex in
cloneBlockfunctionby @nicoder in #1269 - HTML Title Writer loses text when Title contains a TextRun instead a string.by @begnini in #1436
- Fix regex in fixBrokenMacros, make it less greedy @MuriloSo @brainwoodby @yurii-sio2 in #1502 / #1345
- 240 twips are being added to line spacing, should not happen when using lineRule fixedby @troosan in #1509 / #1505
- Adding table layout to the generated HTMLby @aarangara in #1441
- Fix loading of Sharepoint documentby @Garrcomm in #1498
- RTF writer: Round getPageSizeW and getPageSizeH to avoid decimalsby @Patrick64 in #1493
- Fix parsing of Office 365 documentsby @Timanx in #1485
- For RTF writers, sizes should should never have decimalsby @Samuel-BF in #1536
- Style Name Parsing fails if document generated by a non-english word versionby @begnini in #1434
- Get rid of duplicated code in TemplateProcessorby @abcdmitry in #1161
- Add methods setValuesFromArray and cloneRowFromArray to the TemplateProcessor @geraldb-nicat GH-670
- Set complex type in template @troosan GH-1565
- implement support for section vAlign @troosan GH-1569
- ParseStyle for border-color @Gllrm0 GH-1551
- Html writer auto invert text color @SailorMax GH-1387
- Add RightToLeft table presentation. @troosan GH-1550
- Add support for page vertical alignment. @troosan GH-672 GH-1569
- Adding setNumId method for ListItem style @eweso GH-1329
- Add support for basic fields in RTF writer. @Samuel-BF GH-1717
- Fix HTML border-color parsing. @troosan GH-1551 / GH-1570
- Language::validateLocale should pass with locale 'zxx'. @efpapado GH-1558
- can't align center vertically with the text @ter987 GH-672
- fix parsing of border-color and add test @troosan GH-1570
- TrackChange doesn't handle all return types of \\DateTime::createFromFormat(...) @superhaggis GH-1584
- To support PreserveText inside sub container @bhattnishant GH-1637
- No nested w:pPr elements in ListItemRun. @waltertamboer GH-1628
- Ensure that entity_loader disable variable is re-set back to the original setting @seamuslee001 GH-1585
- Use embedded http server to test loading of remote images @troosan GH-1544
- Change private to protected to be able extending class Html @SpinyMan GH-1646
- Fix apt-get crash in Travis CI for PHP 5.3 @mdupont GH-1707
Full Changelog
"},{"location":"changes/0.x/0.18.0.html#enhancements","title":"Enhancements","text":"- Add support for charts in template processor #2012 (@dbarzin)
- add/setting page element border style. #1986 (@emnabs)
- allow to use customized pdf library #1983 (@SailorMax)
- feat: Update addHtml to handle style inheritance #1965 (@Julien1138)
- Add parsing of Shape node values #1924 (@sven-ahrens)
- Allow to redefine TCPDF object #1907 (@SailorMax)
- Enhancements to addHTML parser #1902 (@lubosdz)
- Make Default Paper Configurable #1851 (@oleibman)
- Implement various missing features for the ODT writer #1796 (@oleibman)
- Added support for \"cloudConvert\" images #1794 (@ErnestStaug)
- Add support for several features for the RTF writer #1775 (@oleibman)
- Add font style for Field elements #1774 (@oleibman)
- Add support for ListItemRun in HTML writer #1766 (@stefan-91)
- Improvements in RTF writer #1755 (@oleibman)
- Allow a closure to be passed with image replacement tags #1716 (@mbardelmeijer)
- Add Option for Dynamic Chart Legend Position #1699 (@Stephan212)
- Add parsing of HTML checkbox input field #1832 (@Matze2010)
- Fix image stroke in libreoffice 7.x #1992 (@Adizbek)
- Fix deprecated warning for non-hexadecimal number #1988 (@Ciki)
- Fix limit not taken into account when adding image in template #1967 (@jsochor)
- Add null check when setComplexValue is not found #1936 (@YannikFirre)
- Some document have non-standard locale code #1824 (@ErnestStaug)
- Fixes PHPDoc @param and @return types for several Converter methods #1818 (@caugner)
- Update the regexp to avoid catastrophic backtracking #1809 (@juzser)
- Fix PHPUnit tests on develop branch #1771 (@mdupont)
- TemplateProcessor cloneBlock wrongly clones images #1763 (@alarai)
- Compatibility with PHP 7.4, PHP 8.0 and migrate to Laminas Escaper #1946 (@liborm85)
- Remove legacy PHPOffice/Common package, fix PHP 8.0 compatibility #1996 (@liborm85)
- Improve Word2007 Test Coverage #1858 (@oleibman)
- Fix typo in docs. Update templates-processing.rst #1952 (@mnvx)
- Fix documentation and method name for FootnoteProperties #1776 (@mdupont)
- fix: documentation about paragraph indentation #1764 (@mdupont)
- Update templates-processing.rst #1745 (@igronus)
- Unused variables $rows, $cols in sample #1877 (@ThanasisMpalatsoukas)
- Add unit test for NumberingStyle #1744 (@Manunchik)
- Add unit test for PhpWord Settings #1743 (@Manunchik)
- Add unit test for Media elements #1742 (@Manunchik)
- Update templates processing docs #1729 (@hcdias)
Full Changelog
"},{"location":"changes/0.x/0.18.1.html#bug-fixes","title":"Bug fixes","text":"- Fix BC break in GH-1946. This package does not replace laminas/laminas-zendframework-bridge by @mussbach in #2032
Full Changelog
"},{"location":"changes/0.x/0.18.2.html#bug-fixes","title":"Bug fixes","text":"- when adding image to relationship first check that the generated RID is actually unique by @tpv-ebben in #2063
- Update chart, don't write 'c:overlap' if grouping is 'clustered' by @dfsd534 in #2052
- Update Html parser to accept line-height:normal by @joelgo in #2041
- Fix image border in Word2007 Writer for LibreOffice 7 by k@amilmmach in #2021
- Corrected namespace for Language class in docs by @MegaChriz in #2087
- Added support for Garamond font by @artemkolotilkin in #2078
- Add BorderStyle for Cell Style to documentation by @DShkrabak in #2090
Full Changelog
"},{"location":"changes/0.x/0.18.3.html#bug-fixes","title":"Bug fixes","text":"- PHP 8.1 compatibility
This is the first release after a long development hiatus in CodePlex. This release initialized ODT and RTF Writer, along with some other new features for the existing Word2007 Writer, e.g. tab, multiple header, rowspan and colspan. Composer and Travis were added.
"},{"location":"changes/0.x/0.7.0.html#features","title":"Features","text":"- Implement RTF Writer - @Progi1984 #1
- Implement ODT Writer - @Progi1984 #2
- Word2007: Add rowspan and colspan to cells - @kaystrobach
- Word2007: Support for tab stops - @RLovelett
- Word2007: Support Multiple headers - @RLovelett
- Word2007: Wrapping Styles to Images - @gabrielbull
- Added support for image wrapping style - @gabrielbull
- \"Warning: Invalid error type specified in ...\\PHPWord.php on line 226\" is thrown when the specified template file is not found - @RomanSyroeshko #32
- PHPWord_Shared_String.IsUTF8 returns FALSE for Cyrillic UTF-8 input - @RomanSyroeshko #34
- Temporary files naming logic in PHPWord_Template can lead to a collision - @RomanSyroeshko #38
- Add superscript/subscript styling in Excel2007 Writer - @MarkBaker
- add indentation support to paragraphs - @deds
- Support for Composer - @Progi1984 #27
- Basic CI with Travis - @Progi1984
- Added PHPWord_Exception and exception when could not copy the template - @Progi1984
- IMPROVED: Moved examples out of Classes directory - @Progi1984
- IMPROVED: Advanced string replace in setValue for Template - @Esmeraldo #49
This release merged a lot of improvements from the community. Unit tests introduced in this release and has reached 90% code coverage.
"},{"location":"changes/0.x/0.8.0.html#features","title":"Features","text":"- Template: Permit to save a template generated as a file (PHPWord_Template::saveAs()) - @RomanSyroeshko #56, #57
- Word2007: Support sections page numbering - @gabrielbull
- Word2007: Added line height methods to mirror the line height settings in Word in the paragraph styling - @gabrielbull
- Word2007: Added support for page header & page footer height - @JillElaine #5
- General: Add ability to manage line breaks after image insertion - @bskrtich #6, #66, #84
- Template: Ability to limit number of replacements performed by setValue() method of Template class - @RomanSyroeshko #52, #53, #85
- Table row: Repeat as header row & allow row to break across pages - @ivanlanin #48, #86
- Table: Table width in percentage - @ivanlanin #48, #86
- Font: Superscript and subscript - @ivanlanin #48, #86
- Paragraph: Hanging paragraph - @ivanlanin #48, #86
- Section: Multicolumn and section break - @ivanlanin #48, #86
- Template: Ability to apply XSL style sheet to Template - @RomanSyroeshko #46, #47, #83
- General: PHPWord_Shared_Font::pointSizeToTwips() converter - @ivanlanin #87
- Paragraph: Ability to define normal paragraph style with PHPWord::setNormalStyle() - @ivanlanin #87
- Paragraph: Ability to define parent style (basedOn) and style for following paragraph (next) - @ivanlanin #87
- Clone table rows on the fly when using a template document - @jeroenmoors #44, #88
- Initial addition of basic footnote support - @deds #16
- Paragraph: Ability to define paragraph pagination: widow control, keep next, keep lines, and page break before - @ivanlanin #92
- General: PHPWord_Style_Font refactoring - @ivanlanin #93
- Font: Use points instead of halfpoints internally. Conversion to halfpoints done during XML Writing. - @ivanlanin #93
- Paragraph: setTabs() function - @ivanlanin #92
- General: Basic support for TextRun on ODT and RTF - @ivanlanin #99
- Reader: Basic Reader for Word2007 - @ivanlanin #104
- TextRun: Allow Text Break in Text Run - @bskrtich #109
- General: Support for East Asian fontstyle - @jhfangying #111, #118
- Image: Use exif_imagetype to check image format instead of extension name - @gabrielbull #114
- General: Setting for XMLWriter Compatibility option - @bskrtich #103
- MemoryImage: Allow remote image when allow_url_open = on - @ivanlanin #122
- TextBreak: Allow font and paragraph style for text break - @ivanlanin #18
- Fixed bug with cell styling - @gabrielbull
- Fixed bug list items inside of cells - @gabrielbull
- Adding a value that contains \"&\" in a template breaks it - @SiebelsTim #51
- Example in README.md is broken - @Progi1984 #89
- General: PHPWord_Shared_Drawing::centimetersToPixels() conversion - @ivanlanin #94
- Footnote: Corrupt DOCX reported by MS Word when sections > 1 and not every sections have footnote - @ivanlanin #125
- UnitTests - @Progi1984
This is a bugfix release for image detection functionality.
- Added fallback for computers that do not have exif_imagetype - @bskrtich, @gabrielbull
This release marked the transformation to namespaces (PHP 5.3+).
"},{"location":"changes/0.x/0.9.0.html#features","title":"Features","text":"- Image: Ability to use remote or GD images using
addImage()on sections, headers, footer, cells, and textruns - @ivanlanin - Header: Ability to use remote or GD images using
addWatermark()- @ivanlanin
- Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin
- Move documentation to Read The Docs - by @Progi1984 & @ivanlanin in #82
- Reorganize and redesign samples folder - @ivanlanin #137
- Use
PhpOffice\\PhpWordnamespace for PSR compliance - @RomanSyroeshko @gabrielbull #159, #58 - Restructure folders and change folder name
ClassestosrcandTeststotestfor PSR compliance - @RomanSyroeshko @gabrielbull - Compliance to phpDocumentor - @ivanlanin
- Merge Style\\TableFull into Style\\Table. Style\\TableFull is deprecated - @ivanlanin #160
- Merge Section\\MemoryImage into Section\\Image. Section\\Image is deprecated - @ivanlanin #160
This is a bugfix release for PSR-4 compatibility.
- Fixed PSR-4 composer autoloader - @AntonTyutin
Full Changelog
"},{"location":"changes/1.x/1.0.0.html#breaking-change","title":"BREAKING CHANGE","text":"Most deprecated things were dropped. See details in https://github.com/PHPOffice/PHPWord/commit/b9f1151bc6f90c276153c3c9dca10a5fc7f355fb.
"},{"location":"changes/1.x/1.0.0.html#dropped-classes","title":"Dropped classes:","text":"PhpOffice\\PhpWord\\Template
PhpOffice\\PhpWord\\Style\\Font::UNDERLINE_DOTHASHPhpOffice\\PhpWord\\Style\\Font::UNDERLINE_DOTHASHHEAVYPhpOffice\\PhpWord\\Style\\Cell::VALIGN_TOPPhpOffice\\PhpWord\\Style\\Cell::VALIGN_CENTERPhpOffice\\PhpWord\\Style\\Cell::VALIGN_BOTTOMPhpOffice\\PhpWord\\Style\\Cell::VALIGN_BOTHPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_DOTPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_UNDERSCOREPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_LINEPhpOffice\\PhpWord\\Style\\TOC::TABLEADER_NONEPhpOffice\\PhpWord\\Style\\Table::WIDTH_AUTOPhpOffice\\PhpWord\\Style\\Table::WIDTH_PERCENTPhpOffice\\PhpWord\\Style\\Table::WIDTH_TWIPPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_NAMEPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_SIZEPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_COLORPhpOffice\\PhpWord\\PhpWord::DEFAULT_FONT_CONTENT_TYPE
PhpOffice\\PhpWord\\Ekement\\AbstractContainer::createTextRun()PhpOffice\\PhpWord\\Ekement\\AbstractContainer::createFootnote()PhpOffice\\PhpWord\\Ekement\\Footnote::getReferenceId()PhpOffice\\PhpWord\\Ekement\\Footnote::setReferenceId()PhpOffice\\PhpWord\\Ekement\\Image::getIsWatermark()PhpOffice\\PhpWord\\Ekement\\Image::getIsMemImage()PhpOffice\\PhpWord\\Ekement\\Link::getTarget()PhpOffice\\PhpWord\\Ekement\\Link::getLinkSrc()PhpOffice\\PhpWord\\Ekement\\Link::getLinkName()PhpOffice\\PhpWord\\Ekement\\OLEObject::getObjectId()PhpOffice\\PhpWord\\Ekement\\OLEObject::setObjectId()PhpOffice\\PhpWord\\Ekement\\Section::getFootnotePropoperties()PhpOffice\\PhpWord\\Ekement\\Section::setSettings()PhpOffice\\PhpWord\\Ekement\\Section::getSettings()PhpOffice\\PhpWord\\Ekement\\Section::createHeader()PhpOffice\\PhpWord\\Ekement\\Section::createFooter()PhpOffice\\PhpWord\\Ekement\\Section::getFooter()PhpOffice\\PhpWord\\Media::addSectionMediaElement()PhpOffice\\PhpWord\\Media::addSectionLinkElement()PhpOffice\\PhpWord\\Media::getSectionMediaElements()PhpOffice\\PhpWord\\Media::countSectionMediaElements()PhpOffice\\PhpWord\\Media::addHeaderMediaElement()PhpOffice\\PhpWord\\Media::countHeaderMediaElements()PhpOffice\\PhpWord\\Media::getHeaderMediaElements()PhpOffice\\PhpWord\\Media::addFooterMediaElement()PhpOffice\\PhpWord\\Media::countFooterMediaElements()PhpOffice\\PhpWord\\Media::getFooterMediaElements()PhpOffice\\PhpWord\\PhpWord::getProtection()PhpOffice\\PhpWord\\PhpWord::loadTemplate()PhpOffice\\PhpWord\\PhpWord::createSection()PhpOffice\\PhpWord\\PhpWord::getDocumentProperties()PhpOffice\\PhpWord\\PhpWord::setDocumentProperties()PhpOffice\\PhpWord\\Reader\\AbstractReader::getReadDataOnly()PhpOffice\\PhpWord\\Settings::getCompatibility()PhpOffice\\PhpWord\\Style\\AbstractStyle::setArrayStyle()PhpOffice\\PhpWord\\Style\\Cell::getDefaultBorderColor()PhpOffice\\PhpWord\\Style\\Font::getBold()PhpOffice\\PhpWord\\Style\\Font::getItalic()PhpOffice\\PhpWord\\Style\\Font::getSuperScript()PhpOffice\\PhpWord\\Style\\Font::getSubScript()PhpOffice\\PhpWord\\Style\\Font::getStrikethrough()PhpOffice\\PhpWord\\Style\\Font::getParagraphStyle()PhpOffice\\PhpWord\\Style\\Frame::getAlign()PhpOffice\\PhpWord\\Style\\Frame::setAlign()PhpOffice\\PhpWord\\Style\\NumberingLevel::getAlign()PhpOffice\\PhpWord\\Style\\NumberingLevel::setAlign()PhpOffice\\PhpWord\\Style\\Paragraph::getAlign()PhpOffice\\PhpWord\\Style\\Paragraph::setAlign()PhpOffice\\PhpWord\\Style\\Paragraph::getWidowControl()PhpOffice\\PhpWord\\Style\\Paragraph::getKeepNext()PhpOffice\\PhpWord\\Style\\Paragraph::getKeepLines()PhpOffice\\PhpWord\\Style\\Paragraph::getPageBreakBefore()PhpOffice\\PhpWord\\Style\\Row::getTblHeader()PhpOffice\\PhpWord\\Style\\Row::isTblHeader()PhpOffice\\PhpWord\\Style\\Row::getCantSplit()PhpOffice\\PhpWord\\Style\\Row::getExactHeight()PhpOffice\\PhpWord\\Style\\Spacing::getRule()PhpOffice\\PhpWord\\Style\\Spacing::setRule()PhpOffice\\PhpWord\\Style\\Table::getAlign()PhpOffice\\PhpWord\\Style\\Table::setAlign()PhpOffice\\PhpWord\\Writer\\AbstractWriter::getUseDiskCaching()PhpOffice\\PhpWord\\Writer\\HTML::writeDocument()
- Multiple PHP 8.1 fixes
loadConfigreturns config that was actually applied- HTML Reader : Override inline style on HTML attribute for table
- HTML Reader : Use
borderattribute for tables - HTML Reader : Style page-break-after in paragraph
- HTML Reader : Heading in Text Run is not allowed
- Drop support for PHP 7.0 and older
Full Changelog
"},{"location":"changes/1.x/1.1.0.html#enhancements","title":"Enhancements","text":"- Introduce deleteRow() method for TemplateProcessor
- HTML Reader: Add basic support for CSS Style Tag
- Allow customizing macro syntax in TemplateProcessor
- Add background color support for textboxes
- Add softhyphen support to word reader
- Add support table row height when importing HTML
- Add support for fractional font sizes
- Added image quality support, with the maximum quality as default
- Support for reading nested tables
- DOCX reader: Read empty vmerge
- Fixed setting width of Cell Style
masteris the new default branch
Full Changelog
"},{"location":"changes/1.x/1.2.0.html#enhancements","title":"Enhancements","text":"- Word2007 Reader/Writer : Added noWrap table cell property by @kernusr in GH-2359
- HTML Reader : Support for
font-variant: small-capsby @cambraca in GH-2117 - Improved TextDirection for styling a cell by @terryzwt in GH-2429
- Word2007 Reader : Added option to disable loading images by @aelliott1485 in GH-2450
- HTML Writer : Added border-spacing to default styles for table by @kernusr in GH-2451
- Word2007 Reader : Support for table cell borders and margins by @kernusr in GH-2454
- PDF Writer : Add config for defining the default font by @MikeMaldini in #2262 & #2468
- Word2007 Reader : Added support for Comments by @shaedrich in #2161 & #2469
- Word2007 Reader/Writer: Permit book-fold printing by @potofcoffee in #2225 & #2470
- Word2007 Writer : Add PageNumber to TOC by @jet-desk in #1652 & #2471
- Word2007 Reader/Writer + ODText Reader/Writer : Add Element Formula in by @Progi1984 in #2477
- Add Support for Various Missing Features in HTML Writer by @oleibman in #2475
- Fixed addHTML (text-align:right in html is not handled correctly) in #2467
- HTML Writer : Added ability to specify generic fallback font
- HTML Writer : Added ability to specify handling of whitespace
- HTML Writer : Added support for Table Border style, color, and size
- HTML Writer : Added support for empty paragraphs (Word writer permits, browsers generally suppress)
- HTML Writer : Paragraph style should support indentation, line-height, page-break-before
- HTML Writer : Removed margin-top/bottom when spacing is null in Paragraph style
- HTML Writer : Added default paragraph style to all paragraphs, as well as class Normal
- HTML Writer : Use css @page and page declarations for sections
- HTML Writer : Wrap sections in div, with page break before each (except first)
- PDF Writer : Added support for PageBreak
- PDF Writer : Added callback for modifying the HTML
- Added Support for Language, both for document overall and individual text elements
- Template : Set a checkbox by @nxtpge in #2509
- ODText / RTF / Word2007 Writer : Add field FILENAME by @milkyway-git in #2510
- ODText Reader : Improve Section Reader by @oleibman in #2507
- Fixed wrong mimetype for docx files by @gamerlv in GH-2416
- Word2007 Reader : Read hyperlingks in headings by @hannesdorn in GH-2433
- PclZip : strtr using empty string by @spl1nes in GH-2432
- Fixed PHP 8.2 deprecated about Allow access to an undefined property by @DAdq26 in GH-2440
- Template Processor : Fixed choose dimention for Float Value by @gdevilbat in GH-2449
- HTML Parser : Fix image parsing from url without extension by @JokubasR in GH-2459
- Word2007 Reader : Fixed reading of Office365 DocX file by @filippotoso & @lfglopes in #2506
- Word2007 Reader : Check for null on $fontDefaultStyle by @spatialfree in #2513
- Added PHPStan by @PowerKiKi in GH-2405
- Bump symfony/process from 4.4.44 to 5.4.26 by @dependabot in GH-2431
- Bump phpunit/phpunit from 9.6.8 to 9.6.10 by @dependabot in GH-2430
- Added Coveralls.io by @Progi1984 in GH-2452
- Added support for PHP 8.2 & PHP 8.3 by @Progi1984 in GH-2453
- Moved documention from ReadTheDocs to MkDocs & Github Pages by @Progi1984 in GH-2465
- Bump phpstan/phpstan-phpunit from 1.3.13 to 1.3.14 by @dependabot in #2457
- Bump symfony/process from 5.4.26 to 5.4.28 by @dependabot in #2456
- Bump phpunit/phpunit from 9.6.10 to 9.6.11 by @dependabot in #2455
- Remove deprecated utf8_encode in PHP 8.2 by @mhcwebdesign in #2447 & #2472
- Bump mpdf/mpdf from 8.1.6 to 8.2.0 by @dependabot in #2480
- Bump phpunit/phpunit from 9.6.11 to 9.6.13 by @dependabot in #2481
- Bump tecnickcom/tcpdf from 6.6.2 to 6.6.5 by @dependabot in #2482
- Bump phpmd/phpmd from 2.13.0 to 2.14.1 by @dependabot in #2483
- Bump phpstan/phpstan-phpunit from 1.3.14 to 1.3.15 by @dependabot in #2494
- Removed dependency
laminas/laminas-escaper
Full Changelog
"},{"location":"changes/2.x/2.0.0.html#enhancements","title":"Enhancements","text":""},{"location":"changes/2.x/2.0.0.html#bug-fixes","title":"Bug fixes","text":"- MsDoc Reader : Correct Font Size Calculation by @oleibman fixing #2526 in #2531
- Bump dompdf/dompdf from 2.0.3 to 2.0.4 by @dependabot in #2530
- Bump phpunit/phpunit from 9.6.13 to 9.6.14 by @dependabot in #2519
- Bump mpdf/mpdf from 8.2.0 to 8.2.2 by @dependabot in #2518
- Bump phpmd/phpmd from 2.14.1 to 2.15.0 by @dependabot in #2538
Containers are objects where you can put elements (texts, lists, tables, etc). There are 3 main containers, i.e. sections, headers, and footers.There are 3 elements that can also act as containers, i.e. textruns, table cells, and footnotes.
"},{"location":"usage/containers.html#sections","title":"Sections","text":"Every visible element in word is placed inside of a section. To create a section, use the following code:
<?php\n\n$section = $phpWord->addSection($sectionStyle);\nThe $sectionStyle is an optional associative array that sets the section. Example:
<?php\n\n$sectionStyle = array(\n 'orientation' => 'landscape',\n 'marginTop' => 600,\n 'colsNum' => 2,\n);\nYou can change a section page number by using the pageNumberingStart style of the section.
<?php\n\n// Method 1\n$section = $phpWord->addSection(array('pageNumberingStart' => 1));\n\n// Method 2\n$section = $phpWord->addSection();\n$section->getStyle()->setPageNumberingStart(1);\nYou can change a section layout to multicolumn (like in a newspaper) by using the breakType and colsNum style of the section.
<?php\n\n// Method 1\n$section = $phpWord->addSection(array('breakType' => 'continuous', 'colsNum' => 2));\n\n// Method 2\n$section = $phpWord->addSection();\n$section->getStyle()->setBreakType('continuous');\n$section->getStyle()->setColsNum(2);\nYou can apply line numbering to a section by using the lineNumbering style of the section.
<?php\n\n// Method 1\n$section = $phpWord->addSection(array('lineNumbering' => array()));\n\n// Method 2\n$section = $phpWord->addSection();\n$section->getStyle()->setLineNumbering(array());\nBelow are the properties of the line numbering style.
startLine numbering starting valueincrementLine number incrementsdistanceDistance between text and line numbering in twiprestartLine numbering restart setting continuous|newPage|newSection
Each section can have its own header reference. To create a header use the addHeader method:
<?php\n\n$header = $section->addHeader();\nBe sure to save the result in a local object. You can use all elements that are available for the footer. See \"Footer\" section for detail. Additionally, only inside of the header reference you can add watermarks or background pictures. See \"Watermarks\" section.
You can pass an optional parameter to specify where the header/footer should be applied, it can be
Footer::AUTOdefault, all pages except if overridden by first or evenFooter::FIRSTeach first page of the sectionFooter::EVENeach even page of the section. Will only be applied if the evenAndOddHeaders is set to true in phpWord->settings
To change the evenAndOddHeaders use the getSettings method to return the Settings object, and then call the setEvenAndOddHeaders method:
<?php\n\n$phpWord->getSettings()->setEvenAndOddHeaders(true);\nEach section can have its own footer reference. To create a footer, use the addFooter method:
<?php\n\n$footer = $section->addFooter();\nBe sure to save the result in a local object to add elements to a footer. You can add the following elements to footers:
- Texts
addTextandcreateTextrun - Text breaks
- Images
- Tables
- Preserve text
See the \"Elements\" section for the detail of each elements.
"},{"location":"usage/containers.html#other-containers","title":"Other containers","text":"Textruns, table cells, and footnotes are elements that can also act as containers. See the corresponding \"Elements\" section for the detail of each elements.
"},{"location":"usage/introduction.html","title":"Introduction","text":""},{"location":"usage/introduction.html#basic-example","title":"Basic example","text":"The following is a basic example of the PHPWord library. More examples are provided in the samples folder.
<?php\nrequire_once 'bootstrap.php';\n\n// Creating the new document...\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n\n/* Note: any element you append to a document must reside inside of a Section. */\n\n// Adding an empty Section to the document...\n$section = $phpWord->addSection();\n// Adding Text element to the Section having font styled by default...\n$section->addText(\n '\"Learn from yesterday, live for today, hope for tomorrow. '\n . 'The important thing is not to stop questioning.\" '\n . '(Albert Einstein)'\n);\n\n/*\n * Note: it's possible to customize font style of the Text element you add in three ways:\n * - inline;\n * - using named font style (new font style object will be implicitly created);\n * - using explicitly created font style object.\n */\n\n// Adding Text element with font customized inline...\n$section->addText(\n '\"Great achievement is usually born of great sacrifice, '\n . 'and is never the result of selfishness.\" '\n . '(Napoleon Hill)',\n array('name' => 'Tahoma', 'size' => 10)\n);\n\n// Adding Text element with font customized using named font style...\n$fontStyleName = 'oneUserDefinedStyle';\n$phpWord->addFontStyle(\n $fontStyleName,\n array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true)\n);\n$section->addText(\n '\"The greatest accomplishment is not in never falling, '\n . 'but in rising again after you fall.\" '\n . '(Vince Lombardi)',\n $fontStyleName\n);\n\n// Adding Text element with font customized using explicitly created font style object...\n$fontStyle = new \\PhpOffice\\PhpWord\\Style\\Font();\n$fontStyle->setBold(true);\n$fontStyle->setName('Tahoma');\n$fontStyle->setSize(13);\n$myTextElement = $section->addText('\"Believe you can and you\\'re halfway there.\" (Theodor Roosevelt)');\n$myTextElement->setFontStyle($fontStyle);\n\n// Saving the document as OOXML file...\n$objWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'Word2007');\n$objWriter->save('helloWorld.docx');\n\n// Saving the document as ODF file...\n$objWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'ODText');\n$objWriter->save('helloWorld.odt');\n\n// Saving the document as HTML file...\n$objWriter = \\PhpOffice\\PhpWord\\IOFactory::createWriter($phpWord, 'HTML');\n$objWriter->save('helloWorld.html');\n\n/* Note: we skip RTF, because it's not XML-based and requires a different example. */\n/* Note: we skip PDF, because \"HTML-to-PDF\" approach is used to create PDF documents. */\nThe PhpOffice\\PhpWord\\Settings class provides some options that will affect the behavior of PHPWord. Below are the options.
This option sets XMLWriter::setIndent and XMLWriter::setIndentString. The default value of this option is true (compatible), which is required for OpenOffice to render OOXML document correctly. You can set this option to false during development to make the resulting XML file easier to read.
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setCompatibility(false);\nBy default, PHPWord uses Zip extension to deal with ZIP compressed archives and files inside them. If you can't have Zip extension installed on your server, you can use pure PHP library alternative, `PclZip``, which is included in PHPWord.
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setZipClass(\\PhpOffice\\PhpWord\\Settings::PCLZIP);\nWriting documents of some formats, especially XML-based, requires correct output escaping. Without it your document may become broken when you put special characters like ampersand, quotes, and others in it.
Escaping can be performed in two ways: outside of the library by a software developer and inside of the library by built-in mechanism. By default, the built-in mechanism is disabled for backward compatibility with versions prior to v0.13.0. To turn it on set outputEscapingEnabled option to true in your PHPWord configuration file or use the following instruction at runtime:
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setOutputEscapingEnabled(true);\nBy default, all sections of the document will print on A4 paper. You can alter the default paper by using the following function:
<?php\n\n\\PhpOffice\\PhpWord\\Settings::setDefaultPaper('Letter');\nBy default, every text appears in Arial 10 point. You can alter the default font by using the following two functions:
<?php\n\n$phpWord->setDefaultFontName('Times New Roman');\n$phpWord->setDefaultFontSize(12);\nSettings for the generated document can be set using $phpWord->getSettings()
The default zoom value is 100 percent. This can be changed either to another percentage
<?php\n\n$phpWord->getSettings()->setZoom(75);\nOr to predefined values fullPage, bestFit, textFit
<?php\n\n$phpWord->getSettings()->setZoom(Zoom::BEST_FIT);\nUse mirror margins to set up facing pages for double-sided documents, such as books or magazines.
<?php\n\n$phpWord->getSettings()->setMirrorMargins(true);\nDon't forget to set both paper size and page size
For example, to print a document on A4 paper (landscape) and fold it into A5 pages (portrait), use this section style:
<?php\n\nuse PhpOffice\\PhpWord\\Shared\\Converter;\n\n$phpWord->getSettings()->setMirrorMargins(true);\n$phpWord->addSection([\n 'paperSize' => 'A4',\n 'orientation' => 'landscape',\n 'pageSizeW' => Converter::cmToTwip(14.85),\n 'pageSizeH' => Converter::cmToTwip(21),\n]);\nUse book-fold printing to set up documents to be printed as foldable pages.
<?php\n\n$phpWord->getSettings()->setBookFoldPrinting(true);\nBy default spelling and grammatical errors are shown as soon as you open a word document. For big documents this can slow down the opening of the document. You can hide the spelling and/or grammatical errors with:
<?php\n\n$phpWord->getSettings()->setHideGrammaticalErrors(true);\n$phpWord->getSettings()->setHideSpellingErrors(true);\nYou can also specify the status of the spell and grammar checks, marking spelling or grammar as dirty will force a re-check when opening the document.
<?php\n\n$proofState = new \\PhpOffice\\PhpWord\\ComplexType\\ProofState();\n$proofState->setGrammar(\\PhpOffice\\PhpWord\\ComplexType\\ProofState::CLEAN);\n$proofState->setSpelling(\\PhpOffice\\PhpWord\\ComplexType\\ProofState::DIRTY);\n\n$phpWord->getSettings()->setProofState($proofState);\nTrack changes can be activated using setTrackRevisions, you can furture specify
- Not to use move syntax, instead moved items will be seen as deleted in one place and added in another
- Not track formatting revisions
<?php\n\n$phpWord->getSettings()->setTrackRevisions(true);\n$phpWord->getSettings()->setDoNotTrackMoves(true);\n$phpWord->getSettings()->setDoNotTrackFormatting(true);\nThe default symbol to represent a decimal figure is the . in english. In french you might want to change it to , for instance.
<?php\n\n$phpWord->getSettings()->setDecimalSymbol(',');\nThe default language of the document can be change with the following.
<?php\n\n$phpWord->getSettings()->setThemeFontLang(new Language(Language::FR_BE));\nLanguage has 3 parameters, one for Latin languages, one for East Asian languages and one for Complex (Bi-Directional) languages. A couple of language codes are provided in the PhpOffice\\PhpWord\\Style\\Language class but any valid code/ID can be used.
In case you are generating an RTF document the language need to be set differently.
<?php\n\n$lang = new Language();\n$lang->setLangId(Language::EN_GB_ID);\n$phpWord->getSettings()->setThemeFontLang($lang);\nYou can set the document information such as title, creator, and company name. Use the following functions:
<?php\n\n$properties = $phpWord->getDocInfo();\n$properties->setCreator('My name');\n$properties->setCompany('My factory');\n$properties->setTitle('My title');\n$properties->setDescription('My description');\n$properties->setCategory('My category');\n$properties->setLastModifiedBy('My name');\n$properties->setCreated(mktime(0, 0, 0, 3, 12, 2014));\n$properties->setModified(mktime(0, 0, 0, 3, 14, 2014));\n$properties->setSubject('My subject');\n$properties->setKeywords('my, key, word');\nThe base length unit in Open Office XML is twip. Twip means \"TWentieth of an Inch Point\", i.e. 1 twip = 1/1440 inch.
You can use PHPWord helper functions to convert inches, centimeters, or points to twip.
<?php\n\n// Paragraph with 6 points space after\n$phpWord->addParagraphStyle('My Style', array(\n 'spaceAfter' => \\PhpOffice\\PhpWord\\Shared\\Converter::pointToTwip(6))\n);\n\n$section = $phpWord->addSection();\n$sectionStyle = $section->getStyle();\n// half inch left margin\n$sectionStyle->setMarginLeft(\\PhpOffice\\PhpWord\\Shared\\Converter::inchToTwip(.5));\n// 2 cm right margin\n$sectionStyle->setMarginRight(\\PhpOffice\\PhpWord\\Shared\\Converter::cmToTwip(2));\nThe document (or parts of it) can be password protected.
<?php\n\n$documentProtection = $phpWord->getSettings()->getDocumentProtection();\n$documentProtection->setEditing(DocProtect::READ_ONLY);\n$documentProtection->setPassword('myPassword');\nTo force an update of the fields present in the document, set updateFields to true
<?php\n\n$phpWord->getSettings()->setUpdateFields(true);\nHyphenation describes the process of breaking words with hyphens. There are several options to control hyphenation.
"},{"location":"usage/introduction.html#auto-hyphenation","title":"Auto hyphenation","text":"To automatically hyphenate text set autoHyphenation to true.
<?php\n\n$phpWord->getSettings()->setAutoHyphenation(true);\nThe maximum number of consecutive lines of text ending with a hyphen can be controlled by the consecutiveHyphenLimit option. There is no limit if the option is not set or the provided value is 0.
<?php\n\n$phpWord->getSettings()->setConsecutiveHyphenLimit(2);\nThe hyphenation zone (in twip) is the allowed amount of whitespace before hyphenation is applied. The smaller the hyphenation zone the more words are hyphenated. Or in other words, the wider the hyphenation zone the less words are hyphenated.
<?php\n\n$phpWord->getSettings()->setHyphenationZone(\\PhpOffice\\PhpWord\\Shared\\Converter::cmToTwip(1));\nTo control whether or not words in all capital letters shall be hyphenated use the doNotHyphenateCaps option.
<?php\n\n$phpWord->getSettings()->setDoNotHyphenateCaps(true);\nThe name of the reader is HTML.
<?php\n\n$reader = IOFactory::createReader('HTML');\n$reader->load(__DIR__ . '/sample.html');\nThe name of the reader is MsDoc.
<?php\n\n$reader = IOFactory::createReader('MsDoc');\n$reader->load(__DIR__ . '/sample.doc');\nThe name of the reader is ODText.
<?php\n\n$reader = IOFactory::createReader('ODText');\n$reader->load(__DIR__ . '/sample.odt');\nThe name of the reader is RTF.
<?php\n\n$reader = IOFactory::createReader('RTF');\n$reader->load(__DIR__ . '/sample.rtf');\nThe name of the reader is Word2007.
<?php\n\n$reader = IOFactory::createReader('Word2007');\n$reader->load(__DIR__ . '/sample.docx');\nYou can create an OOXML document template with included search-patterns (macros) which can be replaced by any value you wish. Only single-line values can be replaced. By default Macros are defined like this: ${search-pattern} but you can define custom macros. To load a template file, create a new instance of the TemplateProcessor.
<?php\n\n$templateProcessor = new TemplateProcessor('Template.docx');\nGiven a template containing
Hello ${firstname} ${lastname}!\nThe following will replace ${firstname} with John, and ${lastname} with Doe . The resulting document will now contain Hello John Doe!
<?php\n\n$templateProcessor->setValue('firstname', 'John');\n$templateProcessor->setValue('lastname', 'Doe');\nYou can also set multiple values by passing all of them in an array.
<?php\n\n$templateProcessor->setValues(array('firstname' => 'John', 'lastname' => 'Doe'));\nGiven a template containing a checkbox control with the title or tag named:
${checkbox}\n<?php\n\n$templateProcessor->setCheckbox('checkbox', true);\nTo add a checkbox and set its title or tag in a template
- Go to Developer tab > Controls group
- Select the Check Box Content Control
- Right-click on your checkbox
- Click on Properties
- Set the title or the tag
These steps may change regarding the version of Microsoft Word used.
"},{"location":"usage/template.html#setmacroopeningchars","title":"setMacroOpeningChars","text":"You can define a custom opening macro. The following will set {# as the opening search pattern.
<?php\n\n$templateProcessor->setMacroOpeningChars('{#');\nYou can define a custom closing macro. The following will set #} as the closing search pattern.
<?php\n\n$templateProcessor->setMacroClosingChars('#}');\nYou can define a custom opening and closing macro at the same time . The following will set the search-pattern like this: {#search-pattern#} .
<?php\n\n$templateProcessor->setMacroChars('{#', '#}');\nThe search-pattern model for images can be like: - ${search-image-pattern} - ${search-image-pattern:[width]:[height]:[ratio]} - ${search-image-pattern:[width]x[height]} - ${search-image-pattern:size=[width]x[height]} - ${search-image-pattern:width=[width]:height=[height]:ratio=false}
Where: - [width] and [height] can be just numbers or numbers with measure, which supported by Word (cm, mm, in, pt, pc, px, %, em, ex) - [ratio] uses only for false, - or f to turn off respect aspect ration of image. By default template image size uses as 'container' size.
Example:
${CompanyLogo}\n${UserLogo:50:50} ${Name} - ${City} - ${Street}\n<?php\n\n$templateProcessor = new TemplateProcessor('Template.docx');\n$templateProcessor->setValue('Name', 'John Doe');\n$templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street'));\n\n$templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png');\n$templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false));\n$templateProcessor->setImageValue('FeatureImage', function () {\n // Closure will only be executed if the replacement tag is found in the template\n\n return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false);\n});\nGiven a template containing See Sample_23_TemplateBlock.php for an example.
${block_name}\nCustomer: ${customer_name}\nAddress: ${customer_address}\n${/block_name}\nThe following will duplicate everything between ${block_name} and ${/block_name} 3 times.
<?php\n\n$templateProcessor->cloneBlock('block_name', 3, true, true);\nThe last parameter will rename any macro defined inside the block and add #1, #2, #3 ... to the macro name. The result will be
Customer: ${customer_name#1}\nAddress: ${customer_address#1}\n\nCustomer: ${customer_name#2}\nAddress: ${customer_address#2}\n\nCustomer: ${customer_name#3}\nAddress: ${customer_address#3}\nIt is also possible to pass an array with the values to replace the marcros with. If an array with replacements is passed, the count argument is ignored, it is the size of the array that counts.
<?php\n\n$replacements = array(\n array('customer_name' => 'Batman', 'customer_address' => 'Gotham City'),\n array('customer_name' => 'Superman', 'customer_address' => 'Metropolis'),\n);\n$templateProcessor->cloneBlock('block_name', 0, true, false, $replacements);\nThe result will then be
Customer: Batman\nAddress: Gotham City\n\nCustomer: Superman\nAddress: Metropolis\nGiven a template containing
${block_name}\nThis block content will be replaced\n${/block_name}\nThe following will replace everything between ${block_name} and ${/block_name} with the value passed.
<?php\n\n$templateProcessor->replaceBlock('block_name', 'This is the replacement text.');\nSame as previous, but it deletes the block
<?php\n\n$templateProcessor->deleteBlock('block_name');\nClones a table row in a template document. See Sample_07_TemplateCloneRow.php for an example.
+-----------+----------------+\n| ${userId} | ${userName} |\n| |----------------+\n| | ${userAddress} |\n+-----------+----------------+\n<?php\n\n$templateProcessor->cloneRow('userId', 2);\nWill result in
+-------------+------------------+\n| ${userId#1} | ${userName#1} |\n| |------------------+\n| | ${userAddress#1} |\n+-------------+------------------+\n| ${userId#2} | ${userName#2} |\n| |------------------+\n| | ${userAddress#2} |\n+-------------+------------------+\nFinds a row in a table row identified by $search param and clones it as many times as there are entries in $values.
+-----------+----------------+\n| ${userId} | ${userName} |\n| |----------------+\n| | ${userAddress} |\n+-----------+----------------+\n<?php\n\n$values = [\n ['userId' => 1, 'userName' => 'Batman', 'userAddress' => 'Gotham City'],\n ['userId' => 2, 'userName' => 'Superman', 'userAddress' => 'Metropolis'],\n];\n$templateProcessor->cloneRowAndSetValues('userId', $values);\nWill result in
+---+-------------+\n| 1 | Batman |\n| |-------------+\n| | Gotham City |\n+---+-------------+\n| 2 | Superman |\n| |-------------+\n| | Metropolis |\n+---+-------------+\nApplies the XSL stylesheet passed to header part, footer part and main part
<?php\n\n$xslDomDocument = new \\DOMDocument();\n$xslDomDocument->load('/path/to/my/stylesheet.xsl');\n$templateProcessor->applyXslStyleSheet($xslDomDocument);\nReplaces a ${macro} with the ComplexType passed. See Sample_40_TemplateSetComplexValue.php for examples.
<?php\n\n$inline = new TextRun();\n$inline->addText('by a red italic text', array('italic' => true, 'color' => 'red'));\n$templateProcessor->setComplexValue('inline', $inline);\nReplaces a ${macro} with the ComplexType passed. See Sample_40_TemplateSetComplexValue.php for examples.
<?php\n\n$table = new Table(array('borderSize' => 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP));\n$table->addRow();\n$table->addCell(150)->addText('Cell A1');\n$table->addCell(150)->addText('Cell A2');\n$table->addCell(150)->addText('Cell A3');\n$table->addRow();\n$table->addCell(150)->addText('Cell B1');\n$table->addCell(150)->addText('Cell B2');\n$table->addCell(150)->addText('Cell B3');\n$templateProcessor->setComplexBlock('table', $table);\nReplace a variable by a chart.
<?php\n\n$categories = array('A', 'B', 'C', 'D', 'E');\n$series1 = array(1, 3, 2, 5, 4);\n$chart = new Chart('doughnut', $categories, $series1);\n$templateProcessor->setChartValue('myChart', $chart);\nSaves the loaded template within the current directory. Returns the file path.
<?php\n\n$filepath = $templateProcessor->save();\nSaves a copy of the loaded template in the indicated path.
<?php\n\n$pathToSave = 'path/to/save/file.ext';\n$templateProcessor->saveAs($pathToSave);\nThe name of the writer is HTML.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'HTML');\n$writer->save(__DIR__ . '/sample.html');\nWhen generating html/pdf, you can alter the default handling of white space (normal), and/or supply a fallback generic font as follows:
$writer = IOFactory::createWriter($oPhpWord, 'HTML');\n$writer->setDefaultGenericFont('serif');\n$writer->setDefaultWhiteSpace('pre-wrap');\n$writer->save(__DIR__ . '/sample.html');\nThe name of the writer is ODText.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'ODText');\n$writer->save(__DIR__ . '/sample.docx');\nThe name of the writer is PDF.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'PDF');\n$writer->save(__DIR__ . '/sample.pdf');\nTo generate a PDF, the PhpWord object passes through HTML before generating the PDF. This HTML can be modified using a callback.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'PDF');\n$writer->setEditCallback('cbEditHTML');\n$writer->save(__DIR__ . '/sample.pdf');\n\n/**\n * Add a meta tag generator\n */\nfunction cbEditHTML(string $inputHTML): string\n{\n $beforeBody = '<meta name=\"generator\" content=\"PHPWord\" />';\n $needle = '</head>';\n\n $pos = strpos($inputHTML, $needle);\n if ($pos !== false) {\n $inputHTML = (string) substr_replace($inputHTML, \"$beforeBody\\n$needle\", $pos, strlen($needle));\n }\n\n return $inputHTML;\n}\nYou can define options like : * font: default font
Options must be defined before creating the writer.
<?php\n\nuse PhpOffice\\PhpWord\\Settings;\n\nSettings::setPdfRendererOptions([\n 'font' => 'Arial'\n]);\n\n$writer = IOFactory::createWriter($oPhpWord, 'PDF');\n$writer->save(__DIR__ . '/sample.pdf');\nThe name of the writer is RTF.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'RTF');\n$writer->save(__DIR__ . '/sample.rtf');\nThe name of the writer is Word2007.
<?php\n\n$writer = IOFactory::createWriter($oPhpWord, 'Word2007');\n$writer->save(__DIR__ . '/sample.docx');\nYou can change the ZIP Adapter for the writer. By default, the ZIP Adapter is ZipArchiveAdapter.
<?php\n\nuse PhpOffice\\Common\\Adapter\\Zip\\PclZipAdapter;\nuse PhpOffice\\Common\\Adapter\\Zip\\ZipArchiveAdapter;\n\n$writer = IOFactory::createWriter($oPhpWord, 'Word2007');\n$writer->setZipAdapter(new PclZipAdapter());\n$writer->save(__DIR__ . '/sample.docx');\nBelow are the matrix of element availability in each container. The column shows the containers while the rows lists the elements.
Num Element Section Header Footer Cell Text Run Footnote 1 Text 2 Text Run 3 Link 4 Title 5 Preserve Text 6 Text Break 7 Page Break 8 List 9 Table 10 Image 11 Watermark 12 OLEObject 13 TOC 14 Footnote 15 Endnote 16 CheckBox 17 TextBox 18 Field 19 Line 20 ChartLegend:
- : Available.
- : Available only when inside header/footer.
- : Available only when inside section.
- : Not available.
- : Should be available.
Charts can be added using
<?php\n\n$categories = array('A', 'B', 'C', 'D', 'E');\n$series = array(1, 3, 2, 5, 4);\n$chart = $section->addChart('line', $categories, $series, $style);\nFor available styling options, see Styles > Chart.
Check out the Sample_32_Chart.php for more options and styling.
"},{"location":"usage/elements/checkbox.html","title":"Checkbox","text":"Checkbox elements can be added to sections or table cells by using addCheckBox.
<?php\n\n$section->addCheckBox($name, $text, [$fontStyle], [$paragraphStyle]);\n$name. Name of the check box.$text. Text to be displayed in the document.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
Comments can be added to a document by using addComment. The comment can contain formatted text. Once the comment has been added, it can be linked to any element with setCommentStart.
<?php\n\n// first create a comment\n$comment= new \\PhpOffice\\PhpWord\\Element\\Comment('Authors name', new \\DateTime(), 'my_initials');\n$comment->addText('Test', array('bold' => true));\n\n// add it to the document\n$phpWord->addComment($comment);\n\n$textrun = $section->addTextRun();\n$textrun->addText('This ');\n$text = $textrun->addText('is');\n// link the comment to the text you just created\n$text->setCommentStart($comment);\nIf no end is set for a comment using the setCommentEnd, the comment will be ended automatically at the end of the element it is started on.
Currently the following fields are supported:
- PAGE
- NUMPAGES
- DATE
- XE
- INDEX
- FILENAME
<?php\n\n$section->addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle])\n$fontStyle. SeeStyles > Font.
See \\PhpOffice\\PhpWord\\Element\\Field for list of properties and options available for each field type. Options which are not specifically defined can be added. Those must start with a \\.
For instance for the INDEX field, you can do the following (See Index Field for list of available options <https://support.office.com/en-us/article/Field-codes-Index-field-adafcf4a-cb30-43f6-85c7-743da1635d9e?ui=en-US&rs=en-US&ad=US>_ ):
<?php\n\n//the $fieldText can be either a simple string\n$fieldText = 'The index value';\n\n//or a 'TextRun', to be able to format the text you want in the index\n$fieldText = new TextRun();\n$fieldText->addText('My ');\n$fieldText->addText('bold index', ['bold' => true]);\n$fieldText->addText(' entry');\n$section->addField('XE', array(), array(), $fieldText);\n\n//this actually adds the index\n$section->addField('INDEX', array(), array('\\\\e \" \" \\\\h \"A\" \\\\c \"3\"'), 'right click to update index');\nFormula can be added using
<?php\n\nuse PhpOffice\\Math\\Element;\nuse PhpOffice\\Math\\Math;\n\n$fraction = new Element\\Fraction();\n$fraction\n ->setDenominator(new Element\\Numeric(2))\n ->setNumerator(new Element\\Identifier('\u03c0'))\n;\n\n$math = new Math();\n$math->add($fraction);\n\n$formula = $section->addFormula($math);\nTo add an image, use the addImage method to sections, headers, footers, textruns, or table cells.
<?php\n\n$section->addImage($src, [$style]);\n$src. String path to a local image, URL of a remote image or the image data, as a string. Warning: Do not pass user-generated strings here, as that would allow an attacker to read arbitrary files or perform server-side request forgery by passing file paths or URLs instead of image data.$style. SeeStyles > Image.
Examples:
<?php\n\n$section = $phpWord->addSection();\n$section->addImage(\n 'mars.jpg',\n array(\n 'width' => 100,\n 'height' => 100,\n 'marginTop' => -1,\n 'marginLeft' => -1,\n 'wrappingStyle' => 'behind'\n )\n);\n$footer = $section->addFooter();\n$footer->addImage('http://example.com/image.php');\n$textrun = $section->addTextRun();\n$textrun->addImage('http://php.net/logo.jpg');\n$source = file_get_contents('/path/to/my/images/earth.jpg');\n$textrun->addImage($source);\nLine elements can be added to sections by using addLine.
<?php\n\n$lineStyle = array('weight' => 1, 'width' => 100, 'height' => 0, 'color' => 635552);\n$section->addLine($lineStyle);\nAvailable line style attributes:
weight. Line width in twip.color. Defines the color of stroke.dash. Line types: dash, rounddot, squaredot, dashdot, longdash, longdashdot, longdashdotdot.beginArrow. Start type of arrow: block, open, classic, diamond, oval.endArrow. End type of arrow: block, open, classic, diamond, oval.width. Line-object width in pt.height. Line-object height in pt.flip. Flip the line element: true, false.
You can add Hyperlinks to the document by using the function addLink:
<?php\n\n$section->addLink($linkSrc, [$linkName], [$fontStyle], [$paragraphStyle]);\n$linkSrc. The URL of the link.$linkName. Placeholder of the URL that appears in the document.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
Lists can be added by using addListItem and addListItemRun methods. addListItem is used for creating lists that only contain plain text. addListItemRun is used for creating complex list items that contains texts with different style (some bold, other italics, etc) or other elements, e.g. images or links. The syntaxes are as follow:
Basic usage:
<?php\n\n$section->addListItem($text, [$depth], [$fontStyle], [$listStyle], [$paragraphStyle]);\n$listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle])\nParameters:
$text. Text that appears in the document.$depth. Depth of list item.$fontStyle. SeeStyles > Font..$listStyle. List style of the current element TYPE_NUMBER, TYPE_ALPHANUM, TYPE_BULLET_FILLED, etc. See list of constants in PHPWord\\Style\\ListItem.$paragraphStyle. SeeStyles > Paragraph..
See Sample_14_ListItem.php for more code sample.
Advanced usage:
You can also create your own numbering style by changing the $listStyle parameter with the name of your numbering style.
<?php\n\n$phpWord->addNumberingStyle(\n 'multilevel',\n array(\n 'type' => 'multilevel',\n 'levels' => array(\n array('format' => 'decimal', 'text' => '%1.', 'left' => 360, 'hanging' => 360, 'tabPos' => 360),\n array('format' => 'upperLetter', 'text' => '%2.', 'left' => 720, 'hanging' => 360, 'tabPos' => 720),\n )\n )\n);\n$section->addListItem('List Item I', 0, null, 'multilevel');\n$section->addListItem('List Item I.a', 1, null, 'multilevel');\n$section->addListItem('List Item I.b', 1, null, 'multilevel');\n$section->addListItem('List Item II', 0, null, 'multilevel');\nFor available styling options see Styles > Numbering Level.
You can create footnotes with addFootnote and endnotes withaddEndnote in texts or textruns, but it's recommended to use textrun to have better layout. You can use addText, addLink,addTextBreak, addImage, addOLEObject on footnotes and endnotes.
On textrun:
<?php\n\n$textrun = $section->addTextRun();\n$textrun->addText('Lead text.');\n$footnote = $textrun->addFootnote();\n$footnote->addText('Footnote text can have ');\n$footnote->addLink('http://test.com', 'links');\n$footnote->addText('.');\n$footnote->addTextBreak();\n$footnote->addText('And text break.');\n$textrun->addText('Trailing text.');\n$endnote = $textrun->addEndnote();\n$endnote->addText('Endnote put at the end');\nOn text:
<?php\n\n$section->addText('Lead text.');\n$footnote = $section->addFootnote();\n$footnote->addText('Footnote text.');\nBy default the footnote reference number will be displayed with decimal number starting from 1. This number uses the FooterReference style which you can redefine with the addFontStyle method. Default value for this style is array('superScript' => true);
The footnote numbering can be controlled by setting the FootnoteProperties on the Section.
<?php\n\n$fp = new \\PhpOffice\\PhpWord\\ComplexType\\FootnoteProperties();\n//sets the position of the footnote (pageBottom (default), beneathText, sectEnd, docEnd)\n$fp->setPos(\\PhpOffice\\PhpWord\\ComplexType\\FootnoteProperties::POSITION_BENEATH_TEXT);\n//set the number format to use (decimal (default), upperRoman, upperLetter, ...)\n$fp->setNumFmt(\\PhpOffice\\PhpWord\\SimpleType\\NumberFormat::LOWER_ROMAN);\n//force starting at other than 1\n$fp->setNumStart(2);\n//when to restart counting (continuous (default), eachSect, eachPage)\n$fp->setNumRestart(\\PhpOffice\\PhpWord\\ComplexType\\FootnoteProperties::RESTART_NUMBER_EACH_PAGE);\n//And finaly, set it on the Section\n$section->setFootnoteProperties($fp);\nYou can add OLE embeddings, such as Excel spreadsheets or PowerPoint presentations to the document by using addOLEObject method.
<?php\n\n$section->addOLEObject($src, [$style]);\nThere are two ways to insert a page break, using the addPageBreak method or using the pageBreakBefore style of paragraph.
<?php\n\n$section->addPageBreak();\nThe addPreserveText method is used to add a page number or page count to headers or footers.
<?php\n\n$footer->addPreserveText('Page {PAGE} of {NUMPAGES}.');\nTo add tables, rows, and cells, use the addTable, addRow, and addCell methods:
<?php\n\n$table = $section->addTable([$tableStyle]);\n$table->addRow([$height], [$rowStyle]);\n$cell = $table->addCell($width, [$cellStyle]);\nTable style can be defined with addTableStyle:
<?php\n\n$tableStyle = array(\n 'borderColor' => '006699',\n 'borderSize' => 6,\n 'cellMargin' => 50\n);\n$firstRowStyle = array('bgColor' => '66BBFF');\n$phpWord->addTableStyle('myTable', $tableStyle, $firstRowStyle);\n$table = $section->addTable('myTable');\nFor available styling options see Styles > Table.
You can span a cell on multiple columns by using gridSpan or multiple rows by using vMerge.
<?php\n\n$cell = $table->addCell(200);\n$cell->getStyle()->setGridSpan(5);\nSee Sample_09_Tables.php for more code sample.
Text can be added by using addText and addTextRun methods. addText is used for creating simple paragraphs that only contain texts with the same style. addTextRun is used for creating complex paragraphs that contain text with different style (some bold, other italics, etc) or other elements, e.g. images or links. The syntaxes are as follow:
<?php\n\n$section->addText($text, [$fontStyle], [$paragraphStyle]);\n$textrun = $section->addTextRun([$paragraphStyle]);\n$text. Text to be displayed in the document.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
For available styling options, see Styles > Font and Styles > Paragraph.
If you want to enable track changes on added text you can mark it as INSERTED or DELETED by a specific user at a given time:
<?php\n\n$text = $section->addText('Hello World!');\n$text->setChanged(\\PhpOffice\\PhpWord\\Element\\ChangedElement::TYPE_INSERTED, 'Fred', (new \\DateTime()));\nTo Be Completed...
"},{"location":"usage/elements/textbreak.html","title":"Text breaks","text":"Text breaks are empty new lines. To add text breaks, use the following syntax. All parameters are optional.
<?php\n\n$section->addTextBreak([$breakCount], [$fontStyle], [$paragraphStyle]);\n$breakCount. How many lines.$fontStyle. SeeStyles > Font.$paragraphStyle. SeeStyles > Paragraph.
If you want to structure your document or build table of contents, you need titles or headings. To add a title to the document, use the addTitleStyle and addTitle method. If depth is 0, a Title will be inserted, otherwise a Heading1, Heading2, ...
<?php\n\n$phpWord->addTitleStyle($depth, [$fontStyle], [$paragraphStyle]);\n$section->addTitle($text, $depth, $pageNumber);\naddTitleStyle : - $depth - $fontStyle: See Styles > Font. - $paragraphStyle: See Styles > Paragraph.
addTitle : - $text. Text to be displayed in the document. This can be string or a \\PhpOffice\\PhpWord\\Element\\TextRun - $depth - $pageNumber : Number of the page
It's necessary to add a title style to your document because otherwise the title won't be detected as a real title.
"},{"location":"usage/elements/toc.html","title":"Table of contents","text":"To add a table of contents (TOC), you can use the addTOC method. Your TOC can only be generated if you have add at least one title (See \"Title\").
<?php\n\n$section->addTOC([$fontStyle], [$tocStyle], [$minDepth], [$maxDepth]);\n$fontStyle. See font style section.$tocStyle. See available options below.$minDepth. Minimum depth of header to be shown. Default 1.$maxDepth. Maximum depth of header to be shown. Default 9.
Options for $tocStyle:
tabLeader. Fill type between the title text and the page number. Use the defined constants in\\PhpOffice\\PhpWord\\Style\\TOC.tabPos. The position of the tab where the page number appears in twip.indent. The indent factor of the titles in twip.
Track changes can be set on text elements. There are 2 ways to set the change information on an element. Either by calling the setChangeInfo(), or by setting the TrackChange instance on the element with setTrackChange().
<?php\n\n$phpWord = new \\PhpOffice\\PhpWord\\PhpWord();\n\n// New portrait section\n$section = $phpWord->addSection();\n$textRun = $section->addTextRun();\n\n$text = $textRun->addText('Hello World! Time to ');\n\n$text = $textRun->addText('wake ', array('bold' => true));\n$text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800);\n\n$text = $textRun->addText('up');\n$text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred'));\n\n$text = $textRun->addText('go to sleep');\n$text->setChangeInfo(TrackChange::DELETED, 'Barney', new \\DateTime('@' . (time() - 3600)));\nTo add a watermark (or page background image), your section needs a header reference. After creating a header, you can use the addWatermark method to add a watermark.
<?php\n\n$section = $phpWord->addSection();\n$header = $section->addHeader();\n$header->addWatermark('resources/_earth.jpg', array('marginTop' => 200, 'marginLeft' => 55));\nAvailable Chart style options:
width. Width (in EMU).height. Height (in EMU).3d. Is 3D; applies to pie, bar, line, area, true or false.colors. A list of colors to use in the chart.title. The title for the chart.showLegend. Show legend, true or false.LegendPosition. Legend position, r (default), b, t, l or tr.categoryLabelPosition. Label position for categories, nextTo (default), low or high.valueLabelPosition. Label position for values, nextTo (default), low or high.categoryAxisTitle. The title for the category axis.valueAxisTitle. The title for the values axis.majorTickMarkPos. The position for major tick marks, in, out, cross, none (default).showAxisLabels. Show labels for axis, true or false.gridX. Show Gridlines for X-Axis, true or false.gridY. Show Gridlines for Y-Axis, true or false.
Available Font style options:
allCaps. All caps, true or false.bgColor. Font background color, e.g. FF0000.bold. Bold, true or false.color. Font color, e.g. FF0000.doubleStrikethrough. Double strikethrough, true or false.fgColor. Font highlight color, e.g. yellow, green, blue. See\\PhpOffice\\PhpWord\\Style\\Font::FGCOLOR_...class constants for possible valueshint. Font content type, default, eastAsia, or cs.italic. Italic, true or false.name. Font name, e.g. Arial.rtl. Right to Left language, true or false.size. Font size, e.g. 20, 22.smallCaps. Small caps, true or false.strikethrough. Strikethrough, true or false.subScript. Subscript, true or false.superScript. Superscript, true or false.underline. Underline, single, dash, dotted, etc. See\\PhpOffice\\PhpWord\\Style\\Font::UNDERLINE_...class constants for possible valueslang. Language, either a language code like en-US, fr-BE, etc. or an object (or as an array) if you need to set eastAsian or bidirectional languages See\\PhpOffice\\PhpWord\\Style\\Languageclass for some language codes.position. The text position, raised or lowered, in half pointshidden. Hidden text, true or false.whiteSpace. How white space is handled when generating html/pdf. Possible values are pre-wrap and normal (other css values for white space are accepted, but are not expected to be useful).fallbackFont. Fallback generic font for html/pdf. Possible values are sans-serif, serif, and monospace (other css values for generic fonts are accepted).
Available Image style options:
alignment. See\\PhpOffice\\PhpWord\\SimpleType\\Jcclass for the details.height. Height in pt.marginLeft. Left margin in inches, can be negative.marginTop. Top margin in inches, can be negative.width. Width in pt.wrappingStyle. Wrapping style, inline, square, tight, behind, or infront.wrapDistanceTop. Top text wrapping in pixels.wrapDistanceBottom. Bottom text wrapping in pixels.wrapDistanceLeft. Left text wrapping in pixels.wrapDistanceRight. Right text wrapping in pixels.
Available NumberingLevel style options:
alignment. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. See\\PhpOffice\\PhpWord\\SimpleType\\Jcclass constants for possible values.font. Font name.format. Numbering format bullet|decimal|upperRoman|lowerRoman|upperLetter|lowerLetter.hanging. See paragraph style.hint. See font style.left. See paragraph style.restart. Restart numbering level symbol.start. Starting value.suffix. Content between numbering symbol and paragraph text tab|space|nothing.tabPos. See paragraph style.text. Numbering level text e.g. %1 for nonbullet or bullet character.
Available Paragraph style options:
alignment. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. See\\PhpOffice\\PhpWord\\SimpleType\\Jcclass constants for possible values.basedOn. Parent style.hanging. Hanging indentation in half inches.indent. Indent (left indentation) in half inches.indentation. An array of indentation key => value pairs in twip. Supports left, right, firstLine and hanging indentation. See\\PhpOffice\\PhpWord\\Style\\Indentationfor possible identation types.keepLines. Keep all lines on one page, true or false.keepNext. Keep paragraph with next paragraph, true or false.lineHeight. Text line height, e.g. 1.0, 1.5, etc.next. Style for next paragraph.pageBreakBefore. Start paragraph on next page, true or false.spaceBefore. Space before paragraph in twip.spaceAfter. Space after paragraph in twip.spacing. Space between lines in twip. If spacingLineRule is auto, 240 (height of 1 line) will be added, so if you want a double line height, set this to 240.spacingLineRule. Line Spacing Rule. auto, exact, atLeast See\\PhpOffice\\PhpWord\\SimpleType\\LineSpacingRuleclass constants for possible values.suppressAutoHyphens. Hyphenation for paragraph, true or false.tabs. Set of custom tab stops.widowControl. Allow first/last line to display on a separate page, true or false.contextualSpacing. Ignore Spacing Above and Below When Using Identical Styles, true or false.bidi. Right to Left Paragraph Layout, true or false.shading. Paragraph Shading.textAlignment. Vertical Character Alignment on Line. See\\PhpOffice\\PhpWord\\SimpleType\\TextAlignmentclass constants for possible values.
Available Section style options:
borderBottomColor. Border bottom color.borderBottomSize. Border bottom size in twip.borderLeftColor. Border left color.borderLeftSize. Border left size in twip.borderRightColor. Border right color.borderRightSize. Border right size in twip.borderTopColor. Border top color.borderTopSize. Border top size in twip.breakType. Section break type (nextPage, nextColumn, continuous, evenPage, oddPage).colsNum. Number of columns.colsSpace. Spacing between columns.footerHeight. Spacing to bottom of footer.gutter. Page gutter spacing.headerHeight. Spacing to top of header.marginTop. Page margin top in twip.marginLeft. Page margin left in twip.marginRight. Page margin right in twip.marginBottom. Page margin bottom in twip.orientation. Page orientation (portrait, which is default, orlandscape). See\\PhpOffice\\PhpWord\\Style\\Section::ORIENTATION_...class constants for possible valuespageSizeH. Page height in twip. Implicitly defined byorientationoption. Any changes are discouraged.pageSizeW. Page width in twip. Implicitly defined byorientationoption. Any changes are discouraged.vAlign. Vertical Page Alignment See\\PhpOffice\\PhpWord\\SimpleType\\VerticalJcfor possible values
Available Table style options:
alignment. Supports all alignment modes since 1st Edition of ECMA-376 standard up till ISO/IEC 29500:2012. See\\PhpOffice\\PhpWord\\SimpleType\\JcTableand\\PhpOffice\\PhpWord\\SimpleType\\Jcclass constants for possible values.bgColor. Background color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Color. Border color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Size. Border size in twip.cellMargin(Top|Right|Bottom|Left). Cell margin in twip.indent. Table indent from leading margin. Must be an instance of\\PhpOffice\\PhpWord\\ComplexType\\TblWidth.width. Table width in Fiftieths of a Percent or Twentieths of a Point.unit. The unit to use for the width. One of\\PhpOffice\\PhpWord\\SimpleType\\TblWidth. Defaults to auto.layout. Table layout, either fixed or autofit See\\PhpOffice\\PhpWord\\Style\\Tablefor constants.cellSpacingCell spacing in twippositionFloating Table Positioning, see below for optionsbidiVisualPresent table as Right-To-Left
Floating Table Positioning options:
leftFromTextDistance From Left of Table to Text in twiprightFromTextDistance From Right of Table to Text in twiptopFromTextDistance From Top of Table to Text in twipbottomFromTextDistance From Top of Table to Text in twipvertAnchorTable Vertical Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::VANCHOR_*horzAnchorTable Horizontal Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::HANCHOR_*tblpXSpecRelative Horizontal Alignment From Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::XALIGN_*tblpXAbsolute Horizontal Distance From Anchorin twiptblpYSpecRelative Vertical Alignment From Anchor, one of\\PhpOffice\\PhpWord\\Style\\TablePosition::YALIGN_*tblpYAbsolute Vertical Distance From Anchorin twip
Available Row style options:
cantSplit. Table row cannot break across pages, true or false.exactHeight. Row height is exact or at least.tblHeader. Repeat table row on every new page, true or false.
Available Cell style options:
bgColor. Background color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Color. Border color, e.g. '9966CC'.border(Top|Right|Bottom|Left)Size. Border size in twip.border(Top|Right|Bottom|Left)Style. Border style. You can use constants from\\PhpOffice\\PhpWord\\SimpleType\\BordergridSpan. Number of columns spanned.textDirection(btLr|tbRl). Direction of text. You can use constants\\PhpOffice\\PhpWord\\Style\\Cell::TEXT_DIR_BTLRand\\PhpOffice\\PhpWord\\Style\\Cell::TEXT_DIR_TBRLvalign. Vertical alignment, top, center, both, bottom.vMerge. restart or continue.width. Cell width in twip.
Elements
Elements
Legend:
-
-
- : Available.
+
- : Available.
- : Available only when inside header/footer.
- : Available only when inside section. -
- : Not available.
-
- : Should be available.
+
- : Not available.
+
- : Should be available.