Repository: PHPOffice/PHPWord Branch: master Commit: 0ab0b4940bc5 Files: 692 Total size: 2.9 MB Directory structure: gitextract_ajsy6hth/ ├── .gitattributes ├── .github/ │ ├── ISSUE_TEMPLATE/ │ │ ├── 1_bug_report.yml │ │ └── 2_feature_request.yml │ ├── PULL_REQUEST_TEMPLATE.md │ ├── dependabot.yml │ ├── support.yml │ └── workflows/ │ ├── deploy.yml │ └── php.yml ├── .github_changelog_generator ├── .gitignore ├── .php-cs-fixer.dist.php ├── CONTRIBUTING.md ├── COPYING ├── COPYING.LESSER ├── LICENSE ├── README.md ├── composer.json ├── docs/ │ ├── changes/ │ │ ├── 0.x/ │ │ │ ├── 0.10.0.md │ │ │ ├── 0.10.1.md │ │ │ ├── 0.11.0.md │ │ │ ├── 0.11.1.md │ │ │ ├── 0.12.0.md │ │ │ ├── 0.12.1.md │ │ │ ├── 0.13.0.md │ │ │ ├── 0.14.0.md │ │ │ ├── 0.15.0.md │ │ │ ├── 0.16.0.md │ │ │ ├── 0.17.0.md │ │ │ ├── 0.18.0.md │ │ │ ├── 0.18.1.md │ │ │ ├── 0.18.2.md │ │ │ ├── 0.18.3.md │ │ │ ├── 0.7.0.md │ │ │ ├── 0.8.0.md │ │ │ ├── 0.8.1.md │ │ │ ├── 0.9.0.md │ │ │ └── 0.9.1.md │ │ └── 1.x/ │ │ ├── 1.0.0.md │ │ ├── 1.1.0.md │ │ ├── 1.2.0.md │ │ ├── 1.3.0.md │ │ ├── 1.4.0.md │ │ └── 1.5.0.md │ ├── credits.md │ ├── faq.md │ ├── howto.md │ ├── index.md │ ├── install.md │ └── usage/ │ ├── containers.md │ ├── elements/ │ │ ├── chart.md │ │ ├── checkbox.md │ │ ├── comment.md │ │ ├── field.md │ │ ├── formula.md │ │ ├── image.md │ │ ├── index.md │ │ ├── line.md │ │ ├── link.md │ │ ├── list.md │ │ ├── note.md │ │ ├── oleobject.md │ │ ├── pagebreak.md │ │ ├── preservetext.md │ │ ├── ruby.md │ │ ├── table.md │ │ ├── text.md │ │ ├── textbox.md │ │ ├── textbreak.md │ │ ├── title.md │ │ ├── toc.md │ │ ├── trackchanges.md │ │ └── watermark.md │ ├── introduction.md │ ├── readers.md │ ├── styles/ │ │ ├── chart.md │ │ ├── font.md │ │ ├── image.md │ │ ├── numberinglevel.md │ │ ├── paragraph.md │ │ ├── section.md │ │ └── table.md │ ├── template.md │ └── writers.md ├── mkdocs.yml ├── phpmd.xml.dist ├── phpstan-baseline.neon ├── phpstan.neon.dist ├── phpunit.xml.dist ├── phpword.ini.dist ├── samples/ │ ├── Sample_01_SimpleText.php │ ├── Sample_02_TabStops.php │ ├── Sample_03_Sections.php │ ├── Sample_04_Textrun.php │ ├── Sample_05_Multicolumn.php │ ├── Sample_06_Footnote.php │ ├── Sample_07_TemplateCloneRow.php │ ├── Sample_08_ParagraphPagination.php │ ├── Sample_09_Tables.php │ ├── Sample_10_EastAsianFontStyle.php │ ├── Sample_11_ReadWord2007.php │ ├── Sample_11_ReadWord97.php │ ├── Sample_12_HeaderFooter.php │ ├── Sample_13_Images.php │ ├── Sample_14_ListItem.php │ ├── Sample_15_Link.php │ ├── Sample_16_Object.php │ ├── Sample_17_TitleTOC.php │ ├── Sample_18_Watermark.php │ ├── Sample_19_TextBreak.php │ ├── Sample_20_BGColor.php │ ├── Sample_21_TableRowRules.php │ ├── Sample_22_CheckBox.php │ ├── Sample_23_TemplateBlock.php │ ├── Sample_24_ReadODText.php │ ├── Sample_25_TextBox.php │ ├── Sample_26_Html.php │ ├── Sample_27_Field.php │ ├── Sample_28_ReadRTF.php │ ├── Sample_29_Line.php │ ├── Sample_30_ReadHTML.php │ ├── Sample_31_Shape.php │ ├── Sample_32_Chart.php │ ├── Sample_33_FormField.php │ ├── Sample_34_SDT.php │ ├── Sample_35_InternalLink.php │ ├── Sample_36_RTL.php │ ├── Sample_37_Comments.php │ ├── Sample_38_Protection.php │ ├── Sample_39_TrackChanges.php │ ├── Sample_40_TemplateSetComplexValue.php │ ├── Sample_41_TemplateSetChart.php │ ├── Sample_42_TemplateSetCheckbox.php │ ├── Sample_43_RTLDefault.php │ ├── Sample_44_ExtractVariablesFromReaderWord2007.php │ ├── Sample_45_Autoloader.php │ ├── Sample_46_RubyPhoneticGuide.php │ ├── Sample_Footer.php │ ├── Sample_Header.php │ ├── bootstrap/ │ │ ├── css/ │ │ │ └── phpword.css │ │ └── fonts/ │ │ └── FontAwesome.otf │ ├── index.php │ └── resources/ │ ├── Sample_07_TemplateCloneRow.docx │ ├── Sample_11_ReadWord2007.docx │ ├── Sample_11_ReadWord97.doc │ ├── Sample_23_TemplateBlock.docx │ ├── Sample_24_ReadODText.odt │ ├── Sample_28_ReadRTF.rtf │ ├── Sample_30_ReadHTML.html │ ├── Sample_40_TemplateSetComplexValue.docx │ ├── Sample_41_TemplateSetChart.docx │ ├── Sample_42_TemplateSetCheckbox.docx │ ├── Sample_44_ExtractVariablesFromReaderWord2007.docx │ └── _sheet.xls ├── src/ │ └── PhpWord/ │ ├── Autoloader.php │ ├── Collection/ │ │ ├── AbstractCollection.php │ │ ├── Bookmarks.php │ │ ├── Charts.php │ │ ├── Comments.php │ │ ├── Endnotes.php │ │ ├── Footnotes.php │ │ └── Titles.php │ ├── ComplexType/ │ │ ├── FootnoteProperties.php │ │ ├── ProofState.php │ │ ├── RubyProperties.php │ │ ├── TblWidth.php │ │ └── TrackChangesView.php │ ├── Element/ │ │ ├── AbstractContainer.php │ │ ├── AbstractElement.php │ │ ├── Bookmark.php │ │ ├── Cell.php │ │ ├── Chart.php │ │ ├── CheckBox.php │ │ ├── Comment.php │ │ ├── Endnote.php │ │ ├── Field.php │ │ ├── Footer.php │ │ ├── Footnote.php │ │ ├── FormField.php │ │ ├── Formula.php │ │ ├── Header.php │ │ ├── Image.php │ │ ├── Line.php │ │ ├── Link.php │ │ ├── ListItem.php │ │ ├── ListItemRun.php │ │ ├── OLEObject.php │ │ ├── PageBreak.php │ │ ├── PreserveText.php │ │ ├── Row.php │ │ ├── Ruby.php │ │ ├── SDT.php │ │ ├── Section.php │ │ ├── Shape.php │ │ ├── TOC.php │ │ ├── Table.php │ │ ├── Text.php │ │ ├── TextBox.php │ │ ├── TextBreak.php │ │ ├── TextRun.php │ │ ├── Title.php │ │ └── TrackChange.php │ ├── Escaper/ │ │ ├── AbstractEscaper.php │ │ ├── EscaperInterface.php │ │ ├── RegExp.php │ │ ├── Rtf.php │ │ └── Xml.php │ ├── Exception/ │ │ ├── CopyFileException.php │ │ ├── CreateTemporaryFileException.php │ │ ├── Exception.php │ │ ├── InvalidImageException.php │ │ ├── InvalidObjectException.php │ │ ├── InvalidStyleException.php │ │ └── UnsupportedImageTypeException.php │ ├── IOFactory.php │ ├── Media.php │ ├── Metadata/ │ │ ├── Compatibility.php │ │ ├── DocInfo.php │ │ ├── Protection.php │ │ └── Settings.php │ ├── PhpWord.php │ ├── Reader/ │ │ ├── AbstractReader.php │ │ ├── HTML.php │ │ ├── MsDoc.php │ │ ├── ODText/ │ │ │ ├── AbstractPart.php │ │ │ ├── Content.php │ │ │ └── Meta.php │ │ ├── ODText.php │ │ ├── RTF/ │ │ │ └── Document.php │ │ ├── RTF.php │ │ ├── ReaderInterface.php │ │ ├── Word2007/ │ │ │ ├── AbstractPart.php │ │ │ ├── Comments.php │ │ │ ├── DocPropsApp.php │ │ │ ├── DocPropsCore.php │ │ │ ├── DocPropsCustom.php │ │ │ ├── Document.php │ │ │ ├── Endnotes.php │ │ │ ├── Footnotes.php │ │ │ ├── Numbering.php │ │ │ ├── Settings.php │ │ │ └── Styles.php │ │ └── Word2007.php │ ├── Settings.php │ ├── Shared/ │ │ ├── AbstractEnum.php │ │ ├── Converter.php │ │ ├── Css.php │ │ ├── Drawing.php │ │ ├── Html.php │ │ ├── Microsoft/ │ │ │ └── PasswordEncoder.php │ │ ├── OLERead.php │ │ ├── PCLZip/ │ │ │ └── pclzip.lib.php │ │ ├── Text.php │ │ ├── Validate.php │ │ ├── XMLReader.php │ │ ├── XMLWriter.php │ │ └── ZipArchive.php │ ├── SimpleType/ │ │ ├── Border.php │ │ ├── DocProtect.php │ │ ├── Jc.php │ │ ├── JcTable.php │ │ ├── LineSpacingRule.php │ │ ├── NumberFormat.php │ │ ├── TblWidth.php │ │ ├── TextAlignment.php │ │ ├── VerticalJc.php │ │ └── Zoom.php │ ├── Style/ │ │ ├── AbstractStyle.php │ │ ├── Border.php │ │ ├── Cell.php │ │ ├── Chart.php │ │ ├── Extrusion.php │ │ ├── Fill.php │ │ ├── Font.php │ │ ├── Frame.php │ │ ├── Image.php │ │ ├── Indentation.php │ │ ├── Language.php │ │ ├── Line.php │ │ ├── LineNumbering.php │ │ ├── ListItem.php │ │ ├── Numbering.php │ │ ├── NumberingLevel.php │ │ ├── Outline.php │ │ ├── Paper.php │ │ ├── Paragraph.php │ │ ├── Row.php │ │ ├── Section.php │ │ ├── Shading.php │ │ ├── Shadow.php │ │ ├── Shape.php │ │ ├── Spacing.php │ │ ├── TOC.php │ │ ├── Tab.php │ │ ├── Table.php │ │ ├── TablePosition.php │ │ └── TextBox.php │ ├── Style.php │ ├── TemplateProcessor.php │ └── Writer/ │ ├── AbstractWriter.php │ ├── EPub3/ │ │ ├── Element/ │ │ │ ├── AbstractElement.php │ │ │ ├── Image.php │ │ │ └── Text.php │ │ ├── Part/ │ │ │ ├── AbstractPart.php │ │ │ ├── Content.php │ │ │ ├── ContentXhtml.php │ │ │ ├── Manifest.php │ │ │ ├── Meta.php │ │ │ ├── Mimetype.php │ │ │ └── Nav.php │ │ ├── Part.php │ │ └── Style/ │ │ ├── AbstractStyle.php │ │ ├── Font.php │ │ ├── Paragraph.php │ │ └── Table.php │ ├── EPub3.php │ ├── HTML/ │ │ ├── Element/ │ │ │ ├── AbstractElement.php │ │ │ ├── Bookmark.php │ │ │ ├── Container.php │ │ │ ├── Endnote.php │ │ │ ├── Footnote.php │ │ │ ├── Image.php │ │ │ ├── Link.php │ │ │ ├── ListItem.php │ │ │ ├── ListItemRun.php │ │ │ ├── PageBreak.php │ │ │ ├── Ruby.php │ │ │ ├── Table.php │ │ │ ├── Text.php │ │ │ ├── TextBreak.php │ │ │ ├── TextRun.php │ │ │ └── Title.php │ │ ├── Part/ │ │ │ ├── AbstractPart.php │ │ │ ├── Body.php │ │ │ └── Head.php │ │ └── Style/ │ │ ├── AbstractStyle.php │ │ ├── Font.php │ │ ├── Generic.php │ │ ├── Image.php │ │ ├── Paragraph.php │ │ └── Table.php │ ├── HTML.php │ ├── ODText/ │ │ ├── Element/ │ │ │ ├── AbstractElement.php │ │ │ ├── Container.php │ │ │ ├── Field.php │ │ │ ├── Formula.php │ │ │ ├── Image.php │ │ │ ├── Link.php │ │ │ ├── ListItemRun.php │ │ │ ├── PageBreak.php │ │ │ ├── Ruby.php │ │ │ ├── Table.php │ │ │ ├── Text.php │ │ │ ├── TextBreak.php │ │ │ ├── TextRun.php │ │ │ └── Title.php │ │ ├── Part/ │ │ │ ├── AbstractPart.php │ │ │ ├── Content.php │ │ │ ├── Manifest.php │ │ │ ├── Meta.php │ │ │ ├── Mimetype.php │ │ │ └── Styles.php │ │ └── Style/ │ │ ├── AbstractStyle.php │ │ ├── Font.php │ │ ├── Image.php │ │ ├── Numbering.php │ │ ├── Paragraph.php │ │ ├── Section.php │ │ └── Table.php │ ├── ODText.php │ ├── PDF/ │ │ ├── AbstractRenderer.php │ │ ├── DomPDF.php │ │ ├── MPDF.php │ │ └── TCPDF.php │ ├── PDF.php │ ├── RTF/ │ │ ├── Element/ │ │ │ ├── AbstractElement.php │ │ │ ├── Container.php │ │ │ ├── Field.php │ │ │ ├── Image.php │ │ │ ├── Link.php │ │ │ ├── ListItem.php │ │ │ ├── PageBreak.php │ │ │ ├── Ruby.php │ │ │ ├── Table.php │ │ │ ├── Text.php │ │ │ ├── TextBreak.php │ │ │ ├── TextRun.php │ │ │ └── Title.php │ │ ├── Part/ │ │ │ ├── AbstractPart.php │ │ │ ├── Document.php │ │ │ └── Header.php │ │ └── Style/ │ │ ├── AbstractStyle.php │ │ ├── Border.php │ │ ├── Font.php │ │ ├── Indentation.php │ │ ├── Paragraph.php │ │ ├── Section.php │ │ └── Tab.php │ ├── RTF.php │ ├── Word2007/ │ │ ├── Element/ │ │ │ ├── AbstractElement.php │ │ │ ├── Bookmark.php │ │ │ ├── Chart.php │ │ │ ├── CheckBox.php │ │ │ ├── Container.php │ │ │ ├── Endnote.php │ │ │ ├── Field.php │ │ │ ├── Footnote.php │ │ │ ├── FormField.php │ │ │ ├── Formula.php │ │ │ ├── Image.php │ │ │ ├── Line.php │ │ │ ├── Link.php │ │ │ ├── ListItem.php │ │ │ ├── ListItemRun.php │ │ │ ├── OLEObject.php │ │ │ ├── PageBreak.php │ │ │ ├── ParagraphAlignment.php │ │ │ ├── PreserveText.php │ │ │ ├── Ruby.php │ │ │ ├── SDT.php │ │ │ ├── Shape.php │ │ │ ├── TOC.php │ │ │ ├── Table.php │ │ │ ├── TableAlignment.php │ │ │ ├── Text.php │ │ │ ├── TextBox.php │ │ │ ├── TextBreak.php │ │ │ ├── TextRun.php │ │ │ └── Title.php │ │ ├── Part/ │ │ │ ├── AbstractPart.php │ │ │ ├── Chart.php │ │ │ ├── Comments.php │ │ │ ├── ContentTypes.php │ │ │ ├── DocPropsApp.php │ │ │ ├── DocPropsCore.php │ │ │ ├── DocPropsCustom.php │ │ │ ├── Document.php │ │ │ ├── Endnotes.php │ │ │ ├── FontTable.php │ │ │ ├── Footer.php │ │ │ ├── Footnotes.php │ │ │ ├── Header.php │ │ │ ├── Numbering.php │ │ │ ├── Rels.php │ │ │ ├── RelsDocument.php │ │ │ ├── RelsPart.php │ │ │ ├── Settings.php │ │ │ ├── Styles.php │ │ │ ├── Theme.php │ │ │ └── WebSettings.php │ │ └── Style/ │ │ ├── AbstractStyle.php │ │ ├── Cell.php │ │ ├── Extrusion.php │ │ ├── Fill.php │ │ ├── Font.php │ │ ├── Frame.php │ │ ├── Image.php │ │ ├── Indentation.php │ │ ├── Line.php │ │ ├── LineNumbering.php │ │ ├── MarginBorder.php │ │ ├── Outline.php │ │ ├── Paragraph.php │ │ ├── Row.php │ │ ├── Section.php │ │ ├── Shading.php │ │ ├── Shadow.php │ │ ├── Shape.php │ │ ├── Spacing.php │ │ ├── Tab.php │ │ ├── Table.php │ │ ├── TablePosition.php │ │ └── TextBox.php │ ├── Word2007.php │ ├── WriterInterface.php │ └── WriterPartInterface.php └── tests/ ├── PhpWordTests/ │ ├── AbstractTestReader.php │ ├── AbstractWebServerEmbedded.php │ ├── AutoloaderTest.php │ ├── Collection/ │ │ └── CollectionTest.php │ ├── ComplexType/ │ │ ├── FootnotePropertiesTest.php │ │ ├── ProofStateTest.php │ │ └── RubyPropertiesTest.php │ ├── Element/ │ │ ├── AbstractElementTest.php │ │ ├── BookmarkTest.php │ │ ├── CellTest.php │ │ ├── CheckBoxTest.php │ │ ├── CommentTest.php │ │ ├── FieldTest.php │ │ ├── FooterTest.php │ │ ├── FootnoteTest.php │ │ ├── FormulaTest.php │ │ ├── HeaderTest.php │ │ ├── ImageTest.php │ │ ├── LineTest.php │ │ ├── LinkTest.php │ │ ├── ListItemRunTest.php │ │ ├── ListItemTest.php │ │ ├── ObjectTest.php │ │ ├── PreserveTextTest.php │ │ ├── RowTest.php │ │ ├── RubyTest.php │ │ ├── SDTTest.php │ │ ├── SectionTest.php │ │ ├── TOCTest.php │ │ ├── TableTest.php │ │ ├── TextBoxTest.php │ │ ├── TextBreakTest.php │ │ ├── TextRunTest.php │ │ ├── TextTest.php │ │ ├── TitleTest.php │ │ └── TrackChangeTest.php │ ├── Escaper/ │ │ ├── RtfEscaper2Test.php │ │ └── RtfEscaper3Test.php │ ├── Exception/ │ │ ├── CopyFileExceptionTest.php │ │ ├── CreateTemporaryFileExceptionTest.php │ │ ├── ExceptionTest.php │ │ ├── InvalidImageExceptionTest.php │ │ ├── InvalidStyleExceptionTest.php │ │ └── UnsupportedImageTypeExceptionTest.php │ ├── IOFactoryTest.php │ ├── MediaTest.php │ ├── Metadata/ │ │ ├── DocInfoTest.php │ │ └── SettingsTest.php │ ├── PhpWordTest.php │ ├── Reader/ │ │ ├── HTMLTest.php │ │ ├── MsDocTest.php │ │ ├── ODText/ │ │ │ └── ODTextSectionTest.php │ │ ├── ODTextTest.php │ │ ├── RTFTest.php │ │ ├── Word2007/ │ │ │ ├── ElementTest.php │ │ │ ├── PartTest.php │ │ │ └── StyleTest.php │ │ └── Word2007Test.php │ ├── SettingsTest.php │ ├── Shared/ │ │ ├── ConverterTest.php │ │ ├── CssTest.php │ │ ├── DrawingTest.php │ │ ├── HtmlTest.php │ │ ├── Microsoft/ │ │ │ └── PasswordEncoderTest.php │ │ ├── TextTest.php │ │ ├── ValidateTest.php │ │ ├── XMLReaderTest.php │ │ ├── XMLWriterTest.php │ │ └── ZipArchiveTest.php │ ├── Style/ │ │ ├── AbstractStyleTest.php │ │ ├── CellTest.php │ │ ├── ChartTest.php │ │ ├── FontTest.php │ │ ├── ImageTest.php │ │ ├── IndentationTest.php │ │ ├── LanguageTest.php │ │ ├── LineNumberingTest.php │ │ ├── LineTest.php │ │ ├── ListItemTest.php │ │ ├── NumberingLevelTest.php │ │ ├── NumberingTest.php │ │ ├── PaperTest.php │ │ ├── ParagraphTest.php │ │ ├── RowTest.php │ │ ├── SectionTest.php │ │ ├── ShadingTest.php │ │ ├── SpacingTest.php │ │ ├── TOCTest.php │ │ ├── TabTest.php │ │ ├── TablePositionTest.php │ │ ├── TableTest.php │ │ └── TextBoxTest.php │ ├── StyleTest.php │ ├── TemplateProcessorTest.php │ ├── TestHelperDOCX.php │ ├── TestableTemplateProcesor.php │ ├── WriteReadback/ │ │ ├── ODTextTest.php │ │ └── Word2007Test.php │ ├── Writer/ │ │ ├── EPub3/ │ │ │ ├── Element/ │ │ │ │ ├── ImageTest.php │ │ │ │ └── TextTest.php │ │ │ ├── ElementTest.php │ │ │ ├── Part/ │ │ │ │ ├── AbstractPartTest.php │ │ │ │ ├── ContentTest.php │ │ │ │ ├── ManifestTest.php │ │ │ │ ├── MetaTest.php │ │ │ │ ├── MimetypeTest.php │ │ │ │ └── NavTest.php │ │ │ ├── PartTest.php │ │ │ ├── Style/ │ │ │ │ ├── AbstractStyleTest.php │ │ │ │ ├── FontTest.php │ │ │ │ ├── ParagraphTest.php │ │ │ │ └── TableTest.php │ │ │ └── StyleTest.php │ │ ├── EPub3Test.php │ │ ├── HTML/ │ │ │ ├── DirectionTest.php │ │ │ ├── Element/ │ │ │ │ ├── PageBreakTest.php │ │ │ │ ├── RubyTest.php │ │ │ │ ├── TableTest.php │ │ │ │ └── TextTest.php │ │ │ ├── ElementTest.php │ │ │ ├── FontTest.php │ │ │ ├── Helper.php │ │ │ ├── ParagraphTest.php │ │ │ ├── PartTest.php │ │ │ └── StyleTest.php │ │ ├── HTMLTest.php │ │ ├── ODText/ │ │ │ ├── Element/ │ │ │ │ ├── FieldTest.php │ │ │ │ ├── FormulaTest.php │ │ │ │ ├── ImageTest.php │ │ │ │ └── ListItemRunTest.php │ │ │ ├── ElementTest.php │ │ │ ├── Part/ │ │ │ │ ├── AbstractPartTest.php │ │ │ │ ├── ContentTest.php │ │ │ │ └── ManifestTest.php │ │ │ ├── Style/ │ │ │ │ ├── FontTest.php │ │ │ │ ├── NumberingTest.php │ │ │ │ ├── Paragraph2Test.php │ │ │ │ ├── ParagraphTest.php │ │ │ │ └── SectionTest.php │ │ │ └── StyleTest.php │ │ ├── ODTextTest.php │ │ ├── PDF/ │ │ │ ├── DomPDFTest.php │ │ │ ├── MPDFTest.php │ │ │ └── TCPDFTest.php │ │ ├── PDFTest.php │ │ ├── RTF/ │ │ │ ├── Element/ │ │ │ │ └── TableTest.php │ │ │ ├── Element2Test.php │ │ │ ├── ElementTest.php │ │ │ ├── HeaderFooterTest.php │ │ │ └── StyleTest.php │ │ ├── RTFTest.php │ │ ├── Word2007/ │ │ │ ├── Element/ │ │ │ │ ├── ChartTest.php │ │ │ │ ├── FieldTest.php │ │ │ │ ├── FormFieldTest.php │ │ │ │ ├── FormulaTest.php │ │ │ │ ├── TOCTest.php │ │ │ │ ├── TableTest.php │ │ │ │ ├── TextBoxTest.php │ │ │ │ └── TitleTest.php │ │ │ ├── ElementTest.php │ │ │ ├── Part/ │ │ │ │ ├── AbstractPartTest.php │ │ │ │ ├── CommentsTest.php │ │ │ │ ├── DocumentTest.php │ │ │ │ ├── FooterTest.php │ │ │ │ ├── FootnotesTest.php │ │ │ │ ├── HeaderTest.php │ │ │ │ ├── NumberingTest.php │ │ │ │ ├── SettingsTest.php │ │ │ │ └── StylesTest.php │ │ │ ├── PartTest.php │ │ │ ├── Style/ │ │ │ │ ├── DirectionTest.php │ │ │ │ ├── FontTest.php │ │ │ │ ├── ImageTest.php │ │ │ │ ├── IndentationTest.php │ │ │ │ ├── ParagraphTest.php │ │ │ │ ├── SectionTest.php │ │ │ │ ├── TableCellTest.php │ │ │ │ └── TableTest.php │ │ │ └── StyleTest.php │ │ └── Word2007Test.php │ ├── XmlDocument.php │ └── _files/ │ ├── documents/ │ │ ├── docChinese.doc │ │ ├── docCzech.doc │ │ ├── docSlovak.doc │ │ ├── reader-2011.docx │ │ ├── reader-comments.docx │ │ ├── reader-formula.docx │ │ ├── reader-formula.odt │ │ ├── reader-styles.docx │ │ ├── reader.doc │ │ ├── reader.docx │ │ ├── reader.font-halfpoint.doc │ │ ├── reader.html │ │ ├── reader.odt │ │ ├── reader.rtf │ │ ├── sheet.xls │ │ ├── without_table_macros.docx │ │ └── word.2493.nosection.odt │ ├── images/ │ │ ├── alexz-johnson.pcx │ │ ├── angela_merkel.tif │ │ ├── mars_noext_jpg │ │ └── new-php-logo │ ├── templates/ │ │ ├── blank.docx │ │ ├── clone-delete-block.docx │ │ ├── clone-merge-with-custom-macro.docx │ │ ├── clone-merge.docx │ │ ├── corrupted_main_document_part.docx │ │ ├── delete-row.docx │ │ ├── document22-with-custom-macro-xml.docx │ │ ├── document22-xml.docx │ │ ├── extract-variable.docx │ │ ├── header-footer-with-custom-macro.docx │ │ ├── header-footer.docx │ │ └── with_table_macros.docx │ └── xsl/ │ ├── passthrough.xsl │ └── remove_tables_by_needle.xsl └── bootstrap.php ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitattributes ================================================ # build config /.scrutinizer.yml export-ignore /.github export-ignore /php_cs.dist export-ignore /phpmd.xml.dist export-ignore /phpstan.neon export-ignore /composer.lock export-ignore # git files /.gitignore export-ignore /.gitattributes export-ignore # project directories /build export-ignore /docs export-ignore /samples export-ignore # tests /phpunit.xml.dist export-ignore /tests export-ignore ================================================ FILE: .github/ISSUE_TEMPLATE/1_bug_report.yml ================================================ name: 🐛 Bug Report description: Create a report to help improve PHPWord labels: [ "Bug Report" ] body: - type: markdown attributes: value: | ### ❗️ Read this before submitting your bug report: - **Write in English/French.** Reports in all other languages will be closed. - **Provide as much detail as possible** - Attachments : Error logs, Screenshots, Document files (generated and expected). - If the issue cannot be reproduced, it cannot be fixed. - type: textarea id: what-happened attributes: label: Describe the bug and add attachments description: What went wrong? If possible, add screenshots, error logs, document files (generated and expected) or screen recordings to help explain your problem. validations: required: true - type: textarea id: expected-behavior attributes: label: Expected behavior description: A clear and concise description of what you expected to happen. validations: required: true - type: textarea id: steps-reproduce attributes: label: Steps to reproduce description: Please provide a code sample that reproduces the issue. placeholder: | ```php addSection(); $section->... ``` validations: required: true - type: input id: phpword-version attributes: label: PHPWord version(s) where the bug happened placeholder: "e.g., 1.2.0 or master" validations: required: true - type: input id: php-version attributes: label: PHP version(s) where the bug happened placeholder: "e.g., 7.1 or 8.2" validations: required: true - type: checkboxes attributes: label: Priority description: Funded tickets have a higher priority. options: - label: I want to crowdfund the bug fix (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer. required: false - label: I want to pay the bug fix and fund a maintainer for that. (Contact @Progi1984) required: false ================================================ FILE: .github/ISSUE_TEMPLATE/2_feature_request.yml ================================================ name: 💡 Feature request description: Suggest an idea for this project labels: [ "Change Request" ] body: - type: markdown attributes: value: | ### ❗️ Read this before submitting your bug report: - **Write in English/French.** Reports in all other languages will be closed. - **Provide as much detail as possible** - Attachments : Error logs, Screenshots, Document files (generated and expected). - If the issue cannot be reproduced, it cannot be fixed. - type: textarea id: problem attributes: label: Describe the problem description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] validations: required: true - type: textarea id: expected-behavior attributes: label: Describe the expected behavior description: A clear and concise description of what you expected to happen. If possible, add screenshots, document files (expected). validations: required: true - type: checkboxes attributes: label: Priority description: Funded tickets have a higher priority. options: - label: I want to crowdfund the feature (with [@algora-io](https://docs.algora.io/bounties/overview)) and fund a community developer. required: false - label: I want to pay the feature and fund a maintainer for that. (Contact @Progi1984) required: false ================================================ FILE: .github/PULL_REQUEST_TEMPLATE.md ================================================ ### Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. Fixes # (issue) ### Checklist: - [ ] My CI is :green_circle: - [ ] I have covered by unit tests my new code (check build/coverage for coverage report) - [ ] I have updated the [documentation](https://github.com/PHPOffice/PHPWord/tree/master/docs) to describe the changes - [ ] I have updated the [changelog](https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.5.0.md) ================================================ FILE: .github/dependabot.yml ================================================ version: 2 updates: - package-ecosystem: composer directory: "/" schedule: interval: monthly time: "11:00" open-pull-requests-limit: 10 ================================================ FILE: .github/support.yml ================================================ # Label used to mark issues as support requests supportLabel: Question # Comment to post on issues marked as support requests. Add a link # to a support page, or set to `false` to disable supportComment: > This looks like a support question. Please ask your support questions on [StackOverflow](http://stackoverflow.com/questions/tagged/phpword), or [Gitter](https://gitter.im/PHPOffice/PHPWord). Thank you for your contributions. # Whether to close issues marked as support requests close: true # Whether to lock issues marked as support requests lock: false ================================================ FILE: .github/workflows/deploy.yml ================================================ name: Deploy on: push: branches: - master pull_request: jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 ### MkDocs - name: Setup Python uses: actions/setup-python@v2 with: python-version: 3.x - name: Install Python Dependencies run: pip install mkdocs-material autolink-references-mkdocs-plugin - name: Build documentation run: mkdocs build --site-dir public ### PHPUnit - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: 8.1 extensions: ctype, dom, gd, iconv, fileinfo, libxml, mbstring, simplexml, xml, xmlreader, xmlwriter, zip, zlib coverage: xdebug - name: Create directory public/coverage run: mkdir ./public/coverage - name: Install PHP Dependencies run: composer install --ansi --prefer-dist --no-interaction --no-progress - name: Build Coverage Report run: XDEBUG_MODE=coverage ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./public/coverage ### PHPDoc - name: Create directory public/docs run: mkdir ./public/docs - name: Install PhpDocumentor run: wget https://phpdoc.org/phpDocumentor.phar && chmod +x phpDocumentor.phar - name: Build Documentation run: ./phpDocumentor.phar run -d ./src -t ./public/docs ### Deploy - name: Deploy uses: peaceiris/actions-gh-pages@v3 if: github.ref == 'refs/heads/master' with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public ================================================ FILE: .github/workflows/php.yml ================================================ name: PHPWord on: [push, pull_request] jobs: php-cs-fixer: name: PHP CS Fixer runs-on: ubuntu-latest steps: - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.3' extensions: mbstring, intl, gd, xml, dom, json, fileinfo, curl, zip, iconv - uses: actions/checkout@v2 - name: Validate composer config run: composer validate --strict - name: Composer Install run: composer global require friendsofphp/php-cs-fixer - name: Add environment path run: export PATH="$PATH:$HOME/.composer/vendor/bin" - name: Run PHPCSFixer run: php-cs-fixer fix --dry-run --diff phpmd: name: PHP Mess Detector runs-on: ubuntu-latest steps: - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.4' extensions: gd, xml, zip - uses: actions/checkout@v2 - name: Composer Install run: composer install --ansi --prefer-dist --no-interaction --no-progress - name: Run phpmd run: ./vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude "src/PhpWord/Shared/PCLZip/*" phpstan: name: PHP Static Analysis runs-on: ubuntu-latest strategy: fail-fast: false matrix: # Disabled PHPStan in '7.1' php: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] steps: - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} extensions: gd, xml, zip - uses: actions/checkout@v2 - name: Composer Install run: composer install --ansi --prefer-dist --no-interaction --no-progress - name: Run phpstan run: ./vendor/bin/phpstan analyse -c phpstan.neon.dist phpunit: name: PHPUnit ${{ matrix.php }} runs-on: ubuntu-latest strategy: fail-fast: false matrix: php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] steps: - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} extensions: gd, xml, zip coverage: ${{ (matrix.php == '7.3') && 'xdebug' || 'none' }} - uses: actions/checkout@v2 - name: Composer Install run: composer install --ansi --prefer-dist --no-interaction --no-progress - name: Run phpunit if: matrix.php != '7.3' run: ./vendor/bin/phpunit -c phpunit.xml.dist --no-coverage - name: Run phpunit if: matrix.php == '7.3' run: ./vendor/bin/phpunit -c phpunit.xml.dist --coverage-clover build/clover.xml - name: Upload coverage results to Coveralls if: matrix.php == '7.3' env: COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.3/php-coveralls.phar chmod +x php-coveralls.phar php php-coveralls.phar --coverage_clover=build/clover.xml --json_path=build/coveralls-upload.json -vvv samples: name: Check samples runs-on: ubuntu-latest strategy: fail-fast: false matrix: php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] steps: - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} extensions: gd, xml, zip coverage: xdebug - uses: actions/checkout@v2 - name: Composer Install run: composer install --ansi --prefer-dist --no-interaction --no-progress - name: Generate samples files run: composer run samples ================================================ FILE: .github_changelog_generator ================================================ user=PHPOffice project=PHPWord since-tag=0.18.1 future-release=0.18.2 issues=false pulls=true ================================================ FILE: .gitignore ================================================ /composer.lock .DS_Store ._* .Spotlight-V100 .Trashes Thumbs.db Desktop.ini .idea _build /build phpunit.xml composer.phar composer.lock vendor /report /build /samples/results /.settings phpword.ini /.buildpath /.scannerwork /.project /nbproject /.php_cs.cache /.phpunit.result.cache /public ================================================ FILE: .php-cs-fixer.dist.php ================================================ notName('pclzip.lib.php') ->notName('OLERead.php') ->in('samples') ->in('src') ->in('tests'); $config = new PhpCsFixer\Config(); $config ->setRiskyAllowed(true) ->setFinder($finder) ->setCacheFile(sys_get_temp_dir() . '/php-cs-fixer' . preg_replace('~\W~', '-', __DIR__)) ->setRules([ 'align_multiline_comment' => true, 'array_indentation' => true, 'array_syntax' => ['syntax' => 'short'], 'backtick_to_shell_exec' => true, 'binary_operator_spaces' => true, 'blank_line_after_namespace' => true, 'blank_line_after_opening_tag' => true, 'blank_line_before_statement' => true, 'braces' => true, 'cast_spaces' => true, 'class_attributes_separation' => ['elements' => ['method' => 'one', 'property' => 'one']], // const are often grouped with other related const 'class_definition' => false, 'class_keyword_remove' => false, // ::class keyword gives us better support in IDE 'combine_consecutive_issets' => true, 'combine_consecutive_unsets' => true, 'combine_nested_dirname' => true, 'comment_to_phpdoc' => false, // interferes with annotations 'compact_nullable_typehint' => true, 'concat_space' => ['spacing' => 'one'], 'constant_case' => true, 'date_time_immutable' => false, // Break our unit tests 'declare_equal_normalize' => true, 'declare_strict_types' => false, // Too early to adopt strict types 'dir_constant' => true, 'doctrine_annotation_array_assignment' => true, 'doctrine_annotation_braces' => true, 'doctrine_annotation_indentation' => true, 'doctrine_annotation_spaces' => true, 'elseif' => true, 'encoding' => true, 'ereg_to_preg' => true, 'escape_implicit_backslashes' => true, 'explicit_indirect_variable' => false, // I feel it makes the code actually harder to read 'explicit_string_variable' => false, // I feel it makes the code actually harder to read 'final_class' => false, // We need non-final classes 'final_internal_class' => true, 'final_public_method_for_abstract_class' => false, // We need non-final methods 'fopen_flag_order' => true, 'fopen_flags' => true, 'full_opening_tag' => true, 'fully_qualified_strict_types' => true, 'function_declaration' => true, 'function_to_constant' => true, 'function_typehint_space' => true, 'general_phpdoc_annotation_remove' => ['annotations' => ['access', 'category', 'copyright', 'throws']], 'global_namespace_import' => true, 'header_comment' => false, // We don't use common header in all our files 'heredoc_indentation' => false, // Requires PHP >= 7.3 'heredoc_to_nowdoc' => false, // Not sure about this one 'implode_call' => true, 'include' => true, 'increment_style' => true, 'indentation_type' => true, 'is_null' => true, 'line_ending' => true, 'linebreak_after_opening_tag' => true, 'list_syntax' => ['syntax' => 'short'], 'logical_operators' => true, 'lowercase_cast' => true, 'lowercase_keywords' => true, 'lowercase_static_reference' => true, 'magic_constant_casing' => true, 'magic_method_casing' => true, 'mb_str_functions' => false, // No, too dangerous to change that 'method_argument_space' => true, 'method_chaining_indentation' => true, 'modernize_types_casting' => true, 'multiline_comment_opening_closing' => true, 'multiline_whitespace_before_semicolons' => true, 'native_constant_invocation' => false, // Micro optimization that look messy 'native_function_casing' => true, 'native_function_invocation' => false, // I suppose this would be best, but I am still unconvinced about the visual aspect of it 'native_function_type_declaration_casing' => true, 'new_with_braces' => true, 'no_alias_functions' => true, 'no_alternative_syntax' => true, 'no_binary_string' => true, 'no_blank_lines_after_class_opening' => true, 'no_blank_lines_after_phpdoc' => true, 'no_blank_lines_before_namespace' => false, // we want 1 blank line before namespace 'no_break_comment' => true, 'no_closing_tag' => true, 'no_empty_comment' => true, 'no_empty_phpdoc' => true, 'no_empty_statement' => true, 'no_extra_blank_lines' => true, 'no_homoglyph_names' => true, 'no_leading_import_slash' => true, 'no_leading_namespace_whitespace' => true, 'no_mixed_echo_print' => true, 'no_multiline_whitespace_around_double_arrow' => true, 'no_null_property_initialization' => true, 'no_php4_constructor' => true, 'no_short_bool_cast' => true, 'echo_tag_syntax' => ['format' => 'long'], 'no_singleline_whitespace_before_semicolons' => true, 'no_spaces_after_function_name' => true, 'no_spaces_around_offset' => true, 'no_spaces_inside_parenthesis' => true, 'no_superfluous_elseif' => false, // Might be risky on a huge code base 'no_superfluous_phpdoc_tags' => ['allow_mixed' => true], 'no_trailing_comma_in_list_call' => true, 'no_trailing_comma_in_singleline_array' => true, 'no_trailing_whitespace' => true, 'no_trailing_whitespace_in_comment' => true, 'no_unneeded_control_parentheses' => true, 'no_unneeded_curly_braces' => true, 'no_unneeded_final_method' => true, 'no_unreachable_default_argument_value' => true, 'no_unset_cast' => true, 'no_unset_on_property' => true, 'no_unused_imports' => true, 'no_useless_else' => true, 'no_useless_return' => true, 'no_whitespace_before_comma_in_array' => true, 'no_whitespace_in_blank_line' => true, 'non_printable_character' => true, 'normalize_index_brace' => true, 'not_operator_with_space' => false, // No we prefer to keep '!' without spaces 'not_operator_with_successor_space' => false, // idem 'nullable_type_declaration_for_default_null_value' => true, 'object_operator_without_whitespace' => true, 'ordered_class_elements' => false, // We prefer to keep some freedom 'ordered_imports' => true, 'ordered_interfaces' => true, 'php_unit_construct' => true, 'php_unit_dedicate_assert' => true, 'php_unit_dedicate_assert_internal_type' => true, 'php_unit_expectation' => true, 'php_unit_fqcn_annotation' => true, 'php_unit_internal_class' => false, // Because tests are excluded from package 'php_unit_method_casing' => true, 'php_unit_mock' => true, 'php_unit_mock_short_will_return' => true, 'php_unit_namespaced' => true, 'php_unit_no_expectation_annotation' => true, 'phpdoc_order_by_value' => ['annotations' => ['covers']], 'php_unit_set_up_tear_down_visibility' => true, 'php_unit_size_class' => false, // That seems extra work to maintain for little benefits 'php_unit_strict' => false, // We sometime actually need assertEquals 'php_unit_test_annotation' => true, 'php_unit_test_case_static_method_calls' => ['call_type' => 'self'], 'php_unit_test_class_requires_covers' => false, // We don't care as much as we should about coverage 'phpdoc_add_missing_param_annotation' => false, // Don't add things that bring no value 'phpdoc_align' => false, // Waste of time 'phpdoc_annotation_without_dot' => true, 'phpdoc_indent' => true, //'phpdoc_inline_tag' => true, 'phpdoc_line_span' => false, // Unfortunately our old comments turn even uglier with this 'phpdoc_no_access' => true, 'phpdoc_no_alias_tag' => true, 'phpdoc_no_empty_return' => true, 'phpdoc_no_package' => true, 'phpdoc_no_useless_inheritdoc' => true, 'phpdoc_order' => true, 'phpdoc_return_self_reference' => true, 'phpdoc_scalar' => true, 'phpdoc_separation' => true, 'phpdoc_single_line_var_spacing' => true, 'phpdoc_summary' => true, 'phpdoc_to_comment' => false, // interferes with annotations 'phpdoc_to_param_type' => false, // Because experimental, but interesting for one shot use 'phpdoc_to_return_type' => false, // idem 'phpdoc_trim' => true, 'phpdoc_trim_consecutive_blank_line_separation' => true, 'phpdoc_types' => true, 'phpdoc_types_order' => true, 'phpdoc_var_annotation_correct_order' => true, 'phpdoc_var_without_name' => true, 'pow_to_exponentiation' => true, 'protected_to_private' => true, 'psr_autoloading' => true, 'random_api_migration' => true, 'return_assignment' => false, // Sometimes useful for clarity or debug 'return_type_declaration' => true, 'self_accessor' => true, 'self_static_accessor' => true, 'semicolon_after_instruction' => false, // Buggy in `samples/index.php` 'set_type_to_cast' => true, 'short_scalar_cast' => true, 'simple_to_complex_string_variable' => false, // Would differ from TypeScript without obvious advantages 'simplified_null_return' => false, // Even if technically correct we prefer to be explicit 'single_blank_line_at_eof' => true, 'single_blank_line_before_namespace' => true, 'single_class_element_per_statement' => true, 'single_import_per_statement' => true, 'single_line_after_imports' => true, 'single_line_comment_style' => true, 'single_line_throw' => false, // I don't see any reason for having a special case for Exception 'single_quote' => true, 'single_trait_insert_per_statement' => true, 'space_after_semicolon' => true, 'standardize_increment' => true, 'standardize_not_equals' => true, 'static_lambda' => false, // Risky if we can't guarantee nobody use `bindTo()` 'strict_comparison' => false, // No, too dangerous to change that 'strict_param' => false, // No, too dangerous to change that 'string_line_ending' => true, 'switch_case_semicolon_to_colon' => true, 'switch_case_space' => true, 'ternary_operator_spaces' => true, 'ternary_to_null_coalescing' => true, 'trailing_comma_in_multiline' => true, 'trim_array_spaces' => true, 'unary_operator_spaces' => true, 'visibility_required' => ['elements' => ['property', 'method']], // not const 'void_return' => true, 'whitespace_after_comma_in_array' => true, 'yoda_style' => false, ]); return $config; ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing to PHPWord PHPWord is built by the crowd and for the crowd. Every contribution is welcome; either by [reporting a bug](https://github.com/PHPOffice/PHPWord/issues/new?labels=Bug+Report&template=bug_report.md) or [suggesting improvements](https://github.com/PHPOffice/PHPWord/issues/new?labels=Change+Request&template=feature_request.md), or in a more active form like [requesting a pull](https://github.com/PHPOffice/PHPWord/pulls). We want to create a high quality document writer and reader library that people can use with more confidence and fewer bugs. We want to collaborate happily, code joyfully, and live merrily. Thus, below are some guidelines that we expect to be followed by each contributor: - **Be brief, but be bold**. State your issues briefly. But speak out your ideas loudly, even if you can't or don't know how to implement them right away. The world will be better with limitless innovations. - **Follow PHP-FIG standards**. We follow PHP Standards Recommendations (PSRs) by [PHP Framework Interoperability Group](http://www.php-fig.org/). If you're not familiar with these standards, [familiarize yourself now](https://github.com/php-fig/fig-standards). Also, please run `composer fix` to automatically fix your code to match these recommendations. - **Test your code**. No one knows your code better than you, so we depend on you to test the changes you make before pull request submission. We use [PHPUnit](https://phpunit.de/) for our testing purposes and request that you use this tool too. Tests can be ran with `composer test`. [Documentation for writing tests with PHPUnit is available on Read the Docs.](https://phpunit.readthedocs.io) - **Use best practices when submitting pull requests**. Create a separate branch named specifically for the issue that you are addressing. Read the [GitHub manual](https://help.github.com/articles/about-pull-requests) to learn more about pull requests and GitHub. If you are new to GitHub, read [this short manual](https://help.github.com/articles/fork-a-repo) to get yourself familiar with forks and how git works in general. [This video](http://www.youtube.com/watch?v=-zvHQXnBO6c) explains how to synchronize your fork on GitHub with the upstream branch from PHPWord. ## Getting Started 1. [Clone](https://help.github.com/en/articles/cloning-a-repository) [PHPWord](https://github.com/PHPOffice/PHPWord/) 2. [Install Composer](https://getcomposer.org/download/) if you don't already have it 3. Open your terminal and: 1. Switch to the directory PHPWord was cloned to (e.g., `cd ~/Projects/PHPWord/`) 2. Run `composer install` to install the dependencies You're ready to start working on PHPWord! Tests belong in the `/tests/PhpWord/` directory, the source code is in `/src/PhpWord/`, and any documentation should go in `/docs/`. Familiarize yourself with the codebase and try your hand at fixing [one of our outstanding issues](https://github.com/PHPOffice/PHPWord/issues). Before you get started, check the [existing pull requests](https://github.com/PHPOffice/PHPWord/pulls) to make sure no one else is already working on it. Once you have an issue you want to start working on, you'll need to write tests for it, and then you can start implementing the changes necessary to pass the new tests. To run the tests, you can run one of the following commands in your terminal: - `composer test-no-coverage` to run all of the tests - `composer test` to run all of the tests and generate test coverage reports When you're ready to submit your new (and fully tested) feature, ensure `composer check` passes and [submit a pull request to PHPWord](https://github.com/PHPOffice/PHPWord/issues/new). That's it. Thank you for your interest in PHPWord, and welcome! May the Force be with you. ================================================ FILE: COPYING ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: COPYING.LESSER ================================================ GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ================================================ FILE: LICENSE ================================================ PHPWord, a pure PHP library for reading and writing word processing documents. Copyright (c) 2010-2025 PHPWord. PHPWord is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation. PHPWord is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License version 3 for more details. You should have received a copy of the GNU Lesser General Public License version 3 along with PHPWord. If not, see . ================================================ FILE: README.md ================================================ # ![PHPWord](https://rawgit.com/PHPOffice/PHPWord/develop/docs/images/phpword.svg "PHPWord") [![Latest Stable Version](https://poser.pugx.org/phpoffice/phpword/v)](https://packagist.org/packages/phpoffice/phpword) [![Coverage Status](https://coveralls.io/repos/github/PHPOffice/PHPWord/badge.svg?branch=master)](https://coveralls.io/github/PHPOffice/PHPWord?branch=master) [![Total Downloads](https://poser.pugx.org/phpoffice/phpword/downloads)](https://packagist.org/packages/phpoffice/phpword) [![License](https://poser.pugx.org/phpoffice/phpword/license)](https://packagist.org/packages/phpoffice/phpword) Branch Master : [![PHPWord](https://github.com/PHPOffice/PHPWord/actions/workflows/php.yml/badge.svg?branch=master)](https://github.com/PHPOffice/PHPWord/actions/workflows/php.yml) PHPWord is a library written in pure PHP that provides a set of classes to write to and read from different document file formats. The current version of PHPWord supports Microsoft [Office Open XML](http://en.wikipedia.org/wiki/Office_Open_XML) (OOXML or OpenXML), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (OpenDocument or ODF), [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (RTF), HTML, and PDF. PHPWord is an open source project licensed under the terms of [LGPL version 3](COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://github.com/PHPOffice/PHPWord/actions) and unit testing. You can learn more about PHPWord by reading the [Developers' Documentation](https://phpoffice.github.io/PHPWord/). If you have any questions, please ask on [StackOverFlow](https://stackoverflow.com/questions/tagged/phpword) Read more about PHPWord: - [Features](#features) - [Requirements](#requirements) - [Installation](#installation) - [Getting started](#getting-started) - [Contributing](#contributing) - [Developers' Documentation](https://phpoffice.github.io/PHPWord/) ## Features With PHPWord, you can create OOXML, ODF, or RTF documents dynamically using your PHP scripts. Below are some of the things that you can do with PHPWord library: - 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 ## Requirements PHPWord requires the following: - PHP 7.1+ - [XML Parser extension](http://www.php.net/manual/en/xml.installation.php) - [Laminas Escaper component](https://docs.laminas.dev/laminas-escaper/intro/) - [Zip extension](http://php.net/manual/en/book.zip.php) (optional, used to write OOXML and ODF) - [GD extension](http://php.net/manual/en/book.image.php) (optional, used to add images) - [XMLWriter extension](http://php.net/manual/en/book.xmlwriter.php) (optional, used to write OOXML and ODF) - [XSL extension](http://php.net/manual/en/book.xsl.php) (optional, used to apply XSL style sheet to template ) - [dompdf library](https://github.com/dompdf/dompdf) (optional, used to write PDF) ## Installation PHPWord is installed via [Composer](https://getcomposer.org/). To [add a dependency](https://getcomposer.org/doc/04-schema.md#package-links) to PHPWord in your project, either Run the following to use the latest stable version ```sh composer require phpoffice/phpword ``` or if you want the latest unreleased version ```sh composer require phpoffice/phpword:dev-master ``` ## Getting started The following is a basic usage example of the PHPWord library. ```php addSection(); // Adding Text element to the Section having font styled by default... $section->addText( '"Learn from yesterday, live for today, hope for tomorrow. ' . 'The important thing is not to stop questioning." ' . '(Albert Einstein)' ); /* * Note: it's possible to customize font style of the Text element you add in three ways: * - inline; * - using named font style (new font style object will be implicitly created); * - using explicitly created font style object. */ // Adding Text element with font customized inline... $section->addText( '"Great achievement is usually born of great sacrifice, ' . 'and is never the result of selfishness." ' . '(Napoleon Hill)', array('name' => 'Tahoma', 'size' => 10) ); // Adding Text element with font customized using named font style... $fontStyleName = 'oneUserDefinedStyle'; $phpWord->addFontStyle( $fontStyleName, array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true) ); $section->addText( '"The greatest accomplishment is not in never falling, ' . 'but in rising again after you fall." ' . '(Vince Lombardi)', $fontStyleName ); // Adding Text element with font customized using explicitly created font style object... $fontStyle = new \PhpOffice\PhpWord\Style\Font(); $fontStyle->setBold(true); $fontStyle->setName('Tahoma'); $fontStyle->setSize(13); $myTextElement = $section->addText('"Believe you can and you\'re halfway there." (Theodor Roosevelt)'); $myTextElement->setFontStyle($fontStyle); // Saving the document as OOXML file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007'); $objWriter->save('helloWorld.docx'); // Saving the document as ODF file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'ODText'); $objWriter->save('helloWorld.odt'); // Saving the document as HTML file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'HTML'); $objWriter->save('helloWorld.html'); /* Note: we skip RTF, because it's not XML-based and requires a different example. */ /* Note: we skip PDF, because "HTML-to-PDF" approach is used to create PDF documents. */ ``` More examples are provided in the [samples folder](samples/). For an easy access to those samples launch `php -S localhost:8000` in the samples directory then browse to [http://localhost:8000](http://localhost:8000) to view the samples. You can also read the [Developers' Documentation](https://phpoffice.github.io/PHPWord/) for more detail. ## Contributing We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute. - Read [our contributing guide](CONTRIBUTING.md). - [Fork us](https://github.com/PHPOffice/PHPWord/fork) and [request a pull](https://github.com/PHPOffice/PHPWord/pulls) to the [master](https://github.com/PHPOffice/PHPWord/tree/master) branch. - Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub. - Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter. ================================================ FILE: composer.json ================================================ { "name": "phpoffice/phpword", "description": "PHPWord - A pure PHP library for reading and writing word processing documents (OOXML, ODF, RTF, HTML, PDF)", "keywords": [ "PHP", "PHPOffice", "office", "PHPWord", "word", "template", "template processor", "reader", "writer", "docx", "OOXML", "OpenXML", "Office Open XML", "ISO IEC 29500", "WordprocessingML", "RTF", "Rich Text Format", "doc", "odt", "ODF", "OpenDocument", "PDF", "HTML" ], "homepage": "https://phpoffice.github.io/PHPWord/", "type": "library", "license": "LGPL-3.0-only", "authors": [ { "name": "Mark Baker" }, { "name": "Gabriel Bull", "email": "me@gabrielbull.com", "homepage": "http://gabrielbull.com/" }, { "name": "Franck Lefevre", "homepage": "https://rootslabs.net/blog/" }, { "name": "Ivan Lanin", "homepage": "http://ivan.lanin.org" }, { "name": "Roman Syroeshko", "homepage": "http://ru.linkedin.com/pub/roman-syroeshko/34/a53/994/" }, { "name": "Antoine de Troostembergh" } ], "scripts": { "test": [ "@php vendor/bin/phpunit --color=always" ], "test-no-coverage": [ "@php vendor/bin/phpunit --color=always --no-coverage" ], "check": [ "@php vendor/bin/php-cs-fixer fix --ansi --dry-run --diff", "@php vendor/bin/phpmd src/,tests/ text ./phpmd.xml.dist --exclude pclzip.lib.php", "@test-no-coverage", "@php vendor/bin/phpstan analyse --ansi" ], "fix": [ "@php vendor/bin/php-cs-fixer fix --ansi" ], "samples": [ "php samples/Sample_01_SimpleText.php", "php samples/Sample_02_TabStops.php", "php samples/Sample_03_Sections.php", "php samples/Sample_04_Textrun.php", "php samples/Sample_05_Multicolumn.php", "php samples/Sample_06_Footnote.php", "php samples/Sample_07_TemplateCloneRow.php", "php samples/Sample_08_ParagraphPagination.php", "php samples/Sample_09_Tables.php", "php samples/Sample_10_EastAsianFontStyle.php", "php samples/Sample_11_ReadWord97.php", "php samples/Sample_11_ReadWord2007.php", "php samples/Sample_12_HeaderFooter.php", "php samples/Sample_13_Images.php", "php samples/Sample_14_ListItem.php", "php samples/Sample_15_Link.php", "php samples/Sample_16_Object.php", "php samples/Sample_17_TitleTOC.php", "php samples/Sample_18_Watermark.php", "php samples/Sample_19_TextBreak.php", "php samples/Sample_20_BGColor.php", "php samples/Sample_21_TableRowRules.php", "php samples/Sample_22_CheckBox.php", "php samples/Sample_23_TemplateBlock.php", "php samples/Sample_24_ReadODText.php", "php samples/Sample_25_TextBox.php", "php samples/Sample_26_Html.php", "php samples/Sample_27_Field.php", "php samples/Sample_28_ReadRTF.php", "php samples/Sample_29_Line.php", "php samples/Sample_30_ReadHTML.php", "php samples/Sample_31_Shape.php", "php samples/Sample_32_Chart.php", "php samples/Sample_33_FormField.php", "php samples/Sample_34_SDT.php", "php samples/Sample_35_InternalLink.php", "php samples/Sample_36_RTL.php", "php samples/Sample_37_Comments.php", "php samples/Sample_38_Protection.php", "php samples/Sample_39_TrackChanges.php", "php samples/Sample_40_TemplateSetComplexValue.php", "php samples/Sample_41_TemplateSetChart.php", "php samples/Sample_42_TemplateSetCheckbox.php", "php samples/Sample_43_RTLDefault.php", "php samples/Sample_44_ExtractVariablesFromReaderWord2007.php", "php samples/Sample_45_Autoloader.php" ] }, "scripts-descriptions": { "test": "Runs all unit tests", "test-no-coverage": "Runs all unit tests, without code coverage", "check": "Runs PHP CheckStyle and PHP Mess detector", "fix": "Fixes issues found by PHP-CS" }, "require": { "php": "^7.1|^8.0", "ext-dom": "*", "ext-gd": "*", "ext-zip": "*", "ext-json": "*", "ext-xml": "*", "phpoffice/math": "^0.3" }, "require-dev": { "ext-libxml": "*", "dompdf/dompdf": "^2.0 || ^3.0", "friendsofphp/php-cs-fixer": "^3.3", "mpdf/mpdf": "^7.0 || ^8.0", "phpmd/phpmd": "^2.13", "phpstan/phpstan": "^0.12.88 || ^1.0.0 || ^2.0.0", "phpstan/phpstan-phpunit": "^1.0 || ^2.0", "phpunit/phpunit": ">=7.0", "symfony/process": "^4.4 || ^5.0", "tecnickcom/tcpdf": "^6.5" }, "suggest": { "ext-xmlwriter": "Allows writing OOXML and ODF", "ext-xsl": "Allows applying XSL style sheet to headers, to main document part, and to footers of an OOXML template", "dompdf/dompdf": "Allows writing PDF" }, "autoload": { "psr-4": { "PhpOffice\\PhpWord\\": "src/PhpWord" } }, "autoload-dev": { "psr-4": { "PhpOffice\\PhpWordTests\\": "tests/PhpWordTests" } } } ================================================ FILE: docs/changes/0.x/0.10.0.md ================================================ # 0.10.0 (4 May 2014) 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. ### Features - Image: Get image dimensions without EXIF extension - @andrew-kzoo #184 - Table: Add `tblGrid` element 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 `FootnoteReference` style - @ivanlanin - Font: Add `bgColor` to font style to define background using HEX color - @jcarignan #168 - Table: Add `exactHeight` to row style to define whether row height should be exact or atLeast - @jcarignan #168 - Element: New `CheckBox` element 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 `cloneBlock` and `deleteBlock` - @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.xml` `Application` to `PHPWord` - @ivanlanin - DOCX Writer: Create `word/settings.xml` and `word/webSettings.xml` dynamically - @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 `bgColor` from `Font`, `Table`, and `Cell` and put it into the new `Shading` style - @ivanlanin - Style: New `Indentation` and `Spacing` style - @ivanlanin - Paragraph: Ability to define first line and right indentation - @ivanlanin ### Bugfixes - Footnote: Footnote content doesn't show footnote reference number - @ivanlanin #170 - Documentation: Error in a function - @theBeerNut #195 ### Deprecated - `createTextRun` replaced by `addTextRun` - `createFootnote` replaced by `addFootnote` - `createHeader` replaced by `addHeader` - `createFooter` replaced by `addFooter` - `createSection` replaced by `addSection` - `Element\Footnote::getReferenceId` replaced by `Element\AbstractElement::getRelationId` - `Element\Footnote::setReferenceId` replaced by `Element\AbstractElement::setRelationId` - `Footnote::addFootnoteLinkElement` replaced by `Media::addElement` - `Footnote::getFootnoteLinkElements` replaced by `Media::getElements` - All current methods on `Media` - `Element\Link::getLinkSrc` replaced by `Element\Link::getTarget` - `Element\Link::getLinkName` replaced by `Element\Link::getText` - `Style\Cell::getDefaultBorderColor` ### Miscellaneous - Documentation: Simplify page level docblock - @ivanlanin #179 - Writer: Refactor writer classes and create a new `Write\AbstractWriter` abstract class - @ivanlanin #160 - General: Refactor folders: `Element` and `Exception` - @ivanlanin #187 - General: Remove legacy `HashTable` and `Shared\ZipStreamWrapper` and all related properties/methods - @ivanlanin #187 - Element: New `AbstractElement` abstract 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 `Settings` to `Style\Section` - @ivanlanin #187 - General: Give `Abstract` prefix and `Interface` suffix for all abstract classes and interfaces as per [PHP-FIG recommendation](https://github.com/php-fig/fig-standards/blob/master/bylaws/002-psr-naming-conventions.md) - @ivanlanin #187 - Style: New `Style\AbstractStyle` abstract class - @ivanlanin #187 - Writer: New 'ODText\Base` class - @ivanlanin #187 - General: Rename `Footnote` to `Footnotes` to 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 `AbstractContainer` from `AbstractElement` - @ivanlanin - Refactor: Apply composite pattern for Word2007 reader - @ivanlanin ================================================ FILE: docs/changes/0.x/0.10.1.md ================================================ # 0.10.1 (21 May 2014) This is a bugfix release for `php-zip` requirement in Composer. - Change Composer requirements for php-zip from `require` to `suggest` - @bskrtich #246 ================================================ FILE: docs/changes/0.x/0.11.0.md ================================================ # 0.11.0 (1 June 2014) 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. ### Features - 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 `TextBox` element - @basjan @ivanlanin #228, #229, #231 - HTML: Ability to add elements to PHPWord object via html - @basjan #231 - Element: New `ListItemRun` element 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 `Field` element - @basjan #251 - RTF Reader: Basic RTF reader - @ivanlanin #72, #252 - Element: New `Line` element - @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 ### Bugfixes - 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: `marginLeft` and `marginTop` cannot accept float value - @ivanlanin #248 - Title: Orphan `w:fldChar` caused OpenOffice to crash when opening DOCX - @ivanlanin #236 ### Deprecated - Static classes `Footnotes`, `Endnotes`, and `TOC` - `Writer\Word2007\Part`: `Numbering::writeNumbering()`, `Settings::writeSettings()`, `WebSettings::writeWebSettings()`, `ContentTypes::writeContentTypes()`, `Styles::writeStyles()`, `Document::writeDocument()` all changed into `write()` - `Writer\Word2007\Part\DocProps`: Split into `Writer\Word2007\Part\DocPropsCore` and `Writer\Word2007\Part\DocPropsApp` - `Element\Title::getBookmarkId()` replaced by `Element\Title::getRelationId()` - `Writer\HTML::writeDocument`: Replaced by `Writer\HTML::getContent` ### Miscellaneous - License: Change the project license from LGPL 2.1 into LGPL 3.0 - #211 - Word2007 Writer: New `Style\Image` class - @ivanlanin - Refactor: Replace static classes `Footnotes`, `Endnotes`, and `TOC` with `Collections` - @ivanlanin #206 - QA: Reactivate `phpcpd` and `phpmd` on Travis - @ivanlanin - Refactor: PHPMD recommendation: Change all `get...` method that returns `boolean` into `is...` or `has...` - @ivanlanin - Docs: Create gh-pages branch for API documentation - @Progi1984 #154 - QA: Add `.scrutinizer.yml` and include `composer.lock` for 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 `samples` folder - @ivanlanin ================================================ FILE: docs/changes/0.x/0.11.1.md ================================================ # 0.11.1 (2 June 2014) This is an immediate bugfix release for HTML reader. - HTML Reader: `

` and header tags puts no output - @canyildiz @ivanlanin #257 ================================================ FILE: docs/changes/0.x/0.12.0.md ================================================ # 0.12.0 (3 January 2015) 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. ### Features - Element: Ability to add drawing shapes (arc, curve, line, polyline, rect, oval) using new `Shape` element - @ivanlanin #123 - Font: New `scale`, `spacing`, and `kerning` property 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 encapsulate `IOFactory` - @ivanlanin - General: New `Shared\Converter` static 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 ### Bugfixes - Fix rare PclZip/realpath/PHP version problem - @andrew-kzoo #261 - `addHTML` encoding 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` of container should be case insensitive, e.g. `addToc` should be accepted, not only `addTOC` - @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()` and `Element\Section::setPageSizeH()` were mentioned in the docs but not implemented. - Special Characters (ampersand) in Title break docx output - @RomanSyroeshko #401 - `` tag is closed with `` tag: - @franzholz #438 ### Deprecated - `Element\Link::getTarget()` replaced by `Element\Link::getSource()` - `Element\Section::getSettings()` and `Element\Section::setSettings()` replaced by `Element\Section::getStyle()` and `Element\Section::setStyle()` - `Shared\Drawing` and `Shared\Font` merged into `Shared\Converter` - `DocumentProperties` replaced by `Metadata\DocInfo` - `Template` replaced by `TemplateProcessor` - `PhpWord->loadTemplate($filename)` ### Miscellaneous - Docs: Add known issue on `README` about requirement for temporary folder to be writable and update `samples/index.php` for 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 `Template` into `TemplateProcessor` - @RomanSyroeshko #216 - Reverted #51. All text escaping must be performed out of the library - @RomanSyroeshko #51 v ================================================ FILE: docs/changes/0.x/0.12.1.md ================================================ # 0.12.1 (30 August 2015) Maintenance release. This release is focused primarily on `TemplateProcessor`. ### Changes - Changed visibility of all private properties and methods of `TemplateProcessor` to `protected`. - @RomanSyroeshko #498 - Improved performance of `TemplateProcessor::setValue()`. - @RomanSyroeshko @nicoSWD #513 ### Bugfixes - Fixed issue with "Access denied" message while opening `Sample_07_TemplateCloneRow.docx` and `Sample_23_TemplateBlock.docx` result files on Windows platform. - @RomanSyroeshko @AshSat #532 - Fixed `PreserveText` element alignment in footer (see `Sample_12_HeaderFooter.php`). - @RomanSyroeshko @SSchwaiger #495 ================================================ FILE: docs/changes/0.x/0.13.0.md ================================================ # 0.13.0 (31 July 2016) 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](https://getcomposer.org/) to install PHPWord. ### Added - Introduced the `\PhpOffice\PhpWord\SimpleType\Jc` simple type. - @RomanSyroeshko - Introduced the `\PhpOffice\PhpWord\SimpleType\JcTable` simple 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.ini` or `\PhpOffice\PhpWord\Settings`. - @RomanSyroeshko #483 - Supported processing of headers and footers in `TemplateProcessor::applyXslStyleSheet()`. - @RomanSyroeshko #335 ### Changed - Improved error message for the case when `autoload.php` is not found. - @RomanSyroeshko #371 - Renamed the `align` option of `NumberingLevel`, `Frame`, `Table`, and `Paragraph` styles into `alignment`. - @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 ### Deprecated - `getAlign` and `setAlign` methods of `NumberingLevel`, `Frame`, `Table`, and `Paragraph` styles. Use the correspondent `getAlignment` and `setAlignment` methods instead. - @RomanSyroeshko - `left`, `right`, and `justify` alignment options for paragraphs (now are mapped to `Jc::START`, `Jc::END`, and `Jc::BOTH`). - @RomanSyroeshko - `left`, `right`, and `justify` alignment options for tables (now are mapped to `Jc::START`, `Jc::END`, and `Jc::CENTER`). - @RomanSyroeshko - `TCPDF` due to its limited HTML support. Use `DomPDF` or `MPDF` writer instead. - @RomanSyroeshko #399 ### Removed - `\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](https://getcomposer.org/). We also removed `\PhpOffice\PhpWord\Autoloader`, because the latter change made it completely useless. Autoloaders provided by Composer are in use now (see `bootstrap.php`). - @RomanSyroeshko - `\PhpOffice\PhpWord\Shared\Drawing` replaced by `\PhpOffice\Common\Drawing`. - @Progi1984 #658 - `\PhpOffice\PhpWord\Shared\Font`. - @Progi1984 #658 - `\PhpOffice\PhpWord\Shared\String` replaced by `\PhpOffice\Common\Text`. - @Progi1984 @RomanSyroeshko #658 - `\PhpOffice\PhpWord\Shared\XMLReader` replaced by `\PhpOffice\Common\XMLReader`. - @Progi1984 #658 - `\PhpOffice\PhpWord\Shared\XMLWriter` replaced by `\PhpOffice\Common\XMLWriter`. - @Progi1984 @RomanSyroeshko #658 - `AbstractContainer::addMemoryImage()`. Use `AbstractContainer::addImage()` instead. ### Fixed - `Undefined property` error 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 of `TemplateProcessor::fixBrokenMacros()`. - @RomanSyroeshko @d-damien #548 ================================================ FILE: docs/changes/0.x/0.14.0.md ================================================ # 0.14.0 (29 Dec 2017) This release fixes several bugs and adds some new features. This version brings compatibility with PHP 7.0 & 7.1 ### Added - Possibility to control the footnote numbering -by [@troosan](https://github.com/troosan) in [#1068](https://github.com/PHPOffice/PHPWord/pull/1068) - Image creation from string -by [@troosan](https://github.com/troosan) in [#937](https://github.com/PHPOffice/PHPWord/pull/937) - Introduced the `\PhpOffice\PhpWord\SimpleType\NumberFormat` simple type. - @troosan - Support for ContextualSpacing -by [@postHawk](https://github.com/postHawk) in [#1088](https://github.com/PHPOffice/PHPWord/pull/1088) - Possiblity to hide spelling and/or grammatical errors -by [@troosan](https://github.com/troosan) in [#542](https://github.com/PHPOffice/PHPWord/pull/542) - Possiblity to set default document language as well as changing the language for each text element -by [@troosan](https://github.com/troosan) in [#1108](https://github.com/PHPOffice/PHPWord/pull/1108) - Support for Comments -by [@troosan](https://github.com/troosan) in [#1067](https://github.com/PHPOffice/PHPWord/pull/1067) - Support for paragraph textAlignment -by [@troosan](https://github.com/troosan) in [#1165](https://github.com/PHPOffice/PHPWord/pull/1165) - Add support for HTML underline tag `` in addHtml -by [@zNightFalLz](https://github.com/zNightFalLz) in [#1186](https://github.com/PHPOffice/PHPWord/pull/1186) - Add support for HTML `
` in addHtml - @anrikunby [@troosan](https://github.com/troosan) in [#659](https://github.com/PHPOffice/PHPWord/pull/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](https://github.com/cookiekiller) in [#863](https://github.com/PHPOffice/PHPWord/pull/863) #824 - Allow to force an update of all fields on opening a document -by [@troosan](https://github.com/troosan) in [#951](https://github.com/PHPOffice/PHPWord/pull/951) - Allow adding a CheckBox in a TextRun -by [@irond](https://github.com/irond) in [#727](https://github.com/PHPOffice/PHPWord/pull/727) - Add support for HTML img tag -by [@srggroup](https://github.com/srggroup) in [#934](https://github.com/PHPOffice/PHPWord/pull/934) - Add support for password protection for docx -by [@mariahaubner](https://github.com/mariahaubner) in [#1019](https://github.com/PHPOffice/PHPWord/pull/1019) ### Fixed - Loosen dependency to Zend - Images are not being printed when generating PDF -by [@hubertinio](https://github.com/hubertinio) in [#1074](https://github.com/PHPOffice/PHPWord/pull/1074) #431 - Fixed some PHP 7 warnings - @ likeuntomurphy #927 - Fixed PHP 7.2 compatibility (renamed `Object` class names to `ObjectElement`) -by [@SailorMax](https://github.com/SailorMax) in [#1185](https://github.com/PHPOffice/PHPWord/pull/1185) - Fixed Word 97 reader - @alsofronie @Benpxpxby [@mario-rivera](https://github.com/mario-rivera) in [#912](https://github.com/PHPOffice/PHPWord/pull/912) #920 #892 - Fixed image loading over https -by [@troosan](https://github.com/troosan) in [#988](https://github.com/PHPOffice/PHPWord/pull/988) - Impossibility to set different even and odd page headers -by [@troosan](https://github.com/troosan) in [#981](https://github.com/PHPOffice/PHPWord/pull/981) - Fixed Word2007 reader where unnecessary paragraphs were being created -by [@donghaobo](https://github.com/donghaobo) in [#1043](https://github.com/PHPOffice/PHPWord/pull/1043) #620 - Fixed Word2007 reader where margins were not being read correctly -by [@slowprog](https://github.com/slowprog) in [#885](https://github.com/PHPOffice/PHPWord/pull/885) #1008 - Impossible to add element PreserveText in Section -by [@rvanlaak](https://github.com/rvanlaak) in [#452](https://github.com/PHPOffice/PHPWord/pull/452) - Added missing options for numbering format -by [@troosan](https://github.com/troosan) in [#1041](https://github.com/PHPOffice/PHPWord/pull/1041) - Fixed impossibility to set a different footer for first page -by [@ctrlaltca](https://github.com/ctrlaltca) in [#1116](https://github.com/PHPOffice/PHPWord/pull/1116),by [@aoloe](https://github.com/aoloe) in [#875](https://github.com/PHPOffice/PHPWord/pull/875) - Fixed styles not being applied by HTML writer, better pdf output -by [@sarke](https://github.com/sarke) in [#1047](https://github.com/PHPOffice/PHPWord/pull/1047) #500 #1139 - Fixed read docx error when document contains image from remote url -by [@FBnil](https://github.com/FBnil) in [#1173](https://github.com/PHPOffice/PHPWord/pull/1173) #1176 - Padded the $args array to remove error -by [@kaigoh](https://github.com/kaigoh) in [#1150](https://github.com/PHPOffice/PHPWord/pull/1150),by [@reformed](https://github.com/reformed) in [#870](https://github.com/PHPOffice/PHPWord/pull/870) - Fix incorrect image size between windows and mac -by [@bskrtich](https://github.com/bskrtich) in [#874](https://github.com/PHPOffice/PHPWord/pull/874) - Fix adding HTML table to document - @mogilvieby [@arivanbastos](https://github.com/arivanbastos) in [#324](https://github.com/PHPOffice/PHPWord/pull/324) - Fix parsing on/off values (w:val="true|false|1|0|on|off") -by [@troosan](https://github.com/troosan) in [#1221](https://github.com/PHPOffice/PHPWord/pull/1221) #1219 - Fix error on Empty Dropdown Entry -by [@ComputerTinker](https://github.com/ComputerTinker) in [#592](https://github.com/PHPOffice/PHPWord/pull/592) ### Deprecated - PhpWord->getProtection(), get it from the settings instead PhpWord->getSettings()->getDocumentProtection(); ================================================ FILE: docs/changes/0.x/0.15.0.md ================================================ # 0.15.0 (14 Jul 2018) ### Added - Parsing of `align` HTML attribute -by [@troosan](https://github.com/troosan) in [#1231](https://github.com/PHPOffice/PHPWord/pull/1231) - Parse formatting inside HTML lists - @troosanby [@samimussbach](https://github.com/samimussbach) in [#1239](https://github.com/PHPOffice/PHPWord/pull/1239) / [#945](https://github.com/PHPOffice/PHPWord/pull/945) / [#1215](https://github.com/PHPOffice/PHPWord/pull/1215) / [#508](https://github.com/PHPOffice/PHPWord/pull/508) - Parsing of CSS `direction` instruction, HTML `lang` attribute, formatting inside table cell -by [@troosan](https://github.com/troosan) in [#1273](https://github.com/PHPOffice/PHPWord/pull/1273) / [#1252](https://github.com/PHPOffice/PHPWord/pull/1252) / [#1254](https://github.com/PHPOffice/PHPWord/pull/1254) - Add support for Track changes @Cipby [@troosan](https://github.com/troosan) in [#354](https://github.com/PHPOffice/PHPWord/pull/354) / [#1262](https://github.com/PHPOffice/PHPWord/pull/1262) - Add support for fixed Table Layout @aoloe @ekopachby [@troosan](https://github.com/troosan) in [#841](https://github.com/PHPOffice/PHPWord/pull/841) / [#1276](https://github.com/PHPOffice/PHPWord/pull/1276) - Add support for Cell Spacing @dox07by [@troosan](https://github.com/troosan) in [#1040](https://github.com/PHPOffice/PHPWord/pull/1040) - Add parsing of formatting inside lists @atomicalnetby [@troosan](https://github.com/troosan) in [#594](https://github.com/PHPOffice/PHPWord/pull/594) - Added support for Vertically Raised or Lowered Text (w:position) @anrikunby [@troosan](https://github.com/troosan) in [#640](https://github.com/PHPOffice/PHPWord/pull/640) - Add support for MACROBUTTON field @phryneasby [@troosan](https://github.com/troosan) in [#1021](https://github.com/PHPOffice/PHPWord/pull/1021) - Add support for Hyphenationby [@Trainmaster](https://github.com/Trainmaster) in [#1282](https://github.com/PHPOffice/PHPWord/pull/1282) (Document: `autoHyphenation`, `consecutiveHyphenLimit`, `hyphenationZone`, `doNotHyphenateCaps`, Paragraph: `suppressAutoHyphens`) - Added support for Floating Table Positioning (tblpPr)by [@anrikun](https://github.com/anrikun) in [#639](https://github.com/PHPOffice/PHPWord/pull/639) - Added support for Image text wrapping distanceby [@troosan](https://github.com/troosan) in [#1310](https://github.com/PHPOffice/PHPWord/pull/1310) - Added parsing of CSS line-height and text-indent in HTML readerby [@troosan](https://github.com/troosan) in [#1316](https://github.com/PHPOffice/PHPWord/pull/1316) - Added the ability to enable gridlines and axislabels on chartsby [@FrankMeyer](https://github.com/FrankMeyer) in [#576](https://github.com/PHPOffice/PHPWord/pull/576) - Add support for table indent (tblInd)by [@Trainmaster](https://github.com/Trainmaster) in [#1343](https://github.com/PHPOffice/PHPWord/pull/1343) - Added parsing of internal links in HTML readerby [@lalop](https://github.com/lalop) in [#1336](https://github.com/PHPOffice/PHPWord/pull/1336) - Several improvements to chartsby [@JAEK-S](https://github.com/JAEK-S) in [#1332](https://github.com/PHPOffice/PHPWord/pull/1332) - Add parsing of html image in base64 formatby [@jgpATs2w](https://github.com/jgpATs2w) in [#1382](https://github.com/PHPOffice/PHPWord/pull/1382) - Added Support for Indentation & Tabs on RTF Writer.by [@smaug1985](https://github.com/smaug1985) in [#1405](https://github.com/PHPOffice/PHPWord/pull/1405) - Allows decimal numbers in HTML line-height styleby [@jgpATs2w](https://github.com/jgpATs2w) in [#1413](https://github.com/PHPOffice/PHPWord/pull/1413) ### Fixed - Fix reading of docx default style -by [@troosan](https://github.com/troosan) in [#1238](https://github.com/PHPOffice/PHPWord/pull/1238) - Fix the size unit of when parsing html images -by [@troosan](https://github.com/troosan) in [#1254](https://github.com/PHPOffice/PHPWord/pull/1254) - Fixed HTML parsing of nested lists -by [@troosan](https://github.com/troosan) in [#1265](https://github.com/PHPOffice/PHPWord/pull/1265) - Save PNG alpha information when using remote images.by [@samsullivan](https://github.com/samsullivan) in [#779](https://github.com/PHPOffice/PHPWord/pull/779) - Fix parsing of `` tag.by [@troosan](https://github.com/troosan) in [#1274](https://github.com/PHPOffice/PHPWord/pull/1274) - Bookmark are not writton as internal link in html writerby [@troosan](https://github.com/troosan) in [#1263](https://github.com/PHPOffice/PHPWord/pull/1263) - It should be possible to add a Footnote in a ListItemRunby [@troosan](https://github.com/troosan) in [#1287](https://github.com/PHPOffice/PHPWord/pull/1287) #1287 - Fix colspan and rowspan for tables in HTML Writerby [@mattbolt](https://github.com/mattbolt) in [#1292](https://github.com/PHPOffice/PHPWord/pull/1292) - Fix parsing of Heading and Title formating @troosanby [@gthomas2](https://github.com/gthomas2) in [#465](https://github.com/PHPOffice/PHPWord/pull/465) - Fix Dateformat typo, fix hours casing, add Month-Day-Year formatsby [@ComputerTinker](https://github.com/ComputerTinker) in [#591](https://github.com/PHPOffice/PHPWord/pull/591) - Support reading of w:drawing for documents produced by word 2011+by [@gthomas2](https://github.com/gthomas2) in [#464](https://github.com/PHPOffice/PHPWord/pull/464) #1324 - Fix missing column width in ODText writerby [@potofcoffee](https://github.com/potofcoffee) in [#413](https://github.com/PHPOffice/PHPWord/pull/413) - Disable entity loader before parsing XML to avoid XXE injectionby [@Tom4t0](https://github.com/Tom4t0) in [#1427](https://github.com/PHPOffice/PHPWord/pull/1427) ### Changed - Remove zend-stdlib dependencyby [@Trainmaster](https://github.com/Trainmaster) in [#1284](https://github.com/PHPOffice/PHPWord/pull/1284) - The default unit for `\PhpOffice\PhpWord\Style\Image` changed from `px` to `pt`. ### Miscellaneous - Drop GitHub pages, switch to coveralls for code coverage analysisby [@czosel](https://github.com/czosel) in [#1360](https://github.com/PHPOffice/PHPWord/pull/1360) ================================================ FILE: docs/changes/0.x/0.16.0.md ================================================ # 0.16.0 (30 dec 2018) ### Added - Add getVariableCount method in TemplateProcessor.by [@nicoder](https://github.com/nicoder) in [#1272](https://github.com/PHPOffice/PHPWord/pull/1272) - Add setting Chart Title and Legend visibilityby [@Tom-Magill](https://github.com/Tom-Magill) in [#1433](https://github.com/PHPOffice/PHPWord/pull/1433) - Add ability to pass a Style object in Section constructorby [@ndench](https://github.com/ndench) in [#1416](https://github.com/PHPOffice/PHPWord/pull/1416) - Add support for hidden textby [@Alexmg86](https://github.com/Alexmg86) in [#1527](https://github.com/PHPOffice/PHPWord/pull/1527) - Add support for setting images in TemplateProcessorby [@SailorMax](https://github.com/SailorMax) in [#1170](https://github.com/PHPOffice/PHPWord/pull/1170) - Add "Plain Text" type to SDT (Structured Document Tags)by [@morrisdj](https://github.com/morrisdj) in [#1541](https://github.com/PHPOffice/PHPWord/pull/1541) - Added possibility to index variables inside cloned block in TemplateProcessorby [@JPBetley](https://github.com/JPBetley) in [#817](https://github.com/PHPOffice/PHPWord/pull/817) - Added possibility to replace variables inside cloned block with values in TemplateProcessorby [@DIDoS](https://github.com/DIDoS) in [#1392](https://github.com/PHPOffice/PHPWord/pull/1392) ### Fixed - Fix regex in `cloneBlock` functionby [@nicoder](https://github.com/nicoder) in [#1269](https://github.com/PHPOffice/PHPWord/pull/1269) - HTML Title Writer loses text when Title contains a TextRun instead a string.by [@begnini](https://github.com/begnini) in [#1436](https://github.com/PHPOffice/PHPWord/pull/1436) - Fix regex in fixBrokenMacros, make it less greedy @MuriloSo @brainwoodby [@yurii-sio2](https://github.com/yurii-sio2) in [#1502](https://github.com/PHPOffice/PHPWord/pull/1502) / [#1345](https://github.com/PHPOffice/PHPWord/pull/1345) - 240 twips are being added to line spacing, should not happen when using lineRule fixedby [@troosan](https://github.com/troosan) in [#1509](https://github.com/PHPOffice/PHPWord/pull/1509) / [#1505](https://github.com/PHPOffice/PHPWord/pull/1505) - Adding table layout to the generated HTMLby [@aarangara](https://github.com/aarangara) in [#1441](https://github.com/PHPOffice/PHPWord/pull/1441) - Fix loading of Sharepoint documentby [@Garrcomm](https://github.com/Garrcomm) in [#1498](https://github.com/PHPOffice/PHPWord/pull/1498) - RTF writer: Round getPageSizeW and getPageSizeH to avoid decimalsby [@Patrick64](https://github.com/Patrick64) in [#1493](https://github.com/PHPOffice/PHPWord/pull/1493) - Fix parsing of Office 365 documentsby [@Timanx](https://github.com/Timanx) in [#1485](https://github.com/PHPOffice/PHPWord/pull/1485) - For RTF writers, sizes should should never have decimalsby [@Samuel-BF](https://github.com/Samuel-BF) in [#1536](https://github.com/PHPOffice/PHPWord/pull/1536) - Style Name Parsing fails if document generated by a non-english word versionby [@begnini](https://github.com/begnini) in [#1434](https://github.com/PHPOffice/PHPWord/pull/1434) ### Miscellaneous - Get rid of duplicated code in TemplateProcessorby [@abcdmitry](https://github.com/abcdmitry) in [#1161](https://github.com/PHPOffice/PHPWord/pull/1161) ================================================ FILE: docs/changes/0.x/0.17.0.md ================================================ # 0.17.0 (01 oct 2019) ### Added - Add methods setValuesFromArray and cloneRowFromArray to the TemplateProcessor [@geraldb-nicat](https://github.com/geraldb-nicat) GH-670 - Set complex type in template [@troosan](https://github.com/troosan) GH-1565 - implement support for section vAlign [@troosan](https://github.com/troosan) GH-1569 - ParseStyle for border-color [@Gllrm0](https://github.com/Gllrm0) GH-1551 - Html writer auto invert text color [@SailorMax](https://github.com/SailorMax) GH-1387 - Add RightToLeft table presentation. [@troosan](https://github.com/troosan) GH-1550 - Add support for page vertical alignment. [@troosan](https://github.com/troosan) GH-672 GH-1569 - Adding setNumId method for ListItem style [@eweso](https://github.com/eweso) GH-1329 - Add support for basic fields in RTF writer. [@Samuel-BF](https://github.com/Samuel-BF) GH-1717 ### Fixed - Fix HTML border-color parsing. [@troosan](https://github.com/troosan) GH-1551 / GH-1570 - Language::validateLocale should pass with locale 'zxx'. [@efpapado](https://github.com/efpapado) GH-1558 - can't align center vertically with the text [@ter987](https://github.com/ter987) GH-672 - fix parsing of border-color and add test [@troosan](https://github.com/troosan) GH-1570 - TrackChange doesn't handle all return types of \DateTime::createFromFormat(...) [@superhaggis](https://github.com/superhaggis) GH-1584 - To support PreserveText inside sub container [@bhattnishant](https://github.com/bhattnishant) GH-1637 - No nested w:pPr elements in ListItemRun. [@waltertamboer](https://github.com/waltertamboer) GH-1628 - Ensure that entity_loader disable variable is re-set back to the original setting [@seamuslee001](https://github.com/seamuslee001) GH-1585 ### Miscellaneous - Use embedded http server to test loading of remote images [@troosan](https://github.com/troosan) GH-1544 - Change private to protected to be able extending class Html [@SpinyMan](https://github.com/SpinyMan) GH-1646 - Fix apt-get crash in Travis CI for PHP 5.3 [@mdupont](https://github.com/mdupont) GH-1707 ================================================ FILE: docs/changes/0.x/0.18.0.md ================================================ # [0.18.0](https://github.com/PHPOffice/PHPWord/tree/0.18.0) (2021-02-12) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.17.0...0.18.0) ### Enhancements - Add support for charts in template processor [#2012](https://github.com/PHPOffice/PHPWord/pull/2012) ([@dbarzin](https://github.com/dbarzin)) - add/setting page element border style. [#1986](https://github.com/PHPOffice/PHPWord/pull/1986) ([@emnabs](https://github.com/emnabs)) - allow to use customized pdf library [#1983](https://github.com/PHPOffice/PHPWord/pull/1983) ([@SailorMax](https://github.com/SailorMax)) - feat: Update addHtml to handle style inheritance [#1965](https://github.com/PHPOffice/PHPWord/pull/1965) ([@Julien1138](https://github.com/Julien1138)) - Add parsing of Shape node values [#1924](https://github.com/PHPOffice/PHPWord/pull/1924) ([@sven-ahrens](https://github.com/sven-ahrens)) - Allow to redefine TCPDF object [#1907](https://github.com/PHPOffice/PHPWord/pull/1907) ([@SailorMax](https://github.com/SailorMax)) - Enhancements to addHTML parser [#1902](https://github.com/PHPOffice/PHPWord/pull/1902) ([@lubosdz](https://github.com/lubosdz)) - Make Default Paper Configurable [#1851](https://github.com/PHPOffice/PHPWord/pull/1851) ([@oleibman](https://github.com/oleibman)) - Implement various missing features for the ODT writer [#1796](https://github.com/PHPOffice/PHPWord/pull/1796) ([@oleibman](https://github.com/oleibman)) - Added support for "cloudConvert" images [#1794](https://github.com/PHPOffice/PHPWord/pull/1794) ([@ErnestStaug](https://github.com/ErnestStaug)) - Add support for several features for the RTF writer [#1775](https://github.com/PHPOffice/PHPWord/pull/1775) ([@oleibman](https://github.com/oleibman)) - Add font style for Field elements [#1774](https://github.com/PHPOffice/PHPWord/pull/1774) ([@oleibman](https://github.com/oleibman)) - Add support for ListItemRun in HTML writer [#1766](https://github.com/PHPOffice/PHPWord/pull/1766) ([@stefan-91](https://github.com/stefan-91)) - Improvements in RTF writer [#1755](https://github.com/PHPOffice/PHPWord/pull/1755) ([@oleibman](https://github.com/oleibman)) - Allow a closure to be passed with image replacement tags [#1716](https://github.com/PHPOffice/PHPWord/pull/1716) ([@mbardelmeijer](https://github.com/mbardelmeijer)) - Add Option for Dynamic Chart Legend Position [#1699](https://github.com/PHPOffice/PHPWord/pull/1699) ([@Stephan212](https://github.com/Stephan212)) - Add parsing of HTML checkbox input field [#1832](https://github.com/PHPOffice/PHPWord/pull/1832) ([@Matze2010](https://github.com/Matze2010)) ### Bug fixes - Fix image stroke in libreoffice 7.x [#1992](https://github.com/PHPOffice/PHPWord/pull/1992) ([@Adizbek](https://github.com/Adizbek)) - Fix deprecated warning for non-hexadecimal number [#1988](https://github.com/PHPOffice/PHPWord/pull/1988) ([@Ciki](https://github.com/Ciki)) - Fix limit not taken into account when adding image in template [#1967](https://github.com/PHPOffice/PHPWord/pull/1967) ([@jsochor](https://github.com/jsochor)) - Add null check when setComplexValue is not found [#1936](https://github.com/PHPOffice/PHPWord/pull/1936) ([@YannikFirre](https://github.com/YannikFirre)) - Some document have non-standard locale code [#1824](https://github.com/PHPOffice/PHPWord/pull/1824) ([@ErnestStaug](https://github.com/ErnestStaug)) - Fixes PHPDoc @param and @return types for several Converter methods [#1818](https://github.com/PHPOffice/PHPWord/pull/1818) ([@caugner](https://github.com/caugner)) - Update the regexp to avoid catastrophic backtracking [#1809](https://github.com/PHPOffice/PHPWord/pull/1809) ([@juzser](https://github.com/juzser)) - Fix PHPUnit tests on develop branch [#1771](https://github.com/PHPOffice/PHPWord/pull/1771) ([@mdupont](https://github.com/mdupont)) - TemplateProcessor cloneBlock wrongly clones images [#1763](https://github.com/PHPOffice/PHPWord/pull/1763) ([@alarai](https://github.com/alarai)) ### Miscellaneous - Compatibility with PHP 7.4, PHP 8.0 and migrate to Laminas Escaper [#1946](https://github.com/PHPOffice/PHPWord/pull/1946) ([@liborm85](https://github.com/liborm85)) - Remove legacy PHPOffice/Common package, fix PHP 8.0 compatibility [#1996](https://github.com/PHPOffice/PHPWord/pull/1996) ([@liborm85](https://github.com/liborm85)) - Improve Word2007 Test Coverage [#1858](https://github.com/PHPOffice/PHPWord/pull/1858) ([@oleibman](https://github.com/oleibman)) - Fix typo in docs. Update templates-processing.rst [#1952](https://github.com/PHPOffice/PHPWord/pull/1952) ([@mnvx](https://github.com/mnvx)) - Fix documentation and method name for FootnoteProperties [#1776](https://github.com/PHPOffice/PHPWord/pull/1776) ([@mdupont](https://github.com/mdupont)) - fix: documentation about paragraph indentation [#1764](https://github.com/PHPOffice/PHPWord/pull/1764) ([@mdupont](https://github.com/mdupont)) - Update templates-processing.rst [#1745](https://github.com/PHPOffice/PHPWord/pull/1745) ([@igronus](https://github.com/igronus)) - Unused variables $rows, $cols in sample [#1877](https://github.com/PHPOffice/PHPWord/pull/1877) ([@ThanasisMpalatsoukas](https://github.com/ThanasisMpalatsoukas)) - Add unit test for NumberingStyle [#1744](https://github.com/PHPOffice/PHPWord/pull/1744) ([@Manunchik](https://github.com/Manunchik)) - Add unit test for PhpWord Settings [#1743](https://github.com/PHPOffice/PHPWord/pull/1743) (@[Manunchik](https://github.com/Manunchik)) - Add unit test for Media elements [#1742](https://github.com/PHPOffice/PHPWord/pull/1742) ([@Manunchik](https://github.com/Manunchik)) - Update templates processing docs [#1729](https://github.com/PHPOffice/PHPWord/pull/1729) ([@hcdias](https://github.com/hcdias)) ================================================ FILE: docs/changes/0.x/0.18.1.md ================================================ # [0.18.1](https://github.com/PHPOffice/PHPWord/tree/0.18.1) (2021-03-08) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.0...0.18.1) ### Bug fixes - Fix BC break in GH-1946. This package does not replace laminas/laminas-zendframework-bridge by [@mussbach](https://github.com/mussbach) in [#2032](https://github.com/PHPOffice/PHPWord/pull/2032) ================================================ FILE: docs/changes/0.x/0.18.2.md ================================================ # [0.18.2](https://github.com/PHPOffice/PHPWord/tree/0.18.2) (2021-06-04) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.1...0.18.2) ### Bug fixes - when adding image to relationship first check that the generated RID is actually unique by [@tpv-ebben](https://github.com/tpv-ebben) in [#2063](https://github.com/PHPOffice/PHPWord/pull/2063) - Update chart, don't write 'c:overlap' if grouping is 'clustered' by [@dfsd534](https://github.com/dfsd534) in [#2052](https://github.com/PHPOffice/PHPWord/pull/2052) - Update Html parser to accept line-height:normal by [@joelgo](https://github.com/joelgo) in [#2041](https://github.com/PHPOffice/PHPWord/pull/2041) - Fix image border in Word2007 Writer for LibreOffice 7 by [k@amilmmach](https://github.com/kamilmmach) in [#2021](https://github.com/PHPOffice/PHPWord/pull/2021) ### Miscellaneous - Corrected namespace for Language class in docs by [@MegaChriz](https://github.com/MegaChriz) in [#2087](https://github.com/PHPOffice/PHPWord/pull/2087) - Added support for Garamond font by [@artemkolotilkin](https://github.com/artemkolotilkin) in [#2078](https://github.com/PHPOffice/PHPWord/pull/2078) - Add BorderStyle for Cell Style to documentation by [@DShkrabak](https://github.com/DShkrabak) in [#2090](https://github.com/PHPOffice/PHPWord/pull/2090) ================================================ FILE: docs/changes/0.x/0.18.3.md ================================================ # [0.18.3](https://github.com/PHPOffice/PHPWord/tree/0.18.3) (2022-02-17) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.2...0.18.3) ### Bug fixes - PHP 8.1 compatibility ================================================ FILE: docs/changes/0.x/0.7.0.md ================================================ # 0.7.0 (28 Jan 2014) This is the first release after a long development hiatus in [CodePlex](https://phpword.codeplex.com/). 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](https://packagist.org/packages/phpoffice/phpword) and [Travis](https://travis-ci.org/PHPOffice/PHPWord) were added. ### Features - 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 ### Bugfixes - "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 ### Miscellaneous - 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](http://phpword.codeplex.com/workitem/49) ================================================ FILE: docs/changes/0.x/0.8.0.md ================================================ # 0.8.0 (15 Mar 2014) This release merged a lot of improvements from the community. Unit tests introduced in this release and has reached 90% code coverage. ### Features - 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 ### Bugfixes - 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 ### Miscellaneous - UnitTests - @Progi1984 ================================================ FILE: docs/changes/0.x/0.8.1.md ================================================ # 0.8.1 (17 Mar 2014) This is a bugfix release for image detection functionality. - Added fallback for computers that do not have exif_imagetype - @bskrtich, @gabrielbull ================================================ FILE: docs/changes/0.x/0.9.0.md ================================================ # 0.9.0 (26 Mar 2014) This release marked the transformation to namespaces (PHP 5.3+). ### Features - 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 ### Bugfixes - Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin ### Miscellaneous - Move documentation to [Read The Docs](http://phpword.readthedocs.org/en/develop/) - by [@Progi1984](https://github.com/Progi1984) & [@ivanlanin](https://github.com/ivanlanin) in [#82](https://github.com/PHPOffice/PHPWord/pull/82) - Reorganize and redesign samples folder - @ivanlanin #137 - Use `PhpOffice\PhpWord` namespace for PSR compliance - @RomanSyroeshko @gabrielbull #159, #58 - Restructure folders and change folder name `Classes` to `src` and `Tests` to `test` for 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 ================================================ FILE: docs/changes/0.x/0.9.1.md ================================================ # 0.9.1 (27 Mar 2014) This is a bugfix release for PSR-4 compatibility. - Fixed PSR-4 composer autoloader - @AntonTyutin ================================================ FILE: docs/changes/1.x/1.0.0.md ================================================ # [1.0.0](https://github.com/PHPOffice/PHPWord/tree/1.0.0) (2022-11-15) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/0.18.3...1.0.0) ### BREAKING CHANGE Most deprecated things were dropped. See details in https://github.com/PHPOffice/PHPWord/commit/b9f1151bc6f90c276153c3c9dca10a5fc7f355fb. #### Dropped classes: - `PhpOffice\PhpWord\Template` #### Dropped constants: - `PhpOffice\PhpWord\Style\Font::UNDERLINE_DOTHASH` - `PhpOffice\PhpWord\Style\Font::UNDERLINE_DOTHASHHEAVY` - `PhpOffice\PhpWord\Style\Cell::VALIGN_TOP` - `PhpOffice\PhpWord\Style\Cell::VALIGN_CENTER` - `PhpOffice\PhpWord\Style\Cell::VALIGN_BOTTOM` - `PhpOffice\PhpWord\Style\Cell::VALIGN_BOTH` - `PhpOffice\PhpWord\Style\TOC::TABLEADER_DOT` - `PhpOffice\PhpWord\Style\TOC::TABLEADER_UNDERSCORE` - `PhpOffice\PhpWord\Style\TOC::TABLEADER_LINE` - `PhpOffice\PhpWord\Style\TOC::TABLEADER_NONE` - `PhpOffice\PhpWord\Style\Table::WIDTH_AUTO` - `PhpOffice\PhpWord\Style\Table::WIDTH_PERCENT` - `PhpOffice\PhpWord\Style\Table::WIDTH_TWIP` - `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_NAME` - `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_SIZE` - `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_COLOR` - `PhpOffice\PhpWord\PhpWord::DEFAULT_FONT_CONTENT_TYPE` - #### Dropped methods: - `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()` ### Bug fixes - Multiple PHP 8.1 fixes - `loadConfig` returns config that was actually applied - HTML Reader : Override inline style on HTML attribute for table - HTML Reader : Use `border` attribute for tables - HTML Reader : Style page-break-after in paragraph - HTML Reader : Heading in Text Run is not allowed ### Miscellaneous - Drop support for PHP 7.0 and older ================================================ FILE: docs/changes/1.x/1.1.0.md ================================================ # [1.1.0](https://github.com/PHPOffice/PHPWord/tree/1.1.0) (2023-05-30) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.0.0...1.1.0) ### Enhancements - 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 ### Bug fixes - DOCX reader: Read empty vmerge - Fixed setting width of Cell Style ### Miscellaneous - `master` is the new default branch ================================================ FILE: docs/changes/1.x/1.2.0.md ================================================ # [1.2.0](https://github.com/PHPOffice/PHPWord/tree/1.2.0) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.1.0...1.2.0) ## Enhancements - Word2007 Reader/Writer : Added noWrap table cell property by [@kernusr](https://github.com/kernusr) in GH-2359 - HTML Reader : Support for `font-variant: small-caps` by [@cambraca](https://github.com/cambraca) in GH-2117 - Improved TextDirection for styling a cell by [@terryzwt](https://github.com/terryzwt) in GH-2429 - Word2007 Reader : Added option to disable loading images by [@aelliott1485](https://github.com/aelliott1485) in GH-2450 - HTML Writer : Added border-spacing to default styles for table by [@kernusr](https://github.com/kernusr) in GH-2451 - Word2007 Reader : Support for table cell borders and margins by [@kernusr](https://github.com/kernusr) in GH-2454 - PDF Writer : Add config for defining the default font by [@MikeMaldini](https://github.com/MikeMaldini) in [#2262](https://github.com/PHPOffice/PHPWord/pull/2262) & [#2468](https://github.com/PHPOffice/PHPWord/pull/2468) - Word2007 Reader : Added support for Comments by [@shaedrich](https://github.com/shaedrich) in [#2161](https://github.com/PHPOffice/PHPWord/pull/2161) & [#2469](https://github.com/PHPOffice/PHPWord/pull/2469) - Word2007 Reader/Writer: Permit book-fold printing by [@potofcoffee](https://github.com/potofcoffee) in [#2225](https://github.com/PHPOffice/PHPWord/pull/2225) & [#2470](https://github.com/PHPOffice/PHPWord/pull/2470) - Word2007 Writer : Add PageNumber to TOC by [@jet-desk](https://github.com/jet-desk) in [#1652](https://github.com/PHPOffice/PHPWord/pull/1652) & [#2471](https://github.com/PHPOffice/PHPWord/pull/2471) - Word2007 Reader/Writer + ODText Reader/Writer : Add Element Formula in by [@Progi1984](https://github.com/Progi1984) in [#2477](https://github.com/PHPOffice/PHPWord/pull/2477) - Add Support for Various Missing Features in HTML Writer by [@oleibman](https://github.com/oleibman) in [#2475](https://github.com/PHPOffice/PHPWord/pull/2475) - Fixed addHTML (text-align:right in html is not handled correctly) in [#2467](https://github.com/PHPOffice/PHPWord/pull/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](https://github.com/nxtpge) in [#2509](https://github.com/PHPOffice/PHPWord/pull/2509) - ODText / RTF / Word2007 Writer : Add field FILENAME by [@milkyway-git](https://github.com/milkyway-git) in [#2510](https://github.com/PHPOffice/PHPWord/pull/2510) - ODText Reader : Improve Section Reader by [@oleibman](https://github.com/oleibman) in [#2507](https://github.com/PHPOffice/PHPWord/pull/2507) ### Bug fixes - Fixed wrong mimetype for docx files by [@gamerlv](https://github.com/gamerlv) in GH-2416 - Word2007 Reader : Read hyperlingks in headings by [@hannesdorn](https://github.com/hannesdorn) in GH-2433 - PclZip : strtr using empty string by [@spl1nes](https://github.com/spl1nes) in GH-2432 - Fixed PHP 8.2 deprecated about Allow access to an undefined property by [@DAdq26](https://github.com/DAdq26) in GH-2440 - Template Processor : Fixed choose dimention for Float Value by [@gdevilbat](https://github.com/gdevilbat) in GH-2449 - HTML Parser : Fix image parsing from url without extension by [@JokubasR](https://github.com/JokubasR) in GH-2459 - Word2007 Reader : Fixed reading of Office365 DocX file by [@filippotoso](https://github.com/filippotoso) & [@lfglopes](https://github.com/lfglopes) in [#2506](https://github.com/PHPOffice/PHPWord/pull/2506) - Word2007 Reader : Check for null on $fontDefaultStyle by [@spatialfree](https://github.com/spatialfree) in [#2513](https://github.com/PHPOffice/PHPWord/pull/2513) ### Miscellaneous - Added PHPStan by [@PowerKiKi](https://github.com/PowerKiKi) in GH-2405 - Bump symfony/process from 4.4.44 to 5.4.26 by [@dependabot](https://github.com/dependabot) in GH-2431 - Bump phpunit/phpunit from 9.6.8 to 9.6.10 by [@dependabot](https://github.com/dependabot) in GH-2430 - Added Coveralls.io by [@Progi1984](https://github.com/Progi1984) in GH-2452 - Added support for PHP 8.2 & PHP 8.3 by [@Progi1984](https://github.com/Progi1984) in GH-2453 - Moved documention from ReadTheDocs to MkDocs & Github Pages by [@Progi1984](https://github.com/Progi1984) in GH-2465 - Bump phpstan/phpstan-phpunit from 1.3.13 to 1.3.14 by [@dependabot](https://github.com/dependabot) in [#2457](https://github.com/PHPOffice/PHPWord/pull/2457) - Bump symfony/process from 5.4.26 to 5.4.28 by [@dependabot](https://github.com/dependabot) in [#2456](https://github.com/PHPOffice/PHPWord/pull/2456) - Bump phpunit/phpunit from 9.6.10 to 9.6.11 by [@dependabot](https://github.com/dependabot) in [#2455](https://github.com/PHPOffice/PHPWord/pull/2455) - Remove deprecated utf8_encode in PHP 8.2 by [@mhcwebdesign](https://github.com/mhcwebdesign) in [#2447](https://github.com/PHPOffice/PHPWord/pull/2447) & [#2472](https://github.com/PHPOffice/PHPWord/pull/2472) - Bump mpdf/mpdf from 8.1.6 to 8.2.0 by [@dependabot](https://github.com/dependabot) in [#2480](https://github.com/PHPOffice/PHPWord/pull/2480) - Bump phpunit/phpunit from 9.6.11 to 9.6.13 by [@dependabot](https://github.com/dependabot) in [#2481](https://github.com/PHPOffice/PHPWord/pull/2481) - Bump tecnickcom/tcpdf from 6.6.2 to 6.6.5 by [@dependabot](https://github.com/dependabot) in [#2482](https://github.com/PHPOffice/PHPWord/pull/2482) - Bump phpmd/phpmd from 2.13.0 to 2.14.1 by [@dependabot](https://github.com/dependabot) in [#2483](https://github.com/PHPOffice/PHPWord/pull/2483) - Bump phpstan/phpstan-phpunit from 1.3.14 to 1.3.15 by [@dependabot](https://github.com/dependabot) in [#2494](https://github.com/PHPOffice/PHPWord/pull/2494) ### BC Breaks - Removed dependency `laminas/laminas-escaper` - *Unintended Break* TemplateProcessor Does Not Persist File After Destruct. [#2539](https://github.com/PHPOffice/PHPWord/issues/2539) To be fixed by [#2545](https://github.com/PHPOffice/PHPWord/pull/2545 ================================================ FILE: docs/changes/1.x/1.3.0.md ================================================ # [1.3.0](https://github.com/PHPOffice/PHPWord/tree/1.3.0) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.2.0...1.3.0) ## Enhancements - IOFactory : Added extractVariables method to extract variables from a document [@sibalonat](https://github.com/sibalonat) in [#2515](https://github.com/PHPOffice/PHPWord/pull/2515) - PDF Writer : Documented how to specify a PDF renderer, when working with the PDF writer, as well as the three available choices by [@settermjd](https://github.com/settermjd) in [#2642](https://github.com/PHPOffice/PHPWord/pull/2642) - Word2007 Reader: Support for Paragraph Border Style by [@damienfa](https://github.com/damienfa) in [#2651](https://github.com/PHPOffice/PHPWord/pull/2651) - Word2007 Writer: Support for field REF by [@crystoline](https://github.com/crystoline) in [#2652](https://github.com/PHPOffice/PHPWord/pull/2652) - Word2007 Reader : Support for FormFields by [@vincentKool](https://github.com/vincentKool) in [#2653](https://github.com/PHPOffice/PHPWord/pull/2653) - RTF Writer : Support for Table Border Style fixing [#345](https://github.com/PHPOffice/PHPWord/issues/345) by [@Progi1984](https://github.com/Progi1984) in [#2656](https://github.com/PHPOffice/PHPWord/pull/2656) - Word2007 Reader: Support the page break () by [@stanolacko](https://github.com/stanolacko) in [#2662](https://github.com/PHPOffice/PHPWord/pull/2662) - MsDoc Reader: Support for UTF-8 characters by [@Progi1984] fixing [#881](https://github.com/PHPOffice/PHPWord/issues/881), [#1454](https://github.com/PHPOffice/PHPWord/issues/1454), [#1817](https://github.com/PHPOffice/PHPWord/issues/1817), [#1927](https://github.com/PHPOffice/PHPWord/issues/1927), [#2383](https://github.com/PHPOffice/PHPWord/issues/2383), [#2565](https://github.com/PHPOffice/PHPWord/issues/2565) in [#2664](https://github.com/PHPOffice/PHPWord/pull/2664) - Word2007 Writer: Added support for multiples comment for the same text by [@rodrigoq](https://github.com/rodrigoq) fixing [#2109](https://github.com/PHPOffice/PHPWord/issues/2109) in [#2665](https://github.com/PHPOffice/PHPWord/pull/2665) ### Bug fixes - MsDoc Reader : Correct Font Size Calculation by [@oleibman](https://github.com/oleibman) fixing [#2526](https://github.com/PHPOffice/PHPWord/issues/2526) in [#2531](https://github.com/PHPOffice/PHPWord/pull/2531) - Html Reader : Process Titles as Headings not Paragraphs [@0b10011](https://github.com/0b10011) and [@oleibman](https://github.com/oleibman) Issue [#1692](https://github.com/PHPOffice/PHPWord/issues/1692) PR [#2533](https://github.com/PHPOffice/PHPWord/pull/2533) - Generate Table Cell if Row Doesn't Have Any [@oleibman](https://github.com/oleibman) fixing [#2505](https://github.com/PHPOffice/PHPWord/issues/2505) in [#2516](https://github.com/PHPOffice/PHPWord/pull/2516) - TemplateProcessor Persist File After Destruct [@oleibman](https://github.com/oleibman) fixing [#2539](https://github.com/PHPOffice/PHPWord/issues/2539) in [#2545](https://github.com/PHPOffice/PHPWord/pull/2545) - TemplateProcessor Destructor Problem with Php7 [@oleibman](https://github.com/oleibman) fixing [#2548](https://github.com/PHPOffice/PHPWord/issues/2548) in [#2554](https://github.com/PHPOffice/PHPWord/pull/2554) - bug: TemplateProcessor fix multiline values [@gimler](https://github.com/gimler) fixing [#268](https://github.com/PHPOffice/PHPWord/issues/268), [#2323](https://github.com/PHPOffice/PHPWord/issues/2323) and [#2486](https://github.com/PHPOffice/PHPWord/issues/2486) in [#2522](https://github.com/PHPOffice/PHPWord/pull/2522) - 32-bit Problem in PasswordEncoder [@oleibman](https://github.com/oleibman) fixing [#2550](https://github.com/PHPOffice/PHPWord/issues/2550) in [#2551](https://github.com/PHPOffice/PHPWord/pull/2551) - Typo : Fix hardcoded macro chars in TemplateProcessor method [@glafarge](https://github.com/glafarge) in [#2618](https://github.com/PHPOffice/PHPWord/pull/2618) - XML Reader : Prevent fatal errors when opening corrupt files or "doc" files [@mmcev106](https://github.com/mmcev106) in [#2626](https://github.com/PHPOffice/PHPWord/pull/2626) - Documentation : Updated Comment element by [@laminga](https://github.com/laminga) in [#2650](https://github.com/PHPOffice/PHPWord/pull/2650) - HTML Reader : Read width & height attributes in points fixing [#2589](https://github.com/PHPOffice/PHPWord/issues/2589) by [@Progi1984](https://github.com/Progi1984) in [#2654](https://github.com/PHPOffice/PHPWord/pull/2654) - Template Processor : Fixed bad naming of variables fixing [#2586](https://github.com/PHPOffice/PHPWord/issues/2586) by [@Progi1984](https://github.com/Progi1984) in [#2655](https://github.com/PHPOffice/PHPWord/pull/2655) - Word2007 Writer : Fix first footnote appearing as separator [#2634](https://github.com/PHPOffice/PHPWord/issues/2634) by [@jacksleight](https://github.com/jacksleight) in [#2635](https://github.com/PHPOffice/PHPWord/pull/2635) - Template Processor : Fixed images with transparent backgrounds displaying a white background by [@ElwynVdb](https://github.com/ElwynVdb) in [#2638](https://github.com/PHPOffice/PHPWord/pull/2638) - HTML Writer : Fixed rowspan for tables by [@andomiell](https://github.com/andomiell) in [#2659](https://github.com/PHPOffice/PHPWord/pull/2659) - Word2007 Writer : Fixed StrikeThrough property by [@noec764](https://github.com/noec764) fixing [#1722](https://github.com/PHPOffice/PHPWord/issues/1722) & [#1693](https://github.com/PHPOffice/PHPWord/issues/1693) in [#2661](https://github.com/PHPOffice/PHPWord/pull/2661) - HTML Reader : Fixed link without href by [@asmundstavdahl](https://github.com/asmundstavdahl) fixing [#1562](https://github.com/PHPOffice/PHPWord/issues/1562) in [#2663](https://github.com/PHPOffice/PHPWord/pull/2663) ### Miscellaneous - Bump dompdf/dompdf from 2.0.3 to 2.0.4 by [@dependabot](https://github.com/dependabot) in [#2530](https://github.com/PHPOffice/PHPWord/pull/2530) - Bump phpunit/phpunit from 9.6.13 to 9.6.14 by [@dependabot](https://github.com/dependabot) in [#2519](https://github.com/PHPOffice/PHPWord/pull/2519) - Bump mpdf/mpdf from 8.2.0 to 8.2.2 by [@dependabot](https://github.com/dependabot) in [#2518](https://github.com/PHPOffice/PHPWord/pull/2518) - Bump phpmd/phpmd from 2.14.1 to 2.15.0 by [@dependabot](https://github.com/dependabot) in [#2538](https://github.com/PHPOffice/PHPWord/pull/2538) - Bump phpunit/phpunit from 9.6.14 to 9.6.15 by [@dependabot](https://github.com/dependabot) in [#2537](https://github.com/PHPOffice/PHPWord/pull/2537) - Bump symfony/process from 5.4.28 to 5.4.34 by [@dependabot](https://github.com/dependabot) in [#2536](https://github.com/PHPOffice/PHPWord/pull/2536) - Allow rgb() when converting Html by [@oleibman](https://github.com/oleibman) fixing [#2508](https://github.com/PHPOffice/PHPWord/issues/2508) in [#2512](https://github.com/PHPOffice/PHPWord/pull/2512) - Improved Issue Template by [@Progi1984](https://github.com/Progi1984) in [#2609](https://github.com/PHPOffice/PHPWord/pull/2609) - Bump phpoffice/math from 0.1.0 to 0.2.0 by [@Progi1984](https://github.com/Progi1984) fixing [#2559](https://github.com/PHPOffice/PHPWord/issues/2559) in [#2645](https://github.com/PHPOffice/PHPWord/pull/2645) - Bump tecnickcom/tcpdf from 6.6.5 to 6.7.5 by [@dependabot](https://github.com/dependabot) in [#2646](https://github.com/PHPOffice/PHPWord/pull/2646) - Bump mpdf/mpdf from 8.2.2 to 8.2.4 by [@dependabot](https://github.com/dependabot) in [#2647](https://github.com/PHPOffice/PHPWord/pull/2647) - Bump phenx/php-svg-lib from 0.5.1 to 0.5.4 by [@dependabot](https://github.com/dependabot) in [#2649](https://github.com/PHPOffice/PHPWord/pull/2649) - Bump phpstan/phpstan-phpunit from 1.3.15 to 1.4.0 by [@dependabot](https://github.com/dependabot) in [#2648](https://github.com/PHPOffice/PHPWord/pull/2648) ### BC Breaks ================================================ FILE: docs/changes/1.x/1.4.0.md ================================================ # [1.4.0](https://github.com/PHPOffice/PHPWord/tree/1.4.0) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.3.0...1.4.0) ## Enhancements - Default Font: Allow specify Asisn font and Latin font separately - Writer ODText: Support for ListItemRun by [@Progi1984](https://github.com/Progi1984) fixing [#2159](https://github.com/PHPOffice/PHPWord/issues/2159), [#2620](https://github.com/PHPOffice/PHPWord/issues/2620) in [#2669](https://github.com/PHPOffice/PHPWord/pull/2669) - Writer HTML: Support for vAlign in Tables by [@SpraxDev](https://github.com/SpraxDev) in [#2675](https://github.com/PHPOffice/PHPWord/pull/2675) - Writer Word2007: Support for padding in Table Cell by [@Azamat8405](https://github.com/Azamat8405) in [#2697](https://github.com/PHPOffice/PHPWord/pull/2697) - Added support for PHP 8.4 by [@Progi1984](https://github.com/Progi1984) in [#2660](https://github.com/PHPOffice/PHPWord/pull/2660) - Autoload : Allow to use PHPWord without Composer fixing [#2543](https://github.com/PHPOffice/PHPWord/issues/2543), [#2552](https://github.com/PHPOffice/PHPWord/issues/2552), [#2716](https://github.com/PHPOffice/PHPWord/issues/2716), [#2717](https://github.com/PHPOffice/PHPWord/issues/2717) in [#2722](https://github.com/PHPOffice/PHPWord/pull/2722) - Add Default font color for Word by [@Collie-IT](https://github.com/Collie-IT) in [#2700](https://github.com/PHPOffice/PHPWord/pull/2700) - Writer HTML: Support Default font color by [@MichaelPFrey](https://github.com/MichaelPFrey) in [#2731](https://github.com/PHPOffice/PHPWord/pull/2731) - Writer ODText: Support Default font color by [@MichaelPFrey](https://github.com/MichaelPFrey) in [#2735](https://github.com/PHPOffice/PHPWord/pull/2735) - Add basic ruby text (phonetic guide) support for Word2007 and HTML Reader/Writer, RTF Writer, basic support for ODT writing by [@Deadpikle](https://github.com/Deadpikle) in [#2727](https://github.com/PHPOffice/PHPWord/pull/2727) - Reader HTML: Support font styles for h1/h6 by [@Progi1984](https://github.com/Progi1984) fixing [#2619](https://github.com/PHPOffice/PHPWord/issues/2619) in [#2737](https://github.com/PHPOffice/PHPWord/pull/2737) - Writer EPub3: Basic support by [@Sambit003](https://github.com/Sambit003) fixing [#55](https://github.com/PHPOffice/PHPWord/issues/55) in [#2724](https://github.com/PHPOffice/PHPWord/pull/2724) - Writer Word2007: Added support for background and border color transparency in Text Box element by [@chudy20007](https://github.com/Chudy20007) in [#2555](https://github.com/PHPOffice/PHPWord/pull/2555) - Writer/Reader Word2007: Added support for the firstLineChars for Indentation by [@liuzhilinux](https://github.com/liuzhilinux) & [@Progi1984](https://github.com/Progi1984) in [#2753](https://github.com/PHPOffice/PHPWord/pull/2753) ### Bug fixes - Writer ODText: Support for images inside a textRun by [@Progi1984](https://github.com/Progi1984) fixing [#2240](https://github.com/PHPOffice/PHPWord/issues/2240) in [#2668](https://github.com/PHPOffice/PHPWord/pull/2668) - Allow vAlign and vMerge on Style\Cell to be set to null by [@SpraxDev](https://github.com/SpraxDev) fixing [#2673](https://github.com/PHPOffice/PHPWord/issues/2673) in [#2676](https://github.com/PHPOffice/PHPWord/pull/2676) - Reader HTML: Support for differents size units for table by [@Progi1984](https://github.com/Progi1984) fixing [#2384](https://github.com/PHPOffice/PHPWord/issues/2384), [#2701](https://github.com/PHPOffice/PHPWord/issues/2701) in [#2725](https://github.com/PHPOffice/PHPWord/pull/2725) - Reader Word2007: Respect paragraph indent units by [@tugmaks](https://github.com/tugmaks) & [@Progi1984](https://github.com/Progi1984) fixing [#507](https://github.com/PHPOffice/PHPWord/issues/507) in [#2726](https://github.com/PHPOffice/PHPWord/pull/2726) - Reader Word2007: Support Header elements within Title elements by [@SpraxDev](https://github.com/SpraxDev) fixing [#2616](https://github.com/PHPOffice/PHPWord/issues/2616), [#2426](https://github.com/PHPOffice/PHPWord/issues/2426) in [#2674](https://github.com/PHPOffice/PHPWord/pull/2674) - Reader HTML: Support for inherit value for property line-height by [@Progi1984](https://github.com/Progi1984) fixing [#2683](https://github.com/PHPOffice/PHPWord/issues/2683) in [#2733](https://github.com/PHPOffice/PHPWord/pull/2733) - Writer HTML: Fixed null string for Text Elements by [@armagedon007](https://github.com/armagedon007) and [@Progi1984](https://github.com/Progi1984) in [#2738](https://github.com/PHPOffice/PHPWord/pull/2738) - Template Processor: Fix 0 considered as empty string by [@cavasinf](https://github.com/cavasinf), [@SnipsMine](https://github.com/SnipsMine) and [@Progi1984](https://github.com/Progi1984) fixing [#2572](https://github.com/PHPOffice/PHPWord/issues/2572), [#2703](https://github.com/PHPOffice/PHPWord/issues/2703) in [#2748](https://github.com/PHPOffice/PHPWord/pull/2748) - Word2007 Writer : Corrected generating TOC to fix page number missing issues [@jgiacomello](https://github.com/jgiacomello) in [#2556](https://github.com/PHPOffice/PHPWord/pull/2556) - Enhanced error handling in encoding functions [@michalschroeder](https://github.com/michalschroeder) in [#2784](https://github.com/PHPOffice/PHPWord/pull/2784) ### Miscellaneous - Bump dompdf/dompdf from 2.0.4 to 3.0.0 by [@dependabot](https://github.com/dependabot) fixing [#2621](https://github.com/PHPOffice/PHPWord/issues/2621) in [#2666](https://github.com/PHPOffice/PHPWord/pull/2666) - Add test case to make sure vMerge defaults to 'continue' by [@SpraxDev](https://github.com/SpraxDev) in [#2677](https://github.com/PHPOffice/PHPWord/pull/2677) - Adding the possibility to use iterate search and replace with setValues by [@moghwan](https://github.com/moghwan) in [#2632](https://github.com/PHPOffice/PHPWord/pull/2640) - Add test cases that test the ODTText and Word2007 reader using the corresponding writer, increasing test coverage by [@MichaelPFrey](https://github.com/MichaelPFrey) in [#2745](https://github.com/PHPOffice/PHPWord/pull/2745) - Updated TOCTest to use static HTML content instead of external resource [@michalschroeder](https://github.com/michalschroeder) in [#2784](https://github.com/PHPOffice/PHPWord/pull/2784) - Bump PHPOffice/math from 0.2.0 to 0.3.0 by [@eileenmcnaughton](https://github.com/eileenmcnaughton) in [#2785](https://github.com/PHPOffice/PHPWord/pull/2785) ### Deprecations - Deprecate `PhpOffice\PhpWord\Style\Paragraph::getIndent()` : Use `PhpOffice\PhpWord\Style\Paragraph::getIndentLeft()` - Deprecate `PhpOffice\PhpWord\Style\Paragraph::setHanging()` : Use `PhpOffice\PhpWord\Style\Paragraph::setIndentHanging()` - Deprecate `PhpOffice\PhpWord\Style\Paragraph::setIndent()` : Use `PhpOffice\PhpWord\Style\Paragraph::setIndentLeft()` ### BC Breaks ### Notes - Writer ODText previously used to set 'style:use-window-font-color' to 'true', now it is set to 'false'. (see [#2735](https://github.com/PHPOffice/PHPWord/pull/2735)) The effect of this attribute is "implementation dependent" (if implemented at all). Setting it to false allows setting a default font color and improves interoperabilt, but may break certain specific use cases. ================================================ FILE: docs/changes/1.x/1.5.0.md ================================================ # [1.5.0](https://github.com/PHPOffice/PHPWord/tree/1.5.0) (WIP) [Full Changelog](https://github.com/PHPOffice/PHPWord/compare/1.4.0...1.5.0) ## Enhancements ### Bug fixes - Set writeAttribute return type by [@radarhere](https://github.com/radarhere) fixing [#2204](https://github.com/PHPOffice/PHPWord/issues/2204) in [#2776](https://github.com/PHPOffice/PHPWord/pull/2776) ### Miscellaneous - Update phpstan/phpstan requirement from ^0.12.88 || ^1.0.0 to ^0.12.88 || ^1.0.0 || ^2.0.0 by [@dependabot](https://github.com/dependabot) & [@Progi1984](https://github.com/Progi1984) in [#2736](https://github.com/PHPOffice/PHPWord/pull/2736) ### Deprecations ### BC Breaks ### Notes ================================================ FILE: docs/credits.md ================================================ # Credits Images from chart page come from the [LibreOffice Core](https://github.com/LibreOffice/core/tree/master/icon-themes/galaxy/chart2/res). Some definitions come from the [Office Open XML](http://officeopenxml.com). ## References ### OpenXML Known as "ISO/IEC 29500, Third edition, 2012-09-01" ISO : - [Part 1: Fundamentals and Markup Language Reference](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061750_ISO_IEC_29500-1_2012.zip) - [Part 2: Open Packaging Conventions](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061796_ISO_IEC_29500-2_2012.zip) - [Part 3: Markup Compatibility and Extensibility](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061797_ISO_IEC_29500-3_2012.zip) - [Part 4: Transitional Migration Features](http://standards.iso.org/ittf/PubliclyAvailableStandards/c061798_ISO_IEC_29500-4_2012.zip) MSDN : - [Open XML SDK 2.5 with Validator](http://www.microsoft.com/en-gb/download/details.aspx?id=30425) - [DocumentFormat.OpenXml.Wordprocessing Namespace on MSDN](http://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing%28v=office.14%29.aspx) Library of Congress : - [OOXML Format Family -- ISO/IEC 29500 and ECMA 376](https://www.loc.gov/preservation/digital/formats/fdd/fdd000395.shtml) - [Schemas in W3C XML Schema language and in RELAX NG for the Strict variant of PPTX, etc.](http://standards.iso.org/ittf/PubliclyAvailableStandards/c071691_ISO_IEC_29500-1_2016_Electronic_inserts.zip) ### OpenDocument - [Oasis OpenDocument Standard Version 1.2](http://docs.oasis-open.org/office/v1.2/os/OpenDocument-v1.2-os.html) - [Schema Central Open Document 1.1](http://www.datypic.com/sc/odf/ss.html) ### Rich Text Format - [Rich Text Format (RTF) Specification, version 1.9.1](http://www.microsoft.com/en-us/download/details.aspx?id=10725) ### Word 97 ================================================ FILE: docs/faq.md ================================================ # Frequently asked questions ## How contribute to PHPWord? - Improve the documentation ================================================ FILE: docs/howto.md ================================================ # How to ## Create float left image Use absolute positioning relative to margin horizontally and to line vertically. ``` php 40, 'height' => 40, 'wrappingStyle' => 'square', 'positioning' => 'absolute', 'posHorizontalRel' => 'margin', 'posVerticalRel' => 'line', ); $textrun->addImage(__DIR__ . '/resources/_earth.jpg', $imageStyle); ``` ## Download the produced file automatically Use ``php://output`` as the filename. ``` php addSection(); $section->addText('Hello World!'); $file = 'HelloWorld.docx'; header("Content-Description: File Transfer"); header('Content-Disposition: attachment; filename="' . $file . '"'); header('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document'); header('Content-Transfer-Encoding: binary'); header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); header('Expires: 0'); $xmlWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007'); $xmlWriter->save("php://output"); ``` ## Create numbered headings Define a numbering style and title styles, and match the two styles (with ``pStyle`` and ``numStyle``) like below. ``` php addNumberingStyle( 'hNum', array('type' => 'multilevel', 'levels' => array( array('pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'), array('pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'), array('pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'), ) ) ); $phpWord->addTitleStyle(1, array('size' => 16), array('numStyle' => 'hNum', 'numLevel' => 0)); $phpWord->addTitleStyle(2, array('size' => 14), array('numStyle' => 'hNum', 'numLevel' => 1)); $phpWord->addTitleStyle(3, array('size' => 12), array('numStyle' => 'hNum', 'numLevel' => 2)); $section->addTitle('Heading 1', 1); $section->addTitle('Heading 2', 2); $section->addTitle('Heading 3', 3); ``` ## Add a link within a title Apply 'HeadingN' paragraph style to TextRun or Link. Sample code: ``` php addTitleStyle(1, array('size' => 16, 'bold' => true)); $phpWord->addTitleStyle(2, array('size' => 14, 'bold' => true)); $phpWord->addFontStyle('Link', array('color' => '0000FF', 'underline' => 'single')); $section = $phpWord->addSection(); // Textrun $textrun = $section->addTextRun('Heading1'); $textrun->addText('The '); $textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord', 'Link'); // Link $section->addLink('https://github.com/', 'GitHub', 'Link', 'Heading2'); ``` ## Remove [Compatibility Mode] text in the MS Word title bar Use the ``Metadata\Compatibility\setOoxmlVersion(n)`` method with ``n`` is the version of Office: * 14 = Office 2010 * 15 = Office 2013 ``` php getCompatibility()->setOoxmlVersion(15); ``` ================================================ FILE: docs/index.md ================================================ # ![PHPWord](images/phpword.svg) 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](http://en.wikipedia.org/wiki/Office_Open_XML)(`.docx`), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (`.odt`), [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (`.rtf`), [Microsoft Word Binary File](https://en.wikipedia.org/wiki/Doc_(computing)) (`.doc`), HTML (`.html`), and PDF (`.pdf`). PHPWord is an open source project licensed under the terms of [LGPL version 3](https://github.com/PHPOffice/PHPWord/blob/master/COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration and unit testing](https://github.com/PHPOffice/PHPWord/actions/workflows/php.yml). You can learn more about PHPWord by reading this Developers'Documentation. ## Features - 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 ## File formats Below are the supported features for each file formats. ### Writers | Features | | OOXML | ODF | RTF | HTML | PDF | |---------------------------|----------------------|--------|-------|-------|--------|--------| | **Document Properties** | Standard | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Custom | :material-check: | :material-check: | | | | | **Element Type** | Text | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Text Run | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Title | :material-check: | :material-check: | | :material-check: | :material-check: | | | Link | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Preserve Text | :material-check: | | | | | | | Text Break | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Page Break | :material-check: | | :material-check: | | | | | List | :material-check: | :material-check: | | | | | | Table | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Image | :material-check: | :material-check: | :material-check: | :material-check: | | | | Object | :material-check: | | | | | | | Watermark | :material-check: | | | | | | | Table of Contents | :material-check: | | | | | | | Header | :material-check: | | | | | | | Footer | :material-check: | | | | | | | Footnote | :material-check: | | | :material-check: | | | | Endnote | :material-check: | | | :material-check: | | | | Comments | :material-check: | | | | | | **Graphs** | 2D basic graphs | :material-check: | | | | | | | 2D advanced graphs | | | | | | | | 3D graphs | :material-check: | | | | | | **Math** | OMML support | :material-check: | | | | | | | MathML support | | :material-check: | | | | | **Bonus** | Encryption | | | | | | | | Protection | | | | | | ### Readers | Features | | OOXML | DOC | ODF | RTF | HTML | |---------------------------|----------------------|--------|-------|-------|-------|-------| | **Document Properties** | Standard | :material-check: | | | | | | | Custom | :material-check: | | | | | | **Element Type** | Text | :material-check: | :material-check: | :material-check: | :material-check: | :material-check: | | | Text Run | :material-check: | | | | | | | Title | :material-check: | | :material-check: | | | | | Link | :material-check: | :material-check: | | | | | | Preserve Text | :material-check: | | | | | | | Text Break | :material-check: | :material-check: | | | | | | Page Break | :material-check: | | | | | | | List | :material-check: | | :material-check: | | :material-check: | | | Table | :material-check: | | | | :material-check: | | | Image | :material-check: | :material-check: | | | | | | Object | | | | | | | | Watermark | | | | | | | | Table of Contents | | | | | | | | Header | :material-check: | | | | | | | Footer | :material-check: | | | | | | | Footnote | :material-check: | | | | | | | Endnote | :material-check: | | | | | | | Comments | :material-check: | | | | | | **Graphs** | 2D basic graphs | | | | | | | | 2D advanced graphs | | | | | | | | 3D graphs | | | | | | | **Math** | OMML support | :material-check: | | | | | | | MathML support | | :material-check: | | | | | **Bonus** | Encryption | | | | | | | | Protection | | | | | | ## Contributing We welcome everyone to contribute to PHPWord. Below are some of the things that you can do to contribute: - Read [our contributing guide](https://github.com/PHPOffice/PHPWord/blob/master/CONTRIBUTING.md) - [Fork us](https://github.com/PHPOffice/PHPWord/fork) and [request a pull](https://github.com/PHPOffice/PHPWord/pulls) to the [master](https://github.com/PHPOffice/PHPWord/tree/master) branch - Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub - Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter ================================================ FILE: docs/install.md ================================================ # Installation ## Requirements Mandatory: - PHP 7.1+ - PHP [DOM extension](http://php.net/manual/en/book.dom.php) - PHP [JSON extension](http://php.net/manual/en/book.json.php) - PHP [XML Parser extension](http://www.php.net/manual/en/xml.installation.php) - PHP [XMLWriter extension](http://php.net/manual/en/book.xmlwriter.php) ## Installation There are two ways to install PHPWord, i.e. via [Composer](http://getcomposer.org) or manually by downloading the library. ### Using Composer To install via Composer, add the following lines to your `composer.json`: ``` json { "require": { "phpoffice/phpword": "dev-master" } } ``` ### Using manual install To install manually: * [download PHPOffice\PHPWord package from GitHub](https://github.com/PHPOffice/PHPWord/archive/master.zip) * extract the package and put the contents to your machine. ``` php addSection($sectionStyle); ``` The ``$sectionStyle`` is an optional associative array that sets the section. Example: ``` php 'landscape', 'marginTop' => 600, 'colsNum' => 2, ); ``` ### Page number You can change a section page number by using the ``pageNumberingStart`` style of the section. ``` php addSection(array('pageNumberingStart' => 1)); // Method 2 $section = $phpWord->addSection(); $section->getStyle()->setPageNumberingStart(1); ``` ### Multicolumn You can change a section layout to multicolumn (like in a newspaper) by using the ``breakType`` and ``colsNum`` style of the section. ``` php addSection(array('breakType' => 'continuous', 'colsNum' => 2)); // Method 2 $section = $phpWord->addSection(); $section->getStyle()->setBreakType('continuous'); $section->getStyle()->setColsNum(2); ``` ### Line numbering You can apply line numbering to a section by using the ``lineNumbering`` style of the section. ``` php addSection(array('lineNumbering' => array())); // Method 2 $section = $phpWord->addSection(); $section->getStyle()->setLineNumbering(array()); ``` Below are the properties of the line numbering style. - ``start`` Line numbering starting value - ``increment`` Line number increments - ``distance`` Distance between text and line numbering in *twip* - ``restart`` Line numbering restart setting continuous\|newPage\|newSection ## Headers Each section can have its own header reference. To create a header use the ``addHeader`` method: ``` php addHeader(); ``` Be 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::AUTO`` default, all pages except if overridden by first or even - ``Footer::FIRST`` each first page of the section - ``Footer::EVEN`` each 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 getSettings()->setEvenAndOddHeaders(true); ``` ## Footers Each section can have its own footer reference. To create a footer, use the ``addFooter`` method: ``` php addFooter(); ``` Be sure to save the result in a local object to add elements to a footer. You can add the following elements to footers: - Texts ``addText`` and ``createTextrun`` - Text breaks - Images - Tables - Preserve text See the "Elements" section for the detail of each elements. ### Other containers Textruns, table cells, and footnotes are elements that can also act as containers. See the corresponding "Elements" section for the detail of each elements. ================================================ FILE: docs/usage/elements/chart.md ================================================ # Chart Charts can be added using ``` php addChart('line', $categories, $series, $style); ``` For available styling options, see [`Styles > Chart`](../styles/chart.md). Check out the Sample_32_Chart.php for more options and styling. ================================================ FILE: docs/usage/elements/checkbox.md ================================================ # Checkbox Checkbox elements can be added to sections or table cells by using ``addCheckBox``. ``` php addCheckBox($name, $text, [$fontStyle], [$paragraphStyle]); ``` - ``$name``. Name of the check box. - ``$text``. Text to be displayed in the document. - ``$fontStyle``. See [`Styles > Font`](../styles/font.md). - ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). ================================================ FILE: docs/usage/elements/comment.md ================================================ # Comment 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 ``setCommentRangeStart``. ``` php addText('Test', array('bold' => true)); // add it to the document $phpWord->addComment($comment); $textrun = $section->addTextRun(); $textrun->addText('This '); $text = $textrun->addText('is'); // link the comment to the text you just created $text->setCommentRangeStart($comment); $textrun->addText(' a test'); ``` If no end is set for a comment using the ``setCommentRangeEnd``, the comment will be ended automatically at the end of the element it is started on. ================================================ FILE: docs/usage/elements/field.md ================================================ # Field Currently the following fields are supported: - PAGE - NUMPAGES - DATE - XE - INDEX - FILENAME - REF ``` php addField($fieldType, [$properties], [$options], [$fieldText], [$fontStyle]) ``` - ``$fontStyle``. See [`Styles > Font`](../styles/font.md). 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 `_ ): ``` php addText('My '); $fieldText->addText('bold index', ['bold' => true]); $fieldText->addText(' entry'); $section->addField('XE', array(), array(), $fieldText); // this actually adds the index $section->addField('INDEX', array(), array('\\e " " \\h "A" \\c "3"'), 'right click to update index'); // Adding reference to a bookmark $fieldText->addField('REF', [ 'name' => 'bookmark' ], [ 'InsertParagraphNumberRelativeContext', 'CreateHyperLink', ]); ``` ================================================ FILE: docs/usage/elements/formula.md ================================================ # Formula Formula can be added using ``` php setDenominator(new Element\Numeric(2)) ->setNumerator(new Element\Identifier('π')) ; $math = new Math(); $math->add($fraction); $formula = $section->addFormula($math); ``` ================================================ FILE: docs/usage/elements/image.md ================================================ # Image To add an image, use the ``addImage`` method to sections, headers, footers, textruns, or table cells. ``` php addImage($src, [$style]); ``` - ``$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``. See [`Styles > Image`](../styles/image.md). Examples: ``` php addSection(); $section->addImage( 'mars.jpg', array( 'width' => 100, 'height' => 100, 'marginTop' => -1, 'marginLeft' => -1, 'wrappingStyle' => 'behind' ) ); $footer = $section->addFooter(); $footer->addImage('http://example.com/image.php'); $textrun = $section->addTextRun(); $textrun->addImage('http://php.net/logo.jpg'); $source = file_get_contents('/path/to/my/images/earth.jpg'); $textrun->addImage($source); ``` ================================================ FILE: docs/usage/elements/index.md ================================================ # Elements Below 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](text.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 2 | Text Run | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | | 3 | [Link](link.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 4 | [Title](title.md) | :white_check_mark: | :question: | :question: | :question: | :question: | :question: | | 5 | [Preserve Text](preservetext.md) | :question: | :white_check_mark: | :white_check_mark: | :material-check-decagram-outline: | :red_circle: | :red_circle: | | 6 | [Text Break](textbreak.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 7 | [Page Break](pagebreak.md) | :white_check_mark: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | | 8 | [List](list.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | | 9 | [Table](table.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | | 10 | [Image](image.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 11 | [Watermark](watermark.md) | :red_circle: | :white_check_mark: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | | 12 | [OLEObject](oleobject.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 13 | [TOC](toc.md) | :white_check_mark: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | :red_circle: | | 14 | [Footnote](note.md) | :white_check_mark: | :red_circle: | :red_circle: | :material-check-decagram: | :material-check-decagram: | :red_circle: | | 15 | [Endnote](note.md) | :white_check_mark: | :red_circle: | :red_circle: | :material-check-decagram: | :material-check-decagram: | :red_circle: | | 16 | [CheckBox](checkbox.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | | 17 | [TextBox](textbox.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :red_circle: | :red_circle: | | 18 | [Field](field.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 19 | [Line](line.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | 20 | [Chart](chart.md) | :white_check_mark: | | | :white_check_mark: | | | Legend: - :white_check_mark: : Available. - :material-check-decagram-outline: : Available only when inside header/footer. - :material-check-decagram: : Available only when inside section. - :red_circle: : Not available. - :question: : Should be available. ================================================ FILE: docs/usage/elements/line.md ================================================ # Line Line elements can be added to sections by using ``addLine``. ``` php 1, 'width' => 100, 'height' => 0, 'color' => 635552); $section->addLine($lineStyle); ``` Available 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. ================================================ FILE: docs/usage/elements/link.md ================================================ # Link You can add Hyperlinks to the document by using the function addLink: ``` php addLink($linkSrc, [$linkName], [$fontStyle], [$paragraphStyle]); ``` - ``$linkSrc``. The URL of the link. - ``$linkName``. Placeholder of the URL that appears in the document. - ``$fontStyle``. See [`Styles > Font`](../styles/font.md). - ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). ================================================ FILE: docs/usage/elements/list.md ================================================ # List 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 addListItem($text, [$depth], [$fontStyle], [$listStyle], [$paragraphStyle]); $listItemRun = $section->addListItemRun([$depth], [$listStyle], [$paragraphStyle]) ``` Parameters: - ``$text``. Text that appears in the document. - ``$depth``. Depth of list item. - ``$fontStyle``. See [`Styles > Font`](../styles/font.md).. - ``$listStyle``. List style of the current element TYPE\_NUMBER, TYPE\_ALPHANUM, TYPE\_BULLET\_FILLED, etc. See list of constants in PHPWord\\Style\\ListItem. - ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md).. 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 addNumberingStyle( 'multilevel', array( 'type' => 'multilevel', 'levels' => array( array('format' => 'decimal', 'text' => '%1.', 'left' => 360, 'hanging' => 360, 'tabPos' => 360), array('format' => 'upperLetter', 'text' => '%2.', 'left' => 720, 'hanging' => 360, 'tabPos' => 720), ) ) ); $section->addListItem('List Item I', 0, null, 'multilevel'); $section->addListItem('List Item I.a', 1, null, 'multilevel'); $section->addListItem('List Item I.b', 1, null, 'multilevel'); $section->addListItem('List Item II', 0, null, 'multilevel'); ``` For available styling options see [`Styles > Numbering Level`](../styles/numberinglevel.md). ================================================ FILE: docs/usage/elements/note.md ================================================ # Footnote & Endnote You can create footnotes with ``addFootnote`` and endnotes with``addEndnote`` 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 addTextRun(); $textrun->addText('Lead text.'); $footnote = $textrun->addFootnote(); $footnote->addText('Footnote text can have '); $footnote->addLink('http://test.com', 'links'); $footnote->addText('.'); $footnote->addTextBreak(); $footnote->addText('And text break.'); $textrun->addText('Trailing text.'); $endnote = $textrun->addEndnote(); $endnote->addText('Endnote put at the end'); ``` On text: ``` php addText('Lead text.'); $footnote = $section->addFootnote(); $footnote->addText('Footnote text.'); ``` By 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 setPos(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::POSITION_BENEATH_TEXT); //set the number format to use (decimal (default), upperRoman, upperLetter, ...) $fp->setNumFmt(\PhpOffice\PhpWord\SimpleType\NumberFormat::LOWER_ROMAN); //force starting at other than 1 $fp->setNumStart(2); //when to restart counting (continuous (default), eachSect, eachPage) $fp->setNumRestart(\PhpOffice\PhpWord\ComplexType\FootnoteProperties::RESTART_NUMBER_EACH_PAGE); //And finaly, set it on the Section $section->setFootnoteProperties($fp); ``` ================================================ FILE: docs/usage/elements/oleobject.md ================================================ # Object You can add OLE embeddings, such as Excel spreadsheets or PowerPoint presentations to the document by using ``addOLEObject`` method. ``` php addOLEObject($src, [$style]); ``` ================================================ FILE: docs/usage/elements/pagebreak.md ================================================ # Page breaks There are two ways to insert a page break, using the ``addPageBreak`` method or using the ``pageBreakBefore`` style of paragraph. ``` php addPageBreak(); ``` ================================================ FILE: docs/usage/elements/preservetext.md ================================================ # Preserve text The ``addPreserveText`` method is used to add a page number or page count to headers or footers. ``` php addPreserveText('Page {PAGE} of {NUMPAGES}.'); ``` ================================================ FILE: docs/usage/elements/ruby.md ================================================ # Ruby Ruby (phonetic guide) text can be added by using the ``addRuby`` method. Ruby elements require a ``RubyProperties`` object, a ``TextRun`` for the base text, and a ``TextRun`` for the actual ruby (phonetic guide) text. Here is one example for a complete ruby element setup: ``` php addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $section->addRuby($baseTextRun, $rubyTextRun, $properties); ``` - ``$baseTextRun``. ``TextRun`` to be used for the base text. - ``$rubyTextRun``. ``TextRun`` to be used for the ruby text. - ``$properties``. ``RubyProperties`` properties object for the ruby text. A title with a phonetic guide is a little more complex, but still possible. Make sure you add the appropraite title style to your document. ```php $phpWord = new PhpWord(); $fontStyle = new Font(); $fontStyle->setAllCaps(true); $fontStyle->setBold(true); $fontStyle->setSize(24); $phpWord->addTitleStyle(1, ['name' => 'Arial', 'size' => 24, 'bold' => true, 'color' => '990000']); $section = $phpWord->addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $textRun = new TextRun(); $textRun->addRuby($baseTextRun, $rubyTextRun, $properties); $section->addTitle($textRun, 1); ``` ================================================ FILE: docs/usage/elements/table.md ================================================ # Table To add tables, rows, and cells, use the ``addTable``, ``addRow``, and ``addCell`` methods: ``` php addTable([$tableStyle]); $table->addRow([$height], [$rowStyle]); $cell = $table->addCell($width, [$cellStyle]); ``` Table style can be defined with ``addTableStyle``: ``` php '006699', 'borderSize' => 6, 'cellMargin' => 50 ); $firstRowStyle = array('bgColor' => '66BBFF'); $phpWord->addTableStyle('myTable', $tableStyle, $firstRowStyle); $table = $section->addTable('myTable'); ``` For available styling options see [`Styles > Table`](../styles/table.md). ## Cell span You can span a cell on multiple columns by using ``gridSpan`` or multiple rows by using ``vMerge``. ``` php addCell(200); $cell->getStyle()->setGridSpan(5); ``` See ``Sample_09_Tables.php`` for more code sample. ================================================ FILE: docs/usage/elements/text.md ================================================ # Text 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 addText($text, [$fontStyle], [$paragraphStyle]); $textrun = $section->addTextRun([$paragraphStyle]); ``` - ``$text``. Text to be displayed in the document. - ``$fontStyle``. See [`Styles > Font`](../styles/font.md). - ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). For available styling options, see [`Styles > Font`](../styles/font.md) and [`Styles > Paragraph`](../styles/paragraph.md). 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 addText('Hello World!'); $text->setChanged(\PhpOffice\PhpWord\Element\ChangedElement::TYPE_INSERTED, 'Fred', (new \DateTime())); ``` ================================================ FILE: docs/usage/elements/textbox.md ================================================ # TextBox To Be Completed... ================================================ FILE: docs/usage/elements/textbreak.md ================================================ # Text breaks Text breaks are empty new lines. To add text breaks, use the following syntax. All parameters are optional. ``` php addTextBreak([$breakCount], [$fontStyle], [$paragraphStyle]); ``` - ``$breakCount``. How many lines. - ``$fontStyle``. See [`Styles > Font`](../styles/font.md). - ``$paragraphStyle``. See [`Styles > Paragraph`](../styles/paragraph.md). ================================================ FILE: docs/usage/elements/title.md ================================================ # Title 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 addTitleStyle($depth, [$fontStyle], [$paragraphStyle]); $section->addTitle($text, $depth, $pageNumber); ``` `addTitleStyle` : - ``$depth`` - ``$fontStyle``: See [`Styles > Font`](../styles/font.md). - ``$paragraphStyle``: See [`Styles > Paragraph`](../styles/paragraph.md). `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. ================================================ FILE: docs/usage/elements/toc.md ================================================ # Table of contents 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](title.md)"). ``` php addTOC([$fontStyle], [$tocStyle], [$minDepth], [$maxDepth]); ``` - ``$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*. ================================================ FILE: docs/usage/elements/trackchanges.md ================================================ # Track Changes 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 addSection(); $textRun = $section->addTextRun(); $text = $textRun->addText('Hello World! Time to '); $text = $textRun->addText('wake ', array('bold' => true)); $text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800); $text = $textRun->addText('up'); $text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred')); $text = $textRun->addText('go to sleep'); $text->setChangeInfo(TrackChange::DELETED, 'Barney', new \DateTime('@' . (time() - 3600))); ``` ================================================ FILE: docs/usage/elements/watermark.md ================================================ # Watermark To 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 addSection(); $header = $section->addHeader(); $header->addWatermark('resources/_earth.jpg', array('marginTop' => 200, 'marginLeft' => 55)); ``` ================================================ FILE: docs/usage/introduction.md ================================================ # Introduction ## Basic example The following is a basic example of the PHPWord library. More examples are provided in the [samples folder](https://github.com/PHPOffice/PHPWord/tree/master/samples/). ``` php addSection(); // Adding Text element to the Section having font styled by default... $section->addText( '"Learn from yesterday, live for today, hope for tomorrow. ' . 'The important thing is not to stop questioning." ' . '(Albert Einstein)' ); /* * Note: it's possible to customize font style of the Text element you add in three ways: * - inline; * - using named font style (new font style object will be implicitly created); * - using explicitly created font style object. */ // Adding Text element with font customized inline... $section->addText( '"Great achievement is usually born of great sacrifice, ' . 'and is never the result of selfishness." ' . '(Napoleon Hill)', array('name' => 'Tahoma', 'size' => 10) ); // Adding Text element with font customized using named font style... $fontStyleName = 'oneUserDefinedStyle'; $phpWord->addFontStyle( $fontStyleName, array('name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true) ); $section->addText( '"The greatest accomplishment is not in never falling, ' . 'but in rising again after you fall." ' . '(Vince Lombardi)', $fontStyleName ); // Adding Text element with font customized using explicitly created font style object... $fontStyle = new \PhpOffice\PhpWord\Style\Font(); $fontStyle->setBold(true); $fontStyle->setName('Tahoma'); $fontStyle->setSize(13); $myTextElement = $section->addText('"Believe you can and you\'re halfway there." (Theodor Roosevelt)'); $myTextElement->setFontStyle($fontStyle); // Saving the document as OOXML file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'Word2007'); $objWriter->save('helloWorld.docx'); // Saving the document as ODF file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'ODText'); $objWriter->save('helloWorld.odt'); // Saving the document as HTML file... $objWriter = \PhpOffice\PhpWord\IOFactory::createWriter($phpWord, 'HTML'); $objWriter->save('helloWorld.html'); /* Note: we skip RTF, because it's not XML-based and requires a different example. */ /* Note: we skip PDF, because "HTML-to-PDF" approach is used to create PDF documents. */ ``` ## PHPWord Settings The ``PhpOffice\PhpWord\Settings`` class provides some options that will affect the behavior of PHPWord. Below are the options. ### XML Writer compatibility This option sets [XMLWriter::setIndent](http://www.php.net/manual/en/function.xmlwriter-set-indent.php) and [XMLWriter::setIndentString](http://www.php.net/manual/en/function.xmlwriter-set-indent-string.php>). The default value of this option is ``true`` (compatible), which is [required for OpenOffice](https://github.com/PHPOffice/PHPWord/issues/103) to render OOXML document correctly. You can set this option to ``false`` during development to make the resulting XML file easier to read. ``` php setDefaultFontName('Times New Roman'); $phpWord->setDefaultFontColor('FF0000'); $phpWord->setDefaultFontSize(12); ``` Or you can specify Asian Font ``` php setDefaultAsianFontName('標楷體'); ``` ## Document settings Settings for the generated document can be set using ``$phpWord->getSettings()`` ### Magnification Setting The default zoom value is 100 percent. This can be changed either to another percentage ``` php getSettings()->setZoom(75); ``` Or to predefined values ``fullPage``, ``bestFit``, ``textFit`` ``` php getSettings()->setZoom(Zoom::BEST_FIT); ``` ### Mirroring the Page Margins Use mirror margins to set up facing pages for double-sided documents, such as books or magazines. ``` php getSettings()->setMirrorMargins(true); ``` !!! note annotate "Don'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 getSettings()->setMirrorMargins(true); $phpWord->addSection([ 'paperSize' => 'A4', 'orientation' => 'landscape', 'pageSizeW' => Converter::cmToTwip(14.85), 'pageSizeH' => Converter::cmToTwip(21), ]); ``` ### Printing as folded booklet Use book-fold printing to set up documents to be printed as foldable pages. ``` php getSettings()->setBookFoldPrinting(true); ``` ### Spelling and grammatical checks By 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 getSettings()->setHideGrammaticalErrors(true); $phpWord->getSettings()->setHideSpellingErrors(true); ``` You 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 setGrammar(\PhpOffice\PhpWord\ComplexType\ProofState::CLEAN); $proofState->setSpelling(\PhpOffice\PhpWord\ComplexType\ProofState::DIRTY); $phpWord->getSettings()->setProofState($proofState); ``` ### Track Revisions Track 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 getSettings()->setTrackRevisions(true); $phpWord->getSettings()->setDoNotTrackMoves(true); $phpWord->getSettings()->setDoNotTrackFormatting(true); ``` ### Decimal Symbol The default symbol to represent a decimal figure is the ``.`` in english. In french you might want to change it to ``,`` for instance. ``` php getSettings()->setDecimalSymbol(','); ``` ### Document Language The default language of the document can be change with the following. ``` php getSettings()->setThemeFontLang(new Language(Language::FR_BE)); ``` ``Language`` 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 setLangId(Language::EN_GB_ID); $phpWord->getSettings()->setThemeFontLang($lang); ``` ## Document information You can set the document information such as title, creator, and company name. Use the following functions: ``` php getDocInfo(); $properties->setCreator('My name'); $properties->setCompany('My factory'); $properties->setTitle('My title'); $properties->setDescription('My description'); $properties->setCategory('My category'); $properties->setLastModifiedBy('My name'); $properties->setCreated(mktime(0, 0, 0, 3, 12, 2014)); $properties->setModified(mktime(0, 0, 0, 3, 14, 2014)); $properties->setSubject('My subject'); $properties->setKeywords('my, key, word'); ``` ## Measurement units The 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 addParagraphStyle('My Style', array( 'spaceAfter' => \PhpOffice\PhpWord\Shared\Converter::pointToTwip(6)) ); $section = $phpWord->addSection(); $sectionStyle = $section->getStyle(); // half inch left margin $sectionStyle->setMarginLeft(\PhpOffice\PhpWord\Shared\Converter::inchToTwip(.5)); // 2 cm right margin $sectionStyle->setMarginRight(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(2)); ``` ## Document protection The document (or parts of it) can be password protected. ``` php getSettings()->getDocumentProtection(); $documentProtection->setEditing(DocProtect::READ_ONLY); $documentProtection->setPassword('myPassword'); ``` ## Automatically Recalculate Fields on Open To force an update of the fields present in the document, set updateFields to true ``` php getSettings()->setUpdateFields(true); ``` ## Hyphenation Hyphenation describes the process of breaking words with hyphens. There are several options to control hyphenation. ### Auto hyphenation To automatically hyphenate text set ``autoHyphenation`` to ``true``. ``` php getSettings()->setAutoHyphenation(true); ``` ### Consecutive Hyphen Limit The 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 getSettings()->setConsecutiveHyphenLimit(2); ``` ### Hyphenation Zone The 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 getSettings()->setHyphenationZone(\PhpOffice\PhpWord\Shared\Converter::cmToTwip(1)); ``` ### Hyphenate Caps To control whether or not words in all capital letters shall be hyphenated use the `doNotHyphenateCaps` option. ``` php getSettings()->setDoNotHyphenateCaps(true); ``` ================================================ FILE: docs/usage/readers.md ================================================ # Readers ## HTML The name of the reader is `HTML`. ``` php load(__DIR__ . '/sample.html'); ``` ## MsDoc The name of the reader is `MsDoc`. ``` php load(__DIR__ . '/sample.doc'); ``` ## ODText The name of the reader is `ODText`. ``` php load(__DIR__ . '/sample.odt'); ``` ## RTF The name of the reader is `RTF`. ``` php load(__DIR__ . '/sample.rtf'); ``` ## Word2007 The name of the reader is `Word2007`. ``` php load(__DIR__ . '/sample.docx'); ``` ================================================ FILE: docs/usage/styles/chart.md ================================================ # Chart Available 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*. ================================================ FILE: docs/usage/styles/font.md ================================================ # Font 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 values - ``hint``. 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 values - ``lang``. 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\Language`` class for some language codes. - ``position``. The text position, raised or lowered, in half points - ``hidden``. 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). ================================================ FILE: docs/usage/styles/image.md ================================================ # Image Available Image style options: - ``alignment``. See ``\PhpOffice\PhpWord\SimpleType\Jc`` class 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. ================================================ FILE: docs/usage/styles/numberinglevel.md ================================================ # Numbering level 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\Jc`` class 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. ================================================ FILE: docs/usage/styles/paragraph.md ================================================ # Paragraph 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\Jc`` class 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*, *firstLineChars* and *hanging* indentation. See ``\PhpOffice\PhpWord\Style\Indentation`` for 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\LineSpacingRule`` class 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\TextAlignment`` class constants for possible values. ================================================ FILE: docs/usage/styles/section.md ================================================ # Section 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, or ``landscape``). See ``\PhpOffice\PhpWord\Style\Section::ORIENTATION_...`` class constants for possible values - ``pageSizeH``. Page height in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged. - ``pageSizeW``. Page width in *twip*. Implicitly defined by ``orientation`` option. Any changes are discouraged. - ``vAlign``. Vertical Page Alignment See ``\PhpOffice\PhpWord\SimpleType\VerticalJc`` for possible values ================================================ FILE: docs/usage/styles/table.md ================================================ # Table 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\JcTable`` and ``\PhpOffice\PhpWord\SimpleType\Jc`` class 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\Table`` for constants. - ``cellSpacing`` Cell spacing in *twip* - ``position`` Floating Table Positioning, see below for options - ``bidiVisual`` Present table as Right-To-Left Floating Table Positioning options: - ``leftFromText`` Distance From Left of Table to Text in *twip* - ``rightFromText`` Distance From Right of Table to Text in *twip* - ``topFromText`` Distance From Top of Table to Text in *twip* - ``bottomFromText`` Distance From Top of Table to Text in *twip* - ``vertAnchor`` Table Vertical Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::VANCHOR_*`` - ``horzAnchor`` Table Horizontal Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::HANCHOR_*`` - ``tblpXSpec`` Relative Horizontal Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::XALIGN_*`` - ``tblpX`` Absolute Horizontal Distance From Anchorin *twip* - ``tblpYSpec`` Relative Vertical Alignment From Anchor, one of ``\PhpOffice\PhpWord\Style\TablePosition::YALIGN_*`` - ``tblpY`` Absolute 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\Border`` - ``gridSpan``. Number of columns spanned. - ``textDirection(btLr|tbRl)``. Direction of text. You can use constants ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR`` and ``\PhpOffice\PhpWord\Style\Cell::TEXT_DIR_TBRL`` - ``valign``. Vertical alignment, *top*, *center*, *both*, *bottom*. - ``vMerge``. *restart* or *continue*. - ``width``. Cell width in *twip*. ================================================ FILE: docs/usage/template.md ================================================ # Template processing You 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 setValue('firstname', 'John'); $templateProcessor->setValue('lastname', 'Doe'); ``` ## setValues You can also set multiple values by passing all of them in an array. ``` php setValues(array('firstname' => 'John', 'lastname' => 'Doe')); ``` ## setCheckbox Given a template containing a checkbox control with the title or tag named: ``` clean ${checkbox} ``` The following will check the checkbox: ``` php setCheckbox('checkbox', true); ``` !!! note annotate "To add a checkbox and set its title or tag in a template" 1. Go to **Developer** tab > **Controls** group 2. Select the **Check Box Content Control** 3. Right-click on your checkbox 4. Click on **Properties** 5. Set the title or the tag These steps may change regarding the version of Microsoft Word used. ## setMacroOpeningChars You can define a custom opening macro. The following will set ``{#`` as the opening search pattern. ``` php setMacroOpeningChars('{#'); ``` ## setMacroClosingChars You can define a custom closing macro. The following will set ``#}`` as the closing search pattern. ``` php setMacroClosingChars('#}'); ``` ## setMacroChars You can define a custom opening and closing macro at the same time . The following will set the search-pattern like this: ``{#search-pattern#}`` . ``` php setMacroChars('{#', '#}'); ``` ## setImageValue The 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: ``` clean ${CompanyLogo} ${UserLogo:50:50} ${Name} - ${City} - ${Street} ``` ``` php setValue('Name', 'John Doe'); $templateProcessor->setValue(array('City', 'Street'), array('Detroit', '12th Street')); $templateProcessor->setImageValue('CompanyLogo', 'path/to/company/logo.png'); $templateProcessor->setImageValue('UserLogo', array('path' => 'path/to/logo.png', 'width' => 100, 'height' => 100, 'ratio' => false)); $templateProcessor->setImageValue('FeatureImage', function () { // Closure will only be executed if the replacement tag is found in the template return array('path' => SlowFeatureImageGenerator::make(), 'width' => 100, 'height' => 100, 'ratio' => false); }); ``` ## cloneBlock Given a template containing See ``Sample_23_TemplateBlock.php`` for an example. ``` clean ${block_name} Customer: ${customer_name} Address: ${customer_address} ${/block_name} ``` The following will duplicate everything between ``${block_name}`` and ``${/block_name}`` 3 times. ``` php cloneBlock('block_name', 3, true, true); ``` The last parameter will rename any macro defined inside the block and add #1, #2, #3 ... to the macro name. The result will be ``` clean Customer: ${customer_name#1} Address: ${customer_address#1} Customer: ${customer_name#2} Address: ${customer_address#2} Customer: ${customer_name#3} Address: ${customer_address#3} ``` It 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 'Batman', 'customer_address' => 'Gotham City'), array('customer_name' => 'Superman', 'customer_address' => 'Metropolis'), ); $templateProcessor->cloneBlock('block_name', 0, true, false, $replacements); ``` The result will then be ``` clean Customer: Batman Address: Gotham City Customer: Superman Address: Metropolis ``` ## replaceBlock Given a template containing ``` clean ${block_name} This block content will be replaced ${/block_name} ``` The following will replace everything between ``${block_name}`` and ``${/block_name}`` with the value passed. ``` php replaceBlock('block_name', 'This is the replacement text.'); ``` ## deleteBlock Same as previous, but it deletes the block ``` php deleteBlock('block_name'); ``` ## cloneRow Clones a table row in a template document. See ``Sample_07_TemplateCloneRow.php`` for an example. ``` clean +-----------+----------------+ | ${userId} | ${userName} | | |----------------+ | | ${userAddress} | +-----------+----------------+ ``` ``` php cloneRow('userId', 2); ``` Will result in ``` clean +-------------+------------------+ | ${userId#1} | ${userName#1} | | |------------------+ | | ${userAddress#1} | +-------------+------------------+ | ${userId#2} | ${userName#2} | | |------------------+ | | ${userAddress#2} | +-------------+------------------+ ``` ## cloneRowAndSetValues Finds a row in a table row identified by `$search` param and clones it as many times as there are entries in `$values`. ``` clean +-----------+----------------+ | ${userId} | ${userName} | | |----------------+ | | ${userAddress} | +-----------+----------------+ ``` ``` php 1, 'userName' => 'Batman', 'userAddress' => 'Gotham City'], ['userId' => 2, 'userName' => 'Superman', 'userAddress' => 'Metropolis'], ]; $templateProcessor->cloneRowAndSetValues('userId', $values); ``` Will result in ``` clean +---+-------------+ | 1 | Batman | | |-------------+ | | Gotham City | +---+-------------+ | 2 | Superman | | |-------------+ | | Metropolis | +---+-------------+ ``` ## applyXslStyleSheet Applies the XSL stylesheet passed to header part, footer part and main part ``` php load('/path/to/my/stylesheet.xsl'); $templateProcessor->applyXslStyleSheet($xslDomDocument); ``` ## setComplexValue Replaces a ${macro} with the ComplexType passed. See ``Sample_40_TemplateSetComplexValue.php`` for examples. ``` php addText('by a red italic text', array('italic' => true, 'color' => 'red')); $templateProcessor->setComplexValue('inline', $inline); ``` ## setComplexBlock Replaces a ${macro} with the ComplexType passed. See ``Sample_40_TemplateSetComplexValue.php`` for examples. ``` php 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP)); $table->addRow(); $table->addCell(150)->addText('Cell A1'); $table->addCell(150)->addText('Cell A2'); $table->addCell(150)->addText('Cell A3'); $table->addRow(); $table->addCell(150)->addText('Cell B1'); $table->addCell(150)->addText('Cell B2'); $table->addCell(150)->addText('Cell B3'); $templateProcessor->setComplexBlock('table', $table); ``` ## setChartValue Replace a variable by a chart. ``` php setChartValue('myChart', $chart); ``` ## save Saves the loaded template within the current directory. Returns the file path. ``` php save(); ``` ## saveAs Saves a copy of the loaded template in the indicated path. ``` php saveAs($pathToSave); ``` ================================================ FILE: docs/usage/writers.md ================================================ # Writers ## HTML The name of the writer is `HTML`. ``` php save(__DIR__ . '/sample.html'); ``` When generating html/pdf, you can alter the default handling of white space (normal), and/or supply a fallback generic font as follows: ```php $writer = IOFactory::createWriter($oPhpWord, 'HTML'); $writer->setDefaultGenericFont('serif'); $writer->setDefaultWhiteSpace('pre-wrap'); $writer->save(__DIR__ . '/sample.html'); ``` ## ODText The name of the writer is `ODText`. ``` php save(__DIR__ . '/sample.docx'); ``` ## PDF The name of the writer is `PDF`. ``` php save(__DIR__ . '/sample.pdf'); ``` To generate a PDF, the PhpWord object passes through HTML before generating the PDF. This HTML can be modified using a callback. ``` php setEditCallback('cbEditHTML'); $writer->save(__DIR__ . '/sample.pdf'); /** * Add a meta tag generator */ function cbEditHTML(string $inputHTML): string { $beforeBody = ''; $needle = ''; $pos = strpos($inputHTML, $needle); if ($pos !== false) { $inputHTML = (string) substr_replace($inputHTML, "$beforeBody\n$needle", $pos, strlen($needle)); } return $inputHTML; } ``` ### Options You can define options like : * `font`: default font Options must be defined before creating the writer. ``` php 'Arial' ]); $writer = IOFactory::createWriter($oPhpWord, 'PDF'); $writer->save(__DIR__ . '/sample.pdf'); ``` #### Specify the PDF Renderer Before PHPWord can write a PDF, you **must** specify the renderer to use and the path to it. Currently, three renderers are supported: - [DomPDF](https://github.com/dompdf/dompdf) - [MPDF](https://mpdf.github.io/) - [TCPDF](https://tcpdf.org/) To specify the renderer you use two static `Settings` functions: - `setPdfRendererName`: This sets the name of the renderer library to use. Provide one of [`Settings`' three `PDF_` constants](https://github.com/PHPOffice/PHPWord/blob/master/src/PhpWord/Settings.php#L39-L41) to the function call. - `setPdfRendererPath`: This sets the path to the renderer library. This directory is the renderer's package directory within Composer's _vendor_ directory. In the code below, you can see an example of setting MPDF as the desired PDF renderer. ```php Settings::setPdfRendererName(Settings::PDF_RENDERER_MPDF); Settings::setPdfRendererPath(__DIR__ . '/../vendor/mpdf/mpdf'); ``` or you can edit settings in phpword.ini ( or phpword.ini.dist) file. ``` ini pdfRendererName = MPDF ;DomPDF, TCPDF, MPDF pdfRendererPath = /path/to/your/renderer/folder ``` ## RTF The name of the writer is `RTF`. ``` php save(__DIR__ . '/sample.rtf'); ``` ## Word2007 The name of the writer is `Word2007`. ``` php save(__DIR__ . '/sample.docx'); ``` ### ZIP Adapter You can change the ZIP Adapter for the writer. By default, the ZIP Adapter is `ZipArchiveAdapter`. ``` php setZipAdapter(new PclZipAdapter()); $writer->save(__DIR__ . '/sample.docx'); ``` ================================================ FILE: mkdocs.yml ================================================ site_name: PHPWord site_url: https://phpoffice.github.io/PHPWord repo_url: https://github.com/PHPOffice/PHPWord repo_name: PHPOffice/PHPWord edit_uri: edit/develop/docs/ ## Theme theme: name: material palette: primary: indigo features: - search.highlight - search.suggest ## Plugins plugins: - search - autolink_references: autolinks: - reference_prefix: GP- target_url: https://github.com/ - reference_prefix: GH- target_url: https://github.com/PHPOffice/PHPWord/issues/ - reference_prefix: CP- target_url: https://archive.codeplex.com/?p=phpword& ## Config extra: generator: false markdown_extensions: ## Syntax highlighting - pymdownx.highlight - pymdownx.superfences ## Support for emojis - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg ## Support for call-outs - admonition - pymdownx.details use_directory_urls: false ## Navigation nav: - Introduction: 'index.md' - Install: 'install.md' - Usage: - Introduction: 'usage/introduction.md' - Containers: 'usage/containers.md' - Elements: - Introduction: 'usage/elements/index.md' - Chart: 'usage/elements/chart.md' - Checkbox: 'usage/elements/checkbox.md' - Comment: 'usage/elements/comment.md' - Field: 'usage/elements/field.md' - Footnote & Endnote: 'usage/elements/note.md' - Formula: 'usage/elements/formula.md' - Image: 'usage/elements/image.md' - Line: 'usage/elements/line.md' - Link: 'usage/elements/link.md' - List: 'usage/elements/list.md' - OLE Object: 'usage/elements/oleobject.md' - Page Break: 'usage/elements/pagebreak.md' - Preserve Text: 'usage/elements/preservetext.md' - Ruby: 'usage/elements/ruby.md' - Text: 'usage/elements/text.md' - TextBox: 'usage/elements/textbox.md' - Text Break: 'usage/elements/textbreak.md' - Table: 'usage/elements/table.md' - Table of contents: 'usage/elements/toc.md' - Title: 'usage/elements/title.md' - Track Changes: 'usage/elements/trackchanges.md' - Watermark: 'usage/elements/watermark.md' - Styles: - Chart: 'usage/styles/chart.md' - Font: 'usage/styles/font.md' - Image: 'usage/styles/image.md' - Numbering Level: 'usage/styles/numberinglevel.md' - Paragraph: 'usage/styles/paragraph.md' - Section: 'usage/styles/section.md' - Table: 'usage/styles/table.md' - Template Processing: 'usage/template.md' - Readers: 'usage/readers.md' - Writers: 'usage/writers.md' - FAQ: 'faq.md' - How to: 'howto.md' - Credits: 'credits.md' - Releases: - '1.x': - '1.5.0 (WIP)': 'changes/1.x/1.5.0.md' - '1.4.0': 'changes/1.x/1.4.0.md' - '1.3.0': 'changes/1.x/1.3.0.md' - '1.2.0': 'changes/1.x/1.2.0.md' - '1.1.0': 'changes/1.x/1.1.0.md' - '1.0.0': 'changes/1.x/1.0.0.md' - '0.x': - '0.18.3': 'changes/0.x/0.18.3.md' - '0.18.2': 'changes/0.x/0.18.2.md' - '0.18.1': 'changes/0.x/0.18.1.md' - '0.18.0': 'changes/0.x/0.18.0.md' - '0.17.0': 'changes/0.x/0.17.0.md' - '0.16.0': 'changes/0.x/0.16.0.md' - '0.15.0': 'changes/0.x/0.15.0.md' - '0.14.0': 'changes/0.x/0.14.0.md' - '0.13.0': 'changes/0.x/0.13.0.md' - '0.12.1': 'changes/0.x/0.12.1.md' - '0.12.0': 'changes/0.x/0.12.0.md' - '0.11.1': 'changes/0.x/0.11.1.md' - '0.11.0': 'changes/0.x/0.11.0.md' - '0.10.1': 'changes/0.x/0.10.1.md' - '0.10.0': 'changes/0.x/0.10.0.md' - '0.9.1': 'changes/0.x/0.9.1.md' - '0.9.0': 'changes/0.x/0.9.0.md' - '0.8.1': 'changes/0.x/0.8.1.md' - '0.8.0': 'changes/0.x/0.8.0.md' - '0.7.0': 'changes/0.x/0.7.0.md' - Developers: - 'Coveralls': 'https://coveralls.io/github/PHPOffice/PHPWord' - 'Code Coverage': 'coverage/index.html' - 'PHPDoc': 'docs/index.html' ================================================ FILE: phpmd.xml.dist ================================================ ================================================ FILE: phpstan-baseline.neon ================================================ parameters: ignoreErrors: - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer\\:\\:__call\\(\\) should return PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement but returns null\\.$#" count: 1 path: src/PhpWord/Element/AbstractContainer.php - message: "#^Parameter \\#1 \\$objectOrClass of class ReflectionClass constructor expects class\\-string\\\\|T of object, string given\\.$#" count: 1 path: src/PhpWord/Element/AbstractContainer.php - message: "#^Parameter \\#1 \\$string of function md5 expects string, int\\<0, max\\> given\\.$#" count: 1 path: src/PhpWord/Element/AbstractElement.php - message: "#^Parameter \\#2 \\$styleValue of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:setNewStyle\\(\\) expects array\\|PhpOffice\\\\PhpWord\\\\Style\\|string\\|null, array\\|PhpOffice\\\\PhpWord\\\\Style\\\\Cell\\|null given\\.$#" count: 1 path: src/PhpWord/Element/Cell.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\Field\\:\\:setOptions\\(\\) should return PhpOffice\\\\PhpWord\\\\Element\\\\Field but returns array\\.$#" count: 1 path: src/PhpWord/Element/Field.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\Field\\:\\:setProperties\\(\\) should return PhpOffice\\\\PhpWord\\\\Element\\\\Field but returns array\\.$#" count: 1 path: src/PhpWord/Element/Field.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Element\\\\Field\\:\\:\\$fontStyle \\(PhpOffice\\\\PhpWord\\\\Style\\\\Font\\|string\\) does not accept null\\.$#" count: 1 path: src/PhpWord/Element/Field.php - message: "#^Result of \\|\\| is always true\\.$#" count: 1 path: src/PhpWord/Element/Field.php - message: "#^Parameter \\#2 \\$styleValue of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:setNewStyle\\(\\) expects array\\|PhpOffice\\\\PhpWord\\\\Style\\|string\\|null, array\\|PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\|string\\|null given\\.$#" count: 1 path: src/PhpWord/Element/Footnote.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\Image\\:\\:getArchiveImageSize\\(\\) should return array\\|null but returns array\\|false\\|null\\.$#" count: 1 path: src/PhpWord/Element/Image.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\Image\\:\\:getImageString\\(\\) should return string\\|null but returns string\\|false\\|null\\.$#" count: 1 path: src/PhpWord/Element/Image.php - message: "#^Parameter \\#1 \\$callback of function call_user_func expects callable\\(\\)\\: mixed, string given\\.$#" count: 1 path: src/PhpWord/Element/Image.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Element\\\\Image\\:\\:\\$source \\(string\\) does not accept string\\|false\\.$#" count: 1 path: src/PhpWord/Element/Image.php - message: "#^Offset 'extension' does not exist on array\\{dirname\\?\\: string, basename\\: string, extension\\?\\: string, filename\\: string\\}\\.$#" count: 2 path: src/PhpWord/Element/OLEObject.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Element\\\\OLEObject\\:\\:\\$icon \\(string\\) does not accept string\\|false\\.$#" count: 1 path: src/PhpWord/Element/OLEObject.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\Section\\:\\:addHeader\\(\\) should return PhpOffice\\\\PhpWord\\\\Element\\\\Header but returns PhpOffice\\\\PhpWord\\\\Element\\\\Footer\\.$#" count: 1 path: src/PhpWord/Element/Section.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Element\\\\Section\\:\\:addHeaderFooter\\(\\) should return PhpOffice\\\\PhpWord\\\\Element\\\\Footer but returns PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer\\.$#" count: 1 path: src/PhpWord/Element/Section.php - message: "#^Parameter \\#2 \\$styleValue of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:setNewStyle\\(\\) expects array\\|PhpOffice\\\\PhpWord\\\\Style\\|string\\|null, array\\|PhpOffice\\\\PhpWord\\\\Style\\|PhpOffice\\\\PhpWord\\\\Style\\\\Section\\|string given\\.$#" count: 1 path: src/PhpWord/Element/Section.php - message: "#^Parameter \\#3 \\$length of function substr expects int\\|null, int\\|false given\\.$#" count: 1 path: src/PhpWord/Element/Section.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Escaper\\\\Rtf\\:\\:escapeAsciiCharacter\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Escaper/Rtf.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Escaper\\\\Rtf\\:\\:escapeAsciiCharacter\\(\\) has parameter \\$code with no type specified\\.$#" count: 1 path: src/PhpWord/Escaper/Rtf.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Escaper\\\\Rtf\\:\\:escapeMultibyteCharacter\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Escaper/Rtf.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Escaper\\\\Rtf\\:\\:escapeMultibyteCharacter\\(\\) has parameter \\$code with no type specified\\.$#" count: 1 path: src/PhpWord/Escaper/Rtf.php - message: "#^Cannot instantiate interface PhpOffice\\\\PhpWord\\\\Writer\\\\WriterInterface\\.$#" count: 1 path: src/PhpWord/IOFactory.php - message: "#^Method PhpOffice\\\\PhpWord\\\\IOFactory\\:\\:createObject\\(\\) should return PhpOffice\\\\PhpWord\\\\Reader\\\\ReaderInterface\\|PhpOffice\\\\PhpWord\\\\Writer\\\\WriterInterface but returns object\\.$#" count: 1 path: src/PhpWord/IOFactory.php - message: "#^Method PhpOffice\\\\PhpWord\\\\IOFactory\\:\\:createReader\\(\\) should return PhpOffice\\\\PhpWord\\\\Reader\\\\ReaderInterface but returns PhpOffice\\\\PhpWord\\\\Reader\\\\ReaderInterface\\|PhpOffice\\\\PhpWord\\\\Writer\\\\WriterInterface\\.$#" count: 1 path: src/PhpWord/IOFactory.php - message: "#^Method PhpOffice\\\\PhpWord\\\\IOFactory\\:\\:createWriter\\(\\) should return PhpOffice\\\\PhpWord\\\\Writer\\\\WriterInterface but returns PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\|PhpOffice\\\\PhpWord\\\\Writer\\\\WriterInterface\\.$#" count: 1 path: src/PhpWord/IOFactory.php - message: "#^Parameter \\#1 \\$objectOrClass of class ReflectionClass constructor expects class\\-string\\\\|T of object, string given\\.$#" count: 1 path: src/PhpWord/IOFactory.php - message: "#^Method PhpOffice\\\\PhpWord\\\\PhpWord\\:\\:getDefaultFontSize\\(\\) should return int but returns float\\|int\\.$#" count: 1 path: src/PhpWord/PhpWord.php - message: "#^Parameter \\#1 \\$callback of function forward_static_call_array expects callable\\(\\)\\: mixed, array\\{'PhpOffice\\\\\\\\PhpWord…', string\\} given\\.$#" count: 1 path: src/PhpWord/PhpWord.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Reader\\\\AbstractReader\\:\\:openFile\\(\\) should return resource but return statement is missing\\.$#" count: 1 path: src/PhpWord/Reader/AbstractReader.php - message: "#^Parameter \\#2 \\$html of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:addHtml\\(\\) expects string, string\\|false given\\.$#" count: 1 path: src/PhpWord/Reader/HTML.php - message: "#^Offset 'textNodes' on array\\{changed\\: PhpOffice\\\\PhpWord\\\\Element\\\\TrackChange, textNodes\\: DOMNodeList\\\\} in isset\\(\\) always exists and is not nullable\\.$#" count: 1 path: src/PhpWord/Reader/ODText/Content.php - message: "#^Parameter \\#2 \\$contextNode of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLReader\\:\\:getElements\\(\\) expects DOMElement\\|null, DOMNode\\|null given\\.$#" count: 2 path: src/PhpWord/Reader/ODText/Content.php - message: "#^Parameter \\#2 \\$depth of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer\\:\\:addTitle\\(\\) expects int, string\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/ODText/Content.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Reader\\\\RTF\\\\Document\\:\\:\\$rtf \\(string\\) does not accept string\\|false\\.$#" count: 1 path: src/PhpWord/Reader/RTF.php - message: "#^Cannot call method setStyleByArray\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Font\\|string\\.$#" count: 1 path: src/PhpWord/Reader/RTF/Document.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Reader\\\\RTF\\\\Document\\:\\:\\$phpWord is never read, only written\\.$#" count: 1 path: src/PhpWord/Reader/RTF/Document.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Reader\\\\ReaderInterface\\:\\:load\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Reader/ReaderInterface.php - message: "#^Parameter \\#1 \\$string of function substr expects string, string\\|false given\\.$#" count: 2 path: src/PhpWord/Reader/Word2007.php - message: "#^Parameter \\#2 \\$xmlFile of method PhpOffice\\\\PhpWord\\\\Reader\\\\Word2007\\:\\:getRels\\(\\) expects string, string\\|false given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007.php - message: "#^Parameter \\#3 \\$subject of function str_replace expects array\\|string, string\\|false given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007.php - message: "#^Binary operation \"/\" between string\\|null and 2 results in an error\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Call to an undefined method DOMNode\\:\\:getAttribute\\(\\)\\.$#" count: 2 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Reader\\\\Word2007\\\\AbstractPart\\:\\:getHeadingDepth\\(\\) never returns float so it can be removed from the return type\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Reader\\\\Word2007\\\\AbstractPart\\:\\:getHeadingDepth\\(\\) should return float\\|int\\|null but returns string\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Reader\\\\Word2007\\\\AbstractPart\\:\\:read\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#1 \\$depth of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer\\:\\:addListItemRun\\(\\) expects int, string\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#1 \\$height of method PhpOffice\\\\PhpWord\\\\Element\\\\Table\\:\\:addRow\\(\\) expects int\\|null, string\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#1 \\$value of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:setRelationId\\(\\) expects int, string\\|null given\\.$#" count: 2 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#1 \\$width of method PhpOffice\\\\PhpWord\\\\Element\\\\Row\\:\\:addCell\\(\\) expects int\\|null, string\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#2 \\$contextNode of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLReader\\:\\:getAttribute\\(\\) expects DOMElement\\|null, DOMNode\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#2 \\$depth of method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer\\:\\:addTitle\\(\\) expects int, float\\|int given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Strict comparison using \\=\\=\\= between null and DOMElement will always evaluate to false\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/AbstractPart.php - message: "#^Parameter \\#2 \\$relationId of method PhpOffice\\\\PhpWord\\\\Reader\\\\Word2007\\\\Footnotes\\:\\:getElement\\(\\) expects int, string\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/Footnotes.php - message: "#^Parameter \\#3 \\$levelId of method PhpOffice\\\\PhpWord\\\\Reader\\\\Word2007\\\\Numbering\\:\\:readLevel\\(\\) expects int, string\\|null given\\.$#" count: 2 path: src/PhpWord/Reader/Word2007/Numbering.php - message: "#^Parameter \\#1 \\$comments of method PhpOffice\\\\PhpWord\\\\ComplexType\\\\TrackChangesView\\:\\:setComments\\(\\) expects bool\\|null, string\\|null given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/Settings.php - message: "#^Parameter \\#1 \\$consecutiveHyphenLimit of method PhpOffice\\\\PhpWord\\\\Metadata\\\\Settings\\:\\:setConsecutiveHyphenLimit\\(\\) expects int, string given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/Settings.php - message: "#^Parameter \\#1 \\$hyphenationZone of method PhpOffice\\\\PhpWord\\\\Metadata\\\\Settings\\:\\:setHyphenationZone\\(\\) expects float\\|int\\|null, string given\\.$#" count: 1 path: src/PhpWord/Reader/Word2007/Settings.php - message: "#^Parameter \\#1 \\$filename of function parse_ini_file expects string, string\\|false given\\.$#" count: 1 path: src/PhpWord/Settings.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\AbstractEnum\\:\\:getConstants\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/AbstractEnum.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\AbstractEnum\\:\\:\\$constCacheArray has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/AbstractEnum.php - message: "#^Binary operation \"/\" between string and 10 results in an error\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:angleToDegree\\(\\) should return int but returns float\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:cssToPoint\\(\\) should return float\\|null but returns string\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:htmlToRgb\\(\\) should return array but returns false\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:inchToEmu\\(\\) should return int but returns float\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:pixelToEmu\\(\\) should return int but returns float\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Parameter \\#1 \\$centimeter of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:cmToPoint\\(\\) expects float, string given\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Parameter \\#1 \\$inch of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:inchToPoint\\(\\) expects float, string given\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Parameter \\#1 \\$pica of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:picaToPoint\\(\\) expects float, string given\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Parameter \\#1 \\$pixel of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Converter\\:\\:pixelToPoint\\(\\) expects float, string given\\.$#" count: 1 path: src/PhpWord/Shared/Converter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Drawing\\:\\:angleToDegrees\\(\\) should return int but returns float\\.$#" count: 1 path: src/PhpWord/Shared/Drawing.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Drawing\\:\\:emuToPixels\\(\\) should return int but returns float\\.$#" count: 1 path: src/PhpWord/Shared/Drawing.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Drawing\\:\\:pixelsToEmu\\(\\) should return int but returns float\\.$#" count: 1 path: src/PhpWord/Shared/Drawing.php - message: "#^Call to an undefined method DOMNode\\:\\:getAttribute\\(\\)\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Cannot call method setBorderSize\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Table\\|string\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Cannot call method setStyleName\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Table\\|string\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^If condition is always true\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:addHtml\\(\\) has parameter \\$options with no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:filterOutNonInheritedStyles\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:mapBorderColor\\(\\) has parameter \\$cssBorderColor with no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:mapBorderColor\\(\\) has parameter \\$styles with no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:mapListType\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:parseLink\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:parseList\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:parseRuby\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:parseStyleDeclarations\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:recursiveParseStylesInHierarchy\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Parameter \\#1 \\$attribute of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:parseStyle\\(\\) expects DOMAttr, DOMNode given\\.$#" count: 3 path: src/PhpWord/Shared/Html.php - message: "#^Parameter \\#2 \\$element of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:parseNode\\(\\) expects PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer, PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer\\|PhpOffice\\\\PhpWord\\\\Element\\\\Row\\|PhpOffice\\\\PhpWord\\\\Element\\\\Table given\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:\\$listIndex has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:\\$options has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\Html\\:\\:\\$xpath has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Result of \\|\\| is always true\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Right side of && is always true\\.$#" count: 1 path: src/PhpWord/Shared/Html.php - message: "#^Variable \\$cNodes in empty\\(\\) always exists and is not falsy\\.$#" count: 2 path: src/PhpWord/Shared/Html.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\Microsoft\\\\PasswordEncoder\\:\\:\\$encryptionMatrix has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Microsoft/PasswordEncoder.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\Microsoft\\\\PasswordEncoder\\:\\:\\$initialCodeArray has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Microsoft/PasswordEncoder.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\Microsoft\\\\PasswordEncoder\\:\\:\\$passwordMaxLength has no type specified\\.$#" count: 1 path: src/PhpWord/Shared/Microsoft/PasswordEncoder.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:getData\\(\\) should return string but returns string\\|false\\.$#" count: 1 path: src/PhpWord/Shared/XMLWriter.php - message: "#^Call to method add\\(\\) on an unknown class PclZip\\.$#" count: 2 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method addFromString\\(\\) on an unknown class PclZip\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method close\\(\\) on an unknown class PclZip\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method extract\\(\\) on an unknown class PclZip\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method extractByIndex\\(\\) on an unknown class PclZip\\.$#" count: 3 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method extractTo\\(\\) on an unknown class PclZip\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method getFromName\\(\\) on an unknown class PclZip\\.$#" count: 2 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Call to method listContent\\(\\) on an unknown class PclZip\\.$#" count: 3 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Comparison operation \"\\!\\=\" between array and 0 results in an error\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Constant PCLZIP_OPT_ADD_PATH not found\\.$#" count: 2 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Constant PCLZIP_OPT_EXTRACT_AS_STRING not found\\.$#" count: 2 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Constant PCLZIP_OPT_PATH not found\\.$#" count: 2 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Constant PCLZIP_OPT_REMOVE_PATH not found\\.$#" count: 2 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Instantiated class PclZip not found\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\ZipArchive\\:\\:getFromName\\(\\) should return string but returns string\\|false\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Shared\\\\ZipArchive\\:\\:open\\(\\) should return bool but returns int\\|true\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Offset 'dirname' does not exist on array\\{dirname\\?\\: string, basename\\: string, extension\\?\\: string, filename\\: string\\}\\.$#" count: 3 path: src/PhpWord/Shared/ZipArchive.php - message: "#^PHPDoc tag @var for variable \\$zip contains unknown class PclZip\\.$#" count: 6 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Parameter \\#1 \\$callback of function call_user_func_array expects callable\\(\\)\\: mixed, array\\{\\$this\\(PhpOffice\\\\PhpWord\\\\Shared\\\\ZipArchive\\)\\|PclZip\\|ZipArchive, mixed\\} given\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Parameter \\#1 \\$stream of function fclose expects resource, resource\\|false given\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Parameter \\#1 \\$stream of function fwrite expects resource, resource\\|false given\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Shared\\\\ZipArchive\\:\\:\\$zip has unknown class PclZip as its type\\.$#" count: 1 path: src/PhpWord/Shared/ZipArchive.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\:\\:addFontStyle\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\:\\:addLinkStyle\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\:\\:addNumberingStyle\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Numbering but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\:\\:addParagraphStyle\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\:\\:addTableStyle\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Table but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\:\\:addTitleStyle\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style.php - message: "#^Call to an undefined method object\\:\\:setStyleByArray\\(\\)\\.$#" count: 1 path: src/PhpWord/Style/AbstractStyle.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\:\\:setFloatVal\\(\\) should return float\\|null but returns float\\|int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/AbstractStyle.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\:\\:setNumericVal\\(\\) should return float\\|int\\|null but returns float\\|int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/AbstractStyle.php - message: "#^Parameter \\#3 \\$length of function substr expects int\\|null, int\\|false given\\.$#" count: 1 path: src/PhpWord/Style/AbstractStyle.php - message: "#^Unreachable statement \\- code above always terminates\\.$#" count: 1 path: src/PhpWord/Style/AbstractStyle.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Border\\:\\:getBorderSize\\(\\) should return array\\ but returns array\\\\.$#" count: 1 path: src/PhpWord/Style/Border.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Cell\\:\\:getBgColor\\(\\) should return string but returns null\\.$#" count: 1 path: src/PhpWord/Style/Cell.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Cell\\:\\:setUnit\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Cell.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Chart\\:\\:getMajorTickPosition\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Chart\\:\\:setCategoryAxisTitle\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Chart\\:\\:setValueAxisTitle\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Chart\\:\\:setValueLabelPosition\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Chart\\:\\:showAxisLabels\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Chart\\:\\:showGridY\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^PHPDoc tag @param has invalid value \\(string\\)\\: Unexpected token \"\\\\n \\* \", expected variable at offset 250$#" count: 1 path: src/PhpWord/Style/Chart.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setAllCaps\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setBgColor\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Table but return statement is missing\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setDoubleStrikethrough\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setSmallCaps\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setStrikethrough\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setSubScript\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Font\\:\\:setSuperScript\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Font but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Font.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\Line\\:\\:\\$weight \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/Line.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\ListItem\\:\\:getListTypeStyle\\(\\) should return array but empty return statement found\\.$#" count: 1 path: src/PhpWord/Style/ListItem.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\ListItem\\:\\:getListTypeStyle\\(\\) should return array but return statement is missing\\.$#" count: 1 path: src/PhpWord/Style/ListItem.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\:\\:setStyleValue\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Paragraph.php - message: "#^Result of && is always false\\.$#" count: 1 path: src/PhpWord/Style/Paragraph.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Section\\:\\:setSettingValue\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\Section but returns PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\.$#" count: 1 path: src/PhpWord/Style/Section.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\TOC\\:\\:setTabLeader\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\TOC but returns PhpOffice\\\\PhpWord\\\\Style\\\\Tab\\.$#" count: 1 path: src/PhpWord/Style/TOC.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\TOC\\:\\:setTabPos\\(\\) should return PhpOffice\\\\PhpWord\\\\Style\\\\TOC but returns PhpOffice\\\\PhpWord\\\\Style\\\\Tab\\.$#" count: 1 path: src/PhpWord/Style/TOC.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getBorderInsideHColor\\(\\) should return string but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getBorderInsideHSize\\(\\) should return int but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getBorderInsideVColor\\(\\) should return string but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getBorderInsideVSize\\(\\) should return int but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getBorderSize\\(\\) should return array\\ but returns array\\\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getCellMarginBottom\\(\\) should return int but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getCellMarginLeft\\(\\) should return int but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getCellMarginRight\\(\\) should return int but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Style\\\\Table\\:\\:getCellMarginTop\\(\\) should return int but returns int\\|string\\|null\\.$#" count: 1 path: src/PhpWord/Style/Table.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\TablePosition\\:\\:\\$bottomFromText \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/TablePosition.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\TablePosition\\:\\:\\$leftFromText \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/TablePosition.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\TablePosition\\:\\:\\$rightFromText \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/TablePosition.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\TablePosition\\:\\:\\$tblpX \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/TablePosition.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\TablePosition\\:\\:\\$tblpY \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/TablePosition.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Style\\\\TablePosition\\:\\:\\$topFromText \\(int\\) does not accept float\\|int\\|null\\.$#" count: 1 path: src/PhpWord/Style/TablePosition.php - message: "#^Call to an undefined method object\\:\\:write\\(\\)\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Cannot access offset 'end' on array\\\\|true\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Cannot access offset 'start' on array\\\\|true\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:addImageToRelations\\(\\) has parameter \\$imageMimeType with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:addImageToRelations\\(\\) has parameter \\$imgPath with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:addImageToRelations\\(\\) has parameter \\$partFileName with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:addImageToRelations\\(\\) has parameter \\$rid with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:chooseImageDimension\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:chooseImageDimension\\(\\) has parameter \\$baseValue with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:chooseImageDimension\\(\\) has parameter \\$defaultValue with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:chooseImageDimension\\(\\) has parameter \\$inlineValue with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:fixImageWidthHeightRatio\\(\\) has parameter \\$actualHeight with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:fixImageWidthHeightRatio\\(\\) has parameter \\$actualWidth with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:fixImageWidthHeightRatio\\(\\) has parameter \\$height with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:fixImageWidthHeightRatio\\(\\) has parameter \\$width with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:getImageArgs\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:getImageArgs\\(\\) has parameter \\$varNameWithArgs with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:getNextRelationsIndex\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:getNextRelationsIndex\\(\\) has parameter \\$documentPartName with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:indexClonedVariables\\(\\) should return string but returns array\\, string\\|null\\>\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:prepareImageAttrs\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:prepareImageAttrs\\(\\) has parameter \\$replaceImage with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:prepareImageAttrs\\(\\) has parameter \\$varInlineArgs with no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:setValueForPart\\(\\) should return string but returns array\\\\|string\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Method PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:setValueForPart\\(\\) should return string but returns array\\\\|string\\|null\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Parameter \\#1 \\$element of method PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Part\\\\Chart\\:\\:setElement\\(\\) expects PhpOffice\\\\PhpWord\\\\Element\\\\Chart, PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement given\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Parameter \\#2 \\$array of function implode expects array\\|null, array\\\\|string given\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Parameter \\#2 \\$array of function implode expects array\\|null, string given\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Property PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:\\$macroClosingChars has no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Property PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:\\$macroOpeningChars has no type specified\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Property PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:\\$tempDocumentFooters \\(array\\\\) does not accept string\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Property PhpOffice\\\\PhpWord\\\\TemplateProcessor\\:\\:\\$tempDocumentHeaders \\(array\\\\) does not accept string\\.$#" count: 1 path: src/PhpWord/TemplateProcessor.php - message: "#^Argument of an invalid type array\\\\|false supplied for foreach, only iterables are supported\\.$#" count: 1 path: src/PhpWord/Writer/AbstractWriter.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\HTML\\\\Element\\\\AbstractElement\\:\\:write\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/HTML/Element/AbstractElement.php - message: "#^Variable \\$row in PHPDoc tag @var does not match assigned variable \\$rowStyle\\.$#" count: 1 path: src/PhpWord/Writer/HTML/Element/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Element\\\\Field\\:\\:writeDefault\\(\\) has parameter \\$type with no type specified\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Element/Field.php - message: "#^Variable \\$row in PHPDoc tag @var does not match any variable in the foreach loop\\: \\$cell$#" count: 1 path: src/PhpWord/Writer/ODText/Element/Table.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Element\\\\AbstractElement\\:\\:replaceTabs\\(\\) has parameter \\$text with no type specified\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Element/AbstractElement.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Element\\\\AbstractElement\\:\\:replaceTabs\\(\\) has parameter \\$xmlWriter with no type specified\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Element/AbstractElement.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Element\\\\Text\\:\\:writeChangeInsertion\\(\\) has parameter \\$start with no type specified\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Element/Text.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getParagraphStyle\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Element/TextRun.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\:\\:setColumnWidths\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Part/Content.php - message: "#^Parameter \\#1 \\$container of method PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Part\\\\Content\\:\\:collectTrackedChanges\\(\\) expects PhpOffice\\\\PhpWord\\\\Element\\\\AbstractContainer, PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement given\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Part/Content.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Part\\\\Content\\:\\:\\$imageParagraphStyles has no type specified\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Part/Content.php - message: "#^Call to an undefined method object\\:\\:write\\(\\)\\.$#" count: 2 path: src/PhpWord/Writer/ODText/Part/Styles.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Part\\\\Styles\\:\\:cvttwiptostr\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/ODText/Part/Styles.php - message: "#^Parameter \\#1 \\$callback of function call_user_func_array expects callable\\(\\)\\: mixed, array\\{PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\AbstractRenderer, string\\} given\\.$#" count: 1 path: src/PhpWord/Writer/PDF.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:\\$renderer \\(PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\AbstractRenderer\\) does not accept object\\.$#" count: 1 path: src/PhpWord/Writer/PDF.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF\\:\\:loadHtml\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/PDF/DomPDF.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF\\:\\:output\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/PDF/DomPDF.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF\\:\\:render\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/PDF/DomPDF.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF\\:\\:setPaper\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/PDF/DomPDF.php - message: "#^Class PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF referenced with incorrect case\\: PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\Dompdf\\.$#" count: 1 path: src/PhpWord/Writer/PDF/DomPDF.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF\\:\\:createExternalWriterInstance\\(\\) should return PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\\\DomPDF but returns Dompdf\\\\Dompdf\\.$#" count: 1 path: src/PhpWord/Writer/PDF/DomPDF.php - message: "#^Binary operation \"\\+\" between int\\|string and 1 results in an error\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Parameter \\#1 \\$value of method PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Style\\\\Font\\:\\:setNameIndex\\(\\) expects int, int\\|string given\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\AbstractElement\\:\\:\\$fontStyle \\(PhpOffice\\\\PhpWord\\\\Style\\\\Font\\) does not accept PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\|null\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\AbstractElement\\:\\:\\$fontStyle \\(PhpOffice\\\\PhpWord\\\\Style\\\\Font\\) does not accept PhpOffice\\\\PhpWord\\\\Style\\\\Font\\|string\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\AbstractElement\\:\\:\\$paragraphStyle \\(PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\) does not accept PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\|null\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\AbstractElement\\:\\:\\$paragraphStyle \\(PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\) does not accept PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\|string\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\AbstractElement\\:\\:\\$paragraphStyle \\(PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\) does not accept null\\.$#" count: 2 path: src/PhpWord/Writer/RTF/Element/AbstractElement.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\Field\\:\\:write\\(\\) should return string but empty return statement found\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Field.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\Field\\:\\:writeDate\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Field.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\Field\\:\\:writeNumpages\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Field.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\RTF\\\\Element\\\\Field\\:\\:writePage\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Field.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getImageStringData\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Image.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getStyle\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Image.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getSource\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Link.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getText\\(\\)\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Element/Link.php - message: "#^Call to an undefined method object\\:\\:write\\(\\)\\.$#" count: 2 path: src/PhpWord/Writer/RTF/Part/Document.php - message: "#^Binary operation \"\\+\" between int\\|string and 1 results in an error\\.$#" count: 1 path: src/PhpWord/Writer/RTF/Style/Border.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\AbstractElement\\:\\:write\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/AbstractElement.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\Field\\:\\:buildPropertiesAndOptions\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/Field.php - message: "#^Parameter \\#1 \\$content of method PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\AbstractElement\\:\\:writeText\\(\\) expects string, bool\\|int\\|string given\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/FormField.php - message: "#^Parameter \\#3 \\$value of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:writeElementBlock\\(\\) expects string\\|null, bool\\|int\\|string given\\.$#" count: 3 path: src/PhpWord/Writer/Word2007/Element/FormField.php - message: "#^Parameter \\#3 \\$value of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:writeElementBlock\\(\\) expects string\\|null, int given\\.$#" count: 4 path: src/PhpWord/Writer/Word2007/Element/FormField.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\ParagraphAlignment\\:\\:\\$attributes has no type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/ParagraphAlignment.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\ParagraphAlignment\\:\\:\\$name has no type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/ParagraphAlignment.php - message: "#^Parameter \\#2 \\$content of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:writeElement\\(\\) expects string\\|null, bool\\|int\\|string given\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/SDT.php - message: "#^Parameter \\#3 \\$value of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:writeElementBlock\\(\\) expects string\\|null, int\\<100000000, 999999999\\> given\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/SDT.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\TableAlignment\\:\\:\\$attributes has no type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/TableAlignment.php - message: "#^Property PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Element\\\\TableAlignment\\:\\:\\$name has no type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/TableAlignment.php - message: "#^Method PhpOffice\\\\PhpWord\\\\PhpWord\\:\\:addBookmark\\(\\) invoked with 0 parameters, 1 required\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Element/Title.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Part\\\\Chart\\:\\:writeAxisTitle\\(\\) has parameter \\$title with no type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Part/Chart.php - message: "#^Parameter \\#3 \\$value of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:writeElementBlock\\(\\) expects string\\|null, int given\\.$#" count: 9 path: src/PhpWord/Writer/Word2007/Part/Chart.php - message: "#^Parameter \\#3 \\$value of method PhpOffice\\\\PhpWord\\\\Shared\\\\XMLWriter\\:\\:writeElementBlock\\(\\) expects string\\|null, int\\<0, max\\> given\\.$#" count: 4 path: src/PhpWord/Writer/Word2007/Part/Chart.php - message: "#^Parameter \\#1 \\$string of function md5 expects string, int\\<0, max\\> given\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Part/Numbering.php - message: "#^Parameter \\#1 \\$haystack of function strpos expects string, int given\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Part/Rels.php - message: "#^Method PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Style\\\\AbstractStyle\\:\\:write\\(\\) has no return type specified\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Style/AbstractStyle.php - message: "#^Parameter \\#1 \\$styleName of static method PhpOffice\\\\PhpWord\\\\Style\\:\\:getStyle\\(\\) expects string, PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\|string given\\.$#" count: 1 path: src/PhpWord/Writer/Word2007/Style/Font.php - message: "#^Call to an undefined method object\\:\\:read\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/AbstractTestReader.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\AbstractTestReader\\:\\:\\$parts has no type specified\\.$#" count: 1 path: tests/PhpWordTests/AbstractTestReader.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\AbstractWebServerEmbedded\\:\\:getBaseUrl\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/AbstractWebServerEmbedded.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\AbstractWebServerEmbedded\\:\\:getRemoteBmpImageUrl\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/AbstractWebServerEmbedded.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\AbstractWebServerEmbedded\\:\\:getRemoteGifImageUrl\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/AbstractWebServerEmbedded.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\AbstractWebServerEmbedded\\:\\:getRemoteImageUrl\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/AbstractWebServerEmbedded.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\AbstractWebServerEmbedded\\:\\:\\$httpServer has no type specified\\.$#" count: 1 path: tests/PhpWordTests/AbstractWebServerEmbedded.php - message: "#^Parameter \\#1 \\$width of class PhpOffice\\\\PhpWord\\\\Element\\\\Cell constructor expects int\\|null, string given\\.$#" count: 2 path: tests/PhpWordTests/Element/CellTest.php - message: "#^Parameter \\#2 \\$style of class PhpOffice\\\\PhpWord\\\\Element\\\\Cell constructor expects array\\|PhpOffice\\\\PhpWord\\\\Style\\\\Cell\\|null, int given\\.$#" count: 2 path: tests/PhpWordTests/Element/CellTest.php - message: "#^Parameter \\#1 \\$text of method PhpOffice\\\\PhpWord\\\\Element\\\\Field\\:\\:setText\\(\\) expects PhpOffice\\\\PhpWord\\\\Element\\\\TextRun\\|string\\|null, array given\\.$#" count: 1 path: tests/PhpWordTests/Element/FieldTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Element\\\\ImageTest\\:\\:testImages\\(\\) has parameter \\$createFunction with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Element\\\\ImageTest\\:\\:testImages\\(\\) has parameter \\$extension with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Element\\\\ImageTest\\:\\:testImages\\(\\) has parameter \\$imageFunction with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Element\\\\ImageTest\\:\\:testImages\\(\\) has parameter \\$imageQuality with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Element\\\\ImageTest\\:\\:testImages\\(\\) has parameter \\$source with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Element\\\\ImageTest\\:\\:testImages\\(\\) has parameter \\$type with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Parameter \\#1 \\$source of class PhpOffice\\\\PhpWord\\\\Element\\\\Image constructor expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Parameter \\#1 \\$string of function md5 expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Parameter \\#1 \\$string of function ucfirst expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Parameter \\#3 \\$watermark of class PhpOffice\\\\PhpWord\\\\Element\\\\Image constructor expects bool, null given\\.$#" count: 1 path: tests/PhpWordTests/Element/ImageTest.php - message: "#^Parameter \\#2 \\$style of class PhpOffice\\\\PhpWord\\\\Element\\\\Section constructor expects array\\|PhpOffice\\\\PhpWord\\\\Style\\|string\\|null, PhpOffice\\\\PhpWord\\\\Style\\\\Section given\\.$#" count: 1 path: tests/PhpWordTests/Element/SectionTest.php - message: "#^Parameter \\#1 \\$text of class PhpOffice\\\\PhpWord\\\\Element\\\\Title constructor expects PhpOffice\\\\PhpWord\\\\Element\\\\TextRun\\|string, PhpOffice\\\\PhpWord\\\\Element\\\\PageBreak given\\.$#" count: 1 path: tests/PhpWordTests/Element/TitleTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Escaper\\\\RtfEscaper2Test\\:\\:escapestring\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/Escaper/RtfEscaper2Test.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Escaper\\\\RtfEscaper2Test\\:\\:escapestring\\(\\) has parameter \\$str with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Escaper/RtfEscaper2Test.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Escaper\\\\RtfEscaper2Test\\:\\:expect\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/Escaper/RtfEscaper2Test.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Escaper\\\\RtfEscaper2Test\\:\\:expect\\(\\) has parameter \\$str with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Escaper/RtfEscaper2Test.php - message: "#^Parameter \\#1 \\$expected of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) expects class\\-string\\, string given\\.$#" count: 1 path: tests/PhpWordTests/IOFactoryTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/IOFactoryTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\PhpWord\\:\\:undefinedMethod\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/PhpWordTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getRows\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Reader/Word2007/ElementTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getText\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Reader/Word2007/ElementTest.php - message: "#^Cannot access offset 0 on PhpOffice\\\\PhpWord\\\\Element\\\\TextRun\\.$#" count: 1 path: tests/PhpWordTests/Reader/Word2007/ElementTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getElement\\(\\)\\.$#" count: 2 path: tests/PhpWordTests/Reader/Word2007/PartTest.php - message: "#^Cannot call method getElement\\(\\) on PhpOffice\\\\PhpWord\\\\Element\\\\TextRun\\|string\\.$#" count: 3 path: tests/PhpWordTests/Reader/Word2007/PartTest.php - message: "#^Cannot call method isBold\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Font\\|string\\.$#" count: 1 path: tests/PhpWordTests/Reader/Word2007/PartTest.php - message: "#^Variable \\$endnote in PHPDoc tag @var does not match assigned variable \\$documentEndnote\\.$#" count: 1 path: tests/PhpWordTests/Reader/Word2007/PartTest.php - message: "#^Variable \\$footnote in PHPDoc tag @var does not match assigned variable \\$documentFootnote\\.$#" count: 1 path: tests/PhpWordTests/Reader/Word2007/PartTest.php - message: "#^Cannot access offset 0 on PhpOffice\\\\PhpWord\\\\Element\\\\TextRun\\.$#" count: 2 path: tests/PhpWordTests/Reader/Word2007/StyleTest.php - message: "#^Else branch is unreachable because ternary operator condition is always true\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$compatibility has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$defaultFontName has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$defaultFontSize has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$defaultPaper has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$measurementUnit has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$outputEscapingEnabled has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$pdfRendererName has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$pdfRendererPath has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$tempDir has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\SettingsTest\\:\\:\\$zipClass has no type specified\\.$#" count: 1 path: tests/PhpWordTests/SettingsTest.php - message: "#^Cannot call method getStyleName\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Table\\|string\\.$#" count: 1 path: tests/PhpWordTests/Shared/HtmlTest.php - message: "#^Parameter \\#1 \\$number of static method PhpOffice\\\\PhpWord\\\\Shared\\\\Text\\:\\:numberFormat\\(\\) expects float, string given\\.$#" count: 2 path: tests/PhpWordTests/Shared/TextTest.php - message: "#^Parameter \\#2 \\$locale of function setlocale expects array\\|string\\|null, int given\\.$#" count: 1 path: tests/PhpWordTests/Shared/XMLWriterTest.php - message: "#^Parameter \\#2 \\$locale of function setlocale expects string\\|null, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Shared/XMLWriterTest.php - message: "#^Argument of an invalid type array\\\\|false supplied for foreach, only iterables are supported\\.$#" count: 1 path: tests/PhpWordTests/Shared/ZipArchiveTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Style\\\\AbstractStyleTest\\:\\:callProtectedMethod\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/Style/AbstractStyleTest.php - message: "#^Parameter \\#1 \\$objectOrClass of class ReflectionClass constructor expects class\\-string\\\\|object, class\\-string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Style/AbstractStyleTest.php - message: "#^Cannot call method setLineHeight\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Font\\|string\\.$#" count: 1 path: tests/PhpWordTests/Style/FontTest.php - message: "#^Parameter \\#1 \\$type of class PhpOffice\\\\PhpWord\\\\Style\\\\Font constructor expects string, null given\\.$#" count: 1 path: tests/PhpWordTests/Style/FontTest.php - message: "#^Parameter \\#2 \\$value of method PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\:\\:setStyleValue\\(\\) expects array\\|int\\|string, null given\\.$#" count: 1 path: tests/PhpWordTests/Style/FontTest.php - message: "#^Cannot call method setLineHeight\\(\\) on PhpOffice\\\\PhpWord\\\\Style\\\\Paragraph\\|string\\.$#" count: 1 path: tests/PhpWordTests/Style/ParagraphTest.php - message: "#^Parameter \\#2 \\$value of method PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle\\:\\:setStyleValue\\(\\) expects array\\|int\\|string, bool given\\.$#" count: 1 path: tests/PhpWordTests/Style/RowTest.php - message: "#^Parameter \\#2 \\$value of method PhpOffice\\\\PhpWord\\\\Style\\\\Section\\:\\:setSettingValue\\(\\) expects array\\|int\\|string, null given\\.$#" count: 1 path: tests/PhpWordTests/Style/SectionTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement\\:\\:getText\\(\\)\\.$#" count: 2 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Shared\\\\ZipArchive\\:\\:AddFromString\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Cannot access offset 'end' on array\\\\|bool\\.$#" count: 2 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Cannot access offset 'start' on array\\\\|bool\\.$#" count: 2 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Parameter \\#2 \\$haystack of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringContainsString\\(\\) expects string, string\\|false given\\.$#" count: 6 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Parameter \\#2 \\$haystack of static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertStringNotContainsString\\(\\) expects string, string\\|false given\\.$#" count: 4 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Part \\$documentZip \\(ZipArchive\\) of encapsed string cannot be cast to string\\.$#" count: 1 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Part \\$templateZip \\(ZipArchive\\) of encapsed string cannot be cast to string\\.$#" count: 1 path: tests/PhpWordTests/TemplateProcessorTest.php - message: "#^Argument of an invalid type array\\\\|false supplied for foreach, only iterables are supported\\.$#" count: 1 path: tests/PhpWordTests/TestHelperDOCX.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\TestableTemplateProcesor\\:\\:__construct\\(\\) has parameter \\$mainPart with no type specified\\.$#" count: 1 path: tests/PhpWordTests/TestableTemplateProcesor.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\TestableTemplateProcesor\\:\\:__construct\\(\\) has parameter \\$settingsPart with no type specified\\.$#" count: 1 path: tests/PhpWordTests/TestableTemplateProcesor.php - message: "#^Cannot access property \\$length on DOMNodeList\\\\|false\\.$#" count: 9 path: tests/PhpWordTests/Writer/HTML/ElementTest.php - message: "#^Cannot access property \\$length on DOMNodeList\\\\|false\\.$#" count: 2 path: tests/PhpWordTests/Writer/HTML/Element/RubyTest.php - message: "#^Cannot call method item\\(\\) on DOMNodeList\\\\|false\\.$#" count: 11 path: tests/PhpWordTests/Writer/HTML/ElementTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 3 path: tests/PhpWordTests/Writer/HTML/Element/PageBreakTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Writer\\\\ODText\\\\Style\\\\FontTest\\:\\:providerAllNamedColors\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/Writer/ODText/Style/FontTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:getFont\\(\\)\\.$#" count: 2 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:getOrientation\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:getPaperSize\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:getTempDir\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:setFont\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:setOrientation\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:setPaperSize\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:setTempDir\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 3 path: tests/PhpWordTests/Writer/PDF/DomPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:getFont\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/MPDFTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/MPDFTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 2 path: tests/PhpWordTests/Writer/PDF/TCPDFTest.php - message: "#^Call to an undefined method PhpOffice\\\\PhpWord\\\\Writer\\\\PDF\\:\\:getFont\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDF/TCPDFTest.php - message: "#^Parameter \\#2 \\$libraryBaseDir of static method PhpOffice\\\\PhpWord\\\\Settings\\:\\:setPdfRenderer\\(\\) expects string, string\\|false given\\.$#" count: 1 path: tests/PhpWordTests/Writer/PDFTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Writer\\\\RTF\\\\ElementTest\\:\\:removeCr\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/Writer/RTF/ElementTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Writer\\\\RTF\\\\ElementTest\\:\\:removeCr\\(\\) has parameter \\$field with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Writer/RTF/ElementTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Writer\\\\RTF\\\\StyleTest\\:\\:removeCr\\(\\) has no return type specified\\.$#" count: 1 path: tests/PhpWordTests/Writer/RTF/StyleTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\Writer\\\\RTF\\\\StyleTest\\:\\:removeCr\\(\\) has parameter \\$field with no type specified\\.$#" count: 1 path: tests/PhpWordTests/Writer/RTF/StyleTest.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\Writer\\\\Word2007\\\\Element\\\\ChartTest\\:\\:\\$outputEscapingEnabled has no type specified\\.$#" count: 1 path: tests/PhpWordTests/Writer/Word2007/Element/ChartTest.php - message: "#^Call to an undefined method object\\:\\:write\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/Word2007/ElementTest.php - message: "#^Call to an undefined method object\\:\\:write\\(\\)\\.$#" count: 1 path: tests/PhpWordTests/Writer/Word2007/StyleTest.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\XmlDocument\\:\\:getElement\\(\\) should return DOMElement\\|null but returns DOMNode\\|null\\.$#" count: 1 path: tests/PhpWordTests/XmlDocument.php - message: "#^Method PhpOffice\\\\PhpWordTests\\\\XmlDocument\\:\\:getNodeList\\(\\) should return DOMNodeList\\ but returns DOMNodeList\\\\|false\\.$#" count: 1 path: tests/PhpWordTests/XmlDocument.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\XmlDocument\\:\\:\\$path \\(string\\) does not accept string\\|false\\.$#" count: 1 path: tests/PhpWordTests/XmlDocument.php - message: "#^Property PhpOffice\\\\PhpWordTests\\\\XmlDocument\\:\\:\\$xpath \\(DOMXPath\\) does not accept null\\.$#" count: 1 path: tests/PhpWordTests/XmlDocument.php # https://github.com/phpstan/phpstan/issues/8770 - message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\HTML\\\\Part\\\\AbstractPart is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:|]+$#" count: 1 path: src/PhpWord/Writer/HTML.php # https://github.com/phpstan/phpstan/issues/8770 - message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Element\\\\AbstractElement is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#" count: 2 path: tests/PhpWordTests/Element/AbstractElementTest.php # https://github.com/phpstan/phpstan/issues/8770 - message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Style\\\\AbstractStyle is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#" count: 4 path: tests/PhpWordTests/Style/AbstractStyleTest.php # https://github.com/phpstan/phpstan/issues/8770 - message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\EPub3\\\\Style\\\\AbstractStyle is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#" count: 2 path: tests/PhpWordTests/Writer/EPub3/Style/AbstractStyleTest.php # https://github.com/phpstan/phpstan/issues/8770 - message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\ODText\\\\Part\\\\AbstractPart is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#" count: 2 path: tests/PhpWordTests/Writer/ODText/Part/AbstractPartTest.php # https://github.com/phpstan/phpstan/issues/8770 - message: "#^PHPDoc tag @var with type PhpOffice\\\\PhpWord\\\\Writer\\\\Word2007\\\\Part\\\\AbstractPart is not subtype of native type[\\sA-Za-z\\@\\\\\\/0-9\\.:]+$#" count: 2 path: tests/PhpWordTests/Writer/Word2007/Part/AbstractPartTest.php ================================================ FILE: phpstan.neon.dist ================================================ includes: - phpstan-baseline.neon - vendor/phpstan/phpstan-phpunit/extension.neon - vendor/phpstan/phpstan-phpunit/rules.neon parameters: level: 7 paths: - src/ - tests/ excludePaths: - */pclzip.lib.php - src/PhpWord/Shared/OLERead.php - src/PhpWord/Reader/MsDoc.php - src/PhpWord/Writer/PDF/MPDF.php bootstrapFiles: - tests/bootstrap.php ## <=PHP7.4 reportUnmatchedIgnoredErrors: false treatPhpDocTypesAsCertain: false ignoreErrors: - identifier: missingType.iterableValue ## <=PHP7.4 - message: '#Parameter \#1 \$argument of class ReflectionClass constructor expects class-string\|T of object, string given.#' path: src/PhpWord/Element/AbstractContainer.php - message: '#Parameter \#1 \$function of function call_user_func expects callable\(\): mixed, string given.#' path: src/PhpWord/Element/Image.php - message: '#Parameter \#1 \$argument of class ReflectionClass constructor expects class-string\|T of object, string given.#' path: src/PhpWord/IOFactory.php - message: '#Parameter \#1 \$function of function forward_static_call_array expects callable\(\): mixed, array{.+, string} given.#' path: src/PhpWord/PhpWord.php - message: '#Parameter \#1 \$function of function call_user_func_array expects callable\(\): mixed, array{\$this\(PhpOffice\\PhpWord\\Shared\\ZipArchive\)\|PclZip\|ZipArchive, mixed} given.#' path: src/PhpWord/Shared/ZipArchive.php - message: '#Parameter \#1 \$function of function call_user_func_array expects callable\(\): mixed, array{PhpOffice\\PhpWord\\Writer\\PDF\\AbstractRenderer, string} given.#' path: src/PhpWord/Writer/PDF.php - message: '#Parameter \#1 \$argument of class ReflectionClass constructor expects class-string\|object, class-string\|false given.#' path: tests/PhpWordTests/Style/AbstractStyleTest.php ================================================ FILE: phpunit.xml.dist ================================================ ./src ./src/PhpWord/Shared/PCLZip ./tests/PhpWordTests ================================================ FILE: phpword.ini.dist ================================================ ; Default config file for PHPWord ; Copy this file into phpword.ini and use Settings::loadConfig to load [General] compatibility = true zipClass = ZipArchive pdfRendererName = DomPDF pdfRendererPath = ; tempDir = "C:\PhpWordTemp" outputEscapingEnabled = false [Font] defaultFontName = Arial defaultFontSize = 10 defaultFontColor = 000000 [Paper] defaultPaper = "A4" ================================================ FILE: samples/Sample_01_SimpleText.php ================================================ getSettings()->setThemeFontLang($languageEnGb); $fontStyleName = 'rStyle'; $phpWord->addFontStyle($fontStyleName, ['bold' => true, 'italic' => true, 'size' => 16, 'allCaps' => true, 'doubleStrikethrough' => true]); $paragraphStyleName = 'pStyle'; $phpWord->addParagraphStyle($paragraphStyleName, ['alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER, 'spaceAfter' => 100]); $phpWord->addTitleStyle(1, ['bold' => true], ['spaceAfter' => 240]); // New portrait section $section = $phpWord->addSection(); // Simple text $section->addTitle('Welcome to PhpWord', 1); $section->addText('Hello World!'); // $pStyle = new Font(); // $pStyle->setLang() $section->addText('Ce texte-ci est en français.', ['lang' => PhpOffice\PhpWord\Style\Language::FR_BE]); // Two text break $section->addTextBreak(2); // Define styles $section->addText('I am styled by a font style definition.', $fontStyleName); $section->addText('I am styled by a paragraph style definition.', null, $paragraphStyleName); $section->addText('I am styled by both font and paragraph style.', $fontStyleName, $paragraphStyleName); $section->addTextBreak(); // Inline font style $fontStyle['name'] = 'Times New Roman'; $fontStyle['size'] = 20; $textrun = $section->addTextRun(); $textrun->addText('I am inline styled ', $fontStyle); $textrun->addText('with '); $textrun->addText('color', ['color' => '996699']); $textrun->addText(', '); $textrun->addText('bold', ['bold' => true]); $textrun->addText(', '); $textrun->addText('italic', ['italic' => true]); $textrun->addText(', '); $textrun->addText('underline', ['underline' => 'dash']); $textrun->addText(', '); $textrun->addText('strikethrough', ['strikethrough' => true]); $textrun->addText(', '); $textrun->addText('doubleStrikethrough', ['doubleStrikethrough' => true]); $textrun->addText(', '); $textrun->addText('superScript', ['superScript' => true]); $textrun->addText(', '); $textrun->addText('subScript', ['subScript' => true]); $textrun->addText(', '); $textrun->addText('smallCaps', ['smallCaps' => true]); $textrun->addText(', '); $textrun->addText('allCaps', ['allCaps' => true]); $textrun->addText(', '); $textrun->addText('fgColor', ['fgColor' => 'yellow']); $textrun->addText(', '); $textrun->addText('scale', ['scale' => 200]); $textrun->addText(', '); $textrun->addText('spacing', ['spacing' => 120]); $textrun->addText(', '); $textrun->addText('kerning', ['kerning' => 10]); $textrun->addText('. '); // Link $section->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); $section->addTextBreak(); // Image $section->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 18, 'height' => 18]); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_02_TabStops.php ================================================ addParagraphStyle( $multipleTabsStyleName, [ 'tabs' => [ new PhpOffice\PhpWord\Style\Tab('left', 1550), new PhpOffice\PhpWord\Style\Tab('center', 3200), new PhpOffice\PhpWord\Style\Tab('right', 5300), ], ] ); $rightTabStyleName = 'rightTab'; $phpWord->addParagraphStyle($rightTabStyleName, ['tabs' => [new PhpOffice\PhpWord\Style\Tab('right', 9090)]]); $leftTabStyleName = 'centerTab'; $phpWord->addParagraphStyle($leftTabStyleName, ['tabs' => [new PhpOffice\PhpWord\Style\Tab('center', 4680)]]); // New portrait section $section = $phpWord->addSection(); // Add listitem elements $section->addText("Multiple Tabs:\tOne\tTwo\tThree", null, $multipleTabsStyleName); $section->addText("Left Aligned\tRight Aligned", null, $rightTabStyleName); $section->addText("\tCenter Aligned", null, $leftTabStyleName); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_03_Sections.php ================================================ addSection(['borderColor' => '00FF00', 'borderSize' => 12]); $section->addText('I am placed on a default section.'); // New landscape section $section = $phpWord->addSection(['orientation' => 'landscape']); $section->addText('I am placed on a landscape section. Every page starting from this section will be landscape style.'); $section->addPageBreak(); $section->addPageBreak(); // New portrait section $section = $phpWord->addSection( ['paperSize' => 'Folio', 'marginLeft' => 600, 'marginRight' => 600, 'marginTop' => 600, 'marginBottom' => 600] ); $section->addText('This section uses other margins with folio papersize.'); // The text of this section is vertically centered $section = $phpWord->addSection( ['vAlign' => VerticalJc::CENTER] ); $section->addText('This section is vertically centered.'); // New portrait section with Header & Footer $section = $phpWord->addSection( [ 'marginLeft' => 200, 'marginRight' => 200, 'marginTop' => 200, 'marginBottom' => 200, 'headerHeight' => 50, 'footerHeight' => 50, ] ); $section->addText('This section and we play with header/footer height.'); $section->addHeader()->addText('Header'); $section->addFooter()->addText('Footer'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_04_Textrun.php ================================================ addParagraphStyle($paragraphStyleName, ['spacing' => 100]); $boldFontStyleName = 'BoldText'; $phpWord->addFontStyle($boldFontStyleName, ['bold' => true]); $coloredFontStyleName = 'ColoredText'; $phpWord->addFontStyle($coloredFontStyleName, ['color' => 'FF8080', 'bgColor' => 'FFFFCC']); $linkFontStyleName = 'NLink'; $phpWord->addLinkStyle($linkFontStyleName, ['color' => '0000FF', 'underline' => PhpOffice\PhpWord\Style\Font::UNDERLINE_SINGLE]); // New portrait section $section = $phpWord->addSection(); // Add text run $textrun = $section->addTextRun($paragraphStyleName); $textrun->addText('Each textrun can contain native text, link elements or an image.'); $textrun->addText(' No break is placed after adding an element.', $boldFontStyleName); $textrun->addText(' Both '); $textrun->addText('superscript', ['superScript' => true]); $textrun->addText(' and '); $textrun->addText('subscript', ['subScript' => true]); $textrun->addText(' are also available.'); $textrun->addText(' All elements are placed inside a paragraph with the optionally given paragraph style.', $coloredFontStyleName); $textrun->addText(' Sample Link: '); $textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub', $linkFontStyleName); $textrun->addText(' Sample Image: '); $textrun->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 18, 'height' => 18]); $textrun->addText(' Sample Object: '); $textrun->addObject(__DIR__ . '/resources/_sheet.xls'); $textrun->addText(' Here is some more text. '); $textrun = $section->addTextRun(); $textrun->addText('This text is not visible.', ['hidden' => true]); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_05_Multicolumn.php ================================================ addSection(); $section->addText("Normal paragraph. {$filler}"); // Two columns $section = $phpWord->addSection( [ 'colsNum' => 2, 'colsSpace' => 1440, 'breakType' => 'continuous', ] ); $section->addText("Two columns, one inch (1440 twips) spacing. {$filler}"); // Normal $section = $phpWord->addSection(['breakType' => 'continuous']); $section->addText("Normal paragraph again. {$filler}"); // Three columns $section = $phpWord->addSection( [ 'colsNum' => 3, 'colsSpace' => 720, 'breakType' => 'continuous', ] ); $section->addText("Three columns, half inch (720 twips) spacing. {$filler}"); // Normal $section = $phpWord->addSection(['breakType' => 'continuous']); $section->addText("Normal paragraph again. {$filler}"); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_06_Footnote.php ================================================ addParagraphStyle($paragraphStyleName, ['spacing' => 100]); $boldFontStyleName = 'BoldText'; $phpWord->addFontStyle($boldFontStyleName, ['bold' => true]); $coloredFontStyleName = 'ColoredText'; $phpWord->addFontStyle($coloredFontStyleName, ['color' => 'FF8080', 'bgColor' => 'FFFFCC']); $linkFontStyleName = 'NLink'; $phpWord->addLinkStyle($linkFontStyleName, ['color' => '0000FF', 'underline' => PhpOffice\PhpWord\Style\Font::UNDERLINE_SINGLE]); // New portrait section $section = $phpWord->addSection(); // Add text elements $textrun = $section->addTextRun($paragraphStyleName); $textrun->addText('This is some lead text in a paragraph with a following footnote. ', $paragraphStyleName); $footnote = $textrun->addFootnote(); $footnote->addText('Just like a textrun, a footnote can contain native texts. '); $footnote->addText('No break is placed after adding an element. ', $boldFontStyleName); $footnote->addText('All elements are placed inside a paragraph. ', $coloredFontStyleName); $footnote->addTextBreak(); $footnote->addText('But you can insert a manual text break like above, '); $footnote->addText('links like '); $footnote->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub', $linkFontStyleName); $footnote->addText(', image like '); $footnote->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 18, 'height' => 18]); $footnote->addText(', or object like '); $footnote->addObject(__DIR__ . '/resources/_sheet.xls'); $footnote->addText('But you can only put footnote in section, not in header or footer.'); $section->addText( 'You can also create the footnote directly from the section making it wrap in a paragraph ' . 'like the footnote below this paragraph. But is best used from within a textrun.' ); $footnote = $section->addFootnote(); $footnote->addText('The reference for this is wrapped in its own line'); $footnoteProperties = new FootnoteProperties(); $footnoteProperties->setNumFmt(NumberFormat::DECIMAL_ENCLOSED_CIRCLE); $section->setFootnoteProperties($footnoteProperties); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_07_TemplateCloneRow.php ================================================ setValue('weekday', date('l')); // On section/content $templateProcessor->setValue('time', date('H:i')); // On footer $templateProcessor->setValue('serverName', realpath(__DIR__)); // On header // Simple table $templateProcessor->cloneRow('rowValue', 10); $templateProcessor->setValue('rowValue#1', 'Sun'); $templateProcessor->setValue('rowValue#2', 'Mercury'); $templateProcessor->setValue('rowValue#3', 'Venus'); $templateProcessor->setValue('rowValue#4', 'Earth'); $templateProcessor->setValue('rowValue#5', 'Mars'); $templateProcessor->setValue('rowValue#6', 'Jupiter'); $templateProcessor->setValue('rowValue#7', 'Saturn'); $templateProcessor->setValue('rowValue#8', 'Uranus'); $templateProcessor->setValue('rowValue#9', 'Neptun'); $templateProcessor->setValue('rowValue#10', 'Pluto'); $templateProcessor->setValue('rowNumber#1', '1'); $templateProcessor->setValue('rowNumber#2', '2'); $templateProcessor->setValue('rowNumber#3', '3'); $templateProcessor->setValue('rowNumber#4', '4'); $templateProcessor->setValue('rowNumber#5', '5'); $templateProcessor->setValue('rowNumber#6', '6'); $templateProcessor->setValue('rowNumber#7', '7'); $templateProcessor->setValue('rowNumber#8', '8'); $templateProcessor->setValue('rowNumber#9', '9'); $templateProcessor->setValue('rowNumber#10', '10'); // Table with a spanned cell $values = [ [ 'userId' => 1, 'userFirstName' => 'James', 'userName' => 'Taylor', 'userPhone' => '+1 428 889 773', ], [ 'userId' => 2, 'userFirstName' => 'Robert', 'userName' => 'Bell', 'userPhone' => '+1 428 889 774', ], [ 'userId' => 3, 'userFirstName' => 'Michael', 'userName' => 'Ray', 'userPhone' => '+1 428 889 775', ], ]; $templateProcessor->cloneRowAndSetValues('userId', $values); //this is equivalent to cloning and settings values with cloneRowAndSetValues // $templateProcessor->cloneRow('userId', 3); // $templateProcessor->setValue('userId#1', '1'); // $templateProcessor->setValue('userFirstName#1', 'James'); // $templateProcessor->setValue('userName#1', 'Taylor'); // $templateProcessor->setValue('userPhone#1', '+1 428 889 773'); // $templateProcessor->setValue('userId#2', '2'); // $templateProcessor->setValue('userFirstName#2', 'Robert'); // $templateProcessor->setValue('userName#2', 'Bell'); // $templateProcessor->setValue('userPhone#2', '+1 428 889 774'); // $templateProcessor->setValue('userId#3', '3'); // $templateProcessor->setValue('userFirstName#3', 'Michael'); // $templateProcessor->setValue('userName#3', 'Ray'); // $templateProcessor->setValue('userPhone#3', '+1 428 889 775'); echo date('H:i:s'), ' Saving the result document...', EOL; $templateProcessor->saveAs(__DIR__ . '/results/Sample_07_TemplateCloneRow.docx'); echo getEndingNotes(['Word2007' => 'docx'], __DIR__ . '/results/Sample_07_TemplateCloneRow.docx'); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_08_ParagraphPagination.php ================================================ setDefaultParagraphStyle( [ 'alignment' => PhpOffice\PhpWord\SimpleType\Jc::BOTH, 'spaceAfter' => PhpOffice\PhpWord\Shared\Converter::pointToTwip(12), 'spacing' => 120, ] ); // New section $section = $phpWord->addSection(); $section->addText( 'Below are the samples on how to control your paragraph ' . 'pagination. See "Line and Page Break" tab on paragraph properties ' . 'window to see the attribute set by these controls.', ['bold' => true], ['space' => ['before' => 360, 'after' => 480]] ); $section->addText( 'Paragraph with widowControl = false (default: true). ' . 'A "widow" is the last line of a paragraph printed by itself at the top ' . 'of a page. An "orphan" is the first line of a paragraph printed by ' . 'itself at the bottom of a page. Set this option to "false" if you want ' . 'to disable this automatic control.', null, ['widowControl' => false, 'indentation' => ['left' => 240, 'right' => 120]] ); $section->addText( 'Paragraph with keepNext = true (default: false). ' . '"Keep with next" is used to prevent Word from inserting automatic page ' . 'breaks between paragraphs. Set this option to "true" if you do not want ' . 'your paragraph to be separated with the next paragraph.', null, ['keepNext' => true, 'indentation' => ['firstLine' => 240]] ); $section->addText( 'Paragraph with keepLines = true (default: false). ' . '"Keep lines together" will prevent Word from inserting an automatic page ' . 'break within a paragraph. Set this option to "true" if you do not want ' . 'all lines of your paragraph to be in the same page.', null, ['keepLines' => true, 'indentation' => ['left' => 240, 'hanging' => 240]] ); $section->addText('Keep scrolling. More below.'); $section->addText( 'Paragraph with pageBreakBefore = true (default: false). ' . 'Different with all other control above, "page break before" separates ' . 'your paragraph into the next page. This option is most useful for ' . 'heading styles.', null, ['pageBreakBefore' => true] ); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_09_Tables.php ================================================ addSection(); $header = ['size' => 16, 'bold' => true]; // 1. Basic table $rows = 10; $cols = 5; $section->addText('Basic table', $header); $table = $section->addTable(); for ($r = 1; $r <= $rows; ++$r) { $table->addRow(); for ($c = 1; $c <= $cols; ++$c) { $table->addCell(1750)->addText("Row {$r}, Cell {$c}"); } } // 2. Advanced table $section->addTextBreak(1); $section->addText('Fancy table', $header); $fancyTableStyleName = 'Fancy Table'; $fancyTableStyle = ['borderSize' => 6, 'borderColor' => '006699', 'cellMargin' => 80, 'alignment' => PhpOffice\PhpWord\SimpleType\JcTable::CENTER, 'cellSpacing' => 50]; $fancyTableFirstRowStyle = ['borderBottomSize' => 18, 'borderBottomColor' => '0000FF', 'bgColor' => '66BBFF']; $fancyTableCellStyle = ['valign' => 'center']; $fancyTableCellBtlrStyle = ['valign' => 'center', 'textDirection' => PhpOffice\PhpWord\Style\Cell::TEXT_DIR_BTLR]; $fancyTableFontStyle = ['bold' => true]; $phpWord->addTableStyle($fancyTableStyleName, $fancyTableStyle, $fancyTableFirstRowStyle); $table = $section->addTable($fancyTableStyleName); $table->addRow(900); $table->addCell(2000, $fancyTableCellStyle)->addText('Row 1', $fancyTableFontStyle); $table->addCell(2000, $fancyTableCellStyle)->addText('Row 2', $fancyTableFontStyle); $table->addCell(2000, $fancyTableCellStyle)->addText('Row 3', $fancyTableFontStyle); $table->addCell(2000, $fancyTableCellStyle)->addText('Row 4', $fancyTableFontStyle); $table->addCell(500, $fancyTableCellBtlrStyle)->addText('Row 5', $fancyTableFontStyle); for ($i = 1; $i <= 8; ++$i) { $table->addRow(); $table->addCell(2000)->addText("Cell {$i}"); $table->addCell(2000)->addText("Cell {$i}"); $table->addCell(2000)->addText("Cell {$i}"); $table->addCell(2000)->addText("Cell {$i}"); $text = (0 == $i % 2) ? 'X' : ''; $table->addCell(500)->addText($text); } /* * 3. colspan (gridSpan) and rowspan (vMerge) * ------------------------- * | A | B | C | * |-----|-----------| | * | D | | * ------|-----------| | * | E | F | G | | * ------------------------- */ $section->addPageBreak(); $section->addText('Table with colspan and rowspan', $header); $fancyTableStyle = ['borderSize' => 6, 'borderColor' => '999999']; $cellRowSpan = ['vMerge' => 'restart', 'valign' => 'center', 'bgColor' => 'FFFF00']; $cellRowContinue = ['vMerge' => 'continue']; $cellColSpan = ['gridSpan' => 2, 'valign' => 'center']; $cellHCentered = ['alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]; $cellVCentered = ['valign' => 'center']; $spanTableStyleName = 'Colspan Rowspan'; $phpWord->addTableStyle($spanTableStyleName, $fancyTableStyle); $table = $section->addTable($spanTableStyleName); $row1 = $table->addRow(); $row1->addCell(500)->addText('A'); $row1->addCell(1000, ['gridSpan' => 2])->addText('B'); $row1->addCell(500, ['vMerge' => 'restart'])->addText('C'); $row2 = $table->addRow(); $row2->addCell(1500, ['gridSpan' => 3])->addText('D'); $row2->addCell(null, ['vMerge' => 'continue']); $row3 = $table->addRow(); $row3->addCell(500)->addText('E'); $row3->addCell(500)->addText('F'); $row3->addCell(500)->addText('G'); $row3->addCell(null, ['vMerge' => 'continue']); /* * 4. colspan (gridSpan) and rowspan (vMerge) * --------------------- * | | B | 1 | * | A | |----| * | | | 2 | * | |---|----|----| * | | C | D | 3 | * --------------------- * @see https://github.com/PHPOffice/PHPWord/issues/806 */ $section->addPageBreak(); $section->addText('Table with colspan and rowspan', $header); $styleTable = ['borderSize' => 6, 'borderColor' => '999999']; $phpWord->addTableStyle('Colspan Rowspan', $styleTable); $table = $section->addTable('Colspan Rowspan'); $row = $table->addRow(); $row->addCell(1000, ['vMerge' => 'restart'])->addText('A'); $row->addCell(1000, ['gridSpan' => 2, 'vMerge' => 'restart'])->addText('B'); $row->addCell(1000)->addText('1'); $row = $table->addRow(); $row->addCell(1000, ['vMerge' => 'continue']); $row->addCell(1000, ['vMerge' => 'continue', 'gridSpan' => 2]); $row->addCell(1000)->addText('2'); $row = $table->addRow(); $row->addCell(1000, ['vMerge' => 'continue']); $row->addCell(1000)->addText('C'); $row->addCell(1000)->addText('D'); $row->addCell(1000)->addText('3'); // 5. Nested table $section->addTextBreak(2); $section->addText('Nested table in a centered and 50% width table.', $header); $table = $section->addTable(['width' => 50 * 50, 'unit' => 'pct', 'alignment' => PhpOffice\PhpWord\SimpleType\JcTable::CENTER]); $cell = $table->addRow()->addCell(); $cell->addText('This cell contains nested table.'); $innerCell = $cell->addTable(['alignment' => PhpOffice\PhpWord\SimpleType\JcTable::CENTER])->addRow()->addCell(); $innerCell->addText('Inside nested table'); // 6. Table with floating position $section->addTextBreak(2); $section->addText('Table with floating positioning.', $header); $table = $section->addTable(['borderSize' => 6, 'borderColor' => '999999', 'position' => ['vertAnchor' => TablePosition::VANCHOR_TEXT, 'bottomFromText' => Converter::cmToTwip(1)]]); $cell = $table->addRow()->addCell(); $cell->addText('This is a single cell.'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_10_EastAsianFontStyle.php ================================================ addSection(); $header = ['size' => 16, 'bold' => true]; //1.Use EastAisa FontStyle $section->addText('中文楷体样式测试', ['name' => '楷体', 'size' => 16, 'color' => '1B2232', 'lang' => ['latin' => 'en-US', 'eastAsia' => 'zh-CN']]); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_11_ReadWord2007.php ================================================ addSection(); // Add first page header $header = $section->addHeader(); $header->firstPage(); $table = $header->addTable(); $table->addRow(); $cell = $table->addCell(4500); $textrun = $cell->addTextRun(); $textrun->addText('This is the header with '); $textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); $table->addCell(4500)->addImage(__DIR__ . '/resources/PhpWord.png', ['width' => 80, 'height' => 80, 'alignment' => PhpOffice\PhpWord\SimpleType\Jc::END]); // Add header for all other pages $subsequent = $section->addHeader(); $subsequent->addText('Subsequent pages in Section 1 will Have this!'); $subsequent->addImage(__DIR__ . '/resources/_mars.jpg', ['width' => 80, 'height' => 80]); // Add footer $footer = $section->addFooter(); $footer->addPreserveText('Page {PAGE} of {NUMPAGES}.', null, ['alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]); $footer->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); // Write some text $section->addTextBreak(); $section->addText('Some text...'); // Create a second page $section->addPageBreak(); // Write some text $section->addTextBreak(); $section->addText('Some text...'); // Create a third page $section->addPageBreak(); // Write some text $section->addTextBreak(); $section->addText('Some text...'); // New portrait section $section2 = $phpWord->addSection(); $sec2Header = $section2->addHeader(); $sec2Header->addText('All pages in Section 2 will Have this!'); // Write some text $section2->addTextBreak(); $section2->addText('Some text...'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_13_Images.php ================================================ addSection(); $section->addText('Local image without any styles:'); $section->addImage(__DIR__ . '/resources/_mars.jpg'); printSeparator($section); $section->addText('Local image with styles:'); $section->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 210, 'height' => 210, 'alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]); // Remote image printSeparator($section); $source = 'http://php.net/images/logos/php-med-trans-light.gif'; $section->addText("Remote image from: {$source}"); $section->addImage($source); // Image from string printSeparator($section); $source = __DIR__ . '/resources/_mars.jpg'; $fileContent = file_get_contents($source); $section->addText('Image from string'); $section->addImage($fileContent); //Wrapping style printSeparator($section); $text = str_repeat('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. ', 2); $wrappingStyles = ['inline', 'behind', 'infront', 'square', 'tight']; foreach ($wrappingStyles as $wrappingStyle) { $section->addText("Wrapping style {$wrappingStyle}"); $section->addImage( __DIR__ . '/resources/_earth.jpg', [ 'positioning' => 'relative', 'marginTop' => -1, 'marginLeft' => 1, 'width' => 80, 'height' => 80, 'wrappingStyle' => $wrappingStyle, 'wrapDistanceRight' => Converter::cmToPoint(1), 'wrapDistanceBottom' => Converter::cmToPoint(1), ] ); $section->addText($text); printSeparator($section); } //Absolute positioning $section->addText('Absolute positioning: see top right corner of page'); $section->addImage( __DIR__ . '/resources/_mars.jpg', [ 'width' => Converter::cmToPixel(3), 'height' => Converter::cmToPixel(3), 'positioning' => PhpOffice\PhpWord\Style\Image::POSITION_ABSOLUTE, 'posHorizontal' => PhpOffice\PhpWord\Style\Image::POSITION_HORIZONTAL_RIGHT, 'posHorizontalRel' => PhpOffice\PhpWord\Style\Image::POSITION_RELATIVE_TO_PAGE, 'posVerticalRel' => PhpOffice\PhpWord\Style\Image::POSITION_RELATIVE_TO_PAGE, 'marginLeft' => Converter::cmToPixel(15.5), 'marginTop' => Converter::cmToPixel(1.55), ] ); //Relative positioning printSeparator($section); $section->addText('Relative positioning: Horizontal position center relative to column,'); $section->addText('Vertical position top relative to line'); $section->addImage( __DIR__ . '/resources/_mars.jpg', [ 'width' => Converter::cmToPixel(3), 'height' => Converter::cmToPixel(3), 'positioning' => PhpOffice\PhpWord\Style\Image::POSITION_RELATIVE, 'posHorizontal' => PhpOffice\PhpWord\Style\Image::POSITION_HORIZONTAL_CENTER, 'posHorizontalRel' => PhpOffice\PhpWord\Style\Image::POSITION_RELATIVE_TO_COLUMN, 'posVertical' => PhpOffice\PhpWord\Style\Image::POSITION_VERTICAL_TOP, 'posVerticalRel' => PhpOffice\PhpWord\Style\Image::POSITION_RELATIVE_TO_LINE, ] ); function printSeparator(Section $section): void { $section->addTextBreak(); $lineStyle = ['weight' => 0.2, 'width' => 150, 'height' => 0, 'align' => 'center']; $section->addLine($lineStyle); $section->addTextBreak(2); } // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_14_ListItem.php ================================================ addFontStyle($fontStyleName, ['color' => 'FF0000']); $paragraphStyleName = 'P-Style'; $phpWord->addParagraphStyle($paragraphStyleName, ['spaceAfter' => 95]); $multilevelNumberingStyleName = 'multilevel'; $phpWord->addNumberingStyle( $multilevelNumberingStyleName, [ 'type' => 'multilevel', 'levels' => [ ['format' => 'decimal', 'text' => '%1.', 'left' => 360, 'hanging' => 360, 'tabPos' => 360], ['format' => 'upperLetter', 'text' => '%2.', 'left' => 720, 'hanging' => 360, 'tabPos' => 720], ], ] ); $predefinedMultilevelStyle = ['listType' => PhpOffice\PhpWord\Style\ListItem::TYPE_NUMBER_NESTED]; // New section $section = $phpWord->addSection(); // Lists $section->addText('Multilevel list.'); $section->addListItem('List Item I', 0, null, $multilevelNumberingStyleName); $section->addListItem('List Item I.a', 1, null, $multilevelNumberingStyleName); $section->addListItem('List Item I.b', 1, null, $multilevelNumberingStyleName); $section->addListItem('List Item II', 0, null, $multilevelNumberingStyleName); $section->addListItem('List Item II.a', 1, null, $multilevelNumberingStyleName); $section->addListItem('List Item III', 0, null, $multilevelNumberingStyleName); $section->addTextBreak(2); $section->addText('Basic simple bulleted list.'); $section->addListItem('List Item 1'); $section->addListItem('List Item 2'); $section->addListItem('List Item 3'); $section->addTextBreak(2); $section->addText('Continue from multilevel list above.'); $section->addListItem('List Item IV', 0, null, $multilevelNumberingStyleName); $section->addListItem('List Item IV.a', 1, null, $multilevelNumberingStyleName); $section->addTextBreak(2); $section->addText('Multilevel predefined list.'); $section->addListItem('List Item 1', 0, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addListItem('List Item 2', 0, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addListItem('List Item 3', 1, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addListItem('List Item 4', 1, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addListItem('List Item 5', 2, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addListItem('List Item 6', 1, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addListItem('List Item 7', 0, $fontStyleName, $predefinedMultilevelStyle, $paragraphStyleName); $section->addTextBreak(2); $section->addText('List with inline formatting.'); $listItemRun = $section->addListItemRun(); $listItemRun->addText('List item 1'); $listItemRun->addText(' in bold', ['bold' => true]); $listItemRun = $section->addListItemRun(1, $predefinedMultilevelStyle, $paragraphStyleName); $listItemRun->addText('List item 2'); $listItemRun->addText(' in italic', ['italic' => true]); $footnote = $listItemRun->addFootnote(); $footnote->addText('this is a footnote on a list item'); $listItemRun = $section->addListItemRun(); $listItemRun->addText('List item 3'); $listItemRun->addText(' underlined', ['underline' => 'dash']); $section->addTextBreak(2); // Numbered heading $headingNumberingStyleName = 'headingNumbering'; $phpWord->addNumberingStyle( $headingNumberingStyleName, ['type' => 'multilevel', 'levels' => [ ['pStyle' => 'Heading1', 'format' => 'decimal', 'text' => '%1'], ['pStyle' => 'Heading2', 'format' => 'decimal', 'text' => '%1.%2'], ['pStyle' => 'Heading3', 'format' => 'decimal', 'text' => '%1.%2.%3'], ], ] ); $phpWord->addTitleStyle(1, ['size' => 16], ['numStyle' => $headingNumberingStyleName, 'numLevel' => 0]); $phpWord->addTitleStyle(2, ['size' => 14], ['numStyle' => $headingNumberingStyleName, 'numLevel' => 1]); $phpWord->addTitleStyle(3, ['size' => 12], ['numStyle' => $headingNumberingStyleName, 'numLevel' => 2]); $section->addTitle('Heading 1', 1); $section->addTitle('Heading 2', 2); $section->addTitle('Heading 3', 3); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_15_Link.php ================================================ addLinkStyle($linkFontStyleName, ['bold' => true, 'color' => '808000']); // New section $section = $phpWord->addSection(); // Add hyperlink elements $section->addLink( 'https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub', ['color' => '0000FF', 'underline' => PhpOffice\PhpWord\Style\Font::UNDERLINE_SINGLE] ); $section->addTextBreak(2); $section->addLink('http://www.bing.com', null, $linkFontStyleName); $section->addLink('http://www.yahoo.com', null, $linkFontStyleName); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_16_Object.php ================================================ addSection(); $section->addText('You can open this OLE object by double clicking on the icon:'); $section->addTextBreak(2); $section->addOLEObject(__DIR__ . '/resources/_sheet.xls'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_17_TitleTOC.php ================================================ getSettings()->setUpdateFields(true); // New section $section = $phpWord->addSection(); // Define styles $fontStyle12 = ['spaceAfter' => 60, 'size' => 12]; $fontStyle10 = ['size' => 10]; $phpWord->addTitleStyle(null, ['size' => 22, 'bold' => true]); $phpWord->addTitleStyle(1, ['size' => 20, 'color' => '333333', 'bold' => true]); $phpWord->addTitleStyle(2, ['size' => 16, 'color' => '666666']); $phpWord->addTitleStyle(3, ['size' => 14, 'italic' => true]); $phpWord->addTitleStyle(4, ['size' => 12]); // Add text elements $section->addTitle('Table of contents 1', 0); $section->addTextBreak(2); // Add TOC #1 $toc = $section->addTOC($fontStyle12); $section->addTextBreak(2); // Filler $section->addText('Text between TOC'); $section->addTextBreak(2); // Add TOC #1 $section->addText('Table of contents 2'); $section->addTextBreak(2); $toc2 = $section->addTOC($fontStyle10); $toc2->setMinDepth(2); $toc2->setMaxDepth(3); // Add Titles $section->addPageBreak(); $section->addTitle('Foo n Bar', 1); $section->addText('Some text...'); $section->addTextBreak(2); $section->addTitle('I am a Subtitle of Title 1', 2); $section->addTextBreak(2); $section->addText('Some more text...'); $section->addTextBreak(2); $section->addTitle('Another Title (Title 2)', 1); $section->addText('Some text...'); $section->addPageBreak(); $section->addTitle('I am Title 3', 1); $section->addText('And more text...'); $section->addTextBreak(2); $section->addTitle('I am a Subtitle of Title 3', 2); $section->addText('Again and again, more text...'); $section->addTitle('Subtitle 3.1.1', 3); $section->addText('Text'); $section->addTitle('Subtitle 3.1.1.1', 4); $section->addText('Text'); $section->addTitle('Subtitle 3.1.1.2', 4); $section->addText('Text'); $section->addTitle('Subtitle 3.1.2', 3); $section->addText('Text'); echo date('H:i:s'), ' Note: Please refresh TOC manually.', EOL; // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_18_Watermark.php ================================================ addSection(); $header = $section->addHeader(); $header->addWatermark(__DIR__ . '/resources/_earth.jpg', ['marginTop' => 200, 'marginLeft' => 55]); $section->addText('The header reference to the current section includes a watermark image.'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_19_TextBreak.php ================================================ 24]; $paragraphStyle24 = ['spacing' => 240, 'size' => 24]; $fontStyleName = 'fontStyle'; $phpWord->addFontStyle($fontStyleName, ['size' => 9]); $paragraphStyleName = 'paragraphStyle'; $phpWord->addParagraphStyle($paragraphStyleName, ['spacing' => 480]); // New section $section = $phpWord->addSection(); $section->addText('Text break with no style:'); $section->addTextBreak(); $section->addText('Text break with defined font style:'); $section->addTextBreak(1, $fontStyleName); $section->addText('Text break with defined paragraph style:'); $section->addTextBreak(1, null, $paragraphStyleName); $section->addText('Text break with inline font style:'); $section->addTextBreak(1, $fontStyle24); $section->addText('Text break with inline paragraph style:'); $section->addTextBreak(1, null, $paragraphStyle24); $section->addText('Done.'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_20_BGColor.php ================================================ addSection(); $section->addText( 'This is some text highlighted using fgColor (limited to 15 colors)', ['fgColor' => PhpOffice\PhpWord\Style\Font::FGCOLOR_YELLOW] ); $section->addText('This one uses bgColor and is using hex value (0xfbbb10)', ['bgColor' => 'fbbb10']); $section->addText('Compatible with font colors', ['color' => '0000ff', 'bgColor' => 'fbbb10']); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_21_TableRowRules.php ================================================ addSection(); $section->addText('By default, when you insert an image, it adds a textbreak after its content.'); $section->addText('If we want a simple border around an image, we wrap the image inside a table->row->cell'); $section->addText( 'On the image with the red border, even if we set the row height to the height of the image, ' . 'the textbreak is still there:' ); $table1 = $section->addTable(['cellMargin' => 0, 'cellMarginRight' => 0, 'cellMarginBottom' => 0, 'cellMarginLeft' => 0]); $table1->addRow(3750); $cell1 = $table1->addCell(null, ['valign' => 'top', 'borderSize' => 30, 'borderColor' => 'ff0000']); $cell1->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 250, 'height' => 250, 'alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]); $section->addTextBreak(); $section->addText("But if we set the rowStyle 'exactHeight' to true, the real row height is used, removing the textbreak:"); $table2 = $section->addTable( [ 'cellMargin' => 0, 'cellMarginRight' => 0, 'cellMarginBottom' => 0, 'cellMarginLeft' => 0, ] ); $table2->addRow(3750, ['exactHeight' => true]); $cell2 = $table2->addCell(null, ['valign' => 'top', 'borderSize' => 30, 'borderColor' => '00ff00']); $cell2->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 250, 'height' => 250, 'alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]); $section->addTextBreak(); $section->addText('In this example, image is 250px height. Rows are calculated in twips, and 1px = 15twips.'); $section->addText('So: $' . "table2->addRow(3750, array('exactHeight'=>true));"); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_22_CheckBox.php ================================================ addSection(); $section->addText('Check box in section'); $section->addCheckBox('chkBox1', 'Checkbox 1'); $section->addText('Check box in table cell'); $table = $section->addTable(); $table->addRow(); $cell = $table->addCell(); $cell->addCheckBox('chkBox2', 'Checkbox 2'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_23_TemplateBlock.php ================================================ cloneBlock('CLONEME', 3); // Everything between ${tag} and ${/tag}, will be deleted/erased. $templateProcessor->deleteBlock('DELETEME'); echo date('H:i:s'), ' Saving the result document...', EOL; $templateProcessor->saveAs(__DIR__ . '/results/Sample_23_TemplateBlock.docx'); echo getEndingNotes(['Word2007' => 'docx'], __DIR__ . '/results/Sample_23_TemplateBlock.docx'); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_24_ReadODText.php ================================================ addSection(); // In section $textbox = $section->addTextBox( [ 'alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER, 'width' => 400, 'height' => 150, 'borderSize' => 1, 'borderColor' => '#FF0000', ] ); $textbox->addText('Text box content in section.'); $textbox->addText('Another line.'); $cell = $textbox->addTable()->addRow()->addCell(); $cell->addText('Table inside textbox'); // Inside table $section->addTextBreak(2); $cell = $section->addTable()->addRow()->addCell(300); $textbox = $cell->addTextBox(['borderSize' => 1, 'borderColor' => '#0000FF', 'innerMargin' => 100]); $textbox->addText('Textbox inside table'); // Inside header with textrun $header = $section->addHeader(); $textbox = $header->addTextBox(['width' => 600, 'borderSize' => 1, 'borderColor' => '#00FF00']); $textrun = $textbox->addTextRun(); $textrun->addText('TextBox in header. TextBox can contain a TextRun '); $textrun->addText('with bold text', ['bold' => true]); $textrun->addText(', '); $textrun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); $textrun->addText(', and image '); $textrun->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 18, 'height' => 18]); $textrun->addText('.'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_26_Html.php ================================================ addParagraphStyle('Heading2', ['alignment' => 'center']); $section = $phpWord->addSection(); $html = '

Adding element via HTML

'; $html .= '

Some well-formed HTML snippet needs to be used

'; $html .= '

With for example some1 inline formatting1

'; $html .= '

A link to Read the docs

'; $html .= '

היי, זה פסקה מימין לשמאל

'; $html .= '

Unordered (bulleted) list:

'; $html .= '
  • Item 1
  • Item 2
    • Item 2.1
    • Item 2.1
'; $html .= '

1.5 line height with first line text indent:

'; $html .= '

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

'; $html .= '

centered title

'; $html .= '

Ordered (numbered) list:

'; $html .= '

  1. List 1 item 1

  2. List 1 item 2
    1. sub list 1
    2. sub list 2
  3. List 1 item 3

A second list, numbering should restart

  1. List 2 item 1
  2. List 2 item 2
    1. sub list 1
    2. sub list 2
  4. List 2 item 3
    1. sub list 1, restarts with a
    2. sub list 2
'; $html .= '

List with formatted content:

'; $html .= '
  • big list item1
  • list item2 in bold
'; $html .= '

A table with formatting:

'; $html .= '
header a header b header c
12
This is bold text6
'; $html .= '

Table inside another table:

'; $html .= '
column 1column 2
Cell in parent table
'; $html .= '

The text below is not visible, click on show/hide to reveil it:

'; $html .= '

This is hidden text

'; PhpOffice\PhpWord\Shared\Html::addHtml($section, $html, false, false); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_27_Field.php ================================================ 14]); // New section $section = $phpWord->addSection(); $section->addTitle('This page demos fields'); // Add Field elements // See Element/Field.php for all options $section->addText('Date field:'); $section->addField('DATE', ['dateformat' => 'dddd d MMMM yyyy H:mm:ss'], ['PreserveFormat']); $section->addText('Style Ref field:'); $section->addField('STYLEREF', ['StyleIdentifier' => 'Heading 1']); $section->addText('Page field:'); $section->addField('PAGE', ['format' => 'Arabic']); $section->addText('Number of pages field:'); $section->addField('NUMPAGES', ['numformat' => '0,00', 'format' => 'Arabic'], ['PreserveFormat']); $section->addText('Filename field:'); $section->addField('FILENAME', ['format' => 'Upper'], ['Path', 'PreserveFormat']); $section->addTextBreak(); $textrun = $section->addTextRun(); $textrun->addText('An index field is '); $textrun->addField('XE', [], ['Italic'], 'My first index'); $textrun->addText('here:'); $indexEntryText = new TextRun(); $indexEntryText->addText('My '); $indexEntryText->addText('bold index', ['bold' => true]); $indexEntryText->addText(' entry'); $textrun = $section->addTextRun(); $textrun->addText('A complex index field is '); $textrun->addField('XE', [], ['Bold'], $indexEntryText); $textrun->addText('here:'); $section->addText('The actual index:'); $section->addField('INDEX', [], ['\\e " "'], 'right click to update the index'); $textrun = $section->addTextRun(['alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]); $textrun->addText('This is the date of lunar calendar '); $textrun->addField('DATE', ['dateformat' => 'd-M-yyyy H:mm:ss'], ['PreserveFormat', 'LunarCalendar']); $textrun->addText(' written in a textrun.'); $section->addTextBreak(); $macroText = new TextRun(); $macroText->addText('Double click', ['bold' => true]); $macroText->addText(' to '); $macroText->addText('zoom to 100%', ['italic' => true]); $section->addText('A macro button with styled text:'); $section->addField('MACROBUTTON', ['macroname' => 'Zoom100'], [], $macroText); $section->addTextBreak(); $section->addText('A macro button with simple text:'); $section->addField('MACROBUTTON', ['macroname' => 'Zoom100'], [], 'double click to zoom'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_28_ReadRTF.php ================================================ addSection(); // Add Line elements // See Element/Line.php for all options $section->addText('Horizontal Line (Inline style):'); $section->addLine( [ 'width' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(4), 'height' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(0), 'positioning' => 'absolute', ] ); $section->addText('Vertical Line (Inline style):'); $section->addLine( [ 'width' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(0), 'height' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(1), 'positioning' => 'absolute', ] ); // Two text break $section->addTextBreak(1); $section->addText('Positioned Line (red):'); $section->addLine( [ 'width' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(4), 'height' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(1), 'positioning' => 'absolute', 'posHorizontalRel' => 'page', 'posVerticalRel' => 'page', 'marginLeft' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(10), 'marginTop' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(8), 'wrappingStyle' => PhpOffice\PhpWord\Style\Image::WRAPPING_STYLE_SQUARE, 'color' => 'red', ] ); $section->addText('Horizontal Formatted Line'); $section->addLine( [ 'width' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(15), 'height' => PhpOffice\PhpWord\Shared\Converter::cmToPixel(0), 'positioning' => 'absolute', 'beginArrow' => PhpOffice\PhpWord\Style\Line::ARROW_STYLE_BLOCK, 'endArrow' => PhpOffice\PhpWord\Style\Line::ARROW_STYLE_OVAL, 'dash' => PhpOffice\PhpWord\Style\Line::DASH_STYLE_LONG_DASH_DOT_DOT, 'weight' => 10, ] ); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_30_ReadHTML.php ================================================ addSection(); // Define styles $phpWord->addTitleStyle(1, ['size' => 14, 'bold' => true]); // Arc $section->addTitle('Arc', 1); $section->addShape( 'arc', [ 'points' => '-90 20', 'frame' => ['width' => 120, 'height' => 120], 'outline' => ['color' => '#333333', 'weight' => 2, 'startArrow' => 'oval', 'endArrow' => 'open'], ] ); // Curve $section->addTitle('Curve', 1); $section->addShape( 'curve', [ 'points' => '1,100 200,1 1,50 200,50', 'connector' => 'elbow', 'outline' => [ 'color' => '#66cc00', 'weight' => 2, 'dash' => 'dash', 'startArrow' => 'diamond', 'endArrow' => 'block', ], ] ); // Line $section->addTitle('Line', 1); $section->addShape( 'line', [ 'points' => '1,1 150,30', 'outline' => [ 'color' => '#cc00ff', 'line' => 'thickThin', 'weight' => 3, 'startArrow' => 'oval', 'endArrow' => 'classic', ], ] ); // Polyline $section->addTitle('Polyline', 1); $section->addShape( 'polyline', [ 'points' => '1,30 20,10 55,20 75,10 100,40 115,50, 120,15 200,50', 'outline' => ['color' => '#cc6666', 'weight' => 2, 'startArrow' => 'none', 'endArrow' => 'classic'], ] ); // Rectangle $section->addTitle('Rectangle', 1); $section->addShape( 'rect', [ 'roundness' => 0.2, 'frame' => ['width' => 100, 'height' => 100, 'left' => 1, 'top' => 1], 'fill' => ['color' => '#FFCC33'], 'outline' => ['color' => '#990000', 'weight' => 1], 'shadow' => [], ] ); // Oval $section->addTitle('Oval', 1); $section->addShape( 'oval', [ 'frame' => ['width' => 100, 'height' => 70, 'left' => 1, 'top' => 1], 'fill' => ['color' => '#33CC99'], 'outline' => ['color' => '#333333', 'weight' => 2], 'extrusion' => [], ] ); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_32_Chart.php ================================================ addTitleStyle(1, ['size' => 14, 'bold' => true], ['keepNext' => true, 'spaceBefore' => 240]); $phpWord->addTitleStyle(2, ['size' => 14, 'bold' => true], ['keepNext' => true, 'spaceBefore' => 240]); // 2D charts $section = $phpWord->addSection(); $section->addTitle('2D charts', 1); $section = $phpWord->addSection(['colsNum' => 2, 'breakType' => 'continuous']); $chartTypes = ['pie', 'doughnut', 'bar', 'column', 'line', 'area', 'scatter', 'radar', 'stacked_bar', 'percent_stacked_bar', 'stacked_column', 'percent_stacked_column']; $twoSeries = ['bar', 'column', 'line', 'area', 'scatter', 'radar', 'stacked_bar', 'percent_stacked_bar', 'stacked_column', 'percent_stacked_column']; $threeSeries = ['bar', 'line']; $categories = ['A', 'B', 'C', 'D', 'E']; $series1 = [1, 3, 2, 5, 4]; $series2 = [3, 1, 7, 2, 6]; $series3 = [8, 3, 2, 5, 4]; $showGridLines = false; $showAxisLabels = false; $showLegend = true; $legendPosition = 't'; // r = right, l = left, t = top, b = bottom, tr = top right foreach ($chartTypes as $chartType) { $section->addTitle(ucfirst($chartType), 2); $chart = $section->addChart($chartType, $categories, $series1); $chart->getStyle()->setWidth(Converter::inchToEmu(2.5))->setHeight(Converter::inchToEmu(2)); $chart->getStyle()->setShowGridX($showGridLines); $chart->getStyle()->setShowGridY($showGridLines); $chart->getStyle()->setShowAxisLabels($showAxisLabels); $chart->getStyle()->setShowLegend($showLegend); $chart->getStyle()->setLegendPosition($legendPosition); if (in_array($chartType, $twoSeries)) { $chart->addSeries($categories, $series2); } if (in_array($chartType, $threeSeries)) { $chart->addSeries($categories, $series3); } $section->addTextBreak(); } // 3D charts $section = $phpWord->addSection(['breakType' => 'continuous']); $section->addTitle('3D charts', 1); $section = $phpWord->addSection(['colsNum' => 2, 'breakType' => 'continuous']); $chartTypes = ['pie', 'bar', 'column', 'line', 'area']; $multiSeries = ['bar', 'column', 'line', 'area']; $style = [ 'width' => Converter::cmToEmu(5), 'height' => Converter::cmToEmu(4), '3d' => true, 'showAxisLabels' => $showAxisLabels, 'showGridX' => $showGridLines, 'showGridY' => $showGridLines, ]; foreach ($chartTypes as $chartType) { $section->addTitle(ucfirst($chartType), 2); $chart = $section->addChart($chartType, $categories, $series1, $style); if (in_array($chartType, $multiSeries)) { $chart->addSeries($categories, $series2); $chart->addSeries($categories, $series3); } $section->addTextBreak(); } // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_33_FormField.php ================================================ getSettings()->getDocumentProtection()->setEditing('forms'); // New section $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText('Form fields can be added in a text run and can be in form of textinput '); $textrun->addFormField('textinput')->setName('MyTextBox'); $textrun->addText(', checkbox '); $textrun->addFormField('checkbox')->setDefault(true); $textrun->addText(', or dropdown '); $textrun->addFormField('dropdown')->setEntries(['Choice 1', 'Choice 2', 'Choice 3']); $textrun->addText('. You have to set document protection to "forms" to enable dropdown.'); $section->addText('They can also be added as a stand alone paragraph.'); $section->addFormField('textinput')->setValue('Your name'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_34_SDT.php ================================================ addSection(); $textrun = $section->addTextRun(); $textrun->addText('Combobox: '); $textrun->addSDT('comboBox')->setListItems(['1' => 'Choice 1', '2' => 'Choice 2']); $textrun = $section->addTextRun(); $textrun->addText('Date: '); $textrun->addSDT('date'); $textrun->addTextBreak(1); $textrun->addText('Date with pre set value: '); $textrun->addSDT('date')->setValue('03/30/2017'); $textrun->addTextBreak(1); $textrun->addText('Date with pre set value: '); $textrun->addSDT('date')->setValue('30.03.2017'); $textrun = $section->addTextRun(); $textrun->addText('Drop down list: '); $textrun->addSDT('dropDownList')->setListItems(['1' => 'Choice 1', '2' => 'Choice 2'])->setValue('Choice 1'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_35_InternalLink.php ================================================ addSection(); $section->addTitle('This is page 1', 1); $linkIsInternal = true; $section->addLink('MyBookmark', 'Take me to page 3', null, null, $linkIsInternal); $section->addPageBreak(); $section->addTitle('This is page 2', 1); $section->addPageBreak(); $section->addTitle('This is page 3', 1); $section->addBookmark('MyBookmark'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_36_RTL.php ================================================ setDefaultFontName('DejaVu Sans'); // for good rendition of PDF $rendererName = Settings::PDF_RENDERER_MPDF; $rendererLibraryPath = $vendorDirPath . '/mpdf/mpdf'; Settings::setPdfRenderer($rendererName, $rendererLibraryPath); // New section $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText('This is a Left to Right paragraph.'); $textrun = $section->addTextRun(['alignment' => PhpOffice\PhpWord\SimpleType\Jc::END]); $textrun->addText('سلام این یک پاراگراف راست به چپ است', ['rtl' => true]); $section->addText('Table visually presented as RTL'); $style = ['rtl' => true, 'size' => 12]; $tableStyle = ['borderSize' => 6, 'borderColor' => '000000', 'width' => 5000, 'unit' => PhpOffice\PhpWord\SimpleType\TblWidth::PERCENT, 'bidiVisual' => true]; $table = $section->addTable($tableStyle); $cellHCentered = ['alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER]; $cellHEnd = ['alignment' => PhpOffice\PhpWord\SimpleType\Jc::END]; $cellVCentered = ['valign' => PhpOffice\PhpWord\SimpleType\VerticalJc::CENTER]; //Vidually bidirectinal table $table->addRow(); $cell = $table->addCell(1500, $cellVCentered); $textrun = $cell->addTextRun($cellHCentered); $textrun->addText('ردیف', $style); $cell = $table->addCell(2000); $textrun = $cell->addTextRun($cellHEnd); $textrun->addText('سوالات', $style); $cell = $table->addCell(1000, $cellVCentered); $textrun = $cell->addTextRun($cellHCentered); $textrun->addText('بارم', $style); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_37_Comments.php ================================================ addText('Test', ['bold' => true]); $phpWord->addComment($comment); $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText('This '); $text = $textrun->addText('is'); $text->setCommentRangeStart($comment); $textrun->addText(' a test'); $section->addTextBreak(2); // Let's create a comment that we will link to a start element and an end element $commentWithStartAndEnd = new PhpOffice\PhpWord\Element\Comment('Foo Bar', new DateTime()); $commentWithStartAndEnd->addText('A comment with a start and an end'); $phpWord->addComment($commentWithStartAndEnd); $textrunWithEnd = $section->addTextRun(); $textrunWithEnd->addText('This '); $textToStartOn = $textrunWithEnd->addText('is', ['bold' => true]); $textToStartOn->setCommentRangeStart($commentWithStartAndEnd); $textrunWithEnd->addText(' another', ['italic' => true]); $textToEndOn = $textrunWithEnd->addText(' test'); $textToEndOn->setCommentRangeEnd($commentWithStartAndEnd); $section->addTextBreak(2); // Let's add a comment on an image $commentOnImage = new PhpOffice\PhpWord\Element\Comment('Mr Smart', new DateTime()); $imageComment = $commentOnImage->addTextRun(); $imageComment->addText('Hey, Mars does look '); $imageComment->addText('red', ['color' => 'FF0000']); $phpWord->addComment($commentOnImage); $image = $section->addImage(__DIR__ . '/resources/_mars.jpg'); $image->setCommentRangeStart($commentOnImage); $section->addTextBreak(2); // We can also do things the other way round, link the comment to the element $anotherText = $section->addText('another text'); $comment1 = new PhpOffice\PhpWord\Element\Comment('Authors name', new DateTime(), 'my_initials'); $comment1->addText('Test', ['bold' => true]); $comment1->setStartElement($anotherText); $comment1->setEndElement($anotherText); $phpWord->addComment($comment1); // We can also do things the other way round, link the comment to the element $lastText = $section->addText('with a last text and two comments'); $comment1 = new PhpOffice\PhpWord\Element\Comment('Authors name', new DateTime(), 'my_initials'); $comment1->addText('Comment 1', ['bold' => true]); $comment1->setStartElement($lastText); $comment1->setEndElement($lastText); $phpWord->addComment($comment1); $comment2 = new PhpOffice\PhpWord\Element\Comment('Authors name', new DateTime(), 'my_initials'); $comment2->addText('Comment 2', ['bold' => true]); $comment2->setStartElement($lastText); $comment2->setEndElement($lastText); $phpWord->addComment($comment2); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_38_Protection.php ================================================ getSettings()->getDocumentProtection(); $documentProtection->setEditing(DocProtect::READ_ONLY); $documentProtection->setPassword('myPassword'); $section = $phpWord->addSection(); $section->addText('this document is password protected'); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_39_TrackChanges.php ================================================ addSection(); $textRun = $section->addTextRun(); $text = $textRun->addText('Hello World! Time to '); $text = $textRun->addText('wake ', ['bold' => true]); $text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800); $text = $textRun->addText('up'); $text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred')); $text = $textRun->addText('go to sleep'); $text->setChangeInfo(TrackChange::DELETED, 'Barney', new DateTime('@' . (time() - 3600))); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_40_TemplateSetComplexValue.php ================================================ addText('This title has been set ', ['bold' => true, 'italic' => true, 'color' => 'blue']); $title->addText('dynamically', ['bold' => true, 'italic' => true, 'color' => 'red', 'underline' => 'single']); $templateProcessor->setComplexBlock('title', $title); $inline = new TextRun(); $inline->addText('by a red italic text', ['italic' => true, 'color' => 'red']); $templateProcessor->setComplexValue('inline', $inline); $table = new Table(['borderSize' => 12, 'borderColor' => 'green', 'width' => 6000, 'unit' => TblWidth::TWIP]); $table->addRow(); $table->addCell(150)->addText('Cell A1'); $table->addCell(150)->addText('Cell A2'); $table->addCell(150)->addText('Cell A3'); $table->addRow(); $table->addCell(150)->addText('Cell B1'); $table->addCell(150)->addText('Cell B2'); $table->addCell(150)->addText('Cell B3'); $templateProcessor->setComplexBlock('table', $table); $field = new Field('DATE', ['dateformat' => 'dddd d MMMM yyyy H:mm:ss'], ['PreserveFormat']); $templateProcessor->setComplexValue('field', $field); // $link = new Link('https://github.com/PHPOffice/PHPWord'); // $templateProcessor->setComplexValue('link', $link); echo date('H:i:s'), ' Saving the result document...', EOL; $templateProcessor->saveAs(__DIR__ . '/results/Sample_40_TemplateSetComplexValue.docx'); echo getEndingNotes(['Word2007' => 'docx'], __DIR__ . '/results/Sample_40_TemplateSetComplexValue.docx'); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_41_TemplateSetChart.php ================================================ addSeries($categories, $series2); } if (in_array($chartType, $threeSeries)) { $chart->addSeries($categories, $series3); } $chart->getStyle() ->setWidth(Converter::inchToEmu(3)) ->setHeight(Converter::inchToEmu(3)); $templateProcessor->setChart("chart{$i}", $chart); ++$i; } echo date('H:i:s'), ' Saving the result document...', EOL; $templateProcessor->saveAs(__DIR__ . '/results/Sample_41_TemplateSetChart.docx'); echo getEndingNotes(['Word2007' => 'docx'], __DIR__ . '/results/Sample_41_TemplateSetChart.docx'); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_42_TemplateSetCheckbox.php ================================================ setCheckbox('checkbox', true); $templateProcessor->setCheckbox('checkbox2', false); echo date('H:i:s'), ' Saving the result document...', EOL; $templateProcessor->saveAs(__DIR__ . "/results/{$filename}"); echo getEndingNotes(['Word2007' => 'docx'], "results/{$filename}"); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_43_RTLDefault.php ================================================ setDefaultFontName('DejaVu Sans'); // for good rendition of PDF $rendererName = Settings::PDF_RENDERER_MPDF; $rendererLibraryPath = $vendorDirPath . '/mpdf/mpdf'; Settings::setPdfRenderer($rendererName, $rendererLibraryPath); // New section $section = $phpWord->addSection(); $arabic = '

الألم الذي ربما تنجم عنه بعض ا.

'; $english = '

LTR in RTL document.

'; SharedHtml::addHtml($section, $arabic, false, false); SharedHtml::addHtml($section, $english, false, false); SharedHtml::addHtml($section, $english, false, false); SharedHtml::addHtml($section, $arabic, false, false); SharedHtml::addHtml($section, $arabic, false, false); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } Settings::setDefaultRtl(false); ================================================ FILE: samples/Sample_44_ExtractVariablesFromReaderWord2007.php ================================================ getSettings()->setThemeFontLang($languageEnGb); $fontStyleName = 'rStyle'; $phpWord->addFontStyle($fontStyleName, ['bold' => true, 'italic' => true, 'size' => 16, 'allCaps' => true, 'doubleStrikethrough' => true]); $paragraphStyleName = 'pStyle'; $phpWord->addParagraphStyle($paragraphStyleName, ['alignment' => PhpOffice\PhpWord\SimpleType\Jc::CENTER, 'spaceAfter' => 100]); $phpWord->addTitleStyle(1, ['bold' => true], ['spaceAfter' => 240]); // New portrait section $section = $phpWord->addSection(); // Simple text $section->addTitle('Welcome to PhpWord', 1); $section->addText('Hello World!'); // $pStyle = new Font(); // $pStyle->setLang() $section->addText('Ce texte-ci est en français.', ['lang' => PhpOffice\PhpWord\Style\Language::FR_BE]); // Two text break $section->addTextBreak(2); // Define styles $section->addText('I am styled by a font style definition.', $fontStyleName); $section->addText('I am styled by a paragraph style definition.', null, $paragraphStyleName); $section->addText('I am styled by both font and paragraph style.', $fontStyleName, $paragraphStyleName); $section->addTextBreak(); // Inline font style $fontStyle['name'] = 'Times New Roman'; $fontStyle['size'] = 20; $textrun = $section->addTextRun(); $textrun->addText('I am inline styled ', $fontStyle); $textrun->addText('with '); $textrun->addText('color', ['color' => '996699']); $textrun->addText(', '); $textrun->addText('bold', ['bold' => true]); $textrun->addText(', '); $textrun->addText('italic', ['italic' => true]); $textrun->addText(', '); $textrun->addText('underline', ['underline' => 'dash']); $textrun->addText(', '); $textrun->addText('strikethrough', ['strikethrough' => true]); $textrun->addText(', '); $textrun->addText('doubleStrikethrough', ['doubleStrikethrough' => true]); $textrun->addText(', '); $textrun->addText('superScript', ['superScript' => true]); $textrun->addText(', '); $textrun->addText('subScript', ['subScript' => true]); $textrun->addText(', '); $textrun->addText('smallCaps', ['smallCaps' => true]); $textrun->addText(', '); $textrun->addText('allCaps', ['allCaps' => true]); $textrun->addText(', '); $textrun->addText('fgColor', ['fgColor' => 'yellow']); $textrun->addText(', '); $textrun->addText('scale', ['scale' => 200]); $textrun->addText(', '); $textrun->addText('spacing', ['spacing' => 120]); $textrun->addText(', '); $textrun->addText('kerning', ['kerning' => 10]); $textrun->addText('. '); // Link $section->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); $section->addTextBreak(); // Image $section->addImage(__DIR__ . '/resources/_earth.jpg', ['width' => 18, 'height' => 18]); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_46_RubyPhoneticGuide.php ================================================ addSection(); $section->addText('Here is some normal text with no ruby, also known as "phonetic guide", text.'); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_CENTER); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(20); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('en-US'); $textRun = $section->addTextRun(); $textRun->addText('Here is a demonstration of ruby text for '); $baseTextRun = new TextRun(null); $baseTextRun->addText('this'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('ruby-text'); $textRun->addRuby($baseTextRun, $rubyTextRun, $properties); $textRun->addText(' word.'); $textRun = $section->addTextRun(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_CENTER); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(20); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $textRun->addText('Here is a demonstration of ruby text for Japanese text: '); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $textRun->addRuby($baseTextRun, $rubyTextRun, $properties); $section->addText('You can also have ruby text for titles:'); $phpWord->addTitleStyle(1, ['name' => 'Arial', 'size' => 24, 'bold' => true, 'color' => '000099']); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_CENTER); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(50); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $textRun = new TextRun(); $textRun->addRuby($baseTextRun, $rubyTextRun, $properties); $section->addTitle($textRun, 1); // Save file echo write($phpWord, basename(__FILE__, '.php'), $writers); if (!CLI) { include_once 'Sample_Footer.php'; } ================================================ FILE: samples/Sample_Footer.php ================================================ ================================================ FILE: samples/Sample_Header.php ================================================ '); define('SCRIPT_FILENAME', basename($_SERVER['SCRIPT_FILENAME'], '.php')); define('IS_INDEX', SCRIPT_FILENAME == 'index'); Settings::loadConfig(); if (defined('DOMPDF_ENABLE_AUTOLOAD')) { Settings::setPdfRenderer(Settings::PDF_RENDERER_DOMPDF, $vendorDirPath . '/dompdf/dompdf'); } // Set writers $writers = ['Word2007' => 'docx', 'ODText' => 'odt', 'RTF' => 'rtf', 'HTML' => 'html', 'PDF' => 'pdf', 'EPub3' => 'epub']; // Set PDF renderer if (null === Settings::getPdfRendererPath()) { $writers['PDF'] = null; } // Turn output escaping on Settings::setOutputEscapingEnabled(true); // Return to the caller script when runs by CLI if (CLI) { return; } // Set titles and names $pageHeading = str_replace('_', ' ', SCRIPT_FILENAME); $pageTitle = IS_INDEX ? 'Welcome to ' : "{$pageHeading} - "; $pageTitle .= 'PHPWord'; $pageHeading = IS_INDEX ? '' : "

{$pageHeading}

"; // Populate samples $files = ''; if ($handle = opendir('.')) { $sampleFiles = []; while (false !== ($sampleFile = readdir($handle))) { $sampleFiles[] = $sampleFile; } sort($sampleFiles); closedir($handle); foreach ($sampleFiles as $file) { if (preg_match('/^Sample_\d+_/', $file)) { $name = str_replace('_', ' ', preg_replace('/(Sample_|\.php)/', '', $file)); $files .= "
  • {$name}
    • "; } } } /** * Write documents. */ function write(PhpOffice\PhpWord\PhpWord $phpWord, string $filename, array $writers): string { $result = ''; // Write documents foreach ($writers as $format => $extension) { $result .= date('H:i:s') . " Write to {$format} format"; if (null !== $extension) { $targetFile = __DIR__ . "/results/{$filename}.{$extension}"; $phpWord->save($targetFile, $format); } else { $result .= ' ... NOT DONE!'; } $result .= EOL; } $result .= getEndingNotes($writers, $filename); return $result; } /** * Get ending notes. */ function getEndingNotes(array $writers, string $filename): string { $result = ''; // Do not show execution time for index if (!IS_INDEX) { $result .= date('H:i:s') . ' Done writing file(s)' . EOL; $result .= date('H:i:s') . ' Peak memory usage: ' . (memory_get_peak_usage(true) / 1024 / 1024) . ' MB' . EOL; } // Return if (CLI) { $result .= 'The results are stored in the "results" subdirectory.' . EOL; } else { if (!IS_INDEX) { $types = array_values($writers); $result .= '

     

    '; $result .= '

    Results: '; foreach ($types as $type) { if (null !== $type) { $resultFile = 'results/' . SCRIPT_FILENAME . '.' . $type; if (file_exists($resultFile)) { $result .= "{$type} "; } } } $result .= '

    '; $result .= '
    ';
            if (file_exists($filename . '.php')) {
                $result .= highlight_file($filename . '.php', true);
            }
            $result .= '
    '; } } return $result; } ?> <?php echo $pageTitle; ?>
    ================================================ FILE: samples/bootstrap/css/phpword.css ================================================ body { padding-top: 20px; padding-bottom: 20px; min-height: 1000px; } .navbar { margin-bottom: 20px; } .passed { color: #339900; } .failed { color: #ff0000; } ================================================ FILE: samples/index.php ================================================ ['PHP 7.1', version_compare(PHP_VERSION, '7.1', '>=')], 'xml' => ['PHP extension XML', extension_loaded('xml')], 'temp' => ['Temp folder "' . Settings::getTempDir() . '" is writable', is_writable(Settings::getTempDir())], 'zip' => ['PHP extension ZipArchive (optional)', extension_loaded('zip')], 'gd' => ['PHP extension GD (optional)', extension_loaded('gd')], 'xmlw' => ['PHP extension XMLWriter (optional)', extension_loaded('xmlwriter')], 'xsl' => ['PHP extension XSL (optional)', extension_loaded('xsl')], ]; if (!CLI) { ?>

    Welcome to PHPWord, a library written in pure PHP that provides a set of classes to write to and read from different document file formats, i.e. Office Open XML (.docx), Open Document Format (.odt), and Rich Text Format (.rtf).

     

    Fork us on Github! Read the Docs

    Requirement check:'; echo '
      '; foreach ($requirements as $key => $value) { [$label, $result] = $value; $status = $result ? 'passed' : 'failed'; echo "
    • {$label} ... {$status}
      • "; } echo '
    '; include_once 'Sample_Footer.php'; } else { echo 'Requirement check:' . PHP_EOL; foreach ($requirements as $key => $value) { [$label, $result] = $value; $label = strip_tags($label); $status = $result ? '32m passed' : '31m failed'; echo "{$label} ... \033[{$status}\033[0m" . PHP_EOL; } } ================================================ FILE: samples/resources/Sample_28_ReadRTF.rtf ================================================ {\rtf1 \ansi\ansicpg1252 \deff0 {\fonttbl{\f0\fnil\fcharset0 Arial;}{\f1\fnil\fcharset0 Times New Roman;}} {\colortbl;\red255\green0\blue0;\red14\green0\blue0} {\*\generator PhpWord;} {\info{\title }{\subject }{\category }{\keywords }{\comment }{\author }{\operator }{\creatim \yr2014\mo05\dy27\hr23\min36\sec45}{\revtim \yr2014\mo05\dy27\hr23\min36\sec45}{\company }{\manager }} \deftab720\viewkind1\uc1\pard\nowidctlpar\lang1036\kerning1\fs20 {Welcome to PhpWord}\par \pard\nowidctlpar{\cf0\f0 Hello World!}\par \par \par \pard\nowidctlpar{\cf0\f0\fs32\b\i I am styled by a font style definition.}\par \pard\nowidctlpar{\cf0\f0 I am styled by a paragraph style definition.}\par \pard\nowidctlpar\qc\sa100{\cf0\f0\fs32\b\i I am styled by both font and paragraph style.}\par \pard\nowidctlpar{\cf1\f1\fs40\b\i\ul\strike\super I am inline styled.}\par \par {\field {\*\fldinst {HYPERLINK "https://github.com/PHPOffice/PHPWord"}}{\fldrslt {PHPWord on GitHub}}}\par \par } ================================================ FILE: samples/resources/Sample_30_ReadHTML.html ================================================ PHPWord

    Adding element via HTML

    Some well formed HTML snippet needs to be used

    With for example some1 inline formatting1

    Unordered (bulleted) list:

    • Item 1
    • Item 2
      • Item 2.1
      • Item 2.1

    Ordered (numbered) list:

    1. Item 1
    2. Item 2

    Double height

    Includes images

    ================================================ FILE: src/PhpWord/Autoloader.php ================================================ items; } /** * Get item by index. * * @return ?T */ public function getItem(int $index) { if (array_key_exists($index, $this->items)) { return $this->items[$index]; } return null; } /** * Set item. * * @param ?T $item */ public function setItem(int $index, $item): void { if (array_key_exists($index, $this->items)) { $this->items[$index] = $item; } } /** * Add new item. * * @param T $item */ public function addItem($item): int { $index = $this->countItems(); $this->items[$index] = $item; return $index; } /** * Get item count. */ public function countItems(): int { return count($this->items); } } ================================================ FILE: src/PhpWord/Collection/Bookmarks.php ================================================ */ class Bookmarks extends AbstractCollection { } ================================================ FILE: src/PhpWord/Collection/Charts.php ================================================ */ class Charts extends AbstractCollection { } ================================================ FILE: src/PhpWord/Collection/Comments.php ================================================ */ class Comments extends AbstractCollection { } ================================================ FILE: src/PhpWord/Collection/Endnotes.php ================================================ */ class Endnotes extends AbstractCollection { } ================================================ FILE: src/PhpWord/Collection/Footnotes.php ================================================ */ class Footnotes extends AbstractCollection { } ================================================ FILE: src/PhpWord/Collection/Titles.php ================================================ */ class Titles extends AbstractCollection { } ================================================ FILE: src/PhpWord/ComplexType/FootnoteProperties.php ================================================ pos; } /** * Set the Footnote Positioning Location (pageBottom, beneathText, sectEnd, docEnd). * * @param string $pos * * @return self */ public function setPos($pos) { $position = [ self::POSITION_PAGE_BOTTOM, self::POSITION_BENEATH_TEXT, self::POSITION_SECTION_END, self::POSITION_DOC_END, ]; if (in_array($pos, $position)) { $this->pos = $pos; } else { throw new InvalidArgumentException('Invalid value, on of ' . implode(', ', $position) . ' possible'); } return $this; } /** * Get the Footnote Numbering Format. * * @return string */ public function getNumFmt() { return $this->numFmt; } /** * Set the Footnote Numbering Format. * * @param string $numFmt One of NumberFormat * * @return self */ public function setNumFmt($numFmt) { NumberFormat::validate($numFmt); $this->numFmt = $numFmt; return $this; } /** * Get the Footnote Numbering Format. * * @return float */ public function getNumStart() { return $this->numStart; } /** * Set the Footnote Numbering Format. * * @param float $numStart * * @return self */ public function setNumStart($numStart) { $this->numStart = $numStart; return $this; } /** * Get the Footnote and Endnote Numbering Starting Value. * * @return string */ public function getNumRestart() { return $this->numRestart; } /** * Set the Footnote and Endnote Numbering Starting Value (continuous, eachSect, eachPage). * * @param string $numRestart * * @return self */ public function setNumRestart($numRestart) { $restartNumbers = [ self::RESTART_NUMBER_CONTINUOUS, self::RESTART_NUMBER_EACH_SECTION, self::RESTART_NUMBER_EACH_PAGE, ]; if (in_array($numRestart, $restartNumbers)) { $this->numRestart = $numRestart; } else { throw new InvalidArgumentException('Invalid value, on of ' . implode(', ', $restartNumbers) . ' possible'); } return $this; } } ================================================ FILE: src/PhpWord/ComplexType/ProofState.php ================================================ spelling = $spelling; } else { throw new InvalidArgumentException('Invalid value, dirty or clean possible'); } return $this; } /** * Get the Spell Checking State. * * @return string */ public function getSpelling() { return $this->spelling; } /** * Set the Grammatical Checking State (dirty or clean). * * @param string $grammar * * @return self */ public function setGrammar($grammar) { if ($grammar == self::CLEAN || $grammar == self::DIRTY) { $this->grammar = $grammar; } else { throw new InvalidArgumentException('Invalid value, dirty or clean possible'); } return $this; } /** * Get the Grammatical Checking State. * * @return string */ public function getGrammar() { return $this->grammar; } } ================================================ FILE: src/PhpWord/ComplexType/RubyProperties.php ================================================ alignment = self::ALIGNMENT_DISTRIBUTE_SPACE; $this->fontFaceSize = 12; $this->fontPointsAboveText = 22; $this->languageId = 'ja-JP'; $this->baseTextFontSize = 24; } /** * Get the ruby alignment. */ public function getAlignment(): string { return $this->alignment; } /** * Set the Ruby Alignment (center, distributeLetter, distributeSpace, left, right, rightVertical). */ public function setAlignment(string $alignment): self { $alignmentTypes = [ self::ALIGNMENT_CENTER, self::ALIGNMENT_DISTRIBUTE_LETTER, self::ALIGNMENT_DISTRIBUTE_SPACE, self::ALIGNMENT_LEFT, self::ALIGNMENT_RIGHT, self::ALIGNMENT_RIGHT_VERTICAL, ]; if (in_array($alignment, $alignmentTypes)) { $this->alignment = $alignment; } else { throw new InvalidArgumentException('Invalid value, alignments of ' . implode(', ', $alignmentTypes) . ' possible'); } return $this; } /** * Get the ruby font face size. */ public function getFontFaceSize(): float { return $this->fontFaceSize; } /** * Set the ruby font face size. */ public function setFontFaceSize(float $size): self { $this->fontFaceSize = $size; return $this; } /** * Get the ruby font points above base text. */ public function getFontPointsAboveBaseText(): float { return $this->fontPointsAboveText; } /** * Set the ruby font points above base text. */ public function setFontPointsAboveBaseText(float $size): self { $this->fontPointsAboveText = $size; return $this; } /** * Get the ruby font size for base text. */ public function getFontSizeForBaseText(): float { return $this->baseTextFontSize; } /** * Set the ruby font size for base text. */ public function setFontSizeForBaseText(float $size): self { $this->baseTextFontSize = $size; return $this; } /** * Get the ruby language id. */ public function getLanguageId(): string { return $this->languageId; } /** * Set the ruby language id. */ public function setLanguageId(string $langId): self { $this->languageId = $langId; return $this; } } ================================================ FILE: src/PhpWord/ComplexType/TblWidth.php ================================================ value = $value; TblWidthSimpleType::validate($type); $this->type = $type; } /** * @return string */ public function getType() { return $this->type; } /** * @return int */ public function getValue() { return $this->value; } } ================================================ FILE: src/PhpWord/ComplexType/TrackChangesView.php ================================================ markup; } /** * Set Display Visual Indicator Of Markup Area. * * @param ?bool $markup * Set to true to show markup */ public function setMarkup($markup): void { $this->markup = $markup === null ? true : $markup; } /** * Get Display Comments. * * @return bool True if comments are shown */ public function hasComments() { return $this->comments; } /** * Set Display Comments. * * @param ?bool $comments * Set to true to show comments */ public function setComments($comments): void { $this->comments = $comments === null ? true : $comments; } /** * Get Display Content Revisions. * * @return bool True if content revisions are shown */ public function hasInsDel() { return $this->insDel; } /** * Set Display Content Revisions. * * @param ?bool $insDel * Set to true to show content revisions */ public function setInsDel($insDel): void { $this->insDel = $insDel === null ? true : $insDel; } /** * Get Display Formatting Revisions. * * @return bool True if formatting revisions are shown */ public function hasFormatting() { return $this->formatting; } /** * Set Display Formatting Revisions. * * @param null|bool $formatting * Set to true to show formatting revisions */ public function setFormatting($formatting = null): void { $this->formatting = $formatting === null ? true : $formatting; } /** * Get Display Ink Annotations. * * @return bool True if ink annotations are shown */ public function hasInkAnnotations() { return $this->inkAnnotations; } /** * Set Display Ink Annotations. * * @param ?bool $inkAnnotations * Set to true to show ink annotations */ public function setInkAnnotations($inkAnnotations): void { $this->inkAnnotations = $inkAnnotations === null ? true : $inkAnnotations; } } ================================================ FILE: src/PhpWord/Element/AbstractContainer.php ================================================ addElement($element, $fontStyle, $paragraphStyle); } } else { // All other elements array_unshift($args, $element); // Prepend element name to the beginning of args array return call_user_func_array([$this, 'addElement'], $args); } } return null; } /** * Add element. * * Each element has different number of parameters passed * * @param string $elementName * * @return AbstractElement */ protected function addElement($elementName) { $elementClass = __NAMESPACE__ . '\\' . $elementName; $this->checkValidity($elementName); // Get arguments $args = func_get_args(); $withoutP = in_array($this->container, ['TextRun', 'Footnote', 'Endnote', 'ListItemRun', 'Field']); if ($withoutP && ($elementName == 'Text' || $elementName == 'PreserveText')) { $args[3] = null; // Remove paragraph style for texts in textrun } // Create element using reflection $reflection = new ReflectionClass($elementClass); $elementArgs = $args; array_shift($elementArgs); // Shift the $elementName off the beginning of array /** @var AbstractElement $element Type hint */ $element = $reflection->newInstanceArgs($elementArgs); // Set parent container $element->setParentContainer($this); $element->setElementIndex($this->countElements() + 1); $element->setElementId(); $this->elements[] = $element; return $element; } /** * Get all elements. * * @return AbstractElement[] */ public function getElements() { return $this->elements; } /** * Returns the element at the requested position. * * @param int $index * * @return null|AbstractElement */ public function getElement($index) { if (array_key_exists($index, $this->elements)) { return $this->elements[$index]; } return null; } /** * Removes the element at requested index. * * @param AbstractElement|int $toRemove */ public function removeElement($toRemove): void { if (is_int($toRemove) && array_key_exists($toRemove, $this->elements)) { unset($this->elements[$toRemove]); } elseif ($toRemove instanceof AbstractElement) { foreach ($this->elements as $key => $element) { if ($element->getElementId() === $toRemove->getElementId()) { unset($this->elements[$key]); return; } } } } /** * Count elements. * * @return int */ public function countElements() { return count($this->elements); } /** * Check if a method is allowed for the current container. * * @param string $method * * @return bool */ private function checkValidity($method) { $generalContainers = [ 'Section', 'Header', 'Footer', 'Footnote', 'Endnote', 'Cell', 'TextRun', 'TextBox', 'ListItemRun', 'TrackChange', ]; $validContainers = [ 'Text' => $generalContainers, 'Bookmark' => $generalContainers, 'Link' => $generalContainers, 'TextBreak' => $generalContainers, 'Image' => $generalContainers, 'OLEObject' => $generalContainers, 'Field' => $generalContainers, 'Line' => $generalContainers, 'Shape' => $generalContainers, 'FormField' => $generalContainers, 'SDT' => $generalContainers, 'TrackChange' => $generalContainers, 'TextRun' => ['Section', 'Header', 'Footer', 'Cell', 'TextBox', 'TrackChange', 'ListItemRun'], 'ListItem' => ['Section', 'Header', 'Footer', 'Cell', 'TextBox'], 'ListItemRun' => ['Section', 'Header', 'Footer', 'Cell', 'TextBox'], 'Table' => ['Section', 'Header', 'Footer', 'Cell', 'TextBox'], 'CheckBox' => ['Section', 'Header', 'Footer', 'Cell', 'TextRun'], 'TextBox' => ['Section', 'Header', 'Footer', 'Cell'], 'Footnote' => ['Section', 'TextRun', 'Cell', 'ListItemRun'], 'Endnote' => ['Section', 'TextRun', 'Cell'], 'PreserveText' => ['Section', 'Header', 'Footer', 'Cell'], 'Title' => ['Section', 'Cell', 'Header'], 'TOC' => ['Section'], 'PageBreak' => ['Section'], 'Chart' => ['Section', 'Cell'], ]; // Special condition, e.g. preservetext can only exists in cell when // the cell is located in header or footer $validSubcontainers = [ 'PreserveText' => [['Cell'], ['Header', 'Footer', 'Section']], 'Footnote' => [['Cell', 'TextRun'], ['Section']], 'Endnote' => [['Cell', 'TextRun'], ['Section']], ]; // Check if a method is valid for current container if (isset($validContainers[$method])) { if (!in_array($this->container, $validContainers[$method])) { throw new BadMethodCallException("Cannot add {$method} in {$this->container}."); } } // Check if a method is valid for current container, located in other container if (isset($validSubcontainers[$method])) { $rules = $validSubcontainers[$method]; $containers = $rules[0]; $allowedDocParts = $rules[1]; foreach ($containers as $container) { if ($this->container == $container && !in_array($this->getDocPart(), $allowedDocParts)) { throw new BadMethodCallException("Cannot add {$method} in {$this->container}."); } } } return true; } } ================================================ FILE: src/PhpWord/Element/AbstractElement.php ================================================ phpWord; } /** * Set PhpWord as reference. */ public function setPhpWord(?PhpWord $phpWord = null): void { $this->phpWord = $phpWord; } /** * Get section number. * * @return int */ public function getSectionId() { return $this->sectionId; } /** * Set doc part. * * @param string $docPart * @param int $docPartId */ public function setDocPart($docPart, $docPartId = 1): void { $this->docPart = $docPart; $this->docPartId = $docPartId; } /** * Get doc part. * * @return string */ public function getDocPart() { return $this->docPart; } /** * Get doc part Id. * * @return int */ public function getDocPartId() { return $this->docPartId; } /** * Return media element (image, object, link) container name. * * @return string section|headerx|footerx|footnote|endnote */ private function getMediaPart() { $mediaPart = $this->docPart; if ($mediaPart == 'Header' || $mediaPart == 'Footer') { $mediaPart .= $this->docPartId; } return strtolower($mediaPart); } /** * Get element index. * * @return int */ public function getElementIndex() { return $this->elementIndex; } /** * Set element index. * * @param int $value */ public function setElementIndex($value): void { $this->elementIndex = $value; } /** * Get element unique ID. * * @return string */ public function getElementId() { return $this->elementId; } /** * Set element unique ID from 6 first digit of md5. */ public function setElementId(): void { $this->elementId = substr(md5((string) mt_rand()), 0, 6); } /** * Get relation Id. * * @return int */ public function getRelationId() { return $this->relationId; } /** * Set relation Id. * * @param int $value */ public function setRelationId($value): void { $this->relationId = $value; } /** * Get nested level. * * @return int */ public function getNestedLevel() { return $this->nestedLevel; } /** * Get comments start. */ public function getCommentsRangeStart(): ?Comments { return $this->commentsRangeStart; } /** * Get comment start. */ public function getCommentRangeStart(): ?Comment { if ($this->commentsRangeStart != null) { return $this->commentsRangeStart->getItem($this->commentsRangeStart->countItems()); } return null; } /** * Set comment start. */ public function setCommentRangeStart(Comment $value): void { if ($this instanceof Comment) { throw new InvalidArgumentException('Cannot set a Comment on a Comment'); } if ($this->commentsRangeStart == null) { $this->commentsRangeStart = new Comments(); } // Set ID early to avoid duplicates. if ($value->getElementId() == null) { $value->setElementId(); } foreach ($this->commentsRangeStart->getItems() as $comment) { if ($value->getElementId() == $comment->getElementId()) { return; } } $idxItem = $this->commentsRangeStart->addItem($value); $this->commentsRangeStart->getItem($idxItem)->setStartElement($this); } /** * Get comments end. */ public function getCommentsRangeEnd(): ?Comments { return $this->commentsRangeEnd; } /** * Get comment end. */ public function getCommentRangeEnd(): ?Comment { if ($this->commentsRangeEnd != null) { return $this->commentsRangeEnd->getItem($this->commentsRangeEnd->countItems()); } return null; } /** * Set comment end. */ public function setCommentRangeEnd(Comment $value): void { if ($this instanceof Comment) { throw new InvalidArgumentException('Cannot set a Comment on a Comment'); } if ($this->commentsRangeEnd == null) { $this->commentsRangeEnd = new Comments(); } // Set ID early to avoid duplicates. if ($value->getElementId() == null) { $value->setElementId(); } foreach ($this->commentsRangeEnd->getItems() as $comment) { if ($value->getElementId() == $comment->getElementId()) { return; } } $idxItem = $this->commentsRangeEnd->addItem($value); $this->commentsRangeEnd->getItem($idxItem)->setEndElement($this); } /** * Get parent element. * * @return null|AbstractElement */ public function getParent() { return $this->parent; } /** * Set parent container. * * Passed parameter should be a container, except for Table (contain Row) and Row (contain Cell) */ public function setParentContainer(self $container): void { $this->parentContainer = substr(get_class($container), strrpos(get_class($container), '\\') + 1); $this->parent = $container; // Set nested level $this->nestedLevel = $container->getNestedLevel(); if ($this->parentContainer == 'Cell') { ++$this->nestedLevel; } // Set phpword $this->setPhpWord($container->getPhpWord()); // Set doc part if (!$this instanceof Footnote) { $this->setDocPart($container->getDocPart(), $container->getDocPartId()); } $this->setMediaRelation(); $this->setCollectionRelation(); } /** * Set relation Id for media elements (link, image, object; legacy of OOXML). * * - Image element needs to be passed to Media object * - Icon needs to be set for Object element */ private function setMediaRelation(): void { if (!$this instanceof Link && !$this instanceof Image && !$this instanceof OLEObject) { return; } $elementName = substr(static::class, strrpos(static::class, '\\') + 1); if ($elementName == 'OLEObject') { $elementName = 'Object'; } $mediaPart = $this->getMediaPart(); $source = $this->getSource(); $image = null; if ($this instanceof Image) { $image = $this; } $rId = Media::addElement($mediaPart, strtolower($elementName), $source, $image); $this->setRelationId($rId); if ($this instanceof OLEObject) { $icon = $this->getIcon(); $rId = Media::addElement($mediaPart, 'image', $icon, new Image($icon)); $this->setImageRelationId($rId); } } /** * Set relation Id for elements that will be registered in the Collection subnamespaces. */ private function setCollectionRelation(): void { if ($this->collectionRelation === true && $this->phpWord instanceof PhpWord) { $elementName = substr(static::class, strrpos(static::class, '\\') + 1); $addMethod = "add{$elementName}"; $rId = $this->phpWord->$addMethod($this); $this->setRelationId($rId); } } /** * Check if element is located in Section doc part (as opposed to Header/Footer). * * @return bool */ public function isInSection() { return $this->docPart == 'Section'; } /** * Set new style value. * * @param mixed $styleObject Style object * @param null|array|string|Style $styleValue Style value * @param bool $returnObject Always return object * * @return mixed */ protected function setNewStyle($styleObject, $styleValue = null, $returnObject = false) { if (null !== $styleValue && is_array($styleValue)) { $styleObject->setStyleByArray($styleValue); $style = $styleObject; } else { $style = $returnObject ? $styleObject : $styleValue; } return $style; } /** * Sets the trackChange information. */ public function setTrackChange(TrackChange $trackChange): void { $this->trackChange = $trackChange; } /** * Gets the trackChange information. * * @return TrackChange */ public function getTrackChange() { return $this->trackChange; } /** * Set changed. * * @param string $type INSERTED|DELETED * @param string $author * @param null|DateTime|int $date allways in UTC */ public function setChangeInfo($type, $author, $date = null): void { $this->trackChange = new TrackChange($type, $author, $date); } /** * Set enum value. * * @param null|string $value * @param string[] $enum * @param null|string $default * * @return null|string * * @todo Merge with the same method in AbstractStyle */ protected function setEnumVal($value = null, $enum = [], $default = null) { if ($value !== null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) { throw new InvalidArgumentException("Invalid style value: {$value}"); } elseif ($value === null || trim($value) == '') { $value = $default; } return $value; } } ================================================ FILE: src/PhpWord/Element/Bookmark.php ================================================ name = SharedText::toUTF8($name); } /** * Get Bookmark name. * * @return string */ public function getName() { return $this->name; } } ================================================ FILE: src/PhpWord/Element/Cell.php ================================================ width = $width; $this->style = $this->setNewStyle(new CellStyle(), $style, true); } /** * Get cell style. * * @return ?CellStyle */ public function getStyle() { return $this->style; } /** * Get cell width. * * @return ?int */ public function getWidth() { return $this->width; } } ================================================ FILE: src/PhpWord/Element/Chart.php ================================================ setType($type); $this->addSeries($categories, $values, $seriesName); $this->style = $this->setNewStyle(new ChartStyle(), $style, true); } /** * Get type. * * @return string */ public function getType() { return $this->type; } /** * Set type. * * @param string $value */ public function setType($value): void { $enum = ['pie', 'doughnut', 'line', 'bar', 'stacked_bar', 'percent_stacked_bar', 'column', 'stacked_column', 'percent_stacked_column', 'area', 'radar', 'scatter']; $this->type = $this->setEnumVal($value, $enum, 'pie'); } /** * Add series. * * @param array $categories * @param array $values * @param null|mixed $name */ public function addSeries($categories, $values, $name = null): void { $this->series[] = [ 'categories' => $categories, 'values' => $values, 'name' => $name, ]; } /** * Get series. * * @return array */ public function getSeries() { return $this->series; } /** * Get chart style. * * @return ?ChartStyle */ public function getStyle() { return $this->style; } } ================================================ FILE: src/PhpWord/Element/CheckBox.php ================================================ setName($name); parent::__construct($text, $fontStyle, $paragraphStyle); } /** * Set name content. * * @param string $name * * @return self */ public function setName($name) { $this->name = SharedText::toUTF8($name); return $this; } /** * Get name content. * * @return string */ public function getName() { return $this->name; } } ================================================ FILE: src/PhpWord/Element/Comment.php ================================================ initials = $initials; } /** * Get Initials. * * @return string */ public function getInitials() { return $this->initials; } /** * Sets the element where this comment starts. */ public function setStartElement(AbstractElement $value): void { $this->startElement = $value; $value->setCommentRangeStart($this); } /** * Get the element where this comment starts. * * @return AbstractElement */ public function getStartElement() { return $this->startElement; } /** * Sets the element where this comment ends. */ public function setEndElement(AbstractElement $value): void { $this->endElement = $value; $value->setCommentRangeEnd($this); } /** * Get the element where this comment ends. * * @return AbstractElement */ public function getEndElement() { return $this->endElement; } } ================================================ FILE: src/PhpWord/Element/Endnote.php ================================================ [ 'properties' => [ 'format' => ['Arabic', 'ArabicDash', 'alphabetic', 'ALPHABETIC', 'roman', 'ROMAN'], ], 'options' => ['PreserveFormat'], ], 'NUMPAGES' => [ 'properties' => [ 'format' => ['Arabic', 'ArabicDash', 'CardText', 'DollarText', 'Ordinal', 'OrdText', 'alphabetic', 'ALPHABETIC', 'roman', 'ROMAN', 'Caps', 'FirstCap', 'Lower', 'Upper', ], 'numformat' => ['0', '0,00', '#.##0', '#.##0,00', '€ #.##0,00(€ #.##0,00)', '0%', '0,00%'], ], 'options' => ['PreserveFormat'], ], 'DATE' => [ 'properties' => [ 'dateformat' => [ // Generic formats 'yyyy-MM-dd', 'yyyy-MM', 'MMM-yy', 'MMM-yyyy', 'h:mm am/pm', 'h:mm:ss am/pm', 'HH:mm', 'HH:mm:ss', // Day-Month-Year formats 'dddd d MMMM yyyy', 'd MMMM yyyy', 'd-MMM-yy', 'd MMM. yy', 'd-M-yy', 'd-M-yy h:mm', 'd-M-yy h:mm:ss', 'd-M-yy h:mm am/pm', 'd-M-yy h:mm:ss am/pm', 'd-M-yy HH:mm', 'd-M-yy HH:mm:ss', 'd/M/yy', 'd/M/yy h:mm', 'd/M/yy h:mm:ss', 'd/M/yy h:mm am/pm', 'd/M/yy h:mm:ss am/pm', 'd/M/yy HH:mm', 'd/M/yy HH:mm:ss', 'd-M-yyyy', 'd-M-yyyy h:mm', 'd-M-yyyy h:mm:ss', 'd-M-yyyy h:mm am/pm', 'd-M-yyyy h:mm:ss am/pm', 'd-M-yyyy HH:mm', 'd-M-yyyy HH:mm:ss', 'd/M/yyyy', 'd/M/yyyy h:mm', 'd/M/yyyy h:mm:ss', 'd/M/yyyy h:mm am/pm', 'd/M/yyyy h:mm:ss am/pm', 'd/M/yyyy HH:mm', 'd/M/yyyy HH:mm:ss', // Month-Day-Year formats 'dddd, MMMM d yyyy', 'MMMM d yyyy', 'MMM-d-yy', 'MMM. d yy', 'M-d-yy', 'M-d-yy h:mm', 'M-d-yy h:mm:ss', 'M-d-yy h:mm am/pm', 'M-d-yy h:mm:ss am/pm', 'M-d-yy HH:mm', 'M-d-yy HH:mm:ss', 'M/d/yy', 'M/d/yy h:mm', 'M/d/yy h:mm:ss', 'M/d/yy h:mm am/pm', 'M/d/yy h:mm:ss am/pm', 'M/d/yy HH:mm', 'M/d/yy HH:mm:ss', 'M-d-yyyy', 'M-d-yyyy h:mm', 'M-d-yyyy h:mm:ss', 'M-d-yyyy h:mm am/pm', 'M-d-yyyy h:mm:ss am/pm', 'M-d-yyyy HH:mm', 'M-d-yyyy HH:mm:ss', 'M/d/yyyy', 'M/d/yyyy h:mm', 'M/d/yyyy h:mm:ss', 'M/d/yyyy h:mm am/pm', 'M/d/yyyy h:mm:ss am/pm', 'M/d/yyyy HH:mm', 'M/d/yyyy HH:mm:ss', ], ], 'options' => ['PreserveFormat', 'LunarCalendar', 'SakaEraCalendar', 'LastUsedFormat'], ], 'MACROBUTTON' => [ 'properties' => ['macroname' => ''], ], 'XE' => [ 'properties' => [], 'options' => ['Bold', 'Italic'], ], 'INDEX' => [ 'properties' => [], 'options' => ['PreserveFormat'], ], 'STYLEREF' => [ 'properties' => ['StyleIdentifier' => ''], 'options' => ['PreserveFormat'], ], 'FILENAME' => [ 'properties' => [ 'format' => ['Upper', 'Lower', 'FirstCap', 'Caps'], ], 'options' => ['Path', 'PreserveFormat'], ], 'REF' => [ 'properties' => ['name' => ''], 'options' => ['f', 'h', 'n', 'p', 'r', 't', 'w'], ], ]; /** * Field type. * * @var string */ protected $type; /** * Field text. * * @var null|string|TextRun */ protected $text; /** * Field properties. * * @var array */ protected $properties = []; /** * Field options. * * @var array */ protected $options = []; /** * Font style. * * @var Font|string */ protected $fontStyle; /** * Set Font style. * * @param array|Font|string $style * * @return Font|string */ public function setFontStyle($style = null) { if ($style instanceof Font) { $this->fontStyle = $style; } elseif (is_array($style)) { $this->fontStyle = new Font('text'); $this->fontStyle->setStyleByArray($style); } elseif (null === $style) { $this->fontStyle = null; } else { $this->fontStyle = $style; } return $this->fontStyle; } /** * Get Font style. * * @return Font|string */ public function getFontStyle() { return $this->fontStyle; } /** * Create a new Field Element. * * @param string $type * @param array $properties * @param array $options * @param null|string|TextRun $text * @param array|Font|string $fontStyle */ public function __construct($type = null, $properties = [], $options = [], $text = null, $fontStyle = null) { $this->setType($type); $this->setProperties($properties); $this->setOptions($options); $this->setText($text); $this->setFontStyle($fontStyle); } /** * Set Field type. * * @param string $type * * @return string */ public function setType($type = null) { if (isset($type)) { if (isset($this->fieldsArray[$type])) { $this->type = $type; } else { throw new InvalidArgumentException("Invalid type '$type'"); } } return $this->type; } /** * Get Field type. * * @return string */ public function getType() { return $this->type; } /** * Set Field properties. * * @return self */ public function setProperties(array $properties = []) { foreach (array_keys($properties) as $propkey) { if (!(isset($this->fieldsArray[$this->type]['properties'][$propkey]))) { throw new InvalidArgumentException("Invalid property '$propkey'"); } } $this->properties = array_merge($this->properties, $properties); return $this; } /** * Get Field properties. * * @return array */ public function getProperties() { return $this->properties; } /** * Set Field options. * * @return self */ public function setOptions(array $options = []) { foreach (array_keys($options) as $optionkey) { if (!(isset($this->fieldsArray[$this->type]['options'][$optionkey])) && substr($optionkey, 0, 1) !== '\\') { throw new InvalidArgumentException("Invalid option '$optionkey', possible values are " . implode(', ', $this->fieldsArray[$this->type]['options'])); } } $this->options = array_merge($this->options, $options); return $this; } /** * Get Field properties. * * @return array */ public function getOptions() { return $this->options; } /** * Set Field text. * * @param null|mixed|string|TextRun $text * * @return null|string|TextRun */ public function setText($text = null) { if (null !== $text) { if (is_string($text) || $text instanceof TextRun) { $this->text = $text; } else { throw new InvalidArgumentException('Invalid text'); } } return $this->text; } /** * Get Field text. * * @return string|TextRun */ public function getText() { return $this->text; } } ================================================ FILE: src/PhpWord/Element/Footer.php ================================================ sectionId = $sectionId; $this->setType($type); $this->setDocPart($this->container, ($sectionId - 1) * 3 + $containerId); } /** * Set type. * * @since 0.10.0 * * @param string $value */ public function setType($value = self::AUTO): void { if (!in_array($value, [self::AUTO, self::FIRST, self::EVEN])) { $value = self::AUTO; } $this->type = $value; } /** * Get type. * * @return string * * @since 0.10.0 */ public function getType() { return $this->type; } /** * Reset type to default. * * @return string */ public function resetType() { return $this->type = self::AUTO; } /** * First page only header. * * @return string */ public function firstPage() { return $this->type = self::FIRST; } /** * Even numbered pages only. * * @return string */ public function evenPage() { return $this->type = self::EVEN; } } ================================================ FILE: src/PhpWord/Element/Footnote.php ================================================ paragraphStyle = $this->setNewStyle(new Paragraph(), $paragraphStyle); $this->setDocPart($this->container); } /** * Get paragraph style. * * @return null|Paragraph|string */ public function getParagraphStyle() { return $this->paragraphStyle; } } ================================================ FILE: src/PhpWord/Element/FormField.php ================================================ setType($type); } /** * Get type. * * @return string */ public function getType() { return $this->type; } /** * Set type. * * @param string $value * * @return self */ public function setType($value) { $enum = ['textinput', 'checkbox', 'dropdown']; $this->type = $this->setEnumVal($value, $enum, $this->type); return $this; } /** * Get name. * * @return ?string */ public function getName() { return $this->name; } /** * Set name. * * @param ?string $value * * @return self */ public function setName($value) { $this->name = $value; return $this; } /** * Get default. * * @return bool|int|string */ public function getDefault() { return $this->default; } /** * Set default. * * @param bool|int|string $value * * @return self */ public function setDefault($value) { $this->default = $value; return $this; } /** * Get value. * * @return null|bool|int|string */ public function getValue() { return $this->value; } /** * Set value. * * @param null|bool|int|string $value * * @return self */ public function setValue($value) { $this->value = $value; return $this; } /** * Get entries. * * @return array */ public function getEntries() { return $this->entries; } /** * Set entries. * * @param array $value * * @return self */ public function setEntries($value) { $this->entries = $value; return $this; } } ================================================ FILE: src/PhpWord/Element/Formula.php ================================================ setMath($math); } public function setMath(Math $math): self { $this->math = $math; return $this; } public function getMath(): Math { return $this->math; } } ================================================ FILE: src/PhpWord/Element/Header.php ================================================ addImage($src, $style, true); } } ================================================ FILE: src/PhpWord/Element/Image.php ================================================ source = $source; $this->style = $this->setNewStyle(new ImageStyle(), $style, true); $this->setIsWatermark($watermark); $this->setName($name); $this->checkImage(); } /** * Get Image style. * * @return ?ImageStyle */ public function getStyle() { return $this->style; } /** * Get image source. * * @return string */ public function getSource() { return $this->source; } /** * Get image source type. * * @return string */ public function getSourceType() { return $this->sourceType; } /** * Sets the image name. * * @param string $value */ public function setName($value): void { $this->name = $value; } /** * Get image name. * * @return null|string */ public function getName() { return $this->name; } /** * Get image media ID. * * @return string */ public function getMediaId() { return md5($this->source); } /** * Get is watermark. * * @return bool */ public function isWatermark() { return $this->watermark; } /** * Set is watermark. * * @param bool $value */ public function setIsWatermark($value): void { $this->watermark = $value; } /** * Get image type. * * @return string */ public function getImageType() { return $this->imageType; } /** * Get image create function. * * @return string */ public function getImageCreateFunction() { return $this->imageCreateFunc; } /** * Get image function. * * @return null|callable(resource): void */ public function getImageFunction(): ?callable { return $this->imageFunc; } /** * Get image quality. */ public function getImageQuality(): ?int { return $this->imageQuality; } /** * Get image extension. * * @return string */ public function getImageExtension() { return $this->imageExtension; } /** * Get is memory image. * * @return bool */ public function isMemImage() { return $this->memoryImage; } /** * Get target file name. * * @return string */ public function getTarget() { return $this->target; } /** * Set target file name. * * @param string $value */ public function setTarget($value): void { $this->target = $value; } /** * Get media index. * * @return int */ public function getMediaIndex() { return $this->mediaIndex; } /** * Set media index. * * @param int $value */ public function setMediaIndex($value): void { $this->mediaIndex = $value; } /** * Get image string. */ public function getImageString(): ?string { $source = $this->source; $actualSource = null; $imageBinary = null; $isTemp = false; // Get actual source from archive image or other source // Return null if not found if ($this->sourceType == self::SOURCE_ARCHIVE) { $source = substr($source, 6); [$zipFilename, $imageFilename] = explode('#', $source); $zip = new ZipArchive(); if ($zip->open($zipFilename) !== false) { if ($zip->locateName($imageFilename) !== false) { $isTemp = true; $zip->extractTo(Settings::getTempDir(), $imageFilename); $actualSource = Settings::getTempDir() . DIRECTORY_SEPARATOR . $imageFilename; } } $zip->close(); } else { $actualSource = $source; } // Can't find any case where $actualSource = null hasn't captured by // preceding exceptions. Please uncomment when you find the case and // put the case into Element\ImageTest. // if ($actualSource === null) { // return null; // } // Read image binary data and convert to hex/base64 string if ($this->sourceType == self::SOURCE_GD) { $imageResource = call_user_func($this->imageCreateFunc, $actualSource); if ($this->imageType === 'image/png') { // PNG images need to preserve alpha channel information imagesavealpha($imageResource, true); } ob_start(); $callback = $this->imageFunc; $callback($imageResource); $imageBinary = ob_get_contents(); ob_end_clean(); } elseif ($this->sourceType == self::SOURCE_STRING) { $imageBinary = $this->source; } else { $fileHandle = fopen($actualSource, 'rb', false); $fileSize = filesize($actualSource); if ($fileHandle !== false && $fileSize > 0) { $imageBinary = fread($fileHandle, $fileSize); fclose($fileHandle); } } // Delete temporary file if necessary if ($isTemp === true) { @unlink($actualSource); } return $imageBinary; } /** * Get image string data. * * @param bool $base64 * * @return null|string * * @since 0.11.0 */ public function getImageStringData($base64 = false) { $imageBinary = $this->getImageString(); if ($imageBinary === null) { return null; } if ($base64) { return base64_encode($imageBinary); } return bin2hex($imageBinary); } /** * Check memory image, supported type, image functions, and proportional width/height. */ private function checkImage(): void { $this->setSourceType(); // Check image data if ($this->sourceType == self::SOURCE_ARCHIVE) { $imageData = $this->getArchiveImageSize($this->source); } elseif ($this->sourceType == self::SOURCE_STRING) { $imageData = @getimagesizefromstring($this->source); } else { $imageData = @getimagesize($this->source); } if (!is_array($imageData)) { throw new InvalidImageException(sprintf('Invalid image: %s', $this->source)); } [$actualWidth, $actualHeight, $imageType] = $imageData; // Check image type support $supportedTypes = [IMAGETYPE_JPEG, IMAGETYPE_GIF, IMAGETYPE_PNG]; if ($this->sourceType != self::SOURCE_GD && $this->sourceType != self::SOURCE_STRING) { $supportedTypes = array_merge($supportedTypes, [IMAGETYPE_BMP, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM]); } if (!in_array($imageType, $supportedTypes)) { throw new UnsupportedImageTypeException(); } // Define image functions $this->imageType = image_type_to_mime_type($imageType); $this->setFunctions(); $this->setProportionalSize($actualWidth, $actualHeight); } /** * Set source type. */ private function setSourceType(): void { if (stripos(strrev($this->source), strrev('.php')) === 0) { $this->memoryImage = true; $this->sourceType = self::SOURCE_GD; } elseif (strpos($this->source, 'zip://') !== false) { $this->memoryImage = false; $this->sourceType = self::SOURCE_ARCHIVE; } elseif (filter_var($this->source, FILTER_VALIDATE_URL) !== false) { $this->memoryImage = true; if (strpos($this->source, 'https') === 0) { $fileContent = file_get_contents($this->source); $this->source = $fileContent; $this->sourceType = self::SOURCE_STRING; } else { $this->sourceType = self::SOURCE_GD; } } elseif ((strpos($this->source, chr(0)) === false) && @file_exists($this->source)) { $this->memoryImage = false; $this->sourceType = self::SOURCE_LOCAL; } else { $this->memoryImage = true; $this->sourceType = self::SOURCE_STRING; } } /** * Get image size from archive. * * @since 0.12.0 Throws CreateTemporaryFileException. * * @param string $source * * @return null|array */ private function getArchiveImageSize($source) { $imageData = null; $source = substr($source, 6); [$zipFilename, $imageFilename] = explode('#', $source); $tempFilename = tempnam(Settings::getTempDir(), 'PHPWordImage'); if (false === $tempFilename) { throw new CreateTemporaryFileException(); // @codeCoverageIgnore } $zip = new ZipArchive(); if ($zip->open($zipFilename) !== false) { if ($zip->locateName($imageFilename) !== false) { $imageContent = $zip->getFromName($imageFilename); if ($imageContent !== false) { file_put_contents($tempFilename, $imageContent); $imageData = getimagesize($tempFilename); unlink($tempFilename); } } $zip->close(); } return $imageData; } /** * Set image functions and extensions. */ private function setFunctions(): void { switch ($this->imageType) { case 'image/png': $this->imageCreateFunc = $this->sourceType == self::SOURCE_STRING ? 'imagecreatefromstring' : 'imagecreatefrompng'; $this->imageFunc = function ($resource): void { imagepng($resource, null, $this->imageQuality); }; $this->imageExtension = 'png'; $this->imageQuality = -1; break; case 'image/gif': $this->imageCreateFunc = $this->sourceType == self::SOURCE_STRING ? 'imagecreatefromstring' : 'imagecreatefromgif'; $this->imageFunc = function ($resource): void { imagegif($resource); }; $this->imageExtension = 'gif'; $this->imageQuality = null; break; case 'image/jpeg': case 'image/jpg': $this->imageCreateFunc = $this->sourceType == self::SOURCE_STRING ? 'imagecreatefromstring' : 'imagecreatefromjpeg'; $this->imageFunc = function ($resource): void { imagejpeg($resource, null, $this->imageQuality); }; $this->imageExtension = 'jpg'; $this->imageQuality = 100; break; case 'image/bmp': case 'image/x-ms-bmp': $this->imageType = 'image/bmp'; $this->imageFunc = null; $this->imageExtension = 'bmp'; $this->imageQuality = null; break; case 'image/tiff': $this->imageType = 'image/tiff'; $this->imageFunc = null; $this->imageExtension = 'tif'; $this->imageQuality = null; break; } } /** * Set proportional width/height if one dimension not available. * * @param int $actualWidth * @param int $actualHeight */ private function setProportionalSize($actualWidth, $actualHeight): void { $styleWidth = $this->style->getWidth(); $styleHeight = $this->style->getHeight(); if (!($styleWidth && $styleHeight)) { if ($styleWidth == null && $styleHeight == null) { $this->style->setWidth($actualWidth); $this->style->setHeight($actualHeight); } elseif ($styleWidth) { $this->style->setHeight($actualHeight * ($styleWidth / $actualWidth)); } else { $this->style->setWidth($actualWidth * ($styleHeight / $actualHeight)); } } } } ================================================ FILE: src/PhpWord/Element/Line.php ================================================ style = $this->setNewStyle(new LineStyle(), $style); } /** * Get line style. * * @return ?LineStyle */ public function getStyle() { return $this->style; } } ================================================ FILE: src/PhpWord/Element/Link.php ================================================ source = SharedText::toUTF8($source); $this->text = null === $text ? $this->source : SharedText::toUTF8($text); $this->fontStyle = $this->setNewStyle(new Font('text'), $fontStyle); $this->paragraphStyle = $this->setNewStyle(new Paragraph(), $paragraphStyle); $this->internal = $internal; } /** * Get link source. * * @return string */ public function getSource() { return $this->source; } /** * Get link text. */ public function getText(): string { return $this->text; } /** * Get Text style. * * @return null|Font|string */ public function getFontStyle() { return $this->fontStyle; } /** * Get Paragraph style. * * @return null|Paragraph|string */ public function getParagraphStyle() { return $this->paragraphStyle; } /** * is internal. * * @return bool */ public function isInternal() { return $this->internal; } } ================================================ FILE: src/PhpWord/Element/ListItem.php ================================================ textObject = new Text(SharedText::toUTF8($text), $fontStyle, $paragraphStyle); $this->depth = $depth; // Version >= 0.10.0 will pass numbering style name. Older version will use old method if (null !== $listStyle && is_string($listStyle)) { $this->style = new ListItemStyle($listStyle); // @codeCoverageIgnore } else { $this->style = $this->setNewStyle(new ListItemStyle(), $listStyle, true); } } /** * Get style. * * @return ?ListItemStyle */ public function getStyle() { return $this->style; } /** * Get Text object. * * @return Text */ public function getTextObject() { return $this->textObject; } /** * Get depth. * * @return int */ public function getDepth() { return $this->depth; } /** * Get text. * * @return string * * @since 0.11.0 */ public function getText() { return $this->textObject->getText(); } } ================================================ FILE: src/PhpWord/Element/ListItemRun.php ================================================ depth = $depth; // Version >= 0.10.0 will pass numbering style name. Older version will use old method if (null !== $listStyle && is_string($listStyle)) { $this->style = new ListItemStyle($listStyle); } else { $this->style = $this->setNewStyle(new ListItemStyle(), $listStyle, true); } parent::__construct($paragraphStyle); } /** * Get ListItem style. * * @return ?ListItemStyle */ public function getStyle() { return $this->style; } /** * Get ListItem depth. * * @return int */ public function getDepth() { return $this->depth; } } ================================================ FILE: src/PhpWord/Element/OLEObject.php ================================================ source = $source; $this->style = $this->setNewStyle(new ImageStyle(), $style, true); $this->icon = realpath(__DIR__ . "/../resources/{$pathInfoExtension}.png"); return; } throw new InvalidObjectException(); } /** * Get object source. * * @return string */ public function getSource() { return $this->source; } /** * Get object style. * * @return ?ImageStyle */ public function getStyle() { return $this->style; } /** * Get object icon. * * @return string */ public function getIcon() { return $this->icon; } /** * Get image relation ID. * * @return int */ public function getImageRelationId() { return $this->imageRelationId; } /** * Set Image Relation ID. * * @param int $rId */ public function setImageRelationId($rId): void { $this->imageRelationId = $rId; } } ================================================ FILE: src/PhpWord/Element/PageBreak.php ================================================ fontStyle = $this->setNewStyle(new Font('text'), $fontStyle); $this->paragraphStyle = $this->setNewStyle(new Paragraph(), $paragraphStyle); $this->text = SharedText::toUTF8($text); $matches = preg_split('/({.*?})/', $this->text ?? '', -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY); if (isset($matches[0])) { $this->text = $matches; } } /** * Get Text style. * * @return null|Font|string */ public function getFontStyle() { return $this->fontStyle; } /** * Get Paragraph style. * * @return null|Paragraph|string */ public function getParagraphStyle() { return $this->paragraphStyle; } /** * Get Text content. * * @return null|array|string */ public function getText() { return $this->text; } } ================================================ FILE: src/PhpWord/Element/Row.php ================================================ height = $height; $this->style = $this->setNewStyle(new RowStyle(), $style, true); } /** * Add a cell. * * @param int $width * @param mixed $style * * @return Cell */ public function addCell($width = null, $style = null) { $cell = new Cell($width, $style); $cell->setParentContainer($this); $this->cells[] = $cell; return $cell; } /** * Get all cells. * * @return Cell[] */ public function getCells() { return $this->cells; } /** * Get row style. * * @return ?RowStyle */ public function getStyle() { return $this->style; } /** * Get row height. * * @return ?int */ public function getHeight() { return $this->height; } } ================================================ FILE: src/PhpWord/Element/Ruby.php ================================================ baseTextRun = $baseTextRun; $this->rubyTextRun = $rubyTextRun; $this->properties = $properties; } /** * Get base text run. */ public function getBaseTextRun(): TextRun { return $this->baseTextRun; } /** * Set the base text run. */ public function setBaseTextRun(TextRun $textRun): self { $this->baseTextRun = $textRun; return $this; } /** * Get ruby text run. */ public function getRubyTextRun(): TextRun { return $this->rubyTextRun; } /** * Set the ruby text run. */ public function setRubyTextRun(TextRun $textRun): self { $this->rubyTextRun = $textRun; return $this; } /** * Get ruby properties. */ public function getProperties(): RubyProperties { return $this->properties; } /** * Set the ruby properties. */ public function setProperties(RubyProperties $properties): self { $this->properties = $properties; return $this; } } ================================================ FILE: src/PhpWord/Element/SDT.php ================================================ setType($type); } /** * Get type. * * @return string */ public function getType() { return $this->type; } /** * Set type. * * @param string $value * * @return self */ public function setType($value) { $enum = ['plainText', 'comboBox', 'dropDownList', 'date']; $this->type = $this->setEnumVal($value, $enum, 'comboBox'); return $this; } /** * Get value. * * @return null|bool|int|string */ public function getValue() { return $this->value; } /** * Set value. * * @param null|bool|int|string $value * * @return self */ public function setValue($value) { $this->value = $value; return $this; } /** * Get listItems. * * @return array */ public function getListItems() { return $this->listItems; } /** * Set listItems. * * @param array $value * * @return self */ public function setListItems($value) { $this->listItems = $value; return $this; } /** * Get tag. * * @return string */ public function getTag() { return $this->tag; } /** * Set tag. * * @param string $tag * * @return self */ public function setTag($tag) { $this->tag = $tag; return $this; } /** * Get alias. * * @return string */ public function getAlias() { return $this->alias; } /** * Set alias. * * @param string $alias * * @return self */ public function setAlias($alias) { $this->alias = $alias; return $this; } } ================================================ FILE: src/PhpWord/Element/Section.php ================================================ sectionId = $sectionCount; $this->setDocPart($this->container, $this->sectionId); if (null === $style) { $style = new SectionStyle(); } $this->style = $this->setNewStyle(new SectionStyle(), $style); } /** * Set section style. */ public function setStyle(?array $style = null): void { if (null !== $style) { $this->style->setStyleByArray($style); } } /** * Get section style. * * @return ?SectionStyle */ public function getStyle() { return $this->style; } /** * Add header. * * @since 0.10.0 * * @param string $type * * @return Header */ public function addHeader($type = Header::AUTO) { return $this->addHeaderFooter($type, true); } /** * Add footer. * * @since 0.10.0 * * @param string $type * * @return Footer */ public function addFooter($type = Header::AUTO) { return $this->addHeaderFooter($type, false); } /** * Get header elements. * * @return Header[] */ public function getHeaders() { return $this->headers; } /** * Get footer elements. * * @return Footer[] */ public function getFooters() { return $this->footers; } /** * Get the footnote properties. * * @return FootnoteProperties */ public function getFootnoteProperties() { return $this->footnoteProperties; } /** * Set the footnote properties. */ public function setFootnoteProperties(?FootnoteProperties $footnoteProperties = null): void { $this->footnoteProperties = $footnoteProperties; } /** * Is there a header for this section that is for the first page only? * * If any of the Header instances have a type of Header::FIRST then this method returns true. * False otherwise. * * @return bool */ public function hasDifferentFirstPage() { foreach ($this->headers as $header) { if ($header->getType() == Header::FIRST) { return true; } } foreach ($this->footers as $footer) { if ($footer->getType() == Header::FIRST) { return true; } } return false; } /** * Add header/footer. * * @since 0.10.0 * * @param string $type * @param bool $header * * @return Footer|Header */ private function addHeaderFooter($type = Header::AUTO, $header = true) { $containerClass = substr(static::class, 0, strrpos(static::class, '\\') ?: 0) . '\\' . ($header ? 'Header' : 'Footer'); $collectionArray = $header ? 'headers' : 'footers'; $collection = &$this->$collectionArray; if (in_array($type, [Header::AUTO, Header::FIRST, Header::EVEN])) { $index = count($collection); /** @var AbstractContainer $container Type hint */ $container = new $containerClass($this->sectionId, ++$index, $type); $container->setPhpWord($this->phpWord); $collection[$index] = $container; return $container; } throw new Exception('Invalid header/footer type.'); } } ================================================ FILE: src/PhpWord/Element/Shape.php ================================================ setType($type); $this->style = $this->setNewStyle(new ShapeStyle(), $style); } /** * Get type. * * @return string */ public function getType() { return $this->type; } /** * Set pattern. * * @param string $value * * @return self */ public function setType($value = null) { $enum = ['arc', 'curve', 'line', 'polyline', 'rect', 'oval']; $this->type = $this->setEnumVal($value, $enum, null); return $this; } /** * Get shape style. * * @return ?ShapeStyle */ public function getStyle() { return $this->style; } } ================================================ FILE: src/PhpWord/Element/TOC.php ================================================ tocStyle = new TOCStyle(); if (null !== $tocStyle) { $this->tocStyle->setStyleByArray($tocStyle); } if (null !== $fontStyle && is_array($fontStyle)) { $this->fontStyle = new Font(); $this->fontStyle->setStyleByArray($fontStyle); } else { $this->fontStyle = $fontStyle; } $this->minDepth = $minDepth; $this->maxDepth = $maxDepth; } /** * Get all titles. * * @return array */ public function getTitles() { if (!$this->phpWord instanceof PhpWord) { return []; } $titles = $this->phpWord->getTitles()->getItems(); foreach ($titles as $i => $title) { /** @var Title $title Type hint */ $depth = $title->getDepth(); if ($this->minDepth > $depth) { unset($titles[$i]); } if (($this->maxDepth != 0) && ($this->maxDepth < $depth)) { unset($titles[$i]); } } return $titles; } /** * Get TOC Style. * * @return TOCStyle */ public function getStyleTOC() { return $this->tocStyle; } /** * Get Font Style. * * @return Font|string */ public function getStyleFont() { return $this->fontStyle; } /** * Set max depth. * * @param int $value */ public function setMaxDepth($value): void { $this->maxDepth = $value; } /** * Get Max Depth. * * @return int Max depth of titles */ public function getMaxDepth() { return $this->maxDepth; } /** * Set min depth. * * @param int $value */ public function setMinDepth($value): void { $this->minDepth = $value; } /** * Get Min Depth. * * @return int Min depth of titles */ public function getMinDepth() { return $this->minDepth; } } ================================================ FILE: src/PhpWord/Element/Table.php ================================================ style = $this->setNewStyle(new TableStyle(), $style); } /** * Add a row. * * @param int $height * @param mixed $style * * @return Row */ public function addRow($height = null, $style = null) { $row = new Row($height, $style); $row->setParentContainer($this); $this->rows[] = $row; return $row; } /** * Add a cell. * * @param int $width * @param mixed $style * * @return Cell */ public function addCell($width = null, $style = null) { $index = count($this->rows) - 1; $row = $this->rows[$index]; $cell = $row->addCell($width, $style); return $cell; } /** * Get all rows. * * @return Row[] */ public function getRows() { return $this->rows; } /** * Get table style. * * @return null|string|TableStyle */ public function getStyle() { return $this->style; } /** * Get table width. * * @return ?int */ public function getWidth() { return $this->width; } /** * Set table width. * * @param int $width */ public function setWidth($width): void { $this->width = $width; } /** * Get column count. * * @return int */ public function countColumns() { $columnCount = 0; $rowCount = count($this->rows); for ($i = 0; $i < $rowCount; ++$i) { /** @var Row $row Type hint */ $row = $this->rows[$i]; $cellCount = count($row->getCells()); if ($columnCount < $cellCount) { $columnCount = $cellCount; } } return $columnCount; } /** * The first declared cell width for each column. * * @return int[] */ public function findFirstDefinedCellWidths() { $cellWidths = []; foreach ($this->rows as $row) { $cells = $row->getCells(); if (count($cells) <= count($cellWidths)) { continue; } $cellWidths = []; foreach ($cells as $cell) { $cellWidths[] = $cell->getWidth(); } } return $cellWidths; } } ================================================ FILE: src/PhpWord/Element/Text.php ================================================ setText($text); $paragraphStyle = $this->setParagraphStyle($paragraphStyle); $this->setFontStyle($fontStyle, $paragraphStyle); } /** * Set Text style. * * @param array|Font|string $style * @param array|Paragraph|string $paragraphStyle * * @return Font|string */ public function setFontStyle($style = null, $paragraphStyle = null) { if ($style instanceof Font) { $this->fontStyle = $style; $this->setParagraphStyle($paragraphStyle); } elseif (is_array($style)) { $this->fontStyle = new Font('text', $paragraphStyle); $this->fontStyle->setStyleByArray($style); } elseif (null === $style) { $this->fontStyle = new Font('text', $paragraphStyle); } else { $this->fontStyle = $style; $this->setParagraphStyle($paragraphStyle); } return $this->fontStyle; } /** * Get Text style. * * @return Font|string */ public function getFontStyle() { return $this->fontStyle; } /** * Set Paragraph style. * * @param array|Paragraph|string $style * * @return Paragraph|string */ public function setParagraphStyle($style = null) { if (is_array($style)) { $this->paragraphStyle = new Paragraph(); $this->paragraphStyle->setStyleByArray($style); } elseif ($style instanceof Paragraph) { $this->paragraphStyle = $style; } elseif (null === $style) { $this->paragraphStyle = new Paragraph(); } else { $this->paragraphStyle = $style; } return $this->paragraphStyle; } /** * Get Paragraph style. * * @return Paragraph|string */ public function getParagraphStyle() { return $this->paragraphStyle; } /** * Set text content. * * @param string $text * * @return self */ public function setText($text) { $this->text = SharedText::toUTF8($text); return $this; } /** * Get Text content. */ public function getText(): ?string { return $this->text; } } ================================================ FILE: src/PhpWord/Element/TextBox.php ================================================ style = $this->setNewStyle(new TextBoxStyle(), $style); } /** * Get textbox style. * * @return ?TextBoxStyle */ public function getStyle() { return $this->style; } } ================================================ FILE: src/PhpWord/Element/TextBreak.php ================================================ setParagraphStyle($paragraphStyle); } if (null !== $fontStyle) { $this->setFontStyle($fontStyle, $paragraphStyle); } } /** * Set Text style. * * @param mixed $style * @param mixed $paragraphStyle * * @return Font|string */ public function setFontStyle($style = null, $paragraphStyle = null) { if ($style instanceof Font) { $this->fontStyle = $style; $this->setParagraphStyle($paragraphStyle); } elseif (is_array($style)) { $this->fontStyle = new Font('text', $paragraphStyle); $this->fontStyle->setStyleByArray($style); } else { $this->fontStyle = $style; $this->setParagraphStyle($paragraphStyle); } return $this->fontStyle; } /** * Get Text style. * * @return null|Font|string */ public function getFontStyle() { return $this->fontStyle; } /** * Set Paragraph style. * * @param array|Paragraph|string $style * * @return Paragraph|string */ public function setParagraphStyle($style = null) { if (is_array($style)) { $this->paragraphStyle = new Paragraph(); $this->paragraphStyle->setStyleByArray($style); } elseif ($style instanceof Paragraph) { $this->paragraphStyle = $style; } else { $this->paragraphStyle = $style; } return $this->paragraphStyle; } /** * Get Paragraph style. * * @return null|Paragraph|string */ public function getParagraphStyle() { return $this->paragraphStyle; } /** * Has font/paragraph style defined. * * @return bool */ public function hasStyle() { return null !== $this->fontStyle || null !== $this->paragraphStyle; } } ================================================ FILE: src/PhpWord/Element/TextRun.php ================================================ paragraphStyle = $this->setParagraphStyle($paragraphStyle); } /** * Get Paragraph style. * * @return Paragraph|string */ public function getParagraphStyle() { return $this->paragraphStyle; } /** * Set Paragraph style. * * @param array|Paragraph|string $style * * @return Paragraph|string */ public function setParagraphStyle($style = null) { if (is_array($style)) { $this->paragraphStyle = new Paragraph(); $this->paragraphStyle->setStyleByArray($style); } elseif ($style instanceof Paragraph) { $this->paragraphStyle = $style; } elseif (null === $style) { $this->paragraphStyle = new Paragraph(); } else { $this->paragraphStyle = $style; } return $this->paragraphStyle; } public function getText(): string { $outstr = ''; foreach ($this->getElements() as $element) { if ($element instanceof Text) { $outstr .= $element->getText(); } elseif ($element instanceof Ruby) { $outstr .= $element->getBaseTextRun()->getText() . ' (' . $element->getRubyTextRun()->getText() . ')'; } } return $outstr; } } ================================================ FILE: src/PhpWord/Element/Title.php ================================================ text = SharedText::toUTF8($text); } elseif ($text instanceof TextRun) { $this->text = $text; } else { throw new InvalidArgumentException('Invalid text, should be a string or a TextRun'); } $this->depth = $depth; $styleName = $depth === 0 ? 'Title' : "Heading_{$this->depth}"; if (array_key_exists($styleName, Style::getStyles())) { $this->style = str_replace('_', '', $styleName); } if ($pageNumber !== null) { $this->pageNumber = $pageNumber; } } /** * Get Title Text content. * * @return string|TextRun */ public function getText() { return $this->text; } /** * Get depth. * * @return int */ public function getDepth() { return $this->depth; } /** * Get Title style. * * @return ?string */ public function getStyle() { return $this->style; } /** * Get page number. */ public function getPageNumber(): ?int { return $this->pageNumber; } } ================================================ FILE: src/PhpWord/Element/TrackChange.php ================================================ changeType = $changeType; $this->author = $author; if ($date !== null && $date !== false) { $this->date = ($date instanceof DateTime) ? $date : new DateTime('@' . $date); } } /** * Get TrackChange Author. * * @return string */ public function getAuthor() { return $this->author; } /** * Get TrackChange Date. * * @return DateTime */ public function getDate() { return $this->date; } /** * Get the Change type. * * @return string */ public function getChangeType() { return $this->changeType; } } ================================================ FILE: src/PhpWord/Escaper/AbstractEscaper.php ================================================ escapeSingleValue($item); } } else { $input = $this->escapeSingleValue($input); } return $input; } } ================================================ FILE: src/PhpWord/Escaper/EscaperInterface.php ================================================ $code || $code >= 0x80) { return '{\\u' . $code . '}'; } if ($code == 123 || $code == 125 || $code == 92) { // open or close brace or backslash return '\\' . chr($code); } return chr($code); } protected function escapeMultibyteCharacter($code) { return '\\uc0{\\u' . $code . '}'; } /** * @see http://www.randomchaos.com/documents/?source=php_and_unicode * * @param ?string $input */ protected function escapeSingleValue($input) { $escapedValue = ''; $numberOfBytes = 1; $bytes = []; for ($i = 0; $i < strlen($input); ++$i) { $character = $input[$i]; $asciiCode = ord($character); if ($asciiCode < 128) { $escapedValue .= $this->escapeAsciiCharacter($asciiCode); } else { if (0 == count($bytes)) { if ($asciiCode < 224) { $numberOfBytes = 2; } elseif ($asciiCode < 240) { $numberOfBytes = 3; } elseif ($asciiCode < 248) { $numberOfBytes = 4; } } $bytes[] = $asciiCode; if ($numberOfBytes == count($bytes)) { if (4 == $numberOfBytes) { $multibyteCode = ($bytes[0] % 8) * 262144 + ($bytes[1] % 64) * 4096 + ($bytes[2] % 64) * 64 + ($bytes[3] % 64); } elseif (3 == $numberOfBytes) { $multibyteCode = ($bytes[0] % 16) * 4096 + ($bytes[1] % 64) * 64 + ($bytes[2] % 64); } else { $multibyteCode = ($bytes[0] % 32) * 64 + ($bytes[1] % 64); } if (65279 != $multibyteCode) { $escapedValue .= $multibyteCode < 128 ? $this->escapeAsciiCharacter($multibyteCode) : $this->escapeMultibyteCharacter($multibyteCode); } $numberOfBytes = 1; $bytes = []; } } } return $escapedValue; } } ================================================ FILE: src/PhpWord/Escaper/Xml.php ================================================ load($filename); } /** * Loads PhpWord ${variable} from file. * * @param string $filename The name of the file * * @return array The extracted variables */ public static function extractVariables(string $filename, string $readerName = 'Word2007'): array { /** @var ReaderInterface $reader */ $reader = self::createReader($readerName); $document = $reader->load($filename); $extractedVariables = []; foreach ($document->getSections() as $section) { $concatenatedText = ''; foreach ($section->getElements() as $element) { if ($element instanceof TextRun) { foreach ($element->getElements() as $textElement) { if ($textElement instanceof Text) { $text = $textElement->getText(); $concatenatedText .= $text; } } } } preg_match_all('/\$\{([^}]+)\}/', $concatenatedText, $matches); if (!empty($matches[1])) { foreach ($matches[1] as $match) { $trimmedMatch = trim($match); $extractedVariables[] = $trimmedMatch; } } } return $extractedVariables; } /** * Check if it's a concrete class (not abstract nor interface). * * @param string $class * * @return bool */ private static function isConcreteClass($class) { $reflection = new ReflectionClass($class); return !$reflection->isAbstract() && !$reflection->isInterface(); } } ================================================ FILE: src/PhpWord/Media.php ================================================ $mediaTypeCount]; switch ($mediaType) { // Images case 'image': if (null === $image) { throw new Exception('Image object not assigned.'); } $isMemImage = $image->isMemImage(); $extension = $image->getImageExtension(); $mediaData['imageExtension'] = $extension; $mediaData['imageType'] = $image->getImageType(); if ($isMemImage) { $mediaData['isMemImage'] = true; $mediaData['imageString'] = $image->getImageString(); } $target = "{$container}_image{$mediaTypeCount}.{$extension}"; $image->setTarget($target); $image->setMediaIndex($mediaTypeCount); break; // Objects case 'object': $target = "{$container}_oleObject{$mediaTypeCount}.bin"; break; // Links case 'link': $target = $source; break; } $mediaData['source'] = $source; $mediaData['target'] = $target; $mediaData['type'] = $mediaType; $mediaData['rID'] = $rId; self::$elements[$container][$mediaId] = $mediaData; return $rId; } $mediaData = self::$elements[$container][$mediaId]; if (null !== $image) { $image->setTarget($mediaData['target']); $image->setMediaIndex($mediaData['mediaIndex']); } return $mediaData['rID']; } /** * Get media elements count. * * @param string $container section|headerx|footerx|footnote|endnote * @param string $mediaType image|object|link * * @return int * * @since 0.10.0 */ public static function countElements($container, $mediaType = null) { $mediaCount = 0; if (isset(self::$elements[$container])) { foreach (self::$elements[$container] as $mediaData) { if (null !== $mediaType) { if ($mediaType == $mediaData['type']) { ++$mediaCount; } } else { ++$mediaCount; } } } return $mediaCount; } /** * Get media elements. * * @param string $container section|headerx|footerx|footnote|endnote * @param string $type image|object|link * * @return array * * @since 0.10.0 */ public static function getElements($container, $type = null) { $elements = []; // If header/footer, search for headerx and footerx where x is number if ($container == 'header' || $container == 'footer') { foreach (self::$elements as $key => $val) { if (substr($key, 0, 6) == $container) { $elements[$key] = $val; } } return $elements; } if (!isset(self::$elements[$container])) { return $elements; } return self::getElementsByType($container, $type); } /** * Get elements by media type. * * @param string $container section|footnote|endnote * @param string $type image|object|link * * @return array * * @since 0.11.0 Splitted from `getElements` to reduce complexity */ private static function getElementsByType($container, $type = null) { $elements = []; foreach (self::$elements[$container] as $key => $data) { if ($type !== null) { if ($type == $data['type']) { $elements[$key] = $data; } } else { $elements[$key] = $data; } } return $elements; } /** * Reset media elements. */ public static function resetElements(): void { self::$elements = []; } } ================================================ FILE: src/PhpWord/Metadata/Compatibility.php ================================================ ooxmlVersion; } /** * Set OOXML version. * * @param int $value * * @return self */ public function setOoxmlVersion($value) { $this->ooxmlVersion = $value; return $this; } } ================================================ FILE: src/PhpWord/Metadata/DocInfo.php ================================================ creator = ''; $this->lastModifiedBy = $this->creator; $this->created = time(); $this->modified = time(); $this->title = ''; $this->subject = ''; $this->description = ''; $this->keywords = ''; $this->category = ''; $this->company = ''; $this->manager = ''; } /** * Get Creator. * * @return string */ public function getCreator() { return $this->creator; } /** * Set Creator. * * @param string $value * * @return self */ public function setCreator($value = '') { $this->creator = $this->setValue($value, ''); return $this; } /** * Get Last Modified By. * * @return string */ public function getLastModifiedBy() { return $this->lastModifiedBy; } /** * Set Last Modified By. * * @param string $value * * @return self */ public function setLastModifiedBy($value = '') { $this->lastModifiedBy = $this->setValue($value, $this->creator); return $this; } /** * Get Created. * * @return int */ public function getCreated() { return $this->created; } /** * Set Created. * * @param int $value * * @return self */ public function setCreated($value = null) { $this->created = $this->setValue($value, time()); return $this; } /** * Get Modified. * * @return int */ public function getModified() { return $this->modified; } /** * Set Modified. * * @param int $value * * @return self */ public function setModified($value = null) { $this->modified = $this->setValue($value, time()); return $this; } /** * Get Title. * * @return string */ public function getTitle() { return $this->title; } /** * Set Title. * * @param string $value * * @return self */ public function setTitle($value = '') { $this->title = $this->setValue($value, ''); return $this; } /** * Get Description. * * @return string */ public function getDescription() { return $this->description; } /** * Set Description. * * @param string $value * * @return self */ public function setDescription($value = '') { $this->description = $this->setValue($value, ''); return $this; } /** * Get Subject. * * @return string */ public function getSubject() { return $this->subject; } /** * Set Subject. * * @param string $value * * @return self */ public function setSubject($value = '') { $this->subject = $this->setValue($value, ''); return $this; } /** * Get Keywords. * * @return string */ public function getKeywords() { return $this->keywords; } /** * Set Keywords. * * @param string $value * * @return self */ public function setKeywords($value = '') { $this->keywords = $this->setValue($value, ''); return $this; } /** * Get Category. * * @return string */ public function getCategory() { return $this->category; } /** * Set Category. * * @param string $value * * @return self */ public function setCategory($value = '') { $this->category = $this->setValue($value, ''); return $this; } /** * Get Company. * * @return string */ public function getCompany() { return $this->company; } /** * Set Company. * * @param string $value * * @return self */ public function setCompany($value = '') { $this->company = $this->setValue($value, ''); return $this; } /** * Get Manager. * * @return string */ public function getManager() { return $this->manager; } /** * Set Manager. * * @param string $value * * @return self */ public function setManager($value = '') { $this->manager = $this->setValue($value, ''); return $this; } /** * Get a List of Custom Property Names. * * @return array of string */ public function getCustomProperties() { return array_keys($this->customProperties); } /** * Check if a Custom Property is defined. * * @param string $propertyName * * @return bool */ public function isCustomPropertySet($propertyName) { return isset($this->customProperties[$propertyName]); } /** * Get a Custom Property Value. * * @param string $propertyName * * @return mixed */ public function getCustomPropertyValue($propertyName) { if ($this->isCustomPropertySet($propertyName)) { return $this->customProperties[$propertyName]['value']; } return null; } /** * Get a Custom Property Type. * * @param string $propertyName * * @return ?string */ public function getCustomPropertyType($propertyName) { if ($this->isCustomPropertySet($propertyName)) { return $this->customProperties[$propertyName]['type']; } return null; } /** * Set a Custom Property. * * @param string $propertyName * @param mixed $propertyValue * @param string $propertyType * 'i': Integer * 'f': Floating Point * 's': String * 'd': Date/Time * 'b': Boolean * * @return self */ public function setCustomProperty($propertyName, $propertyValue = '', $propertyType = null) { $propertyTypes = [ self::PROPERTY_TYPE_INTEGER, self::PROPERTY_TYPE_FLOAT, self::PROPERTY_TYPE_STRING, self::PROPERTY_TYPE_DATE, self::PROPERTY_TYPE_BOOLEAN, ]; if (($propertyType === null) || (!in_array($propertyType, $propertyTypes))) { if ($propertyValue === null) { $propertyType = self::PROPERTY_TYPE_STRING; } elseif (is_float($propertyValue)) { $propertyType = self::PROPERTY_TYPE_FLOAT; } elseif (is_int($propertyValue)) { $propertyType = self::PROPERTY_TYPE_INTEGER; } elseif (is_bool($propertyValue)) { $propertyType = self::PROPERTY_TYPE_BOOLEAN; } elseif ($propertyValue instanceof DateTime) { $propertyType = self::PROPERTY_TYPE_DATE; } else { $propertyType = self::PROPERTY_TYPE_STRING; } } $this->customProperties[$propertyName] = [ 'value' => $propertyValue, 'type' => $propertyType, ]; return $this; } /** * Convert document property based on type. * * @param string $propertyValue * @param string $propertyType * * @return mixed */ public static function convertProperty($propertyValue, $propertyType) { $conversion = self::getConversion($propertyType); switch ($conversion) { case 'empty': // Empty return ''; case 'null': // Null return null; case 'int': // Signed integer return (int) $propertyValue; case 'uint': // Unsigned integer return abs((int) $propertyValue); case 'float': // Float return (float) $propertyValue; case 'date': // Date return strtotime($propertyValue); case 'bool': // Boolean return $propertyValue == 'true'; } return $propertyValue; } /** * Convert document property type. * * @param string $propertyType * * @return string */ public static function convertPropertyType($propertyType) { $typeGroups = [ self::PROPERTY_TYPE_INTEGER => ['i1', 'i2', 'i4', 'i8', 'int', 'ui1', 'ui2', 'ui4', 'ui8', 'uint'], self::PROPERTY_TYPE_FLOAT => ['r4', 'r8', 'decimal'], self::PROPERTY_TYPE_STRING => ['empty', 'null', 'lpstr', 'lpwstr', 'bstr'], self::PROPERTY_TYPE_DATE => ['date', 'filetime'], self::PROPERTY_TYPE_BOOLEAN => ['bool'], ]; foreach ($typeGroups as $groupId => $groupMembers) { if (in_array($propertyType, $groupMembers)) { return $groupId; } } return self::PROPERTY_TYPE_UNKNOWN; } /** * Set default for null and empty value. * * @param mixed $value * @param mixed $default * * @return mixed */ private function setValue($value, $default) { if ($value === null || $value == '') { $value = $default; } return $value; } /** * Get conversion model depending on property type. * * @param string $propertyType * * @return string */ private static function getConversion($propertyType) { $conversions = [ 'empty' => ['empty'], 'null' => ['null'], 'int' => ['i1', 'i2', 'i4', 'i8', 'int'], 'uint' => ['ui1', 'ui2', 'ui4', 'ui8', 'uint'], 'float' => ['r4', 'r8', 'decimal'], 'bool' => ['bool'], 'date' => ['date', 'filetime'], ]; foreach ($conversions as $conversion => $types) { if (in_array($propertyType, $types)) { return $conversion; } } return 'string'; } } ================================================ FILE: src/PhpWord/Metadata/Protection.php ================================================ setEditing($editing); } } /** * Get editing protection. * * @return string */ public function getEditing() { return $this->editing; } /** * Set editing protection. * * @param string $editing Any value of \PhpOffice\PhpWord\SimpleType\DocProtect * * @return self */ public function setEditing($editing = null) { DocProtect::validate($editing); $this->editing = $editing; return $this; } /** * Get password. * * @return string */ public function getPassword() { return $this->password; } /** * Set password. * * @param string $password * * @return self */ public function setPassword($password) { $this->password = $password; return $this; } /** * Get count for hash iterations. * * @return int */ public function getSpinCount() { return $this->spinCount; } /** * Set count for hash iterations. * * @param int $spinCount * * @return self */ public function setSpinCount($spinCount) { $this->spinCount = $spinCount; return $this; } /** * Get algorithm. * * @return string */ public function getAlgorithm() { return $this->algorithm; } /** * Set algorithm. * * @param string $algorithm * * @return self */ public function setAlgorithm($algorithm) { $this->algorithm = $algorithm; return $this; } /** * Get salt. * * @return string */ public function getSalt() { return $this->salt; } /** * Set salt. Salt HAS to be 16 characters, or an exception will be thrown. * * @param string $salt * * @return self */ public function setSalt($salt) { if ($salt !== null && strlen($salt) !== 16) { throw new InvalidArgumentException('salt has to be of exactly 16 bytes length'); } $this->salt = $salt; return $this; } } ================================================ FILE: src/PhpWord/Metadata/Settings.php ================================================ documentProtection == null) { $this->documentProtection = new Protection(); } return $this->documentProtection; } /** * @param Protection $documentProtection */ public function setDocumentProtection($documentProtection): void { $this->documentProtection = $documentProtection; } /** * @return ProofState */ public function getProofState() { if ($this->proofState == null) { $this->proofState = new ProofState(); } return $this->proofState; } /** * @param ProofState $proofState */ public function setProofState($proofState): void { $this->proofState = $proofState; } /** * Are spelling errors hidden. * * @return bool */ public function hasHideSpellingErrors() { return $this->hideSpellingErrors; } /** * Hide spelling errors. * * @param ?bool $hideSpellingErrors */ public function setHideSpellingErrors($hideSpellingErrors): void { $this->hideSpellingErrors = $hideSpellingErrors === null ? true : $hideSpellingErrors; } /** * Are grammatical errors hidden. * * @return bool */ public function hasHideGrammaticalErrors() { return $this->hideGrammaticalErrors; } /** * Hide grammatical errors. * * @param ?bool $hideGrammaticalErrors */ public function setHideGrammaticalErrors($hideGrammaticalErrors): void { $this->hideGrammaticalErrors = $hideGrammaticalErrors === null ? true : $hideGrammaticalErrors; } /** * @return bool */ public function hasEvenAndOddHeaders() { return $this->evenAndOddHeaders; } /** * @param ?bool $evenAndOddHeaders */ public function setEvenAndOddHeaders($evenAndOddHeaders): void { $this->evenAndOddHeaders = $evenAndOddHeaders === null ? true : $evenAndOddHeaders; } /** * Get the Visibility of Annotation Types. * * @return TrackChangesView */ public function getRevisionView() { return $this->revisionView; } /** * Set the Visibility of Annotation Types. */ public function setRevisionView(?TrackChangesView $trackChangesView = null): void { $this->revisionView = $trackChangesView; } /** * @return bool */ public function hasTrackRevisions() { return $this->trackRevisions; } /** * @param ?bool $trackRevisions */ public function setTrackRevisions($trackRevisions): void { $this->trackRevisions = $trackRevisions === null ? true : $trackRevisions; } /** * @return bool */ public function hasDoNotTrackMoves() { return $this->doNotTrackMoves; } /** * @param ?bool $doNotTrackMoves */ public function setDoNotTrackMoves($doNotTrackMoves): void { $this->doNotTrackMoves = $doNotTrackMoves === null ? true : $doNotTrackMoves; } /** * @return bool */ public function hasDoNotTrackFormatting() { return $this->doNotTrackFormatting; } /** * @param ?bool $doNotTrackFormatting */ public function setDoNotTrackFormatting($doNotTrackFormatting): void { $this->doNotTrackFormatting = $doNotTrackFormatting === null ? true : $doNotTrackFormatting; } /** * @return mixed */ public function getZoom() { return $this->zoom; } /** * @param mixed $zoom */ public function setZoom($zoom): void { if (is_numeric($zoom)) { // zoom is a percentage $this->zoom = $zoom; } else { Zoom::validate($zoom); $this->zoom = $zoom; } } /** * @return bool */ public function hasMirrorMargins() { return $this->mirrorMargins; } /** * @param bool $mirrorMargins */ public function setMirrorMargins($mirrorMargins): void { $this->mirrorMargins = $mirrorMargins; } /** * Returns the Language. */ public function getThemeFontLang(): ?Language { return $this->themeFontLang; } /** * Sets the Language for this document. */ public function setThemeFontLang(Language $themeFontLang): self { $this->themeFontLang = $themeFontLang; return $this; } /** * @return bool */ public function hasUpdateFields() { return $this->updateFields; } /** * @param ?bool $updateFields */ public function setUpdateFields($updateFields): void { $this->updateFields = $updateFields === null ? false : $updateFields; } /** * Returns the Radix Point for Field Code Evaluation. * * @return string */ public function getDecimalSymbol() { return $this->decimalSymbol; } /** * sets the Radix Point for Field Code Evaluation. * * @param string $decimalSymbol */ public function setDecimalSymbol($decimalSymbol): void { $this->decimalSymbol = $decimalSymbol; } /** * @return null|bool */ public function hasAutoHyphenation() { return $this->autoHyphenation; } /** * @param bool $autoHyphenation */ public function setAutoHyphenation($autoHyphenation): void { $this->autoHyphenation = (bool) $autoHyphenation; } /** * @return null|int */ public function getConsecutiveHyphenLimit() { return $this->consecutiveHyphenLimit; } /** * @param int $consecutiveHyphenLimit */ public function setConsecutiveHyphenLimit($consecutiveHyphenLimit): void { $this->consecutiveHyphenLimit = (int) $consecutiveHyphenLimit; } /** * @return null|float|int */ public function getHyphenationZone() { return $this->hyphenationZone; } /** * @param null|float|int $hyphenationZone Measurement unit is twip */ public function setHyphenationZone($hyphenationZone): void { $this->hyphenationZone = $hyphenationZone; } /** * @return null|bool */ public function hasDoNotHyphenateCaps() { return $this->doNotHyphenateCaps; } /** * @param bool $doNotHyphenateCaps */ public function setDoNotHyphenateCaps($doNotHyphenateCaps): void { $this->doNotHyphenateCaps = (bool) $doNotHyphenateCaps; } public function hasBookFoldPrinting(): bool { return $this->bookFoldPrinting; } public function setBookFoldPrinting(bool $bookFoldPrinting): self { $this->bookFoldPrinting = $bookFoldPrinting; return $this; } } ================================================ FILE: src/PhpWord/PhpWord.php ================================================ collections[$collection] = new $class(); } // Metadata $metadata = ['DocInfo', 'Settings', 'Compatibility']; foreach ($metadata as $meta) { $class = 'PhpOffice\\PhpWord\\Metadata\\' . $meta; $this->metadata[$meta] = new $class(); } } /** * Dynamic function call to reduce static dependency. * * @since 0.12.0 * * @param mixed $function * @param mixed $args * * @return mixed */ public function __call($function, $args) { $function = strtolower($function); $getCollection = []; $addCollection = []; $addStyle = []; $collections = ['Bookmark', 'Title', 'Footnote', 'Endnote', 'Chart', 'Comment']; foreach ($collections as $collection) { $getCollection[] = strtolower("get{$collection}s"); $addCollection[] = strtolower("add{$collection}"); } $styles = ['Paragraph', 'Font', 'Table', 'Numbering', 'Link', 'Title']; foreach ($styles as $style) { $addStyle[] = strtolower("add{$style}Style"); } // Run get collection method if (in_array($function, $getCollection)) { $key = ucfirst(str_replace('get', '', $function)); return $this->collections[$key]; } // Run add collection item method if (in_array($function, $addCollection)) { $key = ucfirst(str_replace('add', '', $function) . 's'); $collectionObject = $this->collections[$key]; return $collectionObject->addItem($args[0] ?? null); } // Run add style method if (in_array($function, $addStyle)) { return forward_static_call_array(['PhpOffice\\PhpWord\\Style', $function], $args); } // Exception throw new BadMethodCallException("Method $function is not defined."); } /** * Get document properties object. * * @return Metadata\DocInfo */ public function getDocInfo() { return $this->metadata['DocInfo']; } /** * Get compatibility. * * @return Metadata\Compatibility * * @since 0.12.0 */ public function getCompatibility() { return $this->metadata['Compatibility']; } /** * Get compatibility. * * @return Metadata\Settings * * @since 0.14.0 */ public function getSettings() { return $this->metadata['Settings']; } /** * Get all sections. * * @return Section[] */ public function getSections() { return $this->sections; } /** * Returns the section at the requested position. * * @param int $index * * @return null|Section */ public function getSection($index) { if (array_key_exists($index, $this->sections)) { return $this->sections[$index]; } return null; } /** * Create new section. * * @param null|array|string $style * * @return Section */ public function addSection($style = null) { $section = new Section(count($this->sections) + 1, $style); $section->setPhpWord($this); $this->sections[] = $section; return $section; } /** * Sorts the sections using the callable passed. * * @see http://php.net/manual/en/function.usort.php for usage * * @param callable $sorter */ public function sortSections($sorter): void { usort($this->sections, $sorter); } /** * Get default font name. * * @return string */ public function getDefaultFontName() { return Settings::getDefaultFontName(); } /** * Set default font name. * * @param string $fontName */ public function setDefaultFontName($fontName): void { Settings::setDefaultFontName($fontName); } /** * Get default asian font name. */ public function getDefaultAsianFontName(): string { return Settings::getDefaultAsianFontName(); } /** * Set default asian font name. * * @param string $fontName */ public function setDefaultAsianFontName($fontName): void { Settings::setDefaultAsianFontName($fontName); } /** * Set default font color. */ public function setDefaultFontColor(string $fontColor): void { Settings::setDefaultFontColor($fontColor); } /** * Get default font color. */ public function getDefaultFontColor(): string { return Settings::getDefaultFontColor(); } /** * Get default font size. * * @return int */ public function getDefaultFontSize() { return Settings::getDefaultFontSize(); } /** * Set default font size. * * @param int $fontSize */ public function setDefaultFontSize($fontSize): void { Settings::setDefaultFontSize($fontSize); } /** * Set default paragraph style definition to styles.xml. * * @param array $styles Paragraph style definition * * @return Style\Paragraph */ public function setDefaultParagraphStyle($styles) { return Style::setDefaultParagraphStyle($styles); } /** * Save to file or download. * * All exceptions should already been handled by the writers * * @param string $filename * @param string $format * @param bool $download * * @return bool */ public function save($filename, $format = 'Word2007', $download = false) { $mime = [ 'Word2007' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'ODText' => 'application/vnd.oasis.opendocument.text', 'RTF' => 'application/rtf', 'HTML' => 'text/html', 'PDF' => 'application/pdf', ]; $writer = IOFactory::createWriter($this, $format); if ($download === true) { header('Content-Description: File Transfer'); header('Content-Disposition: attachment; filename="' . $filename . '"'); header('Content-Type: ' . $mime[$format]); header('Content-Transfer-Encoding: binary'); header('Cache-Control: must-revalidate, post-check=0, pre-check=0'); header('Expires: 0'); $filename = 'php://output'; // Change filename to force download } $writer->save($filename); return true; } /** * Create new section. * * @deprecated 0.10.0 * * @param array $settings * * @return Section * * @codeCoverageIgnore */ public function createSection($settings = null) { return $this->addSection($settings); } /** * Get document properties object. * * @deprecated 0.12.0 * * @return Metadata\DocInfo * * @codeCoverageIgnore */ public function getDocumentProperties() { return $this->getDocInfo(); } /** * Set document properties object. * * @deprecated 0.12.0 * * @param Metadata\DocInfo $documentProperties * * @return self * * @codeCoverageIgnore */ public function setDocumentProperties($documentProperties) { $this->metadata['Document'] = $documentProperties; return $this; } } ================================================ FILE: src/PhpWord/Reader/AbstractReader.php ================================================ readDataOnly; return true; } /** * Set read data only. * * @param bool $value * * @return self */ public function setReadDataOnly($value = true) { $this->readDataOnly = $value; return $this; } public function hasImageLoading(): bool { return $this->imageLoading; } public function setImageLoading(bool $value): self { $this->imageLoading = $value; return $this; } /** * Open file for reading. * * @param string $filename * * @return resource */ protected function openFile($filename) { // Check if file exists if (!file_exists($filename) || !is_readable($filename)) { throw new Exception("Could not open $filename for reading! File does not exist."); } // Open file $this->fileHandle = fopen($filename, 'rb'); if ($this->fileHandle === false) { throw new Exception("Could not open file $filename for reading."); } } /** * Can the current ReaderInterface read the file? * * @param string $filename * * @return bool */ public function canRead($filename) { // Check if file exists try { $this->openFile($filename); } catch (Exception $e) { return false; } if (is_resource($this->fileHandle)) { fclose($this->fileHandle); } return true; } } ================================================ FILE: src/PhpWord/Reader/HTML.php ================================================ canRead($docFile)) { $section = $phpWord->addSection(); HTMLParser::addHtml($section, file_get_contents($docFile), true); } else { throw new Exception("Cannot read {$docFile}."); } return $phpWord; } } ================================================ FILE: src/PhpWord/Reader/MsDoc.php ================================================ phpWord = new PhpWord(); $this->loadOLE($filename); $this->readFib($this->dataWorkDocument); $this->readFibContent(); return $this->phpWord; } /** * Load an OLE Document. * * @param string $filename */ private function loadOLE($filename): void { // OLE reader $ole = new OLERead(); $ole->read($filename); // Get WorkDocument stream $this->dataWorkDocument = $ole->getStream($ole->wrkdocument); // Get 1Table stream $this->data1Table = $ole->getStream($ole->wrk1Table); // Get Data stream $this->dataData = $ole->getStream($ole->wrkData); // Get Data stream $this->dataObjectPool = $ole->getStream($ole->wrkObjectPool); // Get Summary Information data $this->summaryInformation = $ole->getStream($ole->summaryInformation); // Get Document Summary Information data $this->documentSummaryInformation = $ole->getStream($ole->docSummaryInfos); } private function getNumInLcb($lcb, $iSize) { return ($lcb - 4) / (4 + $iSize); } private function getArrayCP($data, $posMem, $iNum) { $arrayCP = []; for ($inc = 0; $inc < $iNum; ++$inc) { $arrayCP[$inc] = self::getInt4d($data, $posMem); $posMem += 4; } return $arrayCP; } /** * @see http://msdn.microsoft.com/en-us/library/dd949344%28v=office.12%29.aspx * @see https://igor.io/2012/09/24/binary-parsing.html * * @param string $data */ private function readFib($data) { $pos = 0; //----- FibBase // wIdent $pos += 2; // nFib $pos += 2; // unused $pos += 2; // lid : Language Identifier $pos += 2; // pnNext $pos += 2; // $mem = self::getInt2d($data, $pos); // $fDot = ($mem >> 15) & 1; // $fGlsy = ($mem >> 14) & 1; // $fComplex = ($mem >> 13) & 1; // $fHasPic = ($mem >> 12) & 1; // $cQuickSaves = ($mem >> 8) & bindec('1111'); // $fEncrypted = ($mem >> 7) & 1; // $fWhichTblStm = ($mem >> 6) & 1; // $fReadOnlyRecommended = ($mem >> 5) & 1; // $fWriteReservation = ($mem >> 4) & 1; // $fExtChar = ($mem >> 3) & 1; // $fLoadOverride = ($mem >> 2) & 1; // $fFarEast = ($mem >> 1) & 1; // $fObfuscated = ($mem >> 0) & 1; $pos += 2; // nFibBack $pos += 2; // lKey $pos += 4; // envr ++$pos; // $mem = self::getInt1d($data, $pos); // $fMac = ($mem >> 7) & 1; // $fEmptySpecial = ($mem >> 6) & 1; // $fLoadOverridePage = ($mem >> 5) & 1; // $reserved1 = ($mem >> 4) & 1; // $reserved2 = ($mem >> 3) & 1; // $fSpare0 = ($mem >> 0) & bindec('111'); ++$pos; // reserved3 $pos += 2; // reserved4 $pos += 2; // reserved5 $pos += 4; // reserved6 $pos += 4; //----- csw $pos += 2; //----- fibRgW // reserved1 $pos += 2; // reserved2 $pos += 2; // reserved3 $pos += 2; // reserved4 $pos += 2; // reserved5 $pos += 2; // reserved6 $pos += 2; // reserved7 $pos += 2; // reserved8 $pos += 2; // reserved9 $pos += 2; // reserved10 $pos += 2; // reserved11 $pos += 2; // reserved12 $pos += 2; // reserved13 $pos += 2; // lidFE $pos += 2; //----- cslw $pos += 2; //----- fibRgLw // cbMac $pos += 4; // reserved1 $pos += 4; // reserved2 $pos += 4; $this->arrayFib['ccpText'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['ccpFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['ccpHdd'] = self::getInt4d($data, $pos); $pos += 4; // reserved3 $pos += 4; // ccpAtn $pos += 4; // ccpEdn $pos += 4; // ccpTxbx $pos += 4; // ccpHdrTxbx $pos += 4; // reserved4 $pos += 4; // reserved5 $pos += 4; // reserved6 $pos += 4; // reserved7 $pos += 4; // reserved8 $pos += 4; // reserved9 $pos += 4; // reserved10 $pos += 4; // reserved11 $pos += 4; // reserved12 $pos += 4; // reserved13 $pos += 4; // reserved14 $pos += 4; //----- cbRgFcLcb $cbRgFcLcb = self::getInt2d($data, $pos); $pos += 2; //----- fibRgFcLcbBlob switch ($cbRgFcLcb) { case 0x005D: $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_97); break; case 0x006C: $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_97); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2000); break; case 0x0088: $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_97); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2000); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2002); break; case 0x00A4: $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_97); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2000); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2002); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2003); break; case 0x00B7: $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_97); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2000); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2002); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2003); $pos = $this->readBlockFibRgFcLcb($data, $pos, self::VERSION_2007); break; } //----- cswNew $this->arrayFib['cswNew'] = self::getInt2d($data, $pos); $pos += 2; if ($this->arrayFib['cswNew'] != 0) { //@todo : fibRgCswNew } return $pos; } private function readBlockFibRgFcLcb($data, $pos, $version) { if ($version == self::VERSION_97) { $this->arrayFib['fcStshfOrig'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbStshfOrig'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcStshf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbStshf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcffndRef'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcffndRef'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcffndTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcffndTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfandRef'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfandRef'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfandTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfandTxt '] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfSed'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfSed'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcPad'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcPad'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfPhe'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfPhe'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfGlsy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfGlsy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfGlsy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfGlsy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfHdd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfHdd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBteChpx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBteChpx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBtePapx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBtePapx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfSea'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfSea'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfFfn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfFfn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldMom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldMom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldHdr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldHdr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldAtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldAtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldMcr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldMcr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmk'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmk'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcCmds'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbCmds'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused1'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused1'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfMcr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfMcr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPrDrvr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPrDrvr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPrEnvPort'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPrEnvPort'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPrEnvLand'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPrEnvLand'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcWss'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbWss'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcDop'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbDop'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfAssoc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfAssoc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcClx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbClx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfPgdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfPgdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcAutosaveSource'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbAutosaveSource'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcGrpXstAtnOwners'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbGrpXstAtnOwners'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfAtnBkmk'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfAtnBkmk'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused2'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused2'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused3'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused3'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcSpaMom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcSpaMom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcSpaHdr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcSpaHdr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfAtnBkf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfAtnBkf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfAtnBkl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfAtnBkl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPms'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPms'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcFormFldSttbs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbFormFldSttbs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfendRef'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfendRef'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfendTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfendTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused4'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused4'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcDggInfo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbDggInfo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfRMark'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfRMark'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfCaption'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfCaption'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfAutoCaption'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfAutoCaption'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfWkb'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfWkb'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfSpl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfSpl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcftxbxTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcftxbxTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfFldTxbx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfFldTxbx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfHdrtxbxTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfHdrtxbxTxt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcffldHdrTxbx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcffldHdrTxbx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcStwUser'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbStwUser'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbTtmbd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbTtmbd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcCookieData'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbCookieData'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdMotherOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdMotherOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdMotherOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdMotherOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdFtnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdFtnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdFtnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdFtnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdEdnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdEdnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdEdnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdEdnOldOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfIntlFld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfIntlFld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcRouteSlip'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbRouteSlip'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbSavedBy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbSavedBy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbFnm'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbFnm'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlfLst'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlfLst'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlfLfo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlfLfo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfTxbxBkd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfTxbxBkd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfTxbxHdrBkd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfTxbxHdrBkd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcDocUndoWord9'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbDocUndoWord9'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcRgbUse'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbRgbUse'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUsp'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUsp'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUskf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUskf'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcupcRgbUse'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcupcRgbUse'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcupcUsp'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcupcUsp'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbGlsyStyle'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbGlsyStyle'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlgosl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlgosl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcocx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcocx'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBteLvc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBteLvc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['dwLowDateTime'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['dwHighDateTime'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfLvcPre10'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfLvcPre10'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfAsumy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfAsumy'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfGram'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfGram'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbListNames'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbListNames'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfUssr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfUssr'] = self::getInt4d($data, $pos); $pos += 4; } if ($version == self::VERSION_2000) { $this->arrayFib['fcPlcfTch'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfTch'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcRmdThreading'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbRmdThreading'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcMid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbMid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbRgtplc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbRgtplc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcMsoEnvelope'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbMsoEnvelope'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfLad'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfLad'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcRgDofr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbRgDofr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcosl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcosl'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfCookieOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfCookieOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdMotherOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdMotherOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdMotherOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdMotherOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdFtnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdFtnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdFtnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdFtnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdEdnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdEdnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdEdnOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdEdnOld'] = self::getInt4d($data, $pos); $pos += 4; } if ($version == self::VERSION_2002) { $this->arrayFib['fcUnused1'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused1'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfPgp'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfPgp'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfuim'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfuim'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlfguidUim'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlfguidUim'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcAtrdExtra'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbAtrdExtra'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlrsid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlrsid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkFactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkFactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfFactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfFactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfcookie'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfcookie'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklFactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklFactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcFactoidData'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbFactoidData'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcDocUndo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbDocUndo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkFcc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkFcc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfFcc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfFcc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklFcc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklFcc'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfbkmkBPRepairs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfbkmkBPRepairs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfbkfBPRepairs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfbkfBPRepairs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfbklBPRepairs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfbklBPRepairs'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPmsNew'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPmsNew'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcODSO'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbODSO'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiOldXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiOldXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiNewXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiNewXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiMixedXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiMixedXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused2'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused2'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcffactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcffactoid'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcOldXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcOldXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcNewXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcNewXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcMixedXP'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcMixedXP'] = self::getInt4d($data, $pos); $pos += 4; } if ($version == self::VERSION_2003) { $this->arrayFib['fcHplxsdr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbHplxsdr'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkSdt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkSdt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfSdt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfSdt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklSdt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklSdt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcCustomXForm'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbCustomXForm'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkProt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkProt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfProt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfProt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklProt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklProt'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbProtUser'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbProtUser'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiOldInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiOldInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiNew'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiNew'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfpmiNewInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfpmiNewInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcOld'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcOldInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcOldInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcNew'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcNew'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcflvcNewInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcflvcNewInline'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdMother'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdMother'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdMother'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdMother'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcAfdMother'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbAfdMother'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcAfdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbAfdFtn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPgdEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPgdEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcBkdEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbBkdEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcAfdEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbAfdEdn'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcAfd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbAfd'] = self::getInt4d($data, $pos); $pos += 4; } if ($version == self::VERSION_2007) { $this->arrayFib['fcPlcfmthd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfmthd'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkMoveFrom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkMoveFrom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfMoveFrom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfMoveFrom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklMoveFrom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklMoveFrom'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkMoveTo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkMoveTo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfMoveTo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfMoveTo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklMoveTo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklMoveTo'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused1'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused1'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused2'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused2'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused3'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused3'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcSttbfBkmkArto'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbSttbfBkmkArto'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBkfArto'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBkfArto'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcPlcfBklArto'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbPlcfBklArto'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcArtoData'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbArtoData'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused4'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused4'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused5'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused5'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcUnused6'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbUnused6'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcOssTheme'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbOssTheme'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['fcColorSchemeMapping'] = self::getInt4d($data, $pos); $pos += 4; $this->arrayFib['lcbColorSchemeMapping'] = self::getInt4d($data, $pos); $pos += 4; } return $pos; } private function readFibContent(): void { // Informations about Font $this->readRecordSttbfFfn(); // Informations about page $this->readRecordPlcfSed(); // reading paragraphs //@see https://github.com/notmasteryet/CompoundFile/blob/ec118f354efebdee9102e41b5b7084fce81125b0/WordFileReader/WordDocument.cs#L86 $this->readRecordPlcfBtePapx(); // reading character formattings //@see https://github.com/notmasteryet/CompoundFile/blob/ec118f354efebdee9102e41b5b7084fce81125b0/WordFileReader/WordDocument.cs#L94 $this->readRecordPlcfBteChpx(); $this->generatePhpWord(); } /** * Section and information about them. * * @see http://msdn.microsoft.com/en-us/library/dd924458%28v=office.12%29.aspx */ private function readRecordPlcfSed(): void { $posMem = $this->arrayFib['fcPlcfSed']; // PlcfSed // PlcfSed : aCP $aCP = []; $aCP[0] = self::getInt4d($this->data1Table, $posMem); $posMem += 4; $aCP[1] = self::getInt4d($this->data1Table, $posMem); $posMem += 4; // PlcfSed : aSed //@see http://msdn.microsoft.com/en-us/library/dd950194%28v=office.12%29.aspx $numSed = $this->getNumInLcb($this->arrayFib['lcbPlcfSed'], 12); $aSed = []; for ($iInc = 0; $iInc < $numSed; ++$iInc) { // Sed : http://msdn.microsoft.com/en-us/library/dd950982%28v=office.12%29.aspx // fn $posMem += 2; // fnMpr $aSed[$iInc] = self::getInt4d($this->data1Table, $posMem); $posMem += 4; // fnMpr $posMem += 2; // fcMpr $posMem += 4; } foreach ($aSed as $offsetSed) { // Sepx : http://msdn.microsoft.com/en-us/library/dd921348%28v=office.12%29.aspx $cb = self::getInt2d($this->dataWorkDocument, $offsetSed); $offsetSed += 2; $oStylePrl = $this->readPrl($this->dataWorkDocument, $offsetSed, $cb); $offsetSed += $oStylePrl->length; $this->arraySections[] = $oStylePrl; } } /** * Specifies the fonts that are used in the document. * * @see http://msdn.microsoft.com/en-us/library/dd943880%28v=office.12%29.aspx */ private function readRecordSttbfFfn(): void { $posMem = $this->arrayFib['fcSttbfFfn']; $cData = self::getInt2d($this->data1Table, $posMem); $posMem += 2; $cbExtra = self::getInt2d($this->data1Table, $posMem); $posMem += 2; if ($cData < 0x7FF0 && $cbExtra == 0) { for ($inc = 0; $inc < $cData; ++$inc) { // len ++$posMem; // ffid ++$posMem; // wWeight (400 : Normal - 700 bold) $posMem += 2; // chs ++$posMem; // ixchSzAlt $ixchSzAlt = self::getInt1d($this->data1Table, $posMem); ++$posMem; // panose $posMem += 10; // fs $posMem += 24; // xszFfn $xszFfn = ''; do { $char = self::getInt2d($this->data1Table, $posMem); $posMem += 2; if ($char > 0) { $xszFfn .= chr($char); } } while ($char != 0); // xszAlt $xszAlt = ''; if ($ixchSzAlt > 0) { do { $char = self::getInt2d($this->data1Table, $posMem); $posMem += 2; if ($char == 0) { break; } $xszAlt .= chr($char); } while ($char != 0); } $this->arrayFonts[] = [ 'main' => $xszFfn, 'alt' => $xszAlt, ]; } } } /** * Paragraph and information about them. * * @see http://msdn.microsoft.com/en-us/library/dd908569%28v=office.12%29.aspx */ private function readRecordPlcfBtePapx(): void { $posMem = $this->arrayFib['fcPlcfBtePapx']; $num = $this->getNumInLcb($this->arrayFib['lcbPlcfBtePapx'], 4); $posMem += 4 * ($num + 1); $arrAPnBtePapx = $this->getArrayCP($this->data1Table, $posMem, $num); $posMem += 4 * $num; foreach ($arrAPnBtePapx as $aPnBtePapx) { $offsetBase = $aPnBtePapx * 512; $offset = $offsetBase; $string = ''; $numRun = self::getInt1d($this->dataWorkDocument, $offset + 511); $arrayRGFC = []; for ($inc = 0; $inc <= $numRun; ++$inc) { $arrayRGFC[$inc] = self::getInt4d($this->dataWorkDocument, $offset); $offset += 4; } $arrayRGB = []; for ($inc = 1; $inc <= $numRun; ++$inc) { // @see http://msdn.microsoft.com/en-us/library/dd925804(v=office.12).aspx $arrayRGB[$inc] = self::getInt1d($this->dataWorkDocument, $offset); ++$offset; // reserved $offset += 12; } foreach (array_keys($arrayRGFC) as $key) { if (!isset($arrayRGFC[$key + 1])) { break; } $strLen = $arrayRGFC[$key + 1] - $arrayRGFC[$key] - 1; for ($inc = 0; $inc < ($strLen * 2); ++$inc) { $byte = self::getInt2d($this->dataWorkDocument, $arrayRGFC[$key] + ($inc * 2)); if ($byte > 0) { $string .= mb_chr($byte, 'UTF-8'); } else { break; } } } $this->arrayParagraphs[] = $string; //@todo readPrl for paragraphs /*// use $this->readPrl() foreach ($arrayRGB as $key => $rgb) { $offset = $offsetBase + ($rgb * 2); $cb = self::getInt1d($this->dataWorkDocument, $offset); $offset += 1; print_r('$cb : '.$cb.PHP_EOL); if ($cb == 0) { $cb = self::getInt1d($this->dataWorkDocument, $offset); $cb = $cb * 2; $offset += 1; print_r('$cb0 : '.$cb.PHP_EOL); } else { $cb = $cb * 2 - 1; print_r('$cbD : '.$cb.PHP_EOL); } $istd = self::getInt2d($this->dataWorkDocument, $offset); $offset += 2; $cb -= 2; print_r('$istd : '.$istd.($istd == 0 ? ' (Normal)' : '').PHP_EOL); if ($cb > 0) { do{ $sprm = self::getInt2d($this->dataWorkDocument, $offset); $offset += 2; $cb -= 2; $sprm_IsPmd = $sprm & 0x01FF; $sprm_F = ($sprm/512) & 0x0001; $sprm_Sgc = ($sprm/1024) & 0x0007; $sprm_Spra = ($sprm/8192); print_r('$sprm : 0x'.dechex($sprm).PHP_EOL); print_r('$sprm.ispmd : 0x'.dechex($sprm_IsPmd).PHP_EOL); print_r('$sprm.f : 0x'.dechex($sprm_F).PHP_EOL); print_r('$sprm.sgc : 0x'.dechex($sprm_Sgc)); switch (dechex($sprm_Sgc)) { case 0x01: print_r(' (Paragraph property)'); break; case 0x02: print_r(' (Character property)'); break; case 0x03: print_r(' (Picture property)'); break; case 0x04: print_r(' (Section property)'); break; case 0x05: print_r(' (Table property)'); break; } print_r(PHP_EOL); print_r('$sprm.spra : 0x'.dechex($sprm_Spra).PHP_EOL); switch (dechex($sprm_Spra)) { case 0x0: $operand = self::getInt1d($this->dataWorkDocument, $offset); $offset += 1; $cb -= 1; switch (dechex($operand)) { case 0x00: $operand = 'OFF'; break; case 0x01: $operand = 'ON'; break; case 0x80: $operand = 'CURRENT VALUE'; print_r(''.PHP_EOL.PHP_EOL); break; case 0x81: $operand = 'OPPOSITE OF THE CURRENT VALUE'; break; } break; case 0x1: $operand = self::getInt1d($this->dataWorkDocument, $offset); $offset += 1; $cb -= 1; print_r('$operand : 0x'.dechex($operand).PHP_EOL); break; case 0x2: case 0x4: case 0x5: $operand = self::getInt2d($this->dataWorkDocument, $offset); $offset += 2; $cb -= 2; print_r('$operand : 0x'.dechex($operand).PHP_EOL); break; case 0x3: if ($sprm_IsPmd != 0x70) { $operand = self::getInt4d($this->dataWorkDocument, $offset); $offset += 4; $cb -= 4; print_r('$operand : 0x'.dechex($operand).PHP_EOL); } break; case 0x7: $operand = self::getInt3d($this->dataWorkDocument, $offset); $offset += 3; $cb -= 3; print_r('$operand : 0x'.dechex($operand).PHP_EOL); break; default: print_r('YO YO YO : '.PHP_EOL); } // switch (dechex($sprm_Sgc)) { case 0x01: // Sprm is modifying a paragraph property. switch ($sprm_IsPmd) { case 0x0A: // sprmPIlvl print_r('sprmPIlvl : '.$operand.PHP_EOL.PHP_EOL); break; case 0x0B: // sprmPIlfo print_r('sprmPIlfo : '.$operand.PHP_EOL.PHP_EOL); break; default: print_r('$sprm_IsPmd(1) : '.$sprm_IsPmd.PHP_EOL.PHP_EOL); break; } break; case 0x02: // Sprm is modifying a character property. switch ($sprm_IsPmd) { default: print_r('$sprm_IsPmd(2) : '.$sprm_IsPmd.PHP_EOL.PHP_EOL); break; } break; case 0x03: // Sprm is modifying a picture property. switch ($sprm_IsPmd) { default: print_r('$sprm_IsPmd(3) : '.$sprm_IsPmd.PHP_EOL.PHP_EOL); break; } break; case 0x04: // Sprm is modifying a section property. switch ($sprm_IsPmd) { default: print_r('$sprm_IsPmd(4) : '.$sprm_IsPmd.PHP_EOL.PHP_EOL); break; } break; case 0x05: // Sprm is modifying a table property. switch ($sprm_IsPmd) { default: print_r('$sprm_IsPmd(4) : '.$sprm_IsPmd.PHP_EOL.PHP_EOL); break; } break; default: print_r('$sprm_Sgc : '.dechex($sprm_Sgc).PHP_EOL.PHP_EOL); break; } } while ($cb > 0); } else { if ($istd > 0) { // @todo : Determining Properties of a Paragraph Style # @see http://msdn.microsoft.com/en-us/library/dd948631%28v=office.12%29.aspx } } }*/ } } /** * Character formatting properties to text in a document. * * @see http://msdn.microsoft.com/en-us/library/dd907108%28v=office.12%29.aspx */ private function readRecordPlcfBteChpx(): void { $posMem = $this->arrayFib['fcPlcfBteChpx']; $num = $this->getNumInLcb($this->arrayFib['lcbPlcfBteChpx'], 4); $aPnBteChpx = []; for ($inc = 0; $inc <= $num; ++$inc) { $aPnBteChpx[$inc] = self::getInt4d($this->data1Table, $posMem); $posMem += 4; } $pnFkpChpx = self::getInt4d($this->data1Table, $posMem); $posMem += 4; $offsetBase = $pnFkpChpx * 512; $offset = $offsetBase; // ChpxFkp // @see http://msdn.microsoft.com/en-us/library/dd910989%28v=office.12%29.aspx $numRGFC = self::getInt1d($this->dataWorkDocument, $offset + 511); $arrayRGFC = []; for ($inc = 0; $inc <= $numRGFC; ++$inc) { $arrayRGFC[$inc] = self::getInt4d($this->dataWorkDocument, $offset); $offset += 4; } $arrayRGB = []; for ($inc = 1; $inc <= $numRGFC; ++$inc) { $arrayRGB[$inc] = self::getInt1d($this->dataWorkDocument, $offset); ++$offset; } $start = 0; foreach ($arrayRGB as $keyRGB => $rgb) { $oStyle = new stdClass(); $oStyle->pos_start = $start; $oStyle->pos_len = (int) ceil((($arrayRGFC[$keyRGB] - 1) - $arrayRGFC[$keyRGB - 1]) / 2); $start += $oStyle->pos_len; if ($rgb > 0) { // Chp Structure // @see http://msdn.microsoft.com/en-us/library/dd772849%28v=office.12%29.aspx $posRGB = $offsetBase + $rgb * 2; $cb = self::getInt1d($this->dataWorkDocument, $posRGB); ++$posRGB; $oStyle->style = $this->readPrl($this->dataWorkDocument, $posRGB, $cb); $posRGB += $oStyle->style->length; } $this->arrayCharacters[] = $oStyle; } } /** * @return stdClass */ private function readSprm($sprm) { $oSprm = new stdClass(); $oSprm->isPmd = $sprm & 0x01FF; $oSprm->f = (int) ($sprm / 512) & 0x0001; $oSprm->sgc = (int) ($sprm / 1024) & 0x0007; $oSprm->spra = (int) ($sprm / 8192); return $oSprm; } /** * @param string $data * @param int $pos * @param stdClass $oSprm * * @return array */ private function readSprmSpra($data, $pos, $oSprm) { $length = 0; $operand = null; switch (dechex($oSprm->spra)) { case 0x0: $operand = self::getInt1d($data, $pos); $length = 1; switch (dechex($operand)) { case 0x00: $operand = false; break; case 0x01: $operand = true; break; case 0x80: $operand = self::SPRA_VALUE; break; case 0x81: $operand = self::SPRA_VALUE_OPPOSITE; break; } break; case 0x1: $operand = self::getInt1d($data, $pos); $length = 1; break; case 0x2: case 0x4: case 0x5: $operand = self::getInt2d($data, $pos); $length = 2; break; case 0x3: if ($oSprm->isPmd != 0x70) { $operand = self::getInt4d($data, $pos); $length = 4; } break; case 0x7: $operand = self::getInt3d($data, $pos); $length = 3; break; default: // print_r('YO YO YO : '.PHP_EOL); } return [ 'length' => $length, 'operand' => $operand, ]; } /** * @param $data int * @param $pos int * @param $cbNum int * * @return stdClass * * @see http://msdn.microsoft.com/en-us/library/dd772849%28v=office.12%29.aspx */ private function readPrl($data, $pos, $cbNum) { $posStart = $pos; $oStylePrl = new stdClass(); // Variables $sprmCPicLocation = null; $sprmCFData = null; //$sprmCFSpec = null; do { // Variables $operand = null; $sprm = self::getInt2d($data, $pos); $oSprm = $this->readSprm($sprm); $pos += 2; $cbNum -= 2; $arrayReturn = $this->readSprmSpra($data, $pos, $oSprm); $pos += $arrayReturn['length']; $cbNum -= $arrayReturn['length']; $operand = $arrayReturn['operand']; switch (dechex($oSprm->sgc)) { // Paragraph property case 0x01: break; // Character property case 0x02: if (!isset($oStylePrl->styleFont)) { $oStylePrl->styleFont = []; } switch ($oSprm->isPmd) { // sprmCFRMarkIns case 0x01: break; // sprmCFFldVanish case 0x02: break; // sprmCPicLocation case 0x03: $sprmCPicLocation = $operand; break; // sprmCFData case 0x06: $sprmCFData = dechex($operand) != 0x00; break; // sprmCFItalic case 0x36: // By default, text is not italicized. switch ($operand) { case false: case true: $oStylePrl->styleFont['italic'] = $operand; break; case self::SPRA_VALUE: $oStylePrl->styleFont['italic'] = false; break; case self::SPRA_VALUE_OPPOSITE: $oStylePrl->styleFont['italic'] = true; break; } break; // sprmCIstd case 0x30: //print_r('sprmCIstd : '.dechex($operand).PHP_EOL.PHP_EOL); break; // sprmCFBold case 0x35: // By default, text is not bold. switch ($operand) { case false: case true: $oStylePrl->styleFont['bold'] = $operand; break; case self::SPRA_VALUE: $oStylePrl->styleFont['bold'] = false; break; case self::SPRA_VALUE_OPPOSITE: $oStylePrl->styleFont['bold'] = true; break; } break; // sprmCFStrike case 0x37: // By default, text is not struck through. switch ($operand) { case false: case true: $oStylePrl->styleFont['strikethrough'] = $operand; break; case self::SPRA_VALUE: $oStylePrl->styleFont['strikethrough'] = false; break; case self::SPRA_VALUE_OPPOSITE: $oStylePrl->styleFont['strikethrough'] = true; break; } break; // sprmCKul case 0x3E: switch (dechex($operand)) { case 0x00: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_NONE; break; case 0x01: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_SINGLE; break; case 0x02: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_WORDS; break; case 0x03: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOUBLE; break; case 0x04: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOTTED; break; case 0x06: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_HEAVY; break; case 0x07: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DASH; break; case 0x09: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOTDASH; break; case 0x0A: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOTDOTDASH; break; case 0x0B: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_WAVY; break; case 0x14: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOTTEDHEAVY; break; case 0x17: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DASHHEAVY; break; case 0x19: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOTDASHHEAVY; break; case 0x1A: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DOTDOTDASHHEAVY; break; case 0x1B: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_WAVYHEAVY; break; case 0x27: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DASHLONG; break; case 0x2B: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_WAVYDOUBLE; break; case 0x37: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_DASHLONGHEAVY; break; default: $oStylePrl->styleFont['underline'] = Style\Font::UNDERLINE_NONE; break; } break; // sprmCIco //@see http://msdn.microsoft.com/en-us/library/dd773060%28v=office.12%29.aspx case 0x42: switch (dechex($operand)) { case 0x00: case 0x01: $oStylePrl->styleFont['color'] = '000000'; break; case 0x02: $oStylePrl->styleFont['color'] = '0000FF'; break; case 0x03: $oStylePrl->styleFont['color'] = '00FFFF'; break; case 0x04: $oStylePrl->styleFont['color'] = '00FF00'; break; case 0x05: $oStylePrl->styleFont['color'] = 'FF00FF'; break; case 0x06: $oStylePrl->styleFont['color'] = 'FF0000'; break; case 0x07: $oStylePrl->styleFont['color'] = 'FFFF00'; break; case 0x08: $oStylePrl->styleFont['color'] = 'FFFFFF'; break; case 0x09: $oStylePrl->styleFont['color'] = '000080'; break; case 0x0A: $oStylePrl->styleFont['color'] = '008080'; break; case 0x0B: $oStylePrl->styleFont['color'] = '008000'; break; case 0x0C: $oStylePrl->styleFont['color'] = '800080'; break; case 0x0D: $oStylePrl->styleFont['color'] = '800080'; break; case 0x0E: $oStylePrl->styleFont['color'] = '808000'; break; case 0x0F: $oStylePrl->styleFont['color'] = '808080'; break; case 0x10: $oStylePrl->styleFont['color'] = 'C0C0C0'; } break; // sprmCHps case 0x43: $oStylePrl->styleFont['size'] = $operand / 2; break; // sprmCIss case 0x48: if (!isset($oStylePrl->styleFont['superScript'])) { $oStylePrl->styleFont['superScript'] = false; } if (!isset($oStylePrl->styleFont['subScript'])) { $oStylePrl->styleFont['subScript'] = false; } switch (dechex($operand)) { case 0x00: // Normal text break; case 0x01: $oStylePrl->styleFont['superScript'] = true; break; case 0x02: $oStylePrl->styleFont['subScript'] = true; break; } break; // sprmCRgFtc0 case 0x4F: $oStylePrl->styleFont['name'] = ''; if (isset($this->arrayFonts[$operand])) { $oStylePrl->styleFont['name'] = $this->arrayFonts[$operand]['main']; } break; // sprmCRgFtc1 case 0x50: // if the language for the text is an East Asian language break; // sprmCRgFtc2 case 0x51: // if the character falls outside the Unicode character range break; // sprmCFSpec case 0x55: //$sprmCFSpec = $operand; break; // sprmCFtcBi case 0x5E: break; // sprmCFItalicBi case 0x5D: break; // sprmCHpsBi case 0x61: break; // sprmCShd80 //@see http://msdn.microsoft.com/en-us/library/dd923447%28v=office.12%29.aspx case 0x66: // $operand = self::getInt2d($data, $pos); $pos += 2; $cbNum -= 2; // $ipat = ($operand >> 0) && bindec('111111'); // $icoBack = ($operand >> 6) && bindec('11111'); // $icoFore = ($operand >> 11) && bindec('11111'); break; // sprmCCv //@see http://msdn.microsoft.com/en-us/library/dd952824%28v=office.12%29.aspx case 0x70: $red = str_pad(dechex(self::getInt1d($this->dataWorkDocument, $pos)), 2, '0', STR_PAD_LEFT); ++$pos; $green = str_pad(dechex(self::getInt1d($this->dataWorkDocument, $pos)), 2, '0', STR_PAD_LEFT); ++$pos; $blue = str_pad(dechex(self::getInt1d($this->dataWorkDocument, $pos)), 2, '0', STR_PAD_LEFT); ++$pos; ++$pos; $oStylePrl->styleFont['color'] = $red . $green . $blue; $cbNum -= 4; break; default: // print_r('@todo Character : 0x'.dechex($oSprm->isPmd)); // print_r(PHP_EOL); } break; // Picture property case 0x03: break; // Section property case 0x04: if (!isset($oStylePrl->styleSection)) { $oStylePrl->styleSection = []; } switch ($oSprm->isPmd) { // sprmSNfcPgn case 0x0E: // numbering format used for page numbers break; // sprmSXaPage case 0x1F: $oStylePrl->styleSection['pageSizeW'] = $operand; break; // sprmSYaPage case 0x20: $oStylePrl->styleSection['pageSizeH'] = $operand; break; // sprmSDxaLeft case 0x21: $oStylePrl->styleSection['marginLeft'] = $operand; break; // sprmSDxaRight case 0x22: $oStylePrl->styleSection['marginRight'] = $operand; break; // sprmSDyaTop case 0x23: $oStylePrl->styleSection['marginTop'] = $operand; break; // sprmSDyaBottom case 0x24: $oStylePrl->styleSection['marginBottom'] = $operand; break; // sprmSFBiDi case 0x28: // RTL layout break; // sprmSDxtCharSpace case 0x30: // characpter pitch break; // sprmSDyaLinePitch case 0x31: // line height break; // sprmSClm case 0x32: // document grid mode break; // sprmSTextFlow case 0x33: // text flow break; default: // print_r('@todo Section : 0x'.dechex($oSprm->isPmd)); // print_r(PHP_EOL); } break; // Table property case 0x05: break; } } while ($cbNum > 0); if (null !== $sprmCPicLocation) { if (null !== $sprmCFData && $sprmCFData == 0x01) { // NilPICFAndBinData //@todo Read Hyperlink structure /*$lcb = self::getInt4d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 4; $cbHeader = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // ignored $sprmCPicLocation += 62; // depending of the element // Hyperlink => HFD // HFD > bits $sprmCPicLocation += 1; // HFD > clsid $sprmCPicLocation += 16; // HFD > hyperlink //@see http://msdn.microsoft.com/en-us/library/dd909835%28v=office.12%29.aspx $streamVersion = self::getInt4d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 4; $data = self::getInt4d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 4; $hlstmfAbsFromGetdataRel = ($data >> 9) & bindec('1'); $hlstmfMonikerSavedAsStr = ($data >> 8) & bindec('1'); $hlstmfHasFrameName = ($data >> 7) & bindec('1'); $hlstmfHasCreationTime = ($data >> 6) & bindec('1'); $hlstmfHasGUID = ($data >> 5) & bindec('1'); $hlstmfHasDisplayName = ($data >> 4) & bindec('1'); $hlstmfHasLocationStr = ($data >> 3) & bindec('1'); $hlstmfSiteGaveDisplayName = ($data >> 2) & bindec('1'); $hlstmfIsAbsolute = ($data >> 1) & bindec('1'); $hlstmfHasMoniker = ($data >> 0) & bindec('1'); for ($inc = 0; $inc <= 32; $inc++) { echo ($data >> $inc) & bindec('1'); } print_r('$hlstmfHasMoniker > '.$hlstmfHasMoniker.PHP_EOL); print_r('$hlstmfIsAbsolute > '.$hlstmfIsAbsolute.PHP_EOL); print_r('$hlstmfSiteGaveDisplayName > '.$hlstmfSiteGaveDisplayName.PHP_EOL); print_r('$hlstmfHasLocationStr > '.$hlstmfHasLocationStr.PHP_EOL); print_r('$hlstmfHasDisplayName > '.$hlstmfHasDisplayName.PHP_EOL); print_r('$hlstmfHasGUID > '.$hlstmfHasGUID.PHP_EOL); print_r('$hlstmfHasCreationTime > '.$hlstmfHasCreationTime.PHP_EOL); print_r('$hlstmfHasFrameName > '.$hlstmfHasFrameName.PHP_EOL); print_r('$hlstmfMonikerSavedAsStr > '.$hlstmfMonikerSavedAsStr.PHP_EOL); print_r('$hlstmfAbsFromGetdataRel > '.$hlstmfAbsFromGetdataRel.PHP_EOL); if ($streamVersion == 2) { $AAA = self::getInt4d($this->dataData, $sprmCPicLocation); echo 'AAAA : '.$AAA.PHP_EOL; if ($hlstmfHasDisplayName == 1) { echo 'displayName'.PHP_EOL; } if ($hlstmfHasFrameName == 1) { echo 'targetFrameName'.PHP_EOL; } if ($hlstmfHasMoniker == 1 || $hlstmfMonikerSavedAsStr == 1) { $sprmCPicLocation += 16; $length = self::getInt4d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 4; for ($inc = 0; $inc < ($length / 2); $inc++) { $chr = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; print_r(chr($chr)); } echo PHP_EOL; echo 'moniker : '.$length.PHP_EOL; } if ($hlstmfHasMoniker == 1 || $hlstmfMonikerSavedAsStr == 1) { echo 'oleMoniker'.PHP_EOL; } if ($hlstmfHasLocationStr == 1) { echo 'location'.PHP_EOL; } if ($hlstmfHasGUID == 1) { echo 'guid'.PHP_EOL; $sprmCPicLocation += 16; } if ($hlstmfHasCreationTime == 1) { echo 'fileTime'.PHP_EOL; $sprmCPicLocation += 4; } echo 'HYPERLINK'.PHP_EOL; }*/ } else { // Pictures //@see http://msdn.microsoft.com/en-us/library/dd925458%28v=office.12%29.aspx //@see http://msdn.microsoft.com/en-us/library/dd926136%28v=office.12%29.aspx // PICF : lcb $sprmCPicLocation += 4; // PICF : cbHeader $sprmCPicLocation += 2; // PICF : mfpf : mm $mfpfMm = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : mfpf : xExt $sprmCPicLocation += 2; // PICF : mfpf : yExt $sprmCPicLocation += 2; // PICF : mfpf : swHMF $sprmCPicLocation += 2; // PICF : innerHeader : grf $sprmCPicLocation += 4; // PICF : innerHeader : padding1 $sprmCPicLocation += 4; // PICF : innerHeader : mmPM $sprmCPicLocation += 2; // PICF : innerHeader : padding2 $sprmCPicLocation += 4; // PICF : picmid : dxaGoal $picmidDxaGoal = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : dyaGoal $picmidDyaGoal = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : mx $picmidMx = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : my $picmidMy = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : dxaReserved1 $picmidDxaCropLeft = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : dyaReserved1 $picmidDxaCropTop = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : dxaReserved2 $picmidDxaCropRight = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : dyaReserved2 $picmidDxaCropBottom = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; // PICF : picmid : fReserved ++$sprmCPicLocation; // PICF : picmid : bpp ++$sprmCPicLocation; // PICF : picmid : brcTop80 $sprmCPicLocation += 4; // PICF : picmid : brcLeft80 $sprmCPicLocation += 4; // PICF : picmid : brcBottom80 $sprmCPicLocation += 4; // PICF : picmid : brcRight80 $sprmCPicLocation += 4; // PICF : picmid : dxaReserved3 $sprmCPicLocation += 2; // PICF : picmid : dyaReserved3 $sprmCPicLocation += 2; // PICF : cProps $sprmCPicLocation += 2; if ($mfpfMm == 0x0066) { // cchPicName $cchPicName = self::getInt1d($this->dataData, $sprmCPicLocation); ++$sprmCPicLocation; // stPicName //$stPicName = ''; for ($inc = 0; $inc <= $cchPicName; ++$inc) { //$chr = self::getInt1d($this->dataData, $sprmCPicLocation); ++$sprmCPicLocation; //$stPicName .= chr($chr); } } // picture (OfficeArtInlineSpContainer) // picture : shape $shapeRH = $this->loadRecordHeader($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 8; if ($shapeRH['recVer'] == 0xF && $shapeRH['recInstance'] == 0x000 && $shapeRH['recType'] == 0xF004) { $sprmCPicLocation += $shapeRH['recLen']; } // picture : rgfb //@see http://msdn.microsoft.com/en-us/library/dd950560%28v=office.12%29.aspx $fileBlockRH = $this->loadRecordHeader($this->dataData, $sprmCPicLocation); while ($fileBlockRH['recType'] == 0xF007 || ($fileBlockRH['recType'] >= 0xF018 && $fileBlockRH['recType'] <= 0xF117)) { $sprmCPicLocation += 8; switch ($fileBlockRH['recType']) { // OfficeArtFBSE //@see http://msdn.microsoft.com/en-us/library/dd944923%28v=office.12%29.aspx case 0xF007: // btWin32 ++$sprmCPicLocation; // btMacOS ++$sprmCPicLocation; // rgbUid $sprmCPicLocation += 16; // tag $sprmCPicLocation += 2; // size $sprmCPicLocation += 4; // cRef $sprmCPicLocation += 4; // foDelay $sprmCPicLocation += 4; // unused1 ++$sprmCPicLocation; // cbName $cbName = self::getInt1d($this->dataData, $sprmCPicLocation); ++$sprmCPicLocation; // unused2 ++$sprmCPicLocation; // unused3 ++$sprmCPicLocation; // nameData if ($cbName > 0) { //$nameData = ''; for ($inc = 0; $inc <= ($cbName / 2); ++$inc) { //$chr = self::getInt2d($this->dataData, $sprmCPicLocation); $sprmCPicLocation += 2; //$nameData .= chr($chr); } } // embeddedBlip //@see http://msdn.microsoft.com/en-us/library/dd910081%28v=office.12%29.aspx $embeddedBlipRH = $this->loadRecordHeader($this->dataData, $sprmCPicLocation); switch ($embeddedBlipRH['recType']) { case self::OFFICEARTBLIPJPG: case self::OFFICEARTBLIPJPEG: if (!isset($oStylePrl->image)) { $oStylePrl->image = []; } $sprmCPicLocation += 8; // embeddedBlip : rgbUid1 $sprmCPicLocation += 16; if ($embeddedBlipRH['recInstance'] == 0x6E1) { // rgbUid2 $sprmCPicLocation += 16; } // embeddedBlip : tag ++$sprmCPicLocation; // embeddedBlip : BLIPFileData $oStylePrl->image['data'] = substr($this->dataData, $sprmCPicLocation, $embeddedBlipRH['recLen']); $oStylePrl->image['format'] = 'jpg'; // Image Size $iCropWidth = $picmidDxaGoal - ($picmidDxaCropLeft + $picmidDxaCropRight); $iCropHeight = $picmidDyaGoal - ($picmidDxaCropTop + $picmidDxaCropBottom); if (!$iCropWidth) { $iCropWidth = 1; } if (!$iCropHeight) { $iCropHeight = 1; } $oStylePrl->image['width'] = Drawing::twipsToPixels($iCropWidth * $picmidMx / 1000); $oStylePrl->image['height'] = Drawing::twipsToPixels($iCropHeight * $picmidMy / 1000); $sprmCPicLocation += $embeddedBlipRH['recLen']; break; case self::OFFICEARTBLIPPNG: break; default: // print_r(dechex($embeddedBlipRH['recType'])); } break; } $fileBlockRH = $this->loadRecordHeader($this->dataData, $sprmCPicLocation); } } } $oStylePrl->length = $pos - $posStart; return $oStylePrl; } /** * Read a record header. * * @param string $stream * @param int $pos * * @return array */ private function loadRecordHeader($stream, $pos) { $rec = self::getInt2d($stream, $pos); $recType = self::getInt2d($stream, $pos + 2); $recLen = self::getInt4d($stream, $pos + 4); return [ 'recVer' => ($rec >> 0) & bindec('1111'), 'recInstance' => ($rec >> 4) & bindec('111111111111'), 'recType' => $recType, 'recLen' => $recLen, ]; } private function generatePhpWord(): void { foreach ($this->arraySections as $itmSection) { $oSection = $this->phpWord->addSection(); $oSection->setStyle($itmSection->styleSection); $sHYPERLINK = ''; foreach ($this->arrayParagraphs as $itmParagraph) { $textPara = $itmParagraph; foreach ($this->arrayCharacters as $oCharacters) { $subText = mb_substr($textPara, $oCharacters->pos_start, $oCharacters->pos_len); $subText = str_replace(chr(13), PHP_EOL, $subText); $arrayText = explode(PHP_EOL, $subText); if (end($arrayText) == '') { array_pop($arrayText); } if (reset($arrayText) == '') { array_shift($arrayText); } // Style Character $styleFont = []; if (isset($oCharacters->style)) { if (isset($oCharacters->style->styleFont)) { $styleFont = $oCharacters->style->styleFont; } } foreach ($arrayText as $sText) { // HyperLink if (empty($sText) && !empty($sHYPERLINK)) { $arrHYPERLINK = explode('"', $sHYPERLINK); $oSection->addLink($arrHYPERLINK[1], null); // print_r('>addHyperLink<'.$sHYPERLINK.'>'.ord($sHYPERLINK[0]).EOL); $sHYPERLINK = ''; } // TextBreak if (empty($sText)) { $oSection->addTextBreak(); $sHYPERLINK = ''; // print_r('>addTextBreak<' . EOL); } if (!empty($sText)) { if (!empty($sHYPERLINK) && ord($sText[0]) > 20) { $sHYPERLINK .= $sText; } if (empty($sHYPERLINK)) { if (ord($sText[0]) > 20) { if (strpos(trim($sText), 'HYPERLINK "') === 0) { $sHYPERLINK = $sText; } else { $oSection->addText($sText, $styleFont); // print_r('>addText<'.$sText.'>'.ord($sText[0]).EOL); } } if (ord($sText[0]) == 1) { if (isset($oCharacters->style->image)) { $fileImage = tempnam(sys_get_temp_dir(), 'PHPWord_MsDoc') . '.' . $oCharacters->style->image['format']; file_put_contents($fileImage, $oCharacters->style->image['data']); $oSection->addImage($fileImage, ['width' => $oCharacters->style->image['width'], 'height' => $oCharacters->style->image['height']]); // print_r('>addImage<'.$fileImage.'>'.EOL); } } } } } } } } } /** * Read 8-bit unsigned integer. * * @param string $data * @param int $pos * * @return int */ public static function getInt1d($data, $pos) { return ord($data[$pos]); } /** * Read 16-bit unsigned integer. * * @param string $data * @param int $pos * * @return int */ public static function getInt2d($data, $pos) { return ord($data[$pos]) | (ord($data[$pos + 1]) << 8); } /** * Read 24-bit signed integer. * * @param string $data * @param int $pos * * @return int */ public static function getInt3d($data, $pos) { return ord($data[$pos]) | (ord($data[$pos + 1]) << 8) | (ord($data[$pos + 2]) << 16); } /** * Read 32-bit signed integer. * * @param string $data * @param int $pos * * @return int */ public static function getInt4d($data, $pos) { // FIX: represent numbers correctly on 64-bit system // http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334 // Hacked by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems $or24 = ord($data[$pos + 3]); if ($or24 >= 128) { // negative number $ord24 = -abs((256 - $or24) << 24); } else { $ord24 = ($or24 & 127) << 24; } return ord($data[$pos]) | (ord($data[$pos + 1]) << 8) | (ord($data[$pos + 2]) << 16) | $ord24; } } ================================================ FILE: src/PhpWord/Reader/ODText/AbstractPart.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); $nodes = $xmlReader->getElements('office:body/office:text/*'); $this->section = null; $this->processNodes($nodes, $xmlReader, $phpWord); $this->section = null; } /** @param DOMNodeList $nodes */ public function processNodes(DOMNodeList $nodes, XMLReader $xmlReader, PhpWord $phpWord): void { if ($nodes->length > 0) { foreach ($nodes as $node) { // $styleName = $xmlReader->getAttribute('text:style-name', $node); switch ($node->nodeName) { case 'text:h': // Heading $depth = $xmlReader->getAttribute('text:outline-level', $node); $this->getSection($phpWord)->addTitle($node->nodeValue, $depth); break; case 'text:p': // Paragraph $styleName = $xmlReader->getAttribute('text:style-name', $node); if (substr($styleName, 0, 2) === 'SB') { break; } $element = $xmlReader->getElement('draw:frame/draw:object', $node); if ($element) { $mathFile = str_replace('./', '', $element->getAttribute('xlink:href')) . '/content.xml'; $xmlReaderObject = new XMLReader(); $mathElement = $xmlReaderObject->getDomFromZip($this->docFile, $mathFile); if ($mathElement) { $mathXML = $mathElement->saveXML($mathElement); if (is_string($mathXML)) { $reader = new MathML(); $math = $reader->read($mathXML); $this->getSection($phpWord)->addFormula($math); } } } else { $children = $node->childNodes; $spans = false; /** @var DOMElement $child */ foreach ($children as $child) { switch ($child->nodeName) { case 'text:change-start': $changeId = $child->getAttribute('text:change-id'); if (isset($trackedChanges[$changeId])) { $changed = $trackedChanges[$changeId]; } break; case 'text:change-end': unset($changed); break; case 'text:change': $changeId = $child->getAttribute('text:change-id'); if (isset($trackedChanges[$changeId])) { $changed = $trackedChanges[$changeId]; } break; case 'text:span': $spans = true; break; } } if ($spans) { $element = $this->getSection($phpWord)->addTextRun(); foreach ($children as $child) { switch ($child->nodeName) { case 'text:span': /** @var DOMElement $child2 */ foreach ($child->childNodes as $child2) { switch ($child2->nodeName) { case '#text': $element->addText($child2->nodeValue); break; case 'text:tab': $element->addText("\t"); break; case 'text:s': $spaces = (int) $child2->getAttribute('text:c') ?: 1; $element->addText(str_repeat(' ', $spaces)); break; } } break; } } } else { $element = $this->getSection($phpWord)->addText($node->nodeValue); } if (isset($changed) && is_array($changed)) { $element->setTrackChange($changed['changed']); if (isset($changed['textNodes'])) { foreach ($changed['textNodes'] as $changedNode) { $element = $this->getSection($phpWord)->addText($changedNode->nodeValue); $element->setTrackChange($changed['changed']); } } } } break; case 'text:list': // List $listItems = $xmlReader->getElements('text:list-item/text:p', $node); foreach ($listItems as $listItem) { // $listStyleName = $xmlReader->getAttribute('text:style-name', $listItem); $this->getSection($phpWord)->addListItem($listItem->nodeValue, 0); } break; case 'text:tracked-changes': $changedRegions = $xmlReader->getElements('text:changed-region', $node); foreach ($changedRegions as $changedRegion) { $type = ($changedRegion->firstChild->nodeName == 'text:insertion') ? TrackChange::INSERTED : TrackChange::DELETED; $creatorNode = $xmlReader->getElements('office:change-info/dc:creator', $changedRegion->firstChild); $author = $creatorNode[0]->nodeValue; $dateNode = $xmlReader->getElements('office:change-info/dc:date', $changedRegion->firstChild); $date = $dateNode[0]->nodeValue; $date = preg_replace('/\.\d+$/', '', $date); $date = DateTime::createFromFormat('Y-m-d\TH:i:s', $date); $changed = new TrackChange($type, $author, $date); $textNodes = $xmlReader->getElements('text:deletion/text:p', $changedRegion); $trackedChanges[$changedRegion->getAttribute('text:id')] = ['changed' => $changed, 'textNodes' => $textNodes]; } break; case 'text:section': // Section // $sectionStyleName = $xmlReader->getAttribute('text:style-name', $listItem); $this->section = $phpWord->addSection(); /** @var DOMNodeList $children */ $children = $node->childNodes; $this->processNodes($children, $xmlReader, $phpWord); break; } } } } private function getSection(PhpWord $phpWord): Section { $section = $this->section; if ($section === null) { $section = $this->section = $phpWord->addSection(); } return $section; } } ================================================ FILE: src/PhpWord/Reader/ODText/Meta.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); $docProps = $phpWord->getDocInfo(); $metaNode = $xmlReader->getElement('office:meta'); // Standard properties $properties = [ 'title' => 'dc:title', 'subject' => 'dc:subject', 'description' => 'dc:description', 'keywords' => 'meta:keyword', 'creator' => 'meta:initial-creator', 'lastModifiedBy' => 'dc:creator', // 'created' => 'meta:creation-date', // 'modified' => 'dc:date', ]; foreach ($properties as $property => $path) { $method = "set{$property}"; $propertyNode = $xmlReader->getElement($path, $metaNode); if ($propertyNode !== null && method_exists($docProps, $method)) { $docProps->$method($propertyNode->nodeValue); } } // Custom properties $propertyNodes = $xmlReader->getElements('meta:user-defined', $metaNode); foreach ($propertyNodes as $propertyNode) { $property = $xmlReader->getAttribute('meta:name', $propertyNode); // Set category, company, and manager property if (in_array($property, ['Category', 'Company', 'Manager'])) { $method = "set{$property}"; $docProps->$method($propertyNode->nodeValue); } else { // Set other custom properties $docProps->setCustomProperty($property, $propertyNode->nodeValue); } } } } ================================================ FILE: src/PhpWord/Reader/ODText.php ================================================ readRelationships($docFile); $readerParts = [ 'content.xml' => 'Content', 'meta.xml' => 'Meta', ]; foreach ($readerParts as $xmlFile => $partName) { $this->readPart($phpWord, $relationships, $partName, $docFile, $xmlFile); } return $phpWord; } /** * Read document part. */ private function readPart(PhpWord $phpWord, array $relationships, string $partName, string $docFile, string $xmlFile): void { $partClass = "PhpOffice\\PhpWord\\Reader\\ODText\\{$partName}"; if (class_exists($partClass)) { /** @var ODText\AbstractPart $part Type hint */ $part = new $partClass($docFile, $xmlFile); $part->setRels($relationships); $part->read($phpWord); } } /** * Read all relationship files. */ private function readRelationships(string $docFile): array { $rels = []; $xmlFile = 'META-INF/manifest.xml'; $xmlReader = new XMLReader(); $xmlReader->getDomFromZip($docFile, $xmlFile); $nodes = $xmlReader->getElements('manifest:file-entry'); foreach ($nodes as $node) { $type = $xmlReader->getAttribute('manifest:media-type', $node); $target = $xmlReader->getAttribute('manifest:full-path', $node); $rels[] = ['type' => $type, 'target' => $target]; } return $rels; } } ================================================ FILE: src/PhpWord/Reader/RTF/Document.php ================================================ 'markOpening', // { 125 => 'markClosing', // } 92 => 'markBackslash', // \ 10 => 'markNewline', // LF 13 => 'markNewline', // CR ]; $this->phpWord = $phpWord; $this->section = $phpWord->addSection(); $this->textrun = $this->section->addTextRun(); $this->length = strlen($this->rtf); $this->flags['paragraph'] = true; // Set paragraph flag from the beginning // Walk each characters while ($this->offset < $this->length) { $char = $this->rtf[$this->offset]; $ascii = ord($char); if (isset($markers[$ascii])) { // Marker found: {, }, \, LF, or CR $markerFunction = $markers[$ascii]; $this->$markerFunction(); } else { if (false === $this->isControl) { // Non control word: Push character $this->pushText($char); } else { if (preg_match('/^[a-zA-Z0-9-]?$/', $char)) { // No delimiter: Buffer control $this->control .= $char; $this->isFirst = false; } else { // Delimiter found: Parse buffered control if ($this->isFirst) { $this->isFirst = false; } else { if (' ' == $char) { // Discard space as a control word delimiter $this->flushControl(true); } } } } } ++$this->offset; } $this->flushText(); } /** * Mark opening braket `{` character. */ private function markOpening(): void { $this->flush(true); array_push($this->groups, $this->flags); } /** * Mark closing braket `}` character. */ private function markClosing(): void { $this->flush(true); $this->flags = array_pop($this->groups); } /** * Mark backslash `\` character. */ private function markBackslash(): void { if ($this->isFirst) { $this->setControl(false); $this->text .= '\\'; } else { $this->flush(); $this->setControl(true); $this->control = ''; } } /** * Mark newline character: Flush control word because it's not possible to span multiline. */ private function markNewline(): void { if ($this->isControl) { $this->flushControl(true); } } /** * Flush control word or text. * * @param bool $isControl */ private function flush($isControl = false): void { if ($this->isControl) { $this->flushControl($isControl); } else { $this->flushText(); } } /** * Flush control word. * * @param bool $isControl */ private function flushControl($isControl = false): void { if (1 === preg_match('/^([A-Za-z]+)(-?[0-9]*) ?$/', $this->control, $match)) { [, $control, $parameter] = $match; $this->parseControl($control, $parameter); } if (true === $isControl) { $this->setControl(false); } } /** * Flush text in queue. */ private function flushText(): void { if ($this->text != '') { if (isset($this->flags['property'])) { // Set property $this->flags['value'] = $this->text; } else { // Set text if (true === $this->flags['paragraph']) { $this->flags['paragraph'] = false; $this->flags['text'] = $this->text; } } // Add text if it's not flagged as skipped if (!isset($this->flags['skipped'])) { $this->readText(); } $this->text = ''; } } /** * Reset control word and first char state. * * @param bool $value */ private function setControl($value): void { $this->isControl = $value; $this->isFirst = $value; } /** * Push text into queue. * * @param string $char */ private function pushText($char): void { if ('<' == $char) { $this->text .= '<'; } elseif ('>' == $char) { $this->text .= '>'; } else { $this->text .= $char; } } /** * Parse control. * * @param string $control * @param string $parameter */ private function parseControl($control, $parameter): void { $controls = [ 'par' => [self::PARA, 'paragraph', true], 'b' => [self::STYL, 'font', 'bold', true], 'i' => [self::STYL, 'font', 'italic', true], 'u' => [self::STYL, 'font', 'underline', true], 'strike' => [self::STYL, 'font', 'strikethrough', true], 'fs' => [self::STYL, 'font', 'size', $parameter], 'qc' => [self::STYL, 'paragraph', 'alignment', Jc::CENTER], 'sa' => [self::STYL, 'paragraph', 'spaceAfter', $parameter], 'fonttbl' => [self::SKIP, 'fonttbl', null], 'colortbl' => [self::SKIP, 'colortbl', null], 'info' => [self::SKIP, 'info', null], 'generator' => [self::SKIP, 'generator', null], 'title' => [self::SKIP, 'title', null], 'subject' => [self::SKIP, 'subject', null], 'category' => [self::SKIP, 'category', null], 'keywords' => [self::SKIP, 'keywords', null], 'comment' => [self::SKIP, 'comment', null], 'shppict' => [self::SKIP, 'pic', null], 'fldinst' => [self::SKIP, 'link', null], ]; if (isset($controls[$control])) { [$function] = $controls[$control]; if (method_exists($this, $function)) { $directives = $controls[$control]; array_shift($directives); // remove the function variable; we won't need it $this->$function($directives); } } } /** * Read paragraph. * * @param array $directives */ private function readParagraph($directives): void { [$property, $value] = $directives; $this->textrun = $this->section->addTextRun(); $this->flags[$property] = $value; } /** * Read style. * * @param array $directives */ private function readStyle($directives): void { [$style, $property, $value] = $directives; $this->flags['styles'][$style][$property] = $value; } /** * Read skip. * * @param array $directives */ private function readSkip($directives): void { [$property] = $directives; $this->flags['property'] = $property; $this->flags['skipped'] = true; } /** * Read text. */ private function readText(): void { $text = $this->textrun->addText($this->text); if (isset($this->flags['styles']['font'])) { $text->getFontStyle()->setStyleByArray($this->flags['styles']['font']); } } } ================================================ FILE: src/PhpWord/Reader/RTF.php ================================================ canRead($docFile)) { $doc = new Document(); $doc->rtf = file_get_contents($docFile); $doc->read($phpWord); } else { throw new Exception("Cannot read {$docFile}."); } return $phpWord; } } ================================================ FILE: src/PhpWord/Reader/ReaderInterface.php ================================================ > */ protected $commentRefs = []; /** * Image Loading. * * @var bool */ protected $imageLoading = true; /** * Read part. */ abstract public function read(PhpWord $phpWord); /** * Create new instance. * * @param string $docFile * @param string $xmlFile */ public function __construct($docFile, $xmlFile) { $this->docFile = $docFile; $this->xmlFile = $xmlFile; } /** * Set relationships. * * @param array $value */ public function setRels($value): void { $this->rels = $value; } public function setImageLoading(bool $value): self { $this->imageLoading = $value; return $this; } public function hasImageLoading(): bool { return $this->imageLoading; } /** * Get comment references. * * @return array> */ public function getCommentReferences(): array { return $this->commentRefs; } /** * Set comment references. * * @param array> $commentRefs */ public function setCommentReferences(array $commentRefs): self { $this->commentRefs = $commentRefs; return $this; } /** * Set comment reference. */ private function setCommentReference(string $type, string $id, AbstractElement $element): self { if (!in_array($type, ['start', 'end'])) { throw new InvalidArgumentException('Type must be "start" or "end"'); } if (!array_key_exists($id, $this->commentRefs)) { $this->commentRefs[$id] = [ 'start' => null, 'end' => null, ]; } $this->commentRefs[$id][$type] = $element; return $this; } /** * Get comment reference. * * @return array */ protected function getCommentReference(string $id): array { if (!array_key_exists($id, $this->commentRefs)) { throw new InvalidArgumentException(sprintf('Comment with id %s isn\'t referenced in document', $id)); } return $this->commentRefs[$id]; } /** * Read w:p. * * @param AbstractContainer $parent * @param string $docPart * * @todo Get font style for preserve text */ protected function readParagraph(XMLReader $xmlReader, DOMElement $domNode, $parent, $docPart = 'document'): void { // Paragraph style $paragraphStyle = $xmlReader->elementExists('w:pPr', $domNode) ? $this->readParagraphStyle($xmlReader, $domNode) : null; if ($xmlReader->elementExists('w:r/w:fldChar/w:ffData', $domNode)) { // FormField $partOfFormField = false; $formNodes = []; $formType = null; $textRunContainers = $xmlReader->countElements('w:r|w:ins|w:del|w:hyperlink|w:smartTag', $domNode); if ($textRunContainers > 0) { $nodes = $xmlReader->getElements('*', $domNode); $paragraph = $parent->addTextRun($paragraphStyle); foreach ($nodes as $node) { if ($xmlReader->elementExists('w:fldChar/w:ffData', $node)) { $partOfFormField = true; $formNodes[] = $node; if ($xmlReader->elementExists('w:fldChar/w:ffData/w:ddList', $node)) { $formType = 'dropdown'; } elseif ($xmlReader->elementExists('w:fldChar/w:ffData/w:textInput', $node)) { $formType = 'textinput'; } elseif ($xmlReader->elementExists('w:fldChar/w:ffData/w:checkBox', $node)) { $formType = 'checkbox'; } } elseif ($partOfFormField && $xmlReader->elementExists('w:fldChar', $node) && 'end' == $xmlReader->getAttribute('w:fldCharType', $node, 'w:fldChar') ) { $formNodes[] = $node; $partOfFormField = false; // Process the form fields $this->readFormField($xmlReader, $formNodes, $paragraph, $paragraphStyle, $formType); } elseif ($partOfFormField) { $formNodes[] = $node; } else { // normal runs $this->readRun($xmlReader, $node, $paragraph, $docPart, $paragraphStyle); } } } } elseif ($xmlReader->elementExists('w:r/w:instrText', $domNode)) { // PreserveText $ignoreText = false; $textContent = ''; $fontStyle = $this->readFontStyle($xmlReader, $domNode); $nodes = $xmlReader->getElements('w:r', $domNode); foreach ($nodes as $node) { if ($xmlReader->elementExists('w:lastRenderedPageBreak', $node)) { $parent->addPageBreak(); } $instrText = $xmlReader->getValue('w:instrText', $node); if (null !== $instrText) { $textContent .= '{' . $instrText . '}'; } else { if ($xmlReader->elementExists('w:fldChar', $node)) { $fldCharType = $xmlReader->getAttribute('w:fldCharType', $node, 'w:fldChar'); if ('begin' == $fldCharType) { $ignoreText = true; } elseif ('end' == $fldCharType) { $ignoreText = false; } } if (false === $ignoreText) { $textContent .= $xmlReader->getValue('w:t', $node); } } } $parent->addPreserveText(htmlspecialchars($textContent, ENT_QUOTES, 'UTF-8'), $fontStyle, $paragraphStyle); return; } // Formula $xmlReader->registerNamespace('m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); if ($xmlReader->elementExists('m:oMath', $domNode)) { $mathElement = $xmlReader->getElement('m:oMath', $domNode); $mathXML = $mathElement->ownerDocument->saveXML($mathElement); if (is_string($mathXML)) { $reader = new OfficeMathML(); $math = $reader->read($mathXML); $parent->addFormula($math); } return; } // List item if ($xmlReader->elementExists('w:pPr/w:numPr', $domNode)) { $numId = $xmlReader->getAttribute('w:val', $domNode, 'w:pPr/w:numPr/w:numId'); $levelId = $xmlReader->getAttribute('w:val', $domNode, 'w:pPr/w:numPr/w:ilvl'); $nodes = $xmlReader->getElements('*', $domNode); $listItemRun = $parent->addListItemRun($levelId, "PHPWordList{$numId}", $paragraphStyle); foreach ($nodes as $node) { $this->readRun($xmlReader, $node, $listItemRun, $docPart, $paragraphStyle); } return; } // Heading or Title $headingDepth = $xmlReader->elementExists('w:pPr', $domNode) ? $this->getHeadingDepth($paragraphStyle) : null; if ($headingDepth !== null) { $textContent = null; $nodes = $xmlReader->getElements('w:r|w:hyperlink', $domNode); $hasRubyElement = $xmlReader->elementExists('w:r/w:ruby', $domNode); if ($nodes->length === 1 && !$hasRubyElement) { $textContent = htmlspecialchars($xmlReader->getValue('w:t', $nodes->item(0)), ENT_QUOTES, 'UTF-8'); } else { $textContent = new TextRun($paragraphStyle); foreach ($nodes as $node) { $this->readRun($xmlReader, $node, $textContent, $docPart, $paragraphStyle); } } $parent->addTitle($textContent, $headingDepth); return; } // Text and TextRun $textRunContainers = $xmlReader->countElements('w:r|w:ins|w:del|w:hyperlink|w:smartTag|w:commentReference|w:commentRangeStart|w:commentRangeEnd', $domNode); if (0 === $textRunContainers) { $parent->addTextBreak(1, $paragraphStyle); } else { $nodes = $xmlReader->getElements('*', $domNode); $paragraph = $parent->addTextRun($paragraphStyle); foreach ($nodes as $node) { $this->readRun($xmlReader, $node, $paragraph, $docPart, $paragraphStyle); } } } /** * @param DOMElement[] $domNodes * @param AbstractContainer $parent * @param mixed $paragraphStyle * @param string $formType */ private function readFormField(XMLReader $xmlReader, array $domNodes, $parent, $paragraphStyle, $formType): void { if (!in_array($formType, ['textinput', 'checkbox', 'dropdown'])) { return; } $formField = $parent->addFormField($formType, null, $paragraphStyle); $ffData = $xmlReader->getElement('w:fldChar/w:ffData', $domNodes[0]); foreach ($xmlReader->getElements('*', $ffData) as $node) { /** @var DOMElement $node */ switch ($node->localName) { case 'name': $formField->setName($node->getAttribute('w:val')); break; case 'ddList': $listEntries = []; foreach ($xmlReader->getElements('*', $node) as $ddListNode) { switch ($ddListNode->localName) { case 'result': $formField->setValue($xmlReader->getAttribute('w:val', $ddListNode)); break; case 'default': $formField->setDefault($xmlReader->getAttribute('w:val', $ddListNode)); break; case 'listEntry': $listEntries[] = $xmlReader->getAttribute('w:val', $ddListNode); break; } } $formField->setEntries($listEntries); if (null !== $formField->getValue()) { $formField->setText($listEntries[$formField->getValue()]); } break; case 'textInput': foreach ($xmlReader->getElements('*', $node) as $ddListNode) { switch ($ddListNode->localName) { case 'default': $formField->setDefault($xmlReader->getAttribute('w:val', $ddListNode)); break; case 'format': case 'maxLength': break; } } break; case 'checkBox': foreach ($xmlReader->getElements('*', $node) as $ddListNode) { switch ($ddListNode->localName) { case 'default': $formField->setDefault($xmlReader->getAttribute('w:val', $ddListNode)); break; case 'checked': $formField->setValue($xmlReader->getAttribute('w:val', $ddListNode)); break; case 'size': case 'sizeAuto': break; } } break; } } if ('textinput' == $formType) { $ignoreText = true; $textContent = ''; foreach ($domNodes as $node) { if ($xmlReader->elementExists('w:fldChar', $node)) { $fldCharType = $xmlReader->getAttribute('w:fldCharType', $node, 'w:fldChar'); if ('separate' == $fldCharType) { $ignoreText = false; } elseif ('end' == $fldCharType) { $ignoreText = true; } } if (false === $ignoreText) { $textContent .= $xmlReader->getValue('w:t', $node); } } $formField->setValue(htmlspecialchars($textContent, ENT_QUOTES, 'UTF-8')); $formField->setText(htmlspecialchars($textContent, ENT_QUOTES, 'UTF-8')); } } /** * Returns the depth of the Heading, returns 0 for a Title. * * @return null|number */ private function getHeadingDepth(?array $paragraphStyle = null) { if (is_array($paragraphStyle) && isset($paragraphStyle['styleName'])) { if ('Title' === $paragraphStyle['styleName']) { return 0; } $headingMatches = []; preg_match('/Heading(\d)/', $paragraphStyle['styleName'], $headingMatches); if (!empty($headingMatches)) { return $headingMatches[1]; } } return null; } /** * Read w:r. * * @param AbstractContainer $parent * @param string $docPart * @param mixed $paragraphStyle * * @todo Footnote paragraph style */ protected function readRun(XMLReader $xmlReader, DOMElement $domNode, $parent, $docPart, $paragraphStyle = null): void { if (in_array($domNode->nodeName, ['w:ins', 'w:del', 'w:smartTag', 'w:hyperlink', 'w:commentReference'])) { $nodes = $xmlReader->getElements('*', $domNode); foreach ($nodes as $node) { $this->readRun($xmlReader, $node, $parent, $docPart, $paragraphStyle); } } elseif ($domNode->nodeName == 'w:r') { $fontStyle = $this->readFontStyle($xmlReader, $domNode); $nodes = $xmlReader->getElements('*', $domNode); foreach ($nodes as $node) { $this->readRunChild($xmlReader, $node, $parent, $docPart, $paragraphStyle, $fontStyle); } } if ($xmlReader->elementExists('.//*["commentReference"=local-name()]', $domNode)) { $node = iterator_to_array($xmlReader->getElements('.//*["commentReference"=local-name()]', $domNode))[0]; $attributeIdentifier = $node->attributes->getNamedItem('id'); if ($attributeIdentifier) { $id = $attributeIdentifier->nodeValue; $this->setCommentReference('start', $id, $parent->getElement($parent->countElements() - 1)); $this->setCommentReference('end', $id, $parent->getElement($parent->countElements() - 1)); } } } /** * Parses nodes under w:r. * * @param string $docPart * @param mixed $paragraphStyle * @param mixed $fontStyle */ protected function readRunChild(XMLReader $xmlReader, DOMElement $node, AbstractContainer $parent, $docPart, $paragraphStyle = null, $fontStyle = null): void { $runParent = $node->parentNode->parentNode; if ($node->nodeName == 'w:footnoteReference') { // Footnote $wId = $xmlReader->getAttribute('w:id', $node); $footnote = $parent->addFootnote(); $footnote->setRelationId($wId); } elseif ($node->nodeName == 'w:endnoteReference') { // Endnote $wId = $xmlReader->getAttribute('w:id', $node); $endnote = $parent->addEndnote(); $endnote->setRelationId($wId); } elseif ($node->nodeName == 'w:pict') { // Image $rId = $xmlReader->getAttribute('r:id', $node, 'v:shape/v:imagedata'); $target = $this->getMediaTarget($docPart, $rId); if ($this->hasImageLoading() && null !== $target) { if ('External' == $this->getTargetMode($docPart, $rId)) { $imageSource = $target; } else { $imageSource = "zip://{$this->docFile}#{$target}"; } $parent->addImage($imageSource); } } elseif ($node->nodeName == 'w:drawing') { // Office 2011 Image $xmlReader->registerNamespace('wp', 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'); $xmlReader->registerNamespace('r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlReader->registerNamespace('pic', 'http://schemas.openxmlformats.org/drawingml/2006/picture'); $xmlReader->registerNamespace('a', 'http://schemas.openxmlformats.org/drawingml/2006/main'); $name = $xmlReader->getAttribute('name', $node, 'wp:inline/a:graphic/a:graphicData/pic:pic/pic:nvPicPr/pic:cNvPr'); $embedId = $xmlReader->getAttribute('r:embed', $node, 'wp:inline/a:graphic/a:graphicData/pic:pic/pic:blipFill/a:blip'); if ($name === null && $embedId === null) { // some Converters puts images on a different path $name = $xmlReader->getAttribute('name', $node, 'wp:anchor/a:graphic/a:graphicData/pic:pic/pic:nvPicPr/pic:cNvPr'); $embedId = $xmlReader->getAttribute('r:embed', $node, 'wp:anchor/a:graphic/a:graphicData/pic:pic/pic:blipFill/a:blip'); } $target = $this->getMediaTarget($docPart, $embedId); if ($this->hasImageLoading() && null !== $target) { $imageSource = "zip://{$this->docFile}#{$target}"; $parent->addImage($imageSource, null, false, $name); } } elseif ($node->nodeName == 'w:object') { // Object $rId = $xmlReader->getAttribute('r:id', $node, 'o:OLEObject'); // $rIdIcon = $xmlReader->getAttribute('r:id', $domNode, 'w:object/v:shape/v:imagedata'); $target = $this->getMediaTarget($docPart, $rId); if (null !== $target) { $textContent = "<Object: {$target}>"; $parent->addText($textContent, $fontStyle, $paragraphStyle); } } elseif ($node->nodeName == 'w:br') { $parent->addTextBreak(); } elseif ($node->nodeName == 'w:tab') { $parent->addText("\t"); } elseif ($node->nodeName == 'mc:AlternateContent') { if ($node->hasChildNodes()) { // Get fallback instead of mc:Choice to make sure it is compatible $fallbackElements = $node->getElementsByTagName('Fallback'); if ($fallbackElements->length) { $fallback = $fallbackElements->item(0); // TextRun $textContent = htmlspecialchars($fallback->nodeValue, ENT_QUOTES, 'UTF-8'); $parent->addText($textContent, $fontStyle, $paragraphStyle); } } } elseif ($node->nodeName == 'w:t' || $node->nodeName == 'w:delText') { // TextRun $textContent = htmlspecialchars($xmlReader->getValue('.', $node), ENT_QUOTES, 'UTF-8'); if ($runParent->nodeName == 'w:hyperlink') { $rId = $xmlReader->getAttribute('r:id', $runParent); $target = $this->getMediaTarget($docPart, $rId); if (null !== $target) { $parent->addLink($target, $textContent, $fontStyle, $paragraphStyle); } else { $parent->addText($textContent, $fontStyle, $paragraphStyle); } } else { /** @var AbstractElement $element */ $element = $parent->addText($textContent, $fontStyle, $paragraphStyle); if (in_array($runParent->nodeName, ['w:ins', 'w:del'])) { $type = ($runParent->nodeName == 'w:del') ? TrackChange::DELETED : TrackChange::INSERTED; $author = $runParent->getAttribute('w:author'); $date = DateTime::createFromFormat('Y-m-d\TH:i:s\Z', $runParent->getAttribute('w:date')); $date = $date instanceof DateTime ? $date : null; $element->setChangeInfo($type, $author, $date); } } } elseif ($node->nodeName == 'w:softHyphen') { $element = $parent->addText("\u{200c}", $fontStyle, $paragraphStyle); } elseif ($node->nodeName == 'w:ruby') { $rubyPropertiesNode = $xmlReader->getElement('w:rubyPr', $node); $properties = $this->readRubyProperties($xmlReader, $rubyPropertiesNode); // read base text node $baseText = new TextRun($paragraphStyle); $baseTextNode = $xmlReader->getElement('w:rubyBase/w:r', $node); $this->readRun($xmlReader, $baseTextNode, $baseText, $docPart, $paragraphStyle); // read the actual ruby text (e.g. furigana in Japanese) $rubyText = new TextRun($paragraphStyle); $rubyTextNode = $xmlReader->getElement('w:rt/w:r', $node); $this->readRun($xmlReader, $rubyTextNode, $rubyText, $docPart, $paragraphStyle); // add element to parent $parent->addRuby($baseText, $rubyText, $properties); } } /** * Read w:rubyPr element. * * @param XMLReader $xmlReader reader for XML * @param DOMElement $domNode w:RubyPr element * * @return RubyProperties ruby properties from element */ protected function readRubyProperties(XMLReader $xmlReader, DOMElement $domNode): RubyProperties { $rubyAlignment = $xmlReader->getElement('w:rubyAlign', $domNode)->getAttribute('w:val'); $rubyHps = $xmlReader->getElement('w:hps', $domNode)->getAttribute('w:val'); // font face $rubyHpsRaise = $xmlReader->getElement('w:hpsRaise', $domNode)->getAttribute('w:val'); // pts above base text $rubyHpsBaseText = $xmlReader->getElement('w:hpsBaseText', $domNode)->getAttribute('w:val'); // base text size $rubyLid = $xmlReader->getElement('w:lid', $domNode)->getAttribute('w:val'); // type of ruby $properties = new RubyProperties(); $properties->setAlignment($rubyAlignment); $properties->setFontFaceSize((float) $rubyHps); $properties->setFontPointsAboveBaseText((float) $rubyHpsRaise); $properties->setFontSizeForBaseText((float) $rubyHpsBaseText); $properties->setLanguageId($rubyLid); return $properties; } /** * Read w:tbl. * * @param mixed $parent * @param string $docPart */ protected function readTable(XMLReader $xmlReader, DOMElement $domNode, $parent, $docPart = 'document'): void { // Table style $tblStyle = null; if ($xmlReader->elementExists('w:tblPr', $domNode)) { $tblStyle = $this->readTableStyle($xmlReader, $domNode); } /** @var \PhpOffice\PhpWord\Element\Table $table Type hint */ $table = $parent->addTable($tblStyle); $tblNodes = $xmlReader->getElements('*', $domNode); foreach ($tblNodes as $tblNode) { if ('w:tblGrid' == $tblNode->nodeName) { // Column // @todo Do something with table columns } elseif ('w:tr' == $tblNode->nodeName) { // Row $rowHeight = $xmlReader->getAttribute('w:val', $tblNode, 'w:trPr/w:trHeight'); $rowHRule = $xmlReader->getAttribute('w:hRule', $tblNode, 'w:trPr/w:trHeight'); $rowHRule = $rowHRule == 'exact'; $rowStyle = [ 'tblHeader' => $xmlReader->elementExists('w:trPr/w:tblHeader', $tblNode), 'cantSplit' => $xmlReader->elementExists('w:trPr/w:cantSplit', $tblNode), 'exactHeight' => $rowHRule, ]; $row = $table->addRow($rowHeight, $rowStyle); $rowNodes = $xmlReader->getElements('*', $tblNode); foreach ($rowNodes as $rowNode) { if ('w:trPr' == $rowNode->nodeName) { // Row style // @todo Do something with row style } elseif ('w:tc' == $rowNode->nodeName) { // Cell $cellWidth = $xmlReader->getAttribute('w:w', $rowNode, 'w:tcPr/w:tcW'); $cellStyle = null; if ($xmlReader->elementExists('w:tcPr', $rowNode)) { $cellStyle = $this->readCellStyle($xmlReader, $rowNode); } $cell = $row->addCell($cellWidth, $cellStyle); $cellNodes = $xmlReader->getElements('*', $rowNode); foreach ($cellNodes as $cellNode) { if ('w:p' == $cellNode->nodeName) { // Paragraph $this->readParagraph($xmlReader, $cellNode, $cell, $docPart); } elseif ($cellNode->nodeName == 'w:tbl') { // Table $this->readTable($xmlReader, $cellNode, $cell, $docPart); } } } } } } } /** * Read w:pPr. * * @return null|array */ protected function readParagraphStyle(XMLReader $xmlReader, DOMElement $domNode) { if (!$xmlReader->elementExists('w:pPr', $domNode)) { return null; } $styleNode = $xmlReader->getElement('w:pPr', $domNode); $styleDefs = [ 'styleName' => [self::READ_VALUE, ['w:pStyle', 'w:name']], 'alignment' => [self::READ_VALUE, 'w:jc'], 'basedOn' => [self::READ_VALUE, 'w:basedOn'], 'next' => [self::READ_VALUE, 'w:next'], 'indentLeft' => [self::READ_VALUE, 'w:ind', 'w:left'], 'indentRight' => [self::READ_VALUE, 'w:ind', 'w:right'], 'indentHanging' => [self::READ_VALUE, 'w:ind', 'w:hanging'], 'indentFirstLine' => [self::READ_VALUE, 'w:ind', 'w:firstLine'], 'indentFirstLineChars' => [self::READ_VALUE, 'w:ind', 'w:firstLineChars'], 'spaceAfter' => [self::READ_VALUE, 'w:spacing', 'w:after'], 'spaceBefore' => [self::READ_VALUE, 'w:spacing', 'w:before'], 'widowControl' => [self::READ_FALSE, 'w:widowControl'], 'keepNext' => [self::READ_TRUE, 'w:keepNext'], 'keepLines' => [self::READ_TRUE, 'w:keepLines'], 'pageBreakBefore' => [self::READ_TRUE, 'w:pageBreakBefore'], 'contextualSpacing' => [self::READ_TRUE, 'w:contextualSpacing'], 'bidi' => [self::READ_TRUE, 'w:bidi'], 'suppressAutoHyphens' => [self::READ_TRUE, 'w:suppressAutoHyphens'], 'borderTopStyle' => [self::READ_VALUE, 'w:pBdr/w:top'], 'borderTopColor' => [self::READ_VALUE, 'w:pBdr/w:top', 'w:color'], 'borderTopSize' => [self::READ_VALUE, 'w:pBdr/w:top', 'w:sz'], 'borderRightStyle' => [self::READ_VALUE, 'w:pBdr/w:right'], 'borderRightColor' => [self::READ_VALUE, 'w:pBdr/w:right', 'w:color'], 'borderRightSize' => [self::READ_VALUE, 'w:pBdr/w:right', 'w:sz'], 'borderBottomStyle' => [self::READ_VALUE, 'w:pBdr/w:bottom'], 'borderBottomColor' => [self::READ_VALUE, 'w:pBdr/w:bottom', 'w:color'], 'borderBottomSize' => [self::READ_VALUE, 'w:pBdr/w:bottom', 'w:sz'], 'borderLeftStyle' => [self::READ_VALUE, 'w:pBdr/w:left'], 'borderLeftColor' => [self::READ_VALUE, 'w:pBdr/w:left', 'w:color'], 'borderLeftSize' => [self::READ_VALUE, 'w:pBdr/w:left', 'w:sz'], ]; return $this->readStyleDefs($xmlReader, $styleNode, $styleDefs); } /** * Read w:rPr. * * @return null|array */ protected function readFontStyle(XMLReader $xmlReader, DOMElement $domNode) { if (null === $domNode) { return null; } // Hyperlink has an extra w:r child if ('w:hyperlink' == $domNode->nodeName) { $domNode = $xmlReader->getElement('w:r', $domNode); } if (!$xmlReader->elementExists('w:rPr', $domNode)) { return null; } $styleNode = $xmlReader->getElement('w:rPr', $domNode); $styleDefs = [ 'styleName' => [self::READ_VALUE, 'w:rStyle'], 'name' => [self::READ_VALUE, 'w:rFonts', ['w:ascii', 'w:hAnsi', 'w:eastAsia', 'w:cs']], 'hint' => [self::READ_VALUE, 'w:rFonts', 'w:hint'], 'size' => [self::READ_SIZE, ['w:sz', 'w:szCs']], 'color' => [self::READ_VALUE, 'w:color'], 'underline' => [self::READ_VALUE, 'w:u'], 'bold' => [self::READ_TRUE, 'w:b'], 'italic' => [self::READ_TRUE, 'w:i'], 'strikethrough' => [self::READ_TRUE, 'w:strike'], 'doubleStrikethrough' => [self::READ_TRUE, 'w:dstrike'], 'smallCaps' => [self::READ_TRUE, 'w:smallCaps'], 'allCaps' => [self::READ_TRUE, 'w:caps'], 'superScript' => [self::READ_EQUAL, 'w:vertAlign', 'w:val', 'superscript'], 'subScript' => [self::READ_EQUAL, 'w:vertAlign', 'w:val', 'subscript'], 'fgColor' => [self::READ_VALUE, 'w:highlight'], 'rtl' => [self::READ_TRUE, 'w:rtl'], 'lang' => [self::READ_VALUE, 'w:lang'], 'position' => [self::READ_VALUE, 'w:position'], 'hidden' => [self::READ_TRUE, 'w:vanish'], ]; return $this->readStyleDefs($xmlReader, $styleNode, $styleDefs); } /** * Read w:tblPr. * * @return null|array|string * * @todo Capture w:tblStylePr w:type="firstRow" */ protected function readTableStyle(XMLReader $xmlReader, DOMElement $domNode) { $style = null; $margins = ['top', 'left', 'bottom', 'right']; $borders = array_merge($margins, ['insideH', 'insideV']); if ($xmlReader->elementExists('w:tblPr', $domNode)) { if ($xmlReader->elementExists('w:tblPr/w:tblStyle', $domNode)) { $style = $xmlReader->getAttribute('w:val', $domNode, 'w:tblPr/w:tblStyle'); } else { $styleNode = $xmlReader->getElement('w:tblPr', $domNode); $styleDefs = []; foreach ($margins as $side) { $ucfSide = ucfirst($side); $styleDefs["cellMargin$ucfSide"] = [self::READ_VALUE, "w:tblCellMar/w:$side", 'w:w']; } foreach ($borders as $side) { $ucfSide = ucfirst($side); $styleDefs["border{$ucfSide}Size"] = [self::READ_VALUE, "w:tblBorders/w:$side", 'w:sz']; $styleDefs["border{$ucfSide}Color"] = [self::READ_VALUE, "w:tblBorders/w:$side", 'w:color']; $styleDefs["border{$ucfSide}Style"] = [self::READ_VALUE, "w:tblBorders/w:$side", 'w:val']; } $styleDefs['layout'] = [self::READ_VALUE, 'w:tblLayout', 'w:type']; $styleDefs['bidiVisual'] = [self::READ_TRUE, 'w:bidiVisual']; $styleDefs['cellSpacing'] = [self::READ_VALUE, 'w:tblCellSpacing', 'w:w']; $style = $this->readStyleDefs($xmlReader, $styleNode, $styleDefs); $tablePositionNode = $xmlReader->getElement('w:tblpPr', $styleNode); if ($tablePositionNode !== null) { $style['position'] = $this->readTablePosition($xmlReader, $tablePositionNode); } $indentNode = $xmlReader->getElement('w:tblInd', $styleNode); if ($indentNode !== null) { $style['indent'] = $this->readTableIndent($xmlReader, $indentNode); } } } return $style; } /** * Read w:tblpPr. * * @return array */ private function readTablePosition(XMLReader $xmlReader, DOMElement $domNode) { $styleDefs = [ 'leftFromText' => [self::READ_VALUE, '.', 'w:leftFromText'], 'rightFromText' => [self::READ_VALUE, '.', 'w:rightFromText'], 'topFromText' => [self::READ_VALUE, '.', 'w:topFromText'], 'bottomFromText' => [self::READ_VALUE, '.', 'w:bottomFromText'], 'vertAnchor' => [self::READ_VALUE, '.', 'w:vertAnchor'], 'horzAnchor' => [self::READ_VALUE, '.', 'w:horzAnchor'], 'tblpXSpec' => [self::READ_VALUE, '.', 'w:tblpXSpec'], 'tblpX' => [self::READ_VALUE, '.', 'w:tblpX'], 'tblpYSpec' => [self::READ_VALUE, '.', 'w:tblpYSpec'], 'tblpY' => [self::READ_VALUE, '.', 'w:tblpY'], ]; return $this->readStyleDefs($xmlReader, $domNode, $styleDefs); } /** * Read w:tblInd. * * @return TblWidthComplexType */ private function readTableIndent(XMLReader $xmlReader, DOMElement $domNode) { $styleDefs = [ 'value' => [self::READ_VALUE, '.', 'w:w'], 'type' => [self::READ_VALUE, '.', 'w:type'], ]; $styleDefs = $this->readStyleDefs($xmlReader, $domNode, $styleDefs); return new TblWidthComplexType((int) $styleDefs['value'], $styleDefs['type']); } /** * Read w:tcPr. * * @return null|array */ private function readCellStyle(XMLReader $xmlReader, DOMElement $domNode) { $styleDefs = [ 'valign' => [self::READ_VALUE, 'w:vAlign'], 'textDirection' => [self::READ_VALUE, 'w:textDirection'], 'gridSpan' => [self::READ_VALUE, 'w:gridSpan'], 'vMerge' => [self::READ_VALUE, 'w:vMerge', null, null, 'continue'], 'bgColor' => [self::READ_VALUE, 'w:shd', 'w:fill'], 'noWrap' => [self::READ_VALUE, 'w:noWrap', null, null, true], ]; $style = null; if ($xmlReader->elementExists('w:tcPr', $domNode)) { $styleNode = $xmlReader->getElement('w:tcPr', $domNode); $borders = ['top', 'left', 'bottom', 'right']; foreach ($borders as $side) { $ucfSide = ucfirst($side); $styleDefs['border' . $ucfSide . 'Size'] = [self::READ_VALUE, 'w:tcBorders/w:' . $side, 'w:sz']; $styleDefs['border' . $ucfSide . 'Color'] = [self::READ_VALUE, 'w:tcBorders/w:' . $side, 'w:color']; $styleDefs['border' . $ucfSide . 'Style'] = [self::READ_VALUE, 'w:tcBorders/w:' . $side, 'w:val']; } $style = $this->readStyleDefs($xmlReader, $styleNode, $styleDefs); } return $style; } /** * Returns the first child element found. * * @param null|array|string $elements * * @return null|string */ private function findPossibleElement(XMLReader $xmlReader, ?DOMElement $parentNode = null, $elements = null) { if (is_array($elements)) { //if element is an array, we take the first element that exists in the XML foreach ($elements as $possibleElement) { if ($xmlReader->elementExists($possibleElement, $parentNode)) { return $possibleElement; } } } else { return $elements; } return null; } /** * Returns the first attribute found. * * @param array|string $attributes * * @return null|string */ private function findPossibleAttribute(XMLReader $xmlReader, DOMElement $node, $attributes) { //if attribute is an array, we take the first attribute that exists in the XML if (is_array($attributes)) { foreach ($attributes as $possibleAttribute) { if ($xmlReader->getAttribute($possibleAttribute, $node)) { return $possibleAttribute; } } return null; } return $attributes; } /** * Read style definition. * * @param array $styleDefs * * @ignoreScrutinizerPatch * * @return array */ protected function readStyleDefs(XMLReader $xmlReader, ?DOMElement $parentNode = null, $styleDefs = []) { $styles = []; foreach ($styleDefs as $styleProp => $styleVal) { [$method, $element, $attribute, $expected, $default] = array_pad($styleVal, 5, null); $element = $this->findPossibleElement($xmlReader, $parentNode, $element); if ($element === null) { continue; } if ($xmlReader->elementExists($element, $parentNode)) { $node = $xmlReader->getElement($element, $parentNode); $attribute = $this->findPossibleAttribute($xmlReader, $node, $attribute); // Use w:val as default if no attribute assigned $attribute = ($attribute === null) ? 'w:val' : $attribute; $attributeValue = $xmlReader->getAttribute($attribute, $node) ?? $default; $styleValue = $this->readStyleDef($method, $attributeValue, $expected); if ($styleValue !== null) { $styles[$styleProp] = $styleValue; } } } return $styles; } /** * Return style definition based on conversion method. * * @param string $method * * @ignoreScrutinizerPatch * * @param null|string $attributeValue * @param mixed $expected * * @return mixed */ private function readStyleDef($method, $attributeValue, $expected) { $style = $attributeValue; if (self::READ_SIZE == $method) { $style = $attributeValue / 2; } elseif (self::READ_TRUE == $method) { $style = $this->isOn($attributeValue); } elseif (self::READ_FALSE == $method) { $style = !$this->isOn($attributeValue); } elseif (self::READ_EQUAL == $method) { $style = $attributeValue == $expected; } return $style; } /** * Parses the value of the on/off value, null is considered true as it means the w:val attribute was not present. * * @see http://www.datypic.com/sc/ooxml/t-w_ST_OnOff.html * * @param string $value * * @return bool */ private function isOn($value = null) { return $value === null || $value === '1' || $value === 'true' || $value === 'on'; } /** * Returns the target of image, object, or link as stored in ::readMainRels. * * @param string $docPart * @param string $rId * * @return null|string */ private function getMediaTarget($docPart, $rId) { $target = null; if (isset($this->rels[$docPart], $this->rels[$docPart][$rId])) { $target = $this->rels[$docPart][$rId]['target']; } return $target; } /** * Returns the target mode. * * @param string $docPart * @param string $rId * * @return null|string */ private function getTargetMode($docPart, $rId) { $mode = null; if (isset($this->rels[$docPart], $this->rels[$docPart][$rId])) { $mode = $this->rels[$docPart][$rId]['targetMode']; } return $mode; } } ================================================ FILE: src/PhpWord/Reader/Word2007/Comments.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); $comments = $phpWord->getComments(); $nodes = $xmlReader->getElements('*'); foreach ($nodes as $node) { $name = str_replace('w:', '', $node->nodeName); $author = $xmlReader->getAttribute('w:author', $node); $date = $xmlReader->getAttribute('w:date', $node); $initials = $xmlReader->getAttribute('w:initials', $node); $element = new Comment($author, new DateTime($date), $initials); $range = $this->getCommentReference($xmlReader->getAttribute('w:id', $node)); if ($range['start']) { $range['start']->setCommentRangeStart($element); } if ($range['end']) { $range['end']->setCommentRangeEnd($element); } $pNodes = $xmlReader->getElements('w:p/w:r', $node); foreach ($pNodes as $pNode) { $this->readRun($xmlReader, $pNode, $element, $this->collection); } $phpWord->getComments()->addItem($element); } } } ================================================ FILE: src/PhpWord/Reader/Word2007/DocPropsApp.php ================================================ 'setCompany', 'Manager' => 'setManager']; /** * Callback functions. * * @var array */ protected $callbacks = []; } ================================================ FILE: src/PhpWord/Reader/Word2007/DocPropsCore.php ================================================ 'setCreator', 'dc:title' => 'setTitle', 'dc:description' => 'setDescription', 'dc:subject' => 'setSubject', 'cp:keywords' => 'setKeywords', 'cp:category' => 'setCategory', 'cp:lastModifiedBy' => 'setLastModifiedBy', 'dcterms:created' => 'setCreated', 'dcterms:modified' => 'setModified', ]; /** * Callback functions. * * @var array */ protected $callbacks = ['dcterms:created' => 'strtotime', 'dcterms:modified' => 'strtotime']; /** * Read core/extended document properties. */ public function read(PhpWord $phpWord): void { $xmlReader = new XMLReader(); $xmlReader->getDomFromZip($this->docFile, $this->xmlFile); $docProps = $phpWord->getDocInfo(); $nodes = $xmlReader->getElements('*'); if ($nodes->length > 0) { foreach ($nodes as $node) { if (!isset($this->mapping[$node->nodeName])) { continue; } $method = $this->mapping[$node->nodeName]; $value = $node->nodeValue == '' ? null : $node->nodeValue; if (isset($this->callbacks[$node->nodeName])) { $value = $this->callbacks[$node->nodeName]($value); } if (method_exists($docProps, $method)) { $docProps->$method($value); } } } } } ================================================ FILE: src/PhpWord/Reader/Word2007/DocPropsCustom.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); $docProps = $phpWord->getDocInfo(); $nodes = $xmlReader->getElements('*'); if ($nodes->length > 0) { foreach ($nodes as $node) { $propertyName = $xmlReader->getAttribute('name', $node); $attributeNode = $xmlReader->getElement('*', $node); $attributeType = $attributeNode->nodeName; $attributeValue = $attributeNode->nodeValue; $attributeValue = DocInfo::convertProperty($attributeValue, $attributeType); $attributeType = DocInfo::convertPropertyType($attributeType); $docProps->setCustomProperty($propertyName, $attributeValue, $attributeType); } } } } ================================================ FILE: src/PhpWord/Reader/Word2007/Document.php ================================================ phpWord = $phpWord; $xmlReader = new XMLReader(); $xmlReader->getDomFromZip($this->docFile, $this->xmlFile); $readMethods = ['w:p' => 'readWPNode', 'w:tbl' => 'readTable', 'w:sectPr' => 'readWSectPrNode']; $nodes = $xmlReader->getElements('w:body/*'); if ($nodes->length > 0) { $section = $this->phpWord->addSection(); foreach ($nodes as $node) { if (isset($readMethods[$node->nodeName])) { $readMethod = $readMethods[$node->nodeName]; $this->$readMethod($xmlReader, $node, $section); } } } } /** * Read header footer. * * @param array $settings */ private function readHeaderFooter($settings, Section &$section): void { $readMethods = ['w:p' => 'readParagraph', 'w:tbl' => 'readTable']; if (is_array($settings) && isset($settings['hf'])) { foreach ($settings['hf'] as $rId => $hfSetting) { if (isset($this->rels['document'][$rId])) { [$hfType, $xmlFile, $docPart] = array_values($this->rels['document'][$rId]); $addMethod = "add{$hfType}"; $hfObject = $section->$addMethod($hfSetting['type']); // Read header/footer content $xmlReader = new XMLReader(); $xmlReader->getDomFromZip($this->docFile, $xmlFile); $nodes = $xmlReader->getElements('*'); if ($nodes->length > 0) { foreach ($nodes as $node) { if (isset($readMethods[$node->nodeName])) { $readMethod = $readMethods[$node->nodeName]; $this->$readMethod($xmlReader, $node, $hfObject, $docPart); } } } } } } } /** * Read w:sectPr. * * @ignoreScrutinizerPatch * * @return array */ private function readSectionStyle(XMLReader $xmlReader, DOMElement $domNode) { $styleDefs = [ 'breakType' => [self::READ_VALUE, 'w:type'], 'vAlign' => [self::READ_VALUE, 'w:vAlign'], 'pageSizeW' => [self::READ_VALUE, 'w:pgSz', 'w:w'], 'pageSizeH' => [self::READ_VALUE, 'w:pgSz', 'w:h'], 'orientation' => [self::READ_VALUE, 'w:pgSz', 'w:orient'], 'colsNum' => [self::READ_VALUE, 'w:cols', 'w:num'], 'colsSpace' => [self::READ_VALUE, 'w:cols', 'w:space'], 'marginTop' => [self::READ_VALUE, 'w:pgMar', 'w:top'], 'marginLeft' => [self::READ_VALUE, 'w:pgMar', 'w:left'], 'marginBottom' => [self::READ_VALUE, 'w:pgMar', 'w:bottom'], 'marginRight' => [self::READ_VALUE, 'w:pgMar', 'w:right'], 'headerHeight' => [self::READ_VALUE, 'w:pgMar', 'w:header'], 'footerHeight' => [self::READ_VALUE, 'w:pgMar', 'w:footer'], 'gutter' => [self::READ_VALUE, 'w:pgMar', 'w:gutter'], ]; $styles = $this->readStyleDefs($xmlReader, $domNode, $styleDefs); // Header and footer // @todo Cleanup this part $nodes = $xmlReader->getElements('*', $domNode); foreach ($nodes as $node) { if ($node->nodeName == 'w:headerReference' || $node->nodeName == 'w:footerReference') { $id = $xmlReader->getAttribute('r:id', $node); $styles['hf'][$id] = [ 'method' => str_replace('w:', '', str_replace('Reference', '', $node->nodeName)), 'type' => $xmlReader->getAttribute('w:type', $node), ]; } } return $styles; } /** * Read w:p node. */ private function readWPNode(XMLReader $xmlReader, DOMElement $node, Section &$section): void { // Page break if ($xmlReader->getAttribute('w:type', $node, 'w:r/w:br') == 'page') { $section->addPageBreak(); // PageBreak } // Paragraph $this->readParagraph($xmlReader, $node, $section); // Section properties if ($xmlReader->elementExists('w:pPr/w:sectPr', $node)) { $sectPrNode = $xmlReader->getElement('w:pPr/w:sectPr', $node); if ($sectPrNode !== null) { $this->readWSectPrNode($xmlReader, $sectPrNode, $section); } $section = $this->phpWord->addSection(); } } /** * Read w:sectPr node. */ private function readWSectPrNode(XMLReader $xmlReader, DOMElement $node, Section &$section): void { $style = $this->readSectionStyle($xmlReader, $node); $section->setStyle($style); $this->readHeaderFooter($style, $section); } } ================================================ FILE: src/PhpWord/Reader/Word2007/Endnotes.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); $nodes = $xmlReader->getElements('*'); if ($nodes->length > 0) { foreach ($nodes as $node) { $id = $xmlReader->getAttribute('w:id', $node); $type = $xmlReader->getAttribute('w:type', $node); // Avoid w:type "separator" and "continuationSeparator" // Only look for or without w:type attribute, or with w:type = normal if ((null === $type || $type === 'normal')) { $element = $this->getElement($phpWord, $id); if ($element !== null) { $pNodes = $xmlReader->getElements('w:p/*', $node); foreach ($pNodes as $pNode) { $this->readRun($xmlReader, $pNode, $element, $this->collection); } $addMethod = "add{$this->element}"; $phpWord->$addMethod($element); } } } } } /** * Searches for the element with the given relationId. * * @param int $relationId * * @return null|\PhpOffice\PhpWord\Element\AbstractContainer */ private function getElement(PhpWord $phpWord, $relationId) { $getMethod = "get{$this->collection}"; $collection = $phpWord->$getMethod()->getItems(); //not found by key, looping to search by relationId foreach ($collection as $collectionElement) { if ($collectionElement->getRelationId() == $relationId) { return $collectionElement; } } return null; } } ================================================ FILE: src/PhpWord/Reader/Word2007/Numbering.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); // Abstract numbering definition $nodes = $xmlReader->getElements('w:abstractNum'); if ($nodes->length > 0) { foreach ($nodes as $node) { $abstractId = $xmlReader->getAttribute('w:abstractNumId', $node); $abstracts[$abstractId] = ['levels' => []]; $abstract = &$abstracts[$abstractId]; $subnodes = $xmlReader->getElements('*', $node); foreach ($subnodes as $subnode) { switch ($subnode->nodeName) { case 'w:multiLevelType': $abstract['type'] = $xmlReader->getAttribute('w:val', $subnode); break; case 'w:lvl': $levelId = $xmlReader->getAttribute('w:ilvl', $subnode); $abstract['levels'][$levelId] = $this->readLevel($xmlReader, $subnode, $levelId); break; } } } } // Numbering instance definition $nodes = $xmlReader->getElements('w:num'); if ($nodes->length > 0) { foreach ($nodes as $node) { $numId = $xmlReader->getAttribute('w:numId', $node); $abstractId = $xmlReader->getAttribute('w:val', $node, 'w:abstractNumId'); $numberings[$numId] = $abstracts[$abstractId]; $numberings[$numId]['numId'] = $numId; $subnodes = $xmlReader->getElements('w:lvlOverride/w:lvl', $node); foreach ($subnodes as $subnode) { $levelId = $xmlReader->getAttribute('w:ilvl', $subnode); $overrides = $this->readLevel($xmlReader, $subnode, $levelId); foreach ($overrides as $key => $value) { $numberings[$numId]['levels'][$levelId][$key] = $value; } } } } // Push to Style collection foreach ($numberings as $numId => $numbering) { $phpWord->addNumberingStyle("PHPWordList{$numId}", $numbering); } } /** * Read numbering level definition from w:abstractNum and w:num. * * @param int $levelId * * @return array */ private function readLevel(XMLReader $xmlReader, DOMElement $subnode, $levelId) { $level = []; $level['level'] = $levelId; $level['start'] = $xmlReader->getAttribute('w:val', $subnode, 'w:start'); $level['format'] = $xmlReader->getAttribute('w:val', $subnode, 'w:numFmt'); $level['restart'] = $xmlReader->getAttribute('w:val', $subnode, 'w:lvlRestart'); $level['suffix'] = $xmlReader->getAttribute('w:val', $subnode, 'w:suff'); $level['text'] = $xmlReader->getAttribute('w:val', $subnode, 'w:lvlText'); $level['alignment'] = $xmlReader->getAttribute('w:val', $subnode, 'w:lvlJc'); $level['tab'] = $xmlReader->getAttribute('w:pos', $subnode, 'w:pPr/w:tabs/w:tab'); $level['left'] = $xmlReader->getAttribute('w:left', $subnode, 'w:pPr/w:ind'); $level['hanging'] = $xmlReader->getAttribute('w:hanging', $subnode, 'w:pPr/w:ind'); $level['font'] = $xmlReader->getAttribute('w:ascii', $subnode, 'w:rPr/w:rFonts'); $level['hint'] = $xmlReader->getAttribute('w:hint', $subnode, 'w:rPr/w:rFonts'); foreach ($level as $key => $value) { if (null === $value) { unset($level[$key]); } } return $level; } } ================================================ FILE: src/PhpWord/Reader/Word2007/Settings.php ================================================ */ private $booleanProperties = [ 'mirrorMargins', 'hideSpellingErrors', 'hideGrammaticalErrors', 'trackRevisions', 'doNotTrackMoves', 'doNotTrackFormatting', 'evenAndOddHeaders', 'updateFields', 'autoHyphenation', 'doNotHyphenateCaps', 'bookFoldPrinting', ]; /** * Read settings.xml. */ public function read(PhpWord $phpWord): void { $xmlReader = new XMLReader(); $xmlReader->getDomFromZip($this->docFile, $this->xmlFile); $docSettings = $phpWord->getSettings(); $nodes = $xmlReader->getElements('*'); if ($nodes->length > 0) { foreach ($nodes as $node) { $name = str_replace('w:', '', $node->nodeName); $value = $xmlReader->getAttribute('w:val', $node); $method = 'set' . $name; if (in_array($name, $this->booleanProperties)) { $docSettings->$method($value !== 'false'); } elseif (method_exists($this, $method)) { $this->$method($xmlReader, $phpWord, $node); } elseif (method_exists($docSettings, $method)) { $docSettings->$method($value); } } } } /** * Sets the document Language. */ protected function setThemeFontLang(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $val = $xmlReader->getAttribute('w:val', $node); $eastAsia = $xmlReader->getAttribute('w:eastAsia', $node); $bidi = $xmlReader->getAttribute('w:bidi', $node); $themeFontLang = new Language(); $themeFontLang->setLatin($val); $themeFontLang->setEastAsia($eastAsia); $themeFontLang->setBidirectional($bidi); $phpWord->getSettings()->setThemeFontLang($themeFontLang); } /** * Sets the document protection. */ protected function setDocumentProtection(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $documentProtection = $phpWord->getSettings()->getDocumentProtection(); $edit = $xmlReader->getAttribute('w:edit', $node); if ($edit !== null) { $documentProtection->setEditing($edit); } } /** * Sets the proof state. */ protected function setProofState(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $proofState = $phpWord->getSettings()->getProofState(); $spelling = $xmlReader->getAttribute('w:spelling', $node); $grammar = $xmlReader->getAttribute('w:grammar', $node); if ($spelling !== null) { $proofState->setSpelling($spelling); } if ($grammar !== null) { $proofState->setGrammar($grammar); } } /** * Sets the proof state. */ protected function setZoom(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $percent = $xmlReader->getAttribute('w:percent', $node); $val = $xmlReader->getAttribute('w:val', $node); if ($percent !== null || $val !== null) { $phpWord->getSettings()->setZoom($percent === null ? $val : $percent); } } /** * Set the Revision view. */ protected function setRevisionView(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $revisionView = new TrackChangesView(); $revisionView->setMarkup(filter_var($xmlReader->getAttribute('w:markup', $node), FILTER_VALIDATE_BOOLEAN)); $revisionView->setComments($xmlReader->getAttribute('w:comments', $node)); $revisionView->setInsDel(filter_var($xmlReader->getAttribute('w:insDel', $node), FILTER_VALIDATE_BOOLEAN)); $revisionView->setFormatting(filter_var($xmlReader->getAttribute('w:formatting', $node), FILTER_VALIDATE_BOOLEAN)); $revisionView->setInkAnnotations(filter_var($xmlReader->getAttribute('w:inkAnnotations', $node), FILTER_VALIDATE_BOOLEAN)); $phpWord->getSettings()->setRevisionView($revisionView); } protected function setConsecutiveHyphenLimit(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $value = $xmlReader->getAttribute('w:val', $node); if ($value !== null) { $phpWord->getSettings()->setConsecutiveHyphenLimit($value); } } protected function setHyphenationZone(XMLReader $xmlReader, PhpWord $phpWord, DOMElement $node): void { $value = $xmlReader->getAttribute('w:val', $node); if ($value !== null) { $phpWord->getSettings()->setHyphenationZone($value); } } } ================================================ FILE: src/PhpWord/Reader/Word2007/Styles.php ================================================ getDomFromZip($this->docFile, $this->xmlFile); $fontDefaults = $xmlReader->getElement('w:docDefaults/w:rPrDefault'); if ($fontDefaults !== null) { $fontDefaultStyle = $this->readFontStyle($xmlReader, $fontDefaults); if ($fontDefaultStyle) { if (array_key_exists('name', $fontDefaultStyle)) { $phpWord->setDefaultFontName($fontDefaultStyle['name']); } if (array_key_exists('size', $fontDefaultStyle)) { $phpWord->setDefaultFontSize($fontDefaultStyle['size']); } if (array_key_exists('color', $fontDefaultStyle)) { $phpWord->setDefaultFontColor($fontDefaultStyle['color']); } if (array_key_exists('lang', $fontDefaultStyle)) { $phpWord->getSettings()->setThemeFontLang(new Language($fontDefaultStyle['lang'])); } } } $paragraphDefaults = $xmlReader->getElement('w:docDefaults/w:pPrDefault'); if ($paragraphDefaults !== null) { $paragraphDefaultStyle = $this->readParagraphStyle($xmlReader, $paragraphDefaults); if ($paragraphDefaultStyle != null) { $phpWord->setDefaultParagraphStyle($paragraphDefaultStyle); } } $nodes = $xmlReader->getElements('w:style'); if ($nodes->length > 0) { foreach ($nodes as $node) { $type = $xmlReader->getAttribute('w:type', $node); $name = $xmlReader->getAttribute('w:val', $node, 'w:name'); if (null === $name) { $name = $xmlReader->getAttribute('w:styleId', $node); } $headingMatches = []; preg_match('/Heading\s*(\d)/i', $name, $headingMatches); // $default = ($xmlReader->getAttribute('w:default', $node) == 1); switch ($type) { case 'paragraph': $paragraphStyle = $this->readParagraphStyle($xmlReader, $node); $fontStyle = $this->readFontStyle($xmlReader, $node); if (!empty($headingMatches)) { $phpWord->addTitleStyle($headingMatches[1], $fontStyle, $paragraphStyle); } else { if (empty($fontStyle)) { if (is_array($paragraphStyle)) { $phpWord->addParagraphStyle($name, $paragraphStyle); } } else { $phpWord->addFontStyle($name, $fontStyle, $paragraphStyle); } } break; case 'character': $fontStyle = $this->readFontStyle($xmlReader, $node); if (!empty($fontStyle)) { $phpWord->addFontStyle($name, $fontStyle); } break; case 'table': $tStyle = $this->readTableStyle($xmlReader, $node); if (!empty($tStyle)) { $phpWord->addTableStyle($name, $tStyle); } break; } } } } } ================================================ FILE: src/PhpWord/Reader/Word2007.php ================================================ readRelationships($docFile); $commentRefs = []; $steps = [ [ 'stepPart' => 'document', 'stepItems' => [ 'styles' => 'Styles', 'numbering' => 'Numbering', ], ], [ 'stepPart' => 'main', 'stepItems' => [ 'officeDocument' => 'Document', 'core-properties' => 'DocPropsCore', 'extended-properties' => 'DocPropsApp', 'custom-properties' => 'DocPropsCustom', ], ], [ 'stepPart' => 'document', 'stepItems' => [ 'endnotes' => 'Endnotes', 'footnotes' => 'Footnotes', 'settings' => 'Settings', 'comments' => 'Comments', ], ], ]; foreach ($steps as $step) { $stepPart = $step['stepPart']; $stepItems = $step['stepItems']; if (!isset($relationships[$stepPart])) { continue; } foreach ($relationships[$stepPart] as $relItem) { $relType = $relItem['type']; if (isset($stepItems[$relType])) { $partName = $stepItems[$relType]; $xmlFile = $relItem['target']; $part = $this->readPart($phpWord, $relationships, $commentRefs, $partName, $docFile, $xmlFile); $commentRefs = $part->getCommentReferences(); } } } return $phpWord; } /** * Read document part. * * @param array> $commentRefs */ private function readPart(PhpWord $phpWord, array $relationships, array $commentRefs, string $partName, string $docFile, string $xmlFile): AbstractPart { $partClass = "PhpOffice\\PhpWord\\Reader\\Word2007\\{$partName}"; if (!class_exists($partClass)) { throw new Exception(sprintf('The part "%s" doesn\'t exist', $partClass)); } /** @var AbstractPart $part Type hint */ $part = new $partClass($docFile, $xmlFile); $part->setImageLoading($this->hasImageLoading()); $part->setRels($relationships); $part->setCommentReferences($commentRefs); $part->read($phpWord); return $part; } /** * Read all relationship files. * * @param string $docFile * * @return array */ private function readRelationships($docFile) { $relationships = []; // _rels/.rels $relationships['main'] = $this->getRels($docFile, '_rels/.rels'); // word/_rels/*.xml.rels $wordRelsPath = 'word/_rels/'; $zip = new ZipArchive(); if ($zip->open($docFile) === true) { for ($i = 0; $i < $zip->numFiles; ++$i) { $xmlFile = $zip->getNameIndex($i); if (!is_string($xmlFile)) { continue; } if ((substr($xmlFile, 0, strlen($wordRelsPath))) == $wordRelsPath && (substr($xmlFile, -1)) != '/') { $docPart = str_replace( '.xml.rels', '', str_replace($wordRelsPath, '', $xmlFile) ); $relationships[$docPart] = $this->getRels($docFile, $xmlFile, 'word/'); } } $zip->close(); } return $relationships; } /** * Get relationship array. * * @param string $docFile * @param string $xmlFile * @param string $targetPrefix * * @return array */ private function getRels($docFile, $xmlFile, $targetPrefix = '') { $metaPrefix = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/'; $officePrefix = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/'; $rels = []; $xmlReader = new XMLReader(); $xmlReader->getDomFromZip($docFile, $xmlFile); $nodes = $xmlReader->getElements('*'); foreach ($nodes as $node) { $rId = $xmlReader->getAttribute('Id', $node); $type = $xmlReader->getAttribute('Type', $node); $target = $xmlReader->getAttribute('Target', $node); $mode = $xmlReader->getAttribute('TargetMode', $node); // Remove URL prefixes from $type to make it easier to read $type = str_replace($metaPrefix, '', $type); $type = str_replace($officePrefix, '', $type); $docPart = str_replace('.xml', '', $target); // Do not add prefix to link source if ($type != 'hyperlink' && $mode != 'External') { $target = $targetPrefix . $target; } // Push to return array $rels[$rId] = ['type' => $type, 'target' => $target, 'docPart' => $docPart, 'targetMode' => $mode]; } ksort($rels); return $rels; } } ================================================ FILE: src/PhpWord/Settings.php ================================================ 0) { self::$defaultFontSize = $value; return true; } return false; } public static function setDefaultRtl(?bool $defaultRtl): void { self::$defaultRtl = $defaultRtl; } public static function isDefaultRtl(): ?bool { return self::$defaultRtl; } /** * Load setting from phpword.yml or phpword.yml.dist. */ public static function loadConfig(?string $filename = null): array { // Get config file $configFile = null; $configPath = __DIR__ . '/../../'; if ($filename !== null) { $files = [$filename]; } else { $files = ["{$configPath}phpword.ini", "{$configPath}phpword.ini.dist"]; } foreach ($files as $file) { if (file_exists($file)) { $configFile = realpath($file); break; } } // Parse config file $config = []; if ($configFile !== null) { $config = @parse_ini_file($configFile); if ($config === false) { return []; } } // Set config value $appliedConfig = []; foreach ($config as $key => $value) { $method = "set{$key}"; if (method_exists(__CLASS__, $method)) { self::$method($value); $appliedConfig[$key] = $value; } } return $appliedConfig; } /** * Get default paper. */ public static function getDefaultPaper(): string { return self::$defaultPaper; } /** * Set default paper. */ public static function setDefaultPaper(string $value): bool { if (trim($value) !== '') { self::$defaultPaper = $value; return true; } return false; } } ================================================ FILE: src/PhpWord/Shared/AbstractEnum.php ================================================ getConstants(); } return self::$constCacheArray[$calledClass]; } /** * Returns all values for this enum. * * @return array */ public static function values() { return array_values(self::getConstants()); } /** * Returns true the value is valid for this enum. * * @param string $value * * @return bool true if value is valid */ public static function isValid($value) { $values = array_values(self::getConstants()); return in_array($value, $values, true); } /** * Validates that the value passed is a valid value. * * @param string $value */ public static function validate($value): void { if (!self::isValid($value)) { $calledClass = static::class; $values = array_values(self::getConstants()); throw new InvalidArgumentException("$value is not a valid value for $calledClass, possible values are " . implode(', ', $values)); } } } ================================================ FILE: src/PhpWord/Shared/Converter.php ================================================ > */ private $styles = []; public function __construct(string $cssContent) { $this->cssContent = $cssContent; } public function process(): void { $cssContent = str_replace(["\r", "\n"], '', $this->cssContent); preg_match_all('/(.+?)\s?\{\s?(.+?)\s?\}/', $cssContent, $cssExtracted); // Check if there are x selectors and x rules if (count($cssExtracted[1]) != count($cssExtracted[2])) { return; } foreach ($cssExtracted[1] as $key => $selector) { $rules = trim($cssExtracted[2][$key]); $rules = explode(';', $rules); foreach ($rules as $rule) { if (empty($rule)) { continue; } [$key, $value] = explode(':', trim($rule)); $this->styles[$this->sanitize($selector)][$this->sanitize($key)] = $this->sanitize($value); } } } public function getStyles(): array { return $this->styles; } public function getStyle(string $selector): array { $selector = $this->sanitize($selector); return $this->styles[$selector] ?? []; } private function sanitize(string $value): string { return addslashes(trim($value)); } } ================================================ FILE: src/PhpWord/Shared/Drawing.php ================================================ . * * @param AbstractContainer $element Where the parts need to be added * @param string $html The code to parse * @param bool $fullHTML If it's a full HTML, no need to add 'body' tag * @param bool $preserveWhiteSpace If false, the whitespaces between nodes will be removed */ public static function addHtml($element, $html, $fullHTML = false, $preserveWhiteSpace = true, $options = null): void { /* * @todo parse $stylesheet for default styles. Should result in an array based on id, class and element, * which could be applied when such an element occurs in the parseNode function. */ static::$options = $options; // Preprocess: remove all line ends, decode HTML entity, // fix ampersand and angle brackets and add body tag for HTML fragments $html = str_replace(["\n", "\r"], '', $html); $html = str_replace(['<', '>', '&', '"'], ['_lt_', '_gt_', '_amp_', '_quot_'], $html); $html = html_entity_decode($html, ENT_QUOTES, 'UTF-8'); $html = str_replace('&', '&', $html); $html = str_replace(['_lt_', '_gt_', '_amp_', '_quot_'], ['<', '>', '&', '"'], $html); if (false === $fullHTML) { $html = '' . $html . ''; } // Load DOM if (\PHP_VERSION_ID < 80000) { $orignalLibEntityLoader = libxml_disable_entity_loader(true); } $dom = new DOMDocument(); $dom->preserveWhiteSpace = $preserveWhiteSpace; $dom->loadXML($html); static::$xpath = new DOMXPath($dom); $node = $dom->getElementsByTagName('body'); static::parseNode($node->item(0), $element); if (\PHP_VERSION_ID < 80000) { libxml_disable_entity_loader($orignalLibEntityLoader); } } /** * parse Inline style of a node. * * @param DOMNode $node Node to check on attributes and to compile a style array * @param array $styles is supplied, the inline style attributes are added to the already existing style * * @return array */ protected static function parseInlineStyle($node, $styles = []) { if (XML_ELEMENT_NODE == $node->nodeType) { $attributes = $node->attributes; // get all the attributes(eg: id, class) $attributeDir = $attributes->getNamedItem('dir'); $attributeDirValue = $attributeDir ? $attributeDir->nodeValue : ''; $bidi = $attributeDirValue === 'rtl'; foreach ($attributes as $attribute) { $val = $attribute->value; switch (strtolower($attribute->name)) { case 'align': $styles['alignment'] = self::mapAlign(trim($val), $bidi); break; case 'lang': $styles['lang'] = $val; break; case 'width': // tables, cells $val = $val === 'auto' ? '100%' : $val; if (false !== strpos($val, '%')) { // e.g. or
    $styles['width'] = (int) $val * 50; $styles['unit'] = \PhpOffice\PhpWord\SimpleType\TblWidth::PERCENT; } else { // e.g. , where "2" = 2px (always pixels) $styles['cellSpacing'] = Converter::pixelToTwip(self::convertHtmlSize($val)); break; case 'bgcolor': // tables, rows, cells e.g. $styles['bgColor'] = self::convertRgb($val); break; case 'valign': // cells e.g. ' . PHP_EOL; $rowCells = $rows[$i]->getCells(); $rowCellCount = count($rowCells); for ($j = 0; $j < $rowCellCount; ++$j) { $cellStyle = $rowCells[$j]->getStyle(); $cellStyleCss = $this->getTableStyle($cellStyle); $cellBgColor = $cellStyle->getBgColor(); $cellFgColor = null; if ($cellBgColor && $cellBgColor !== 'auto') { $red = hexdec(substr($cellBgColor, 0, 2)); $green = hexdec(substr($cellBgColor, 2, 2)); $blue = hexdec(substr($cellBgColor, 4, 2)); $cellFgColor = (($red * 0.299 + $green * 0.587 + $blue * 0.114) > 186) ? null : 'ffffff'; } $cellColSpan = $cellStyle->getGridSpan(); $cellRowSpan = 1; $cellVMerge = $cellStyle->getVMerge(); // If this is the first cell of the vertical merge, find out how many rows it spans if ($cellVMerge === 'restart') { $cellRowSpan = $this->calculateCellRowSpan($rows, $i, $j); } // Ignore cells that are merged vertically with previous rows if ($cellVMerge !== 'continue') { $cellTag = $tblHeader ? 'th' : 'td'; $cellColSpanAttr = (is_numeric($cellColSpan) && ($cellColSpan > 1) ? " colspan=\"{$cellColSpan}\"" : ''); $cellRowSpanAttr = ($cellRowSpan > 1 ? " rowspan=\"{$cellRowSpan}\"" : ''); $cellBgColorAttr = (empty($cellBgColor) ? '' : " bgcolor=\"#{$cellBgColor}\""); $cellFgColorAttr = (empty($cellFgColor) ? '' : " color=\"#{$cellFgColor}\""); $content .= "<{$cellTag}{$cellStyleCss}{$cellColSpanAttr}{$cellRowSpanAttr}{$cellBgColorAttr}{$cellFgColorAttr}>" . PHP_EOL; $writer = new Container($this->parentWriter, $rowCells[$j]); $content .= $writer->write(); if ($cellRowSpan > 1) { // There shouldn't be any content in the subsequent merged cells, but lets check anyway for ($k = $i + 1; $k < $rowCount; ++$k) { $kRowCells = $rows[$k]->getCells(); if (isset($kRowCells[$j]) && $kRowCells[$j]->getStyle()->getVMerge() === 'continue') { $writer = new Container($this->parentWriter, $kRowCells[$j]); $content .= $writer->write(); } else { break; } } } $content .= "" . PHP_EOL; } } $content .= '' . PHP_EOL; } $content .= '
    if (preg_match('#(?:top|bottom|middle|baseline)#i', $val, $matches)) { $styles['valign'] = self::mapAlignVertical($matches[0]); } break; } } $attributeIdentifier = $attributes->getNamedItem('id'); if ($attributeIdentifier && self::$css) { $styles = self::parseStyleDeclarations(self::$css->getStyle('#' . $attributeIdentifier->nodeValue), $styles); } $attributeClass = $attributes->getNamedItem('class'); if ($attributeClass) { if (self::$css) { $styles = self::parseStyleDeclarations(self::$css->getStyle('.' . $attributeClass->nodeValue), $styles); } $styles['className'] = $attributeClass->nodeValue; } $attributeStyle = $attributes->getNamedItem('style'); if ($attributeStyle) { $styles = self::parseStyle($attributeStyle, $styles); } } return $styles; } /** * Parse a node and add a corresponding element to the parent element. * * @param DOMNode $node node to parse * @param AbstractContainer $element object to add an element corresponding with the node * @param array $styles Array with all styles * @param array $data Array to transport data to a next level in the DOM tree, for example level of listitems */ protected static function parseNode($node, $element, $styles = [], $data = []): void { if ($node->nodeName == 'style') { self::$css = new Css($node->textContent); self::$css->process(); return; } // Populate styles array $styleTypes = ['font', 'paragraph', 'list', 'table', 'row', 'cell']; foreach ($styleTypes as $styleType) { if (!isset($styles[$styleType])) { $styles[$styleType] = []; } } // Node mapping table $nodes = [ // $method $node $element $styles $data $argument1 $argument2 'p' => ['Paragraph', $node, $element, $styles, null, null, null], 'h1' => ['Heading', $node, $element, $styles, null, 'Heading1', null], 'h2' => ['Heading', $node, $element, $styles, null, 'Heading2', null], 'h3' => ['Heading', $node, $element, $styles, null, 'Heading3', null], 'h4' => ['Heading', $node, $element, $styles, null, 'Heading4', null], 'h5' => ['Heading', $node, $element, $styles, null, 'Heading5', null], 'h6' => ['Heading', $node, $element, $styles, null, 'Heading6', null], '#text' => ['Text', $node, $element, $styles, null, null, null], 'strong' => ['Property', null, null, $styles, null, 'bold', true], 'b' => ['Property', null, null, $styles, null, 'bold', true], 'em' => ['Property', null, null, $styles, null, 'italic', true], 'i' => ['Property', null, null, $styles, null, 'italic', true], 'u' => ['Property', null, null, $styles, null, 'underline', 'single'], 'sup' => ['Property', null, null, $styles, null, 'superScript', true], 'sub' => ['Property', null, null, $styles, null, 'subScript', true], 'span' => ['Span', $node, null, $styles, null, null, null], 'font' => ['Span', $node, null, $styles, null, null, null], 'table' => ['Table', $node, $element, $styles, null, null, null], 'tr' => ['Row', $node, $element, $styles, null, null, null], 'td' => ['Cell', $node, $element, $styles, null, null, null], 'th' => ['Cell', $node, $element, $styles, null, null, null], 'ul' => ['List', $node, $element, $styles, $data, null, null], 'ol' => ['List', $node, $element, $styles, $data, null, null], 'li' => ['ListItem', $node, $element, $styles, $data, null, null], 'img' => ['Image', $node, $element, $styles, null, null, null], 'br' => ['LineBreak', null, $element, $styles, null, null, null], 'a' => ['Link', $node, $element, $styles, null, null, null], 'input' => ['Input', $node, $element, $styles, null, null, null], 'hr' => ['HorizRule', $node, $element, $styles, null, null, null], 'ruby' => ['Ruby', $node, $element, $styles, null, null, null], ]; $newElement = null; $keys = ['node', 'element', 'styles', 'data', 'argument1', 'argument2']; if (isset($nodes[$node->nodeName])) { // Execute method based on node mapping table and return $newElement or null // Arguments are passed by reference $arguments = []; $args = []; [$method, $args[0], $args[1], $args[2], $args[3], $args[4], $args[5]] = $nodes[$node->nodeName]; for ($i = 0; $i <= 5; ++$i) { if ($args[$i] !== null) { $arguments[$keys[$i]] = &$args[$i]; } } $method = "parse{$method}"; $newElement = call_user_func_array(['PhpOffice\PhpWord\Shared\Html', $method], array_values($arguments)); // Retrieve back variables from arguments foreach ($keys as $key) { if (array_key_exists($key, $arguments)) { $$key = $arguments[$key]; } } } if ($newElement === null) { $newElement = $element; } static::parseChildNodes($node, $newElement, $styles, $data); } /** * Parse child nodes. * * @param DOMNode $node * @param AbstractContainer|Row|Table $element * @param array $styles * @param array $data */ protected static function parseChildNodes($node, $element, $styles, $data): void { if ('li' != $node->nodeName) { $cNodes = $node->childNodes; if (!empty($cNodes)) { foreach ($cNodes as $cNode) { if ($element instanceof AbstractContainer || $element instanceof Table || $element instanceof Row) { self::parseNode($cNode, $element, $styles, $data); } } } } } /** * Parse paragraph node. * * @param DOMNode $node * @param AbstractContainer $element * @param array &$styles * * @return \PhpOffice\PhpWord\Element\PageBreak|TextRun */ protected static function parseParagraph($node, $element, &$styles) { $styles['paragraph'] = self::recursiveParseStylesInHierarchy($node, $styles['paragraph']); if (isset($styles['paragraph']['isPageBreak']) && $styles['paragraph']['isPageBreak']) { return $element->addPageBreak(); } return $element->addTextRun($styles['paragraph']); } /** * Parse input node. * * @param DOMNode $node * @param AbstractContainer $element * @param array &$styles */ protected static function parseInput($node, $element, &$styles): void { $attributes = $node->attributes; if (null === $attributes->getNamedItem('type')) { return; } $inputType = $attributes->getNamedItem('type')->nodeValue; switch ($inputType) { case 'checkbox': $checked = ($checked = $attributes->getNamedItem('checked')) && $checked->nodeValue === 'true' ? true : false; $textrun = $element->addTextRun($styles['paragraph']); $textrun->addFormField('checkbox')->setValue($checked); break; } } /** * Parse heading node. * * @param string $argument1 Name of heading style * * @todo Think of a clever way of defining header styles, now it is only based on the assumption, that * Heading1 - Heading6 are already defined somewhere */ protected static function parseHeading(DOMNode $node, AbstractContainer $element, array &$styles, string $argument1): TextRun { $style = new Paragraph(); $style->setStyleName($argument1); $style->setStyleByArray(self::parseInlineStyle($node, $styles['paragraph'])); return $element->addTextRun($style); } /** * Parse text node. * * @param DOMNode $node * @param AbstractContainer $element * @param array &$styles */ protected static function parseText($node, $element, &$styles): void { $styles['font'] = self::recursiveParseStylesInHierarchy($node, $styles['font']); //alignment applies on paragraph, not on font. Let's copy it there if (isset($styles['font']['alignment']) && is_array($styles['paragraph'])) { $styles['paragraph']['alignment'] = $styles['font']['alignment']; } if (is_callable([$element, 'addText'])) { $element->addText($node->nodeValue, $styles['font'], $styles['paragraph']); } } /** * Parse property node. * * @param array &$styles * @param string $argument1 Style name * @param string $argument2 Style value */ protected static function parseProperty(&$styles, $argument1, $argument2): void { $styles['font'][$argument1] = $argument2; } /** * Parse span node. * * @param DOMNode $node * @param array &$styles */ protected static function parseSpan($node, &$styles): void { self::parseInlineStyle($node, $styles['font']); } /** * Parse table node. * * @param DOMNode $node * @param AbstractContainer $element * @param array &$styles * * @return Table $element * * @todo As soon as TableItem, RowItem and CellItem support relative width and height */ protected static function parseTable($node, $element, &$styles) { $elementStyles = self::parseInlineStyle($node, $styles['table']); $newElement = $element->addTable($elementStyles); // Add style name from CSS Class if (isset($elementStyles['className'])) { $newElement->getStyle()->setStyleName($elementStyles['className']); } $attributes = $node->attributes; if ($attributes->getNamedItem('border')) { $border = (int) $attributes->getNamedItem('border')->nodeValue; $newElement->getStyle()->setBorderSize(Converter::pixelToTwip($border)); } return $newElement; } /** * Parse a table row. * * @param DOMNode $node * @param Table $element * @param array &$styles * * @return Row $element */ protected static function parseRow($node, $element, &$styles) { $rowStyles = self::parseInlineStyle($node, $styles['row']); if ($node->parentNode->nodeName == 'thead') { $rowStyles['tblHeader'] = true; } // set cell height to control row heights $height = $rowStyles['height'] ?? null; unset($rowStyles['height']); // would not apply return $element->addRow($height, $rowStyles); } /** * Parse table cell. * * @param DOMNode $node * @param Table $element * @param array &$styles * * @return \PhpOffice\PhpWord\Element\Cell|TextRun $element */ protected static function parseCell($node, $element, &$styles) { $cellStyles = self::recursiveParseStylesInHierarchy($node, $styles['cell']); $colspan = $node->getAttribute('colspan'); if (!empty($colspan)) { $cellStyles['gridSpan'] = $colspan - 0; } // set cell width to control column widths $width = $cellStyles['width'] ?? null; unset($cellStyles['width']); // would not apply $cell = $element->addCell($width, $cellStyles); if (self::shouldAddTextRun($node)) { return $cell->addTextRun(self::filterOutNonInheritedStyles(self::parseInlineStyle($node, $styles['paragraph']))); } return $cell; } /** * Checks if $node contains an HTML element that cannot be added to TextRun. * * @return bool Returns true if the node contains an HTML element that cannot be added to TextRun */ protected static function shouldAddTextRun(DOMNode $node) { $containsBlockElement = self::$xpath->query('.//table|./p|./ul|./ol|./h1|./h2|./h3|./h4|./h5|./h6', $node)->length > 0; if ($containsBlockElement) { return false; } return true; } /** * Recursively parses styles on parent nodes * TODO if too slow, add caching of parent nodes, !! everything is static here so watch out for concurrency !! */ protected static function recursiveParseStylesInHierarchy(DOMNode $node, array $style) { $parentStyle = []; if ($node->parentNode != null && XML_ELEMENT_NODE == $node->parentNode->nodeType) { $parentStyle = self::recursiveParseStylesInHierarchy($node->parentNode, []); } if ($node->nodeName === '#text') { $parentStyle = array_merge($parentStyle, $style); } else { $parentStyle = self::filterOutNonInheritedStyles($parentStyle); } $style = self::parseInlineStyle($node, $parentStyle); return $style; } /** * Removes non-inherited styles from array. */ protected static function filterOutNonInheritedStyles(array $styles) { $nonInheritedStyles = [ 'borderSize', 'borderTopSize', 'borderRightSize', 'borderBottomSize', 'borderLeftSize', 'borderColor', 'borderTopColor', 'borderRightColor', 'borderBottomColor', 'borderLeftColor', 'borderStyle', 'spaceAfter', 'spaceBefore', 'underline', 'strikethrough', 'hidden', ]; $styles = array_diff_key($styles, array_flip($nonInheritedStyles)); return $styles; } /** * Parse list node. * * @param DOMNode $node * @param AbstractContainer $element * @param array &$styles * @param array &$data */ protected static function parseList($node, $element, &$styles, &$data) { $isOrderedList = $node->nodeName === 'ol'; if (isset($data['listdepth'])) { ++$data['listdepth']; } else { $data['listdepth'] = 0; $styles['list'] = 'listStyle_' . self::$listIndex++; $style = $element->getPhpWord()->addNumberingStyle($styles['list'], self::getListStyle($isOrderedList)); // extract attributes start & type e.g.
      $start = 0; $type = ''; foreach ($node->attributes as $attribute) { switch ($attribute->name) { case 'start': $start = (int) $attribute->value; break; case 'type': $type = $attribute->value; break; } } $levels = $style->getLevels(); /** @var \PhpOffice\PhpWord\Style\NumberingLevel */ $level = $levels[0]; if ($start > 0) { $level->setStart($start); } $type = $type ? self::mapListType($type) : null; if ($type) { $level->setFormat($type); } } if ($node->parentNode->nodeName === 'li') { return $element->getParent(); } } /** * @param bool $isOrderedList * * @return array */ protected static function getListStyle($isOrderedList) { if ($isOrderedList) { return [ 'type' => 'multilevel', 'levels' => [ ['format' => NumberFormat::DECIMAL, 'text' => '%1.', 'alignment' => 'left', 'tabPos' => 720, 'left' => 720, 'hanging' => 360], ['format' => NumberFormat::LOWER_LETTER, 'text' => '%2.', 'alignment' => 'left', 'tabPos' => 1440, 'left' => 1440, 'hanging' => 360], ['format' => NumberFormat::LOWER_ROMAN, 'text' => '%3.', 'alignment' => 'right', 'tabPos' => 2160, 'left' => 2160, 'hanging' => 180], ['format' => NumberFormat::DECIMAL, 'text' => '%4.', 'alignment' => 'left', 'tabPos' => 2880, 'left' => 2880, 'hanging' => 360], ['format' => NumberFormat::LOWER_LETTER, 'text' => '%5.', 'alignment' => 'left', 'tabPos' => 3600, 'left' => 3600, 'hanging' => 360], ['format' => NumberFormat::LOWER_ROMAN, 'text' => '%6.', 'alignment' => 'right', 'tabPos' => 4320, 'left' => 4320, 'hanging' => 180], ['format' => NumberFormat::DECIMAL, 'text' => '%7.', 'alignment' => 'left', 'tabPos' => 5040, 'left' => 5040, 'hanging' => 360], ['format' => NumberFormat::LOWER_LETTER, 'text' => '%8.', 'alignment' => 'left', 'tabPos' => 5760, 'left' => 5760, 'hanging' => 360], ['format' => NumberFormat::LOWER_ROMAN, 'text' => '%9.', 'alignment' => 'right', 'tabPos' => 6480, 'left' => 6480, 'hanging' => 180], ], ]; } return [ 'type' => 'hybridMultilevel', 'levels' => [ ['format' => NumberFormat::BULLET, 'text' => '•', 'alignment' => 'left', 'tabPos' => 720, 'left' => 720, 'hanging' => 360, 'font' => 'Symbol', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '◦', 'alignment' => 'left', 'tabPos' => 1440, 'left' => 1440, 'hanging' => 360, 'font' => 'Courier New', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '•', 'alignment' => 'left', 'tabPos' => 2160, 'left' => 2160, 'hanging' => 360, 'font' => 'Wingdings', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '•', 'alignment' => 'left', 'tabPos' => 2880, 'left' => 2880, 'hanging' => 360, 'font' => 'Symbol', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '◦', 'alignment' => 'left', 'tabPos' => 3600, 'left' => 3600, 'hanging' => 360, 'font' => 'Courier New', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '•', 'alignment' => 'left', 'tabPos' => 4320, 'left' => 4320, 'hanging' => 360, 'font' => 'Wingdings', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '•', 'alignment' => 'left', 'tabPos' => 5040, 'left' => 5040, 'hanging' => 360, 'font' => 'Symbol', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '◦', 'alignment' => 'left', 'tabPos' => 5760, 'left' => 5760, 'hanging' => 360, 'font' => 'Courier New', 'hint' => 'default'], ['format' => NumberFormat::BULLET, 'text' => '•', 'alignment' => 'left', 'tabPos' => 6480, 'left' => 6480, 'hanging' => 360, 'font' => 'Wingdings', 'hint' => 'default'], ], ]; } /** * Parse list item node. * * @param DOMNode $node * @param AbstractContainer $element * @param array &$styles * @param array $data * * @todo This function is almost the same like `parseChildNodes`. Merged? * @todo As soon as ListItem inherits from AbstractContainer or TextRun delete parsing part of childNodes */ protected static function parseListItem($node, $element, &$styles, $data): void { $cNodes = $node->childNodes; if (!empty($cNodes)) { $listRun = $element->addListItemRun($data['listdepth'], $styles['list'], $styles['paragraph']); foreach ($cNodes as $cNode) { self::parseNode($cNode, $listRun, $styles, $data); } } } /** * Parse style. * * @param DOMNode $attribute */ protected static function parseStyle($attribute, array $styles): array { $properties = explode(';', trim($attribute->nodeValue, " \t\n\r\0\x0B;")); $selectors = []; foreach ($properties as $property) { [$cKey, $cValue] = array_pad(explode(':', $property, 2), 2, null); $selectors[strtolower(trim($cKey))] = trim($cValue ?? ''); } return self::parseStyleDeclarations($selectors, $styles); } protected static function parseStyleDeclarations(array $selectors, array $styles): array { $bidi = ($selectors['direction'] ?? '') === 'rtl'; foreach ($selectors as $property => $value) { switch ($property) { case 'text-decoration': switch ($value) { case 'underline': $styles['underline'] = 'single'; break; case 'line-through': $styles['strikethrough'] = true; break; } break; case 'text-align': $styles['alignment'] = self::mapAlign($value, $bidi); break; case 'ruby-align': $styles['rubyAlignment'] = self::mapRubyAlign($value); break; case 'display': $styles['hidden'] = $value === 'none' || $value === 'hidden'; break; case 'direction': $styles['rtl'] = $value === 'rtl'; $styles['bidi'] = $value === 'rtl'; break; case 'font-size': $styles['size'] = Converter::cssToPoint($value); break; case 'font-family': $value = array_map('trim', explode(',', $value)); $styles['name'] = ucwords($value[0]); break; case 'color': $styles['color'] = self::convertRgb($value); break; case 'background-color': $styles['bgColor'] = self::convertRgb($value); break; case 'line-height': $matches = []; if ($value === 'normal' || $value === 'inherit') { $spacingLineRule = \PhpOffice\PhpWord\SimpleType\LineSpacingRule::AUTO; $spacing = 0; } elseif (preg_match('/([0-9]+\.?[0-9]*[a-z]+)/', $value, $matches)) { //matches number with a unit, e.g. 12px, 15pt, 20mm, ... $spacingLineRule = \PhpOffice\PhpWord\SimpleType\LineSpacingRule::EXACT; $spacing = Converter::cssToTwip($matches[1]); } elseif (preg_match('/([0-9]+)%/', $value, $matches)) { //matches percentages $spacingLineRule = \PhpOffice\PhpWord\SimpleType\LineSpacingRule::AUTO; //we are subtracting 1 line height because the Spacing writer is adding one line $spacing = ((((int) $matches[1]) / 100) * Paragraph::LINE_HEIGHT) - Paragraph::LINE_HEIGHT; } else { //any other, wich is a multiplier. E.g. 1.2 $spacingLineRule = \PhpOffice\PhpWord\SimpleType\LineSpacingRule::AUTO; //we are subtracting 1 line height because the Spacing writer is adding one line $spacing = ($value * Paragraph::LINE_HEIGHT) - Paragraph::LINE_HEIGHT; } $styles['spacingLineRule'] = $spacingLineRule; $styles['line-spacing'] = $spacing; break; case 'letter-spacing': $styles['letter-spacing'] = Converter::cssToTwip($value); break; case 'text-indent': $styles['indentation']['firstLine'] = Converter::cssToTwip($value); break; case 'font-weight': $tValue = false; if (preg_match('#bold#', $value)) { $tValue = true; // also match bolder } $styles['bold'] = $tValue; break; case 'font-style': $tValue = false; if (preg_match('#(?:italic|oblique)#', $value)) { $tValue = true; } $styles['italic'] = $tValue; break; case 'font-variant': $tValue = false; if (preg_match('#small-caps#', $value)) { $tValue = true; } $styles['smallCaps'] = $tValue; break; case 'margin': $value = Converter::cssToTwip($value); $styles['spaceBefore'] = $value; $styles['spaceAfter'] = $value; break; case 'margin-top': // BC change: up to ver. 0.17.0 incorrectly converted to points - Converter::cssToPoint($value) $styles['spaceBefore'] = Converter::cssToTwip($value); break; case 'margin-bottom': // BC change: up to ver. 0.17.0 incorrectly converted to points - Converter::cssToPoint($value) $styles['spaceAfter'] = Converter::cssToTwip($value); break; case 'padding': $valueTop = $valueRight = $valueBottom = $valueLeft = null; $cValue = preg_replace('# +#', ' ', trim($value)); $paddingArr = explode(' ', $cValue); $countParams = count($paddingArr); if ($countParams == 1) { $valueTop = $valueRight = $valueBottom = $valueLeft = $paddingArr[0]; } elseif ($countParams == 2) { $valueTop = $valueBottom = $paddingArr[0]; $valueRight = $valueLeft = $paddingArr[1]; } elseif ($countParams == 3) { $valueTop = $paddingArr[0]; $valueRight = $valueLeft = $paddingArr[1]; $valueBottom = $paddingArr[2]; } elseif ($countParams == 4) { $valueTop = $paddingArr[0]; $valueRight = $paddingArr[1]; $valueBottom = $paddingArr[2]; $valueLeft = $paddingArr[3]; } if ($valueTop !== null) { $styles['paddingTop'] = Converter::cssToTwip($valueTop); } if ($valueRight !== null) { $styles['paddingRight'] = Converter::cssToTwip($valueRight); } if ($valueBottom !== null) { $styles['paddingBottom'] = Converter::cssToTwip($valueBottom); } if ($valueLeft !== null) { $styles['paddingLeft'] = Converter::cssToTwip($valueLeft); } break; case 'padding-top': $styles['paddingTop'] = Converter::cssToTwip($value); break; case 'padding-right': $styles['paddingRight'] = Converter::cssToTwip($value); break; case 'padding-bottom': $styles['paddingBottom'] = Converter::cssToTwip($value); break; case 'padding-left': $styles['paddingLeft'] = Converter::cssToTwip($value); break; case 'border-color': self::mapBorderColor($styles, $value); break; case 'border-width': $styles['borderSize'] = Converter::cssToPoint($value); break; case 'border-style': $styles['borderStyle'] = self::mapBorderStyle($value); break; case 'width': if (preg_match('/([0-9]+[a-z]+)/', $value, $matches)) { $styles['width'] = Converter::cssToTwip($matches[1]); $styles['unit'] = \PhpOffice\PhpWord\SimpleType\TblWidth::TWIP; } elseif (preg_match('/([0-9]+)%/', $value, $matches)) { $styles['width'] = $matches[1] * 50; $styles['unit'] = \PhpOffice\PhpWord\SimpleType\TblWidth::PERCENT; } elseif (preg_match('/([0-9]+)/', $value, $matches)) { $styles['width'] = $matches[1]; $styles['unit'] = \PhpOffice\PhpWord\SimpleType\TblWidth::AUTO; } break; case 'height': $styles['height'] = Converter::cssToTwip($value); $styles['exactHeight'] = true; break; case 'border': case 'border-top': case 'border-bottom': case 'border-right': case 'border-left': // must have exact order [width color style], e.g. "1px #0011CC solid" or "2pt green solid" // Word does not accept shortened hex colors e.g. #CCC, only full e.g. #CCCCCC if (preg_match('/([0-9]+[^0-9]*)\s+(\#[a-fA-F0-9]+|[a-zA-Z]+)\s+([a-z]+)/', $value, $matches)) { if (false !== strpos($property, '-')) { $tmp = explode('-', $property); $which = $tmp[1]; $which = ucfirst($which); // e.g. bottom -> Bottom } else { $which = ''; } // Note - border width normalization: // Width of border in Word is calculated differently than HTML borders, usually showing up too bold. // Smallest 1px (or 1pt) appears in Word like 2-3px/pt in HTML once converted to twips. // Therefore we need to normalize converted twip value to cca 1/2 of value. // This may be adjusted, if better ratio or formula found. // BC change: up to ver. 0.17.0 was $size converted to points - Converter::cssToPoint($size) $size = Converter::cssToTwip($matches[1]); $size = (int) ($size / 2); // valid variants may be e.g. borderSize, borderTopSize, borderLeftColor, etc .. $styles["border{$which}Size"] = $size; // twips $styles["border{$which}Color"] = trim($matches[2], '#'); $styles["border{$which}Style"] = self::mapBorderStyle($matches[3]); } break; case 'vertical-align': // https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align if (preg_match('#(?:top|bottom|middle|sub|baseline)#i', $value, $matches)) { $styles['valign'] = self::mapAlignVertical($matches[0]); } break; case 'page-break-after': if ($value == 'always') { $styles['isPageBreak'] = true; } break; } } return $styles; } /** * Parse image node. * * @param DOMNode $node * @param AbstractContainer $element * * @return \PhpOffice\PhpWord\Element\Image */ protected static function parseImage($node, $element) { $style = []; $src = null; foreach ($node->attributes as $attribute) { switch ($attribute->name) { case 'src': $src = $attribute->value; break; case 'width': $style['width'] = self::convertHtmlSize($attribute->value); $style['unit'] = \PhpOffice\PhpWord\Style\Image::UNIT_PX; break; case 'height': $style['height'] = self::convertHtmlSize($attribute->value); $style['unit'] = \PhpOffice\PhpWord\Style\Image::UNIT_PX; break; case 'style': $styleattr = explode(';', $attribute->value); foreach ($styleattr as $attr) { if (strpos($attr, ':')) { [$k, $v] = explode(':', $attr); switch ($k) { case 'float': if (trim($v) == 'right') { $style['hPos'] = \PhpOffice\PhpWord\Style\Image::POS_RIGHT; $style['hPosRelTo'] = \PhpOffice\PhpWord\Style\Image::POS_RELTO_MARGIN; // inner section area $style['pos'] = \PhpOffice\PhpWord\Style\Image::POS_RELATIVE; $style['wrap'] = \PhpOffice\PhpWord\Style\Image::WRAP_TIGHT; $style['overlap'] = true; } if (trim($v) == 'left') { $style['hPos'] = \PhpOffice\PhpWord\Style\Image::POS_LEFT; $style['hPosRelTo'] = \PhpOffice\PhpWord\Style\Image::POS_RELTO_MARGIN; // inner section area $style['pos'] = \PhpOffice\PhpWord\Style\Image::POS_RELATIVE; $style['wrap'] = \PhpOffice\PhpWord\Style\Image::WRAP_TIGHT; $style['overlap'] = true; } break; } } } break; } } $originSrc = $src; if (strpos($src, 'data:image') !== false) { $tmpDir = Settings::getTempDir() . '/'; $match = []; preg_match('/data:image\/(\w+);base64,(.+)/', $src, $match); if (!empty($match)) { $src = $imgFile = $tmpDir . uniqid() . '.' . $match[1]; $ifp = fopen($imgFile, 'wb'); if ($ifp !== false) { fwrite($ifp, base64_decode($match[2])); fclose($ifp); } } } $src = urldecode($src); if (!is_file($src) && null !== self::$options && isset(self::$options['IMG_SRC_SEARCH'], self::$options['IMG_SRC_REPLACE']) ) { $src = str_replace(self::$options['IMG_SRC_SEARCH'], self::$options['IMG_SRC_REPLACE'], $src); } if (!is_file($src)) { if ($imgBlob = @file_get_contents($src)) { $tmpDir = Settings::getTempDir() . '/'; $match = []; preg_match('/.+\.(\w+)$/', $src, $match); $src = $tmpDir . uniqid(); if (isset($match[1])) { $src .= '.' . $match[1]; } $ifp = fopen($src, 'wb'); if ($ifp !== false) { fwrite($ifp, $imgBlob); fclose($ifp); } } } if (is_file($src)) { $newElement = $element->addImage($src, $style); } else { throw new Exception("Could not load image $originSrc"); } return $newElement; } /** * Transforms a CSS border style into a word border style. * * @param string $cssBorderStyle * * @return null|string */ protected static function mapBorderStyle($cssBorderStyle) { switch ($cssBorderStyle) { case 'none': case 'dashed': case 'dotted': case 'double': return $cssBorderStyle; default: return 'single'; } } protected static function mapBorderColor(&$styles, $cssBorderColor): void { $numColors = substr_count($cssBorderColor, '#'); if ($numColors === 1) { $styles['borderColor'] = trim($cssBorderColor, '#'); } elseif ($numColors > 1) { $colors = explode(' ', $cssBorderColor); $borders = ['borderTopColor', 'borderRightColor', 'borderBottomColor', 'borderLeftColor']; for ($i = 0; $i < min(4, $numColors, count($colors)); ++$i) { $styles[$borders[$i]] = trim($colors[$i], '#'); } } } /** * Transforms a HTML/CSS alignment into a \PhpOffice\PhpWord\SimpleType\Jc. * * @param string $cssAlignment * @param bool $bidi * * @return null|string */ protected static function mapAlign($cssAlignment, $bidi) { switch ($cssAlignment) { case 'right': return $bidi ? Jc::START : Jc::END; case 'center': return Jc::CENTER; case 'justify': return Jc::BOTH; default: return $bidi ? Jc::END : Jc::START; } } /** * Transforms a HTML/CSS ruby alignment into a \PhpOffice\PhpWord\SimpleType\Jc. */ protected static function mapRubyAlign(string $cssRubyAlignment): string { switch ($cssRubyAlignment) { case 'center': return RubyProperties::ALIGNMENT_CENTER; case 'start': return RubyProperties::ALIGNMENT_LEFT; case 'space-between': return RubyProperties::ALIGNMENT_DISTRIBUTE_SPACE; default: return ''; } } /** * Transforms a HTML/CSS vertical alignment. * * @param string $alignment * * @return null|string */ protected static function mapAlignVertical($alignment) { $alignment = strtolower($alignment); switch ($alignment) { case 'top': case 'baseline': case 'bottom': return $alignment; case 'middle': return 'center'; case 'sub': return 'bottom'; case 'text-top': case 'baseline': return 'top'; default: // @discuss - which one should apply: // - Word uses default vert. alignment: top // - all browsers use default vert. alignment: middle // Returning empty string means attribute wont be set so use Word default (top). return ''; } } /** * Map list style for ordered list. * * @param string $cssListType */ protected static function mapListType($cssListType) { switch ($cssListType) { case 'a': return NumberFormat::LOWER_LETTER; // a, b, c, .. case 'A': return NumberFormat::UPPER_LETTER; // A, B, C, .. case 'i': return NumberFormat::LOWER_ROMAN; // i, ii, iii, iv, .. case 'I': return NumberFormat::UPPER_ROMAN; // I, II, III, IV, .. case '1': default: return NumberFormat::DECIMAL; // 1, 2, 3, .. } } /** * Parse line break. * * @param AbstractContainer $element */ protected static function parseLineBreak($element): void { $element->addTextBreak(); } /** * Parse link node. * * @param DOMNode $node * @param AbstractContainer $element * @param array $styles */ protected static function parseLink($node, $element, &$styles) { $target = null; foreach ($node->attributes as $attribute) { switch ($attribute->name) { case 'href': $target = $attribute->value; break; } } $styles['font'] = self::parseInlineStyle($node, $styles['font']); if (empty($target)) { $target = '#'; } if (strpos($target, '#') === 0 && strlen($target) > 1) { return $element->addLink(substr($target, 1), $node->textContent, $styles['font'], $styles['paragraph'], true); } return $element->addLink($target, $node->textContent, $styles['font'], $styles['paragraph']); } /** * Render horizontal rule * Note: Word rule is not the same as HTML's
      since it does not support width and thus neither alignment. * * @param DOMNode $node * @param AbstractContainer $element */ protected static function parseHorizRule($node, $element): void { $styles = self::parseInlineStyle($node); //
      is implemented as an empty paragraph - extending 100% inside the section // Some properties may be controlled, e.g.
      $fontStyle = $styles + ['size' => 3]; $paragraphStyle = $styles + [ 'lineHeight' => 0.25, // multiply default line height - e.g. 1, 1.5 etc 'spacing' => 0, // twip 'spaceBefore' => 120, // twip, 240/2 (default line height) 'spaceAfter' => 120, // twip 'borderBottomSize' => empty($styles['line-height']) ? 1 : $styles['line-height'], 'borderBottomColor' => empty($styles['color']) ? '000000' : $styles['color'], 'borderBottomStyle' => 'single', // same as "solid" ]; $element->addText('', $fontStyle, $paragraphStyle); // Notes:
      cannot be: // - table - throws error "cannot be inside textruns", e.g. lists // - line - that is a shape, has different behaviour // - repeated text, e.g. underline "_", because of unpredictable line wrapping } /** * Parse ruby node. * * @param DOMNode $node * @param AbstractContainer $element * @param array $styles */ protected static function parseRuby($node, $element, &$styles) { $rubyProperties = new RubyProperties(); $baseTextRun = new TextRun($styles['paragraph']); $rubyTextRun = new TextRun(null); if ($node->hasAttributes()) { $langAttr = $node->attributes->getNamedItem('lang'); if ($langAttr !== null) { $rubyProperties->setLanguageId($langAttr->textContent); } $styleAttr = $node->attributes->getNamedItem('style'); if ($styleAttr !== null) { $styles = self::parseStyle($styleAttr, $styles['paragraph']); if (isset($styles['rubyAlignment']) && $styles['rubyAlignment'] !== '') { $rubyProperties->setAlignment($styles['rubyAlignment']); } if (isset($styles['size']) && $styles['size'] !== '') { $rubyProperties->setFontSizeForBaseText($styles['size']); } $baseTextRun->setParagraphStyle($styles); } } foreach ($node->childNodes as $child) { if ($child->nodeName === '#text') { $content = trim($child->textContent); if ($content !== '') { $baseTextRun->addText($content); } } elseif ($child->nodeName === 'rt') { $rubyTextRun->addText(trim($child->textContent)); if ($child->hasAttributes()) { $styleAttr = $child->attributes->getNamedItem('style'); if ($styleAttr !== null) { $styles = self::parseStyle($styleAttr, []); if (isset($styles['size']) && $styles['size'] !== '') { $rubyProperties->setFontFaceSize($styles['size']); } $rubyTextRun->setParagraphStyle($styles); } } } } return $element->addRuby($baseTextRun, $rubyTextRun, $rubyProperties); } private static function convertRgb(string $rgb): string { if (preg_match(self::RGB_REGEXP, $rgb, $matches) === 1) { return sprintf('%02X%02X%02X', $matches[1], $matches[2], $matches[3]); } return trim($rgb, '# '); } /** * Transform HTML sizes (pt, px) in pixels. */ protected static function convertHtmlSize(string $size): float { // pt if (false !== strpos($size, 'pt')) { return Converter::pointToPixel((float) str_replace('pt', '', $size)); } // px if (false !== strpos($size, 'px')) { return (float) str_replace('px', '', $size); } return (float) $size; } } ================================================ FILE: src/PhpWord/Shared/Microsoft/PasswordEncoder.php ================================================ 4) ? 0xFFFFFFFF : -1; private const HIGH_ORDER_BIT = (PHP_INT_SIZE > 4) ? 0x80000000 : PHP_INT_MIN; /** * Mapping between algorithm name and algorithm ID. * * @var array * * @see https://msdn.microsoft.com/en-us/library/documentformat.openxml.wordprocessing.writeprotection.cryptographicalgorithmsid(v=office.14).aspx */ private static $algorithmMapping = [ self::ALGORITHM_MD2 => [1, 'md2'], self::ALGORITHM_MD4 => [2, 'md4'], self::ALGORITHM_MD5 => [3, 'md5'], self::ALGORITHM_SHA_1 => [4, 'sha1'], self::ALGORITHM_MAC => [5, ''], // 'mac' -> not possible with hash() self::ALGORITHM_RIPEMD => [6, 'ripemd'], self::ALGORITHM_RIPEMD_160 => [7, 'ripemd160'], self::ALGORITHM_HMAC => [9, ''], //'hmac' -> not possible with hash() self::ALGORITHM_SHA_256 => [12, 'sha256'], self::ALGORITHM_SHA_384 => [13, 'sha384'], self::ALGORITHM_SHA_512 => [14, 'sha512'], ]; private static $initialCodeArray = [ 0xE1F0, 0x1D0F, 0xCC9C, 0x84C0, 0x110C, 0x0E10, 0xF1CE, 0x313E, 0x1872, 0xE139, 0xD40F, 0x84F9, 0x280C, 0xA96A, 0x4EC3, ]; private static $encryptionMatrix = [ [0xAEFC, 0x4DD9, 0x9BB2, 0x2745, 0x4E8A, 0x9D14, 0x2A09], [0x7B61, 0xF6C2, 0xFDA5, 0xEB6B, 0xC6F7, 0x9DCF, 0x2BBF], [0x4563, 0x8AC6, 0x05AD, 0x0B5A, 0x16B4, 0x2D68, 0x5AD0], [0x0375, 0x06EA, 0x0DD4, 0x1BA8, 0x3750, 0x6EA0, 0xDD40], [0xD849, 0xA0B3, 0x5147, 0xA28E, 0x553D, 0xAA7A, 0x44D5], [0x6F45, 0xDE8A, 0xAD35, 0x4A4B, 0x9496, 0x390D, 0x721A], [0xEB23, 0xC667, 0x9CEF, 0x29FF, 0x53FE, 0xA7FC, 0x5FD9], [0x47D3, 0x8FA6, 0x0F6D, 0x1EDA, 0x3DB4, 0x7B68, 0xF6D0], [0xB861, 0x60E3, 0xC1C6, 0x93AD, 0x377B, 0x6EF6, 0xDDEC], [0x45A0, 0x8B40, 0x06A1, 0x0D42, 0x1A84, 0x3508, 0x6A10], [0xAA51, 0x4483, 0x8906, 0x022D, 0x045A, 0x08B4, 0x1168], [0x76B4, 0xED68, 0xCAF1, 0x85C3, 0x1BA7, 0x374E, 0x6E9C], [0x3730, 0x6E60, 0xDCC0, 0xA9A1, 0x4363, 0x86C6, 0x1DAD], [0x3331, 0x6662, 0xCCC4, 0x89A9, 0x0373, 0x06E6, 0x0DCC], [0x1021, 0x2042, 0x4084, 0x8108, 0x1231, 0x2462, 0x48C4], ]; private static $passwordMaxLength = 15; /** * Create a hashed password that MS Word will be able to work with. * * @see https://blogs.msdn.microsoft.com/vsod/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0/ * * @param string $password * @param string $algorithmName * @param string $salt * @param int $spinCount * * @return string */ public static function hashPassword($password, $algorithmName = self::ALGORITHM_SHA_1, $salt = null, $spinCount = 10000) { $origEncoding = mb_internal_encoding(); mb_internal_encoding('UTF-8'); $password = mb_substr($password, 0, min(self::$passwordMaxLength, mb_strlen($password))); // Get the single-byte values by iterating through the Unicode characters of the truncated password. // For each character, if the low byte is not equal to 0, take it. Otherwise, take the high byte. $passUtf8 = mb_convert_encoding($password, 'UCS-2LE', 'UTF-8'); if (!is_string($passUtf8)) { throw new Exception('Failed to convert password to UCS-2LE'); } $byteChars = []; for ($i = 0; $i < mb_strlen($password); ++$i) { $byteChars[$i] = ord(substr($passUtf8, $i * 2, 1)); if ($byteChars[$i] == 0) { $byteChars[$i] = ord(substr($passUtf8, $i * 2 + 1, 1)); } } // build low-order word and hig-order word and combine them $combinedKey = self::buildCombinedKey($byteChars); // build reversed hexadecimal string $hex = str_pad(strtoupper(dechex($combinedKey & self::ALL_ONE_BITS)), 8, '0', \STR_PAD_LEFT); $reversedHex = $hex[6] . $hex[7] . $hex[4] . $hex[5] . $hex[2] . $hex[3] . $hex[0] . $hex[1]; $generatedKey = mb_convert_encoding($reversedHex, 'UCS-2LE', 'UTF-8'); // Implementation Notes List: // Word requires that the initial hash of the password with the salt not be considered in the count. // The initial hash of salt + key is not included in the iteration count. $algorithm = self::getAlgorithm($algorithmName); $generatedKey = hash($algorithm, $salt . $generatedKey, true); for ($i = 0; $i < $spinCount; ++$i) { $generatedKey = hash($algorithm, $generatedKey . pack('CCCC', $i, $i >> 8, $i >> 16, $i >> 24), true); } $generatedKey = base64_encode($generatedKey); mb_internal_encoding($origEncoding); return $generatedKey; } /** * Get algorithm from self::$algorithmMapping. * * @param string $algorithmName * * @return string */ private static function getAlgorithm($algorithmName) { $algorithm = self::$algorithmMapping[$algorithmName][1]; if ($algorithm == '') { $algorithm = 'sha1'; } return $algorithm; } /** * Returns the algorithm ID. * * @param string $algorithmName * * @return int */ public static function getAlgorithmId($algorithmName) { return self::$algorithmMapping[$algorithmName][0]; } /** * Build combined key from low-order word and high-order word. * * @param array $byteChars byte array representation of password * * @return int */ private static function buildCombinedKey($byteChars) { $byteCharsLength = count($byteChars); // Compute the high-order word // Initialize from the initial code array (see above), depending on the passwords length. $highOrderWord = self::$initialCodeArray[$byteCharsLength - 1]; // For each character in the password: // For every bit in the character, starting with the least significant and progressing to (but excluding) // the most significant, if the bit is set, XOR the key’s high-order word with the corresponding word from // the Encryption Matrix for ($i = 0; $i < $byteCharsLength; ++$i) { $tmp = self::$passwordMaxLength - $byteCharsLength + $i; $matrixRow = self::$encryptionMatrix[$tmp]; for ($intBit = 0; $intBit < 7; ++$intBit) { if (($byteChars[$i] & (0x0001 << $intBit)) != 0) { $highOrderWord = ($highOrderWord ^ $matrixRow[$intBit]); } } } // Compute low-order word // Initialize with 0 $lowOrderWord = 0; // For each character in the password, going backwards for ($i = $byteCharsLength - 1; $i >= 0; --$i) { // low-order word = (((low-order word SHR 14) AND 0x0001) OR (low-order word SHL 1) AND 0x7FFF)) XOR character $lowOrderWord = (((($lowOrderWord >> 14) & 0x0001) | (($lowOrderWord << 1) & 0x7FFF)) ^ $byteChars[$i]); } // Lastly, low-order word = (((low-order word SHR 14) AND 0x0001) OR (low-order word SHL 1) AND 0x7FFF)) XOR strPassword length XOR 0xCE4B. $lowOrderWord = (((($lowOrderWord >> 14) & 0x0001) | (($lowOrderWord << 1) & 0x7FFF)) ^ $byteCharsLength ^ 0xCE4B); // Combine the Low and High Order Word return self::int32(($highOrderWord << 16) + $lowOrderWord); } /** * Simulate behaviour of (signed) int32. * * @codeCoverageIgnore * * @param int $value * * @return int */ private static function int32($value) { $value = $value & self::ALL_ONE_BITS; if ($value & self::HIGH_ORDER_BIT) { $value = -((~$value & self::ALL_ONE_BITS) + 1); } return $value; } } ================================================ FILE: src/PhpWord/Shared/OLERead.php ================================================ data = file_get_contents($sFileName, false, null, 0, 8); // Check OLE identifier if ($this->data != self::IDENTIFIER_OLE) { throw new Exception('The filename ' . $sFileName . ' is not recognised as an OLE file'); } // Get the file data $this->data = file_get_contents($sFileName); // Total number of sectors used for the SAT $this->numBigBlockDepotBlocks = self::getInt4d($this->data, self::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS); // SecID of the first sector of the directory stream $this->rootStartBlock = self::getInt4d($this->data, self::ROOT_START_BLOCK_POS); // SecID of the first sector of the SSAT (or -2 if not extant) $this->sbdStartBlock = self::getInt4d($this->data, self::SMALL_BLOCK_DEPOT_BLOCK_POS); // SecID of the first sector of the MSAT (or -2 if no additional sectors are used) $this->extensionBlock = self::getInt4d($this->data, self::EXTENSION_BLOCK_POS); // Total number of sectors used by MSAT $this->numExtensionBlocks = self::getInt4d($this->data, self::NUM_EXTENSION_BLOCK_POS); $bigBlockDepotBlocks = array(); $pos = self::BIG_BLOCK_DEPOT_BLOCKS_POS; $bbdBlocks = $this->numBigBlockDepotBlocks; // @codeCoverageIgnoreStart if ($this->numExtensionBlocks != 0) { $bbdBlocks = (self::BIG_BLOCK_SIZE - self::BIG_BLOCK_DEPOT_BLOCKS_POS) / 4; } // @codeCoverageIgnoreEnd for ($i = 0; $i < $bbdBlocks; ++$i) { $bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos); $pos += 4; } // @codeCoverageIgnoreStart for ($j = 0; $j < $this->numExtensionBlocks; ++$j) { $pos = ($this->extensionBlock + 1) * self::BIG_BLOCK_SIZE; $blocksToRead = min($this->numBigBlockDepotBlocks - $bbdBlocks, self::BIG_BLOCK_SIZE / 4 - 1); for ($i = $bbdBlocks; $i < $bbdBlocks + $blocksToRead; ++$i) { $bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos); $pos += 4; } $bbdBlocks += $blocksToRead; if ($bbdBlocks < $this->numBigBlockDepotBlocks) { $this->extensionBlock = self::getInt4d($this->data, $pos); } } // @codeCoverageIgnoreEnd $pos = 0; $this->bigBlockChain = ''; $bbs = self::BIG_BLOCK_SIZE / 4; for ($i = 0; $i < $this->numBigBlockDepotBlocks; ++$i) { $pos = ($bigBlockDepotBlocks[$i] + 1) * self::BIG_BLOCK_SIZE; $this->bigBlockChain .= substr($this->data, $pos, 4 * $bbs); $pos += 4 * $bbs; } $pos = 0; $sbdBlock = $this->sbdStartBlock; $this->smallBlockChain = ''; while ($sbdBlock != -2) { $pos = ($sbdBlock + 1) * self::BIG_BLOCK_SIZE; $this->smallBlockChain .= substr($this->data, $pos, 4 * $bbs); $pos += 4 * $bbs; $sbdBlock = self::getInt4d($this->bigBlockChain, $sbdBlock * 4); } // read the directory stream $block = $this->rootStartBlock; $this->entry = $this->readData($block); $this->readPropertySets(); } /** * Extract binary stream data * * @param mixed $stream * @return string */ public function getStream($stream) { if ($stream === null) { return null; } $streamData = ''; if ($this->props[$stream]['size'] < self::SMALL_BLOCK_THRESHOLD) { $rootdata = $this->readData($this->props[$this->rootentry]['startBlock']); $block = $this->props[$stream]['startBlock']; while ($block != -2) { $pos = $block * self::SMALL_BLOCK_SIZE; $streamData .= substr($rootdata, $pos, self::SMALL_BLOCK_SIZE); $block = self::getInt4d($this->smallBlockChain, $block * 4); } return $streamData; } $numBlocks = $this->props[$stream]['size'] / self::BIG_BLOCK_SIZE; if ($this->props[$stream]['size'] % self::BIG_BLOCK_SIZE != 0) { ++$numBlocks; } if ($numBlocks == 0) { return ''; // @codeCoverageIgnore } $block = $this->props[$stream]['startBlock']; while ($block != -2) { $pos = ($block + 1) * self::BIG_BLOCK_SIZE; $streamData .= substr($this->data, $pos, self::BIG_BLOCK_SIZE); $block = self::getInt4d($this->bigBlockChain, $block * 4); } return $streamData; } /** * Read a standard stream (by joining sectors using information from SAT) * * @param int $blSectorId Sector ID where the stream starts * @return string Data for standard stream */ private function readData($blSectorId) { $block = $blSectorId; $data = ''; while ($block != -2) { $pos = ($block + 1) * self::BIG_BLOCK_SIZE; $data .= substr($this->data, $pos, self::BIG_BLOCK_SIZE); $block = self::getInt4d($this->bigBlockChain, $block * 4); } return $data; } /** * Read entries in the directory stream. */ private function readPropertySets() { $offset = 0; // loop through entires, each entry is 128 bytes $entryLen = strlen($this->entry); while ($offset < $entryLen) { // entry data (128 bytes) $data = substr($this->entry, $offset, self::PROPERTY_STORAGE_BLOCK_SIZE); // size in bytes of name $nameSize = ord($data[self::SIZE_OF_NAME_POS]) | (ord($data[self::SIZE_OF_NAME_POS + 1]) << 8); // type of entry $type = ord($data[self::TYPE_POS]); // sectorID of first sector or short sector, if this entry refers to a stream (the case with workbook) // sectorID of first sector of the short-stream container stream, if this entry is root entry $startBlock = self::getInt4d($data, self::START_BLOCK_POS); $size = self::getInt4d($data, self::SIZE_POS); $name = str_replace("\x00", '', substr($data, 0, $nameSize)); $this->props[] = array( 'name' => $name, 'type' => $type, 'startBlock' => $startBlock, 'size' => $size, ); // tmp helper to simplify checks $upName = strtoupper($name); // Workbook directory entry (BIFF5 uses Book, BIFF8 uses Workbook) // print_r($upName.PHP_EOL); if (($upName === 'WORDDOCUMENT')) { $this->wrkdocument = count($this->props) - 1; } elseif ($upName === '1TABLE') { $this->wrk1Table = count($this->props) - 1; } elseif ($upName === 'DATA') { $this->wrkData = count($this->props) - 1; } elseif ($upName === 'OBJECTPOOL') { $this->wrkObjectPoolelseif = count($this->props) - 1; } elseif ($upName === 'ROOT ENTRY' || $upName === 'R') { $this->rootentry = count($this->props) - 1; } // Summary information if ($name == chr(5) . 'SummaryInformation') { $this->summaryInformation = count($this->props) - 1; } // Additional Document Summary information if ($name == chr(5) . 'DocumentSummaryInformation') { $this->docSummaryInfos = count($this->props) - 1; } $offset += self::PROPERTY_STORAGE_BLOCK_SIZE; } } /** * Read 4 bytes of data at specified position * * @param string $data * @param int $pos * @return int */ private static function getInt4d($data, $pos) { // FIX: represent numbers correctly on 64-bit system // http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334 // Hacked by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems $or24 = ord($data[$pos + 3]); if ($or24 >= 128) { // negative number $ord24 = -abs((256 - $or24) << 24); } else { $ord24 = ($or24 & 127) << 24; } return ord($data[$pos]) | (ord($data[$pos + 1]) << 8) | (ord($data[$pos + 2]) << 16) | $ord24; } } ================================================ FILE: src/PhpWord/Shared/PCLZip/pclzip.lib.php ================================================ zipname = $p_zipname; $this->zip_fd = 0; $this->magic_quotes_status = -1; // ----- Return return; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : // create($p_filelist, $p_add_dir="", $p_remove_dir="") // create($p_filelist, $p_option, $p_option_value, ...) // Description : // This method supports two different synopsis. The first one is historical. // This method creates a Zip Archive. The Zip file is created in the // filesystem. The files and directories indicated in $p_filelist // are added in the archive. See the parameters description for the // supported format of $p_filelist. // When a directory is in the list, the directory and its content is added // in the archive. // In this synopsis, the function takes an optional variable list of // options. See bellow the supported options. // Parameters : // $p_filelist : An array containing file or directory names, or // a string containing one filename or one directory name, or // a string containing a list of filenames and/or directory // names separated by spaces. // $p_add_dir : A path to add before the real path of the archived file, // in order to have it memorized in the archive. // $p_remove_dir : A path to remove from the real path of the file to archive, // in order to have a shorter path memorized in the archive. // When $p_add_dir and $p_remove_dir are set, $p_remove_dir // is removed first, before $p_add_dir is added. // Options : // PCLZIP_OPT_ADD_PATH : // PCLZIP_OPT_REMOVE_PATH : // PCLZIP_OPT_REMOVE_ALL_PATH : // PCLZIP_OPT_COMMENT : // PCLZIP_CB_PRE_ADD : // PCLZIP_CB_POST_ADD : // Return Values : // 0 on failure, // The list of the added files, with a status of the add action. // (see PclZip::listContent() for list entry format) // -------------------------------------------------------------------------------- public function create($p_filelist) { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Set default values $v_options = array(); $v_options[PCLZIP_OPT_NO_COMPRESSION] = false; // ----- Look for variable options arguments $v_size = func_num_args(); // ----- Look for arguments if ($v_size > 1) { // ----- Get the arguments $v_arg_list = func_get_args(); // ----- Remove from the options list the first argument array_shift($v_arg_list); $v_size--; // ----- Look for first arg if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) { // ----- Parse the options $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options, array( PCLZIP_OPT_REMOVE_PATH => 'optional', PCLZIP_OPT_REMOVE_ALL_PATH => 'optional', PCLZIP_OPT_ADD_PATH => 'optional', PCLZIP_CB_PRE_ADD => 'optional', PCLZIP_CB_POST_ADD => 'optional', PCLZIP_OPT_NO_COMPRESSION => 'optional', PCLZIP_OPT_COMMENT => 'optional', PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional', PCLZIP_OPT_TEMP_FILE_ON => 'optional', PCLZIP_OPT_TEMP_FILE_OFF => 'optional' //, PCLZIP_OPT_CRYPT => 'optional' )); if ($v_result != 1) { return 0; } // ----- Look for 2 args // Here we need to support the first historic synopsis of the // method. } else { // ----- Get the first argument $v_options[PCLZIP_OPT_ADD_PATH] = $v_arg_list[0]; // ----- Look for the optional second argument if ($v_size == 2) { $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1]; } elseif ($v_size > 2) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments"); return 0; } } } // ----- Look for default option values $this->privOptionDefaultThreshold($v_options); // ----- Init $v_string_list = array(); $v_att_list = array(); $v_filedescr_list = array(); $p_result_list = array(); // ----- Look if the $p_filelist is really an array if (is_array($p_filelist)) { // ----- Look if the first element is also an array // This will mean that this is a file description entry if (isset($p_filelist[0]) && is_array($p_filelist[0])) { $v_att_list = $p_filelist; // ----- The list is a list of string names } else { $v_string_list = $p_filelist; } // ----- Look if the $p_filelist is a string } elseif (is_string($p_filelist)) { // ----- Create a list from the string $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist); // ----- Invalid variable type for $p_filelist } else { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_filelist"); return 0; } // ----- Reformat the string list if (sizeof($v_string_list) != 0) { foreach ($v_string_list as $v_string) { if ($v_string != '') { $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string; } else { } } } // ----- For each file in the list check the attributes $v_supported_attributes = array( PCLZIP_ATT_FILE_NAME => 'mandatory', PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional', PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional', PCLZIP_ATT_FILE_MTIME => 'optional', PCLZIP_ATT_FILE_CONTENT => 'optional', PCLZIP_ATT_FILE_COMMENT => 'optional' ); foreach ($v_att_list as $v_entry) { $v_result = $this->privFileDescrParseAtt($v_entry, $v_filedescr_list[], $v_options, $v_supported_attributes); if ($v_result != 1) { return 0; } } // ----- Expand the filelist (expand directories) $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options); if ($v_result != 1) { return 0; } // ----- Call the create fct $v_result = $this->privCreate($v_filedescr_list, $p_result_list, $v_options); if ($v_result != 1) { return 0; } // ----- Return return $p_result_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : // add($p_filelist, $p_add_dir="", $p_remove_dir="") // add($p_filelist, $p_option, $p_option_value, ...) // Description : // This method supports two synopsis. The first one is historical. // This methods add the list of files in an existing archive. // If a file with the same name already exists, it is added at the end of the // archive, the first one is still present. // If the archive does not exist, it is created. // Parameters : // $p_filelist : An array containing file or directory names, or // a string containing one filename or one directory name, or // a string containing a list of filenames and/or directory // names separated by spaces. // $p_add_dir : A path to add before the real path of the archived file, // in order to have it memorized in the archive. // $p_remove_dir : A path to remove from the real path of the file to archive, // in order to have a shorter path memorized in the archive. // When $p_add_dir and $p_remove_dir are set, $p_remove_dir // is removed first, before $p_add_dir is added. // Options : // PCLZIP_OPT_ADD_PATH : // PCLZIP_OPT_REMOVE_PATH : // PCLZIP_OPT_REMOVE_ALL_PATH : // PCLZIP_OPT_COMMENT : // PCLZIP_OPT_ADD_COMMENT : // PCLZIP_OPT_PREPEND_COMMENT : // PCLZIP_CB_PRE_ADD : // PCLZIP_CB_POST_ADD : // Return Values : // 0 on failure, // The list of the added files, with a status of the add action. // (see PclZip::listContent() for list entry format) // -------------------------------------------------------------------------------- public function add($p_filelist) { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Set default values $v_options = array(); $v_options[PCLZIP_OPT_NO_COMPRESSION] = false; // ----- Look for variable options arguments $v_size = func_num_args(); // ----- Look for arguments if ($v_size > 1) { // ----- Get the arguments $v_arg_list = func_get_args(); // ----- Remove form the options list the first argument array_shift($v_arg_list); $v_size--; // ----- Look for first arg if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) { // ----- Parse the options $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options, array( PCLZIP_OPT_REMOVE_PATH => 'optional', PCLZIP_OPT_REMOVE_ALL_PATH => 'optional', PCLZIP_OPT_ADD_PATH => 'optional', PCLZIP_CB_PRE_ADD => 'optional', PCLZIP_CB_POST_ADD => 'optional', PCLZIP_OPT_NO_COMPRESSION => 'optional', PCLZIP_OPT_COMMENT => 'optional', PCLZIP_OPT_ADD_COMMENT => 'optional', PCLZIP_OPT_PREPEND_COMMENT => 'optional', PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional', PCLZIP_OPT_TEMP_FILE_ON => 'optional', PCLZIP_OPT_TEMP_FILE_OFF => 'optional' //, PCLZIP_OPT_CRYPT => 'optional' )); if ($v_result != 1) { return 0; } // ----- Look for 2 args // Here we need to support the first historic synopsis of the // method. } else { // ----- Get the first argument $v_options[PCLZIP_OPT_ADD_PATH] = $v_add_path = $v_arg_list[0]; // ----- Look for the optional second argument if ($v_size == 2) { $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1]; } elseif ($v_size > 2) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments"); // ----- Return return 0; } } } // ----- Look for default option values $this->privOptionDefaultThreshold($v_options); // ----- Init $v_string_list = array(); $v_att_list = array(); $v_filedescr_list = array(); $p_result_list = array(); // ----- Look if the $p_filelist is really an array if (is_array($p_filelist)) { // ----- Look if the first element is also an array // This will mean that this is a file description entry if (isset($p_filelist[0]) && is_array($p_filelist[0])) { $v_att_list = $p_filelist; // ----- The list is a list of string names } else { $v_string_list = $p_filelist; } // ----- Look if the $p_filelist is a string } elseif (is_string($p_filelist)) { // ----- Create a list from the string $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist); // ----- Invalid variable type for $p_filelist } else { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type '" . gettype($p_filelist) . "' for p_filelist"); return 0; } // ----- Reformat the string list if (sizeof($v_string_list) != 0) { foreach ($v_string_list as $v_string) { $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string; } } // ----- For each file in the list check the attributes $v_supported_attributes = array( PCLZIP_ATT_FILE_NAME => 'mandatory', PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional', PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional', PCLZIP_ATT_FILE_MTIME => 'optional', PCLZIP_ATT_FILE_CONTENT => 'optional', PCLZIP_ATT_FILE_COMMENT => 'optional' ); foreach ($v_att_list as $v_entry) { $v_result = $this->privFileDescrParseAtt($v_entry, $v_filedescr_list[], $v_options, $v_supported_attributes); if ($v_result != 1) { return 0; } } // ----- Expand the filelist (expand directories) $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options); if ($v_result != 1) { return 0; } // ----- Call the create fct $v_result = $this->privAdd($v_filedescr_list, $p_result_list, $v_options); if ($v_result != 1) { return 0; } // ----- Return return $p_result_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : listContent() // Description : // This public method, gives the list of the files and directories, with their // properties. // The properties of each entries in the list are (used also in other functions) : // filename : Name of the file. For a create or add action it is the filename // given by the user. For an extract function it is the filename // of the extracted file. // stored_filename : Name of the file / directory stored in the archive. // size : Size of the stored file. // compressed_size : Size of the file's data compressed in the archive // (without the headers overhead) // mtime : Last known modification date of the file (UNIX timestamp) // comment : Comment associated with the file // folder : true | false // index : index of the file in the archive // status : status of the action (depending of the action) : // Values are : // ok : OK ! // filtered : the file / dir is not extracted (filtered by user) // already_a_directory : the file can not be extracted because a // directory with the same name already exists // write_protected : the file can not be extracted because a file // with the same name already exists and is // write protected // newer_exist : the file was not extracted because a newer file exists // path_creation_fail : the file is not extracted because the folder // does not exist and can not be created // write_error : the file was not extracted because there was a // error while writing the file // read_error : the file was not extracted because there was a error // while reading the file // invalid_header : the file was not extracted because of an archive // format error (bad file header) // Note that each time a method can continue operating when there // is an action error on a file, the error is only logged in the file status. // Return Values : // 0 on an unrecoverable failure, // The list of the files in the archive. // -------------------------------------------------------------------------------- public function listContent() { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Check archive if (!$this->privCheckFormat()) { return (0); } // ----- Call the extracting fct $p_list = array(); if (($v_result = $this->privList($p_list)) != 1) { unset($p_list); return (0); } // ----- Return return $p_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : // extract($p_path="./", $p_remove_path="") // extract([$p_option, $p_option_value, ...]) // Description : // This method supports two synopsis. The first one is historical. // This method extract all the files / directories from the archive to the // folder indicated in $p_path. // If you want to ignore the 'root' part of path of the memorized files // you can indicate this in the optional $p_remove_path parameter. // By default, if a newer file with the same name already exists, the // file is not extracted. // // If both PCLZIP_OPT_PATH and PCLZIP_OPT_ADD_PATH aoptions // are used, the path indicated in PCLZIP_OPT_ADD_PATH is append // at the end of the path value of PCLZIP_OPT_PATH. // Parameters : // $p_path : Path where the files and directories are to be extracted // $p_remove_path : First part ('root' part) of the memorized path // (if any similar) to remove while extracting. // Options : // PCLZIP_OPT_PATH : // PCLZIP_OPT_ADD_PATH : // PCLZIP_OPT_REMOVE_PATH : // PCLZIP_OPT_REMOVE_ALL_PATH : // PCLZIP_CB_PRE_EXTRACT : // PCLZIP_CB_POST_EXTRACT : // Return Values : // 0 or a negative value on failure, // The list of the extracted files, with a status of the action. // (see PclZip::listContent() for list entry format) // -------------------------------------------------------------------------------- public function extract() { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Check archive if (!$this->privCheckFormat()) { return (0); } // ----- Set default values $v_options = array(); // $v_path = "./"; $v_path = ''; $v_remove_path = ""; $v_remove_all_path = false; // ----- Look for variable options arguments $v_size = func_num_args(); // ----- Default values for option $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = false; // ----- Look for arguments if ($v_size > 0) { // ----- Get the arguments $v_arg_list = func_get_args(); // ----- Look for first arg if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) { // ----- Parse the options $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options, array( PCLZIP_OPT_PATH => 'optional', PCLZIP_OPT_REMOVE_PATH => 'optional', PCLZIP_OPT_REMOVE_ALL_PATH => 'optional', PCLZIP_OPT_ADD_PATH => 'optional', PCLZIP_CB_PRE_EXTRACT => 'optional', PCLZIP_CB_POST_EXTRACT => 'optional', PCLZIP_OPT_SET_CHMOD => 'optional', PCLZIP_OPT_BY_NAME => 'optional', PCLZIP_OPT_BY_EREG => 'optional', PCLZIP_OPT_BY_PREG => 'optional', PCLZIP_OPT_BY_INDEX => 'optional', PCLZIP_OPT_EXTRACT_AS_STRING => 'optional', PCLZIP_OPT_EXTRACT_IN_OUTPUT => 'optional', PCLZIP_OPT_REPLACE_NEWER => 'optional', PCLZIP_OPT_STOP_ON_ERROR => 'optional', PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional', PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional', PCLZIP_OPT_TEMP_FILE_ON => 'optional', PCLZIP_OPT_TEMP_FILE_OFF => 'optional' )); if ($v_result != 1) { return 0; } // ----- Set the arguments if (isset($v_options[PCLZIP_OPT_PATH])) { $v_path = $v_options[PCLZIP_OPT_PATH]; } if (isset($v_options[PCLZIP_OPT_REMOVE_PATH])) { $v_remove_path = $v_options[PCLZIP_OPT_REMOVE_PATH]; } if (isset($v_options[PCLZIP_OPT_REMOVE_ALL_PATH])) { $v_remove_all_path = $v_options[PCLZIP_OPT_REMOVE_ALL_PATH]; } if (isset($v_options[PCLZIP_OPT_ADD_PATH])) { // ----- Check for '/' in last path char if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) { $v_path .= '/'; } $v_path .= $v_options[PCLZIP_OPT_ADD_PATH]; } // ----- Look for 2 args // Here we need to support the first historic synopsis of the // method. } else { // ----- Get the first argument $v_path = $v_arg_list[0]; // ----- Look for the optional second argument if ($v_size == 2) { $v_remove_path = $v_arg_list[1]; } elseif ($v_size > 2) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments"); // ----- Return return 0; } } } // ----- Look for default option values $this->privOptionDefaultThreshold($v_options); // ----- Trace // ----- Call the extracting fct $p_list = array(); $v_result = $this->privExtractByRule($p_list, $v_path, $v_remove_path, $v_remove_all_path, $v_options); if ($v_result < 1) { unset($p_list); return (0); } // ----- Return return $p_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : // extractByIndex($p_index, $p_path="./", $p_remove_path="") // extractByIndex($p_index, [$p_option, $p_option_value, ...]) // Description : // This method supports two synopsis. The first one is historical. // This method is doing a partial extract of the archive. // The extracted files or folders are identified by their index in the // archive (from 0 to n). // Note that if the index identify a folder, only the folder entry is // extracted, not all the files included in the archive. // Parameters : // $p_index : A single index (integer) or a string of indexes of files to // extract. The form of the string is "0,4-6,8-12" with only numbers // and '-' for range or ',' to separate ranges. No spaces or ';' // are allowed. // $p_path : Path where the files and directories are to be extracted // $p_remove_path : First part ('root' part) of the memorized path // (if any similar) to remove while extracting. // Options : // PCLZIP_OPT_PATH : // PCLZIP_OPT_ADD_PATH : // PCLZIP_OPT_REMOVE_PATH : // PCLZIP_OPT_REMOVE_ALL_PATH : // PCLZIP_OPT_EXTRACT_AS_STRING : The files are extracted as strings and // not as files. // The resulting content is in a new field 'content' in the file // structure. // This option must be used alone (any other options are ignored). // PCLZIP_CB_PRE_EXTRACT : // PCLZIP_CB_POST_EXTRACT : // Return Values : // 0 on failure, // The list of the extracted files, with a status of the action. // (see PclZip::listContent() for list entry format) // -------------------------------------------------------------------------------- //function extractByIndex($p_index, options...) public function extractByIndex($p_index) { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Check archive if (!$this->privCheckFormat()) { return (0); } // ----- Set default values $v_options = array(); // $v_path = "./"; $v_path = ''; $v_remove_path = ""; $v_remove_all_path = false; // ----- Look for variable options arguments $v_size = func_num_args(); // ----- Default values for option $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = false; // ----- Look for arguments if ($v_size > 1) { // ----- Get the arguments $v_arg_list = func_get_args(); // ----- Remove form the options list the first argument array_shift($v_arg_list); $v_size--; // ----- Look for first arg if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) { // ----- Parse the options $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options, array( PCLZIP_OPT_PATH => 'optional', PCLZIP_OPT_REMOVE_PATH => 'optional', PCLZIP_OPT_REMOVE_ALL_PATH => 'optional', PCLZIP_OPT_EXTRACT_AS_STRING => 'optional', PCLZIP_OPT_ADD_PATH => 'optional', PCLZIP_CB_PRE_EXTRACT => 'optional', PCLZIP_CB_POST_EXTRACT => 'optional', PCLZIP_OPT_SET_CHMOD => 'optional', PCLZIP_OPT_REPLACE_NEWER => 'optional', PCLZIP_OPT_STOP_ON_ERROR => 'optional', PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional', PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional', PCLZIP_OPT_TEMP_FILE_ON => 'optional', PCLZIP_OPT_TEMP_FILE_OFF => 'optional' )); if ($v_result != 1) { return 0; } // ----- Set the arguments if (isset($v_options[PCLZIP_OPT_PATH])) { $v_path = $v_options[PCLZIP_OPT_PATH]; } if (isset($v_options[PCLZIP_OPT_REMOVE_PATH])) { $v_remove_path = $v_options[PCLZIP_OPT_REMOVE_PATH]; } if (isset($v_options[PCLZIP_OPT_REMOVE_ALL_PATH])) { $v_remove_all_path = $v_options[PCLZIP_OPT_REMOVE_ALL_PATH]; } if (isset($v_options[PCLZIP_OPT_ADD_PATH])) { // ----- Check for '/' in last path char if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) { $v_path .= '/'; } $v_path .= $v_options[PCLZIP_OPT_ADD_PATH]; } if (!isset($v_options[PCLZIP_OPT_EXTRACT_AS_STRING])) { $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = false; } else { } // ----- Look for 2 args // Here we need to support the first historic synopsis of the // method. } else { // ----- Get the first argument $v_path = $v_arg_list[0]; // ----- Look for the optional second argument if ($v_size == 2) { $v_remove_path = $v_arg_list[1]; } elseif ($v_size > 2) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments"); // ----- Return return 0; } } } // ----- Trace // ----- Trick // Here I want to reuse extractByRule(), so I need to parse the $p_index // with privParseOptions() $v_arg_trick = array( PCLZIP_OPT_BY_INDEX, $p_index ); $v_options_trick = array(); $v_result = $this->privParseOptions($v_arg_trick, sizeof($v_arg_trick), $v_options_trick, array( PCLZIP_OPT_BY_INDEX => 'optional' )); if ($v_result != 1) { return 0; } $v_options[PCLZIP_OPT_BY_INDEX] = $v_options_trick[PCLZIP_OPT_BY_INDEX]; // ----- Look for default option values $this->privOptionDefaultThreshold($v_options); // ----- Call the extracting fct if (($v_result = $this->privExtractByRule($p_list, $v_path, $v_remove_path, $v_remove_all_path, $v_options)) < 1) { return (0); } // ----- Return return $p_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : // delete([$p_option, $p_option_value, ...]) // Description : // This method removes files from the archive. // If no parameters are given, then all the archive is emptied. // Parameters : // None or optional arguments. // Options : // PCLZIP_OPT_BY_INDEX : // PCLZIP_OPT_BY_NAME : // PCLZIP_OPT_BY_EREG : // PCLZIP_OPT_BY_PREG : // Return Values : // 0 on failure, // The list of the files which are still present in the archive. // (see PclZip::listContent() for list entry format) // -------------------------------------------------------------------------------- public function delete() { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Check archive if (!$this->privCheckFormat()) { return (0); } // ----- Set default values $v_options = array(); // ----- Look for variable options arguments $v_size = func_num_args(); // ----- Look for arguments if ($v_size > 0) { // ----- Get the arguments $v_arg_list = func_get_args(); // ----- Parse the options $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options, array( PCLZIP_OPT_BY_NAME => 'optional', PCLZIP_OPT_BY_EREG => 'optional', PCLZIP_OPT_BY_PREG => 'optional', PCLZIP_OPT_BY_INDEX => 'optional' )); if ($v_result != 1) { return 0; } } // ----- Magic quotes trick $this->privDisableMagicQuotes(); // ----- Call the delete fct $v_list = array(); if (($v_result = $this->privDeleteByRule($v_list, $v_options)) != 1) { $this->privSwapBackMagicQuotes(); unset($v_list); return (0); } // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Return return $v_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : deleteByIndex() // Description : // ***** Deprecated ***** // delete(PCLZIP_OPT_BY_INDEX, $p_index) should be prefered. // -------------------------------------------------------------------------------- public function deleteByIndex($p_index) { $p_list = $this->delete(PCLZIP_OPT_BY_INDEX, $p_index); // ----- Return return $p_list; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : properties() // Description : // This method gives the properties of the archive. // The properties are : // nb : Number of files in the archive // comment : Comment associated with the archive file // status : not_exist, ok // Parameters : // None // Return Values : // 0 on failure, // An array with the archive properties. // -------------------------------------------------------------------------------- public function properties() { // ----- Reset the error handler $this->privErrorReset(); // ----- Magic quotes trick $this->privDisableMagicQuotes(); // ----- Check archive if (!$this->privCheckFormat()) { $this->privSwapBackMagicQuotes(); return (0); } // ----- Default properties $v_prop = array(); $v_prop['comment'] = ''; $v_prop['nb'] = 0; $v_prop['status'] = 'not_exist'; // ----- Look if file exists if (@is_file($this->zipname)) { // ----- Open the zip file if (($this->zip_fd = @fopen($this->zipname, 'rb')) == 0) { $this->privSwapBackMagicQuotes(); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \'' . $this->zipname . '\' in binary read mode'); // ----- Return return 0; } // ----- Read the central directory informations $v_central_dir = array(); if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1) { $this->privSwapBackMagicQuotes(); return 0; } // ----- Close the zip file $this->privCloseFd(); // ----- Set the user attributes $v_prop['comment'] = $v_central_dir['comment']; $v_prop['nb'] = $v_central_dir['entries']; $v_prop['status'] = 'ok'; } // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Return return $v_prop; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : duplicate() // Description : // This method creates an archive by copying the content of an other one. If // the archive already exist, it is replaced by the new one without any warning. // Parameters : // $p_archive : The filename of a valid archive, or // a valid PclZip object. // Return Values : // 1 on success. // 0 or a negative value on error (error code). // -------------------------------------------------------------------------------- public function duplicate($p_archive) { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Look if the $p_archive is a PclZip object if ((is_object($p_archive)) && (get_class($p_archive) == 'pclzip')) { // ----- Duplicate the archive $v_result = $this->privDuplicate($p_archive->zipname); // ----- Look if the $p_archive is a string (so a filename) } elseif (is_string($p_archive)) { // ----- Check that $p_archive is a valid zip file // TBC : Should also check the archive format if (!is_file($p_archive)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "No file with filename '" . $p_archive . "'"); $v_result = PCLZIP_ERR_MISSING_FILE; } else { // ----- Duplicate the archive $v_result = $this->privDuplicate($p_archive); } // ----- Invalid variable } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_archive_to_add"); $v_result = PCLZIP_ERR_INVALID_PARAMETER; } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : merge() // Description : // This method merge the $p_archive_to_add archive at the end of the current // one ($this). // If the archive ($this) does not exist, the merge becomes a duplicate. // If the $p_archive_to_add archive does not exist, the merge is a success. // Parameters : // $p_archive_to_add : It can be directly the filename of a valid zip archive, // or a PclZip object archive. // Return Values : // 1 on success, // 0 or negative values on error (see below). // -------------------------------------------------------------------------------- public function merge($p_archive_to_add) { $v_result = 1; // ----- Reset the error handler $this->privErrorReset(); // ----- Check archive if (!$this->privCheckFormat()) { return (0); } // ----- Look if the $p_archive_to_add is a PclZip object if ((is_object($p_archive_to_add)) && (get_class($p_archive_to_add) == 'pclzip')) { // ----- Merge the archive $v_result = $this->privMerge($p_archive_to_add); // ----- Look if the $p_archive_to_add is a string (so a filename) } elseif (is_string($p_archive_to_add)) { // ----- Create a temporary archive $v_object_archive = new PclZip($p_archive_to_add); // ----- Merge the archive $v_result = $this->privMerge($v_object_archive); // ----- Invalid variable } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_archive_to_add"); $v_result = PCLZIP_ERR_INVALID_PARAMETER; } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : errorCode() // Description : // Parameters : // -------------------------------------------------------------------------------- public function errorCode() { if (PCLZIP_ERROR_EXTERNAL == 1) { return (PclErrorCode()); } return ($this->error_code); } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : errorName() // Description : // Parameters : // -------------------------------------------------------------------------------- public function errorName($p_with_code = false) { $v_name = array( PCLZIP_ERR_NO_ERROR => 'PCLZIP_ERR_NO_ERROR', PCLZIP_ERR_WRITE_OPEN_FAIL => 'PCLZIP_ERR_WRITE_OPEN_FAIL', PCLZIP_ERR_READ_OPEN_FAIL => 'PCLZIP_ERR_READ_OPEN_FAIL', PCLZIP_ERR_INVALID_PARAMETER => 'PCLZIP_ERR_INVALID_PARAMETER', PCLZIP_ERR_MISSING_FILE => 'PCLZIP_ERR_MISSING_FILE', PCLZIP_ERR_FILENAME_TOO_LONG => 'PCLZIP_ERR_FILENAME_TOO_LONG', PCLZIP_ERR_INVALID_ZIP => 'PCLZIP_ERR_INVALID_ZIP', PCLZIP_ERR_BAD_EXTRACTED_FILE => 'PCLZIP_ERR_BAD_EXTRACTED_FILE', PCLZIP_ERR_DIR_CREATE_FAIL => 'PCLZIP_ERR_DIR_CREATE_FAIL', PCLZIP_ERR_BAD_EXTENSION => 'PCLZIP_ERR_BAD_EXTENSION', PCLZIP_ERR_BAD_FORMAT => 'PCLZIP_ERR_BAD_FORMAT', PCLZIP_ERR_DELETE_FILE_FAIL => 'PCLZIP_ERR_DELETE_FILE_FAIL', PCLZIP_ERR_RENAME_FILE_FAIL => 'PCLZIP_ERR_RENAME_FILE_FAIL', PCLZIP_ERR_BAD_CHECKSUM => 'PCLZIP_ERR_BAD_CHECKSUM', PCLZIP_ERR_INVALID_ARCHIVE_ZIP => 'PCLZIP_ERR_INVALID_ARCHIVE_ZIP', PCLZIP_ERR_MISSING_OPTION_VALUE => 'PCLZIP_ERR_MISSING_OPTION_VALUE', PCLZIP_ERR_INVALID_OPTION_VALUE => 'PCLZIP_ERR_INVALID_OPTION_VALUE', PCLZIP_ERR_UNSUPPORTED_COMPRESSION => 'PCLZIP_ERR_UNSUPPORTED_COMPRESSION', PCLZIP_ERR_UNSUPPORTED_ENCRYPTION => 'PCLZIP_ERR_UNSUPPORTED_ENCRYPTION', PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE => 'PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE', PCLZIP_ERR_DIRECTORY_RESTRICTION => 'PCLZIP_ERR_DIRECTORY_RESTRICTION' ); if (isset($v_name[$this->error_code])) { $v_value = $v_name[$this->error_code]; } else { $v_value = 'NoName'; } if ($p_with_code) { return ($v_value . ' (' . $this->error_code . ')'); } return ($v_value); } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : errorInfo() // Description : // Parameters : // -------------------------------------------------------------------------------- public function errorInfo($p_full = false) { if (PCLZIP_ERROR_EXTERNAL == 1) { return (PclErrorString()); } if ($p_full) { return ($this->errorName(true) . " : " . $this->error_string); } return ($this->error_string . " [code " . $this->error_code . "]"); } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // ***** UNDER THIS LINE ARE DEFINED PRIVATE INTERNAL FUNCTIONS ***** // ***** ***** // ***** THESES FUNCTIONS MUST NOT BE USED DIRECTLY ***** // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privCheckFormat() // Description : // This method check that the archive exists and is a valid zip archive. // Several level of check exists. (futur) // Parameters : // $p_level : Level of check. Default 0. // 0 : Check the first bytes (magic codes) (default value)) // 1 : 0 + Check the central directory (futur) // 2 : 1 + Check each file header (futur) // Return Values : // true on success, // false on error, the error code is set. // -------------------------------------------------------------------------------- public function privCheckFormat($p_level = 0) { $v_result = true; // ----- Reset the file system cache clearstatcache(); // ----- Reset the error handler $this->privErrorReset(); // ----- Look if the file exits if (!is_file($this->zipname)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "Missing archive file '" . $this->zipname . "'"); return (false); } // ----- Check that the file is readeable if (!is_readable($this->zipname)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to read archive '" . $this->zipname . "'"); return (false); } // ----- Check the magic code // TBC // ----- Check the central header // TBC // ----- Check each file header // TBC // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privParseOptions() // Description : // This internal methods reads the variable list of arguments ($p_options_list, // $p_size) and generate an array with the options and values ($v_result_list). // $v_requested_options contains the options that can be present and those that // must be present. // $v_requested_options is an array, with the option value as key, and 'optional', // or 'mandatory' as value. // Parameters : // See above. // Return Values : // 1 on success. // 0 on failure. // -------------------------------------------------------------------------------- public function privParseOptions(&$p_options_list, $p_size, &$v_result_list, $v_requested_options = false) { $v_result = 1; // ----- Read the options $i = 0; while ($i < $p_size) { // ----- Check if the option is supported if (!isset($v_requested_options[$p_options_list[$i]])) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid optional parameter '" . $p_options_list[$i] . "' for this method"); // ----- Return return PclZip::errorCode(); } // ----- Look for next option switch ($p_options_list[$i]) { // ----- Look for options that request a path value case PCLZIP_OPT_PATH: case PCLZIP_OPT_REMOVE_PATH: case PCLZIP_OPT_ADD_PATH: // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value $v_result_list[$p_options_list[$i]] = PclZipUtilTranslateWinPath($p_options_list[$i + 1], false); $i++; break; case PCLZIP_OPT_TEMP_FILE_THRESHOLD: // ----- Check the number of parameters if (($i + 1) >= $p_size) { PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); return PclZip::errorCode(); } // ----- Check for incompatible options if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_OFF])) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '" . PclZipUtilOptionText($p_options_list[$i]) . "' can not be used with option 'PCLZIP_OPT_TEMP_FILE_OFF'"); return PclZip::errorCode(); } // ----- Check the value $v_value = $p_options_list[$i + 1]; if ((!is_integer($v_value)) || ($v_value < 0)) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Integer expected for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); return PclZip::errorCode(); } // ----- Get the value (and convert it in bytes) $v_result_list[$p_options_list[$i]] = $v_value * 1048576; $i++; break; case PCLZIP_OPT_TEMP_FILE_ON: // ----- Check for incompatible options if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_OFF])) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '" . PclZipUtilOptionText($p_options_list[$i]) . "' can not be used with option 'PCLZIP_OPT_TEMP_FILE_OFF'"); return PclZip::errorCode(); } $v_result_list[$p_options_list[$i]] = true; break; case PCLZIP_OPT_TEMP_FILE_OFF: // ----- Check for incompatible options if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_ON])) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '" . PclZipUtilOptionText($p_options_list[$i]) . "' can not be used with option 'PCLZIP_OPT_TEMP_FILE_ON'"); return PclZip::errorCode(); } // ----- Check for incompatible options if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_THRESHOLD])) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '" . PclZipUtilOptionText($p_options_list[$i]) . "' can not be used with option 'PCLZIP_OPT_TEMP_FILE_THRESHOLD'"); return PclZip::errorCode(); } $v_result_list[$p_options_list[$i]] = true; break; case PCLZIP_OPT_EXTRACT_DIR_RESTRICTION: // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value if (is_string($p_options_list[$i + 1]) && ($p_options_list[$i + 1] != '')) { $v_result_list[$p_options_list[$i]] = PclZipUtilTranslateWinPath($p_options_list[$i + 1], false); $i++; } else { } break; // ----- Look for options that request an array of string for value case PCLZIP_OPT_BY_NAME: // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value if (is_string($p_options_list[$i + 1])) { $v_result_list[$p_options_list[$i]][0] = $p_options_list[$i + 1]; } elseif (is_array($p_options_list[$i + 1])) { $v_result_list[$p_options_list[$i]] = $p_options_list[$i + 1]; } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } $i++; break; // ----- Look for options that request an EREG or PREG expression case PCLZIP_OPT_BY_EREG: $p_options_list[$i] = PCLZIP_OPT_BY_PREG; // ereg() is deprecated starting with PHP 5.3. Move PCLZIP_OPT_BY_EREG // to PCLZIP_OPT_BY_PREG case PCLZIP_OPT_BY_PREG: //case PCLZIP_OPT_CRYPT : // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value if (is_string($p_options_list[$i + 1])) { $v_result_list[$p_options_list[$i]] = $p_options_list[$i + 1]; } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } $i++; break; // ----- Look for options that takes a string case PCLZIP_OPT_COMMENT: case PCLZIP_OPT_ADD_COMMENT: case PCLZIP_OPT_PREPEND_COMMENT: // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value if (is_string($p_options_list[$i + 1])) { $v_result_list[$p_options_list[$i]] = $p_options_list[$i + 1]; } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } $i++; break; // ----- Look for options that request an array of index case PCLZIP_OPT_BY_INDEX: // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value $v_work_list = array(); if (is_string($p_options_list[$i + 1])) { // ----- Remove spaces $p_options_list[$i + 1] = str_replace(' ', '', $p_options_list[$i + 1]); // ----- Parse items $v_work_list = explode(",", $p_options_list[$i + 1]); } elseif (is_integer($p_options_list[$i + 1])) { $v_work_list[0] = $p_options_list[$i + 1] . '-' . $p_options_list[$i + 1]; } elseif (is_array($p_options_list[$i + 1])) { $v_work_list = $p_options_list[$i + 1]; } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Value must be integer, string or array for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Reduce the index list // each index item in the list must be a couple with a start and // an end value : [0,3], [5-5], [8-10], ... // ----- Check the format of each item $v_sort_flag = false; $v_sort_value = 0; for ($j = 0; $j < sizeof($v_work_list); $j++) { // ----- Explode the item $v_item_list = explode("-", $v_work_list[$j]); $v_size_item_list = sizeof($v_item_list); // ----- TBC : Here we might check that each item is a // real integer ... // ----- Look for single value if ($v_size_item_list == 1) { // ----- Set the option value $v_result_list[$p_options_list[$i]][$j]['start'] = $v_item_list[0]; $v_result_list[$p_options_list[$i]][$j]['end'] = $v_item_list[0]; } elseif ($v_size_item_list == 2) { // ----- Set the option value $v_result_list[$p_options_list[$i]][$j]['start'] = $v_item_list[0]; $v_result_list[$p_options_list[$i]][$j]['end'] = $v_item_list[1]; } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Too many values in index range for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Look for list sort if ($v_result_list[$p_options_list[$i]][$j]['start'] < $v_sort_value) { $v_sort_flag = true; // ----- TBC : An automatic sort should be writen ... // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Invalid order of index range for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } $v_sort_value = $v_result_list[$p_options_list[$i]][$j]['start']; } // ----- Sort the items if ($v_sort_flag) { // TBC : To Be Completed } // ----- Next option $i++; break; // ----- Look for options that request no value case PCLZIP_OPT_REMOVE_ALL_PATH: case PCLZIP_OPT_EXTRACT_AS_STRING: case PCLZIP_OPT_NO_COMPRESSION: case PCLZIP_OPT_EXTRACT_IN_OUTPUT: case PCLZIP_OPT_REPLACE_NEWER: case PCLZIP_OPT_STOP_ON_ERROR: $v_result_list[$p_options_list[$i]] = true; break; // ----- Look for options that request an octal value case PCLZIP_OPT_SET_CHMOD: // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value $v_result_list[$p_options_list[$i]] = $p_options_list[$i + 1]; $i++; break; // ----- Look for options that request a call-back case PCLZIP_CB_PRE_EXTRACT: case PCLZIP_CB_POST_EXTRACT: case PCLZIP_CB_PRE_ADD: case PCLZIP_CB_POST_ADD: /* for futur use case PCLZIP_CB_PRE_DELETE : case PCLZIP_CB_POST_DELETE : case PCLZIP_CB_PRE_LIST : case PCLZIP_CB_POST_LIST : */ // ----- Check the number of parameters if (($i + 1) >= $p_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Get the value $v_function_name = $p_options_list[$i + 1]; // ----- Check that the value is a valid existing function if (!function_exists($v_function_name)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Function '" . $v_function_name . "()' is not an existing function for option '" . PclZipUtilOptionText($p_options_list[$i]) . "'"); // ----- Return return PclZip::errorCode(); } // ----- Set the attribute $v_result_list[$p_options_list[$i]] = $v_function_name; $i++; break; default: // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Unknown parameter '" . $p_options_list[$i] . "'"); // ----- Return return PclZip::errorCode(); } // ----- Next options $i++; } // ----- Look for mandatory options if ($v_requested_options !== false) { for ($key = reset($v_requested_options); $key = key($v_requested_options); $key = next($v_requested_options)) { // ----- Look for mandatory option if ($v_requested_options[$key] == 'mandatory') { // ----- Look if present if (!isset($v_result_list[$key])) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Missing mandatory parameter " . PclZipUtilOptionText($key) . "(" . $key . ")"); // ----- Return return PclZip::errorCode(); } } } } // ----- Look for default values if (!isset($v_result_list[PCLZIP_OPT_TEMP_FILE_THRESHOLD])) { } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privOptionDefaultThreshold() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privOptionDefaultThreshold(&$p_options) { $v_result = 1; if (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]) || isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF])) { return $v_result; } // ----- Get 'memory_limit' configuration value $v_memory_limit = ini_get('memory_limit'); $v_memory_limit = trim($v_memory_limit); $last = strtolower(substr($v_memory_limit, -1)); $v_memory_limit = preg_replace('/[^0-9,.]/', '', $v_memory_limit); if ($last == 'g') { //$v_memory_limit = $v_memory_limit*1024*1024*1024; $v_memory_limit = $v_memory_limit * 1073741824; } if ($last == 'm') { //$v_memory_limit = $v_memory_limit*1024*1024; $v_memory_limit = $v_memory_limit * 1048576; } if ($last == 'k') { $v_memory_limit = $v_memory_limit * 1024; } $p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] = floor($v_memory_limit * PCLZIP_TEMPORARY_FILE_RATIO); // ----- Sanity check : No threshold if value lower than 1M if ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] < 1048576) { unset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privFileDescrParseAtt() // Description : // Parameters : // Return Values : // 1 on success. // 0 on failure. // -------------------------------------------------------------------------------- public function privFileDescrParseAtt(&$p_file_list, &$p_filedescr, $v_options, $v_requested_options = false) { $v_result = 1; // ----- For each file in the list check the attributes foreach ($p_file_list as $v_key => $v_value) { // ----- Check if the option is supported if (!isset($v_requested_options[$v_key])) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file attribute '" . $v_key . "' for this file"); // ----- Return return PclZip::errorCode(); } // ----- Look for attribute switch ($v_key) { case PCLZIP_ATT_FILE_NAME: if (!is_string($v_value)) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type " . gettype($v_value) . ". String expected for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } $p_filedescr['filename'] = PclZipUtilPathReduction($v_value); if ($p_filedescr['filename'] == '') { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty filename for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } break; case PCLZIP_ATT_FILE_NEW_SHORT_NAME: if (!is_string($v_value)) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type " . gettype($v_value) . ". String expected for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } $p_filedescr['new_short_name'] = PclZipUtilPathReduction($v_value); if ($p_filedescr['new_short_name'] == '') { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty short filename for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } break; case PCLZIP_ATT_FILE_NEW_FULL_NAME: if (!is_string($v_value)) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type " . gettype($v_value) . ". String expected for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } $p_filedescr['new_full_name'] = PclZipUtilPathReduction($v_value); if ($p_filedescr['new_full_name'] == '') { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty full filename for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } break; // ----- Look for options that takes a string case PCLZIP_ATT_FILE_COMMENT: if (!is_string($v_value)) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type " . gettype($v_value) . ". String expected for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } $p_filedescr['comment'] = $v_value; break; case PCLZIP_ATT_FILE_MTIME: if (!is_integer($v_value)) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type " . gettype($v_value) . ". Integer expected for attribute '" . PclZipUtilOptionText($v_key) . "'"); return PclZip::errorCode(); } $p_filedescr['mtime'] = $v_value; break; case PCLZIP_ATT_FILE_CONTENT: $p_filedescr['content'] = $v_value; break; default: // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Unknown parameter '" . $v_key . "'"); // ----- Return return PclZip::errorCode(); } // ----- Look for mandatory options if ($v_requested_options !== false) { for ($key = reset($v_requested_options); $key = key($v_requested_options); $key = next($v_requested_options)) { // ----- Look for mandatory option if ($v_requested_options[$key] == 'mandatory') { // ----- Look if present if (!isset($p_file_list[$key])) { PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Missing mandatory parameter " . PclZipUtilOptionText($key) . "(" . $key . ")"); return PclZip::errorCode(); } } } } // end foreach } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privFileDescrExpand() // Description : // This method look for each item of the list to see if its a file, a folder // or a string to be added as file. For any other type of files (link, other) // just ignore the item. // Then prepare the information that will be stored for that file. // When its a folder, expand the folder with all the files that are in that // folder (recursively). // Parameters : // Return Values : // 1 on success. // 0 on failure. // -------------------------------------------------------------------------------- public function privFileDescrExpand(&$p_filedescr_list, &$p_options) { $v_result = 1; // ----- Create a result list $v_result_list = array(); // ----- Look each entry for ($i = 0; $i < sizeof($p_filedescr_list); $i++) { // ----- Get filedescr $v_descr = $p_filedescr_list[$i]; // ----- Reduce the filename $v_descr['filename'] = PclZipUtilTranslateWinPath($v_descr['filename'], false); $v_descr['filename'] = PclZipUtilPathReduction($v_descr['filename']); // ----- Look for real file or folder if (file_exists($v_descr['filename'])) { if (@is_file($v_descr['filename'])) { $v_descr['type'] = 'file'; } elseif (@is_dir($v_descr['filename'])) { $v_descr['type'] = 'folder'; } elseif (@is_link($v_descr['filename'])) { // skip continue; } else { // skip continue; } // ----- Look for string added as file } elseif (isset($v_descr['content'])) { $v_descr['type'] = 'virtual_file'; // ----- Missing file } else { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '" . $v_descr['filename'] . "' does not exist"); // ----- Return return PclZip::errorCode(); } // ----- Calculate the stored filename $this->privCalculateStoredFilename($v_descr, $p_options); // ----- Add the descriptor in result list $v_result_list[sizeof($v_result_list)] = $v_descr; // ----- Look for folder if ($v_descr['type'] == 'folder') { // ----- List of items in folder $v_dirlist_descr = array(); $v_dirlist_nb = 0; if ($v_folder_handler = @opendir($v_descr['filename'])) { while (($v_item_handler = @readdir($v_folder_handler)) !== false) { // ----- Skip '.' and '..' if (($v_item_handler == '.') || ($v_item_handler == '..')) { continue; } // ----- Compose the full filename $v_dirlist_descr[$v_dirlist_nb]['filename'] = $v_descr['filename'] . '/' . $v_item_handler; // ----- Look for different stored filename // Because the name of the folder was changed, the name of the // files/sub-folders also change if (($v_descr['stored_filename'] != $v_descr['filename']) && (!isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH]))) { if ($v_descr['stored_filename'] != '') { $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_descr['stored_filename'] . '/' . $v_item_handler; } else { $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_item_handler; } } $v_dirlist_nb++; } @closedir($v_folder_handler); } else { // TBC : unable to open folder in read mode } // ----- Expand each element of the list if ($v_dirlist_nb != 0) { // ----- Expand if (($v_result = $this->privFileDescrExpand($v_dirlist_descr, $p_options)) != 1) { return $v_result; } // ----- Concat the resulting list $v_result_list = array_merge($v_result_list, $v_dirlist_descr); } else { } // ----- Free local array unset($v_dirlist_descr); } } // ----- Get the result list $p_filedescr_list = $v_result_list; // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privCreate() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privCreate($p_filedescr_list, &$p_result_list, &$p_options) { $v_result = 1; $v_list_detail = array(); // ----- Magic quotes trick $this->privDisableMagicQuotes(); // ----- Open the file in write mode if (($v_result = $this->privOpenFd('wb')) != 1) { // ----- Return return $v_result; } // ----- Add the list of files $v_result = $this->privAddList($p_filedescr_list, $p_result_list, $p_options); // ----- Close $this->privCloseFd(); // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privAdd() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privAdd($p_filedescr_list, &$p_result_list, &$p_options) { $v_result = 1; $v_list_detail = array(); // ----- Look if the archive exists or is empty if ((!is_file($this->zipname)) || (filesize($this->zipname) == 0)) { // ----- Do a create $v_result = $this->privCreate($p_filedescr_list, $p_result_list, $p_options); // ----- Return return $v_result; } // ----- Magic quotes trick $this->privDisableMagicQuotes(); // ----- Open the zip file if (($v_result = $this->privOpenFd('rb')) != 1) { // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } // ----- Read the central directory informations $v_central_dir = array(); if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Go to beginning of File @rewind($this->zip_fd); // ----- Creates a temporay file $v_zip_temp_name = PCLZIP_TEMPORARY_DIR . uniqid('pclzip-') . '.tmp'; // ----- Open the temporary file in write mode if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \'' . $v_zip_temp_name . '\' in binary write mode'); // ----- Return return PclZip::errorCode(); } // ----- Copy the files from the archive to the temporary file // TBC : Here I should better append the file and go back to erase the central dir $v_size = $v_central_dir['offset']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = fread($this->zip_fd, $v_read_size); @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Swap the file descriptor // Here is a trick : I swap the temporary fd with the zip fd, in order to use // the following methods on the temporary fil and not the real archive $v_swap = $this->zip_fd; $this->zip_fd = $v_zip_temp_fd; $v_zip_temp_fd = $v_swap; // ----- Add the files $v_header_list = array(); if (($v_result = $this->privAddFileList($p_filedescr_list, $v_header_list, $p_options)) != 1) { fclose($v_zip_temp_fd); $this->privCloseFd(); @unlink($v_zip_temp_name); $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } // ----- Store the offset of the central dir $v_offset = @ftell($this->zip_fd); // ----- Copy the block of file headers from the old archive $v_size = $v_central_dir['size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($v_zip_temp_fd, $v_read_size); @fwrite($this->zip_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Create the Central Dir files header for ($i = 0, $v_count = 0; $i < sizeof($v_header_list); $i++) { // ----- Create the file header if ($v_header_list[$i]['status'] == 'ok') { if (($v_result = $this->privWriteCentralFileHeader($v_header_list[$i])) != 1) { fclose($v_zip_temp_fd); $this->privCloseFd(); @unlink($v_zip_temp_name); $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } $v_count++; } // ----- Transform the header to a 'usable' info $this->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]); } // ----- Zip file comment $v_comment = $v_central_dir['comment']; if (isset($p_options[PCLZIP_OPT_COMMENT])) { $v_comment = $p_options[PCLZIP_OPT_COMMENT]; } if (isset($p_options[PCLZIP_OPT_ADD_COMMENT])) { $v_comment = $v_comment . $p_options[PCLZIP_OPT_ADD_COMMENT]; } if (isset($p_options[PCLZIP_OPT_PREPEND_COMMENT])) { $v_comment = $p_options[PCLZIP_OPT_PREPEND_COMMENT] . $v_comment; } // ----- Calculate the size of the central header $v_size = @ftell($this->zip_fd) - $v_offset; // ----- Create the central dir footer if (($v_result = $this->privWriteCentralHeader($v_count + $v_central_dir['entries'], $v_size, $v_offset, $v_comment)) != 1) { // ----- Reset the file list unset($v_header_list); $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } // ----- Swap back the file descriptor $v_swap = $this->zip_fd; $this->zip_fd = $v_zip_temp_fd; $v_zip_temp_fd = $v_swap; // ----- Close $this->privCloseFd(); // ----- Close the temporary file @fclose($v_zip_temp_fd); // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Delete the zip file // TBC : I should test the result ... @unlink($this->zipname); // ----- Rename the temporary file // TBC : I should test the result ... //@rename($v_zip_temp_name, $this->zipname); PclZipUtilRename($v_zip_temp_name, $this->zipname); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privOpenFd() // Description : // Parameters : // -------------------------------------------------------------------------------- public function privOpenFd($p_mode) { $v_result = 1; // ----- Look if already open if ($this->zip_fd != 0) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Zip file \'' . $this->zipname . '\' already open'); // ----- Return return PclZip::errorCode(); } // ----- Open the zip file if (($this->zip_fd = @fopen($this->zipname, $p_mode)) == 0) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \'' . $this->zipname . '\' in ' . $p_mode . ' mode'); // ----- Return return PclZip::errorCode(); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privCloseFd() // Description : // Parameters : // -------------------------------------------------------------------------------- public function privCloseFd() { $v_result = 1; if ($this->zip_fd != 0) { @fclose($this->zip_fd); } $this->zip_fd = 0; // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privAddList() // Description : // $p_add_dir and $p_remove_dir will give the ability to memorize a path which is // different from the real path of the file. This is usefull if you want to have PclTar // running in any directory, and memorize relative path from an other directory. // Parameters : // $p_list : An array containing the file or directory names to add in the tar // $p_result_list : list of added files with their properties (specially the status field) // $p_add_dir : Path to add in the filename path archived // $p_remove_dir : Path to remove in the filename path archived // Return Values : // -------------------------------------------------------------------------------- // function privAddList($p_list, &$p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_options) public function privAddList($p_filedescr_list, &$p_result_list, &$p_options) { $v_result = 1; // ----- Add the files $v_header_list = array(); if (($v_result = $this->privAddFileList($p_filedescr_list, $v_header_list, $p_options)) != 1) { // ----- Return return $v_result; } // ----- Store the offset of the central dir $v_offset = @ftell($this->zip_fd); // ----- Create the Central Dir files header for ($i = 0, $v_count = 0; $i < sizeof($v_header_list); $i++) { // ----- Create the file header if ($v_header_list[$i]['status'] == 'ok') { if (($v_result = $this->privWriteCentralFileHeader($v_header_list[$i])) != 1) { // ----- Return return $v_result; } $v_count++; } // ----- Transform the header to a 'usable' info $this->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]); } // ----- Zip file comment $v_comment = ''; if (isset($p_options[PCLZIP_OPT_COMMENT])) { $v_comment = $p_options[PCLZIP_OPT_COMMENT]; } // ----- Calculate the size of the central header $v_size = @ftell($this->zip_fd) - $v_offset; // ----- Create the central dir footer if (($v_result = $this->privWriteCentralHeader($v_count, $v_size, $v_offset, $v_comment)) != 1) { // ----- Reset the file list unset($v_header_list); // ----- Return return $v_result; } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privAddFileList() // Description : // Parameters : // $p_filedescr_list : An array containing the file description // or directory names to add in the zip // $p_result_list : list of added files with their properties (specially the status field) // Return Values : // -------------------------------------------------------------------------------- public function privAddFileList($p_filedescr_list, &$p_result_list, &$p_options) { $v_result = 1; $v_header = array(); // ----- Recuperate the current number of elt in list $v_nb = sizeof($p_result_list); // ----- Loop on the files for ($j = 0; ($j < sizeof($p_filedescr_list)) && ($v_result == 1); $j++) { // ----- Format the filename $p_filedescr_list[$j]['filename'] = PclZipUtilTranslateWinPath($p_filedescr_list[$j]['filename'], false); // ----- Skip empty file names // TBC : Can this be possible ? not checked in DescrParseAtt ? if ($p_filedescr_list[$j]['filename'] == "") { continue; } // ----- Check the filename if (($p_filedescr_list[$j]['type'] != 'virtual_file') && (!file_exists($p_filedescr_list[$j]['filename']))) { PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '" . $p_filedescr_list[$j]['filename'] . "' does not exist"); return PclZip::errorCode(); } // ----- Look if it is a file or a dir with no all path remove option // or a dir with all its path removed // if ( (is_file($p_filedescr_list[$j]['filename'])) // || ( is_dir($p_filedescr_list[$j]['filename']) if (($p_filedescr_list[$j]['type'] == 'file') || ($p_filedescr_list[$j]['type'] == 'virtual_file') || (($p_filedescr_list[$j]['type'] == 'folder') && (!isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH]) || !$p_options[PCLZIP_OPT_REMOVE_ALL_PATH]))) { // ----- Add the file $v_result = $this->privAddFile($p_filedescr_list[$j], $v_header, $p_options); if ($v_result != 1) { return $v_result; } // ----- Store the file infos $p_result_list[$v_nb++] = $v_header; } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privAddFile() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privAddFile($p_filedescr, &$p_header, &$p_options) { $v_result = 1; // ----- Working variable $p_filename = $p_filedescr['filename']; // TBC : Already done in the fileAtt check ... ? if ($p_filename == "") { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file list parameter (invalid or empty list)"); // ----- Return return PclZip::errorCode(); } // ----- Look for a stored different filename /* TBC : Removed if (isset($p_filedescr['stored_filename'])) { $v_stored_filename = $p_filedescr['stored_filename']; } else { $v_stored_filename = $p_filedescr['stored_filename']; } */ // ----- Set the file properties clearstatcache(); $p_header['version'] = 20; $p_header['version_extracted'] = 10; $p_header['flag'] = 0; $p_header['compression'] = 0; $p_header['crc'] = 0; $p_header['compressed_size'] = 0; $p_header['filename_len'] = strlen($p_filename); $p_header['extra_len'] = 0; $p_header['disk'] = 0; $p_header['internal'] = 0; $p_header['offset'] = 0; $p_header['filename'] = $p_filename; // TBC : Removed $p_header['stored_filename'] = $v_stored_filename; $p_header['stored_filename'] = $p_filedescr['stored_filename']; $p_header['extra'] = ''; $p_header['status'] = 'ok'; $p_header['index'] = -1; // ----- Look for regular file if ($p_filedescr['type'] == 'file') { $p_header['external'] = 0x00000000; $p_header['size'] = filesize($p_filename); // ----- Look for regular folder } elseif ($p_filedescr['type'] == 'folder') { $p_header['external'] = 0x00000010; $p_header['mtime'] = filemtime($p_filename); $p_header['size'] = filesize($p_filename); // ----- Look for virtual file } elseif ($p_filedescr['type'] == 'virtual_file') { $p_header['external'] = 0x00000000; $p_header['size'] = strlen($p_filedescr['content']); } // ----- Look for filetime if (isset($p_filedescr['mtime'])) { $p_header['mtime'] = $p_filedescr['mtime']; } elseif ($p_filedescr['type'] == 'virtual_file') { $p_header['mtime'] = time(); } else { $p_header['mtime'] = filemtime($p_filename); } // ------ Look for file comment if (isset($p_filedescr['comment'])) { $p_header['comment_len'] = strlen($p_filedescr['comment']); $p_header['comment'] = $p_filedescr['comment']; } else { $p_header['comment_len'] = 0; $p_header['comment'] = ''; } // ----- Look for pre-add callback if (isset($p_options[PCLZIP_CB_PRE_ADD])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_header, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_PRE_ADD].'(PCLZIP_CB_PRE_ADD, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_PRE_ADD](PCLZIP_CB_PRE_ADD, $v_local_header); if ($v_result == 0) { // ----- Change the file status $p_header['status'] = "skipped"; $v_result = 1; } // ----- Update the informations // Only some fields can be modified if ($p_header['stored_filename'] != $v_local_header['stored_filename']) { $p_header['stored_filename'] = PclZipUtilPathReduction($v_local_header['stored_filename']); } } // ----- Look for empty stored filename if ($p_header['stored_filename'] == "") { $p_header['status'] = "filtered"; } // ----- Check the path length if (strlen($p_header['stored_filename']) > 0xFF) { $p_header['status'] = 'filename_too_long'; } // ----- Look if no error, or file not skipped if ($p_header['status'] == 'ok') { // ----- Look for a file if ($p_filedescr['type'] == 'file') { // ----- Look for using temporary file to zip if ((!isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF])) && (isset($p_options[PCLZIP_OPT_TEMP_FILE_ON]) || (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]) && ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] <= $p_header['size'])))) { $v_result = $this->privAddFileUsingTempFile($p_filedescr, $p_header, $p_options); if ($v_result < PCLZIP_ERR_NO_ERROR) { return $v_result; } // ----- Use "in memory" zip algo } else { // ----- Open the source file if (($v_file = @fopen($p_filename, "rb")) == 0) { PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to open file '$p_filename' in binary read mode"); return PclZip::errorCode(); } // ----- Read the file content $v_content = @fread($v_file, $p_header['size']); // ----- Close the file @fclose($v_file); // ----- Calculate the CRC $p_header['crc'] = @crc32($v_content); // ----- Look for no compression if ($p_options[PCLZIP_OPT_NO_COMPRESSION]) { // ----- Set header parameters $p_header['compressed_size'] = $p_header['size']; $p_header['compression'] = 0; // ----- Look for normal compression } else { // ----- Compress the content $v_content = @gzdeflate($v_content); // ----- Set header parameters $p_header['compressed_size'] = strlen($v_content); $p_header['compression'] = 8; } // ----- Call the header generation if (($v_result = $this->privWriteFileHeader($p_header)) != 1) { @fclose($v_file); return $v_result; } // ----- Write the compressed (or not) content @fwrite($this->zip_fd, $v_content, $p_header['compressed_size']); } // ----- Look for a virtual file (a file from string) } elseif ($p_filedescr['type'] == 'virtual_file') { $v_content = $p_filedescr['content']; // ----- Calculate the CRC $p_header['crc'] = @crc32($v_content); // ----- Look for no compression if ($p_options[PCLZIP_OPT_NO_COMPRESSION]) { // ----- Set header parameters $p_header['compressed_size'] = $p_header['size']; $p_header['compression'] = 0; // ----- Look for normal compression } else { // ----- Compress the content $v_content = @gzdeflate($v_content); // ----- Set header parameters $p_header['compressed_size'] = strlen($v_content); $p_header['compression'] = 8; } // ----- Call the header generation if (($v_result = $this->privWriteFileHeader($p_header)) != 1) { @fclose($v_file); return $v_result; } // ----- Write the compressed (or not) content @fwrite($this->zip_fd, $v_content, $p_header['compressed_size']); // ----- Look for a directory } elseif ($p_filedescr['type'] == 'folder') { // ----- Look for directory last '/' if (@substr($p_header['stored_filename'], -1) != '/') { $p_header['stored_filename'] .= '/'; } // ----- Set the file properties $p_header['size'] = 0; //$p_header['external'] = 0x41FF0010; // Value for a folder : to be checked $p_header['external'] = 0x00000010; // Value for a folder : to be checked // ----- Call the header generation if (($v_result = $this->privWriteFileHeader($p_header)) != 1) { return $v_result; } } } // ----- Look for post-add callback if (isset($p_options[PCLZIP_CB_POST_ADD])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_header, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_POST_ADD].'(PCLZIP_CB_POST_ADD, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_POST_ADD](PCLZIP_CB_POST_ADD, $v_local_header); if ($v_result == 0) { // ----- Ignored $v_result = 1; } // ----- Update the informations // Nothing can be modified } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privAddFileUsingTempFile() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privAddFileUsingTempFile($p_filedescr, &$p_header, &$p_options) { $v_result = PCLZIP_ERR_NO_ERROR; // ----- Working variable $p_filename = $p_filedescr['filename']; // ----- Open the source file if (($v_file = @fopen($p_filename, "rb")) == 0) { PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to open file '$p_filename' in binary read mode"); return PclZip::errorCode(); } // ----- Creates a compressed temporary file $v_gzip_temp_name = PCLZIP_TEMPORARY_DIR . uniqid('pclzip-') . '.gz'; if (($v_file_compressed = @gzopen($v_gzip_temp_name, "wb")) == 0) { fclose($v_file); PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, 'Unable to open temporary file \'' . $v_gzip_temp_name . '\' in binary write mode'); return PclZip::errorCode(); } // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks $v_size = filesize($p_filename); while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($v_file, $v_read_size); //$v_binary_data = pack('a'.$v_read_size, $v_buffer); @gzputs($v_file_compressed, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Close the file @fclose($v_file); @gzclose($v_file_compressed); // ----- Check the minimum file size if (filesize($v_gzip_temp_name) < 18) { PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'gzip temporary file \'' . $v_gzip_temp_name . '\' has invalid filesize - should be minimum 18 bytes'); return PclZip::errorCode(); } // ----- Extract the compressed attributes if (($v_file_compressed = @fopen($v_gzip_temp_name, "rb")) == 0) { PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \'' . $v_gzip_temp_name . '\' in binary read mode'); return PclZip::errorCode(); } // ----- Read the gzip file header $v_binary_data = @fread($v_file_compressed, 10); $v_data_header = unpack('a1id1/a1id2/a1cm/a1flag/Vmtime/a1xfl/a1os', $v_binary_data); // ----- Check some parameters $v_data_header['os'] = bin2hex($v_data_header['os']); // ----- Read the gzip file footer @fseek($v_file_compressed, filesize($v_gzip_temp_name) - 8); $v_binary_data = @fread($v_file_compressed, 8); $v_data_footer = unpack('Vcrc/Vcompressed_size', $v_binary_data); // ----- Set the attributes $p_header['compression'] = ord($v_data_header['cm']); //$p_header['mtime'] = $v_data_header['mtime']; $p_header['crc'] = $v_data_footer['crc']; $p_header['compressed_size'] = filesize($v_gzip_temp_name) - 18; // ----- Close the file @fclose($v_file_compressed); // ----- Call the header generation if (($v_result = $this->privWriteFileHeader($p_header)) != 1) { return $v_result; } // ----- Add the compressed data if (($v_file_compressed = @fopen($v_gzip_temp_name, "rb")) == 0) { PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \'' . $v_gzip_temp_name . '\' in binary read mode'); return PclZip::errorCode(); } // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks fseek($v_file_compressed, 10); $v_size = $p_header['compressed_size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($v_file_compressed, $v_read_size); //$v_binary_data = pack('a'.$v_read_size, $v_buffer); @fwrite($this->zip_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Close the file @fclose($v_file_compressed); // ----- Unlink the temporary file @unlink($v_gzip_temp_name); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privCalculateStoredFilename() // Description : // Based on file descriptor properties and global options, this method // calculate the filename that will be stored in the archive. // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privCalculateStoredFilename(&$p_filedescr, &$p_options) { $v_result = 1; // ----- Working variables $p_filename = $p_filedescr['filename']; if (isset($p_options[PCLZIP_OPT_ADD_PATH])) { $p_add_dir = $p_options[PCLZIP_OPT_ADD_PATH]; } else { $p_add_dir = ''; } if (isset($p_options[PCLZIP_OPT_REMOVE_PATH])) { $p_remove_dir = $p_options[PCLZIP_OPT_REMOVE_PATH]; } else { $p_remove_dir = ''; } if (isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH])) { $p_remove_all_dir = $p_options[PCLZIP_OPT_REMOVE_ALL_PATH]; } else { $p_remove_all_dir = 0; } // ----- Look for full name change if (isset($p_filedescr['new_full_name'])) { // ----- Remove drive letter if any $v_stored_filename = PclZipUtilTranslateWinPath($p_filedescr['new_full_name']); // ----- Look for path and/or short name change } else { // ----- Look for short name change // Its when we cahnge just the filename but not the path if (isset($p_filedescr['new_short_name'])) { $v_path_info = pathinfo($p_filename); $v_dir = ''; if ($v_path_info['dirname'] != '') { $v_dir = $v_path_info['dirname'] . '/'; } $v_stored_filename = $v_dir . $p_filedescr['new_short_name']; } else { // ----- Calculate the stored filename $v_stored_filename = $p_filename; } // ----- Look for all path to remove if ($p_remove_all_dir) { $v_stored_filename = basename($p_filename); // ----- Look for partial path remove } elseif ($p_remove_dir != "") { if (substr($p_remove_dir, -1) != '/') { $p_remove_dir .= "/"; } if ((substr($p_filename, 0, 2) == "./") || (substr($p_remove_dir, 0, 2) == "./")) { if ((substr($p_filename, 0, 2) == "./") && (substr($p_remove_dir, 0, 2) != "./")) { $p_remove_dir = "./" . $p_remove_dir; } if ((substr($p_filename, 0, 2) != "./") && (substr($p_remove_dir, 0, 2) == "./")) { $p_remove_dir = substr($p_remove_dir, 2); } } $v_compare = PclZipUtilPathInclusion($p_remove_dir, $v_stored_filename); if ($v_compare > 0) { if ($v_compare == 2) { $v_stored_filename = ""; } else { $v_stored_filename = substr($v_stored_filename, strlen($p_remove_dir)); } } } // ----- Remove drive letter if any $v_stored_filename = PclZipUtilTranslateWinPath($v_stored_filename); // ----- Look for path to add if ($p_add_dir != "") { if (substr($p_add_dir, -1) == "/") { $v_stored_filename = $p_add_dir . $v_stored_filename; } else { $v_stored_filename = $p_add_dir . "/" . $v_stored_filename; } } } // ----- Filename (reduce the path of stored name) $v_stored_filename = PclZipUtilPathReduction($v_stored_filename); $p_filedescr['stored_filename'] = $v_stored_filename; // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privWriteFileHeader() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privWriteFileHeader(&$p_header) { $v_result = 1; // ----- Store the offset position of the file $p_header['offset'] = ftell($this->zip_fd); // ----- Transform UNIX mtime to DOS format mdate/mtime $v_date = getdate($p_header['mtime']); $v_mtime = ($v_date['hours'] << 11) + ($v_date['minutes'] << 5) + $v_date['seconds'] / 2; $v_mdate = (($v_date['year'] - 1980) << 9) + ($v_date['mon'] << 5) + $v_date['mday']; // ----- Packed data $v_binary_data = pack("VvvvvvVVVvv", 0x04034b50, $p_header['version_extracted'], $p_header['flag'], $p_header['compression'], $v_mtime, $v_mdate, $p_header['crc'], $p_header['compressed_size'], $p_header['size'], strlen($p_header['stored_filename']), $p_header['extra_len']); // ----- Write the first 148 bytes of the header in the archive fputs($this->zip_fd, $v_binary_data, 30); // ----- Write the variable fields if (strlen($p_header['stored_filename']) != 0) { fputs($this->zip_fd, $p_header['stored_filename'], strlen($p_header['stored_filename'])); } if ($p_header['extra_len'] != 0) { fputs($this->zip_fd, $p_header['extra'], $p_header['extra_len']); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privWriteCentralFileHeader() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privWriteCentralFileHeader(&$p_header) { $v_result = 1; // TBC //for (reset($p_header); $key = key($p_header); next($p_header)) { //} // ----- Transform UNIX mtime to DOS format mdate/mtime $v_date = getdate($p_header['mtime']); $v_mtime = ($v_date['hours'] << 11) + ($v_date['minutes'] << 5) + $v_date['seconds'] / 2; $v_mdate = (($v_date['year'] - 1980) << 9) + ($v_date['mon'] << 5) + $v_date['mday']; // ----- Packed data $v_binary_data = pack("VvvvvvvVVVvvvvvVV", 0x02014b50, $p_header['version'], $p_header['version_extracted'], $p_header['flag'], $p_header['compression'], $v_mtime, $v_mdate, $p_header['crc'], $p_header['compressed_size'], $p_header['size'], strlen($p_header['stored_filename']), $p_header['extra_len'], $p_header['comment_len'], $p_header['disk'], $p_header['internal'], $p_header['external'], $p_header['offset']); // ----- Write the 42 bytes of the header in the zip file fputs($this->zip_fd, $v_binary_data, 46); // ----- Write the variable fields if (strlen($p_header['stored_filename']) != 0) { fputs($this->zip_fd, $p_header['stored_filename'], strlen($p_header['stored_filename'])); } if ($p_header['extra_len'] != 0) { fputs($this->zip_fd, $p_header['extra'], $p_header['extra_len']); } if ($p_header['comment_len'] != 0) { fputs($this->zip_fd, $p_header['comment'], $p_header['comment_len']); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privWriteCentralHeader() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privWriteCentralHeader($p_nb_entries, $p_size, $p_offset, $p_comment) { $v_result = 1; // ----- Packed data $v_binary_data = pack("VvvvvVVv", 0x06054b50, 0, 0, $p_nb_entries, $p_nb_entries, $p_size, $p_offset, strlen($p_comment)); // ----- Write the 22 bytes of the header in the zip file fputs($this->zip_fd, $v_binary_data, 22); // ----- Write the variable fields if (strlen($p_comment) != 0) { fputs($this->zip_fd, $p_comment, strlen($p_comment)); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privList() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privList(&$p_list) { $v_result = 1; // ----- Magic quotes trick $this->privDisableMagicQuotes(); // ----- Open the zip file if (($this->zip_fd = @fopen($this->zipname, 'rb')) == 0) { // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \'' . $this->zipname . '\' in binary read mode'); // ----- Return return PclZip::errorCode(); } // ----- Read the central directory informations $v_central_dir = array(); if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1) { $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Go to beginning of Central Dir @rewind($this->zip_fd); if (@fseek($this->zip_fd, $v_central_dir['offset'])) { $this->privSwapBackMagicQuotes(); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size'); // ----- Return return PclZip::errorCode(); } // ----- Read each entry for ($i = 0; $i < $v_central_dir['entries']; $i++) { // ----- Read the file header if (($v_result = $this->privReadCentralFileHeader($v_header)) != 1) { $this->privSwapBackMagicQuotes(); return $v_result; } $v_header['index'] = $i; // ----- Get the only interesting attributes $this->privConvertHeader2FileInfo($v_header, $p_list[$i]); unset($v_header); } // ----- Close the zip file $this->privCloseFd(); // ----- Magic quotes trick $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privConvertHeader2FileInfo() // Description : // This function takes the file informations from the central directory // entries and extract the interesting parameters that will be given back. // The resulting file infos are set in the array $p_info // $p_info['filename'] : Filename with full path. Given by user (add), // extracted in the filesystem (extract). // $p_info['stored_filename'] : Stored filename in the archive. // $p_info['size'] = Size of the file. // $p_info['compressed_size'] = Compressed size of the file. // $p_info['mtime'] = Last modification date of the file. // $p_info['comment'] = Comment associated with the file. // $p_info['folder'] = true/false : indicates if the entry is a folder or not. // $p_info['status'] = status of the action on the file. // $p_info['crc'] = CRC of the file content. // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privConvertHeader2FileInfo($p_header, &$p_info) { $v_result = 1; // ----- Get the interesting attributes $v_temp_path = PclZipUtilPathReduction($p_header['filename']); $p_info['filename'] = $v_temp_path; $v_temp_path = PclZipUtilPathReduction($p_header['stored_filename']); $p_info['stored_filename'] = $v_temp_path; $p_info['size'] = $p_header['size']; $p_info['compressed_size'] = $p_header['compressed_size']; $p_info['mtime'] = $p_header['mtime']; $p_info['comment'] = $p_header['comment']; $p_info['folder'] = (($p_header['external'] & 0x00000010) == 0x00000010); $p_info['index'] = $p_header['index']; $p_info['status'] = $p_header['status']; $p_info['crc'] = $p_header['crc']; // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privExtractByRule() // Description : // Extract a file or directory depending of rules (by index, by name, ...) // Parameters : // $p_file_list : An array where will be placed the properties of each // extracted file // $p_path : Path to add while writing the extracted files // $p_remove_path : Path to remove (from the file memorized path) while writing the // extracted files. If the path does not match the file path, // the file is extracted with its memorized path. // $p_remove_path does not apply to 'list' mode. // $p_path and $p_remove_path are commulative. // Return Values : // 1 on success,0 or less on error (see error code list) // -------------------------------------------------------------------------------- public function privExtractByRule(&$p_file_list, $p_path, $p_remove_path, $p_remove_all_path, &$p_options) { $v_result = 1; // ----- Magic quotes trick $this->privDisableMagicQuotes(); // ----- Check the path if (($p_path == "") || ((substr($p_path, 0, 1) != "/") && (substr($p_path, 0, 3) != "../") && (substr($p_path, 1, 2) != ":/"))) { $p_path = "./" . $p_path; } // ----- Reduce the path last (and duplicated) '/' if (($p_path != "./") && ($p_path != "/")) { // ----- Look for the path end '/' while (substr($p_path, -1) == "/") { $p_path = substr($p_path, 0, strlen($p_path) - 1); } } // ----- Look for path to remove format (should end by /) if (($p_remove_path != "") && (substr($p_remove_path, -1) != '/')) { $p_remove_path .= '/'; } $p_remove_path_size = strlen($p_remove_path); // ----- Open the zip file if (($v_result = $this->privOpenFd('rb')) != 1) { $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Read the central directory informations $v_central_dir = array(); if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1) { // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Start at beginning of Central Dir $v_pos_entry = $v_central_dir['offset']; // ----- Read each entry $j_start = 0; for ($i = 0, $v_nb_extracted = 0; $i < $v_central_dir['entries']; $i++) { // ----- Read next Central dir entry @rewind($this->zip_fd); if (@fseek($this->zip_fd, $v_pos_entry)) { // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size'); // ----- Return return PclZip::errorCode(); } // ----- Read the file header $v_header = array(); if (($v_result = $this->privReadCentralFileHeader($v_header)) != 1) { // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Store the index $v_header['index'] = $i; // ----- Store the file position $v_pos_entry = ftell($this->zip_fd); // ----- Look for the specific extract rules $v_extract = false; // ----- Look for extract by name rule if ((isset($p_options[PCLZIP_OPT_BY_NAME])) && ($p_options[PCLZIP_OPT_BY_NAME] != 0)) { // ----- Look if the filename is in the list for ($j = 0; ($j < sizeof($p_options[PCLZIP_OPT_BY_NAME])) && (!$v_extract); $j++) { // ----- Look for a directory if (substr($p_options[PCLZIP_OPT_BY_NAME][$j], -1) == "/") { // ----- Look if the directory is in the filename path if ((strlen($v_header['stored_filename']) > strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) && (substr($v_header['stored_filename'], 0, strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) == $p_options[PCLZIP_OPT_BY_NAME][$j])) { $v_extract = true; } // ----- Look for a filename } elseif ($v_header['stored_filename'] == $p_options[PCLZIP_OPT_BY_NAME][$j]) { $v_extract = true; } } // ----- Look for extract by preg rule } elseif ((isset($p_options[PCLZIP_OPT_BY_PREG])) && ($p_options[PCLZIP_OPT_BY_PREG] != "")) { if (preg_match($p_options[PCLZIP_OPT_BY_PREG], $v_header['stored_filename'])) { $v_extract = true; } // ----- Look for extract by index rule } elseif ((isset($p_options[PCLZIP_OPT_BY_INDEX])) && ($p_options[PCLZIP_OPT_BY_INDEX] != 0)) { // ----- Look if the index is in the list for ($j = $j_start; ($j < sizeof($p_options[PCLZIP_OPT_BY_INDEX])) && (!$v_extract); $j++) { if (($i >= $p_options[PCLZIP_OPT_BY_INDEX][$j]['start']) && ($i <= $p_options[PCLZIP_OPT_BY_INDEX][$j]['end'])) { $v_extract = true; } if ($i >= $p_options[PCLZIP_OPT_BY_INDEX][$j]['end']) { $j_start = $j + 1; } if ($p_options[PCLZIP_OPT_BY_INDEX][$j]['start'] > $i) { break; } } // ----- Look for no rule, which means extract all the archive } else { $v_extract = true; } // ----- Check compression method if (($v_extract) && (($v_header['compression'] != 8) && ($v_header['compression'] != 0))) { $v_header['status'] = 'unsupported_compression'; // ----- Look for PCLZIP_OPT_STOP_ON_ERROR if ((isset($p_options[PCLZIP_OPT_STOP_ON_ERROR])) && ($p_options[PCLZIP_OPT_STOP_ON_ERROR] === true)) { $this->privSwapBackMagicQuotes(); PclZip::privErrorLog(PCLZIP_ERR_UNSUPPORTED_COMPRESSION, "Filename '" . $v_header['stored_filename'] . "' is " . "compressed by an unsupported compression " . "method (" . $v_header['compression'] . ") "); return PclZip::errorCode(); } } // ----- Check encrypted files if (($v_extract) && (($v_header['flag'] & 1) == 1)) { $v_header['status'] = 'unsupported_encryption'; // ----- Look for PCLZIP_OPT_STOP_ON_ERROR if ((isset($p_options[PCLZIP_OPT_STOP_ON_ERROR])) && ($p_options[PCLZIP_OPT_STOP_ON_ERROR] === true)) { $this->privSwapBackMagicQuotes(); PclZip::privErrorLog(PCLZIP_ERR_UNSUPPORTED_ENCRYPTION, "Unsupported encryption for " . " filename '" . $v_header['stored_filename'] . "'"); return PclZip::errorCode(); } } // ----- Look for real extraction if (($v_extract) && ($v_header['status'] != 'ok')) { $v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted++]); if ($v_result != 1) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } $v_extract = false; } // ----- Look for real extraction if ($v_extract) { // ----- Go to the file position @rewind($this->zip_fd); if (@fseek($this->zip_fd, $v_header['offset'])) { // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size'); // ----- Return return PclZip::errorCode(); } // ----- Look for extraction as string if ($p_options[PCLZIP_OPT_EXTRACT_AS_STRING]) { $v_string = ''; // ----- Extracting the file $v_result1 = $this->privExtractFileAsString($v_header, $v_string, $p_options); if ($v_result1 < 1) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result1; } // ----- Get the only interesting attributes if (($v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted])) != 1) { // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Set the file content $p_file_list[$v_nb_extracted]['content'] = $v_string; // ----- Next extracted file $v_nb_extracted++; // ----- Look for user callback abort if ($v_result1 == 2) { break; } // ----- Look for extraction in standard output } elseif ((isset($p_options[PCLZIP_OPT_EXTRACT_IN_OUTPUT])) && ($p_options[PCLZIP_OPT_EXTRACT_IN_OUTPUT])) { // ----- Extracting the file in standard output $v_result1 = $this->privExtractFileInOutput($v_header, $p_options); if ($v_result1 < 1) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result1; } // ----- Get the only interesting attributes if (($v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted++])) != 1) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Look for user callback abort if ($v_result1 == 2) { break; } // ----- Look for normal extraction } else { // ----- Extracting the file $v_result1 = $this->privExtractFile($v_header, $p_path, $p_remove_path, $p_remove_all_path, $p_options); if ($v_result1 < 1) { $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result1; } // ----- Get the only interesting attributes if (($v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted++])) != 1) { // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); return $v_result; } // ----- Look for user callback abort if ($v_result1 == 2) { break; } } } } // ----- Close the zip file $this->privCloseFd(); $this->privSwapBackMagicQuotes(); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privExtractFile() // Description : // Parameters : // Return Values : // // 1 : ... ? // PCLZIP_ERR_USER_ABORTED(2) : User ask for extraction stop in callback // -------------------------------------------------------------------------------- public function privExtractFile(&$p_entry, $p_path, $p_remove_path, $p_remove_all_path, &$p_options) { $v_result = 1; // ----- Read the file header if (($v_result = $this->privReadFileHeader($v_header)) != 1) { // ----- Return return $v_result; } // ----- Check that the file header is coherent with $p_entry info if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) { // TBC } // ----- Look for all path to remove if ($p_remove_all_path == true) { // ----- Look for folder entry that not need to be extracted if (($p_entry['external'] & 0x00000010) == 0x00000010) { $p_entry['status'] = "filtered"; return $v_result; } // ----- Get the basename of the path $p_entry['filename'] = basename($p_entry['filename']); // ----- Look for path to remove } elseif ($p_remove_path != "") { if (PclZipUtilPathInclusion($p_remove_path, $p_entry['filename']) == 2) { // ----- Change the file status $p_entry['status'] = "filtered"; // ----- Return return $v_result; } $p_remove_path_size = strlen($p_remove_path); if (substr($p_entry['filename'], 0, $p_remove_path_size) == $p_remove_path) { // ----- Remove the path $p_entry['filename'] = substr($p_entry['filename'], $p_remove_path_size); } } // ----- Add the path if ($p_path != '') { $p_entry['filename'] = $p_path . "/" . $p_entry['filename']; } // ----- Check a base_dir_restriction if (isset($p_options[PCLZIP_OPT_EXTRACT_DIR_RESTRICTION])) { $v_inclusion = PclZipUtilPathInclusion($p_options[PCLZIP_OPT_EXTRACT_DIR_RESTRICTION], $p_entry['filename']); if ($v_inclusion == 0) { PclZip::privErrorLog(PCLZIP_ERR_DIRECTORY_RESTRICTION, "Filename '" . $p_entry['filename'] . "' is " . "outside PCLZIP_OPT_EXTRACT_DIR_RESTRICTION"); return PclZip::errorCode(); } } // ----- Look for pre-extract callback if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_entry, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_PRE_EXTRACT].'(PCLZIP_CB_PRE_EXTRACT, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header); if ($v_result == 0) { // ----- Change the file status $p_entry['status'] = "skipped"; $v_result = 1; } // ----- Look for abort result if ($v_result == 2) { // ----- This status is internal and will be changed in 'skipped' $p_entry['status'] = "aborted"; $v_result = PCLZIP_ERR_USER_ABORTED; } // ----- Update the informations // Only some fields can be modified $p_entry['filename'] = $v_local_header['filename']; } // ----- Look if extraction should be done if ($p_entry['status'] == 'ok') { // ----- Look for specific actions while the file exist if (file_exists($p_entry['filename'])) { // ----- Look if file is a directory if (is_dir($p_entry['filename'])) { // ----- Change the file status $p_entry['status'] = "already_a_directory"; // ----- Look for PCLZIP_OPT_STOP_ON_ERROR // For historical reason first PclZip implementation does not stop // when this kind of error occurs. if ((isset($p_options[PCLZIP_OPT_STOP_ON_ERROR])) && ($p_options[PCLZIP_OPT_STOP_ON_ERROR] === true)) { PclZip::privErrorLog(PCLZIP_ERR_ALREADY_A_DIRECTORY, "Filename '" . $p_entry['filename'] . "' is " . "already used by an existing directory"); return PclZip::errorCode(); } // ----- Look if file is write protected } elseif (!is_writeable($p_entry['filename'])) { // ----- Change the file status $p_entry['status'] = "write_protected"; // ----- Look for PCLZIP_OPT_STOP_ON_ERROR // For historical reason first PclZip implementation does not stop // when this kind of error occurs. if ((isset($p_options[PCLZIP_OPT_STOP_ON_ERROR])) && ($p_options[PCLZIP_OPT_STOP_ON_ERROR] === true)) { PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, "Filename '" . $p_entry['filename'] . "' exists " . "and is write protected"); return PclZip::errorCode(); } // ----- Look if the extracted file is older } elseif (filemtime($p_entry['filename']) > $p_entry['mtime']) { // ----- Change the file status if ((isset($p_options[PCLZIP_OPT_REPLACE_NEWER])) && ($p_options[PCLZIP_OPT_REPLACE_NEWER] === true)) { } else { $p_entry['status'] = "newer_exist"; // ----- Look for PCLZIP_OPT_STOP_ON_ERROR // For historical reason first PclZip implementation does not stop // when this kind of error occurs. if ((isset($p_options[PCLZIP_OPT_STOP_ON_ERROR])) && ($p_options[PCLZIP_OPT_STOP_ON_ERROR] === true)) { PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, "Newer version of '" . $p_entry['filename'] . "' exists " . "and option PCLZIP_OPT_REPLACE_NEWER is not selected"); return PclZip::errorCode(); } } } else { } // ----- Check the directory availability and create it if necessary } else { if ((($p_entry['external'] & 0x00000010) == 0x00000010) || (substr($p_entry['filename'], -1) == '/')) { $v_dir_to_check = $p_entry['filename']; } elseif (!strstr($p_entry['filename'], "/")) { $v_dir_to_check = ""; } else { $v_dir_to_check = dirname($p_entry['filename']); } if (($v_result = $this->privDirCheck($v_dir_to_check, (($p_entry['external'] & 0x00000010) == 0x00000010))) != 1) { // ----- Change the file status $p_entry['status'] = "path_creation_fail"; // ----- Return //return $v_result; $v_result = 1; } } } // ----- Look if extraction should be done if ($p_entry['status'] == 'ok') { // ----- Do the extraction (if not a folder) if (!(($p_entry['external'] & 0x00000010) == 0x00000010)) { // ----- Look for not compressed file if ($p_entry['compression'] == 0) { // ----- Opening destination file if (($v_dest_file = @fopen($p_entry['filename'], 'wb')) == 0) { // ----- Change the file status $p_entry['status'] = "write_error"; // ----- Return return $v_result; } // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks $v_size = $p_entry['compressed_size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($this->zip_fd, $v_read_size); /* Try to speed up the code $v_binary_data = pack('a'.$v_read_size, $v_buffer); @fwrite($v_dest_file, $v_binary_data, $v_read_size); */ @fwrite($v_dest_file, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Closing the destination file fclose($v_dest_file); // ----- Change the file mtime touch($p_entry['filename'], $p_entry['mtime']); } else { // ----- TBC // Need to be finished if (($p_entry['flag'] & 1) == 1) { PclZip::privErrorLog(PCLZIP_ERR_UNSUPPORTED_ENCRYPTION, 'File \'' . $p_entry['filename'] . '\' is encrypted. Encrypted files are not supported.'); return PclZip::errorCode(); } // ----- Look for using temporary file to unzip if ((!isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF])) && (isset($p_options[PCLZIP_OPT_TEMP_FILE_ON]) || (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]) && ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] <= $p_entry['size'])))) { $v_result = $this->privExtractFileUsingTempFile($p_entry, $p_options); if ($v_result < PCLZIP_ERR_NO_ERROR) { return $v_result; } // ----- Look for extract in memory } else { // ----- Read the compressed file in a buffer (one shot) $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']); // ----- Decompress the file $v_file_content = @gzinflate($v_buffer); unset($v_buffer); if ($v_file_content === false) { // ----- Change the file status // TBC $p_entry['status'] = "error"; return $v_result; } // ----- Opening destination file if (($v_dest_file = @fopen($p_entry['filename'], 'wb')) == 0) { // ----- Change the file status $p_entry['status'] = "write_error"; return $v_result; } // ----- Write the uncompressed data @fwrite($v_dest_file, $v_file_content, $p_entry['size']); unset($v_file_content); // ----- Closing the destination file @fclose($v_dest_file); } // ----- Change the file mtime @touch($p_entry['filename'], $p_entry['mtime']); } // ----- Look for chmod option if (isset($p_options[PCLZIP_OPT_SET_CHMOD])) { // ----- Change the mode of the file @chmod($p_entry['filename'], $p_options[PCLZIP_OPT_SET_CHMOD]); } } } // ----- Change abort status if ($p_entry['status'] == "aborted") { $p_entry['status'] = "skipped"; // ----- Look for post-extract callback } elseif (isset($p_options[PCLZIP_CB_POST_EXTRACT])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_entry, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_POST_EXTRACT].'(PCLZIP_CB_POST_EXTRACT, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_POST_EXTRACT](PCLZIP_CB_POST_EXTRACT, $v_local_header); // ----- Look for abort result if ($v_result == 2) { $v_result = PCLZIP_ERR_USER_ABORTED; } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privExtractFileUsingTempFile() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privExtractFileUsingTempFile(&$p_entry, &$p_options) { $v_result = 1; // ----- Creates a temporary file $v_gzip_temp_name = PCLZIP_TEMPORARY_DIR . uniqid('pclzip-') . '.gz'; if (($v_dest_file = @fopen($v_gzip_temp_name, "wb")) == 0) { fclose($v_file); PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, 'Unable to open temporary file \'' . $v_gzip_temp_name . '\' in binary write mode'); return PclZip::errorCode(); } // ----- Write gz file format header $v_binary_data = pack('va1a1Va1a1', 0x8b1f, chr($p_entry['compression']), chr(0x00), time(), chr(0x00), chr(3)); @fwrite($v_dest_file, $v_binary_data, 10); // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks $v_size = $p_entry['compressed_size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($this->zip_fd, $v_read_size); //$v_binary_data = pack('a'.$v_read_size, $v_buffer); @fwrite($v_dest_file, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Write gz file format footer $v_binary_data = pack('VV', $p_entry['crc'], $p_entry['size']); @fwrite($v_dest_file, $v_binary_data, 8); // ----- Close the temporary file @fclose($v_dest_file); // ----- Opening destination file if (($v_dest_file = @fopen($p_entry['filename'], 'wb')) == 0) { $p_entry['status'] = "write_error"; return $v_result; } // ----- Open the temporary gz file if (($v_src_file = @gzopen($v_gzip_temp_name, 'rb')) == 0) { @fclose($v_dest_file); $p_entry['status'] = "read_error"; PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \'' . $v_gzip_temp_name . '\' in binary read mode'); return PclZip::errorCode(); } // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks $v_size = $p_entry['size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @gzread($v_src_file, $v_read_size); //$v_binary_data = pack('a'.$v_read_size, $v_buffer); @fwrite($v_dest_file, $v_buffer, $v_read_size); $v_size -= $v_read_size; } @fclose($v_dest_file); @gzclose($v_src_file); // ----- Delete the temporary file @unlink($v_gzip_temp_name); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privExtractFileInOutput() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privExtractFileInOutput(&$p_entry, &$p_options) { $v_result = 1; // ----- Read the file header if (($v_result = $this->privReadFileHeader($v_header)) != 1) { return $v_result; } // ----- Check that the file header is coherent with $p_entry info if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) { // TBC } // ----- Look for pre-extract callback if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_entry, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_PRE_EXTRACT].'(PCLZIP_CB_PRE_EXTRACT, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header); if ($v_result == 0) { // ----- Change the file status $p_entry['status'] = "skipped"; $v_result = 1; } // ----- Look for abort result if ($v_result == 2) { // ----- This status is internal and will be changed in 'skipped' $p_entry['status'] = "aborted"; $v_result = PCLZIP_ERR_USER_ABORTED; } // ----- Update the informations // Only some fields can be modified $p_entry['filename'] = $v_local_header['filename']; } // ----- Trace // ----- Look if extraction should be done if ($p_entry['status'] == 'ok') { // ----- Do the extraction (if not a folder) if (!(($p_entry['external'] & 0x00000010) == 0x00000010)) { // ----- Look for not compressed file if ($p_entry['compressed_size'] == $p_entry['size']) { // ----- Read the file in a buffer (one shot) $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']); // ----- Send the file to the output echo $v_buffer; unset($v_buffer); } else { // ----- Read the compressed file in a buffer (one shot) $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']); // ----- Decompress the file $v_file_content = gzinflate($v_buffer); unset($v_buffer); // ----- Send the file to the output echo $v_file_content; unset($v_file_content); } } } // ----- Change abort status if ($p_entry['status'] == "aborted") { $p_entry['status'] = "skipped"; // ----- Look for post-extract callback } elseif (isset($p_options[PCLZIP_CB_POST_EXTRACT])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_entry, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_POST_EXTRACT].'(PCLZIP_CB_POST_EXTRACT, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_POST_EXTRACT](PCLZIP_CB_POST_EXTRACT, $v_local_header); // ----- Look for abort result if ($v_result == 2) { $v_result = PCLZIP_ERR_USER_ABORTED; } } return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privExtractFileAsString() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privExtractFileAsString(&$p_entry, &$p_string, &$p_options) { $v_result = 1; // ----- Read the file header $v_header = array(); if (($v_result = $this->privReadFileHeader($v_header)) != 1) { // ----- Return return $v_result; } // ----- Check that the file header is coherent with $p_entry info if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) { // TBC } // ----- Look for pre-extract callback if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_entry, $v_local_header); // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_PRE_EXTRACT].'(PCLZIP_CB_PRE_EXTRACT, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header); if ($v_result == 0) { // ----- Change the file status $p_entry['status'] = "skipped"; $v_result = 1; } // ----- Look for abort result if ($v_result == 2) { // ----- This status is internal and will be changed in 'skipped' $p_entry['status'] = "aborted"; $v_result = PCLZIP_ERR_USER_ABORTED; } // ----- Update the informations // Only some fields can be modified $p_entry['filename'] = $v_local_header['filename']; } // ----- Look if extraction should be done if ($p_entry['status'] == 'ok') { // ----- Do the extraction (if not a folder) if (!(($p_entry['external'] & 0x00000010) == 0x00000010)) { // ----- Look for not compressed file // if ($p_entry['compressed_size'] == $p_entry['size']) if ($p_entry['compression'] == 0) { // ----- Reading the file $p_string = @fread($this->zip_fd, $p_entry['compressed_size']); } else { // ----- Reading the file $v_data = @fread($this->zip_fd, $p_entry['compressed_size']); // ----- Decompress the file if (($p_string = @gzinflate($v_data)) === false) { // TBC } } // ----- Trace } else { // TBC : error : can not extract a folder in a string } } // ----- Change abort status if ($p_entry['status'] == "aborted") { $p_entry['status'] = "skipped"; // ----- Look for post-extract callback } elseif (isset($p_options[PCLZIP_CB_POST_EXTRACT])) { // ----- Generate a local information $v_local_header = array(); $this->privConvertHeader2FileInfo($p_entry, $v_local_header); // ----- Swap the content to header $v_local_header['content'] = $p_string; $p_string = ''; // ----- Call the callback // Here I do not use call_user_func() because I need to send a reference to the // header. // eval('$v_result = '.$p_options[PCLZIP_CB_POST_EXTRACT].'(PCLZIP_CB_POST_EXTRACT, $v_local_header);'); $v_result = $p_options[PCLZIP_CB_POST_EXTRACT](PCLZIP_CB_POST_EXTRACT, $v_local_header); // ----- Swap back the content to header $p_string = $v_local_header['content']; unset($v_local_header['content']); // ----- Look for abort result if ($v_result == 2) { $v_result = PCLZIP_ERR_USER_ABORTED; } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privReadFileHeader() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privReadFileHeader(&$p_header) { $v_result = 1; // ----- Read the 4 bytes signature $v_binary_data = @fread($this->zip_fd, 4); $v_data = unpack('Vid', $v_binary_data); // ----- Check signature if ($v_data['id'] != 0x04034b50) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Invalid archive structure'); // ----- Return return PclZip::errorCode(); } // ----- Read the first 42 bytes of the header $v_binary_data = fread($this->zip_fd, 26); // ----- Look for invalid block size if (strlen($v_binary_data) != 26) { $p_header['filename'] = ""; $p_header['status'] = "invalid_header"; // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Invalid block size : " . strlen($v_binary_data)); // ----- Return return PclZip::errorCode(); } // ----- Extract the values $v_data = unpack('vversion/vflag/vcompression/vmtime/vmdate/Vcrc/Vcompressed_size/Vsize/vfilename_len/vextra_len', $v_binary_data); // ----- Get filename $p_header['filename'] = fread($this->zip_fd, $v_data['filename_len']); // ----- Get extra_fields if ($v_data['extra_len'] != 0) { $p_header['extra'] = fread($this->zip_fd, $v_data['extra_len']); } else { $p_header['extra'] = ''; } // ----- Extract properties $p_header['version_extracted'] = $v_data['version']; $p_header['compression'] = $v_data['compression']; $p_header['size'] = $v_data['size']; $p_header['compressed_size'] = $v_data['compressed_size']; $p_header['crc'] = $v_data['crc']; $p_header['flag'] = $v_data['flag']; $p_header['filename_len'] = $v_data['filename_len']; // ----- Recuperate date in UNIX format $p_header['mdate'] = $v_data['mdate']; $p_header['mtime'] = $v_data['mtime']; if ($p_header['mdate'] && $p_header['mtime']) { // ----- Extract time $v_hour = ($p_header['mtime'] & 0xF800) >> 11; $v_minute = ($p_header['mtime'] & 0x07E0) >> 5; $v_seconde = ($p_header['mtime'] & 0x001F) * 2; // ----- Extract date $v_year = (($p_header['mdate'] & 0xFE00) >> 9) + 1980; $v_month = ($p_header['mdate'] & 0x01E0) >> 5; $v_day = $p_header['mdate'] & 0x001F; // ----- Get UNIX date format $p_header['mtime'] = @mktime($v_hour, $v_minute, $v_seconde, $v_month, $v_day, $v_year); } else { $p_header['mtime'] = time(); } // TBC //for (reset($v_data); $key = key($v_data); next($v_data)) { //} // ----- Set the stored filename $p_header['stored_filename'] = $p_header['filename']; // ----- Set the status field $p_header['status'] = "ok"; // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privReadCentralFileHeader() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privReadCentralFileHeader(&$p_header) { $v_result = 1; // ----- Read the 4 bytes signature $v_binary_data = @fread($this->zip_fd, 4); $v_data = unpack('Vid', $v_binary_data); // ----- Check signature if ($v_data['id'] != 0x02014b50) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Invalid archive structure'); // ----- Return return PclZip::errorCode(); } // ----- Read the first 42 bytes of the header $v_binary_data = fread($this->zip_fd, 42); // ----- Look for invalid block size if (strlen($v_binary_data) != 42) { $p_header['filename'] = ""; $p_header['status'] = "invalid_header"; // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Invalid block size : " . strlen($v_binary_data)); // ----- Return return PclZip::errorCode(); } // ----- Extract the values $p_header = unpack('vversion/vversion_extracted/vflag/vcompression/vmtime/vmdate/Vcrc/Vcompressed_size/Vsize/vfilename_len/vextra_len/vcomment_len/vdisk/vinternal/Vexternal/Voffset', $v_binary_data); // ----- Get filename if ($p_header['filename_len'] != 0) { $p_header['filename'] = fread($this->zip_fd, $p_header['filename_len']); } else { $p_header['filename'] = ''; } // ----- Get extra if ($p_header['extra_len'] != 0) { $p_header['extra'] = fread($this->zip_fd, $p_header['extra_len']); } else { $p_header['extra'] = ''; } // ----- Get comment if ($p_header['comment_len'] != 0) { $p_header['comment'] = fread($this->zip_fd, $p_header['comment_len']); } else { $p_header['comment'] = ''; } // ----- Extract properties // ----- Recuperate date in UNIX format //if ($p_header['mdate'] && $p_header['mtime']) // TBC : bug : this was ignoring time with 0/0/0 if (1) { // ----- Extract time $v_hour = ($p_header['mtime'] & 0xF800) >> 11; $v_minute = ($p_header['mtime'] & 0x07E0) >> 5; $v_seconde = ($p_header['mtime'] & 0x001F) * 2; // ----- Extract date $v_year = (($p_header['mdate'] & 0xFE00) >> 9) + 1980; $v_month = ($p_header['mdate'] & 0x01E0) >> 5; $v_day = $p_header['mdate'] & 0x001F; // ----- Get UNIX date format $p_header['mtime'] = @mktime($v_hour, $v_minute, $v_seconde, $v_month, $v_day, $v_year); } else { $p_header['mtime'] = time(); } // ----- Set the stored filename $p_header['stored_filename'] = $p_header['filename']; // ----- Set default status to ok $p_header['status'] = 'ok'; // ----- Look if it is a directory if (substr($p_header['filename'], -1) == '/') { //$p_header['external'] = 0x41FF0010; $p_header['external'] = 0x00000010; } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privCheckFileHeaders() // Description : // Parameters : // Return Values : // 1 on success, // 0 on error; // -------------------------------------------------------------------------------- public function privCheckFileHeaders(&$p_local_header, &$p_central_header) { $v_result = 1; // ----- Check the static values // TBC if ($p_local_header['filename'] != $p_central_header['filename']) { } if ($p_local_header['version_extracted'] != $p_central_header['version_extracted']) { } if ($p_local_header['flag'] != $p_central_header['flag']) { } if ($p_local_header['compression'] != $p_central_header['compression']) { } if ($p_local_header['mtime'] != $p_central_header['mtime']) { } if ($p_local_header['filename_len'] != $p_central_header['filename_len']) { } // ----- Look for flag bit 3 if (($p_local_header['flag'] & 8) == 8) { $p_local_header['size'] = $p_central_header['size']; $p_local_header['compressed_size'] = $p_central_header['compressed_size']; $p_local_header['crc'] = $p_central_header['crc']; } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privReadEndCentralDir() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privReadEndCentralDir(&$p_central_dir) { $v_result = 1; // ----- Go to the end of the zip file $v_size = filesize($this->zipname); @fseek($this->zip_fd, $v_size); if (@ftell($this->zip_fd) != $v_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Unable to go to the end of the archive \'' . $this->zipname . '\''); // ----- Return return PclZip::errorCode(); } // ----- First try : look if this is an archive with no commentaries (most of the time) // in this case the end of central dir is at 22 bytes of the file end $v_found = 0; if ($v_size > 26) { @fseek($this->zip_fd, $v_size - 22); if (($v_pos = @ftell($this->zip_fd)) != ($v_size - 22)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Unable to seek back to the middle of the archive \'' . $this->zipname . '\''); // ----- Return return PclZip::errorCode(); } // ----- Read for bytes $v_binary_data = @fread($this->zip_fd, 4); $v_data = @unpack('Vid', $v_binary_data); // ----- Check signature if ($v_data['id'] == 0x06054b50) { $v_found = 1; } $v_pos = ftell($this->zip_fd); } // ----- Go back to the maximum possible size of the Central Dir End Record if (!$v_found) { $v_maximum_size = 65557; // 0xFFFF + 22; if ($v_maximum_size > $v_size) { $v_maximum_size = $v_size; } @fseek($this->zip_fd, $v_size - $v_maximum_size); if (@ftell($this->zip_fd) != ($v_size - $v_maximum_size)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Unable to seek back to the middle of the archive \'' . $this->zipname . '\''); // ----- Return return PclZip::errorCode(); } // ----- Read byte per byte in order to find the signature $v_pos = ftell($this->zip_fd); $v_bytes = 0x00000000; while ($v_pos < $v_size) { // ----- Read a byte $v_byte = @fread($this->zip_fd, 1); // ----- Add the byte //$v_bytes = ($v_bytes << 8) | Ord($v_byte); // Note we mask the old value down such that once shifted we can never end up with more than a 32bit number // Otherwise on systems where we have 64bit integers the check below for the magic number will fail. $v_bytes = (($v_bytes & 0xFFFFFF) << 8) | ord($v_byte); // ----- Compare the bytes if ($v_bytes == 0x504b0506) { $v_pos++; break; } $v_pos++; } // ----- Look if not found end of central dir if ($v_pos == $v_size) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Unable to find End of Central Dir Record signature"); // ----- Return return PclZip::errorCode(); } } // ----- Read the first 18 bytes of the header $v_binary_data = fread($this->zip_fd, 18); // ----- Look for invalid block size if (strlen($v_binary_data) != 18) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Invalid End of Central Dir Record size : " . strlen($v_binary_data)); // ----- Return return PclZip::errorCode(); } // ----- Extract the values $v_data = unpack('vdisk/vdisk_start/vdisk_entries/ventries/Vsize/Voffset/vcomment_size', $v_binary_data); // ----- Check the global size if (($v_pos + $v_data['comment_size'] + 18) != $v_size) { // ----- Removed in release 2.2 see readme file // The check of the file size is a little too strict. // Some bugs where found when a zip is encrypted/decrypted with 'crypt'. // While decrypted, zip has training 0 bytes if (0) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'The central dir is not at the end of the archive.' . ' Some trailing bytes exists after the archive.'); // ----- Return return PclZip::errorCode(); } } // ----- Get comment if ($v_data['comment_size'] != 0) { $p_central_dir['comment'] = fread($this->zip_fd, $v_data['comment_size']); } else { $p_central_dir['comment'] = ''; } $p_central_dir['entries'] = $v_data['entries']; $p_central_dir['disk_entries'] = $v_data['disk_entries']; $p_central_dir['offset'] = $v_data['offset']; $p_central_dir['size'] = $v_data['size']; $p_central_dir['disk'] = $v_data['disk']; $p_central_dir['disk_start'] = $v_data['disk_start']; // TBC //for (reset($p_central_dir); $key = key($p_central_dir); next($p_central_dir)) { //} // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privDeleteByRule() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privDeleteByRule(&$p_result_list, &$p_options) { $v_result = 1; $v_list_detail = array(); // ----- Open the zip file if (($v_result = $this->privOpenFd('rb')) != 1) { // ----- Return return $v_result; } // ----- Read the central directory informations $v_central_dir = array(); if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1) { $this->privCloseFd(); return $v_result; } // ----- Go to beginning of File @rewind($this->zip_fd); // ----- Scan all the files // ----- Start at beginning of Central Dir $v_pos_entry = $v_central_dir['offset']; @rewind($this->zip_fd); if (@fseek($this->zip_fd, $v_pos_entry)) { // ----- Close the zip file $this->privCloseFd(); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size'); // ----- Return return PclZip::errorCode(); } // ----- Read each entry $v_header_list = array(); $j_start = 0; for ($i = 0, $v_nb_extracted = 0; $i < $v_central_dir['entries']; $i++) { // ----- Read the file header $v_header_list[$v_nb_extracted] = array(); if (($v_result = $this->privReadCentralFileHeader($v_header_list[$v_nb_extracted])) != 1) { // ----- Close the zip file $this->privCloseFd(); return $v_result; } // ----- Store the index $v_header_list[$v_nb_extracted]['index'] = $i; // ----- Look for the specific extract rules $v_found = false; // ----- Look for extract by name rule if ((isset($p_options[PCLZIP_OPT_BY_NAME])) && ($p_options[PCLZIP_OPT_BY_NAME] != 0)) { // ----- Look if the filename is in the list for ($j = 0; ($j < sizeof($p_options[PCLZIP_OPT_BY_NAME])) && (!$v_found); $j++) { // ----- Look for a directory if (substr($p_options[PCLZIP_OPT_BY_NAME][$j], -1) == "/") { // ----- Look if the directory is in the filename path if ((strlen($v_header_list[$v_nb_extracted]['stored_filename']) > strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) && (substr($v_header_list[$v_nb_extracted]['stored_filename'], 0, strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) == $p_options[PCLZIP_OPT_BY_NAME][$j])) { $v_found = true; } elseif ((($v_header_list[$v_nb_extracted]['external'] & 0x00000010) == 0x00000010) /* Indicates a folder */ && ($v_header_list[$v_nb_extracted]['stored_filename'] . '/' == $p_options[PCLZIP_OPT_BY_NAME][$j])) { $v_found = true; } // ----- Look for a filename } elseif ($v_header_list[$v_nb_extracted]['stored_filename'] == $p_options[PCLZIP_OPT_BY_NAME][$j]) { $v_found = true; } } // ----- Look for extract by preg rule } elseif ((isset($p_options[PCLZIP_OPT_BY_PREG])) && ($p_options[PCLZIP_OPT_BY_PREG] != "")) { if (preg_match($p_options[PCLZIP_OPT_BY_PREG], $v_header_list[$v_nb_extracted]['stored_filename'])) { $v_found = true; } // ----- Look for extract by index rule } elseif ((isset($p_options[PCLZIP_OPT_BY_INDEX])) && ($p_options[PCLZIP_OPT_BY_INDEX] != 0)) { // ----- Look if the index is in the list for ($j = $j_start; ($j < sizeof($p_options[PCLZIP_OPT_BY_INDEX])) && (!$v_found); $j++) { if (($i >= $p_options[PCLZIP_OPT_BY_INDEX][$j]['start']) && ($i <= $p_options[PCLZIP_OPT_BY_INDEX][$j]['end'])) { $v_found = true; } if ($i >= $p_options[PCLZIP_OPT_BY_INDEX][$j]['end']) { $j_start = $j + 1; } if ($p_options[PCLZIP_OPT_BY_INDEX][$j]['start'] > $i) { break; } } } else { $v_found = true; } // ----- Look for deletion if ($v_found) { unset($v_header_list[$v_nb_extracted]); } else { $v_nb_extracted++; } } // ----- Look if something need to be deleted if ($v_nb_extracted > 0) { // ----- Creates a temporay file $v_zip_temp_name = PCLZIP_TEMPORARY_DIR . uniqid('pclzip-') . '.tmp'; // ----- Creates a temporary zip archive $v_temp_zip = new PclZip($v_zip_temp_name); // ----- Open the temporary zip file in write mode if (($v_result = $v_temp_zip->privOpenFd('wb')) != 1) { $this->privCloseFd(); // ----- Return return $v_result; } // ----- Look which file need to be kept for ($i = 0; $i < sizeof($v_header_list); $i++) { // ----- Calculate the position of the header @rewind($this->zip_fd); if (@fseek($this->zip_fd, $v_header_list[$i]['offset'])) { // ----- Close the zip file $this->privCloseFd(); $v_temp_zip->privCloseFd(); @unlink($v_zip_temp_name); // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size'); // ----- Return return PclZip::errorCode(); } // ----- Read the file header $v_local_header = array(); if (($v_result = $this->privReadFileHeader($v_local_header)) != 1) { // ----- Close the zip file $this->privCloseFd(); $v_temp_zip->privCloseFd(); @unlink($v_zip_temp_name); // ----- Return return $v_result; } // ----- Check that local file header is same as central file header if ($this->privCheckFileHeaders($v_local_header, $v_header_list[$i]) != 1) { // TBC } unset($v_local_header); // ----- Write the file header if (($v_result = $v_temp_zip->privWriteFileHeader($v_header_list[$i])) != 1) { // ----- Close the zip file $this->privCloseFd(); $v_temp_zip->privCloseFd(); @unlink($v_zip_temp_name); // ----- Return return $v_result; } // ----- Read/write the data block if (($v_result = PclZipUtilCopyBlock($this->zip_fd, $v_temp_zip->zip_fd, $v_header_list[$i]['compressed_size'])) != 1) { // ----- Close the zip file $this->privCloseFd(); $v_temp_zip->privCloseFd(); @unlink($v_zip_temp_name); // ----- Return return $v_result; } } // ----- Store the offset of the central dir $v_offset = @ftell($v_temp_zip->zip_fd); // ----- Re-Create the Central Dir files header for ($i = 0; $i < sizeof($v_header_list); $i++) { // ----- Create the file header if (($v_result = $v_temp_zip->privWriteCentralFileHeader($v_header_list[$i])) != 1) { $v_temp_zip->privCloseFd(); $this->privCloseFd(); @unlink($v_zip_temp_name); // ----- Return return $v_result; } // ----- Transform the header to a 'usable' info $v_temp_zip->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]); } // ----- Zip file comment $v_comment = ''; if (isset($p_options[PCLZIP_OPT_COMMENT])) { $v_comment = $p_options[PCLZIP_OPT_COMMENT]; } // ----- Calculate the size of the central header $v_size = @ftell($v_temp_zip->zip_fd) - $v_offset; // ----- Create the central dir footer if (($v_result = $v_temp_zip->privWriteCentralHeader(sizeof($v_header_list), $v_size, $v_offset, $v_comment)) != 1) { // ----- Reset the file list unset($v_header_list); $v_temp_zip->privCloseFd(); $this->privCloseFd(); @unlink($v_zip_temp_name); // ----- Return return $v_result; } // ----- Close $v_temp_zip->privCloseFd(); $this->privCloseFd(); // ----- Delete the zip file // TBC : I should test the result ... @unlink($this->zipname); // ----- Rename the temporary file // TBC : I should test the result ... //@rename($v_zip_temp_name, $this->zipname); PclZipUtilRename($v_zip_temp_name, $this->zipname); // ----- Destroy the temporary archive unset($v_temp_zip); // ----- Remove every files : reset the file } elseif ($v_central_dir['entries'] != 0) { $this->privCloseFd(); if (($v_result = $this->privOpenFd('wb')) != 1) { return $v_result; } if (($v_result = $this->privWriteCentralHeader(0, 0, 0, '')) != 1) { return $v_result; } $this->privCloseFd(); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privDirCheck() // Description : // Check if a directory exists, if not it creates it and all the parents directory // which may be useful. // Parameters : // $p_dir : Directory path to check. // Return Values : // 1 : OK // -1 : Unable to create directory // -------------------------------------------------------------------------------- public function privDirCheck($p_dir, $p_is_dir = false) { $v_result = 1; // ----- Remove the final '/' if (($p_is_dir) && (substr($p_dir, -1) == '/')) { $p_dir = substr($p_dir, 0, strlen($p_dir) - 1); } // ----- Check the directory availability if ((is_dir($p_dir)) || ($p_dir == "")) { return 1; } // ----- Extract parent directory $p_parent_dir = dirname($p_dir); // ----- Just a check if ($p_parent_dir != $p_dir) { // ----- Look for parent directory if ($p_parent_dir != "") { if (($v_result = $this->privDirCheck($p_parent_dir)) != 1) { return $v_result; } } } // ----- Create the directory if (!@mkdir($p_dir, 0777)) { // ----- Error log PclZip::privErrorLog(PCLZIP_ERR_DIR_CREATE_FAIL, "Unable to create directory '$p_dir'"); // ----- Return return PclZip::errorCode(); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privMerge() // Description : // If $p_archive_to_add does not exist, the function exit with a success result. // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privMerge(&$p_archive_to_add) { $v_result = 1; // ----- Look if the archive_to_add exists if (!is_file($p_archive_to_add->zipname)) { // ----- Nothing to merge, so merge is a success $v_result = 1; // ----- Return return $v_result; } // ----- Look if the archive exists if (!is_file($this->zipname)) { // ----- Do a duplicate $v_result = $this->privDuplicate($p_archive_to_add->zipname); // ----- Return return $v_result; } // ----- Open the zip file if (($v_result = $this->privOpenFd('rb')) != 1) { // ----- Return return $v_result; } // ----- Read the central directory informations $v_central_dir = array(); if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1) { $this->privCloseFd(); return $v_result; } // ----- Go to beginning of File @rewind($this->zip_fd); // ----- Open the archive_to_add file if (($v_result = $p_archive_to_add->privOpenFd('rb')) != 1) { $this->privCloseFd(); // ----- Return return $v_result; } // ----- Read the central directory informations $v_central_dir_to_add = array(); if (($v_result = $p_archive_to_add->privReadEndCentralDir($v_central_dir_to_add)) != 1) { $this->privCloseFd(); $p_archive_to_add->privCloseFd(); return $v_result; } // ----- Go to beginning of File @rewind($p_archive_to_add->zip_fd); // ----- Creates a temporay file $v_zip_temp_name = PCLZIP_TEMPORARY_DIR . uniqid('pclzip-') . '.tmp'; // ----- Open the temporary file in write mode if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0) { $this->privCloseFd(); $p_archive_to_add->privCloseFd(); PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \'' . $v_zip_temp_name . '\' in binary write mode'); // ----- Return return PclZip::errorCode(); } // ----- Copy the files from the archive to the temporary file // TBC : Here I should better append the file and go back to erase the central dir $v_size = $v_central_dir['offset']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = fread($this->zip_fd, $v_read_size); @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Copy the files from the archive_to_add into the temporary file $v_size = $v_central_dir_to_add['offset']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = fread($p_archive_to_add->zip_fd, $v_read_size); @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Store the offset of the central dir $v_offset = @ftell($v_zip_temp_fd); // ----- Copy the block of file headers from the old archive $v_size = $v_central_dir['size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($this->zip_fd, $v_read_size); @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Copy the block of file headers from the archive_to_add $v_size = $v_central_dir_to_add['size']; while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($p_archive_to_add->zip_fd, $v_read_size); @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Merge the file comments $v_comment = $v_central_dir['comment'] . ' ' . $v_central_dir_to_add['comment']; // ----- Calculate the size of the (new) central header $v_size = @ftell($v_zip_temp_fd) - $v_offset; // ----- Swap the file descriptor // Here is a trick : I swap the temporary fd with the zip fd, in order to use // the following methods on the temporary fil and not the real archive fd $v_swap = $this->zip_fd; $this->zip_fd = $v_zip_temp_fd; $v_zip_temp_fd = $v_swap; // ----- Create the central dir footer if (($v_result = $this->privWriteCentralHeader($v_central_dir['entries'] + $v_central_dir_to_add['entries'], $v_size, $v_offset, $v_comment)) != 1) { $this->privCloseFd(); $p_archive_to_add->privCloseFd(); @fclose($v_zip_temp_fd); $this->zip_fd = null; // ----- Reset the file list unset($v_header_list); // ----- Return return $v_result; } // ----- Swap back the file descriptor $v_swap = $this->zip_fd; $this->zip_fd = $v_zip_temp_fd; $v_zip_temp_fd = $v_swap; // ----- Close $this->privCloseFd(); $p_archive_to_add->privCloseFd(); // ----- Close the temporary file @fclose($v_zip_temp_fd); // ----- Delete the zip file // TBC : I should test the result ... @unlink($this->zipname); // ----- Rename the temporary file // TBC : I should test the result ... //@rename($v_zip_temp_name, $this->zipname); PclZipUtilRename($v_zip_temp_name, $this->zipname); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privDuplicate() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privDuplicate($p_archive_filename) { $v_result = 1; // ----- Look if the $p_archive_filename exists if (!is_file($p_archive_filename)) { // ----- Nothing to duplicate, so duplicate is a success. $v_result = 1; // ----- Return return $v_result; } // ----- Open the zip file if (($v_result = $this->privOpenFd('wb')) != 1) { // ----- Return return $v_result; } // ----- Open the temporary file in write mode if (($v_zip_temp_fd = @fopen($p_archive_filename, 'rb')) == 0) { $this->privCloseFd(); PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive file \'' . $p_archive_filename . '\' in binary write mode'); // ----- Return return PclZip::errorCode(); } // ----- Copy the files from the archive to the temporary file // TBC : Here I should better append the file and go back to erase the central dir $v_size = filesize($p_archive_filename); while ($v_size != 0) { $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = fread($v_zip_temp_fd, $v_read_size); @fwrite($this->zip_fd, $v_buffer, $v_read_size); $v_size -= $v_read_size; } // ----- Close $this->privCloseFd(); // ----- Close the temporary file @fclose($v_zip_temp_fd); // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privErrorLog() // Description : // Parameters : // -------------------------------------------------------------------------------- public function privErrorLog($p_error_code = 0, $p_error_string = '') { if (PCLZIP_ERROR_EXTERNAL == 1) { PclError($p_error_code, $p_error_string); } else { $this->error_code = $p_error_code; $this->error_string = $p_error_string; } } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privErrorReset() // Description : // Parameters : // -------------------------------------------------------------------------------- public function privErrorReset() { if (PCLZIP_ERROR_EXTERNAL == 1) { PclErrorReset(); } else { $this->error_code = 0; $this->error_string = ''; } } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privDisableMagicQuotes() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privDisableMagicQuotes() { $v_result = 1; // ----- Look if function exists if ((!function_exists("get_magic_quotes_runtime")) || (!function_exists("set_magic_quotes_runtime"))) { return $v_result; } // ----- Look if already done if ($this->magic_quotes_status != -1) { return $v_result; } // ----- Get and memorize the magic_quote value $this->magic_quotes_status = @get_magic_quotes_runtime(); // ----- Disable magic_quotes if ($this->magic_quotes_status == 1) { @set_magic_quotes_runtime(0); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : privSwapBackMagicQuotes() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- public function privSwapBackMagicQuotes() { $v_result = 1; // ----- Look if function exists if ((!function_exists("get_magic_quotes_runtime")) || (!function_exists("set_magic_quotes_runtime"))) { return $v_result; } // ----- Look if something to do if ($this->magic_quotes_status != -1) { return $v_result; } // ----- Swap back magic_quotes if ($this->magic_quotes_status == 1) { @set_magic_quotes_runtime($this->magic_quotes_status); } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- } // End of class // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : PclZipUtilPathReduction() // Description : // Parameters : // Return Values : // -------------------------------------------------------------------------------- function PclZipUtilPathReduction($p_dir) { $v_result = ""; // ----- Look for not empty path if ($p_dir != "") { // ----- Explode path by directory names $v_list = explode("/", $p_dir); // ----- Study directories from last to first $v_skip = 0; for ($i = sizeof($v_list) - 1; $i >= 0; $i--) { // ----- Look for current path if ($v_list[$i] == ".") { // ----- Ignore this directory // Should be the first $i=0, but no check is done } elseif ($v_list[$i] == "..") { $v_skip++; } elseif ($v_list[$i] == "") { // ----- First '/' i.e. root slash if ($i == 0) { $v_result = "/" . $v_result; if ($v_skip > 0) { // ----- It is an invalid path, so the path is not modified // TBC $v_result = $p_dir; $v_skip = 0; } // ----- Last '/' i.e. indicates a directory } elseif ($i == (sizeof($v_list) - 1)) { $v_result = $v_list[$i]; // ----- Double '/' inside the path } else { // ----- Ignore only the double '//' in path, // but not the first and last '/' } } else { // ----- Look for item to skip if ($v_skip > 0) { $v_skip--; } else { $v_result = $v_list[$i] . ($i != (sizeof($v_list) - 1) ? "/" . $v_result : ""); } } } // ----- Look for skip if ($v_skip > 0) { while ($v_skip > 0) { $v_result = '../' . $v_result; $v_skip--; } } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : PclZipUtilPathInclusion() // Description : // This function indicates if the path $p_path is under the $p_dir tree. Or, // said in an other way, if the file or sub-dir $p_path is inside the dir // $p_dir. // The function indicates also if the path is exactly the same as the dir. // This function supports path with duplicated '/' like '//', but does not // support '.' or '..' statements. // Parameters : // Return Values : // 0 if $p_path is not inside directory $p_dir // 1 if $p_path is inside directory $p_dir // 2 if $p_path is exactly the same as $p_dir // -------------------------------------------------------------------------------- function PclZipUtilPathInclusion($p_dir, $p_path) { $v_result = 1; // ----- Look for path beginning by ./ if (($p_dir == '.') || ((strlen($p_dir) >= 2) && (substr($p_dir, 0, 2) == './'))) { $p_dir = PclZipUtilTranslateWinPath(getcwd(), false) . '/' . substr($p_dir, 1); } if (($p_path == '.') || ((strlen($p_path) >= 2) && (substr($p_path, 0, 2) == './'))) { $p_path = PclZipUtilTranslateWinPath(getcwd(), false) . '/' . substr($p_path, 1); } // ----- Explode dir and path by directory separator $v_list_dir = explode("/", $p_dir); $v_list_dir_size = sizeof($v_list_dir); $v_list_path = explode("/", $p_path); $v_list_path_size = sizeof($v_list_path); // ----- Study directories paths $i = 0; $j = 0; while (($i < $v_list_dir_size) && ($j < $v_list_path_size) && ($v_result)) { // ----- Look for empty dir (path reduction) if ($v_list_dir[$i] == '') { $i++; continue; } if ($v_list_path[$j] == '') { $j++; continue; } // ----- Compare the items if (($v_list_dir[$i] != $v_list_path[$j]) && ($v_list_dir[$i] != '') && ($v_list_path[$j] != '')) { $v_result = 0; } // ----- Next items $i++; $j++; } // ----- Look if everything seems to be the same if ($v_result) { // ----- Skip all the empty items while (($j < $v_list_path_size) && ($v_list_path[$j] == '')) { $j++; } while (($i < $v_list_dir_size) && ($v_list_dir[$i] == '')) { $i++; } if (($i >= $v_list_dir_size) && ($j >= $v_list_path_size)) { // ----- There are exactly the same $v_result = 2; } elseif ($i < $v_list_dir_size) { // ----- The path is shorter than the dir $v_result = 0; } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : PclZipUtilCopyBlock() // Description : // Parameters : // $p_mode : read/write compression mode // 0 : src & dest normal // 1 : src gzip, dest normal // 2 : src normal, dest gzip // 3 : src & dest gzip // Return Values : // -------------------------------------------------------------------------------- function PclZipUtilCopyBlock($p_src, $p_dest, $p_size, $p_mode = 0) { $v_result = 1; if ($p_mode == 0) { while ($p_size != 0) { $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($p_src, $v_read_size); @fwrite($p_dest, $v_buffer, $v_read_size); $p_size -= $v_read_size; } } elseif ($p_mode == 1) { while ($p_size != 0) { $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @gzread($p_src, $v_read_size); @fwrite($p_dest, $v_buffer, $v_read_size); $p_size -= $v_read_size; } } elseif ($p_mode == 2) { while ($p_size != 0) { $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @fread($p_src, $v_read_size); @gzwrite($p_dest, $v_buffer, $v_read_size); $p_size -= $v_read_size; } } elseif ($p_mode == 3) { while ($p_size != 0) { $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE); $v_buffer = @gzread($p_src, $v_read_size); @gzwrite($p_dest, $v_buffer, $v_read_size); $p_size -= $v_read_size; } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : PclZipUtilRename() // Description : // This function tries to do a simple rename() function. If it fails, it // tries to copy the $p_src file in a new $p_dest file and then unlink the // first one. // Parameters : // $p_src : Old filename // $p_dest : New filename // Return Values : // 1 on success, 0 on failure. // -------------------------------------------------------------------------------- function PclZipUtilRename($p_src, $p_dest) { $v_result = 1; // ----- Try to rename the files if (!@rename($p_src, $p_dest)) { // ----- Try to copy & unlink the src if (!@copy($p_src, $p_dest)) { $v_result = 0; } elseif (!@unlink($p_src)) { $v_result = 0; } } // ----- Return return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : PclZipUtilOptionText() // Description : // Translate option value in text. Mainly for debug purpose. // Parameters : // $p_option : the option value. // Return Values : // The option text value. // -------------------------------------------------------------------------------- function PclZipUtilOptionText($p_option) { $v_list = get_defined_constants(); for (reset($v_list); $v_key = key($v_list); next($v_list)) { $v_prefix = substr($v_key, 0, 10); if ((($v_prefix == 'PCLZIP_OPT') || ($v_prefix == 'PCLZIP_CB_') || ($v_prefix == 'PCLZIP_ATT')) && ($v_list[$v_key] == $p_option)) { return $v_key; } } $v_result = 'Unknown'; return $v_result; } // -------------------------------------------------------------------------------- // -------------------------------------------------------------------------------- // Function : PclZipUtilTranslateWinPath() // Description : // Translate windows path by replacing '\' by '/' and optionally removing // drive letter. // Parameters : // $p_path : path to translate. // $p_remove_disk_letter : true | false // Return Values : // The path translated. // -------------------------------------------------------------------------------- function PclZipUtilTranslateWinPath($p_path, $p_remove_disk_letter = true) { if (stristr(php_uname(), 'windows')) { // ----- Look for potential disk letter if (($p_remove_disk_letter) && (($v_position = strpos($p_path, ':')) != false)) { $p_path = substr($p_path, $v_position + 1); } // ----- Change potential windows directory separator if ((strpos($p_path, '\\') > 0) || (substr($p_path, 0, 1) == '\\')) { $p_path = strtr($p_path, '\\', '/'); } } return $p_path; } // -------------------------------------------------------------------------------- ================================================ FILE: src/PhpWord/Shared/Text.php ================================================ ) * element or in the shared string element. * * @param string $value Value to escape * * @return string */ public static function controlCharacterPHP2OOXML($value = '') { if (empty(self::$controlCharacters)) { self::buildControlCharacters(); } return str_replace(array_values(self::$controlCharacters), array_keys(self::$controlCharacters), $value); } /** * Return a number formatted for being integrated in xml files. * * @param float $number * @param int $decimals * * @return string */ public static function numberFormat($number, $decimals) { return number_format($number, $decimals, '.', ''); } /** * @param int $dec * * @see http://stackoverflow.com/a/7153133/2235790 * * @author velcrow * * @return string */ public static function chr($dec) { if ($dec <= 0x7F) { return chr($dec); } if ($dec <= 0x7FF) { return chr(($dec >> 6) + 192) . chr(($dec & 63) + 128); } if ($dec <= 0xFFFF) { return chr(($dec >> 12) + 224) . chr((($dec >> 6) & 63) + 128) . chr(($dec & 63) + 128); } if ($dec <= 0x1FFFFF) { return chr(($dec >> 18) + 240) . chr((($dec >> 12) & 63) + 128) . chr((($dec >> 6) & 63) + 128) . chr(($dec & 63) + 128); } return ''; } /** * Convert from OpenXML escaped control character to PHP control character. * * @param string $value Value to unescape * * @return string */ public static function controlCharacterOOXML2PHP($value = '') { if (empty(self::$controlCharacters)) { self::buildControlCharacters(); } return str_replace(array_keys(self::$controlCharacters), array_values(self::$controlCharacters), $value); } /** * Check if a string contains UTF-8 data. * * @param string $value * * @return bool */ public static function isUTF8($value = '') { return is_string($value) && ($value === '' || preg_match('/^./su', $value) == 1); } /** * Return UTF8 encoded value. * * @param null|string $value * * @return ?string */ public static function toUTF8($value = '') { if (null !== $value && !self::isUTF8($value)) { // PHP8.2 : utf8_encode is deprecated, but mb_convert_encoding always usable $value = (function_exists('mb_convert_encoding')) ? mb_convert_encoding($value, 'UTF-8', 'ISO-8859-1') : utf8_encode($value); if ($value === false) { throw new Exception('Unable to convert text to UTF-8'); } } return $value; } /** * Returns unicode from UTF8 text. * * The function is splitted to reduce cyclomatic complexity * * @param string $text UTF8 text * * @return string Unicode text * * @since 0.11.0 */ public static function toUnicode($text) { return self::unicodeToEntities(self::utf8ToUnicode($text)); } /** * Returns unicode array from UTF8 text. * * @param string $text UTF8 text * * @return array * * @since 0.11.0 * @see http://www.randomchaos.com/documents/?source=php_and_unicode */ public static function utf8ToUnicode($text) { $unicode = []; $values = []; $lookingFor = 1; // Gets unicode for each character for ($i = 0; $i < strlen($text); ++$i) { $thisValue = ord($text[$i]); if ($thisValue < 128) { $unicode[] = $thisValue; } else { if (count($values) == 0) { $lookingFor = $thisValue < 224 ? 2 : 3; } $values[] = $thisValue; if (count($values) == $lookingFor) { if ($lookingFor == 3) { $number = (($values[0] % 16) * 4096) + (($values[1] % 64) * 64) + ($values[2] % 64); } else { $number = (($values[0] % 32) * 64) + ($values[1] % 64); } $unicode[] = $number; $values = []; $lookingFor = 1; } } } return $unicode; } /** * Returns entites from unicode array. * * @param array $unicode * * @return string * * @since 0.11.0 * @see http://www.randomchaos.com/documents/?source=php_and_unicode */ private static function unicodeToEntities($unicode) { $entities = ''; foreach ($unicode as $value) { if ($value != 65279) { $entities .= $value > 127 ? '\uc0{\u' . $value . '}' : chr($value); } } return $entities; } /** * Return name without underscore for < 0.10.0 variable name compatibility. * * @param string $value * * @return string */ public static function removeUnderscorePrefix($value) { if (null !== $value) { if (substr($value, 0, 1) == '_') { $value = substr($value, 1); } } return $value; } } ================================================ FILE: src/PhpWord/Shared/Validate.php ================================================ open($zipFile); if ($openStatus !== true) { /** * Throw an exception since making further calls on the ZipArchive would cause a fatal error. * This prevents fatal errors on corrupt archives and attempts to open old "doc" files. */ throw new Exception("The archive failed to load with the following error code: $openStatus"); } $content = $zip->getFromName(ltrim($xmlFile, '/')); $zip->close(); if ($content === false) { return false; } return $this->getDomFromString($content); } /** * Get DOMDocument from content string. * * @param string $content * * @return DOMDocument */ public function getDomFromString($content) { if (\PHP_VERSION_ID < 80000) { $originalLibXMLEntityValue = libxml_disable_entity_loader(true); } $this->dom = new DOMDocument(); $this->dom->loadXML($content); if (\PHP_VERSION_ID < 80000) { libxml_disable_entity_loader($originalLibXMLEntityValue); } return $this->dom; } /** * Get elements. * * @param string $path * * @return DOMNodeList */ public function getElements($path, ?DOMElement $contextNode = null) { if ($this->dom === null) { return new DOMNodeList(); // @phpstan-ignore-line } if ($this->xpath === null) { $this->xpath = new DOMXpath($this->dom); } $result = @$this->xpath->query($path, $contextNode); return empty($result) ? new DOMNodeList() : $result; // @phpstan-ignore-line } /** * Registers the namespace with the DOMXPath object. * * @param string $prefix The prefix * @param string $namespaceURI The URI of the namespace * * @return bool true on success or false on failure */ public function registerNamespace($prefix, $namespaceURI) { if ($this->dom === null) { throw new InvalidArgumentException('Dom needs to be loaded before registering a namespace'); } if ($this->xpath === null) { $this->xpath = new DOMXpath($this->dom); } return $this->xpath->registerNamespace($prefix, $namespaceURI); } /** * Get element. * * @param string $path * * @return null|DOMElement */ public function getElement($path, ?DOMElement $contextNode = null) { $elements = $this->getElements($path, $contextNode); if ($elements->length > 0) { return $elements->item(0); } return null; } /** * Get element attribute. * * @param string $attribute * @param string $path * * @return null|string */ public function getAttribute($attribute, ?DOMElement $contextNode = null, $path = null) { $return = null; if ($path !== null) { $elements = $this->getElements($path, $contextNode); if ($elements->length > 0) { /** @var DOMElement $node Type hint */ $node = $elements->item(0); $return = $node->getAttribute($attribute); } } else { if ($contextNode !== null) { $return = $contextNode->getAttribute($attribute); } } return ($return == '') ? null : $return; } /** * Get element value. * * @param string $path * * @return null|string */ public function getValue($path, ?DOMElement $contextNode = null) { $elements = $this->getElements($path, $contextNode); if ($elements->length > 0) { return $elements->item(0)->nodeValue; } return null; } /** * Count elements. * * @param string $path * * @return int */ public function countElements($path, ?DOMElement $contextNode = null) { $elements = $this->getElements($path, $contextNode); return $elements->length; } /** * Element exists. * * @param string $path * * @return bool */ public function elementExists($path, ?DOMElement $contextNode = null) { return $this->getElements($path, $contextNode)->length > 0; } } ================================================ FILE: src/PhpWord/Shared/XMLWriter.php ================================================ openMemory(); } else { if (!$pTemporaryStorageDir || !is_dir($pTemporaryStorageDir)) { $pTemporaryStorageDir = sys_get_temp_dir(); } // Create temporary filename $this->tempFileName = @tempnam($pTemporaryStorageDir, 'xml'); // Open storage $this->openUri($this->tempFileName); } if ($compatibility) { $this->setIndent(false); $this->setIndentString(''); } else { $this->setIndent(true); $this->setIndentString(' '); } } /** * Destructor. */ public function __destruct() { // Unlink temporary files if (empty($this->tempFileName)) { return; } if (PHP_OS != 'WINNT' && @unlink($this->tempFileName) === false) { throw new Exception('The file ' . $this->tempFileName . ' could not be deleted.'); } } /** * Get written data. * * @return string */ public function getData() { if ($this->tempFileName == '') { return $this->outputMemory(true); } $this->flush(); return file_get_contents($this->tempFileName); } /** * Write simple element and attribute(s) block. * * There are two options: * 1. If the `$attributes` is an array, then it's an associative array of attributes * 2. If not, then it's a simple attribute-value pair * * @param string $element * @param array|string $attributes * @param string $value */ public function writeElementBlock($element, $attributes, $value = null): void { $this->startElement($element); if (!is_array($attributes)) { $attributes = [$attributes => $value]; } foreach ($attributes as $attribute => $value) { $this->writeAttribute($attribute, $value); } $this->endElement(); } /** * Write element if ... * * @param bool $condition * @param string $element * @param string $attribute * @param mixed $value */ public function writeElementIf($condition, $element, $attribute = null, $value = null): void { if ($condition == true) { if (null === $attribute) { $this->writeElement($element, $value); } else { $this->startElement($element); $this->writeAttribute($attribute, $value); $this->endElement(); } } } /** * Write attribute if ... * * @param bool $condition * @param string $attribute * @param mixed $value */ public function writeAttributeIf($condition, $attribute, $value): void { if ($condition == true) { $this->writeAttribute($attribute, $value); } } /** * @param string $name * @param mixed $value */ public function writeAttribute($name, $value): bool { if (is_float($value)) { $value = json_encode($value); } return parent::writeAttribute($name, $value ?? ''); } } ================================================ FILE: src/PhpWord/Shared/ZipArchive.php ================================================ usePclzip = (Settings::getZipClass() != 'ZipArchive'); if ($this->usePclzip) { if (!defined('PCLZIP_TEMPORARY_DIR')) { define('PCLZIP_TEMPORARY_DIR', Settings::getTempDir() . '/'); } require_once 'PCLZip/pclzip.lib.php'; } } /** * Catch function calls: pass to ZipArchive or PCLZip. * * `call_user_func_array` can only used for public function, hence the `public` in all `pcl...` methods * * @param mixed $function * @param mixed $args * * @return mixed */ public function __call($function, $args) { // Set object and function $zipFunction = $function; if (!$this->usePclzip) { $zipObject = $this->zip; } else { $zipObject = $this; $zipFunction = "pclzip{$zipFunction}"; } // Run function $result = false; if (method_exists($zipObject, $zipFunction)) { $result = @call_user_func_array([$zipObject, $zipFunction], $args); } return $result; } /** * Open a new zip archive. * * @param string $filename The file name of the ZIP archive to open * @param int $flags The mode to use to open the archive * * @return bool */ public function open($filename, $flags = null) { $result = true; $this->filename = $filename; $this->tempDir = Settings::getTempDir(); if (!$this->usePclzip) { $zip = new \ZipArchive(); // PHP 8.1 compat - passing null as second arg to \ZipArchive::open() is deprecated // passing 0 achieves the same behaviour if ($flags === null) { $flags = 0; } $result = $zip->open($this->filename, $flags); // Scrutizer will report the property numFiles does not exist // See https://github.com/scrutinizer-ci/php-analyzer/issues/190 $this->numFiles = $zip->numFiles; } else { $zip = new PclZip($this->filename); $zipContent = $zip->listContent(); $this->numFiles = is_array($zipContent) ? count($zipContent) : 0; } $this->zip = $zip; return $result; } /** * Close the active archive. * * @return bool */ public function close() { if (!$this->usePclzip) { try { $result = @$this->zip->close(); } catch (Throwable $e) { $result = false; } if ($result === false) { throw new Exception("Could not close zip file {$this->filename}: "); } } return true; } /** * Extract the archive contents (emulate \ZipArchive). * * @param string $destination * @param array|string $entries * * @return bool * * @since 0.10.0 */ public function extractTo($destination, $entries = null) { if (!is_dir($destination)) { return false; } if (!$this->usePclzip) { return $this->zip->extractTo($destination, $entries); } return $this->pclzipExtractTo($destination, $entries); } /** * Extract file from archive by given file name (emulate \ZipArchive). * * @param string $filename Filename for the file in zip archive * * @return bool|string $contents File string contents */ public function getFromName($filename) { if (!$this->usePclzip) { $contents = $this->zip->getFromName($filename); if ($contents === false) { $filename = substr($filename, 1); $contents = $this->zip->getFromName($filename); } } else { $contents = $this->pclzipGetFromName($filename); } return $contents; } /** * Add a new file to the zip archive (emulate \ZipArchive). * * @param string $filename Directory/Name of the file to add to the zip archive * @param string $localname Directory/Name of the file added to the zip * * @return bool */ public function pclzipAddFile($filename, $localname = null) { /** @var PclZip $zip Type hint */ $zip = $this->zip; // Bugfix GH-261 https://github.com/PHPOffice/PHPWord/pull/261 $realpathFilename = realpath($filename); if ($realpathFilename !== false) { $filename = $realpathFilename; } $filenamePartsBaseName = pathinfo($filename, PATHINFO_BASENAME); $filenamePartsDirName = pathinfo($filename, PATHINFO_DIRNAME); $localnamePartsBaseName = pathinfo($localname, PATHINFO_BASENAME); $localnamePartsDirName = pathinfo($localname, PATHINFO_DIRNAME); // To Rename the file while adding it to the zip we // need to create a temp file with the correct name $tempFile = false; if ($filenamePartsBaseName != $localnamePartsBaseName) { $tempFile = true; // temp file created $temppath = $this->tempDir . DIRECTORY_SEPARATOR . $localnamePartsBaseName; copy($filename, $temppath); $filename = $temppath; $filenamePartsDirName = pathinfo($temppath, PATHINFO_DIRNAME); } $pathRemoved = $filenamePartsDirName; $pathAdded = $localnamePartsDirName; if (!$this->usePclzip) { $pathAdded = $pathAdded . '/' . ltrim(str_replace('\\', '/', substr($filename, strlen($pathRemoved))), '/'); //$res = $zip->addFile($filename, $pathAdded); $res = $zip->addFromString($pathAdded, file_get_contents($filename)); // addFile can't use subfolders in some cases } else { $res = $zip->add($filename, PCLZIP_OPT_REMOVE_PATH, $pathRemoved, PCLZIP_OPT_ADD_PATH, $pathAdded); } if ($tempFile) { // Remove temp file, if created unlink($this->tempDir . DIRECTORY_SEPARATOR . $localnamePartsBaseName); } return $res != 0; } /** * Add a new file to the zip archive from a string of raw data (emulate \ZipArchive). * * @param string $localname Directory/Name of the file to add to the zip archive * @param string $contents String of data to add to the zip archive * * @return bool */ public function pclzipAddFromString($localname, $contents) { /** @var PclZip $zip Type hint */ $zip = $this->zip; $filenamePartsBaseName = pathinfo($localname, PATHINFO_BASENAME); $filenamePartsDirName = pathinfo($localname, PATHINFO_DIRNAME); // Write $contents to a temp file $handle = fopen($this->tempDir . DIRECTORY_SEPARATOR . $filenamePartsBaseName, 'wb'); if ($handle) { fwrite($handle, $contents); fclose($handle); } // Add temp file to zip $filename = $this->tempDir . DIRECTORY_SEPARATOR . $filenamePartsBaseName; $pathRemoved = $this->tempDir; $pathAdded = $filenamePartsDirName; $res = $zip->add($filename, PCLZIP_OPT_REMOVE_PATH, $pathRemoved, PCLZIP_OPT_ADD_PATH, $pathAdded); // Remove temp file @unlink($this->tempDir . DIRECTORY_SEPARATOR . $filenamePartsBaseName); return $res != 0; } /** * Extract the archive contents (emulate \ZipArchive). * * @param string $destination * @param array|string $entries * * @return bool * * @since 0.10.0 */ public function pclzipExtractTo($destination, $entries = null) { /** @var PclZip $zip Type hint */ $zip = $this->zip; // Extract all files if (null === $entries) { $result = $zip->extract(PCLZIP_OPT_PATH, $destination); return $result > 0; } // Extract by entries if (!is_array($entries)) { $entries = [$entries]; } foreach ($entries as $entry) { $entryIndex = $this->locateName($entry); $result = $zip->extractByIndex($entryIndex, PCLZIP_OPT_PATH, $destination); if ($result <= 0) { return false; } } return true; } /** * Extract file from archive by given file name (emulate \ZipArchive). * * @param string $filename Filename for the file in zip archive * * @return string $contents File string contents */ public function pclzipGetFromName($filename) { /** @var PclZip $zip Type hint */ $zip = $this->zip; $listIndex = $this->pclzipLocateName($filename); $contents = false; if ($listIndex !== false) { $extracted = $zip->extractByIndex($listIndex, PCLZIP_OPT_EXTRACT_AS_STRING); } else { $filename = substr($filename, 1); $listIndex = $this->pclzipLocateName($filename); $extracted = $zip->extractByIndex($listIndex, PCLZIP_OPT_EXTRACT_AS_STRING); } if (is_array($extracted) && count($extracted) != 0) { $contents = $extracted[0]['content']; } return $contents; } /** * Returns the name of an entry using its index (emulate \ZipArchive). * * @param int $index * * @return bool|string * * @since 0.10.0 */ public function pclzipGetNameIndex($index) { /** @var PclZip $zip Type hint */ $zip = $this->zip; $list = $zip->listContent(); if (isset($list[$index])) { return $list[$index]['filename']; } return false; } /** * Returns the index of the entry in the archive (emulate \ZipArchive). * * @param string $filename Filename for the file in zip archive * * @return false|int */ public function pclzipLocateName($filename) { /** @var PclZip $zip Type hint */ $zip = $this->zip; $list = $zip->listContent(); $listCount = count($list); $listIndex = -1; for ($i = 0; $i < $listCount; ++$i) { if (strtolower($list[$i]['filename']) == strtolower($filename) || strtolower($list[$i]['stored_filename']) == strtolower($filename)) { $listIndex = $i; break; } } return ($listIndex > -1) ? $listIndex : false; } /** * Add an empty directory to the zip archive (emulate \ZipArchive). * * @param string $dirname Directory name to add to the zip archive */ public function addEmptyDir(string $dirname): bool { // Create a directory entry by adding an empty file with trailing slash return $this->addFromString(rtrim($dirname, '/') . '/', ''); } } ================================================ FILE: src/PhpWord/SimpleType/Border.php ================================================ styleName; } /** * Set style name. * * @param string $value * * @return self */ public function setStyleName($value) { $this->styleName = $value; return $this; } /** * Get index number. * * @return null|int */ public function getIndex() { return $this->index; } /** * Set index number. * * @param null|int $value * * @return self */ public function setIndex($value = null) { $this->index = $this->setIntVal($value, $this->index); return $this; } /** * Get is automatic style flag. * * @return bool */ public function isAuto() { return $this->isAuto; } /** * Set is automatic style flag. * * @param bool $value * * @return self */ public function setAuto($value = true) { $this->isAuto = $this->setBoolVal($value, $this->isAuto); return $this; } /** * Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`. * * @param AbstractStyle $substyleObject * @param string $substyleProperty * * @return mixed * * @since 0.12.0 */ public function getChildStyleValue($substyleObject, $substyleProperty) { if ($substyleObject !== null) { $method = "get{$substyleProperty}"; return $substyleObject->$method(); } return null; } /** * Set style value template method. * * Some child classes have their own specific overrides. * Backward compability check for versions < 0.10.0 which use underscore * prefix for their private properties. * Check if the set method is exists. Throws an exception? * * @param string $key * @param array|int|string $value * * @return self */ public function setStyleValue($key, $value) { if (isset($this->aliases[$key])) { $key = $this->aliases[$key]; } if ($key === 'align') { $key = 'alignment'; } $method = 'set' . Text::removeUnderscorePrefix($key); if (method_exists($this, $method)) { $this->$method($value); } return $this; } /** * Set style by using associative array. * * @param array $values * * @return self */ public function setStyleByArray($values = []) { foreach ($values as $key => $value) { $this->setStyleValue($key, $value); } return $this; } /** * Set default for null and empty value. * * @param ?string $value * @param string $default * * @return string */ protected function setNonEmptyVal($value, $default) { if ($value === null || $value == '') { $value = $default; } return $value; } /** * Set bool value. * * @param bool $value * @param bool $default * * @return bool */ protected function setBoolVal($value, $default) { if (!is_bool($value)) { $value = $default; } return $value; } /** * Set numeric value. * * @param mixed $value * @param null|float|int $default * * @return null|float|int */ protected function setNumericVal($value, $default = null) { if (!is_numeric($value)) { $value = $default; } return $value; } /** * Set integer value: Convert string that contains only numeric into integer. * * @param null|float|int|string $value * @param null|int $default * * @return null|int */ protected function setIntVal($value, $default = null) { if (is_string($value) && (preg_match('/[^\d]/', $value) == 0)) { $value = (int) $value; } if (!is_numeric($value)) { $value = $default; } else { $value = (int) $value; } return $value; } /** * Set float value: Convert string that contains only numeric into float. * * @param mixed $value * @param null|float $default * * @return null|float */ protected function setFloatVal($value, $default = null) { if (is_string($value) && (preg_match('/[^\d\.\,]/', $value) == 0)) { $value = (float) $value; } if (!is_numeric($value)) { $value = $default; } return $value; } /** * Set enum value. * * @param mixed $value * @param array $enum * @param mixed $default * * @return mixed */ protected function setEnumVal($value = null, $enum = [], $default = null) { if ($value != null && trim($value) != '' && !empty($enum) && !in_array($value, $enum)) { throw new InvalidArgumentException("Invalid style value: {$value} Options:" . implode(',', $enum)); } elseif ($value === null || trim($value) == '') { $value = $default; } return $value; } /** * Set object value. * * @param mixed $value * @param mixed &$style * * @return mixed */ protected function setObjectVal($value, string $styleName, &$style) { $styleClass = substr(static::class, 0, (int) strrpos(static::class, '\\')) . '\\' . $styleName; if (is_array($value)) { /** @var AbstractStyle $style Type hint */ if (!$style instanceof $styleClass) { $style = new $styleClass(); } $style->setStyleByArray($value); } else { $style = $value; } return $style; } /** * Set $property value and set $pairProperty = false when $value = true. * * @param bool &$property * @param bool &$pairProperty * @param bool $value * * @return self */ protected function setPairedVal(&$property, &$pairProperty, $value) { $property = $this->setBoolVal($value, $property); if ($value === true) { $pairProperty = false; } return $this; } } ================================================ FILE: src/PhpWord/Style/Border.php ================================================ getBorderTopSize(), $this->getBorderLeftSize(), $this->getBorderRightSize(), $this->getBorderBottomSize(), ]; } /** * Set border size. * * @param float|int $value * * @return self */ public function setBorderSize($value = null) { $this->setBorderTopSize($value); $this->setBorderLeftSize($value); $this->setBorderRightSize($value); $this->setBorderBottomSize($value); return $this; } /** * Get border color. * * @return array */ public function getBorderColor() { return [ $this->getBorderTopColor(), $this->getBorderLeftColor(), $this->getBorderRightColor(), $this->getBorderBottomColor(), ]; } /** * Set border color. * * @param null|string $value * * @return self */ public function setBorderColor($value = null) { $this->setBorderTopColor($value); $this->setBorderLeftColor($value); $this->setBorderRightColor($value); $this->setBorderBottomColor($value); return $this; } /** * Get border style. * * @return string[] */ public function getBorderStyle() { return [ $this->getBorderTopStyle(), $this->getBorderLeftStyle(), $this->getBorderRightStyle(), $this->getBorderBottomStyle(), ]; } /** * Set border style. * * @param string $value * * @return self */ public function setBorderStyle($value = null) { $this->setBorderTopStyle($value); $this->setBorderLeftStyle($value); $this->setBorderRightStyle($value); $this->setBorderBottomStyle($value); return $this; } /** * Get border top size. * * @return float|int */ public function getBorderTopSize() { return $this->borderTopSize; } /** * Set border top size. * * @param float|int $value * * @return self */ public function setBorderTopSize($value = null) { $this->borderTopSize = $this->setNumericVal($value, $this->borderTopSize); return $this; } /** * Get border top color. * * @return null|string */ public function getBorderTopColor() { return $this->borderTopColor; } /** * Set border top color. * * @param null|string $value * * @return self */ public function setBorderTopColor($value = null) { $this->borderTopColor = $value; return $this; } /** * Get border top style. * * @return string */ public function getBorderTopStyle() { return $this->borderTopStyle; } /** * Set border top Style. * * @param string $value * * @return self */ public function setBorderTopStyle($value = null) { $this->borderTopStyle = $value; return $this; } /** * Get border left size. * * @return float|int */ public function getBorderLeftSize() { return $this->borderLeftSize; } /** * Set border left size. * * @param float|int $value * * @return self */ public function setBorderLeftSize($value = null) { $this->borderLeftSize = $this->setNumericVal($value, $this->borderLeftSize); return $this; } /** * Get border left color. * * @return null|string */ public function getBorderLeftColor() { return $this->borderLeftColor; } /** * Set border left color. * * @param null|string $value * * @return self */ public function setBorderLeftColor($value = null) { $this->borderLeftColor = $value; return $this; } /** * Get border left style. * * @return string */ public function getBorderLeftStyle() { return $this->borderLeftStyle; } /** * Set border left style. * * @param string $value * * @return self */ public function setBorderLeftStyle($value = null) { $this->borderLeftStyle = $value; return $this; } /** * Get border right size. * * @return float|int */ public function getBorderRightSize() { return $this->borderRightSize; } /** * Set border right size. * * @param float|int $value * * @return self */ public function setBorderRightSize($value = null) { $this->borderRightSize = $this->setNumericVal($value, $this->borderRightSize); return $this; } /** * Get border right color. * * @return null|string */ public function getBorderRightColor() { return $this->borderRightColor; } /** * Set border right color. * * @param null|string $value * * @return self */ public function setBorderRightColor($value = null) { $this->borderRightColor = $value; return $this; } /** * Get border right style. * * @return string */ public function getBorderRightStyle() { return $this->borderRightStyle; } /** * Set border right style. * * @param string $value * * @return self */ public function setBorderRightStyle($value = null) { $this->borderRightStyle = $value; return $this; } /** * Get border bottom size. * * @return float|int */ public function getBorderBottomSize() { return $this->borderBottomSize; } /** * Set border bottom size. * * @param float|int $value * * @return self */ public function setBorderBottomSize($value = null) { $this->borderBottomSize = $this->setNumericVal($value, $this->borderBottomSize); return $this; } /** * Get border bottom color. * * @return null|string */ public function getBorderBottomColor() { return $this->borderBottomColor; } /** * Set border bottom color. * * @param null|string $value * * @return self */ public function setBorderBottomColor($value = null) { $this->borderBottomColor = $value; return $this; } /** * Get border bottom style. * * @return string */ public function getBorderBottomStyle() { return $this->borderBottomStyle; } /** * Set border bottom style. * * @param string $value * * @return self */ public function setBorderBottomStyle($value = null) { $this->borderBottomStyle = $value; return $this; } /** * Check if any of the border is not null. * * @return bool */ public function hasBorder() { $borders = $this->getBorderSize(); return $borders !== array_filter($borders, 'is_null'); } /** * Get Margin Top. * * @return float|int */ public function getMarginTop() { return $this->marginTop; } /** * Set Margin Top. * * @param float|int $value * * @return self */ public function setMarginTop($value = null) { $this->marginTop = $this->setNumericVal($value, self::DEFAULT_MARGIN); return $this; } /** * Get Margin Left. * * @return float|int */ public function getMarginLeft() { return $this->marginLeft; } /** * Set Margin Left. * * @param float|int $value * * @return self */ public function setMarginLeft($value = null) { $this->marginLeft = $this->setNumericVal($value, self::DEFAULT_MARGIN); return $this; } /** * Get Margin Right. * * @return float|int */ public function getMarginRight() { return $this->marginRight; } /** * Set Margin Right. * * @param float|int $value * * @return self */ public function setMarginRight($value = null) { $this->marginRight = $this->setNumericVal($value, self::DEFAULT_MARGIN); return $this; } /** * Get Margin Bottom. * * @return float|int */ public function getMarginBottom() { return $this->marginBottom; } /** * Set Margin Bottom. * * @param float|int $value * * @return self */ public function setMarginBottom($value = null) { $this->marginBottom = $this->setNumericVal($value, self::DEFAULT_MARGIN); return $this; } } ================================================ FILE: src/PhpWord/Style/Cell.php ================================================ vAlign; } /** * Set vertical align. * * @param null|string $value * * @return self */ public function setVAlign($value = null) { if ($value === null) { $this->vAlign = null; return $this; } VerticalJc::validate($value); $this->vAlign = $this->setEnumVal($value, VerticalJc::values(), $this->vAlign); return $this; } /** * Get text direction. * * @return string */ public function getTextDirection() { return $this->textDirection; } /** * Set text direction. * * @param string $value * * @return self */ public function setTextDirection($value = null) { $enum = [ self::TEXT_DIR_BTLR, self::TEXT_DIR_TBRL, self::TEXT_DIR_LRTB, self::TEXT_DIR_LRTBV, self::TEXT_DIR_TBRLV, self::TEXT_DIR_TBLRV, ]; $this->textDirection = $this->setEnumVal($value, $enum, $this->textDirection); return $this; } /** * Get background. * * @return string */ public function getBgColor() { if ($this->shading !== null) { return $this->shading->getFill(); } return null; } /** * Set background. * * @param string $value * * @return self */ public function setBgColor($value = null) { return $this->setShading(['fill' => $value]); } /** * Get grid span (colspan). * * @return int */ public function getGridSpan() { return $this->gridSpan; } /** * Set grid span (colspan). * * @param int $value * * @return self */ public function setGridSpan($value = null) { $this->gridSpan = $this->setIntVal($value, $this->gridSpan); return $this; } /** * Get vertical merge (rowspan). * * @return null|string */ public function getVMerge() { return $this->vMerge; } /** * Set vertical merge (rowspan). * * @param null|string $value * * @return self */ public function setVMerge($value = null) { if ($value === null) { $this->vMerge = null; return $this; } $enum = [self::VMERGE_RESTART, self::VMERGE_CONTINUE]; $this->vMerge = $this->setEnumVal($value, $enum, $this->vMerge); return $this; } /** * Get shading. * * @return Shading */ public function getShading() { return $this->shading; } /** * Set shading. * * @param mixed $value * * @return self */ public function setShading($value = null) { $this->setObjectVal($value, 'Shading', $this->shading); return $this; } /** * Get cell width. * * @return ?int */ public function getWidth() { return $this->width; } /** * Set cell width. * * @param int $value * * @return self */ public function setWidth($value) { $this->width = $this->setIntVal($value); return $this; } /** * Get width unit. * * @return string */ public function getUnit() { return $this->unit; } /** * Set width unit. * * @param string $value */ public function setUnit($value) { $this->unit = $this->setEnumVal($value, [TblWidth::AUTO, TblWidth::PERCENT, TblWidth::TWIP], TblWidth::TWIP); return $this; } /** * Set noWrap. */ public function setNoWrap(bool $value): self { $this->noWrap = $this->setBoolVal($value, true); return $this; } /** * Get noWrap. */ public function getNoWrap(): bool { return $this->noWrap; } /** * Get style padding-top. */ public function getPaddingTop(): ?int { return $this->paddingTop; } /** * Set style padding-top. * * @return $this */ public function setPaddingTop(int $value): self { $this->paddingTop = $value; return $this; } /** * Get style padding-bottom. */ public function getPaddingBottom(): ?int { return $this->paddingBottom; } /** * Set style padding-bottom. * * @return $this */ public function setPaddingBottom(int $value): self { $this->paddingBottom = $value; return $this; } /** * Get style padding-left. */ public function getPaddingLeft(): ?int { return $this->paddingLeft; } /** * Set style padding-left. * * @return $this */ public function setPaddingLeft(int $value): self { $this->paddingLeft = $value; return $this; } /** * Get style padding-right. */ public function getPaddingRight(): ?int { return $this->paddingRight; } /** * Set style padding-right. * * @return $this */ public function setPaddingRight(int $value): self { $this->paddingRight = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/Chart.php ================================================ true, // value 'showCatName' => true, // category name 'showLegendKey' => false, //show the cart legend 'showSerName' => false, // series name 'showPercent' => false, 'showLeaderLines' => false, 'showBubbleSize' => false, ]; /** * A string that tells the writer where to write chart labels or to skip * "nextTo" - sets labels next to the axis (bar graphs on the left) (default) * "low" - labels on the left side of the graph * "high" - labels on the right side of the graph. * * @var string */ private $categoryLabelPosition = 'nextTo'; /** * A string that tells the writer where to write chart labels or to skip * "nextTo" - sets labels next to the axis (bar graphs on the bottom) (default) * "low" - labels are below the graph * "high" - labels above the graph. * * @var string */ private $valueLabelPosition = 'nextTo'; /** * @var string */ private $categoryAxisTitle; /** * @var string */ private $valueAxisTitle; /** * The position for major tick marks * Possible values are 'in', 'out', 'cross', 'none'. * * @var string */ private $majorTickMarkPos = 'none'; /** * Show labels for axis. * * @var bool */ private $showAxisLabels = false; /** * Show Gridlines for Y-Axis. * * @var bool */ private $gridY = false; /** * Show Gridlines for X-Axis. * * @var bool */ private $gridX = false; /** * Create a new instance. * * @param array $style */ public function __construct($style = []) { $this->setStyleByArray($style); } /** * Get width. * * @return int */ public function getWidth() { return $this->width; } /** * Set width. * * @param int $value * * @return self */ public function setWidth($value = null) { $this->width = $this->setIntVal($value, $this->width); return $this; } /** * Get height. * * @return int */ public function getHeight() { return $this->height; } /** * Set height. * * @param int $value * * @return self */ public function setHeight($value = null) { $this->height = $this->setIntVal($value, $this->height); return $this; } /** * Is 3D. * * @return bool */ public function is3d() { return $this->is3d; } /** * Set 3D. * * @param bool $value * * @return self */ public function set3d($value = true) { $this->is3d = $this->setBoolVal($value, $this->is3d); return $this; } /** * Get the list of colors to use in a chart. * * @return array */ public function getColors() { return $this->colors; } /** * Set the colors to use in a chart. * * @param array $value a list of colors to use in the chart * * @return self */ public function setColors($value = []) { $this->colors = $value; return $this; } /** * Get the chart title. * * @return string */ public function getTitle() { return $this->title; } /** * Set the chart title. * * @param string $value * * @return self */ public function setTitle($value = null) { $this->title = $value; return $this; } /** * Get chart legend visibility. * * @return bool */ public function isShowLegend() { return $this->showLegend; } /** * Set chart legend visibility. * * @param bool $value * * @return self */ public function setShowLegend($value = false) { $this->showLegend = $value; return $this; } /** * Get chart legend position. * * @return string */ public function getLegendPosition() { return $this->legendPosition; } /** * Set chart legend position. choices: * "r" - right of chart * "b" - bottom of chart * "t" - top of chart * "l" - left of chart * "tr" - top right of chart. * * default: right * * @param string $legendPosition * * @return self */ public function setLegendPosition($legendPosition = 'r') { $enum = ['r', 'b', 't', 'l', 'tr']; $this->legendPosition = $this->setEnumVal($legendPosition, $enum, $this->legendPosition); return $this; } /* * Show labels for axis * * @return bool */ public function showAxisLabels() { return $this->showAxisLabels; } /** * Set show Gridlines for Y-Axis. * * @param bool $value * * @return self */ public function setShowAxisLabels($value = true) { $this->showAxisLabels = $this->setBoolVal($value, $this->showAxisLabels); return $this; } /** * get the list of options for data labels. * * @return array */ public function getDataLabelOptions() { return $this->dataLabelOptions; } /** * Set values for data label options. * This will only change values for options defined in $this->dataLabelOptions, and cannot create new ones. * * @param array $values [description] */ public function setDataLabelOptions($values = []): void { foreach (array_keys($this->dataLabelOptions) as $option) { if (isset($values[$option])) { $this->dataLabelOptions[$option] = $this->setBoolVal( $values[$option], $this->dataLabelOptions[$option] ); } } } /* * Show Gridlines for Y-Axis * * @return bool */ public function showGridY() { return $this->gridY; } /** * Set show Gridlines for Y-Axis. * * @param bool $value * * @return self */ public function setShowGridY($value = true) { $this->gridY = $this->setBoolVal($value, $this->gridY); return $this; } /** * Get the categoryLabelPosition setting. * * @return string */ public function getCategoryLabelPosition() { return $this->categoryLabelPosition; } /** * Set the categoryLabelPosition setting * "none" - skips writing labels * "nextTo" - sets labels next to the (bar graphs on the left) * "low" - labels on the left side of the graph * "high" - labels on the right side of the graph. * * @param mixed $labelPosition * * @return self */ public function setCategoryLabelPosition($labelPosition) { $enum = ['nextTo', 'low', 'high']; $this->categoryLabelPosition = $this->setEnumVal($labelPosition, $enum, $this->categoryLabelPosition); return $this; } /** * Get the valueAxisLabelPosition setting. * * @return string */ public function getValueLabelPosition() { return $this->valueLabelPosition; } /** * Set the valueLabelPosition setting * "none" - skips writing labels * "nextTo" - sets labels next to the value * "low" - sets labels are below the graph * "high" - sets labels above the graph. */ public function setValueLabelPosition(string $labelPosition) { $enum = ['nextTo', 'low', 'high']; $this->valueLabelPosition = $this->setEnumVal($labelPosition, $enum, $this->valueLabelPosition); return $this; } /** * Get the categoryAxisTitle. * * @return string */ public function getCategoryAxisTitle() { return $this->categoryAxisTitle; } /** * Set the title that appears on the category side of the chart. * * @param string $axisTitle */ public function setCategoryAxisTitle($axisTitle) { $this->categoryAxisTitle = $axisTitle; return $this; } /** * Get the valueAxisTitle. * * @return string */ public function getValueAxisTitle() { return $this->valueAxisTitle; } /** * Set the title that appears on the value side of the chart. * * @param string $axisTitle */ public function setValueAxisTitle($axisTitle) { $this->valueAxisTitle = $axisTitle; return $this; } public function getMajorTickPosition() { return $this->majorTickMarkPos; } /** * Set the position for major tick marks. * * @param string $position */ public function setMajorTickPosition($position): void { $enum = ['in', 'out', 'cross', 'none']; $this->majorTickMarkPos = $this->setEnumVal($position, $enum, $this->majorTickMarkPos); } /** * Show Gridlines for X-Axis. * * @return bool */ public function showGridX() { return $this->gridX; } /** * Set show Gridlines for X-Axis. * * @param bool $value * * @return self */ public function setShowGridX($value = true) { $this->gridX = $this->setBoolVal($value, $this->gridX); return $this; } } ================================================ FILE: src/PhpWord/Style/Extrusion.php ================================================ setStyleByArray($style); } /** * Get type. * * @return string */ public function getType() { return $this->type; } /** * Set pattern. * * @param string $value * * @return self */ public function setType($value = null) { $enum = [self::EXTRUSION_PARALLEL, self::EXTRUSION_PERSPECTIVE]; $this->type = $this->setEnumVal($value, $enum, null); return $this; } /** * Get color. * * @return string */ public function getColor() { return $this->color; } /** * Set color. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/Fill.php ================================================ setStyleByArray($style); } /** * Get color. * * @return string */ public function getColor() { return $this->color; } /** * Set color. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/Font.php ================================================ 'lineHeight', 'letter-spacing' => 'spacing']; /** * Font style type. * * @var string */ private $type; /** * Font name. * * @var string */ private $name; /** * Font Content Type. * * @var string */ private $hint; /** * Font size. * * @var float|int */ private $size; /** * Font color. * * @var null|string */ private $color; /** * Bold. * * @var bool */ private $bold; /** * Italic. * * @var bool */ private $italic; /** * Undeline. * * @var string */ private $underline = self::UNDERLINE_NONE; /** * Superscript. * * @var bool */ private $superScript = false; /** * Subscript. * * @var bool */ private $subScript = false; /** * Strikethrough. * * @var bool */ private $strikethrough; /** * Double strikethrough. * * @var bool */ private $doubleStrikethrough; /** * Small caps. * * @var bool * * @see http://www.schemacentral.com/sc/ooxml/e-w_smallCaps-1.html */ private $smallCaps; /** * All caps. * * @var bool * * @see http://www.schemacentral.com/sc/ooxml/e-w_caps-1.html */ private $allCaps; /** * Foreground/highlight. * * @var string */ private $fgColor; /** * Expanded/compressed text: 0-600 (percent). * * @var int * * @since 0.12.0 * @see http://www.schemacentral.com/sc/ooxml/e-w_w-1.html */ private $scale; /** * Character spacing adjustment: twip. * * @var float|int * * @since 0.12.0 * @see http://www.schemacentral.com/sc/ooxml/e-w_spacing-2.html */ private $spacing; /** * Font kerning: halfpoint. * * @var float|int * * @since 0.12.0 * @see http://www.schemacentral.com/sc/ooxml/e-w_kern-1.html */ private $kerning; /** * Paragraph style. * * @var Paragraph */ private $paragraph; /** * Shading. * * @var Shading */ private $shading; /** * Right to left languages. * * @var ?bool */ private $rtl; /** * noProof (disables AutoCorrect). * * @var bool * http://www.datypic.com/sc/ooxml/e-w_noProof-1.html */ private $noProof; /** * Languages. * * @var null|Language */ private $lang; /** * Hidden text. * * @var bool * * @see http://www.datypic.com/sc/ooxml/e-w_vanish-1.html */ private $hidden; /** * Vertically Raised or Lowered Text. * * @var int Signed Half-Point Measurement * * @see http://www.datypic.com/sc/ooxml/e-w_position-1.html */ private $position; /** * Preservation of white space in html. * * @var string Value used for css white-space */ private $whiteSpace = ''; /** * Generic font as fallback for html. * * @var string generic font name */ private $fallbackFont = ''; /** * Create new font style. * * @param string $type Type of font * @param AbstractStyle|array|string $paragraph Paragraph styles definition */ public function __construct($type = 'text', $paragraph = null) { $this->type = $type; $this->setParagraph($paragraph); } /** * Get style values. * * @return array * * @since 0.12.0 */ public function getStyleValues() { return [ 'name' => $this->getStyleName(), 'basic' => [ 'name' => $this->getName(), 'size' => $this->getSize(), 'color' => $this->getColor(), 'hint' => $this->getHint(), ], 'style' => [ 'bold' => $this->isBold(), 'italic' => $this->isItalic(), 'underline' => $this->getUnderline(), 'strike' => $this->isStrikethrough(), 'dStrike' => $this->isDoubleStrikethrough(), 'super' => $this->isSuperScript(), 'sub' => $this->isSubScript(), 'smallCaps' => $this->isSmallCaps(), 'allCaps' => $this->isAllCaps(), 'fgColor' => $this->getFgColor(), 'hidden' => $this->isHidden(), ], 'spacing' => [ 'scale' => $this->getScale(), 'spacing' => $this->getSpacing(), 'kerning' => $this->getKerning(), 'position' => $this->getPosition(), ], 'paragraph' => $this->getParagraph(), 'rtl' => $this->isRTL(), 'shading' => $this->getShading(), 'lang' => $this->getLang(), 'whiteSpace' => $this->getWhiteSpace(), 'fallbackFont' => $this->getFallbackFont(), ]; } /** * Get style type. * * @return string */ public function getStyleType() { return $this->type; } /** * Get font name. * * @return string */ public function getName() { return $this->name; } /** * Set font name. * * @param string $value * * @return self */ public function setName($value = null) { $this->name = $value; return $this; } /** * Get Font Content Type. * * @return string */ public function getHint() { return $this->hint; } /** * Set Font Content Type. * * @param string $value * * @return self */ public function setHint($value = null) { $this->hint = $value; return $this; } /** * Get font size. * * @return float|int */ public function getSize() { return $this->size; } /** * Set font size. * * @param float|int $value * * @return self */ public function setSize($value = null) { $this->size = $this->setNumericVal($value, $this->size); return $this; } /** * Get font color. */ public function getColor(): ?string { return $this->color; } /** * Set font color. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } /** * Get bold. * * @return bool */ public function isBold() { return $this->bold; } /** * Set bold. * * @param bool $value * * @return self */ public function setBold($value = true) { $this->bold = $this->setBoolVal($value, $this->bold); return $this; } /** * Get italic. * * @return bool */ public function isItalic() { return $this->italic; } /** * Set italic. * * @param bool $value * * @return self */ public function setItalic($value = true) { $this->italic = $this->setBoolVal($value, $this->italic); return $this; } /** * Get underline. * * @return string */ public function getUnderline() { return $this->underline; } /** * Set underline. * * @param string $value * * @return self */ public function setUnderline($value = self::UNDERLINE_NONE) { $this->underline = $this->setNonEmptyVal($value, self::UNDERLINE_NONE); return $this; } /** * Get superscript. * * @return bool */ public function isSuperScript() { return $this->superScript; } /** * Set superscript. * * @param bool $value * * @return self */ public function setSuperScript($value = true) { return $this->setPairedVal($this->superScript, $this->subScript, $value); } /** * Get subscript. * * @return bool */ public function isSubScript() { return $this->subScript; } /** * Set subscript. * * @param bool $value * * @return self */ public function setSubScript($value = true) { return $this->setPairedVal($this->subScript, $this->superScript, $value); } /** * Get strikethrough. */ public function isStrikethrough(): ?bool { return $this->strikethrough; } /** * Set strikethrough. * * @param bool $value */ public function setStrikethrough($value = true): self { return $this->setPairedVal($this->strikethrough, $this->doubleStrikethrough, $value); } /** * Get double strikethrough. */ public function isDoubleStrikethrough(): ?bool { return $this->doubleStrikethrough; } /** * Set double strikethrough. * * @param bool $value */ public function setDoubleStrikethrough($value = true): self { return $this->setPairedVal($this->doubleStrikethrough, $this->strikethrough, $value); } /** * Get small caps. * * @return bool */ public function isSmallCaps() { return $this->smallCaps; } /** * Set small caps. * * @param bool $value * * @return self */ public function setSmallCaps($value = true) { return $this->setPairedVal($this->smallCaps, $this->allCaps, $value); } /** * Get all caps. * * @return bool */ public function isAllCaps() { return $this->allCaps; } /** * Set all caps. * * @param bool $value * * @return self */ public function setAllCaps($value = true) { return $this->setPairedVal($this->allCaps, $this->smallCaps, $value); } /** * Get foreground/highlight color. * * @return string */ public function getFgColor() { return $this->fgColor; } /** * Set foreground/highlight color. * * @param string $value * * @return self */ public function setFgColor($value = null) { $this->fgColor = $value; return $this; } /** * Get background. * * @return string */ public function getBgColor() { return $this->getChildStyleValue($this->shading, 'fill'); } /** * Set background. * * @param string $value * * @return Table */ public function setBgColor($value = null) { $this->setShading(['fill' => $value]); } /** * Get scale. * * @return int */ public function getScale() { return $this->scale; } /** * Set scale. * * @param int $value * * @return self */ public function setScale($value = null) { $this->scale = $this->setIntVal($value, null); return $this; } /** * Get font spacing. * * @return float|int */ public function getSpacing() { return $this->spacing; } /** * Set font spacing. * * @param float|int $value * * @return self */ public function setSpacing($value = null) { $this->spacing = $this->setNumericVal($value, null); return $this; } /** * Get font kerning. * * @return float|int */ public function getKerning() { return $this->kerning; } /** * Set font kerning. * * @param float|int $value * * @return self */ public function setKerning($value = null) { $this->kerning = $this->setNumericVal($value, null); return $this; } /** * Get noProof (disables autocorrect). * * @return bool */ public function isNoProof() { return $this->noProof; } /** * Set noProof (disables autocorrect). * * @param bool $value * * @return $this */ public function setNoProof($value = false) { $this->noProof = $value; return $this; } /** * Get line height. * * @return float|int */ public function getLineHeight() { return $this->getParagraph()->getLineHeight(); } /** * Set lineheight. * * @param float|int|string $value * * @return self */ public function setLineHeight($value) { $this->setParagraph(['lineHeight' => $value]); return $this; } /** * Get paragraph style. * * @return Paragraph */ public function getParagraph() { return $this->paragraph; } /** * Set Paragraph. * * @param mixed $value * * @return self */ public function setParagraph($value = null) { $this->setObjectVal($value, 'Paragraph', $this->paragraph); return $this; } /** * Get rtl. * * @return ?bool */ public function isRTL() { return $this->rtl ?? Settings::isDefaultRtl(); } /** * Set rtl. * * @param ?bool $value * * @return self */ public function setRTL($value = true) { $this->rtl = $this->setBoolVal($value, $this->rtl); return $this; } /** * Get shading. * * @return Shading */ public function getShading() { return $this->shading; } /** * Set shading. * * @param mixed $value * * @return self */ public function setShading($value = null) { $this->setObjectVal($value, 'Shading', $this->shading); return $this; } /** * Get language. * * @return null|Language */ public function getLang() { return $this->lang; } /** * Set language. * * @param mixed $value * * @return self */ public function setLang($value = null) { if (is_string($value) && $value != '') { $value = new Language($value); } $this->setObjectVal($value, 'Language', $this->lang); return $this; } /** * Get hidden text. * * @return bool */ public function isHidden() { return $this->hidden; } /** * Set hidden text. * * @param bool $value * * @return self */ public function setHidden($value = true) { $this->hidden = $this->setBoolVal($value, $this->hidden); return $this; } /** * Get position. * * @return int */ public function getPosition() { return $this->position; } /** * Set position. * * @param int $value * * @return self */ public function setPosition($value = null) { $this->position = $this->setIntVal($value, null); return $this; } /** * Set html css white-space value. It is expected that only pre-wrap and normal (default) are useful. * * @param null|string $value Should be one of pre-wrap, normal, nowrap, pre, pre-line, initial, inherit */ public function setWhiteSpace(?string $value): self { $this->whiteSpace = Validate::validateCSSWhiteSpace($value); return $this; } /** * Get html css white-space value. */ public function getWhiteSpace(): string { return $this->whiteSpace; } /** * Set generic font for fallback for html. * * @param string $value generic font name */ public function setFallbackFont(?string $value): self { $this->fallbackFont = Validate::validateCSSGenericFont($value); return $this; } /** * Get html fallback generic font. */ public function getFallbackFont(): string { return $this->fallbackFont; } } ================================================ FILE: src/PhpWord/Style/Frame.php ================================================ setStyleByArray($style); } /** * @since 0.13.0 * * @return string */ public function getAlignment() { return $this->alignment; } /** * @since 0.13.0 * * @param string $value * * @return self */ public function setAlignment($value) { if (Jc::isValid($value)) { $this->alignment = $value; } return $this; } /** * Get unit. * * @return string */ public function getUnit() { return $this->unit; } /** * Set unit. * * @param string $value * * @return self */ public function setUnit($value) { $this->unit = $value; return $this; } /** * Get width. * * @return float|int */ public function getWidth() { return $this->width; } /** * Set width. * * @param float|int $value * * @return self */ public function setWidth($value = null) { $this->width = $this->setNumericVal($value, null); return $this; } /** * Get height. * * @return float|int */ public function getHeight() { return $this->height; } /** * Set height. * * @param float|int $value * * @return self */ public function setHeight($value = null) { $this->height = $this->setNumericVal($value, null); return $this; } /** * Get left. * * @return float|int */ public function getLeft() { return $this->left; } /** * Set left. * * @param float|int $value * * @return self */ public function setLeft($value = 0) { $this->left = $this->setNumericVal($value, 0); return $this; } /** * Get topmost position. * * @return float|int */ public function getTop() { return $this->top; } /** * Set topmost position. * * @param float|int $value * * @return self */ public function setTop($value = 0) { $this->top = $this->setNumericVal($value, 0); return $this; } /** * Get position type. * * @return string */ public function getPos() { return $this->pos; } /** * Set position type. * * @param string $value * * @return self */ public function setPos($value) { $enum = [ self::POS_ABSOLUTE, self::POS_RELATIVE, ]; $this->pos = $this->setEnumVal($value, $enum, $this->pos); return $this; } /** * Get horizontal position. * * @return string */ public function getHPos() { return $this->hPos; } /** * Set horizontal position. * * @since 0.12.0 "absolute" option is available. * * @param string $value * * @return self */ public function setHPos($value) { $enum = [ self::POS_ABSOLUTE, self::POS_LEFT, self::POS_CENTER, self::POS_RIGHT, self::POS_INSIDE, self::POS_OUTSIDE, ]; $this->hPos = $this->setEnumVal($value, $enum, $this->hPos); return $this; } /** * Get vertical position. * * @return string */ public function getVPos() { return $this->vPos; } /** * Set vertical position. * * @since 0.12.0 "absolute" option is available. * * @param string $value * * @return self */ public function setVPos($value) { $enum = [ self::POS_ABSOLUTE, self::POS_TOP, self::POS_CENTER, self::POS_BOTTOM, self::POS_INSIDE, self::POS_OUTSIDE, ]; $this->vPos = $this->setEnumVal($value, $enum, $this->vPos); return $this; } /** * Get horizontal position relative to. * * @return string */ public function getHPosRelTo() { return $this->hPosRelTo; } /** * Set horizontal position relative to. * * @param string $value * * @return self */ public function setHPosRelTo($value) { $enum = [ self::POS_RELTO_MARGIN, self::POS_RELTO_PAGE, self::POS_RELTO_COLUMN, self::POS_RELTO_CHAR, self::POS_RELTO_LMARGIN, self::POS_RELTO_RMARGIN, self::POS_RELTO_IMARGIN, self::POS_RELTO_OMARGIN, ]; $this->hPosRelTo = $this->setEnumVal($value, $enum, $this->hPosRelTo); return $this; } /** * Get vertical position relative to. * * @return string */ public function getVPosRelTo() { return $this->vPosRelTo; } /** * Set vertical position relative to. * * @param string $value * * @return self */ public function setVPosRelTo($value) { $enum = [ self::POS_RELTO_MARGIN, self::POS_RELTO_PAGE, self::POS_RELTO_TEXT, self::POS_RELTO_LINE, self::POS_RELTO_TMARGIN, self::POS_RELTO_BMARGIN, self::POS_RELTO_IMARGIN, self::POS_RELTO_OMARGIN, ]; $this->vPosRelTo = $this->setEnumVal($value, $enum, $this->vPosRelTo); return $this; } /** * Get wrap type. * * @return string */ public function getWrap() { return $this->wrap; } /** * Set wrap type. * * @param string $value * * @return self */ public function setWrap($value) { $enum = [ self::WRAP_INLINE, self::WRAP_SQUARE, self::WRAP_TIGHT, self::WRAP_THROUGH, self::WRAP_TOPBOTTOM, self::WRAP_BEHIND, self::WRAP_INFRONT, ]; $this->wrap = $this->setEnumVal($value, $enum, $this->wrap); return $this; } /** * Get top distance from text wrap. * * @return float */ public function getWrapDistanceTop() { return $this->wrapDistanceTop; } /** * Set top distance from text wrap. * * @param int $value * * @return self */ public function setWrapDistanceTop($value = null) { $this->wrapDistanceTop = $this->setFloatVal($value, null); return $this; } /** * Get bottom distance from text wrap. * * @return float */ public function getWrapDistanceBottom() { return $this->wrapDistanceBottom; } /** * Set bottom distance from text wrap. * * @param float $value * * @return self */ public function setWrapDistanceBottom($value = null) { $this->wrapDistanceBottom = $this->setFloatVal($value, null); return $this; } /** * Get left distance from text wrap. * * @return float */ public function getWrapDistanceLeft() { return $this->wrapDistanceLeft; } /** * Set left distance from text wrap. * * @param float $value * * @return self */ public function setWrapDistanceLeft($value = null) { $this->wrapDistanceLeft = $this->setFloatVal($value, null); return $this; } /** * Get right distance from text wrap. * * @return float */ public function getWrapDistanceRight() { return $this->wrapDistanceRight; } /** * Set right distance from text wrap. * * @param float $value * * @return self */ public function setWrapDistanceRight($value = null) { $this->wrapDistanceRight = $this->setFloatVal($value, null); return $this; } /** * Get position. * * @return int */ public function getPosition() { return $this->position; } /** * Set position. * * @param int $value * * @return self */ public function setPosition($value = null) { $this->position = $this->setIntVal($value, null); return $this; } } ================================================ FILE: src/PhpWord/Style/Image.php ================================================ setUnit(self::UNIT_PT); // Backward compatibility setting // @todo Remove on 1.0.0 $this->setWrap(self::WRAPPING_STYLE_INLINE); $this->setHPos(self::POSITION_HORIZONTAL_LEFT); $this->setHPosRelTo(self::POSITION_RELATIVE_TO_CHAR); $this->setVPos(self::POSITION_VERTICAL_TOP); $this->setVPosRelTo(self::POSITION_RELATIVE_TO_LINE); } /** * Get margin top. * * @return float|int */ public function getMarginTop() { return $this->getTop(); } /** * Set margin top. * * @ignoreScrutinizerPatch * * @param float|int $value * * @return self */ public function setMarginTop($value = 0) { $this->setTop($value); return $this; } /** * Get margin left. * * @return float|int */ public function getMarginLeft() { return $this->getLeft(); } /** * Set margin left. * * @ignoreScrutinizerPatch * * @param float|int $value * * @return self */ public function setMarginLeft($value = 0) { $this->setLeft($value); return $this; } /** * Get wrapping style. * * @return string */ public function getWrappingStyle() { return $this->getWrap(); } /** * Set wrapping style. * * @param string $wrappingStyle * * @return self */ public function setWrappingStyle($wrappingStyle) { $this->setWrap($wrappingStyle); return $this; } /** * Get positioning type. * * @return string */ public function getPositioning() { return $this->getPos(); } /** * Set positioning type. * * @param string $positioning * * @return self */ public function setPositioning($positioning) { $this->setPos($positioning); return $this; } /** * Get horizontal alignment. * * @return string */ public function getPosHorizontal() { return $this->getHPos(); } /** * Set horizontal alignment. * * @param string $alignment * * @return self */ public function setPosHorizontal($alignment) { $this->setHPos($alignment); return $this; } /** * Get vertical alignment. * * @return string */ public function getPosVertical() { return $this->getVPos(); } /** * Set vertical alignment. * * @param string $alignment * * @return self */ public function setPosVertical($alignment) { $this->setVPos($alignment); return $this; } /** * Get horizontal relation. * * @return string */ public function getPosHorizontalRel() { return $this->getHPosRelTo(); } /** * Set horizontal relation. * * @param string $relto * * @return self */ public function setPosHorizontalRel($relto) { $this->setHPosRelTo($relto); return $this; } /** * Get vertical relation. * * @return string */ public function getPosVerticalRel() { return $this->getVPosRelTo(); } /** * Set vertical relation. * * @param string $relto * * @return self */ public function setPosVerticalRel($relto) { $this->setVPosRelTo($relto); return $this; } } ================================================ FILE: src/PhpWord/Style/Indentation.php ================================================ setStyleByArray($style); } /** * Get left. */ public function getLeft(): ?float { return $this->left; } /** * Set left. */ public function setLeft(?float $value): self { $this->left = $this->setNumericVal($value); return $this; } /** * Get right. */ public function getRight(): ?float { return $this->right; } /** * Set right. */ public function setRight(?float $value): self { $this->right = $this->setNumericVal($value); return $this; } /** * Get first line. */ public function getFirstLine(): ?float { return $this->firstLine; } /** * Set first line. */ public function setFirstLine(?float $value): self { $this->firstLine = $this->setNumericVal($value); return $this; } /** * Get first line chars. */ public function getFirstLineChars(): int { return $this->firstLineChars; } /** * Set first line chars. */ public function setFirstLineChars(int $value): self { $this->firstLineChars = $this->setIntVal($value, $this->firstLineChars); return $this; } /** * Get hanging. */ public function getHanging(): ?float { return $this->hanging; } /** * Set hanging. */ public function setHanging(?float $value = null): self { $this->hanging = $this->setNumericVal($value); return $this; } } ================================================ FILE: src/PhpWord/Style/Language.php ================================================ setLatin($latin); } if (!empty($eastAsia)) { $this->setEastAsia($eastAsia); } if (!empty($bidirectional)) { $this->setBidirectional($bidirectional); } } /** * Set the Latin Language. * * @param string $latin * The value for the latin language */ public function setLatin(?string $latin): self { $this->latin = $this->validateLocale($latin); return $this; } /** * Get the Latin Language. */ public function getLatin(): ?string { return $this->latin; } /** * Set the Language ID. * * @param int $langId * The value for the language ID * * @return self * * @see https://technet.microsoft.com/en-us/library/cc287874(v=office.12).aspx */ public function setLangId($langId) { $this->langId = $langId; return $this; } /** * Get the Language ID. * * @return int */ public function getLangId() { return $this->langId; } /** * Set the East Asian Language. * * @param string $eastAsia * The value for the east asian language * * @return self */ public function setEastAsia($eastAsia) { $this->eastAsia = $this->validateLocale($eastAsia); return $this; } /** * Get the East Asian Language. * * @return null|string */ public function getEastAsia() { return $this->eastAsia; } /** * Set the Complex Script Language. * * @param string $bidirectional * The value for the complex script language * * @return self */ public function setBidirectional($bidirectional) { $this->bidirectional = $this->validateLocale($bidirectional); return $this; } /** * Get the Complex Script Language. * * @return null|string */ public function getBidirectional() { return $this->bidirectional; } /** * Validates that the language passed is in the format xx-xx. * * @param string $locale * * @return string */ private function validateLocale($locale) { if ($locale !== null) { $locale = str_replace('_', '-', $locale); } if ($locale !== null && strlen($locale) === 2) { return strtolower($locale) . '-' . strtoupper($locale); } if ($locale === 'und') { return 'en-EN'; } if ($locale !== null && $locale !== 'zxx' && strstr($locale, '-') === false) { throw new InvalidArgumentException($locale . ' is not a valid language code'); } return $locale; } } ================================================ FILE: src/PhpWord/Style/Line.php ================================================ flip; } /** * Set flip. * * @param bool $value * * @return self */ public function setFlip($value = false) { $this->flip = $this->setBoolVal($value, $this->flip); return $this; } /** * Get connectorType. * * @return string */ public function getConnectorType() { return $this->connectorType; } /** * Set connectorType. * * @param string $value * * @return self */ public function setConnectorType($value = null) { $enum = [ self::CONNECTOR_TYPE_STRAIGHT, ]; $this->connectorType = $this->setEnumVal($value, $enum, $this->connectorType); return $this; } /** * Get weight. * * @return int */ public function getWeight() { return $this->weight; } /** * Set weight. * * @param int $value Weight in points * * @return self */ public function setWeight($value = null) { $this->weight = $this->setNumericVal($value, $this->weight); return $this; } /** * Get color. * * @return string */ public function getColor() { return $this->color; } /** * Set color. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } /** * Get beginArrow. * * @return string */ public function getBeginArrow() { return $this->beginArrow; } /** * Set beginArrow. * * @param string $value * * @return self */ public function setBeginArrow($value = null) { $enum = [ self::ARROW_STYLE_BLOCK, self::ARROW_STYLE_CLASSIC, self::ARROW_STYLE_DIAMOND, self::ARROW_STYLE_OPEN, self::ARROW_STYLE_OVAL, ]; $this->beginArrow = $this->setEnumVal($value, $enum, $this->beginArrow); return $this; } /** * Get endArrow. * * @return string */ public function getEndArrow() { return $this->endArrow; } /** * Set endArrow. * * @param string $value * * @return self */ public function setEndArrow($value = null) { $enum = [ self::ARROW_STYLE_BLOCK, self::ARROW_STYLE_CLASSIC, self::ARROW_STYLE_DIAMOND, self::ARROW_STYLE_OPEN, self::ARROW_STYLE_OVAL, ]; $this->endArrow = $this->setEnumVal($value, $enum, $this->endArrow); return $this; } /** * Get Dash. * * @return string */ public function getDash() { return $this->dash; } /** * Set Dash. * * @param string $value * * @return self */ public function setDash($value = null) { $enum = [ self::DASH_STYLE_DASH, self::DASH_STYLE_DASH_DOT, self::DASH_STYLE_LONG_DASH, self::DASH_STYLE_LONG_DASH_DOT, self::DASH_STYLE_LONG_DASH_DOT_DOT, self::DASH_STYLE_ROUND_DOT, self::DASH_STYLE_SQUARE_DOT, ]; $this->dash = $this->setEnumVal($value, $enum, $this->dash); return $this; } } ================================================ FILE: src/PhpWord/Style/LineNumbering.php ================================================ setStyleByArray($style); } /** * Get start. * * @return int */ public function getStart() { return $this->start; } /** * Set start. * * @param int $value * * @return self */ public function setStart($value = null) { $this->start = $this->setIntVal($value, $this->start); return $this; } /** * Get increment. * * @return int */ public function getIncrement() { return $this->increment; } /** * Set increment. * * @param int $value * * @return self */ public function setIncrement($value = null) { $this->increment = $this->setIntVal($value, $this->increment); return $this; } /** * Get distance. * * @return float|int */ public function getDistance() { return $this->distance; } /** * Set distance. * * @param float|int $value * * @return self */ public function setDistance($value = null) { $this->distance = $this->setNumericVal($value, $this->distance); return $this; } /** * Get restart. * * @return string */ public function getRestart() { return $this->restart; } /** * Set distance. * * @param string $value * * @return self */ public function setRestart($value = null) { $enum = [self::LINE_NUMBERING_CONTINUOUS, self::LINE_NUMBERING_NEW_PAGE, self::LINE_NUMBERING_NEW_SECTION]; $this->restart = $this->setEnumVal($value, $enum, $this->restart); return $this; } } ================================================ FILE: src/PhpWord/Style/ListItem.php ================================================ setNumStyle($numStyle); } else { $this->setListType(); } } /** * Get List Type. * * @return int */ public function getListType() { return $this->listType; } /** * Set legacy list type for version < 0.10.0. * * @param int $value * * @return self */ public function setListType($value = self::TYPE_BULLET_FILLED) { $enum = [ self::TYPE_SQUARE_FILLED, self::TYPE_BULLET_FILLED, self::TYPE_BULLET_EMPTY, self::TYPE_NUMBER, self::TYPE_NUMBER_NESTED, self::TYPE_ALPHANUM, ]; $this->listType = $this->setEnumVal($value, $enum, $this->listType); $this->getListTypeStyle(); return $this; } /** * Get numbering style name. * * @return string */ public function getNumStyle() { return $this->numStyle; } /** * Set numbering style name. * * @param string $value * * @return self */ public function setNumStyle($value) { $this->numStyle = $value; $numStyleObject = Style::getStyle($this->numStyle); if ($numStyleObject instanceof Numbering) { $this->numId = $numStyleObject->getIndex(); $numStyleObject->setNumId($this->numId); } return $this; } /** * Get numbering Id. * * @return int */ public function getNumId() { return $this->numId; } /** * Set numbering Id. Same numId means same list. * * @param mixed $numInt */ public function setNumId($numInt): void { $this->numId = $numInt; $this->getListTypeStyle(); } /** * Get legacy numbering definition. * * @return array * * @since 0.10.0 */ private function getListTypeStyle() { // Check if legacy style already registered in global Style collection $numStyle = 'PHPWordListType' . $this->listType; if ($this->numId) { $numStyle .= 'NumId' . $this->numId; } if (Style::getStyle($numStyle) !== null) { $this->setNumStyle($numStyle); return; } // Property mapping for numbering level information $properties = ['start', 'format', 'text', 'alignment', 'tabPos', 'left', 'hanging', 'font', 'hint']; // Legacy level information $listTypeStyles = [ self::TYPE_SQUARE_FILLED => [ 'type' => 'hybridMultilevel', 'levels' => [ 0 => '1, bullet, , left, 720, 720, 360, Wingdings, default', 1 => '1, bullet, o, left, 1440, 1440, 360, Courier New, default', 2 => '1, bullet, , left, 2160, 2160, 360, Wingdings, default', 3 => '1, bullet, , left, 2880, 2880, 360, Symbol, default', 4 => '1, bullet, o, left, 3600, 3600, 360, Courier New, default', 5 => '1, bullet, , left, 4320, 4320, 360, Wingdings, default', 6 => '1, bullet, , left, 5040, 5040, 360, Symbol, default', 7 => '1, bullet, o, left, 5760, 5760, 360, Courier New, default', 8 => '1, bullet, , left, 6480, 6480, 360, Wingdings, default', ], ], self::TYPE_BULLET_FILLED => [ 'type' => 'hybridMultilevel', 'levels' => [ 0 => '1, bullet, , left, 720, 720, 360, Symbol, default', 1 => '1, bullet, o, left, 1440, 1440, 360, Courier New, default', 2 => '1, bullet, , left, 2160, 2160, 360, Wingdings, default', 3 => '1, bullet, , left, 2880, 2880, 360, Symbol, default', 4 => '1, bullet, o, left, 3600, 3600, 360, Courier New, default', 5 => '1, bullet, , left, 4320, 4320, 360, Wingdings, default', 6 => '1, bullet, , left, 5040, 5040, 360, Symbol, default', 7 => '1, bullet, o, left, 5760, 5760, 360, Courier New, default', 8 => '1, bullet, , left, 6480, 6480, 360, Wingdings, default', ], ], self::TYPE_BULLET_EMPTY => [ 'type' => 'hybridMultilevel', 'levels' => [ 0 => '1, bullet, o, left, 720, 720, 360, Courier New, default', 1 => '1, bullet, o, left, 1440, 1440, 360, Courier New, default', 2 => '1, bullet, , left, 2160, 2160, 360, Wingdings, default', 3 => '1, bullet, , left, 2880, 2880, 360, Symbol, default', 4 => '1, bullet, o, left, 3600, 3600, 360, Courier New, default', 5 => '1, bullet, , left, 4320, 4320, 360, Wingdings, default', 6 => '1, bullet, , left, 5040, 5040, 360, Symbol, default', 7 => '1, bullet, o, left, 5760, 5760, 360, Courier New, default', 8 => '1, bullet, , left, 6480, 6480, 360, Wingdings, default', ], ], self::TYPE_NUMBER => [ 'type' => 'hybridMultilevel', 'levels' => [ 0 => '1, decimal, %1., left, 720, 720, 360, , default', 1 => '1, bullet, o, left, 1440, 1440, 360, Courier New, default', 2 => '1, bullet, , left, 2160, 2160, 360, Wingdings, default', 3 => '1, bullet, , left, 2880, 2880, 360, Symbol, default', 4 => '1, bullet, o, left, 3600, 3600, 360, Courier New, default', 5 => '1, bullet, , left, 4320, 4320, 360, Wingdings, default', 6 => '1, bullet, , left, 5040, 5040, 360, Symbol, default', 7 => '1, bullet, o, left, 5760, 5760, 360, Courier New, default', 8 => '1, bullet, , left, 6480, 6480, 360, Wingdings, default', ], ], self::TYPE_NUMBER_NESTED => [ 'type' => 'multilevel', 'levels' => [ 0 => '1, decimal, %1., left, 360, 360, 360, , ', 1 => '1, decimal, %1.%2., left, 792, 792, 432, , ', 2 => '1, decimal, %1.%2.%3., left, 1224, 1224, 504, , ', 3 => '1, decimal, %1.%2.%3.%4., left, 1800, 1728, 648, , ', 4 => '1, decimal, %1.%2.%3.%4.%5., left, 2520, 2232, 792, , ', 5 => '1, decimal, %1.%2.%3.%4.%5.%6., left, 2880, 2736, 936, , ', 6 => '1, decimal, %1.%2.%3.%4.%5.%6.%7., left, 3600, 3240, 1080, , ', 7 => '1, decimal, %1.%2.%3.%4.%5.%6.%7.%8., left, 3960, 3744, 1224, , ', 8 => '1, decimal, %1.%2.%3.%4.%5.%6.%7.%8.%9., left, 4680, 4320, 1440, , ', ], ], self::TYPE_ALPHANUM => [ 'type' => 'multilevel', 'levels' => [ 0 => '1, decimal, %1., left, 720, 720, 360, , ', 1 => '1, lowerLetter, %2., left, 1440, 1440, 360, , ', 2 => '1, lowerRoman, %3., right, 2160, 2160, 180, , ', 3 => '1, decimal, %4., left, 2880, 2880, 360, , ', 4 => '1, lowerLetter, %5., left, 3600, 3600, 360, , ', 5 => '1, lowerRoman, %6., right, 4320, 4320, 180, , ', 6 => '1, decimal, %7., left, 5040, 5040, 360, , ', 7 => '1, lowerLetter, %8., left, 5760, 5760, 360, , ', 8 => '1, lowerRoman, %9., right, 6480, 6480, 180, , ', ], ], ]; // Populate style and register to global Style register $style = $listTypeStyles[$this->listType]; $numProperties = count($properties); foreach ($style['levels'] as $key => $value) { $level = []; $levelProperties = explode(', ', $value); $level['level'] = $key; for ($i = 0; $i < $numProperties; ++$i) { $property = $properties[$i]; $level[$property] = $levelProperties[$i]; } $style['levels'][$key] = $level; } Style::addNumberingStyle($numStyle, $style); $this->setNumStyle($numStyle); } } ================================================ FILE: src/PhpWord/Style/Numbering.php ================================================ numId; } /** * Set Id. */ public function setNumId(int $value): self { $this->numId = $this->setIntVal($value, $this->numId); return $this; } /** * Get multilevel type. */ public function getType(): ?string { return $this->type; } /** * Set multilevel type. */ public function setType(string $value): self { $enum = ['singleLevel', 'multilevel', 'hybridMultilevel']; $this->type = $this->setEnumVal($value, $enum, $this->type); return $this; } /** * Get levels. * * @return NumberingLevel[] */ public function getLevels(): array { return $this->levels; } /** * Set multilevel type. */ public function setLevels(array $values): self { foreach ($values as $key => $value) { $numberingLevel = new NumberingLevel(); if (is_array($value)) { $numberingLevel->setStyleByArray($value); $numberingLevel->setLevel($key); } $this->levels[$key] = $numberingLevel; } return $this; } } ================================================ FILE: src/PhpWord/Style/NumberingLevel.php ================================================ level; } /** * Set level. * * @param int $value * * @return self */ public function setLevel($value) { $this->level = $this->setIntVal($value, $this->level); return $this; } /** * Get start. * * @return int */ public function getStart() { return $this->start; } /** * Set start. * * @param int $value * * @return self */ public function setStart($value) { $this->start = $this->setIntVal($value, $this->start); return $this; } /** * Get format. * * @return string */ public function getFormat() { return $this->format; } /** * Set format. * * @param string $value * * @return self */ public function setFormat($value) { $this->format = $this->setEnumVal($value, NumberFormat::values(), $this->format); return $this; } /** * Get restart. * * @return int */ public function getRestart() { return $this->restart; } /** * Set restart. * * @param int $value * * @return self */ public function setRestart($value) { $this->restart = $this->setIntVal($value, $this->restart); return $this; } /** * Get related paragraph style. * * @return string */ public function getPStyle() { return $this->pStyle; } /** * Set related paragraph style. * * @param string $value * * @return self */ public function setPStyle($value) { $this->pStyle = $value; return $this; } /** * Get suffix. * * @return string */ public function getSuffix() { return $this->suffix; } /** * Set suffix. * * @param string $value * * @return self */ public function setSuffix($value) { $enum = ['tab', 'space', 'nothing']; $this->suffix = $this->setEnumVal($value, $enum, $this->suffix); return $this; } /** * Get text. * * @return string */ public function getText() { return $this->text; } /** * Set text. * * @param string $value * * @return self */ public function setText($value) { $this->text = $value; return $this; } /** * @since 0.13.0 * * @return string */ public function getAlignment() { return $this->alignment; } /** * @since 0.13.0 * * @param string $value * * @return self */ public function setAlignment($value) { if (Jc::isValid($value)) { $this->alignment = $value; } return $this; } /** * Get left. * * @return int */ public function getLeft() { return $this->left; } /** * Set left. * * @param int $value * * @return self */ public function setLeft($value) { $this->left = $this->setIntVal($value, $this->left); return $this; } /** * Get hanging. * * @return int */ public function getHanging() { return $this->hanging; } /** * Set hanging. * * @param int $value * * @return self */ public function setHanging($value) { $this->hanging = $this->setIntVal($value, $this->hanging); return $this; } /** * Get tab. * * @return int */ public function getTabPos() { return $this->tabPos; } /** * Set tab. * * @param int $value * * @return self */ public function setTabPos($value) { $this->tabPos = $this->setIntVal($value, $this->tabPos); return $this; } /** * Get font. * * @return string */ public function getFont() { return $this->font; } /** * Set font. * * @param string $value * * @return self */ public function setFont($value) { $this->font = $value; return $this; } /** * Get hint. * * @return string */ public function getHint() { return $this->hint; } /** * Set hint. * * @param string $value * * @return self */ public function setHint($value = null) { $enum = ['default', 'eastAsia', 'cs']; $this->hint = $this->setEnumVal($value, $enum, $this->hint); return $this; } } ================================================ FILE: src/PhpWord/Style/Outline.php ================================================ setStyleByArray($style); } /** * Get unit. * * @return string */ public function getUnit() { return $this->unit; } /** * Get weight. * * @return float|int */ public function getWeight() { return $this->weight; } /** * Set weight. * * @param float|int $value * * @return self */ public function setWeight($value = null) { $this->weight = $this->setNumericVal($value, null); return $this; } /** * Get color. * * @return string */ public function getColor() { return $this->color; } /** * Set color. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } /** * Get dash type. * * @return string */ public function getDash() { return $this->dash; } /** * Set dash type. * * @param string $value * * @return self */ public function setDash($value = null) { $this->dash = $value; return $this; } /** * Get line style. * * @return string */ public function getLine() { return $this->line; } /** * Set line style. * * @param string $value * * @return self */ public function setLine($value = null) { $enum = [self::LINE_SINGLE, self::LINE_THIN_THIN, self::LINE_THIN_THICK, self::LINE_THICK_THIN, self::LINE_THICK_BETWEEN_THIN, ]; $this->line = $this->setEnumVal($value, $enum, null); return $this; } /** * Get endCap style. * * @return string */ public function getEndCap() { return $this->endCap; } /** * Set endCap style. * * @param string $value * * @return self */ public function setEndCap($value = null) { $enum = [self::ENDCAP_FLAT, self::ENDCAP_SQUARE, self::ENDCAP_ROUND]; $this->endCap = $this->setEnumVal($value, $enum, null); return $this; } /** * Get startArrow. * * @return string */ public function getStartArrow() { return $this->startArrow; } /** * Set pattern. * * @param string $value * * @return self */ public function setStartArrow($value = null) { $enum = [self::ARROW_NONE, self::ARROW_BLOCK, self::ARROW_CLASSIC, self::ARROW_OVAL, self::ARROW_DIAMOND, self::ARROW_OPEN, ]; $this->startArrow = $this->setEnumVal($value, $enum, null); return $this; } /** * Get endArrow. * * @return string */ public function getEndArrow() { return $this->endArrow; } /** * Set pattern. * * @param string $value * * @return self */ public function setEndArrow($value = null) { $enum = [self::ARROW_NONE, self::ARROW_BLOCK, self::ARROW_CLASSIC, self::ARROW_OVAL, self::ARROW_DIAMOND, self::ARROW_OPEN, ]; $this->endArrow = $this->setEnumVal($value, $enum, null); return $this; } } ================================================ FILE: src/PhpWord/Style/Paper.php ================================================ [297, 420, 'mm'], 'A4' => [210, 297, 'mm'], 'A5' => [148, 210, 'mm'], 'B5' => [176, 250, 'mm'], 'Folio' => [8.5, 13, 'in'], 'Legal' => [8.5, 14, 'in'], 'Letter' => [8.5, 11, 'in'], ]; /** * Paper size. * * @var string */ private $size = 'A4'; /** * Width. * * @var float (twip) */ private $width; /** * Height. * * @var float (twip) */ private $height; /** * Create a new instance. * * @param string $size */ public function __construct($size = 'A4') { $this->setSize($size); } /** * Get size. * * @return string */ public function getSize() { return $this->size; } /** * Set size. * * @param string $size * * @return self */ public function setSize($size) { $this->size = $this->setEnumVal($size, array_keys($this->sizes), $this->size); [$width, $height, $unit] = $this->sizes[$this->size]; if ($unit == 'mm') { $this->width = Converter::cmToTwip($width / 10); $this->height = Converter::cmToTwip($height / 10); } else { $this->width = Converter::inchToTwip($width); $this->height = Converter::inchToTwip($height); } return $this; } /** * Get width. * * @return float */ public function getWidth() { return $this->width; } /** * Get height. * * @return float */ public function getHeight() { return $this->height; } } ================================================ FILE: src/PhpWord/Style/Paragraph.php ================================================ 'lineHeight', 'line-spacing' => 'spacing']; /** * Parent style. * * @var string */ private $basedOn = 'Normal'; /** * Style for next paragraph. * * @var string */ private $next; /** * @var string */ private $alignment = ''; /** * Indentation. * * @var null|Indentation */ private $indentation; /** * Spacing. * * @var Spacing */ private $spacing; /** * Text line height. * * @var null|float|int */ private $lineHeight; /** * Allow first/last line to display on a separate page. * * @var bool */ private $widowControl = true; /** * Keep paragraph with next paragraph. * * @var bool */ private $keepNext = false; /** * Keep all lines on one page. * * @var bool */ private $keepLines = false; /** * Start paragraph on next page. * * @var bool */ private $pageBreakBefore = false; /** * Numbering style name. * * @var string */ private $numStyle; /** * Numbering level. * * @var int */ private $numLevel = 0; /** * Set of Custom Tab Stops. * * @var Tab[] */ private $tabs = []; /** * Shading. * * @var Shading */ private $shading; /** * Ignore Spacing Above and Below When Using Identical Styles. * * @var bool */ private $contextualSpacing = false; /** * Right to Left Paragraph Layout. * * @var ?bool */ private $bidi; /** * Vertical Character Alignment on Line. * * @var string */ private $textAlignment; /** * Suppress hyphenation for paragraph. * * @var bool */ private $suppressAutoHyphens = false; /** * Set Style value. * * @param string $key * @param mixed $value * * @return self */ public function setStyleValue($key, $value) { $key = Text::removeUnderscorePrefix($key); if ('indent' == $key || 'hanging' == $key) { $value = $value * 720; // 720 twips is 0.5 inch } return parent::setStyleValue($key, $value); } /** * Get style values. * * An experiment to retrieve all style values in one function. This will * reduce function call and increase cohesion between functions. Should be * implemented in all styles. * * @ignoreScrutinizerPatch * * @return array */ public function getStyleValues() { $styles = [ 'name' => $this->getStyleName(), 'basedOn' => $this->getBasedOn(), 'next' => $this->getNext(), 'alignment' => $this->getAlignment(), 'indentation' => $this->getIndentation(), 'spacing' => $this->getSpace(), 'pagination' => [ 'widowControl' => $this->hasWidowControl(), 'keepNext' => $this->isKeepNext(), 'keepLines' => $this->isKeepLines(), 'pageBreak' => $this->hasPageBreakBefore(), ], 'numbering' => [ 'style' => $this->getNumStyle(), 'level' => $this->getNumLevel(), ], 'tabs' => $this->getTabs(), 'shading' => $this->getShading(), 'contextualSpacing' => $this->hasContextualSpacing(), 'bidi' => $this->isBidi(), 'textAlignment' => $this->getTextAlignment(), 'suppressAutoHyphens' => $this->hasSuppressAutoHyphens(), ]; return $styles; } /** * @since 0.13.0 * * @return string */ public function getAlignment() { return $this->alignment; } /** * @since 0.13.0 * * @param string $value * * @return self */ public function setAlignment($value) { if (Jc::isValid($value)) { $this->alignment = $value; } return $this; } /** * Get parent style ID. * * @return string */ public function getBasedOn() { return $this->basedOn; } /** * Set parent style ID. * * @param string $value * * @return self */ public function setBasedOn($value = 'Normal') { $this->basedOn = $value; return $this; } /** * Get style for next paragraph. * * @return string */ public function getNext() { return $this->next; } /** * Set style for next paragraph. * * @param string $value * * @return self */ public function setNext($value = null) { $this->next = $value; return $this; } /** * Get hanging. */ public function getHanging(): ?float { return $this->getChildStyleValue($this->indentation, 'hanging'); } /** * Get indentation. * * @deprecated 1.4.0 Use getIndentLeft */ public function getIndent(): ?float { return $this->getChildStyleValue($this->indentation, 'left'); } /** * Get indentation. */ public function getIndentation(): ?Indentation { return $this->indentation; } /** * Get firstLine. */ public function getIndentFirstLine(): ?float { return $this->getChildStyleValue($this->indentation, 'firstLine'); } /** * Get left indentation. */ public function getIndentLeft(): ?float { return $this->getChildStyleValue($this->indentation, 'left'); } /** * Get right indentation. */ public function getIndentRight(): ?float { return $this->getChildStyleValue($this->indentation, 'right'); } /** * Set hanging. * * @deprecated 1.4.0 Use setIndentHanging */ public function setHanging(?float $value = null): self { return $this->setIndentation(['hanging' => $value]); } /** * Set indentation. * * @deprecated 1.4.0 Use setIndentLeft */ public function setIndent(?float $value = null): self { return $this->setIndentation(['left' => $value]); } /** * Set indentation. * * @param array{ * left?:null|float|int|numeric-string, * right?:null|float|int|numeric-string, * hanging?:null|float|int|numeric-string, * firstLine?:null|float|int|numeric-string * } $value */ public function setIndentation(array $value = []): self { $value = array_map(function ($indent) { if (is_string($indent) || is_numeric($indent)) { $indent = $this->setFloatVal($indent); } return $indent; }, $value); $this->setObjectVal($value, 'Indentation', $this->indentation); return $this; } /** * Set hanging indentation. */ public function setIndentHanging(?float $value = null): self { return $this->setIndentation(['hanging' => $value]); } /** * Set firstline indentation. */ public function setIndentFirstLine(?float $value = null): self { return $this->setIndentation(['firstLine' => $value]); } /** * Set firstlineChars indentation. */ public function setIndentFirstLineChars(int $value = 0): self { return $this->setIndentation(['firstLineChars' => $value]); } /** * Set left indentation. */ public function setIndentLeft(?float $value = null): self { return $this->setIndentation(['left' => $value]); } /** * Set right indentation. */ public function setIndentRight(?float $value = null): self { return $this->setIndentation(['right' => $value]); } /** * Get spacing. * * @return Spacing * * @todo Rename to getSpacing in 1.0 */ public function getSpace() { return $this->spacing; } /** * Set spacing. * * @param mixed $value * * @return self * * @todo Rename to setSpacing in 1.0 */ public function setSpace($value = null) { $this->setObjectVal($value, 'Spacing', $this->spacing); return $this; } /** * Get space before paragraph. * * @return null|float|int */ public function getSpaceBefore() { return $this->getChildStyleValue($this->spacing, 'before'); } /** * Set space before paragraph. * * @param null|float|int $value * * @return self */ public function setSpaceBefore($value = null) { return $this->setSpace(['before' => $value]); } /** * Get space after paragraph. * * @return null|float|int */ public function getSpaceAfter() { return $this->getChildStyleValue($this->spacing, 'after'); } /** * Set space after paragraph. * * @param null|float|int $value * * @return self */ public function setSpaceAfter($value = null) { return $this->setSpace(['after' => $value]); } /** * Get spacing between lines. * * @return null|float|int */ public function getSpacing() { return $this->getChildStyleValue($this->spacing, 'line'); } /** * Set spacing between lines. * * @param null|float|int $value * * @return self */ public function setSpacing($value = null) { return $this->setSpace(['line' => $value]); } /** * Get spacing line rule. * * @return string */ public function getSpacingLineRule() { return $this->getChildStyleValue($this->spacing, 'lineRule'); } /** * Set the spacing line rule. * * @param string $value Possible values are defined in LineSpacingRule * * @return Paragraph */ public function setSpacingLineRule($value) { return $this->setSpace(['lineRule' => $value]); } /** * Get line height. * * @return null|float|int */ public function getLineHeight() { return $this->lineHeight; } /** * Set the line height. * * @param float|int|string $lineHeight * * @return self */ public function setLineHeight($lineHeight) { if (is_string($lineHeight)) { $lineHeight = (float) (preg_replace('/[^0-9\.\,]/', '', $lineHeight)); } if ((!is_int($lineHeight) && !is_float($lineHeight)) || !$lineHeight) { throw new InvalidStyleException('Line height must be a valid number'); } $this->lineHeight = $lineHeight; $this->setSpacing(($lineHeight - 1) * self::LINE_HEIGHT); $this->setSpacingLineRule(\PhpOffice\PhpWord\SimpleType\LineSpacingRule::AUTO); return $this; } /** * Get allow first/last line to display on a separate page setting. * * @return bool */ public function hasWidowControl() { return $this->widowControl; } /** * Set keep paragraph with next paragraph setting. * * @param bool $value * * @return self */ public function setWidowControl($value = true) { $this->widowControl = $this->setBoolVal($value, $this->widowControl); return $this; } /** * Get keep paragraph with next paragraph setting. * * @return bool */ public function isKeepNext() { return $this->keepNext; } /** * Set keep paragraph with next paragraph setting. * * @param bool $value * * @return self */ public function setKeepNext($value = true) { $this->keepNext = $this->setBoolVal($value, $this->keepNext); return $this; } /** * Get keep all lines on one page setting. * * @return bool */ public function isKeepLines() { return $this->keepLines; } /** * Set keep all lines on one page setting. * * @param bool $value * * @return self */ public function setKeepLines($value = true) { $this->keepLines = $this->setBoolVal($value, $this->keepLines); return $this; } /** * Get start paragraph on next page setting. * * @return bool */ public function hasPageBreakBefore() { return $this->pageBreakBefore; } /** * Set start paragraph on next page setting. * * @param bool $value * * @return self */ public function setPageBreakBefore($value = true) { $this->pageBreakBefore = $this->setBoolVal($value, $this->pageBreakBefore); return $this; } /** * Get numbering style name. * * @return string */ public function getNumStyle() { return $this->numStyle; } /** * Set numbering style name. * * @param string $value * * @return self */ public function setNumStyle($value) { $this->numStyle = $value; return $this; } /** * Get numbering level. * * @return int */ public function getNumLevel() { return $this->numLevel; } /** * Set numbering level. * * @param int $value * * @return self */ public function setNumLevel($value = 0) { $this->numLevel = $this->setIntVal($value, $this->numLevel); return $this; } /** * Get tabs. * * @return Tab[] */ public function getTabs() { return $this->tabs; } /** * Set tabs. * * @param array $value * * @return self */ public function setTabs($value = null) { if (is_array($value)) { $this->tabs = $value; } return $this; } /** * Get shading. * * @return Shading */ public function getShading() { return $this->shading; } /** * Set shading. * * @param mixed $value * * @return self */ public function setShading($value = null) { $this->setObjectVal($value, 'Shading', $this->shading); return $this; } /** * Get contextualSpacing. * * @return bool */ public function hasContextualSpacing() { return $this->contextualSpacing; } /** * Set contextualSpacing. * * @param bool $contextualSpacing * * @return self */ public function setContextualSpacing($contextualSpacing) { $this->contextualSpacing = $contextualSpacing; return $this; } /** * Get bidirectional. * * @return ?bool */ public function isBidi() { return $this->bidi ?? Settings::isDefaultRtl(); } /** * Set bidi. * * @param ?bool $bidi * Set to true to write from right to left * * @return self */ public function setBidi($bidi) { $this->bidi = $bidi; return $this; } /** * Get textAlignment. * * @return string */ public function getTextAlignment() { return $this->textAlignment; } /** * Set textAlignment. * * @param string $textAlignment * * @return self */ public function setTextAlignment($textAlignment) { TextAlignment::validate($textAlignment); $this->textAlignment = $textAlignment; return $this; } /** * @return bool */ public function hasSuppressAutoHyphens() { return $this->suppressAutoHyphens; } /** * @param bool $suppressAutoHyphens */ public function setSuppressAutoHyphens($suppressAutoHyphens): void { $this->suppressAutoHyphens = (bool) $suppressAutoHyphens; } } ================================================ FILE: src/PhpWord/Style/Row.php ================================================ tblHeader; } /** * Is tblHeader. */ public function setTblHeader(bool $value = true): self { $this->tblHeader = $this->setBoolVal($value, $this->tblHeader); return $this; } /** * Is cantSplit. */ public function isCantSplit(): bool { return $this->cantSplit; } /** * Is cantSplit. */ public function setCantSplit(bool $value = true): self { $this->cantSplit = $this->setBoolVal($value, $this->cantSplit); return $this; } /** * Is exactHeight. */ public function isExactHeight(): bool { return $this->exactHeight; } /** * Set exactHeight. */ public function setExactHeight(bool $value = true): self { $this->exactHeight = $this->setBoolVal($value, $this->exactHeight); return $this; } } ================================================ FILE: src/PhpWord/Style/Section.php ================================================ setPaperSize(); } /** * Get paper size. * * @return string */ public function getPaperSize() { return $this->paper->getSize(); } /** * Set paper size. * * @param string $value * * @return self */ public function setPaperSize($value = '') { if (!$value) { $value = Settings::getDefaultPaper(); } if ($this->paper === null) { $this->paper = new Paper(); } $this->paper->setSize($value); $this->pageSizeW = $this->paper->getWidth(); $this->pageSizeH = $this->paper->getHeight(); return $this; } /** * Set Setting Value. * * @param string $key * @param array|int|string $value * * @return self */ public function setSettingValue($key, $value) { return $this->setStyleValue($key, $value); } /** * Set orientation. * * @param string $value * * @return self */ public function setOrientation($value = null) { $enum = [self::ORIENTATION_PORTRAIT, self::ORIENTATION_LANDSCAPE]; $this->orientation = $this->setEnumVal($value, $enum, $this->orientation); /** @var float|int $longSide Type hint */ $longSide = $this->pageSizeW >= $this->pageSizeH ? $this->pageSizeW : $this->pageSizeH; /** @var float|int $shortSide Type hint */ $shortSide = $this->pageSizeW < $this->pageSizeH ? $this->pageSizeW : $this->pageSizeH; if ($this->orientation == self::ORIENTATION_PORTRAIT) { $this->pageSizeW = $shortSide; $this->pageSizeH = $longSide; } else { $this->pageSizeW = $longSide; $this->pageSizeH = $shortSide; } return $this; } /** * Get Page Orientation. * * @return string */ public function getOrientation() { return $this->orientation; } /** * Set Portrait Orientation. * * @return self */ public function setPortrait() { return $this->setOrientation(self::ORIENTATION_PORTRAIT); } /** * Set Landscape Orientation. * * @return self */ public function setLandscape() { return $this->setOrientation(self::ORIENTATION_LANDSCAPE); } /** * Get Page Size Width. * * @return null|float|int * * @since 0.12.0 */ public function getPageSizeW() { return $this->pageSizeW; } /** * @param null|float|int $value * * @return Section * * @since 0.12.0 */ public function setPageSizeW($value = null) { $this->pageSizeW = $this->setNumericVal($value, self::DEFAULT_WIDTH); return $this; } /** * Get Page Size Height. * * @return null|float|int * * @since 0.12.0 */ public function getPageSizeH() { return $this->pageSizeH; } /** * @param null|float|int $value * * @return Section * * @since 0.12.0 */ public function setPageSizeH($value = null) { $this->pageSizeH = $this->setNumericVal($value, self::DEFAULT_HEIGHT); return $this; } /** * Get gutter. * * @return float|int */ public function getGutter() { return $this->gutter; } /** * Set gutter. * * @param float|int $value * * @return self */ public function setGutter($value = null) { $this->gutter = $this->setNumericVal($value, self::DEFAULT_GUTTER); return $this; } /** * Get Header Height. * * @return float|int */ public function getHeaderHeight() { return $this->headerHeight; } /** * Set Header Height. * * @param float|int $value * * @return self */ public function setHeaderHeight($value = null) { $this->headerHeight = $this->setNumericVal($value, self::DEFAULT_HEADER_HEIGHT); return $this; } /** * Get Footer Height. * * @return float|int */ public function getFooterHeight() { return $this->footerHeight; } /** * Set Footer Height. * * @param float|int $value * * @return self */ public function setFooterHeight($value = null) { $this->footerHeight = $this->setNumericVal($value, self::DEFAULT_FOOTER_HEIGHT); return $this; } /** * Get page numbering start. * * @return null|int */ public function getPageNumberingStart() { return $this->pageNumberingStart; } /** * Set page numbering start. * * @param null|int $pageNumberingStart * * @return self */ public function setPageNumberingStart($pageNumberingStart = null) { $this->pageNumberingStart = $pageNumberingStart; return $this; } /** * Get Section Columns Count. * * @return int */ public function getColsNum() { return $this->colsNum; } /** * Set Section Columns Count. * * @param int $value * * @return self */ public function setColsNum($value = null) { $this->colsNum = $this->setIntVal($value, self::DEFAULT_COLUMN_COUNT); return $this; } /** * Get Section Space Between Columns. * * @return float|int */ public function getColsSpace() { return $this->colsSpace; } /** * Set Section Space Between Columns. * * @param float|int $value * * @return self */ public function setColsSpace($value = null) { $this->colsSpace = $this->setNumericVal($value, self::DEFAULT_COLUMN_SPACING); return $this; } /** * Get Break Type. * * @return ?string */ public function getBreakType() { return $this->breakType; } /** * Set Break Type. * * @param string $value * * @return self */ public function setBreakType($value = null) { $this->breakType = $value; return $this; } /** * Get line numbering. * * @return LineNumbering */ public function getLineNumbering() { return $this->lineNumbering; } /** * Set line numbering. * * @param mixed $value * * @return self */ public function setLineNumbering($value = null) { $this->setObjectVal($value, 'LineNumbering', $this->lineNumbering); return $this; } /** * Get vertical alignment. * * @return ?string */ public function getVAlign() { return $this->vAlign; } /** * Set vertical alignment. * * @param string $value * * @return self */ public function setVAlign($value = null) { VerticalJc::validate($value); $this->vAlign = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/Shading.php ================================================ setStyleByArray($style); } /** * Get pattern. * * @return string */ public function getPattern() { return $this->pattern; } /** * Set pattern. * * @param string $value * * @return self */ public function setPattern($value = null) { $enum = [ self::PATTERN_CLEAR, self::PATTERN_SOLID, self::PATTERN_HSTRIPE, self::PATTERN_VSTRIPE, self::PATTERN_DSTRIPE, self::PATTERN_HCROSS, self::PATTERN_DCROSS, ]; $this->pattern = $this->setEnumVal($value, $enum, $this->pattern); return $this; } /** * Get color. * * @return string */ public function getColor() { return $this->color; } /** * Set pattern. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } /** * Get fill. * * @return string */ public function getFill() { return $this->fill; } /** * Set fill. * * @param string $value * * @return self */ public function setFill($value = null) { $this->fill = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/Shadow.php ================================================ setStyleByArray($style); } /** * Get color. * * @return string */ public function getColor() { return $this->color; } /** * Set color. * * @param string $value * * @return self */ public function setColor($value = null) { $this->color = $value; return $this; } /** * Get offset. * * @return string */ public function getOffset() { return $this->offset; } /** * Set offset. * * @param string $value * * @return self */ public function setOffset($value = null) { $this->offset = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/Shape.php ================================================ setStyleByArray($style); } /** * Get points. * * @return string */ public function getPoints() { return $this->points; } /** * Set points. * * @param string $value * * @return self */ public function setPoints($value = null) { $this->points = $value; return $this; } /** * Get roundness. * * @return float|int */ public function getRoundness() { return $this->roundness; } /** * Set roundness. * * @param float|int $value * * @return self */ public function setRoundness($value = null) { $this->roundness = $this->setNumericVal($value, null); return $this; } /** * Get frame. * * @return Frame */ public function getFrame() { return $this->frame; } /** * Set frame. * * @param mixed $value * * @return self */ public function setFrame($value = null) { $this->setObjectVal($value, 'Frame', $this->frame); return $this; } /** * Get fill. * * @return Fill */ public function getFill() { return $this->fill; } /** * Set fill. * * @param mixed $value * * @return self */ public function setFill($value = null) { $this->setObjectVal($value, 'Fill', $this->fill); return $this; } /** * Get outline. * * @return Outline */ public function getOutline() { return $this->outline; } /** * Set outline. * * @param mixed $value * * @return self */ public function setOutline($value = null) { $this->setObjectVal($value, 'Outline', $this->outline); return $this; } /** * Get shadow. * * @return Shadow */ public function getShadow() { return $this->shadow; } /** * Set shadow. * * @param mixed $value * * @return self */ public function setShadow($value = null) { $this->setObjectVal($value, 'Shadow', $this->shadow); return $this; } /** * Get 3D extrusion. * * @return Extrusion */ public function getExtrusion() { return $this->extrusion; } /** * Set 3D extrusion. * * @param mixed $value * * @return self */ public function setExtrusion($value = null) { $this->setObjectVal($value, 'Extrusion', $this->extrusion); return $this; } } ================================================ FILE: src/PhpWord/Style/Spacing.php ================================================ setStyleByArray($style); } /** * Get before. * * @return null|float|int */ public function getBefore() { return $this->before; } /** * Set before. * * @param null|float|int $value * * @return self */ public function setBefore($value = null) { $this->before = $this->setNumericVal($value, $this->before); return $this; } /** * Get after. * * @return null|float|int */ public function getAfter() { return $this->after; } /** * Set after. * * @param null|float|int $value * * @return self */ public function setAfter($value = null) { $this->after = $this->setNumericVal($value, $this->after); return $this; } /** * Get line. * * @return null|float|int */ public function getLine() { return $this->line; } /** * Set distance. * * @param null|float|int $value * * @return self */ public function setLine($value = null) { $this->line = $this->setNumericVal($value, $this->line); return $this; } /** * Get line rule. * * @return string */ public function getLineRule() { return $this->lineRule; } /** * Set line rule. * * @param string $value * * @return self */ public function setLineRule($value = null) { LineSpacingRule::validate($value); $this->lineRule = $value; return $this; } } ================================================ FILE: src/PhpWord/Style/TOC.php ================================================ getPosition(); } /** * Set Tab Position. * * @param float|int $value * * @return self */ public function setTabPos($value) { return $this->setPosition($value); } /** * Get Tab Leader. * * @return string */ public function getTabLeader() { return $this->getLeader(); } /** * Set Tab Leader. * * @param string $value * * @return self */ public function setTabLeader($value = self::TAB_LEADER_DOT) { return $this->setLeader($value); } /** * Get Indent. * * @return float|int */ public function getIndent() { return $this->indent; } /** * Set Indent. * * @param float|int $value * * @return self */ public function setIndent($value) { $this->indent = $this->setNumericVal($value, $this->indent); return $this; } } ================================================ FILE: src/PhpWord/Style/Tab.php ================================================ type = $this->setEnumVal($type, $stopTypes, $this->type); $this->position = $this->setNumericVal($position, $this->position); $this->leader = $this->setEnumVal($leader, $leaderTypes, $this->leader); } /** * Get stop type. * * @return string */ public function getType() { return $this->type; } /** * Set stop type. * * @param string $value * * @return self */ public function setType($value) { $enum = [ self::TAB_STOP_CLEAR, self::TAB_STOP_LEFT, self::TAB_STOP_CENTER, self::TAB_STOP_RIGHT, self::TAB_STOP_DECIMAL, self::TAB_STOP_BAR, self::TAB_STOP_NUM, ]; $this->type = $this->setEnumVal($value, $enum, $this->type); return $this; } /** * Get leader. * * @return string */ public function getLeader() { return $this->leader; } /** * Set leader. * * @param string $value * * @return self */ public function setLeader($value) { $enum = [ self::TAB_LEADER_NONE, self::TAB_LEADER_DOT, self::TAB_LEADER_HYPHEN, self::TAB_LEADER_UNDERSCORE, self::TAB_LEADER_HEAVY, self::TAB_LEADER_MIDDLEDOT, ]; $this->leader = $this->setEnumVal($value, $enum, $this->leader); return $this; } /** * Get position. * * @return float|int */ public function getPosition() { return $this->position; } /** * Set position. * * @param float|int $value * * @return self */ public function setPosition($value) { $this->position = $this->setNumericVal($value, $this->position); return $this; } } ================================================ FILE: src/PhpWord/Style/Table.php ================================================ firstRowStyle = clone $this; $this->firstRowStyle->isFirstRow = true; unset( $this->firstRowStyle->firstRowStyle, $this->firstRowStyle->borderInsideHSize, $this->firstRowStyle->borderInsideHColor, $this->firstRowStyle->borderInsideVSize, $this->firstRowStyle->borderInsideVColor, $this->firstRowStyle->cellMarginTop, $this->firstRowStyle->cellMarginLeft, $this->firstRowStyle->cellMarginRight, $this->firstRowStyle->cellMarginBottom, $this->firstRowStyle->cellSpacing ); $this->firstRowStyle->setStyleByArray($firstRowStyle); } if ($tableStyle !== null) { $this->setStyleByArray($tableStyle); } } /** * @param null|float|int $cellSpacing */ public function setCellSpacing($cellSpacing = null): self { $this->cellSpacing = $cellSpacing; return $this; } /** * @return null|float|int */ public function getCellSpacing() { return $this->cellSpacing; } /** * Set first row. * * @return Table */ public function getFirstRow() { return $this->firstRowStyle; } /** * Get background. * * @return ?string */ public function getBgColor() { if ($this->shading !== null) { return $this->shading->getFill(); } return null; } /** * Set background. * * @param string $value * * @return self */ public function setBgColor($value = null) { $this->setShading(['fill' => $value]); return $this; } /** * Get TLRBHV Border Size. * * @return int[] */ public function getBorderSize() { return [ $this->getBorderTopSize(), $this->getBorderLeftSize(), $this->getBorderRightSize(), $this->getBorderBottomSize(), $this->getBorderInsideHSize(), $this->getBorderInsideVSize(), ]; } /** * Set TLRBHV Border Size. * * @param int $value Border size in eighths of a point (1/8 point) * * @return self */ public function setBorderSize($value = null) { $this->setBorderTopSize($value); $this->setBorderLeftSize($value); $this->setBorderRightSize($value); $this->setBorderBottomSize($value); $this->setBorderInsideHSize($value); $this->setBorderInsideVSize($value); return $this; } /** * Get TLRBHV Border Color. * * @return string[] */ public function getBorderColor() { return [ $this->getBorderTopColor(), $this->getBorderLeftColor(), $this->getBorderRightColor(), $this->getBorderBottomColor(), $this->getBorderInsideHColor(), $this->getBorderInsideVColor(), ]; } /** * Set TLRBHV Border Color. * * @param string $value * * @return self */ public function setBorderColor($value = null) { $this->setBorderTopColor($value); $this->setBorderLeftColor($value); $this->setBorderRightColor($value); $this->setBorderBottomColor($value); $this->setBorderInsideHColor($value); $this->setBorderInsideVColor($value); return $this; } /** * Get border size inside horizontal. * * @return int */ public function getBorderInsideHSize() { return $this->getTableOnlyProperty('borderInsideHSize'); } /** * Set border size inside horizontal. * * @param int $value * * @return self */ public function setBorderInsideHSize($value = null) { return $this->setTableOnlyProperty('borderInsideHSize', $value); } /** * Get border color inside horizontal. * * @return string */ public function getBorderInsideHColor() { return $this->getTableOnlyProperty('borderInsideHColor'); } /** * Set border color inside horizontal. * * @param string $value * * @return self */ public function setBorderInsideHColor($value = null) { return $this->setTableOnlyProperty('borderInsideHColor', $value, false); } /** * Get border size inside vertical. * * @return int */ public function getBorderInsideVSize() { return $this->getTableOnlyProperty('borderInsideVSize'); } /** * Set border size inside vertical. * * @param int $value * * @return self */ public function setBorderInsideVSize($value = null) { return $this->setTableOnlyProperty('borderInsideVSize', $value); } /** * Get border color inside vertical. * * @return string */ public function getBorderInsideVColor() { return $this->getTableOnlyProperty('borderInsideVColor'); } /** * Set border color inside vertical. * * @param string $value * * @return self */ public function setBorderInsideVColor($value = null) { return $this->setTableOnlyProperty('borderInsideVColor', $value, false); } /** * Get cell margin top. * * @return int */ public function getCellMarginTop() { return $this->getTableOnlyProperty('cellMarginTop'); } /** * Set cell margin top. * * @param int $value * * @return self */ public function setCellMarginTop($value = null) { return $this->setTableOnlyProperty('cellMarginTop', $value); } /** * Get cell margin left. * * @return int */ public function getCellMarginLeft() { return $this->getTableOnlyProperty('cellMarginLeft'); } /** * Set cell margin left. * * @param int $value * * @return self */ public function setCellMarginLeft($value = null) { return $this->setTableOnlyProperty('cellMarginLeft', $value); } /** * Get cell margin right. * * @return int */ public function getCellMarginRight() { return $this->getTableOnlyProperty('cellMarginRight'); } /** * Set cell margin right. * * @param int $value * * @return self */ public function setCellMarginRight($value = null) { return $this->setTableOnlyProperty('cellMarginRight', $value); } /** * Get cell margin bottom. * * @return int */ public function getCellMarginBottom() { return $this->getTableOnlyProperty('cellMarginBottom'); } /** * Set cell margin bottom. * * @param int $value * * @return self */ public function setCellMarginBottom($value = null) { return $this->setTableOnlyProperty('cellMarginBottom', $value); } /** * Get cell margin. * * @return int[] */ public function getCellMargin() { return [ $this->cellMarginTop, $this->cellMarginLeft, $this->cellMarginRight, $this->cellMarginBottom, ]; } /** * Set TLRB cell margin. * * @param int $value Margin in twips * * @return self */ public function setCellMargin($value = null) { $this->setCellMarginTop($value); $this->setCellMarginLeft($value); $this->setCellMarginRight($value); $this->setCellMarginBottom($value); return $this; } /** * Check if any of the margin is not null. * * @return bool */ public function hasMargin() { $margins = $this->getCellMargin(); return $margins !== array_filter($margins, 'is_null'); } /** * Get shading. * * @return Shading */ public function getShading() { return $this->shading; } /** * Set shading. * * @param mixed $value * * @return self */ public function setShading($value = null) { $this->setObjectVal($value, 'Shading', $this->shading); return $this; } /** * @since 0.13.0 * * @return string */ public function getAlignment() { return $this->alignment; } /** * @since 0.13.0 * * @param string $value * * @return self */ public function setAlignment($value) { if (JcTable::isValid($value) || Jc::isValid($value)) { $this->alignment = $value; } return $this; } /** * Get width. * * @return float|int */ public function getWidth() { return $this->width; } /** * Set width. * * @param float|int $value * * @return self */ public function setWidth($value = null) { $this->width = $this->setNumericVal($value, $this->width); return $this; } /** * Get width unit. * * @return string */ public function getUnit() { return $this->unit; } /** * Set width unit. * * @param string $value * * @return self */ public function setUnit($value = null) { TblWidth::validate($value); $this->unit = $value; return $this; } /** * Get layout. * * @return string */ public function getLayout() { return $this->layout; } /** * Set layout. * * @param string $value * * @return self */ public function setLayout($value = null) { $enum = [self::LAYOUT_AUTO, self::LAYOUT_FIXED]; $this->layout = $this->setEnumVal($value, $enum, $this->layout); return $this; } /** * Get table style only property by checking if it's a firstRow. * * This is necessary since firstRow style is cloned from table style but * without certain properties activated, e.g. margins * * @param string $property * * @return null|int|string */ private function getTableOnlyProperty($property) { if (false === $this->isFirstRow) { return $this->$property; } return null; } /** * Set table style only property by checking if it's a firstRow. * * This is necessary since firstRow style is cloned from table style but * without certain properties activated, e.g. margins * * @param string $property * @param int|string $value * @param bool $isNumeric * * @return self */ private function setTableOnlyProperty($property, $value, $isNumeric = true) { if (false === $this->isFirstRow) { if (true === $isNumeric) { $this->$property = $this->setNumericVal($value, $this->$property); } else { $this->$property = $value; } } return $this; } /** * Get position. * * @return ?TablePosition */ public function getPosition() { return $this->position; } /** * Set position. * * @param mixed $value * * @return self */ public function setPosition($value = null) { $this->setObjectVal($value, 'TablePosition', $this->position); return $this; } /** * @return ?TblWidthComplexType */ public function getIndent() { return $this->indent; } /** * @return self * * @see http://www.datypic.com/sc/ooxml/e-w_tblInd-1.html */ public function setIndent(TblWidthComplexType $indent) { $this->indent = $indent; return $this; } /** * Get the columnWidths. * * @return null|int[] */ public function getColumnWidths() { return $this->columnWidths; } /** * The column widths. * * @param int[] $value */ public function setColumnWidths(?array $value = null): void { $this->columnWidths = $value; } /** * Get bidiVisual. * * @return ?bool */ public function isBidiVisual() { return $this->bidiVisual ?? Settings::isDefaultRtl(); } /** * Set bidiVisual. * * @param ?bool $bidi * Set to true to visually present table as Right to Left * * @return self */ public function setBidiVisual($bidi) { $this->bidiVisual = $bidi; return $this; } } ================================================ FILE: src/PhpWord/Style/TablePosition.php ================================================ setStyleByArray($style); } /** * Get distance from left of table to text. * * @return int */ public function getLeftFromText() { return $this->leftFromText; } /** * Set distance from left of table to text. * * @param int $value * * @return self */ public function setLeftFromText($value = null) { $this->leftFromText = $this->setNumericVal($value, $this->leftFromText); return $this; } /** * Get distance from right of table to text. * * @return int */ public function getRightFromText() { return $this->rightFromText; } /** * Set distance from right of table to text. * * @param int $value * * @return self */ public function setRightFromText($value = null) { $this->rightFromText = $this->setNumericVal($value, $this->rightFromText); return $this; } /** * Get distance from top of table to text. * * @return int */ public function getTopFromText() { return $this->topFromText; } /** * Set distance from top of table to text. * * @param int $value * * @return self */ public function setTopFromText($value = null) { $this->topFromText = $this->setNumericVal($value, $this->topFromText); return $this; } /** * Get distance from bottom of table to text. * * @return int */ public function getBottomFromText() { return $this->bottomFromText; } /** * Set distance from bottom of table to text. * * @param int $value * * @return self */ public function setBottomFromText($value = null) { $this->bottomFromText = $this->setNumericVal($value, $this->bottomFromText); return $this; } /** * Get table vertical anchor. * * @return string */ public function getVertAnchor() { return $this->vertAnchor; } /** * Set table vertical anchor. * * @param string $value * * @return self */ public function setVertAnchor($value = null) { $enum = [ self::VANCHOR_TEXT, self::VANCHOR_MARGIN, self::VANCHOR_PAGE, ]; $this->vertAnchor = $this->setEnumVal($value, $enum, $this->vertAnchor); return $this; } /** * Get table horizontal anchor. * * @return string */ public function getHorzAnchor() { return $this->horzAnchor; } /** * Set table horizontal anchor. * * @param string $value * * @return self */ public function setHorzAnchor($value = null) { $enum = [ self::HANCHOR_TEXT, self::HANCHOR_MARGIN, self::HANCHOR_PAGE, ]; $this->horzAnchor = $this->setEnumVal($value, $enum, $this->horzAnchor); return $this; } /** * Get relative horizontal alignment from anchor. * * @return string */ public function getTblpXSpec() { return $this->tblpXSpec; } /** * Set relative horizontal alignment from anchor. * * @param string $value * * @return self */ public function setTblpXSpec($value = null) { $enum = [ self::XALIGN_LEFT, self::XALIGN_CENTER, self::XALIGN_RIGHT, self::XALIGN_INSIDE, self::XALIGN_OUTSIDE, ]; $this->tblpXSpec = $this->setEnumVal($value, $enum, $this->tblpXSpec); return $this; } /** * Get absolute horizontal distance from anchor. * * @return int */ public function getTblpX() { return $this->tblpX; } /** * Set absolute horizontal distance from anchor. * * @param int $value * * @return self */ public function setTblpX($value = null) { $this->tblpX = $this->setNumericVal($value, $this->tblpX); return $this; } /** * Get relative vertical alignment from anchor. * * @return string */ public function getTblpYSpec() { return $this->tblpYSpec; } /** * Set relative vertical alignment from anchor. * * @param string $value * * @return self */ public function setTblpYSpec($value = null) { $enum = [ self::YALIGN_INLINE, self::YALIGN_TOP, self::YALIGN_CENTER, self::YALIGN_BOTTOM, self::YALIGN_INSIDE, self::YALIGN_OUTSIDE, ]; $this->tblpYSpec = $this->setEnumVal($value, $enum, $this->tblpYSpec); return $this; } /** * Get absolute vertical distance from anchor. * * @return int */ public function getTblpY() { return $this->tblpY; } /** * Set absolute vertical distance from anchor. * * @param int $value * * @return self */ public function setTblpY($value = null) { $this->tblpY = $this->setNumericVal($value, $this->tblpY); return $this; } } ================================================ FILE: src/PhpWord/Style/TextBox.php ================================================ bgColor = $value; } /** * Get background color. */ public function getBgColor(): ?string { return $this->bgColor; } /** * Set margin top. */ public function setInnerMarginTop(?int $value = null): void { $this->innerMarginTop = $value; } /** * Get margin top. */ public function getInnerMarginTop(): ?int { return $this->innerMarginTop; } /** * Set margin left. */ public function setInnerMarginLeft(?int $value = null): void { $this->innerMarginLeft = $value; } /** * Get margin left. */ public function getInnerMarginLeft(): ?int { return $this->innerMarginLeft; } /** * Set margin right. */ public function setInnerMarginRight(?int $value = null): void { $this->innerMarginRight = $value; } /** * Get margin right. */ public function getInnerMarginRight(): ?int { return $this->innerMarginRight; } /** * Set margin bottom. */ public function setInnerMarginBottom(?int $value = null): void { $this->innerMarginBottom = $value; } /** * Get margin bottom. */ public function getInnerMarginBottom(): ?int { return $this->innerMarginBottom; } /** * Set TLRB cell margin. * * @param null|int $value Margin in twips */ public function setInnerMargin(?int $value = null): void { $this->setInnerMarginTop($value); $this->setInnerMarginLeft($value); $this->setInnerMarginRight($value); $this->setInnerMarginBottom($value); } /** * Get cell margin. * * @return int[] */ public function getInnerMargin(): array { return [$this->innerMarginLeft, $this->innerMarginTop, $this->innerMarginRight, $this->innerMarginBottom]; } /** * Has inner margin? */ public function hasInnerMargins(): bool { $hasInnerMargins = false; $margins = $this->getInnerMargin(); $numMargins = count($margins); for ($i = 0; $i < $numMargins; ++$i) { if ($margins[$i] !== null) { $hasInnerMargins = true; } } return $hasInnerMargins; } /** * Set border size. * * @param null|int $value Size in points */ public function setBorderSize(?int $value = null): void { $this->borderSize = $value; } /** * Get border size. */ public function getBorderSize(): ?int { return $this->borderSize; } /** * Set border color. */ public function setBorderColor(?string $value = null): void { $this->borderColor = $value; } /** * Get border color. */ public function getBorderColor(): ?string { return $this->borderColor; } } ================================================ FILE: src/PhpWord/Style.php ================================================ setStyleByArray($value); } elseif ($value instanceof AbstractStyle) { if (get_class($style) == get_class($value)) { $style = $value; } } } $style->setStyleName($name); $style->setIndex(self::countStyles() + 1); // One based index self::$styles[$name] = $style; } return self::getStyle($name); } } ================================================ FILE: src/PhpWord/TemplateProcessor.php ================================================ tempDocumentFilename = tempnam(Settings::getTempDir(), 'PhpWord'); if (false === $this->tempDocumentFilename) { throw new CreateTemporaryFileException(); // @codeCoverageIgnore } // Template file cloning if (false === copy($documentTemplate, $this->tempDocumentFilename)) { throw new CopyFileException($documentTemplate, $this->tempDocumentFilename); // @codeCoverageIgnore } // Temporary document content extraction $this->zipClass = new ZipArchive(); $this->zipClass->open($this->tempDocumentFilename); $index = 1; while (false !== $this->zipClass->locateName($this->getHeaderName($index))) { $this->tempDocumentHeaders[$index] = $this->readPartWithRels($this->getHeaderName($index)); ++$index; } $index = 1; while (false !== $this->zipClass->locateName($this->getFooterName($index))) { $this->tempDocumentFooters[$index] = $this->readPartWithRels($this->getFooterName($index)); ++$index; } $this->tempDocumentMainPart = $this->readPartWithRels($this->getMainPartName()); $this->tempDocumentSettingsPart = $this->readPartWithRels($this->getSettingsPartName()); $tempDocumentContentTypes = $this->zipClass->getFromName($this->getDocumentContentTypesName()); if (is_string($tempDocumentContentTypes)) { $this->tempDocumentContentTypes = $tempDocumentContentTypes; } } public function __destruct() { // ZipClass if ($this->zipClass) { try { $this->zipClass->close(); } catch (Throwable $e) { // Nothing to do here. } } } /** * Expose zip class. * * To replace an image: $templateProcessor->zip()->AddFromString("word/media/image1.jpg", file_get_contents($file));
      * To read a file: $templateProcessor->zip()->getFromName("word/media/image1.jpg"); * * @return ZipArchive */ public function zip() { return $this->zipClass; } /** * @param string $fileName * * @return string */ protected function readPartWithRels($fileName) { $relsFileName = $this->getRelationsName($fileName); $partRelations = $this->zipClass->getFromName($relsFileName); if ($partRelations !== false) { $this->tempDocumentRelations[$fileName] = $partRelations; } return $this->fixBrokenMacros($this->zipClass->getFromName($fileName)); } /** * @param string $xml * @param XSLTProcessor $xsltProcessor * * @return string */ protected function transformSingleXml($xml, $xsltProcessor) { if (\PHP_VERSION_ID < 80000) { $orignalLibEntityLoader = libxml_disable_entity_loader(true); } $domDocument = new DOMDocument(); if (false === $domDocument->loadXML($xml)) { throw new Exception('Could not load the given XML document.'); } $transformedXml = $xsltProcessor->transformToXml($domDocument); if (false === $transformedXml) { throw new Exception('Could not transform the given XML document.'); } if (\PHP_VERSION_ID < 80000) { libxml_disable_entity_loader($orignalLibEntityLoader); } return $transformedXml; } /** * @param mixed $xml * @param XSLTProcessor $xsltProcessor * * @return mixed */ protected function transformXml($xml, $xsltProcessor) { if (is_array($xml)) { foreach ($xml as &$item) { $item = $this->transformSingleXml($item, $xsltProcessor); } unset($item); } else { $xml = $this->transformSingleXml($xml, $xsltProcessor); } return $xml; } /** * Applies XSL style sheet to template's parts. * * Note: since the method doesn't make any guess on logic of the provided XSL style sheet, * make sure that output is correctly escaped. Otherwise you may get broken document. * * @param DOMDocument $xslDomDocument * @param array $xslOptions * @param string $xslOptionsUri */ public function applyXslStyleSheet($xslDomDocument, $xslOptions = [], $xslOptionsUri = ''): void { $xsltProcessor = new XSLTProcessor(); $xsltProcessor->importStylesheet($xslDomDocument); if (false === $xsltProcessor->setParameter($xslOptionsUri, $xslOptions)) { throw new Exception('Could not set values for the given XSL style sheet parameters.'); } $this->tempDocumentHeaders = $this->transformXml($this->tempDocumentHeaders, $xsltProcessor); $this->tempDocumentMainPart = $this->transformXml($this->tempDocumentMainPart, $xsltProcessor); $this->tempDocumentFooters = $this->transformXml($this->tempDocumentFooters, $xsltProcessor); } /** * @param string $macro * * @return string */ protected static function ensureMacroCompleted($macro) { if (substr($macro, 0, 2) !== self::$macroOpeningChars && substr($macro, -1) !== self::$macroClosingChars) { $macro = self::$macroOpeningChars . $macro . self::$macroClosingChars; } return $macro; } /** * @param ?string $subject * * @return string */ protected static function ensureUtf8Encoded($subject) { return (null !== $subject) ? Text::toUTF8($subject) : ''; } /** * @param string $search */ public function setComplexValue($search, Element\AbstractElement $complexType): void { $elementName = substr(get_class($complexType), strrpos(get_class($complexType), '\\') + 1); $objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\' . $elementName; $xmlWriter = new XMLWriter(); /** @var Writer\Word2007\Element\AbstractElement $elementWriter */ $elementWriter = new $objectClass($xmlWriter, $complexType, true); $elementWriter->write(); $where = $this->findContainingXmlBlockForMacro($search, 'w:r'); if ($where === false) { return; } $block = $this->getSlice($where['start'], $where['end']); $textParts = $this->splitTextIntoTexts($block); $this->replaceXmlBlock($search, $textParts, 'w:r'); $search = static::ensureMacroCompleted($search); $this->replaceXmlBlock($search, $xmlWriter->getData(), 'w:r'); } /** * @param string $search */ public function setComplexBlock($search, Element\AbstractElement $complexType): void { $elementName = substr(get_class($complexType), strrpos(get_class($complexType), '\\') + 1); $objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\' . $elementName; $xmlWriter = new XMLWriter(); /** @var Writer\Word2007\Element\AbstractElement $elementWriter */ $elementWriter = new $objectClass($xmlWriter, $complexType, false); $elementWriter->write(); $this->replaceXmlBlock($search, $xmlWriter->getData(), 'w:p'); } /** * @param array|string $search * @param null|array|bool|float|int|string $replace * @param int $limit */ public function setValue($search, $replace, $limit = self::MAXIMUM_REPLACEMENTS_DEFAULT): void { if (is_array($search)) { foreach ($search as &$item) { $item = static::ensureMacroCompleted($item); } unset($item); } else { $search = static::ensureMacroCompleted($search); } if (is_array($replace)) { foreach ($replace as &$item) { $item = static::ensureUtf8Encoded($item); } unset($item); } else { $replace = static::ensureUtf8Encoded(null === $replace ? null : (string) $replace); } if (Settings::isOutputEscapingEnabled()) { $xmlEscaper = new Xml(); $replace = $xmlEscaper->escape($replace); } // convert carriage returns if (is_array($replace)) { foreach ($replace as &$item) { $item = $this->replaceCarriageReturns($item); } } else { $replace = $this->replaceCarriageReturns($replace); } $this->tempDocumentHeaders = $this->setValueForPart($search, $replace, $this->tempDocumentHeaders, $limit); $this->tempDocumentMainPart = $this->setValueForPart($search, $replace, $this->tempDocumentMainPart, $limit); $this->tempDocumentFooters = $this->setValueForPart($search, $replace, $this->tempDocumentFooters, $limit); } /** * Set values from a one-dimensional array of "variable => value"-pairs. */ public function setValues(array $values, int $limit = self::MAXIMUM_REPLACEMENTS_DEFAULT): void { foreach ($values as $macro => $replace) { $this->setValue($macro, $replace, $limit); } } public function setCheckbox(string $search, bool $checked): void { $search = static::ensureMacroCompleted($search); $blockType = 'w:sdt'; $where = $this->findContainingXmlBlockForMacro($search, $blockType); if (!is_array($where)) { return; } $block = $this->getSlice($where['start'], $where['end']); $val = $checked ? '1' : '0'; $block = preg_replace('/()/', '$1"' . $val . '"$2', $block); $text = $checked ? '☒' : '☐'; $block = preg_replace('/().*?(<\/w:t>)/', '$1' . $text . '$2', $block); $this->replaceXmlBlock($search, $block, $blockType); } /** * @param string $search */ public function setChart($search, Element\AbstractElement $chart): void { $elementName = substr(get_class($chart), strrpos(get_class($chart), '\\') + 1); $objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\' . $elementName; // Get the next relation id $rId = $this->getNextRelationsIndex($this->getMainPartName()); $chart->setRelationId($rId); // Define the chart filename $filename = "charts/chart{$rId}.xml"; // Get the part writer $writerPart = new Writer\Word2007\Part\Chart(); $writerPart->setElement($chart); // ContentTypes.xml $this->zipClass->addFromString("word/{$filename}", $writerPart->write()); // add chart to content type $xmlRelationsType = ""; $this->tempDocumentContentTypes = str_replace('', $xmlRelationsType, $this->tempDocumentContentTypes) . ''; // Add the chart to relations $xmlChartRelation = ""; $this->tempDocumentRelations[$this->getMainPartName()] = str_replace('', $xmlChartRelation, $this->tempDocumentRelations[$this->getMainPartName()]) . ''; // Write the chart $xmlWriter = new XMLWriter(); $elementWriter = new $objectClass($xmlWriter, $chart, true); $elementWriter->write(); // Place it in the template $this->replaceXmlBlock($search, '' . $xmlWriter->getData() . '', 'w:p'); } private function getImageArgs($varNameWithArgs) { $varElements = explode(':', $varNameWithArgs); array_shift($varElements); // first element is name of variable => remove it $varInlineArgs = []; // size format documentation: https://msdn.microsoft.com/en-us/library/documentformat.openxml.vml.shape%28v=office.14%29.aspx?f=255&MSPPError=-2147217396 foreach ($varElements as $argIdx => $varArg) { if (strpos($varArg, '=')) { // arg=value [$argName, $argValue] = explode('=', $varArg, 2); $argName = strtolower($argName); if ($argName == 'size') { [$varInlineArgs['width'], $varInlineArgs['height']] = explode('x', $argValue, 2); } else { $varInlineArgs[strtolower($argName)] = $argValue; } } elseif (preg_match('/^([0-9]*[a-z%]{0,2}|auto)x([0-9]*[a-z%]{0,2}|auto)$/i', $varArg)) { // 60x40 [$varInlineArgs['width'], $varInlineArgs['height']] = explode('x', $varArg, 2); } else { // :60:40:f switch ($argIdx) { case 0: $varInlineArgs['width'] = $varArg; break; case 1: $varInlineArgs['height'] = $varArg; break; case 2: $varInlineArgs['ratio'] = $varArg; break; } } } return $varInlineArgs; } private function chooseImageDimension($baseValue, $inlineValue, $defaultValue) { $value = $baseValue; if (null === $value && isset($inlineValue)) { $value = $inlineValue; } if (!preg_match('/^([0-9\.]*(cm|mm|in|pt|pc|px|%|em|ex|)|auto)$/i', $value ?? '')) { $value = null; } if (null === $value) { $value = $defaultValue; } if (is_numeric($value)) { $value .= 'px'; } return $value; } private function fixImageWidthHeightRatio(&$width, &$height, $actualWidth, $actualHeight): void { $imageRatio = $actualWidth / $actualHeight; if (($width === '') && ($height === '')) { // defined size are empty $width = $actualWidth . 'px'; $height = $actualHeight . 'px'; } elseif ($width === '') { // defined width is empty $heightFloat = (float) $height; $widthFloat = $heightFloat * $imageRatio; $matches = []; preg_match('/\\d([a-z%]+)$/', $height, $matches); $width = $widthFloat . (!empty($matches) ? $matches[1] : 'px'); } elseif ($height === '') { // defined height is empty $widthFloat = (float) $width; $heightFloat = $widthFloat / $imageRatio; $matches = []; preg_match('/\\d([a-z%]+)$/', $width, $matches); $height = $heightFloat . (!empty($matches) ? $matches[1] : 'px'); } else { // we have defined size, but we need also check it aspect ratio $widthMatches = []; preg_match('/\\d([a-z%]+)$/', $width, $widthMatches); $heightMatches = []; preg_match('/\\d([a-z%]+)$/', $height, $heightMatches); // try to fix only if dimensions are same if (!empty($widthMatches) && !empty($heightMatches) && $widthMatches[1] == $heightMatches[1]) { $dimention = $widthMatches[1]; $widthFloat = (float) $width; $heightFloat = (float) $height; $definedRatio = $widthFloat / $heightFloat; if ($imageRatio > $definedRatio) { // image wider than defined box $height = ($widthFloat / $imageRatio) . $dimention; } elseif ($imageRatio < $definedRatio) { // image higher than defined box $width = ($heightFloat * $imageRatio) . $dimention; } } } } private function prepareImageAttrs($replaceImage, $varInlineArgs) { // get image path and size $width = null; $height = null; $ratio = null; // a closure can be passed as replacement value which after resolving, can contain the replacement info for the image // use case: only when a image if found, the replacement tags can be generated if (is_callable($replaceImage)) { $replaceImage = $replaceImage(); } if (is_array($replaceImage) && isset($replaceImage['path'])) { $imgPath = $replaceImage['path']; if (isset($replaceImage['width'])) { $width = $replaceImage['width']; } if (isset($replaceImage['height'])) { $height = $replaceImage['height']; } if (isset($replaceImage['ratio'])) { $ratio = $replaceImage['ratio']; } } else { $imgPath = $replaceImage; } $width = $this->chooseImageDimension($width, $varInlineArgs['width'] ?? null, 115); $height = $this->chooseImageDimension($height, $varInlineArgs['height'] ?? null, 70); $imageData = @getimagesize($imgPath); if (!is_array($imageData)) { throw new Exception(sprintf('Invalid image: %s', $imgPath)); } [$actualWidth, $actualHeight, $imageType] = $imageData; // fix aspect ratio (by default) if (null === $ratio && isset($varInlineArgs['ratio'])) { $ratio = $varInlineArgs['ratio']; } if (null === $ratio || !in_array(strtolower($ratio), ['', '-', 'f', 'false'])) { $this->fixImageWidthHeightRatio($width, $height, $actualWidth, $actualHeight); } $imageAttrs = [ 'src' => $imgPath, 'mime' => image_type_to_mime_type($imageType), 'width' => $width, 'height' => $height, ]; return $imageAttrs; } private function addImageToRelations($partFileName, $rid, $imgPath, $imageMimeType): void { // define templates $typeTpl = ''; $relationTpl = ''; $newRelationsTpl = '' . "\n" . ''; $newRelationsTypeTpl = ''; $extTransform = [ 'image/jpeg' => 'jpeg', 'image/png' => 'png', 'image/bmp' => 'bmp', 'image/gif' => 'gif', ]; // get image embed name if (isset($this->tempDocumentNewImages[$imgPath])) { $imgName = $this->tempDocumentNewImages[$imgPath]; } else { // transform extension if (isset($extTransform[$imageMimeType])) { $imgExt = $extTransform[$imageMimeType]; } else { throw new Exception("Unsupported image type $imageMimeType"); } // add image to document $imgName = 'image_' . $rid . '_' . pathinfo($partFileName, PATHINFO_FILENAME) . '.' . $imgExt; $this->zipClass->pclzipAddFile($imgPath, 'word/media/' . $imgName); $this->tempDocumentNewImages[$imgPath] = $imgName; // setup type for image $xmlImageType = str_replace(['{IMG}', '{EXT}'], [$imgName, $imgExt], $typeTpl); $this->tempDocumentContentTypes = str_replace('', $xmlImageType, $this->tempDocumentContentTypes) . ''; } $xmlImageRelation = str_replace(['{RID}', '{IMG}'], [$rid, $imgName], $relationTpl); if (!isset($this->tempDocumentRelations[$partFileName])) { // create new relations file $this->tempDocumentRelations[$partFileName] = $newRelationsTpl; // and add it to content types $xmlRelationsType = str_replace('{RELS}', $this->getRelationsName($partFileName), $newRelationsTypeTpl); $this->tempDocumentContentTypes = str_replace('', $xmlRelationsType, $this->tempDocumentContentTypes) . ''; } // add image to relations $this->tempDocumentRelations[$partFileName] = str_replace('', $xmlImageRelation, $this->tempDocumentRelations[$partFileName]) . ''; } /** * @param mixed $search * @param mixed $replace Path to image, or array("path" => xx, "width" => yy, "height" => zz) * @param int $limit */ public function setImageValue($search, $replace, $limit = self::MAXIMUM_REPLACEMENTS_DEFAULT): void { // prepare $search_replace if (!is_array($search)) { $search = [$search]; } $replacesList = []; if (!is_array($replace) || isset($replace['path'])) { $replacesList[] = $replace; } else { $replacesList = array_values($replace); } $searchReplace = []; foreach ($search as $searchIdx => $searchString) { $searchReplace[$searchString] = $replacesList[$searchIdx] ?? $replacesList[0]; } // collect document parts $searchParts = [ $this->getMainPartName() => &$this->tempDocumentMainPart, ]; foreach (array_keys($this->tempDocumentHeaders) as $headerIndex) { $searchParts[$this->getHeaderName($headerIndex)] = &$this->tempDocumentHeaders[$headerIndex]; } foreach (array_keys($this->tempDocumentFooters) as $footerIndex) { $searchParts[$this->getFooterName($footerIndex)] = &$this->tempDocumentFooters[$footerIndex]; } // define templates // result can be verified via "Open XML SDK 2.5 Productivity Tool" (http://www.microsoft.com/en-us/download/details.aspx?id=30425) $imgTpl = ''; $i = 0; foreach ($searchParts as $partFileName => &$partContent) { $partVariables = $this->getVariablesForPart($partContent); foreach ($searchReplace as $searchString => $replaceImage) { $varsToReplace = array_filter($partVariables, function ($partVar) use ($searchString) { return ($partVar == $searchString) || preg_match('/^' . preg_quote($searchString, '/') . ':/', $partVar); }); foreach ($varsToReplace as $varNameWithArgs) { $varInlineArgs = $this->getImageArgs($varNameWithArgs); $preparedImageAttrs = $this->prepareImageAttrs($replaceImage, $varInlineArgs); $imgPath = $preparedImageAttrs['src']; // get image index $imgIndex = $this->getNextRelationsIndex($partFileName); $rid = 'rId' . $imgIndex; // replace preparations $this->addImageToRelations($partFileName, $rid, $imgPath, $preparedImageAttrs['mime']); $xmlImage = str_replace(['{RID}', '{WIDTH}', '{HEIGHT}'], [$rid, $preparedImageAttrs['width'], $preparedImageAttrs['height']], $imgTpl); // replace variable $varNameWithArgsFixed = static::ensureMacroCompleted($varNameWithArgs); $matches = []; if (preg_match('/(<[^<]+>)([^<]*)(' . preg_quote($varNameWithArgsFixed, '/') . ')([^>]*)(<[^>]+>)/Uu', $partContent, $matches)) { $wholeTag = $matches[0]; array_shift($matches); [$openTag, $prefix, , $postfix, $closeTag] = $matches; $replaceXml = $openTag . $prefix . $closeTag . $xmlImage . $openTag . $postfix . $closeTag; // replace on each iteration, because in one tag we can have 2+ inline variables => before proceed next variable we need to change $partContent $partContent = $this->setValueForPart($wholeTag, $replaceXml, $partContent, $limit); } if (++$i >= $limit) { break; } } } } } /** * Returns count of all variables in template. * * @return array */ public function getVariableCount() { $variables = $this->getVariablesForPart($this->tempDocumentMainPart); foreach ($this->tempDocumentHeaders as $headerXML) { $variables = array_merge( $variables, $this->getVariablesForPart($headerXML) ); } foreach ($this->tempDocumentFooters as $footerXML) { $variables = array_merge( $variables, $this->getVariablesForPart($footerXML) ); } return array_count_values($variables); } /** * Returns array of all variables in template. * * @return string[] */ public function getVariables() { return array_keys($this->getVariableCount()); } /** * Clone a table row in a template document. * * @param string $search * @param int $numberOfClones */ public function cloneRow($search, $numberOfClones): void { $search = static::ensureMacroCompleted($search); $tagPos = strpos($this->tempDocumentMainPart, $search); if (!$tagPos) { throw new Exception('Can not clone row, template variable not found or variable contains markup.'); } $rowStart = $this->findRowStart($tagPos); $rowEnd = $this->findRowEnd($tagPos); $xmlRow = $this->getSlice($rowStart, $rowEnd); // Check if there's a cell spanning multiple rows. if (preg_match('##', $xmlRow)) { // $extraRowStart = $rowEnd; $extraRowEnd = $rowEnd; while (true) { $extraRowStart = $this->findRowStart($extraRowEnd + 1); $extraRowEnd = $this->findRowEnd($extraRowEnd + 1); // If extraRowEnd is lower then 7, there was no next row found. if ($extraRowEnd < 7) { break; } // If tmpXmlRow doesn't contain continue, this row is no longer part of the spanned row. $tmpXmlRow = $this->getSlice($extraRowStart, $extraRowEnd); if (!preg_match('##', $tmpXmlRow) && !preg_match('##', $tmpXmlRow) ) { break; } // This row was a spanned row, update $rowEnd and search for the next row. $rowEnd = $extraRowEnd; } $xmlRow = $this->getSlice($rowStart, $rowEnd); } $result = $this->getSlice(0, $rowStart); $result .= implode('', $this->indexClonedVariables($numberOfClones, $xmlRow)); $result .= $this->getSlice($rowEnd); $this->tempDocumentMainPart = $result; } /** * Delete a table row in a template document. */ public function deleteRow(string $search): void { if (self::$macroOpeningChars !== substr($search, 0, 2) && self::$macroClosingChars !== substr($search, -1)) { $search = self::$macroOpeningChars . $search . self::$macroClosingChars; } $tagPos = strpos($this->tempDocumentMainPart, $search); if (!$tagPos) { throw new Exception(sprintf('Can not delete row %s, template variable not found or variable contains markup.', $search)); } $tableStart = $this->findTableStart($tagPos); $tableEnd = $this->findTableEnd($tagPos); $xmlTable = $this->getSlice($tableStart, $tableEnd); if (substr_count($xmlTable, 'tempDocumentMainPart = $this->getSlice(0, $tableStart) . $this->getSlice($tableEnd); return; } $rowStart = $this->findRowStart($tagPos); $rowEnd = $this->findRowEnd($tagPos); $xmlRow = $this->getSlice($rowStart, $rowEnd); $this->tempDocumentMainPart = $this->getSlice(0, $rowStart) . $this->getSlice($rowEnd); // Check if there's a cell spanning multiple rows. if (preg_match('##', $xmlRow)) { $extraRowStart = $rowStart; while (true) { $extraRowStart = $this->findRowStart($extraRowStart + 1); $extraRowEnd = $this->findRowEnd($extraRowStart + 1); // If extraRowEnd is lower then 7, there was no next row found. if ($extraRowEnd < 7) { break; } // If tmpXmlRow doesn't contain continue, this row is no longer part of the spanned row. $tmpXmlRow = $this->getSlice($extraRowStart, $extraRowEnd); if (!preg_match('##', $tmpXmlRow) && !preg_match('##', $tmpXmlRow) ) { break; } $tableStart = $this->findTableStart($extraRowEnd + 1); $tableEnd = $this->findTableEnd($extraRowEnd + 1); $xmlTable = $this->getSlice($tableStart, $tableEnd); if (substr_count($xmlTable, 'tempDocumentMainPart = $this->getSlice(0, $tableStart) . $this->getSlice($tableEnd); return; } $this->tempDocumentMainPart = $this->getSlice(0, $extraRowStart) . $this->getSlice($extraRowEnd); } } } /** * Clones a table row and populates it's values from a two-dimensional array in a template document. * * @param string $search * @param array $values */ public function cloneRowAndSetValues($search, $values): void { $this->cloneRow($search, count($values)); foreach ($values as $rowKey => $rowData) { $rowNumber = $rowKey + 1; foreach ($rowData as $macro => $replace) { $this->setValue($macro . '#' . $rowNumber, $replace); } } } /** * Clone a block. * * @param string $blockname * @param int $clones How many time the block should be cloned * @param bool $replace * @param bool $indexVariables If true, any variables inside the block will be indexed (postfixed with #1, #2, ...) * @param array $variableReplacements Array containing replacements for macros found inside the block to clone * * @return null|string */ public function cloneBlock($blockname, $clones = 1, $replace = true, $indexVariables = false, $variableReplacements = null) { $xmlBlock = null; $matches = []; $escapedMacroOpeningChars = self::$macroOpeningChars; $escapedMacroClosingChars = self::$macroClosingChars; preg_match( //'/(.*((?s)))(.*)((?s))/is', '/(.*((?s)))(.*)((?s))/is', //'/(.*((?s)))(.*)((?s))/is', $this->tempDocumentMainPart, $matches ); if (isset($matches[3])) { $xmlBlock = $matches[3]; if ($indexVariables) { $cloned = $this->indexClonedVariables($clones, $xmlBlock); } elseif ($variableReplacements !== null && is_array($variableReplacements)) { $cloned = $this->replaceClonedVariables($variableReplacements, $xmlBlock); } else { $cloned = []; for ($i = 1; $i <= $clones; ++$i) { $cloned[] = $xmlBlock; } } if ($replace) { $this->tempDocumentMainPart = str_replace( $matches[2] . $matches[3] . $matches[4], implode('', $cloned), $this->tempDocumentMainPart ); } } return $xmlBlock; } /** * Replace a block. * * @param string $blockname * @param string $replacement */ public function replaceBlock($blockname, $replacement): void { $matches = []; $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars); $escapedMacroClosingChars = preg_quote(self::$macroClosingChars); preg_match( '/(<\?xml.*)(' . $escapedMacroOpeningChars . $blockname . $escapedMacroClosingChars . '<\/w:.*?p>)(.*)()/is', $this->tempDocumentMainPart, $matches ); if (isset($matches[3])) { $this->tempDocumentMainPart = str_replace( $matches[2] . $matches[3] . $matches[4], $replacement, $this->tempDocumentMainPart ); } } /** * Delete a block of text. * * @param string $blockname */ public function deleteBlock($blockname): void { $this->replaceBlock($blockname, ''); } /** * Automatically Recalculate Fields on Open. * * @param bool $update */ public function setUpdateFields($update = true): void { $string = $update ? 'true' : 'false'; $matches = []; if (preg_match('//', $this->tempDocumentSettingsPart, $matches)) { $this->tempDocumentSettingsPart = str_replace($matches[0], '', $this->tempDocumentSettingsPart); } else { $this->tempDocumentSettingsPart = str_replace('', '', $this->tempDocumentSettingsPart); } } /** * Saves the result document. * * @return string */ public function save() { foreach ($this->tempDocumentHeaders as $index => $xml) { $this->savePartWithRels($this->getHeaderName($index), $xml); } $this->savePartWithRels($this->getMainPartName(), $this->tempDocumentMainPart); $this->savePartWithRels($this->getSettingsPartName(), $this->tempDocumentSettingsPart); foreach ($this->tempDocumentFooters as $index => $xml) { $this->savePartWithRels($this->getFooterName($index), $xml); } $this->zipClass->addFromString($this->getDocumentContentTypesName(), $this->tempDocumentContentTypes); // Close zip file if (false === $this->zipClass->close()) { throw new Exception('Could not close zip file.'); // @codeCoverageIgnore } return $this->tempDocumentFilename; } /** * @param string $fileName * @param string $xml */ protected function savePartWithRels($fileName, $xml): void { $this->zipClass->addFromString($fileName, $xml); if (isset($this->tempDocumentRelations[$fileName])) { $relsFileName = $this->getRelationsName($fileName); $this->zipClass->addFromString($relsFileName, $this->tempDocumentRelations[$fileName]); } } /** * Saves the result document to the user defined file. * * @since 0.8.0 * * @param string $fileName */ public function saveAs($fileName): void { $tempFileName = $this->save(); if (file_exists($fileName)) { unlink($fileName); } /* * Note: we do not use `rename` function here, because it loses file ownership data on Windows platform. * As a result, user cannot open the file directly getting "Access denied" message. * * @see https://github.com/PHPOffice/PHPWord/issues/532 */ copy($tempFileName, $fileName); unlink($tempFileName); } /** * Finds parts of broken macros and sticks them together. * Macros, while being edited, could be implicitly broken by some of the word processors. * * @param string $documentPart The document part in XML representation * * @return string */ protected function fixBrokenMacros($documentPart) { $brokenMacroOpeningChars = substr(self::$macroOpeningChars, 0, 1); $endMacroOpeningChars = substr(self::$macroOpeningChars, 1); $macroClosingChars = self::$macroClosingChars; return preg_replace_callback( '/\\' . $brokenMacroOpeningChars . '(?:\\' . $endMacroOpeningChars . '|[^{$]*\>\{)[^' . $macroClosingChars . '$]*\}/U', function ($match) { return strip_tags($match[0]); }, $documentPart ); } /** * Find and replace macros in the given XML section. * * @param array|string $search * @param array|string $replace * @param array|string $documentPartXML * @param int $limit * * @return ($documentPartXML is string ? string : array) */ protected function setValueForPart($search, $replace, $documentPartXML, $limit) { // Note: we can't use the same function for both cases here, because of performance considerations. if (self::MAXIMUM_REPLACEMENTS_DEFAULT === $limit) { return str_replace($search, $replace, $documentPartXML); } $regExpEscaper = new RegExp(); return preg_replace($regExpEscaper->escape($search), $replace, $documentPartXML, $limit); } /** * Find all variables in $documentPartXML. * * @param string $documentPartXML * * @return string[] */ protected function getVariablesForPart($documentPartXML) { $matches = []; $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars); $escapedMacroClosingChars = preg_quote(self::$macroClosingChars); preg_match_all("/$escapedMacroOpeningChars(.*?)$escapedMacroClosingChars/i", $documentPartXML, $matches); return $matches[1]; } /** * Get the name of the header file for $index. * * @param int $index * * @return string */ protected function getHeaderName($index) { return sprintf('word/header%d.xml', $index); } /** * Usually, the name of main part document will be 'document.xml'. However, some .docx files (possibly those from Office 365, experienced also on documents from Word Online created from blank templates) have file 'document22.xml' in their zip archive instead of 'document.xml'. This method searches content types file to correctly determine the file name. * * @return string */ protected function getMainPartName() { $contentTypes = $this->zipClass->getFromName('[Content_Types].xml'); $pattern = '~PartName="\/(word\/document.*?\.xml)" ContentType="application\/vnd\.openxmlformats-officedocument\.wordprocessingml\.document\.main\+xml"~'; $matches = []; preg_match($pattern, $contentTypes, $matches); return array_key_exists(1, $matches) ? $matches[1] : 'word/document.xml'; } /** * The name of the file containing the Settings part. * * @return string */ protected function getSettingsPartName() { return 'word/settings.xml'; } /** * Get the name of the footer file for $index. * * @param int $index * * @return string */ protected function getFooterName($index) { return sprintf('word/footer%d.xml', $index); } /** * Get the name of the relations file for document part. * * @param string $documentPartName * * @return string */ protected function getRelationsName($documentPartName) { return 'word/_rels/' . pathinfo($documentPartName, PATHINFO_BASENAME) . '.rels'; } protected function getNextRelationsIndex($documentPartName) { if (isset($this->tempDocumentRelations[$documentPartName])) { $candidate = substr_count($this->tempDocumentRelations[$documentPartName], 'tempDocumentRelations[$documentPartName], 'Id="rId' . $candidate . '"') !== false) { ++$candidate; } return $candidate; } return 1; } /** * @return string */ protected function getDocumentContentTypesName() { return '[Content_Types].xml'; } /** * Find the start position of the nearest table before $offset. */ private function findTableStart(int $offset): int { $rowStart = strrpos( $this->tempDocumentMainPart, 'tempDocumentMainPart) - $offset) * -1) ); if (!$rowStart) { $rowStart = strrpos( $this->tempDocumentMainPart, '', ((strlen($this->tempDocumentMainPart) - $offset) * -1) ); } if (!$rowStart) { throw new Exception('Can not find the start position of the table.'); } return $rowStart; } /** * Find the end position of the nearest table row after $offset. */ private function findTableEnd(int $offset): int { return strpos($this->tempDocumentMainPart, '', $offset) + 7; } /** * Find the start position of the nearest table row before $offset. * * @param int $offset * * @return int */ protected function findRowStart($offset) { $rowStart = strrpos($this->tempDocumentMainPart, 'tempDocumentMainPart) - $offset) * -1)); if (!$rowStart) { $rowStart = strrpos($this->tempDocumentMainPart, '', ((strlen($this->tempDocumentMainPart) - $offset) * -1)); } if (!$rowStart) { throw new Exception('Can not find the start position of the row to clone.'); } return $rowStart; } /** * Find the end position of the nearest table row after $offset. * * @param int $offset * * @return int */ protected function findRowEnd($offset) { return strpos($this->tempDocumentMainPart, '', $offset) + 7; } /** * Get a slice of a string. * * @param int $startPosition * @param int $endPosition * * @return string */ protected function getSlice($startPosition, $endPosition = 0) { if (!$endPosition) { $endPosition = strlen($this->tempDocumentMainPart); } return substr($this->tempDocumentMainPart, $startPosition, ($endPosition - $startPosition)); } /** * Replaces variable names in cloned * rows/blocks with indexed names. * * @param int $count * @param string $xmlBlock * * @return array */ protected function indexClonedVariables($count, $xmlBlock) { $results = []; $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars); $escapedMacroClosingChars = preg_quote(self::$macroClosingChars); for ($i = 1; $i <= $count; ++$i) { $results[] = preg_replace("/$escapedMacroOpeningChars([^:]*?)(:.*?)?$escapedMacroClosingChars/", self::$macroOpeningChars . '\1#' . $i . '\2' . self::$macroClosingChars, $xmlBlock); } return $results; } /** * Replace carriage returns with xml. */ public function replaceCarriageReturns(string $string): string { return str_replace(["\r\n", "\r", "\n"], '', $string); } /** * Replaces variables with values from array, array keys are the variable names. * * @param array $variableReplacements * @param string $xmlBlock * * @return string[] */ protected function replaceClonedVariables($variableReplacements, $xmlBlock) { $results = []; foreach ($variableReplacements as $replacementArray) { $localXmlBlock = $xmlBlock; foreach ($replacementArray as $search => $replacement) { $localXmlBlock = $this->setValueForPart(self::ensureMacroCompleted($search), $replacement, $localXmlBlock, self::MAXIMUM_REPLACEMENTS_DEFAULT); } $results[] = $localXmlBlock; } return $results; } /** * Replace an XML block surrounding a macro with a new block. * * @param string $macro Name of macro * @param string $block New block content * @param string $blockType XML tag type of block * * @return TemplateProcessor Fluent interface */ public function replaceXmlBlock($macro, $block, $blockType = 'w:p') { $where = $this->findContainingXmlBlockForMacro($macro, $blockType); if (is_array($where)) { $this->tempDocumentMainPart = $this->getSlice(0, $where['start']) . $block . $this->getSlice($where['end']); } return $this; } /** * Find start and end of XML block containing the given macro * e.g. ...${macro}.... * * Note that only the first instance of the macro will be found * * @param string $macro Name of macro * @param string $blockType XML tag for block * * @return bool|int[] FALSE if not found, otherwise array with start and end */ protected function findContainingXmlBlockForMacro($macro, $blockType = 'w:p') { $macroPos = $this->findMacro($macro); if (0 > $macroPos) { return false; } $start = $this->findXmlBlockStart($macroPos, $blockType); if (0 > $start) { return false; } $end = $this->findXmlBlockEnd($start, $blockType); //if not found or if resulting string does not contain the macro we are searching for if (0 > $end || strstr($this->getSlice($start, $end), $macro) === false) { return false; } return ['start' => $start, 'end' => $end]; } /** * Find the position of (the start of) a macro. * * Returns -1 if not found, otherwise position of opening $ * * Note that only the first instance of the macro will be found * * @param string $search Macro name * @param int $offset Offset from which to start searching * * @return int -1 if macro not found */ protected function findMacro($search, $offset = 0) { $search = static::ensureMacroCompleted($search); $pos = strpos($this->tempDocumentMainPart, $search, $offset); return ($pos === false) ? -1 : $pos; } /** * Find the start position of the nearest XML block start before $offset. * * @param int $offset Search position * @param string $blockType XML Block tag * * @return int -1 if block start not found */ protected function findXmlBlockStart($offset, $blockType) { $reverseOffset = (strlen($this->tempDocumentMainPart) - $offset) * -1; // first try XML tag with attributes $blockStart = strrpos($this->tempDocumentMainPart, '<' . $blockType . ' ', $reverseOffset); // if not found, or if found but contains the XML tag without attribute if (false === $blockStart || strrpos($this->getSlice($blockStart, $offset), '<' . $blockType . '>')) { // also try XML tag without attributes $blockStart = strrpos($this->tempDocumentMainPart, '<' . $blockType . '>', $reverseOffset); } return ($blockStart === false) ? -1 : $blockStart; } /** * Find the nearest block end position after $offset. * * @param int $offset Search position * @param string $blockType XML Block tag * * @return int -1 if block end not found */ protected function findXmlBlockEnd($offset, $blockType) { $blockEndStart = strpos($this->tempDocumentMainPart, '', $offset); // return position of end of tag if found, otherwise -1 return ($blockEndStart === false) ? -1 : $blockEndStart + 3 + strlen($blockType); } /** * Splits a w:r/w:t into a list of w:r where each ${macro} is in a separate w:r. * * @param string $text * * @return string */ protected function splitTextIntoTexts($text) { if (!$this->textNeedsSplitting($text)) { return $text; } $matches = []; if (preg_match('/()/i', $text, $matches)) { $extractedStyle = $matches[0]; } else { $extractedStyle = ''; } $unformattedText = preg_replace('/>\s+<', $text); $result = str_replace([self::$macroOpeningChars, self::$macroClosingChars], ['' . $extractedStyle . '' . self::$macroOpeningChars, self::$macroClosingChars . '' . $extractedStyle . ''], $unformattedText); return str_replace(['' . $extractedStyle . '', '', ''], ['', '', ''], $result); } /** * Returns true if string contains a macro that is not in it's own w:r. * * @param string $text * * @return bool */ protected function textNeedsSplitting($text) { $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars); $escapedMacroClosingChars = preg_quote(self::$macroClosingChars); return 1 === preg_match('/[^>]' . $escapedMacroOpeningChars . '|' . $escapedMacroClosingChars . '[^<]/i', $text); } public function setMacroOpeningChars(string $macroOpeningChars): void { self::$macroOpeningChars = $macroOpeningChars; } public function setMacroClosingChars(string $macroClosingChars): void { self::$macroClosingChars = $macroClosingChars; } public function setMacroChars(string $macroOpeningChars, string $macroClosingChars): void { self::$macroOpeningChars = $macroOpeningChars; self::$macroClosingChars = $macroClosingChars; } public function getTempDocumentFilename(): string { return $this->tempDocumentFilename; } } ================================================ FILE: src/PhpWord/Writer/AbstractWriter.php ================================================ '', 'object' => '']; /** * Use disk caching. * * @var bool */ private $useDiskCaching = false; /** * Disk caching directory. * * @var string */ private $diskCachingDirectory = './'; /** * Temporary directory. * * @var string */ private $tempDir = ''; /** * Original file name. * * @var string */ private $originalFilename; /** * Temporary file name. * * @var string */ private $tempFilename; /** * Get PhpWord object. * * @return PhpWord */ public function getPhpWord() { if (null !== $this->phpWord) { return $this->phpWord; } throw new Exception('No PhpWord assigned.'); } /** * Set PhpWord object. * * @return self */ public function setPhpWord(?PhpWord $phpWord = null) { $this->phpWord = $phpWord; return $this; } /** * Get writer part. * * @param string $partName Writer part name * * @return mixed */ public function getWriterPart($partName = '') { if ($partName != '' && isset($this->writerParts[strtolower($partName)])) { return $this->writerParts[strtolower($partName)]; } return null; } /** * Get use disk caching status. * * @return bool */ public function isUseDiskCaching() { return $this->useDiskCaching; } /** * Set use disk caching status. * * @param bool $value * @param string $directory * * @return self */ public function setUseDiskCaching($value = false, $directory = null) { $this->useDiskCaching = $value; if (null !== $directory) { if (is_dir($directory)) { $this->diskCachingDirectory = $directory; } else { throw new Exception("Directory does not exist: $directory"); } } return $this; } /** * Get disk caching directory. * * @return string */ public function getDiskCachingDirectory() { return $this->diskCachingDirectory; } /** * Get temporary directory. * * @return string */ public function getTempDir() { return $this->tempDir; } /** * Set temporary directory. * * @param string $value * * @return self */ public function setTempDir($value) { if (!is_dir($value)) { mkdir($value); } $this->tempDir = $value; return $this; } /** * Get temporary file name. * * If $filename is php://output or php://stdout, make it a temporary file * * @param string $filename * * @return string */ protected function getTempFile($filename) { // Temporary directory $this->setTempDir(Settings::getTempDir() . uniqid('/PHPWordWriter_', true) . '/'); // Temporary file $this->originalFilename = $filename; if (strpos(strtolower($filename), 'php://') === 0) { $filename = tempnam(Settings::getTempDir(), 'PhpWord'); if (false === $filename) { $filename = $this->originalFilename; // @codeCoverageIgnore } // @codeCoverageIgnore } $this->tempFilename = $filename; return $this->tempFilename; } /** * Cleanup temporary file. */ protected function cleanupTempFile(): void { if ($this->originalFilename != $this->tempFilename) { // @codeCoverageIgnoreStart // Can't find any test case. Uncomment when found. if (false === copy($this->tempFilename, $this->originalFilename)) { throw new CopyFileException($this->tempFilename, $this->originalFilename); } // @codeCoverageIgnoreEnd @unlink($this->tempFilename); } $this->clearTempDir(); } /** * Clear temporary directory. */ protected function clearTempDir(): void { if (is_dir($this->tempDir)) { $this->deleteDir($this->tempDir); } } /** * Get ZipArchive object. * * @param string $filename * * @return ZipArchive */ protected function getZipArchive($filename) { // Remove any existing file if (file_exists($filename)) { unlink($filename); } // Try opening the ZIP file $zip = new ZipArchive(); // @codeCoverageIgnoreStart // Can't find any test case. Uncomment when found. if ($zip->open($filename, ZipArchive::OVERWRITE) !== true) { if ($zip->open($filename, ZipArchive::CREATE) !== true) { throw new \Exception("Could not open '{$filename}' for writing."); } } // @codeCoverageIgnoreEnd return $zip; } /** * Open file for writing. * * @since 0.11.0 * * @param string $filename * * @return resource */ protected function openFile($filename) { $filename = $this->getTempFile($filename); $fileHandle = fopen($filename, 'wb'); // @codeCoverageIgnoreStart // Can't find any test case. Uncomment when found. if ($fileHandle === false) { throw new \Exception("Could not open '{$filename}' for writing."); } // @codeCoverageIgnoreEnd return $fileHandle; } /** * Write content to file. * * @since 0.11.0 * * @param resource $fileHandle * @param string $content */ protected function writeFile($fileHandle, $content): void { fwrite($fileHandle, $content); fclose($fileHandle); $this->cleanupTempFile(); } /** * Add files to package. * * @param mixed $elements */ protected function addFilesToPackage(ZipArchive $zip, $elements): void { foreach ($elements as $element) { $type = $element['type']; // image|object|link // Skip nonregistered types and set target if (!isset($this->mediaPaths[$type])) { continue; } $target = $this->mediaPaths[$type] . $element['target']; // Retrive GD image content or get local media if (isset($element['isMemImage']) && $element['isMemImage']) { $imageContents = $element['imageString']; $zip->addFromString($target, $imageContents); } else { $this->addFileToPackage($zip, $element['source'], $target); } } } /** * Add file to package. * * Get the actual source from an archive image. * * @param ZipArchive $zipPackage * @param string $source * @param string $target */ protected function addFileToPackage($zipPackage, $source, $target): void { $isArchive = strpos($source, 'zip://') !== false; $actualSource = null; if ($isArchive) { $source = substr($source, 6); [$zipFilename, $imageFilename] = explode('#', $source); $zip = new ZipArchive(); if ($zip->open($zipFilename) !== false) { if ($zip->locateName($imageFilename)) { $zip->extractTo($this->getTempDir(), $imageFilename); $actualSource = $this->getTempDir() . DIRECTORY_SEPARATOR . $imageFilename; } } $zip->close(); } else { $actualSource = $source; } if (null !== $actualSource) { $zipPackage->addFile($actualSource, $target); } } /** * Delete directory. * * @param string $dir */ private function deleteDir($dir): void { foreach (scandir($dir) as $file) { if ($file === '.' || $file === '..') { continue; } elseif (is_file($dir . '/' . $file)) { unlink($dir . '/' . $file); } elseif (is_dir($dir . '/' . $file)) { $this->deleteDir($dir . '/' . $file); } } rmdir($dir); } } ================================================ FILE: src/PhpWord/Writer/EPub3/Element/AbstractElement.php ================================================ getXmlWriter(); $xmlWriter->setIndent(false); $element = $this->getElement(); if (!$element instanceof ImageElement) { return; } $mediaIndex = $element->getMediaIndex(); $target = 'media/image' . $mediaIndex . '.' . $element->getImageExtension(); if (!$this->withoutP) { $xmlWriter->startElement('p'); } $xmlWriter->startElement('img'); $xmlWriter->writeAttribute('src', $target); $style = ''; if ($element->getStyle()->getWidth() !== null) { $style .= 'width:' . $element->getStyle()->getWidth() . 'px;'; } if ($element->getStyle()->getHeight() !== null) { $style .= 'height:' . $element->getStyle()->getHeight() . 'px;'; } if ($style !== '') { $xmlWriter->writeAttribute('style', $style); } $xmlWriter->endElement(); // img if (!$this->withoutP) { $xmlWriter->endElement(); // p } } } ================================================ FILE: src/PhpWord/Writer/EPub3/Element/Text.php ================================================ getXmlWriter(); $xmlWriter->setIndent(true); $xmlWriter->setIndentString(' '); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Text) { return; } $fontStyle = $element->getFontStyle(); $paragraphStyle = $element->getParagraphStyle(); if (!$this->withoutP) { $xmlWriter->startElement('p'); if (is_string($paragraphStyle) && $paragraphStyle !== '') { $xmlWriter->writeAttribute('class', $paragraphStyle); } } if (!empty($fontStyle)) { $xmlWriter->startElement('span'); if (is_string($fontStyle)) { $xmlWriter->writeAttribute('class', $fontStyle); } } $xmlWriter->text($element->getText()); if (!empty($fontStyle)) { $xmlWriter->endElement(); // span } if (!$this->withoutP) { $xmlWriter->endElement(); // p } } } ================================================ FILE: src/PhpWord/Writer/EPub3/Part/AbstractPart.php ================================================ parentWriter = $writer; } /** * Get parent writer. */ public function getParentWriter(): AbstractWriter { return $this->parentWriter; } /** * Write part content. */ abstract public function write(): string; } ================================================ FILE: src/PhpWord/Writer/EPub3/Part/Content.php ================================================ phpWord = $phpWord; } /** * Get XML Writer. * * @return XMLWriter */ protected function getXmlWriter() { $xmlWriter = new XMLWriter(); $xmlWriter->openMemory(); $xmlWriter->startDocument('1.0', 'UTF-8'); return $xmlWriter; } /** * Write part content. */ public function write(): string { if ($this->phpWord === null) { throw new Exception('No PhpWord assigned.'); } $xmlWriter = $this->getXmlWriter(); $docInfo = $this->phpWord->getDocInfo(); // Write package $xmlWriter->startElement('package'); $xmlWriter->writeAttribute('xmlns', 'http://www.idpf.org/2007/opf'); $xmlWriter->writeAttribute('version', '3.0'); $xmlWriter->writeAttribute('unique-identifier', 'book-id'); $xmlWriter->writeAttribute('xml:lang', 'en'); // Write metadata $xmlWriter->startElement('metadata'); $xmlWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/'); $xmlWriter->writeAttribute('xmlns:opf', 'http://www.idpf.org/2007/opf'); // Required elements $xmlWriter->startElement('dc:identifier'); $xmlWriter->writeAttribute('id', 'book-id'); $xmlWriter->text('book-id-' . uniqid()); $xmlWriter->endElement(); $xmlWriter->writeElement('dc:title', $docInfo->getTitle() ?: 'Untitled'); $xmlWriter->writeElement('dc:language', 'en'); // Required modified timestamp $xmlWriter->startElement('meta'); $xmlWriter->writeAttribute('property', 'dcterms:modified'); $xmlWriter->text(date('Y-m-d\TH:i:s\Z')); $xmlWriter->endElement(); $xmlWriter->endElement(); // metadata // Write manifest $xmlWriter->startElement('manifest'); // Add nav document (required) $xmlWriter->startElement('item'); $xmlWriter->writeAttribute('id', 'nav'); $xmlWriter->writeAttribute('href', 'nav.xhtml'); $xmlWriter->writeAttribute('media-type', 'application/xhtml+xml'); $xmlWriter->writeAttribute('properties', 'nav'); $xmlWriter->endElement(); // Add content document $xmlWriter->startElement('item'); $xmlWriter->writeAttribute('id', 'content'); $xmlWriter->writeAttribute('href', 'content.xhtml'); $xmlWriter->writeAttribute('media-type', 'application/xhtml+xml'); $xmlWriter->endElement(); $xmlWriter->endElement(); // manifest // Write spine $xmlWriter->startElement('spine'); $xmlWriter->startElement('itemref'); $xmlWriter->writeAttribute('idref', 'content'); $xmlWriter->endElement(); $xmlWriter->endElement(); // spine $xmlWriter->endElement(); // package return $xmlWriter->outputMemory(true); } } ================================================ FILE: src/PhpWord/Writer/EPub3/Part/ContentXhtml.php ================================================ phpWord = $phpWord; } /** * Get XML Writer. * * @return XMLWriter */ protected function getXmlWriter() { $xmlWriter = new XMLWriter(); $xmlWriter->openMemory(); return $xmlWriter; } /** * Write part content. */ public function write(): string { if ($this->phpWord === null) { throw new \PhpOffice\PhpWord\Exception\Exception('No PhpWord assigned.'); } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8'); $xmlWriter->startElement('html'); $xmlWriter->writeAttribute('xmlns', 'http://www.w3.org/1999/xhtml'); $xmlWriter->writeAttribute('xmlns:epub', 'http://www.idpf.org/2007/ops'); $xmlWriter->startElement('head'); $xmlWriter->writeElement('title', $this->phpWord->getDocInfo()->getTitle() ?: 'Untitled'); $xmlWriter->endElement(); // head $xmlWriter->startElement('body'); // Write sections content foreach ($this->phpWord->getSections() as $section) { $xmlWriter->startElement('div'); $xmlWriter->writeAttribute('class', 'section'); foreach ($section->getElements() as $element) { if ($element instanceof TextRun) { $xmlWriter->startElement('p'); $this->writeTextRun($element, $xmlWriter); $xmlWriter->endElement(); // p } elseif (method_exists($element, 'getText')) { $text = $element->getText(); $xmlWriter->startElement('p'); if ($text instanceof TextRun) { $this->writeTextRun($text, $xmlWriter); } elseif ($text !== null) { $xmlWriter->text((string) $text); } $xmlWriter->endElement(); // p } } $xmlWriter->endElement(); // div } $xmlWriter->endElement(); // body $xmlWriter->endElement(); // html return $xmlWriter->outputMemory(true); } protected function writeTextElement(AbstractElement $textElement, XMLWriter $xmlWriter): void { if ($textElement instanceof Text) { $text = $textElement->getText(); if ($text !== null) { $xmlWriter->text((string) $text); } } elseif (method_exists($textElement, 'getText')) { $text = $textElement->getText(); if ($text instanceof TextRun) { $this->writeTextRun($text, $xmlWriter); } elseif ($text !== null) { $xmlWriter->text((string) $text); } } } protected function writeTextRun(TextRun $textRun, XMLWriter $xmlWriter): void { foreach ($textRun->getElements() as $element) { $this->writeTextElement($element, $xmlWriter); } } } ================================================ FILE: src/PhpWord/Writer/EPub3/Part/Manifest.php ================================================ '; $content .= ''; $content .= ''; $content .= ''; $content .= ''; $content .= ''; return $content; } } ================================================ FILE: src/PhpWord/Writer/EPub3/Part/Meta.php ================================================ openMemory(); $xmlWriter->startDocument('1.0', 'UTF-8'); return $xmlWriter; } /** * Write part content. */ public function write(): string { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('metadata'); $xmlWriter->writeAttribute('xmlns', 'http://www.idpf.org/2007/opf'); $xmlWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/'); // Write basic metadata $title = $this->getParentWriter()->getPhpWord()->getDocInfo()->getTitle() ?: 'Sample EPub3 Document'; $xmlWriter->writeRaw('' . htmlspecialchars($title, ENT_QUOTES) . ''); $xmlWriter->writeElement('dc:language', 'en'); $xmlWriter->writeElement('dc:identifier', 'urn:uuid:12345'); $xmlWriter->writeAttribute('id', 'bookid'); // Write document info if available $docInfo = $this->getParentWriter()->getPhpWord()->getDocInfo(); if ($docInfo->getCreator()) { $xmlWriter->writeElement('dc:creator', $docInfo->getCreator()); } // Write modification date $xmlWriter->startElement('meta'); $xmlWriter->writeAttribute('property', 'dcterms:modified'); $xmlWriter->text('2023-01-01T00:00:00Z'); $xmlWriter->endElement(); $xmlWriter->endElement(); // metadata return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/EPub3/Part/Mimetype.php ================================================ openMemory(); return $xmlWriter; } public function write(): string { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8'); $xmlWriter->startElement('html'); $xmlWriter->writeAttribute('xmlns', 'http://www.w3.org/1999/xhtml'); $xmlWriter->writeAttribute('xmlns:epub', 'http://www.idpf.org/2007/ops'); $xmlWriter->startElement('head'); $xmlWriter->writeElement('title', 'Navigation'); $xmlWriter->endElement(); // head $xmlWriter->startElement('body'); $xmlWriter->startElement('nav'); $xmlWriter->writeAttribute('epub:type', 'toc'); $xmlWriter->writeAttribute('id', 'toc'); // Add navigation items here if needed $xmlWriter->writeElement('h1', 'Table of Contents'); $xmlWriter->startElement('ol'); // Add at least one list item to satisfy EPUB 3.3 requirements $xmlWriter->startElement('li'); $xmlWriter->startElement('a'); $xmlWriter->writeAttribute('href', 'content.xhtml'); $xmlWriter->text('Content'); $xmlWriter->endElement(); // a $xmlWriter->endElement(); // li $xmlWriter->endElement(); // ol $xmlWriter->endElement(); // nav $xmlWriter->endElement(); // body $xmlWriter->endElement(); // html return $xmlWriter->outputMemory(); } } ================================================ FILE: src/PhpWord/Writer/EPub3/Part.php ================================================ parentWriter = $writer; return $this; } /** * Set XML Writer. */ public function setXmlWriter(XMLWriter $writer): self { $this->xmlWriter = $writer; return $this; } /** * Get parent writer. */ public function getParentWriter(): AbstractWriter { return $this->parentWriter; } /** * Write style content. */ abstract public function write(): string; } ================================================ FILE: src/PhpWord/Writer/EPub3/Style/Font.php ================================================ setPhpWord($phpWord); // Create parts $this->parts = [ 'Mimetype' => 'mimetype', 'Content' => 'content.opf', 'Toc' => 'toc.ncx', 'Styles' => 'styles.css', 'Manifest' => 'META-INF/container.xml', 'Nav' => 'nav.xhtml', 'ContentXhtml' => 'content.xhtml', ]; foreach (array_keys($this->parts) as $partName) { $partClass = static::class . '\\Part\\' . $partName; if (class_exists($partClass)) { /** @var WriterPartInterface $part */ $part = new $partClass($partName === 'Content' || $partName === 'ContentXhtml' ? $phpWord : null); $part->setParentWriter($this); $this->writerParts[strtolower($partName)] = $part; } } // Set package paths $this->mediaPaths = ['image' => 'Images/', 'object' => 'Objects/']; } /** * Save PhpWord to file. */ public function save(string $filename): void { $filename = $this->getTempFile($filename); $zip = $this->getZipArchive($filename); // Add mimetype first without compression $zip->addFromString('mimetype', 'application/epub+zip'); $zip->addEmptyDir('META-INF'); // Add other files foreach ($this->parts as $partName => $fileName) { if ($fileName === '') { continue; } $part = $this->getWriterPart($partName); if (!$part instanceof AbstractPart) { continue; } $zip->addFromString($fileName, $part->write()); } // Close zip archive $zip->close(); // Cleanup temp file $this->cleanupTempFile(); } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/AbstractElement.php ================================================ parentWriter = $parentWriter; $this->element = $element; $this->withoutP = $withoutP; } /** * Set without paragraph. * * @param bool $value */ public function setWithoutP($value): void { $this->withoutP = $value; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Bookmark.php ================================================ element instanceof \PhpOffice\PhpWord\Element\Bookmark) { return ''; } $content = ''; $content .= $this->writeOpening(); $content .= "element->getName()}\"/>"; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Container.php ================================================ element; if (!$container instanceof ContainerElement) { return ''; } $containerClass = substr(get_class($container), strrpos(get_class($container), '\\') + 1); $withoutP = in_array($containerClass, ['TextRun', 'Footnote', 'Endnote']) ? true : false; $content = ''; $elements = $container->getElements(); foreach ($elements as $element) { $elementClass = get_class($element); $writerClass = str_replace('PhpOffice\\PhpWord\\Element', $this->namespace, $elementClass); if (class_exists($writerClass)) { /** @var AbstractElement $writer Type hint */ $writer = new $writerClass($this->parentWriter, $element, $withoutP); $content .= $writer->write(); } } return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Endnote.php ================================================ element instanceof \PhpOffice\PhpWord\Element\Footnote) { return ''; } /** @var \PhpOffice\PhpWord\Writer\HTML $parentWriter Type hint */ $parentWriter = $this->parentWriter; $noteId = count($parentWriter->getNotes()) + 1; $noteMark = $this->noteType . '-' . $this->element->getRelationId(); $content = "{$noteId}"; $parentWriter->addNote($noteId, $noteMark); return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Image.php ================================================ element instanceof ImageElement) { return ''; } $content = ''; $imageData = $this->element->getImageStringData(true); if ($imageData !== null) { $styleWriter = new ImageStyleWriter($this->element->getStyle()); $style = $styleWriter->write(); $imageData = 'data:' . $this->element->getImageType() . ';base64,' . $imageData; $content .= $this->writeOpening(); $content .= ""; $content .= $this->writeClosing(); } return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Link.php ================================================ element instanceof \PhpOffice\PhpWord\Element\Link) { return ''; } $prefix = $this->element->isInternal() ? '#' : ''; $content = $this->writeOpening(); $content .= "parentWriter->escapeHTML($this->element->getSource()) . '">' . $this->parentWriter->escapeHTML($this->element->getText()) . ''; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/ListItem.php ================================================ element instanceof \PhpOffice\PhpWord\Element\ListItem) { return ''; } $content = '

      ' . $this->parentWriter->escapeHTML($this->element->getTextObject()->getText()) . '

      ' . PHP_EOL; return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/ListItemRun.php ================================================ element instanceof \PhpOffice\PhpWord\Element\ListItemRun) { return ''; } $writer = new Container($this->parentWriter, $this->element); $content = $writer->write() . PHP_EOL; return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/PageBreak.php ================================================ parentWriter; if ($parentWriter instanceof TCPDF) { return '
      '; } if ($parentWriter->isPdf()) { return ''; } return '
       
      ' . PHP_EOL; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Ruby.php ================================================ processFontStyle(); /** @var \PhpOffice\PhpWord\Element\Ruby $element Type hint */ $element = $this->element; $baseText = $this->parentWriter->escapeHTML($element->getBaseTextRun()->getText()); $rubyText = $this->parentWriter->escapeHTML($element->getRubyTextRun()->getText()); $rubyTagPropertyCSS = $this->getPropertyCssForRubyTag($element->getProperties()); $lang = $element->getProperties()->getLanguageId(); $content = "getParagraphStyleForTextRun($element->getBaseTextRun(), $rubyTagPropertyCSS)} lang=\"{$lang}\">"; $content .= $baseText; $content .= ' ('; $rtTagPropertyCSS = $this->getPropertyCssForRtTag($element->getProperties()); $content .= "getParagraphStyleForTextRun($element->getRubyTextRun(), $rtTagPropertyCSS)}>"; $content .= $rubyText; $content .= ''; $content .= ')'; $content .= ''; return $content; } /** * Get property CSS for the tag. */ private function getPropertyCssForRubyTag(RubyProperties $properties): string { // alignment CSS: https://developer.mozilla.org/en-US/docs/Web/CSS/ruby-align $alignment = 'space-between'; switch ($properties->getAlignment()) { case RubyProperties::ALIGNMENT_CENTER: $alignment = 'center'; break; case RubyProperties::ALIGNMENT_LEFT: $alignment = 'start'; break; default: $alignment = 'space-between'; break; } return 'font-size:' . $properties->getFontSizeForBaseText() . 'pt' . ';' . 'ruby-align:' . $alignment . ';'; } /** * Get property CSS for the tag. */ private function getPropertyCssForRtTag(RubyProperties $properties): string { // alignment CSS: https://developer.mozilla.org/en-US/docs/Web/CSS/ruby-align return 'font-size:' . $properties->getFontFaceSize() . 'pt' . ';'; } /** * Write paragraph style for a given TextRun. */ private function getParagraphStyleForTextRun(TextRun $textRun, string $extraCSS): string { $style = ''; $paragraphStyle = $textRun->getParagraphStyle(); $pStyleIsObject = ($paragraphStyle instanceof Paragraph); if ($pStyleIsObject) { $styleWriter = new ParagraphStyleWriter($paragraphStyle); $styleWriter->setParentWriter($this->parentWriter); $style = $styleWriter->write(); } elseif (is_string($paragraphStyle)) { $style = $paragraphStyle; } if ($style !== null && $style !== '') { if ($pStyleIsObject) { // CSS pairs (style="...") $style = " style=\"{$style}{$extraCSS}\""; } else { // class name; need to append extra styles manually $style = " class=\"{$style}\" style=\"{$extraCSS}\""; } } elseif ($extraCSS !== '') { $style = " style=\"{$extraCSS}\""; } return $style; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Table.php ================================================ element instanceof \PhpOffice\PhpWord\Element\Table) { return ''; } $content = ''; $rows = $this->element->getRows(); $rowCount = count($rows); if ($rowCount > 0) { $content .= 'getTableStyle($this->element->getStyle()) . '>' . PHP_EOL; for ($i = 0; $i < $rowCount; ++$i) { /** @var \PhpOffice\PhpWord\Element\Row $row Type hint */ $rowStyle = $rows[$i]->getStyle(); // $height = $row->getHeight(); $tblHeader = $rowStyle->isTblHeader(); $content .= '
    ' . PHP_EOL; } return $content; } /** * Translates Table style in CSS equivalent. * * @param null|\PhpOffice\PhpWord\Style\Cell|\PhpOffice\PhpWord\Style\Table|string $tableStyle */ private function getTableStyle($tableStyle = null): string { if ($tableStyle == null) { return ''; } if (is_string($tableStyle)) { return ' class="' . $tableStyle . '"'; } $styleWriter = new TableStyleWriter($tableStyle); $style = $styleWriter->write(); if ($style === '') { return ''; } return ' style="' . $style . '"'; } /** * Calculates cell rowspan. * * @param \PhpOffice\PhpWord\Element\Row[] $rows */ private function calculateCellRowSpan(array $rows, int $rowIndex, int $colIndex): int { $currentRow = $rows[$rowIndex]; $currentRowCells = $currentRow->getCells(); $shiftedColIndex = 0; foreach ($currentRowCells as $cell) { if ($cell === $currentRowCells[$colIndex]) { break; } $colSpan = 1; if ($cell->getStyle()->getGridSpan() !== null) { $colSpan = $cell->getStyle()->getGridSpan(); } $shiftedColIndex += $colSpan; } $rowCount = count($rows); $rowSpan = 1; for ($i = $rowIndex + 1; $i < $rowCount; ++$i) { $rowCells = $rows[$i]->getCells(); $colIndex = 0; foreach ($rowCells as $cell) { if ($colIndex === $shiftedColIndex) { if ($cell->getStyle()->getVMerge() === 'continue') { ++$rowSpan; } break; } $colSpan = 1; if ($cell->getStyle()->getGridSpan() !== null) { $colSpan = $cell->getStyle()->getGridSpan(); } $colIndex += $colSpan; } } return $rowSpan; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Text.php ================================================ processFontStyle(); /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */ $element = $this->element; $text = $this->parentWriter->escapeHTML($element->getText() ?? ''); if (!$this->withoutP && !trim($text)) { $text = ' '; } $content = ''; $content .= $this->writeOpening(); $content .= $this->openingText; $content .= $this->openingTags; $content .= $text; $content .= $this->closingTags; $content .= $this->closingText; $content .= $this->writeClosing(); return $content; } /** * Set opening text. * * @param string $value */ public function setOpeningText($value): void { $this->openingText = $value; } /** * Set closing text. * * @param string $value */ public function setClosingText($value): void { $this->closingText = $value; } /** * Write opening. * * @return string */ protected function writeOpening() { $content = ''; if (!$this->withoutP) { $style = $this->getParagraphStyle(); $content .= ""; } //open track change tag $content .= $this->writeTrackChangeOpening(); return $content; } /** * Write ending. * * @return string */ protected function writeClosing() { $content = ''; //close track change tag $content .= $this->writeTrackChangeClosing(); if (!$this->withoutP) { $content .= $this->parentWriter->escapeHTML($this->closingText); $content .= '

    ' . PHP_EOL; } return $content; } /** * writes the track change opening tag. * * @return string the HTML, an empty string if no track change information */ private function writeTrackChangeOpening() { $changed = $this->element->getTrackChange(); if ($changed == null) { return ''; } $content = ''; if (($changed->getChangeType() == TrackChange::INSERTED)) { $content .= 'getChangeType() == TrackChange::DELETED) { $content .= ' ['author' => $changed->getAuthor(), 'id' => $this->element->getElementId()]]; if ($changed->getDate() != null) { $changedProp['changed']['date'] = $changed->getDate()->format('Y-m-d\TH:i:s\Z'); } $content .= json_encode($changedProp); $content .= '\' '; $content .= 'title="' . $changed->getAuthor(); if ($changed->getDate() != null) { $dateUser = $changed->getDate()->format('Y-m-d H:i:s'); $content .= ' - ' . $dateUser; } $content .= '">'; return $content; } /** * writes the track change closing tag. * * @return string the HTML, an empty string if no track change information */ private function writeTrackChangeClosing() { $changed = $this->element->getTrackChange(); if ($changed == null) { return ''; } $content = ''; if (($changed->getChangeType() == TrackChange::INSERTED)) { $content .= ''; } elseif ($changed->getChangeType() == TrackChange::DELETED) { $content .= ''; } return $content; } /** * Write paragraph style. * * @return string */ private function getParagraphStyle() { /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */ $element = $this->element; $style = ''; if (!method_exists($element, 'getParagraphStyle')) { return $style; } $paragraphStyle = $element->getParagraphStyle(); $pStyleIsObject = ($paragraphStyle instanceof Paragraph); if ($pStyleIsObject) { $styleWriter = new ParagraphStyleWriter($paragraphStyle); $styleWriter->setParentWriter($this->parentWriter); $style = $styleWriter->write(); } elseif (is_string($paragraphStyle)) { $style = $paragraphStyle; } if ($style) { $attribute = $pStyleIsObject ? 'style' : 'class'; $style = " {$attribute}=\"{$style}\""; } return $style; } /** * Get font style. */ private function processFontStyle(): void { /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */ $element = $this->element; $attributeStyle = $attributeLang = ''; $lang = null; $fontStyle = $element->getFontStyle(); if ($fontStyle instanceof Font) { // Attribute style $styleWriter = new FontStyleWriter($fontStyle); $fontCSS = $styleWriter->write(); if ($fontCSS) { $attributeStyle = ' style="' . $fontCSS . '"'; } // Attribute Lang $lang = $fontStyle->getLang(); } elseif (!empty($fontStyle)) { // Attribute class $attributeStyle = ' class="' . $fontStyle . '"'; // Attribute Lang /** @var Font $cssClassStyle */ $cssClassStyle = Style::getStyle($fontStyle); if ($cssClassStyle !== null && method_exists($cssClassStyle, 'getLang')) { $lang = $cssClassStyle->getLang(); } } if ($lang) { $attributeLang = $lang->getLatin(); if (!$attributeLang) { $attributeLang = $lang->getEastAsia(); } if (!$attributeLang) { $attributeLang = $lang->getBidirectional(); } if ($attributeLang) { $attributeLang = " lang='$attributeLang'"; } } if ($attributeStyle || $attributeLang) { $this->openingTags = ""; $this->closingTags = ''; } } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/TextBreak.php ================================================ withoutP) { $content = '
    ' . PHP_EOL; } else { $content = '

     

    ' . PHP_EOL; } return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/TextRun.php ================================================ writeOpening(); $writer = new Container($this->parentWriter, $this->element); $content .= $writer->write(); $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Element/Title.php ================================================ element instanceof \PhpOffice\PhpWord\Element\Title) { return ''; } $tag = 'h' . $this->element->getDepth(); $text = $this->element->getText(); if (is_string($text)) { $text = $this->parentWriter->escapeHTML($text); } else { $writer = new Container($this->parentWriter, $text); $text = $writer->write(); } $content = "<{$tag}>{$text}" . PHP_EOL; return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Part/AbstractPart.php ================================================ parentWriter = $writer; } /** * @return HTML */ public function getParentWriter() { if ($this->parentWriter !== null) { return $this->parentWriter; } throw new Exception('No parent WriterInterface assigned.'); } } ================================================ FILE: src/PhpWord/Writer/HTML/Part/Body.php ================================================ getParentWriter()->getPhpWord(); $content = ''; $content .= '' . PHP_EOL; $sections = $phpWord->getSections(); $secno = 0; $isTCPDFWriter = $this->getParentWriter() instanceof TCPDF; foreach ($sections as $section) { ++$secno; if ($isTCPDFWriter && $secno > 1) { $content .= "
    " . PHP_EOL; } else { $content .= "
    " . PHP_EOL; } $writer = new Container($this->getParentWriter(), $section); $content .= $writer->write(); $content .= '
    ' . PHP_EOL; } $content .= $this->writeNotes(); $content .= '' . PHP_EOL; return $content; } /** * Write footnote/endnote contents as textruns. * * @return string */ private function writeNotes() { /** @var \PhpOffice\PhpWord\Writer\HTML $parentWriter Type hint */ $parentWriter = $this->getParentWriter(); $phpWord = $parentWriter->getPhpWord(); $notes = $parentWriter->getNotes(); $content = ''; if (!empty($notes)) { $content .= '
    ' . PHP_EOL; foreach ($notes as $noteId => $noteMark) { [$noteType, $noteTypeId] = explode('-', $noteMark); $method = 'get' . ($noteType == 'endnote' ? 'Endnotes' : 'Footnotes'); $collection = $phpWord->$method()->getItems(); if (isset($collection[$noteTypeId])) { $element = $collection[$noteTypeId]; $noteAnchor = ""; $noteAnchor .= "{$noteId}"; $writer = new TextRunWriter($this->getParentWriter(), $element); $writer->setOpeningText($noteAnchor); $content .= $writer->write(); } } } return $content; } } ================================================ FILE: src/PhpWord/Writer/HTML/Part/Head.php ================================================ getParentWriter()->getPhpWord()->getDocInfo(); $propertiesMapping = [ 'creator' => 'author', 'title' => '', 'description' => '', 'subject' => '', 'keywords' => '', 'category' => '', 'company' => '', 'manager' => '', ]; $title = $docProps->getTitle(); $title = ($title != '') ? $title : 'PHPWord'; $content = ''; $content .= '' . PHP_EOL; $content .= '' . PHP_EOL; $content .= '' . $title . '' . PHP_EOL; foreach ($propertiesMapping as $key => $value) { $value = ($value == '') ? $key : $value; $method = 'get' . $key; if ($docProps->$method() != '') { $content .= '' . PHP_EOL; } } $content .= $this->writeStyles(); $content .= '' . PHP_EOL; return $content; } /** * Get styles. */ private function writeStyles(): string { $css = '' . PHP_EOL; return $css; } /** * Set font and alternates for css font-family. */ private function getFontFamily(string $font, string $genericFont): string { if (empty($font)) { return ''; } $fontfamily = "'" . htmlspecialchars($font, ENT_QUOTES, 'UTF-8') . "'"; if (!empty($genericFont)) { $fontfamily .= ", $genericFont"; } return $fontfamily; } } ================================================ FILE: src/PhpWord/Writer/HTML/Style/AbstractStyle.php ================================================ style = $style; } /** * Set parent writer. * * @param HTML $writer */ public function setParentWriter($writer): void { $this->parentWriter = $writer; } /** * Get parent writer. * * @return HTML */ public function getParentWriter() { return $this->parentWriter; } /** * Get style. * * @return null|array|string|StyleAbstract */ public function getStyle() { if (!$this->style instanceof StyleAbstract && !is_array($this->style)) { return ''; } return $this->style; } /** * Takes array where of CSS properties / values and converts to CSS string. * * @param array $css * * @return string */ protected function assembleCss($css) { $pairs = []; $string = ''; foreach ($css as $key => $value) { if ($value != '') { $pairs[] = $key . ': ' . $value; } } if (!empty($pairs)) { $string = implode('; ', $pairs) . ';'; } return $string; } /** * Get value if ... * * @param null|bool $condition * @param string $value * * @return string */ protected function getValueIf($condition, $value) { return $condition == true ? $value : ''; } } ================================================ FILE: src/PhpWord/Writer/HTML/Style/Font.php ================================================ getStyle(); if (!$style instanceof FontStyle) { return ''; } $css = []; $font = $this->getFontFamily($style->getName(), $style->getFallbackFont()); $size = $style->getSize(); $color = $style->getColor(); $fgColor = $style->getFgColor(); $underline = $style->getUnderline() != FontStyle::UNDERLINE_NONE; $lineThrough = $style->isStrikethrough() || $style->isDoubleStrikethrough(); $css['font-family'] = $this->getValueIf(!empty($font), $font); $css['font-size'] = $this->getValueIf($size !== null, "{$size}pt"); $css['color'] = $this->getValueIf($color !== null, "#{$color}"); $css['background'] = $this->getValueIf($fgColor != '', $fgColor); $css['font-weight'] = $this->getValueIf($style->isBold(), 'bold'); $css['font-style'] = $this->getValueIf($style->isItalic(), 'italic'); $css['vertical-align'] = ''; $css['vertical-align'] .= $this->getValueIf($style->isSuperScript(), 'super'); $css['vertical-align'] .= $this->getValueIf($style->isSubScript(), 'sub'); $css['text-decoration'] = ''; $css['text-decoration'] .= $this->getValueIf($underline, 'underline '); $css['text-decoration'] .= $this->getValueIf($lineThrough, 'line-through '); $css['text-transform'] = $this->getValueIf($style->isAllCaps(), 'uppercase'); $css['font-variant'] = $this->getValueIf($style->isSmallCaps(), 'small-caps'); $css['display'] = $this->getValueIf($style->isHidden(), 'none'); $whitespace = $style->getWhiteSpace(); if ($whitespace) { $css['white-space'] = $whitespace; } $spacing = $style->getSpacing(); $css['letter-spacing'] = $this->getValueIf(null !== $spacing, ($spacing / 20) . 'pt'); if ($style->isRTL()) { $css['direction'] = 'rtl'; } elseif ($style->isRTL() === false) { $css['direction'] = 'ltr'; } return $this->assembleCss($css); } /** * Set font and alternates for css font-family. */ private function getFontFamily(?string $font, string $genericFont): string { if (empty($font)) { return ''; } $fontfamily = "'" . htmlspecialchars($font, ENT_QUOTES, 'UTF-8') . "'"; if (!empty($genericFont)) { $fontfamily .= ", $genericFont"; } return $fontfamily; } } ================================================ FILE: src/PhpWord/Writer/HTML/Style/Generic.php ================================================ getStyle(); $css = []; if (is_array($style) && !empty($style)) { $css = $style; } return $this->assembleCss($css); } } ================================================ FILE: src/PhpWord/Writer/HTML/Style/Image.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Image) { return ''; } $css = []; $width = $style->getWidth(); $height = $style->getHeight(); $css['width'] = $this->getValueIf(is_numeric($width), $width . 'px'); $css['height'] = $this->getValueIf(is_numeric($height), $height . 'px'); return $this->assembleCss($css); } } ================================================ FILE: src/PhpWord/Writer/HTML/Style/Paragraph.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Paragraph) { return ''; } $css = []; // Alignment if ('' !== $style->getAlignment()) { $textAlign = ''; switch ($style->getAlignment()) { case Jc::CENTER: $textAlign = 'center'; break; case Jc::END: $textAlign = $style->isBidi() ? 'left' : 'right'; break; case Jc::MEDIUM_KASHIDA: case Jc::HIGH_KASHIDA: case Jc::LOW_KASHIDA: case Jc::RIGHT: $textAlign = 'right'; break; case Jc::BOTH: case Jc::DISTRIBUTE: case Jc::THAI_DISTRIBUTE: case Jc::JUSTIFY: $textAlign = 'justify'; break; case Jc::LEFT: $textAlign = 'left'; break; default: //all others, including Jc::START $textAlign = $style->isBidi() ? 'right' : 'left'; break; } $css['text-align'] = $textAlign; } // Spacing $spacing = $style->getSpace(); if (null !== $spacing) { $before = $spacing->getBefore(); $after = $spacing->getAfter(); $css['margin-top'] = $this->getValueIf(null !== $before, ($before / 20) . 'pt'); $css['margin-bottom'] = $this->getValueIf(null !== $after, ($after / 20) . 'pt'); } // Line Height $lineHeight = $style->getLineHeight(); if (!empty($lineHeight)) { $css['line-height'] = $lineHeight; } // Indentation (Margin) $indentation = $style->getIndentation(); if ($indentation) { $inches = $indentation->getLeft() * 1.0 / Converter::INCH_TO_TWIP; $css[$this->getParentWriter() instanceof TCPDF ? 'text-indent' : 'margin-left'] = ((string) $inches) . 'in'; $inches = $indentation->getRight() * 1.0 / Converter::INCH_TO_TWIP; $css['margin-right'] = ((string) $inches) . 'in'; } // Page Break Before if ($style->hasPageBreakBefore()) { $css['page-break-before'] = 'always'; } // Bidirectional if ($style->isBidi()) { $css['direction'] = 'rtl'; } return $this->assembleCss($css); } } ================================================ FILE: src/PhpWord/Writer/HTML/Style/Table.php ================================================ getStyle(); if (!$style instanceof StyleTable && !$style instanceof StyleCell) { return ''; } $css = []; if (method_exists($style, 'getLayout')) { if ($style->getLayout() == StyleTable::LAYOUT_FIXED) { $css['table-layout'] = 'fixed'; } elseif ($style->getLayout() == StyleTable::LAYOUT_AUTO) { $css['table-layout'] = 'auto'; } } if (method_exists($style, 'isBidiVisual')) { if ($style->isBidiVisual()) { $css['direction'] = 'rtl'; } } if (method_exists($style, 'getVAlign')) { $css['vertical-align'] = $style->getVAlign(); } foreach (['Top', 'Left', 'Bottom', 'Right'] as $direction) { $method = 'getBorder' . $direction . 'Style'; if (method_exists($style, $method)) { $outval = $style->{$method}(); if ($outval === 'single') { $outval = 'solid'; } if (is_string($outval) && 1 == preg_match('/^[a-z]+$/', $outval)) { $css['border-' . lcfirst($direction) . '-style'] = $outval; } } $method = 'getBorder' . $direction . 'Color'; if (method_exists($style, $method)) { $outval = $style->{$method}(); if (is_string($outval) && 1 == preg_match('/^[a-z]+$/', $outval)) { $css['border-' . lcfirst($direction) . '-color'] = $outval; } } $method = 'getBorder' . $direction . 'Size'; if (method_exists($style, $method)) { $outval = $style->{$method}(); if (is_numeric($outval)) { // size is in twips - divide by 20 to get points $css['border-' . lcfirst($direction) . '-width'] = ((string) ($outval / 20)) . 'pt'; } } } return $this->assembleCss($css); } } ================================================ FILE: src/PhpWord/Writer/HTML.php ================================================ setPhpWord($phpWord); $this->parts = ['Head', 'Body']; foreach ($this->parts as $partName) { $partClass = self::class . '\\Part\\' . $partName; if (class_exists($partClass)) { /** @var AbstractPart $part Type hint */ $part = new $partClass(); $part->setParentWriter($this); $this->writerParts[strtolower($partName)] = $part; } } } /** * Save PhpWord to file. */ public function save(string $filename): void { $this->writeFile($this->openFile($filename), $this->getContent()); } /** * Get content. * * @return string * * @since 0.11.0 */ public function getContent() { $content = ''; $content .= '' . PHP_EOL; $content .= '' . PHP_EOL; $langtext = ''; $phpWord = $this->getPhpWord(); $lang = $phpWord->getSettings()->getThemeFontLang(); if (!empty($lang)) { $lang2 = $lang->getLatin(); if (!$lang2) { $lang2 = $lang->getEastAsia(); } if (!$lang2) { $lang2 = $lang->getBidirectional(); } if ($lang2) { $langtext = " lang='" . $lang2 . "'"; } } $content .= "" . PHP_EOL; $content .= $this->getWriterPart('Head')->write(); $content .= $this->getWriterPart('Body')->write(); $content .= '' . PHP_EOL; // Trigger a callback for editing the entire HTML $callback = $this->editCallback; if ($callback !== null) { $content = $callback($content); } return $content; } /** * Return the callback to edit the entire HTML. */ public function getEditCallback(): ?callable { return $this->editCallback; } /** * Set a callback to edit the entire HTML. * * The callback must accept the HTML as string as first parameter, * and it must return the edited HTML as string. */ public function setEditCallback(?callable $callback): self { $this->editCallback = $callback; return $this; } /** * Get is PDF. * * @return bool */ public function isPdf() { return $this->isPdf; } /** * Get notes. * * @return array */ public function getNotes() { return $this->notes; } /** * Add note. * * @param int $noteId * @param string $noteMark */ public function addNote($noteId, $noteMark): void { $this->notes[$noteId] = $noteMark; } /** * Get generic name for default font for html. */ public function getDefaultGenericFont(): string { return $this->defaultGenericFont; } /** * Set generic name for default font for html. */ public function setDefaultGenericFont(string $value): self { $this->defaultGenericFont = Validate::validateCSSGenericFont($value); return $this; } /** * Get default white space style for html. */ public function getDefaultWhiteSpace(): string { return $this->defaultWhiteSpace; } /** * Set default white space style for html. */ public function setDefaultWhiteSpace(string $value): self { $this->defaultWhiteSpace = Validate::validateCSSWhiteSpace($value); return $this; } /** * Escape string or not depending on setting. */ public function escapeHTML(string $txt): string { if (Settings::isOutputEscapingEnabled()) { return htmlspecialchars($txt, ENT_QUOTES | (defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8'); } return $txt; } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/AbstractElement.php ================================================ startElement('text:s'); $xmlWriter->writeAttributeIf($num > 1, 'text:c', "$num"); $xmlWriter->endElement(); $text = preg_replace('/^ +/', '', $text); } preg_match_all('/([\\s\\S]*?)(\\t| +| ?$)/', $text, $matches, PREG_SET_ORDER); foreach ($matches as $match) { $this->writeText($match[1]); if ($match[2] === '') { break; } elseif ($match[2] === "\t") { $xmlWriter->writeElement('text:tab'); } elseif ($match[2] === ' ') { $xmlWriter->writeElement('text:s'); break; } else { $num = strlen($match[2]); $xmlWriter->startElement('text:s'); $xmlWriter->writeAttributeIf($num > 1, 'text:c', "$num"); $xmlWriter->endElement(); } } } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Container.php ================================================ */ protected $containerWithoutP = ['TextRun', 'Footnote', 'Endnote']; } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Field.php ================================================ getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Field) { return; } $type = strtolower($element->getType()); switch ($type) { case 'date': case 'page': case 'numpages': case 'filename': $this->writeDefault($element, $type); break; } } private function writeDefault(\PhpOffice\PhpWord\Element\Field $element, $type): void { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('text:span'); $fstyle = $element->getFontStyle(); if (is_string($fstyle)) { $xmlWriter->writeAttribute('text:style-name', $fstyle); } switch ($type) { case 'date': $xmlWriter->startElement('text:date'); $xmlWriter->writeAttribute('text:fixed', 'false'); $xmlWriter->endElement(); break; case 'page': $xmlWriter->startElement('text:page-number'); $xmlWriter->writeAttribute('text:fixed', 'false'); $xmlWriter->endElement(); break; case 'numpages': $xmlWriter->startElement('text:page-count'); $xmlWriter->endElement(); break; case 'filename': $xmlWriter->startElement('text:file-name'); $xmlWriter->writeAttribute('text:fixed', 'false'); $options = $element->getOptions(); if ($options != null && in_array('Path', $options)) { $xmlWriter->writeAttribute('text:display', 'full'); } else { $xmlWriter->writeAttribute('text:display', 'name'); } $xmlWriter->endElement(); break; } $xmlWriter->endElement(); // text:span } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Formula.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof ElementFormula) { return; } $part = $this->getPart(); if (!$part instanceof AbstractPart) { return; } $objectIdx = $part->addObject($element); //$style = $element->getStyle(); //$width = Converter::pixelToCm($style->getWidth()); //$height = Converter::pixelToCm($style->getHeight()); $xmlWriter->startElement('text:p'); $xmlWriter->writeAttribute('text:style-name', 'OB' . $objectIdx); $xmlWriter->startElement('draw:frame'); $xmlWriter->writeAttribute('draw:name', $element->getElementId()); $xmlWriter->writeAttribute('text:anchor-type', 'as-char'); //$xmlWriter->writeAttribute('svg:width', $width . 'cm'); //$xmlWriter->writeAttribute('svg:height', $height . 'cm'); //$xmlWriter->writeAttribute('draw:z-index', $mediaIndex); $xmlWriter->startElement('draw:object'); $xmlWriter->writeAttribute('xlink:href', 'Formula' . $objectIdx); $xmlWriter->writeAttribute('xlink:type', 'simple'); $xmlWriter->writeAttribute('xlink:show', 'embed'); $xmlWriter->writeAttribute('xlink:actuate', 'onLoad'); $xmlWriter->endElement(); // draw:object $xmlWriter->endElement(); // draw:frame $xmlWriter->endElement(); // text:p } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Image.php ================================================ getElement(); if (!$element instanceof ElementImage) { return; } $mediaIndex = $element->getMediaIndex(); $target = 'Pictures/' . $element->getTarget(); $style = $element->getStyle(); $width = Converter::pixelToCm($style->getWidth()); $height = Converter::pixelToCm($style->getHeight()); $xmlWriter = $this->getXmlWriter(); if (!$this->withoutP) { $xmlWriter->startElement('text:p'); $xmlWriter->writeAttribute('text:style-name', 'IM' . $mediaIndex); } $xmlWriter->startElement('draw:frame'); $xmlWriter->writeAttribute('draw:style-name', 'fr' . $mediaIndex); $xmlWriter->writeAttributeIf($this->withoutP, 'draw:text-style-name', 'IM' . $mediaIndex); $xmlWriter->writeAttribute('draw:name', $element->getElementId()); $xmlWriter->writeAttribute('text:anchor-type', 'as-char'); $xmlWriter->writeAttribute('svg:width', $width . 'cm'); $xmlWriter->writeAttribute('svg:height', $height . 'cm'); $xmlWriter->writeAttribute('draw:z-index', $mediaIndex); $xmlWriter->startElement('draw:image'); $xmlWriter->writeAttribute('xlink:href', $target); $xmlWriter->writeAttribute('xlink:type', 'simple'); $xmlWriter->writeAttribute('xlink:show', 'embed'); $xmlWriter->writeAttribute('xlink:actuate', 'onLoad'); $xmlWriter->endElement(); // draw:image $xmlWriter->endElement(); // draw:frame if (!$this->withoutP) { $xmlWriter->endElement(); // text:p } } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Link.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Link) { return; } if (!$this->withoutP) { $xmlWriter->startElement('text:p'); // text:p } $xmlWriter->startElement('text:a'); $xmlWriter->writeAttribute('xlink:type', 'simple'); $xmlWriter->writeAttribute('xlink:href', ($element->isInternal() ? '#' : '') . $element->getSource()); $this->writeText($element->getText()); $xmlWriter->endElement(); // text:a if (!$this->withoutP) { $xmlWriter->endElement(); // text:p } } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/ListItemRun.php ================================================ getElement(); if (!$element instanceof ListItemRunElement) { return; } $depth = $element->getDepth() + 1; $xmlWriter = $this->getXmlWriter(); for ($iDepth = 1; $iDepth <= $depth; ++$iDepth) { $xmlWriter->startElement('text:list'); $xmlWriter->writeAttribute('text:style-name', $element->getStyle()->getNumStyle()); $xmlWriter->startElement('text:list-item'); } $containerWriter = new Container($xmlWriter, $element, false); $containerWriter->write(); for ($iDepth = 1; $iDepth <= $depth; ++$iDepth) { $xmlWriter->endElement(); // text:list-item $xmlWriter->endElement(); // text:list } } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/PageBreak.php ================================================ getXmlWriter(); $xmlWriter->startElement('text:p'); $xmlWriter->writeAttribute('text:style-name', 'PB'); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Ruby.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Ruby) { return; } $paragraphStyle = $element->getBaseTextRun()->getParagraphStyle(); if (!$this->withoutP) { $xmlWriter->startElement('text:p'); // text:p } if (empty($paragraphStyle)) { if (!$this->withoutP) { $xmlWriter->writeAttribute('text:style-name', 'Normal'); } } elseif (is_string($paragraphStyle)) { if (!$this->withoutP) { $xmlWriter->writeAttribute('text:style-name', $paragraphStyle); } } $this->replaceTabs($element->getBaseTextRun()->getText(), $xmlWriter); $this->writeText(' ('); $this->replaceTabs($element->getRubyTextRun()->getText(), $xmlWriter); $this->writeText(')'); if (!$this->withoutP) { $xmlWriter->endElement(); // text:p } } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Table.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof TableElement) { return; } $rows = $element->getRows(); $rowCount = count($rows); if ($rowCount > 0) { $xmlWriter->startElement('table:table'); $xmlWriter->writeAttribute('table:name', $element->getElementId()); $xmlWriter->writeAttribute('table:style-name', $element->getElementId()); // Write columns $this->writeColumns($xmlWriter, $element); // Write rows foreach ($rows as $row) { $this->writeRow($xmlWriter, $row); } $xmlWriter->endElement(); // table:table } } /** * Write column. */ private function writeColumns(XMLWriter $xmlWriter, TableElement $element): void { $colCount = $element->countColumns(); for ($i = 0; $i < $colCount; ++$i) { $xmlWriter->startElement('table:table-column'); $xmlWriter->writeAttribute('table:style-name', $element->getElementId() . '.' . $i); $xmlWriter->endElement(); } } /** * Write row. */ private function writeRow(XMLWriter $xmlWriter, RowElement $row): void { $xmlWriter->startElement('table:table-row'); /** @var RowElement $row Type hint */ foreach ($row->getCells() as $cell) { $xmlWriter->startElement('table:table-cell'); $xmlWriter->writeAttribute('office:value-type', 'string'); $containerWriter = new Container($xmlWriter, $cell); $containerWriter->write(); $xmlWriter->endElement(); // table:table-cell } $xmlWriter->endElement(); // table:table-row } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Text.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Text) { return; } $fontStyle = $element->getFontStyle(); $paragraphStyle = $element->getParagraphStyle(); // @todo Commented for TextRun. Should really checkout this value // $fStyleIsObject = ($fontStyle instanceof Font) ? true : false; //$fStyleIsObject = false; //if ($fStyleIsObject) { // Don't never be the case, because I browse all sections for cleaning all styles not declared // throw new Exception('PhpWord : $fStyleIsObject wouldn\'t be an object'); //} if (!$this->withoutP) { $xmlWriter->startElement('text:p'); // text:p } if ($element->getTrackChange() != null && $element->getTrackChange()->getChangeType() == TrackChange::DELETED) { $xmlWriter->startElement('text:change'); $xmlWriter->writeAttribute('text:change-id', $element->getTrackChange()->getElementId()); $xmlWriter->endElement(); } else { if (empty($paragraphStyle)) { if (!$this->withoutP) { $xmlWriter->writeAttribute('text:style-name', 'Normal'); } } elseif (is_string($paragraphStyle)) { if (!$this->withoutP) { $xmlWriter->writeAttribute('text:style-name', $paragraphStyle); } } if (!empty($fontStyle)) { // text:span $xmlWriter->startElement('text:span'); if (is_string($fontStyle)) { $xmlWriter->writeAttribute('text:style-name', $fontStyle); } } $this->writeChangeInsertion(true, $element->getTrackChange()); $this->replaceTabs($element->getText(), $xmlWriter); $this->writeChangeInsertion(false, $element->getTrackChange()); if (!empty($fontStyle)) { $xmlWriter->endElement(); } } if (!$this->withoutP) { $xmlWriter->endElement(); // text:p } } private function writeChangeInsertion($start = true, ?TrackChange $trackChange = null): void { if ($trackChange == null || $trackChange->getChangeType() != TrackChange::INSERTED) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('text:change-' . ($start ? 'start' : 'end')); $xmlWriter->writeAttribute('text:change-id', $trackChange->getElementId()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/TextBreak.php ================================================ getXmlWriter(); $xmlWriter->startElement('text:p'); $xmlWriter->writeAttribute('text:style-name', 'Standard'); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/TextRun.php ================================================ getXmlWriter(); $element = $this->getElement(); $xmlWriter->startElement('text:p'); /** @scrutinizer ignore-call */ $pStyle = $element->getParagraphStyle(); if (!is_string($pStyle)) { $pStyle = 'Normal'; } $xmlWriter->writeAttribute('text:style-name', $pStyle); $containerWriter = new Container($xmlWriter, $element); $containerWriter->write(); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/ODText/Element/Title.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Title) { return; } $xmlWriter->startElement('text:h'); $hdname = 'HD'; $sect = $element->getParent(); if ($sect instanceof \PhpOffice\PhpWord\Element\Section) { if (self::compareToFirstElement($element, $sect->getElements())) { $hdname = 'HE'; } } $depth = $element->getDepth(); $xmlWriter->writeAttribute('text:style-name', "$hdname$depth"); $xmlWriter->writeAttribute('text:outline-level', $depth); $xmlWriter->startElement('text:span'); if ($depth > 0) { $xmlWriter->writeAttribute('text:style-name', 'Heading_' . $depth); } else { $xmlWriter->writeAttribute('text:style-name', 'Title'); } $text = $element->getText(); if (is_string($text)) { $this->writeText($text); } if ($text instanceof \PhpOffice\PhpWord\Element\AbstractContainer) { $containerWriter = new Container($xmlWriter, $text); $containerWriter->write(); } $xmlWriter->endElement(); // text:span $xmlWriter->endElement(); // text:h } /** * Test if element is same as first element in array. * * @param \PhpOffice\PhpWord\Element\AbstractElement $elem * @param \PhpOffice\PhpWord\Element\AbstractElement[] $elemarray * * @return bool */ private static function compareToFirstElement($elem, $elemarray) { return $elem === $elemarray[0]; } } ================================================ FILE: src/PhpWord/Writer/ODText/Part/AbstractPart.php ================================================ writeAttribute('office:version', '1.2'); $xmlWriter->writeAttribute('xmlns:office', 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'); $xmlWriter->writeAttribute('xmlns:style', 'urn:oasis:names:tc:opendocument:xmlns:style:1.0'); $xmlWriter->writeAttribute('xmlns:text', 'urn:oasis:names:tc:opendocument:xmlns:text:1.0'); $xmlWriter->writeAttribute('xmlns:table', 'urn:oasis:names:tc:opendocument:xmlns:table:1.0'); $xmlWriter->writeAttribute('xmlns:draw', 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0'); $xmlWriter->writeAttribute('xmlns:fo', 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0'); $xmlWriter->writeAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink'); $xmlWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/'); $xmlWriter->writeAttribute('xmlns:meta', 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0'); $xmlWriter->writeAttribute('xmlns:number', 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0'); $xmlWriter->writeAttribute('xmlns:svg', 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0'); $xmlWriter->writeAttribute('xmlns:chart', 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0'); $xmlWriter->writeAttribute('xmlns:dr3d', 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0'); $xmlWriter->writeAttribute('xmlns:math', 'http://www.w3.org/1998/Math/MathML'); $xmlWriter->writeAttribute('xmlns:form', 'urn:oasis:names:tc:opendocument:xmlns:form:1.0'); $xmlWriter->writeAttribute('xmlns:script', 'urn:oasis:names:tc:opendocument:xmlns:script:1.0'); $xmlWriter->writeAttribute('xmlns:ooo', 'http://openoffice.org/2004/office'); $xmlWriter->writeAttribute('xmlns:ooow', 'http://openoffice.org/2004/writer'); $xmlWriter->writeAttribute('xmlns:oooc', 'http://openoffice.org/2004/calc'); $xmlWriter->writeAttribute('xmlns:dom', 'http://www.w3.org/2001/xml-events'); $xmlWriter->writeAttribute('xmlns:rpt', 'http://openoffice.org/2005/report'); $xmlWriter->writeAttribute('xmlns:of', 'urn:oasis:names:tc:opendocument:xmlns:of:1.2'); $xmlWriter->writeAttribute('xmlns:xhtml', 'http://www.w3.org/1999/xhtml'); $xmlWriter->writeAttribute('xmlns:grddl', 'http://www.w3.org/2003/g/data-view#'); $xmlWriter->writeAttribute('xmlns:tableooo', 'http://openoffice.org/2009/table'); $xmlWriter->writeAttribute('xmlns:css3t', 'http://www.w3.org/TR/css3-text/'); } /** * Write font faces declaration. */ protected function writeFontFaces(XMLWriter $xmlWriter): void { $xmlWriter->startElement('office:font-face-decls'); $fontTable = []; $styles = Style::getStyles(); $numFonts = 0; if (count($styles) > 0) { foreach ($styles as $style) { // Font if ($style instanceof Font) { ++$numFonts; $name = $style->getName(); if (!in_array($name, $fontTable)) { $fontTable[] = $name; // style:font-face $xmlWriter->startElement('style:font-face'); $xmlWriter->writeAttribute('style:name', $name); $xmlWriter->writeAttribute('svg:font-family', $name); $xmlWriter->endElement(); } } } } if (!in_array(Settings::getDefaultFontName(), $fontTable)) { $xmlWriter->startElement('style:font-face'); $xmlWriter->writeAttribute('style:name', Settings::getDefaultFontName()); $xmlWriter->writeAttribute('svg:font-family', Settings::getDefaultFontName()); $xmlWriter->endElement(); } $xmlWriter->endElement(); } public function addObject(AbstractElement $object): int { $this->objects[] = $object; return count($this->objects) - 1; } /** * @param AbstractElement[] $objects */ public function setObjects(array $objects): self { $this->objects = $objects; return $this; } /** * @return AbstractElement[] */ public function getObjects(): array { return $this->objects; } } ================================================ FILE: src/PhpWord/Writer/ODText/Part/Content.php ================================================ [], 'Image' => [], 'Table' => []]; private $imageParagraphStyles = []; /** * Write part. * * @return string */ public function write() { $xmlWriter = $this->getXmlWriter(); $phpWord = $this->getParentWriter()->getPhpWord(); $this->getAutoStyles($phpWord); $xmlWriter->startDocument('1.0', 'UTF-8'); $xmlWriter->startElement('office:document-content'); $this->writeCommonRootAttributes($xmlWriter); $xmlWriter->writeAttribute('xmlns:xforms', 'http://www.w3.org/2002/xforms'); $xmlWriter->writeAttribute('xmlns:xsd', 'http://www.w3.org/2001/XMLSchema'); $xmlWriter->writeAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance'); $xmlWriter->writeAttribute('xmlns:field', 'urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0'); $xmlWriter->writeAttribute('xmlns:formx', 'urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0'); // Font declarations and automatic styles $this->writeFontFaces($xmlWriter); // office:font-face-decls $this->writeAutoStyles($xmlWriter); // office:automatic-styles // Body $xmlWriter->startElement('office:body'); $xmlWriter->startElement('office:text'); // Tracked changes declarations $trackedChanges = []; $sections = $phpWord->getSections(); foreach ($sections as $section) { $this->collectTrackedChanges($section, $trackedChanges); } $xmlWriter->startElement('text:tracked-changes'); foreach ($trackedChanges as $trackedElement) { $trackedChange = $trackedElement->getTrackChange(); $xmlWriter->startElement('text:changed-region'); $trackedChange->setElementId(); $xmlWriter->writeAttribute('text:id', $trackedChange->getElementId()); if (($trackedChange->getChangeType() == TrackChange::INSERTED)) { $xmlWriter->startElement('text:insertion'); } elseif ($trackedChange->getChangeType() == TrackChange::DELETED) { $xmlWriter->startElement('text:deletion'); } $xmlWriter->startElement('office:change-info'); $xmlWriter->writeElement('dc:creator', $trackedChange->getAuthor()); if ($trackedChange->getDate() != null) { $xmlWriter->writeElement('dc:date', $trackedChange->getDate()->format('Y-m-d\TH:i:s\Z')); } $xmlWriter->endElement(); // office:change-info if ($trackedChange->getChangeType() == TrackChange::DELETED && method_exists($trackedElement, 'getText')) { // @phpstan-ignore-next-line $xmlWriter->writeElement('text:p', $trackedElement->getText()); } $xmlWriter->endElement(); // text:insertion|text:deletion $xmlWriter->endElement(); // text:changed-region } $xmlWriter->endElement(); // text:tracked-changes // Sequence declarations $sequences = ['Illustration', 'Table', 'Text', 'Drawing']; $xmlWriter->startElement('text:sequence-decls'); foreach ($sequences as $sequence) { $xmlWriter->startElement('text:sequence-decl'); $xmlWriter->writeAttribute('text:display-outline-level', 0); $xmlWriter->writeAttribute('text:name', $sequence); $xmlWriter->endElement(); } $xmlWriter->endElement(); // text:sequence-decl // Sections $sections = $phpWord->getSections(); foreach ($sections as $section) { $name = 'Section' . $section->getSectionId(); $xmlWriter->startElement('text:section'); $xmlWriter->writeAttribute('text:name', $name); $xmlWriter->writeAttribute('text:style-name', $name); $xmlWriter->startElement('text:p'); $xmlWriter->writeAttribute('text:style-name', 'SB' . $section->getSectionId()); $xmlWriter->endElement(); $containerWriter = new Container($xmlWriter, $section); $containerWriter->setPart($this); $containerWriter->write(); $xmlWriter->endElement(); // text:section } $xmlWriter->endElement(); // office:text $xmlWriter->endElement(); // office:body $xmlWriter->endElement(); // office:document-content return $xmlWriter->getData(); } /** * Write automatic styles other than fonts and paragraphs. * * @since 0.11.0 */ private function writeAutoStyles(XMLWriter $xmlWriter): void { $xmlWriter->startElement('office:automatic-styles'); $this->writeTextStyles($xmlWriter); foreach ($this->autoStyles as $element => $styles) { $writerClass = 'PhpOffice\\PhpWord\\Writer\\ODText\\Style\\' . $element; foreach ($styles as $style) { /** @var \PhpOffice\PhpWord\Writer\ODText\Style\AbstractStyle $styleWriter Type hint */ $styleWriter = new $writerClass($xmlWriter, $style); $styleWriter->write(); } } $xmlWriter->endElement(); // office:automatic-styles } /** * Write automatic styles. */ private function writeTextStyles(XMLWriter $xmlWriter): void { $styles = Style::getStyles(); $paragraphStyleCount = 0; $style = new Paragraph(); $style->setStyleName('PB'); $style->setAuto(); $styleWriter = new ParagraphStyleWriter($xmlWriter, $style); $styleWriter->write(); $sects = $this->getParentWriter()->getPhpWord()->getSections(); $countsects = count($sects); for ($i = 0; $i < $countsects; ++$i) { $iplus1 = $i + 1; $style = new Paragraph(); $style->setStyleName("SB$iplus1"); $style->setAuto(); $pnstart = $sects[$i]->getStyle()->getPageNumberingStart(); $style->setNumLevel($pnstart); $styleWriter = new ParagraphStyleWriter($xmlWriter, $style); $styleWriter->write(); } foreach ($styles as $style) { $sty = (string) $style->getStyleName(); if (substr($sty, 0, 8) === 'Heading_') { $style = new Paragraph(); $style->setStyleName('HD' . substr($sty, 8)); $style->setAuto(); $styleWriter = new ParagraphStyleWriter($xmlWriter, $style); $styleWriter->write(); $style = new Paragraph(); $style->setStyleName('HE' . substr($sty, 8)); $style->setAuto(); $styleWriter = new ParagraphStyleWriter($xmlWriter, $style); $styleWriter->write(); } } foreach ($styles as $style) { if ($style->isAuto() === true) { $styleClass = str_replace('\\Style\\', '\\Writer\\ODText\\Style\\', get_class($style)); if (class_exists($styleClass)) { /** @var \PhpOffice\PhpWord\Writer\ODText\Style\AbstractStyle $styleWriter Type hint */ $styleWriter = new $styleClass($xmlWriter, $style); $styleWriter->write(); } if ($style instanceof Paragraph) { ++$paragraphStyleCount; } } } foreach ($this->imageParagraphStyles as $style) { $styleWriter = new ParagraphStyleWriter($xmlWriter, $style); $styleWriter->write(); } } /** * Get automatic styles. */ private function getAutoStyles(PhpWord $phpWord): void { $sections = $phpWord->getSections(); $paragraphStyleCount = 0; $fontStyleCount = 0; foreach ($sections as $section) { $style = $section->getStyle(); $style->setStyleName("Section{$section->getSectionId()}"); $this->autoStyles['Section'][] = $style; $this->getContainerStyle($section, $paragraphStyleCount, $fontStyleCount); } } /** * Get all styles of each elements in container recursively. * * Table style can be null or string of the style name * * @param AbstractContainer $container * @param int $paragraphStyleCount * @param int $fontStyleCount * * @todo Simplify the logic */ private function getContainerStyle($container, &$paragraphStyleCount, &$fontStyleCount): void { $elements = $container->getElements(); foreach ($elements as $element) { if ($element instanceof TextRun) { $this->getElementStyleTextRun($element, $paragraphStyleCount); $this->getContainerStyle($element, $paragraphStyleCount, $fontStyleCount); } elseif ($element instanceof Text) { $this->getElementStyle($element, $paragraphStyleCount, $fontStyleCount); } elseif ($element instanceof Field) { $this->getElementStyleField($element, $fontStyleCount); } elseif ($element instanceof Image) { $style = $element->getStyle(); $style->setStyleName('fr' . $element->getMediaIndex()); $this->autoStyles['Image'][] = $style; $sty = new Paragraph(); $sty->setStyleName('IM' . $element->getMediaIndex()); $sty->setAuto(); $sty->setAlignment($style->getAlignment()); $this->imageParagraphStyles[] = $sty; } elseif ($element instanceof Table) { $style = $element->getStyle(); if (is_string($style)) { $style = Style::getStyle($style); } if ($style === null) { $style = new TableStyle(); } $style->setStyleName($element->getElementId()); $style->setColumnWidths($element->findFirstDefinedCellWidths()); $this->autoStyles['Table'][] = $style; } } } /** * Get style of individual element. * * @param Text $element * @param int $paragraphStyleCount * @param int $fontStyleCount */ private function getElementStyle($element, &$paragraphStyleCount, &$fontStyleCount): void { $fontStyle = $element->getFontStyle(); $paragraphStyle = $element->getParagraphStyle(); $phpWord = $this->getParentWriter()->getPhpWord(); if ($fontStyle instanceof Font) { // Font $name = $fontStyle->getStyleName(); if (!$name) { ++$fontStyleCount; $style = $phpWord->addFontStyle("T{$fontStyleCount}", $fontStyle, null); $style->setAuto(); $style->setParagraph(null); $element->setFontStyle("T{$fontStyleCount}"); } else { $element->setFontStyle($name); } } if ($paragraphStyle instanceof Paragraph) { // Paragraph $name = $paragraphStyle->getStyleName(); if (!$name) { ++$paragraphStyleCount; $style = $phpWord->addParagraphStyle("P{$paragraphStyleCount}", $paragraphStyle); $style->setAuto(); $element->setParagraphStyle("P{$paragraphStyleCount}"); } else { $element->setParagraphStyle($name); } } elseif ($paragraphStyle) { ++$paragraphStyleCount; $parstylename = "P$paragraphStyleCount" . "_$paragraphStyle"; $style = $phpWord->addParagraphStyle($parstylename, $paragraphStyle); $style->setAuto(); $element->setParagraphStyle($parstylename); } } /** * Get font style of individual field element. * * @param Field $element * @param int $fontStyleCount */ private function getElementStyleField($element, &$fontStyleCount): void { $fontStyle = $element->getFontStyle(); $phpWord = $this->getParentWriter()->getPhpWord(); if ($fontStyle instanceof Font) { $name = $fontStyle->getStyleName(); if (!$name) { ++$fontStyleCount; $style = $phpWord->addFontStyle("T{$fontStyleCount}", $fontStyle, null); $style->setAuto(); $style->setParagraph(null); $element->setFontStyle("T{$fontStyleCount}"); } else { $element->setFontStyle($name); } } } /** * Get style of individual element. * * @param TextRun $element * @param int $paragraphStyleCount */ private function getElementStyleTextRun($element, &$paragraphStyleCount): void { $paragraphStyle = $element->getParagraphStyle(); $phpWord = $this->getParentWriter()->getPhpWord(); if ($paragraphStyle instanceof Paragraph) { // Paragraph $name = $paragraphStyle->getStyleName(); if (!$name) { ++$paragraphStyleCount; $style = $phpWord->addParagraphStyle("P{$paragraphStyleCount}", $paragraphStyle); $style->setAuto(); $element->setParagraphStyle("P{$paragraphStyleCount}"); } else { $element->setParagraphStyle($name); } } elseif ($paragraphStyle) { ++$paragraphStyleCount; $parstylename = "P$paragraphStyleCount" . "_$paragraphStyle"; $style = $phpWord->addParagraphStyle($parstylename, $paragraphStyle); $style->setAuto(); $element->setParagraphStyle($parstylename); } } /** * Finds all tracked changes. * * @param \PhpOffice\PhpWord\Element\AbstractElement[] $trackedChanges */ private function collectTrackedChanges(AbstractContainer $container, &$trackedChanges = []): void { $elements = $container->getElements(); foreach ($elements as $element) { if ($element->getTrackChange() != null) { $trackedChanges[] = $element; } if (is_callable([$element, 'getElements'])) { $this->collectTrackedChanges($element, $trackedChanges); } } } } ================================================ FILE: src/PhpWord/Writer/ODText/Part/Manifest.php ================================================ getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8'); $xmlWriter->startElement('manifest:manifest'); $xmlWriter->writeAttribute('manifest:version', '1.2'); $xmlWriter->writeAttribute('xmlns:manifest', 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0'); $xmlWriter->startElement('manifest:file-entry'); $xmlWriter->writeAttribute('manifest:media-type', 'application/vnd.oasis.opendocument.text'); $xmlWriter->writeAttribute('manifest:full-path', '/'); $xmlWriter->writeAttribute('manifest:version', '1.2'); $xmlWriter->endElement(); // Parts foreach (['content.xml', 'meta.xml', 'styles.xml'] as $part) { $xmlWriter->startElement('manifest:file-entry'); $xmlWriter->writeAttribute('manifest:media-type', 'text/xml'); $xmlWriter->writeAttribute('manifest:full-path', $part); $xmlWriter->endElement(); } // Media files $media = Media::getElements('section'); foreach ($media as $medium) { if ($medium['type'] == 'image') { $xmlWriter->startElement('manifest:file-entry'); $xmlWriter->writeAttribute('manifest:media-type', $medium['imageType']); $xmlWriter->writeAttribute('manifest:full-path', 'Pictures/' . $medium['target']); $xmlWriter->endElement(); } } foreach ($this->getObjects() as $idxObject => $object) { if ($object instanceof Formula) { $xmlWriter->startElement('manifest:file-entry'); $xmlWriter->writeAttribute('manifest:full-path', 'Formula' . $idxObject . '/content.xml'); $xmlWriter->writeAttribute('manifest:media-type', 'text/xml'); $xmlWriter->endElement(); $xmlWriter->startElement('manifest:file-entry'); $xmlWriter->writeAttribute('manifest:full-path', 'Formula' . $idxObject . '/'); $xmlWriter->writeAttribute('manifest:version', '1.2'); $xmlWriter->writeAttribute('manifest:media-type', 'application/vnd.oasis.opendocument.formula'); $xmlWriter->endElement(); } } $xmlWriter->endElement(); // manifest:manifest return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/ODText/Part/Meta.php ================================================ getParentWriter()->getPhpWord(); $docProps = $phpWord->getDocInfo(); $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8'); $xmlWriter->startElement('office:document-meta'); $xmlWriter->writeAttribute('office:version', '1.2'); $xmlWriter->writeAttribute('xmlns:office', 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'); $xmlWriter->writeAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink'); $xmlWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/'); $xmlWriter->writeAttribute('xmlns:meta', 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0'); $xmlWriter->writeAttribute('xmlns:ooo', 'http://openoffice.org/2004/office'); $xmlWriter->writeAttribute('xmlns:grddl', 'http://www.w3.org/2003/g/data-view#'); $xmlWriter->startElement('office:meta'); // Core properties $xmlWriter->writeElement('dc:title', $docProps->getTitle()); $xmlWriter->writeElement('dc:subject', $docProps->getSubject()); $xmlWriter->writeElement('dc:description', $docProps->getDescription()); $xmlWriter->writeElement('dc:creator', $docProps->getLastModifiedBy()); $xmlWriter->writeElement('dc:date', gmdate($this->dateFormat, $docProps->getModified())); // Extended properties $xmlWriter->writeElement('meta:generator', 'PHPWord'); $xmlWriter->writeElement('meta:initial-creator', $docProps->getCreator()); $xmlWriter->writeElement('meta:creation-date', gmdate($this->dateFormat, $docProps->getCreated())); $xmlWriter->writeElement('meta:keyword', $docProps->getKeywords()); // Category, company, and manager are put in meta namespace $properties = ['Category', 'Company', 'Manager']; foreach ($properties as $property) { $method = "get{$property}"; if ($docProps->$method() !== null) { $this->writeCustomProperty($xmlWriter, $property, $docProps->$method()); } } // Other custom properties // @todo Check type. Currently all assumed as string foreach ($docProps->getCustomProperties() as $property) { $value = $docProps->getCustomPropertyValue($property); $this->writeCustomProperty($xmlWriter, $property, $value); } $xmlWriter->endElement(); // office:meta $xmlWriter->endElement(); // office:document-meta return $xmlWriter->getData(); } /** * Write individual property. * * @param string $property * @param string $value * * @todo Handle other `$type`: double|date|dateTime|duration|boolean (4th arguments) */ private function writeCustomProperty(XMLWriter $xmlWriter, $property, $value): void { $xmlWriter->startElement('meta:user-defined'); $xmlWriter->writeAttribute('meta:name', $property); // if ($type !== null) { // $xmlWriter->writeAttribute('meta:value-type', $type); // } $this->writeText($value); $xmlWriter->endElement(); // meta:user-defined } } ================================================ FILE: src/PhpWord/Writer/ODText/Part/Mimetype.php ================================================ getXmlWriter(); // XML header $xmlWriter->startDocument('1.0', 'UTF-8'); $xmlWriter->startElement('office:document-styles'); $this->writeCommonRootAttributes($xmlWriter); // Font declarations $this->writeFontFaces($xmlWriter); // Office styles $xmlWriter->startElement('office:styles'); $this->writeDefault($xmlWriter); $this->writeNamed($xmlWriter); $xmlWriter->endElement(); // Automatic styles $xmlWriter->startElement('office:automatic-styles'); $this->writePageLayout($xmlWriter); $xmlWriter->endElement(); // office:automatic-styles // Master style $this->writeMaster($xmlWriter); $xmlWriter->endElement(); // office:document-styles return $xmlWriter->getData(); } /** * Write default styles. */ private function writeDefault(XMLWriter $xmlWriter): void { $xmlWriter->startElement('style:default-style'); $xmlWriter->writeAttribute('style:family', 'paragraph'); // Paragraph $xmlWriter->startElement('style:paragraph-properties'); $xmlWriter->writeAttribute('fo:hyphenation-ladder-count', 'no-limit'); $xmlWriter->writeAttribute('style:text-autospace', 'ideograph-alpha'); $xmlWriter->writeAttribute('style:punctuation-wrap', 'hanging'); $xmlWriter->writeAttribute('style:line-break', 'strict'); $xmlWriter->writeAttribute('style:tab-stop-distance', '1.249cm'); $xmlWriter->writeAttribute('style:writing-mode', 'page'); $xmlWriter->endElement(); // style:paragraph-properties $language = $this->getParentWriter()->getPhpWord()->getSettings()->getThemeFontLang(); $latinLang = $language != null && is_string($language->getLatin()) ? explode('-', $language->getLatin()) : ['fr', 'FR']; $asianLang = $language != null && is_string($language->getEastAsia()) ? explode('-', $language->getEastAsia()) : ['zh', 'CN']; $complexLang = $language != null && is_string($language->getBidirectional()) ? explode('-', $language->getBidirectional()) : ['hi', 'IN']; if ($this->getParentWriter()->getPhpWord()->getSettings()->hasHideGrammaticalErrors()) { $latinLang = $asianLang = $complexLang = ['zxx', 'none']; } // Font $xmlWriter->startElement('style:text-properties'); $xmlWriter->writeAttribute('style:use-window-font-color', 'false'); $xmlWriter->writeAttribute('style:font-name', Settings::getDefaultFontName()); $xmlWriter->writeAttribute('fo:font-size', Settings::getDefaultFontSize() . 'pt'); $xmlWriter->writeAttribute('fo:language', $latinLang[0]); $xmlWriter->writeAttribute('fo:country', $latinLang[1]); $xmlWriter->writeAttribute('fo:color', '#' . Settings::getDefaultFontColor()); $xmlWriter->writeAttribute('style:letter-kerning', 'true'); $xmlWriter->writeAttribute('style:font-name-asian', Settings::getDefaultFontName() . '2'); $xmlWriter->writeAttribute('style:font-size-asian', Settings::getDefaultFontSize() . 'pt'); $xmlWriter->writeAttribute('style:language-asian', $asianLang[0]); $xmlWriter->writeAttribute('style:country-asian', $asianLang[1]); $xmlWriter->writeAttribute('style:font-name-complex', Settings::getDefaultFontName() . '2'); $xmlWriter->writeAttribute('style:font-size-complex', Settings::getDefaultFontSize() . 'pt'); $xmlWriter->writeAttribute('style:language-complex', $complexLang[0]); $xmlWriter->writeAttribute('style:country-complex', $complexLang[1]); $xmlWriter->writeAttribute('fo:hyphenate', 'false'); $xmlWriter->writeAttribute('fo:hyphenation-remain-char-count', '2'); $xmlWriter->writeAttribute('fo:hyphenation-push-char-count', '2'); $xmlWriter->endElement(); // style:text-properties $xmlWriter->endElement(); // style:default-style } /** * Write named styles. */ private function writeNamed(XMLWriter $xmlWriter): void { $styles = Style::getStyles(); if (count($styles) > 0) { foreach ($styles as $style) { if ($style->isAuto() === false) { $styleClass = str_replace('\\Style\\', '\\Writer\\ODText\\Style\\', get_class($style)); if (class_exists($styleClass)) { /** @var \PhpOffice\PhpWord\Writer\ODText\Style\AbstractStyle $styleWriter Type hint */ $styleWriter = new $styleClass($xmlWriter, $style); $styleWriter->write(); } } } } } /** * Convert int in twips to inches/cm then to string and append unit. * * @param float|int $twips * @param float $factor * return string */ private static function cvttwiptostr($twips, $factor = 1.0) { $ins = (string) ($twips * $factor / Converter::INCH_TO_TWIP) . 'in'; $cms = (string) ($twips * $factor * Converter::INCH_TO_CM / Converter::INCH_TO_TWIP) . 'cm'; return (strlen($ins) < strlen($cms)) ? $ins : $cms; } /** * call writePageLayoutIndiv to write page layout styles for each page. */ private function writePageLayout(XMLWriter $xmlWriter): void { $sections = $this->getParentWriter()->getPhpWord()->getSections(); $countsects = count($sections); for ($i = 0; $i < $countsects; ++$i) { $this->writePageLayoutIndiv($xmlWriter, $sections[$i], $i + 1); } } /** * Write page layout styles. * * @param \PhpOffice\PhpWord\Element\Section $section * @param int $sectionNbr */ private function writePageLayoutIndiv(XMLWriter $xmlWriter, $section, $sectionNbr): void { $sty = $section->getStyle(); if (count($section->getHeaders()) > 0) { $topfactor = 0.5; } else { $topfactor = 1.0; } if (count($section->getFooters()) > 0) { $botfactor = 0.5; } else { $botfactor = 1.0; } $orient = $sty->getOrientation(); $pwidth = self::cvttwiptostr($sty->getPageSizeW()); $pheight = self::cvttwiptostr($sty->getPageSizeH()); $mtop = self::cvttwiptostr($sty->getMarginTop(), $topfactor); $mbottom = self::cvttwiptostr($sty->getMarginBottom(), $botfactor); $mleft = self::cvttwiptostr($sty->getMarginRight()); $mright = self::cvttwiptostr($sty->getMarginLeft()); $xmlWriter->startElement('style:page-layout'); $xmlWriter->writeAttribute('style:name', "Mpm$sectionNbr"); $xmlWriter->startElement('style:page-layout-properties'); $xmlWriter->writeAttribute('fo:page-width', $pwidth); $xmlWriter->writeAttribute('fo:page-height', $pheight); $xmlWriter->writeAttribute('style:num-format', '1'); $xmlWriter->writeAttribute('style:print-orientation', $orient); $xmlWriter->writeAttribute('fo:margin-top', $mtop); $xmlWriter->writeAttribute('fo:margin-bottom', $mbottom); $xmlWriter->writeAttribute('fo:margin-left', $mleft); $xmlWriter->writeAttribute('fo:margin-right', $mright); $xmlWriter->writeAttribute('style:writing-mode', 'lr-tb'); $xmlWriter->writeAttribute('style:layout-grid-color', '#c0c0c0'); $xmlWriter->writeAttribute('style:layout-grid-lines', '25199'); $xmlWriter->writeAttribute('style:layout-grid-base-height', '0.423cm'); $xmlWriter->writeAttribute('style:layout-grid-ruby-height', '0cm'); $xmlWriter->writeAttribute('style:layout-grid-mode', 'none'); $xmlWriter->writeAttribute('style:layout-grid-ruby-below', 'false'); $xmlWriter->writeAttribute('style:layout-grid-print', 'false'); $xmlWriter->writeAttribute('style:layout-grid-display', 'false'); $xmlWriter->writeAttribute('style:layout-grid-base-width', '0.37cm'); $xmlWriter->writeAttribute('style:layout-grid-snap-to', 'true'); $xmlWriter->writeAttribute('style:footnote-max-height', '0cm'); $xmlWriter->startElement('style:footnote-sep'); $xmlWriter->writeAttribute('style:width', '0.018cm'); $xmlWriter->writeAttribute('style:line-style', 'solid'); $xmlWriter->writeAttribute('style:adjustment', 'left'); $xmlWriter->writeAttribute('style:rel-width', '25%'); $xmlWriter->writeAttribute('style:color', '#000000'); $xmlWriter->endElement(); //style:footnote-sep $xmlWriter->endElement(); // style:page-layout-properties $xmlWriter->startElement('style:header-style'); if ($topfactor < 1.0) { $xmlWriter->startElement('style:header-footer-properties'); $xmlWriter->writeAttribute('fo:min-height', $mtop); $xmlWriter->writeAttribute('fo:margin-bottom', $mtop); $xmlWriter->writeAttribute('style:dynamic-spacing', 'true'); $xmlWriter->endElement(); // style:header-footer-properties } $xmlWriter->endElement(); // style:header-style $xmlWriter->startElement('style:footer-style'); if ($botfactor < 1.0) { $xmlWriter->startElement('style:header-footer-properties'); $xmlWriter->writeAttribute('fo:min-height', $mbottom); $xmlWriter->writeAttribute('fo:margin-top', $mbottom); $xmlWriter->writeAttribute('style:dynamic-spacing', 'true'); $xmlWriter->endElement(); // style:header-footer-properties } $xmlWriter->endElement(); // style:footer-style $xmlWriter->endElement(); // style:page-layout } /** * Write master style. */ private function writeMaster(XMLWriter $xmlWriter): void { $xmlWriter->startElement('office:master-styles'); $sections = $this->getParentWriter()->getPhpWord()->getSections(); $countsects = count($sections); for ($i = 0; $i < $countsects; ++$i) { $iplus1 = $i + 1; $xmlWriter->startElement('style:master-page'); $xmlWriter->writeAttribute('style:name', "Standard$iplus1"); $xmlWriter->writeAttribute('style:page-layout-name', "Mpm$iplus1"); // Multiple headers and footers probably not supported, // and, even if they are, I'm not sure how, // so quit after generating one. foreach ($sections[$i]->getHeaders() as $hdr) { $xmlWriter->startElement('style:header'); foreach ($hdr->getElements() as $elem) { $cl1 = get_class($elem); $cl2 = str_replace('\\Element\\', '\\Writer\\ODText\\Element\\', $cl1); if (class_exists($cl2)) { $wtr = new $cl2($xmlWriter, $elem); $wtr->write(); } } $xmlWriter->endElement(); // style:header break; } foreach ($sections[$i]->getFooters() as $hdr) { $xmlWriter->startElement('style:footer'); foreach ($hdr->getElements() as $elem) { $cl1 = get_class($elem); $cl2 = str_replace('\\Element\\', '\\Writer\\ODText\\Element\\', $cl1); if (class_exists($cl2)) { $wtr = new $cl2($xmlWriter, $elem); $wtr->write(); } } $xmlWriter->endElement(); // style:footer break; } $xmlWriter->endElement(); // style:master-page } $xmlWriter->endElement(); // office:master-styles } } ================================================ FILE: src/PhpWord/Writer/ODText/Style/AbstractStyle.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Font) { return; } $xmlWriter = $this->getXmlWriter(); $stylep = $style->getParagraph(); if ($stylep instanceof \PhpOffice\PhpWord\Style\Paragraph) { $temp1 = clone $stylep; $temp1->setStyleName($style->getStyleName()); $temp2 = new Paragraph($xmlWriter, $temp1); $temp2->write(); } $xmlWriter->startElement('style:style'); $xmlWriter->writeAttribute('style:name', $style->getStyleName()); $xmlWriter->writeAttribute('style:family', 'text'); $xmlWriter->startElement('style:text-properties'); // Name $font = $style->getName(); $xmlWriter->writeAttributeIf($font != '', 'style:font-name', $font); $xmlWriter->writeAttributeIf($font != '', 'style:font-name-complex', $font); $size = $style->getSize(); // Size $xmlWriter->writeAttributeIf(is_numeric($size), 'fo:font-size', $size . 'pt'); $xmlWriter->writeAttributeIf(is_numeric($size), 'style:font-size-asian', $size . 'pt'); $xmlWriter->writeAttributeIf(is_numeric($size), 'style:font-size-complex', $size . 'pt'); // Color $color = $style->getColor(); $xmlWriter->writeAttributeIf($color != '', 'fo:color', '#' . \PhpOffice\PhpWord\Shared\Converter::stringToRgb($color)); // Bold & italic $xmlWriter->writeAttributeIf($style->isBold(), 'fo:font-weight', 'bold'); $xmlWriter->writeAttributeIf($style->isBold(), 'style:font-weight-asian', 'bold'); $xmlWriter->writeAttributeIf($style->isItalic(), 'fo:font-style', 'italic'); $xmlWriter->writeAttributeIf($style->isItalic(), 'style:font-style-asian', 'italic'); $xmlWriter->writeAttributeIf($style->isItalic(), 'style:font-style-complex', 'italic'); // Underline // @todo Various mode of underline $underline = $style->getUnderline(); $xmlWriter->writeAttributeIf($underline != 'none', 'style:text-underline-style', 'solid'); // Strikethrough, double strikethrough $xmlWriter->writeAttributeIf($style->isStrikethrough(), 'style:text-line-through-type', 'single'); $xmlWriter->writeAttributeIf($style->isDoubleStrikethrough(), 'style:text-line-through-type', 'double'); // Small caps, all caps $xmlWriter->writeAttributeIf($style->isSmallCaps(), 'fo:font-variant', 'small-caps'); $xmlWriter->writeAttributeIf($style->isAllCaps(), 'fo:text-transform', 'uppercase'); //Hidden text $xmlWriter->writeAttributeIf($style->isHidden(), 'text:display', 'none'); // Superscript/subscript $xmlWriter->writeAttributeIf($style->isSuperScript(), 'style:text-position', 'super'); $xmlWriter->writeAttributeIf($style->isSubScript(), 'style:text-position', 'sub'); if ($style->isNoProof()) { $xmlWriter->writeAttribute('fo:language', 'zxx'); $xmlWriter->writeAttribute('style:language-asian', 'zxx'); $xmlWriter->writeAttribute('style:language-complex', 'zxx'); $xmlWriter->writeAttribute('fo:country', 'none'); $xmlWriter->writeAttribute('style:country-asian', 'none'); $xmlWriter->writeAttribute('style:country-complex', 'none'); } // @todo Foreground-Color // @todo Background color $xmlWriter->endElement(); // style:text-properties $xmlWriter->endElement(); // style:style } } ================================================ FILE: src/PhpWord/Writer/ODText/Style/Image.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Image) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('style:style'); $xmlWriter->writeAttribute('style:name', $style->getStyleName()); $xmlWriter->writeAttribute('style:family', 'graphic'); $xmlWriter->writeAttribute('style:parent-style-name', 'Graphics'); $xmlWriter->startElement('style:graphic-properties'); $xmlWriter->writeAttribute('style:vertical-pos', 'top'); $xmlWriter->writeAttribute('style:vertical-rel', 'baseline'); $xmlWriter->endElement(); // style:graphic-properties $xmlWriter->endElement(); // style:style } } ================================================ FILE: src/PhpWord/Writer/ODText/Style/Numbering.php ================================================ getStyle(); if (!$style instanceof StyleNumbering) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('text:list-style'); $xmlWriter->writeAttribute('style:name', $style->getStyleName()); foreach ($style->getLevels() as $styleLevel) { $numLevel = $styleLevel->getLevel() + 1; // In Twips $tabPos = $styleLevel->getTabPos(); // In Inches $tabPos /= Converter::INCH_TO_TWIP; // In Centimeters $tabPos *= Converter::INCH_TO_CM; // In Twips $hanging = $styleLevel->getHanging(); // In Inches $hanging /= Converter::INCH_TO_TWIP; // In Centimeters $hanging *= Converter::INCH_TO_CM; $xmlWriter->startElement('text:list-level-style-bullet'); $xmlWriter->writeAttribute('text:level', $numLevel); $xmlWriter->writeAttribute('text:style-name', $style->getStyleName() . '_' . $numLevel); $xmlWriter->writeAttribute('text:bullet-char', $styleLevel->getText()); $xmlWriter->startElement('style:list-level-properties'); $xmlWriter->writeAttribute('text:list-level-position-and-space-mode', 'label-alignment'); $xmlWriter->startElement('style:list-level-label-alignment'); $xmlWriter->writeAttribute('text:label-followed-by', 'listtab'); $xmlWriter->writeAttribute('text:list-tab-stop-position', number_format($tabPos, 2, '.', '') . 'cm'); $xmlWriter->writeAttribute('fo:text-indent', '-' . number_format($hanging, 2, '.', '') . 'cm'); $xmlWriter->writeAttribute('fo:margin-left', number_format($tabPos, 2, '.', '') . 'cm'); $xmlWriter->endElement(); // style:list-level-label-alignment $xmlWriter->endElement(); // style:list-level-properties $xmlWriter->startElement('style:text-properties'); $xmlWriter->writeAttribute('style:font-name', $styleLevel->getFont()); $xmlWriter->endElement(); // style:text-properties $xmlWriter->endElement(); // text:list-level-style-bullet } $xmlWriter->endElement(); // text:list-style } } ================================================ FILE: src/PhpWord/Writer/ODText/Style/Paragraph.php ================================================ Jc::LEFT, Jc::START => Jc::RIGHT, ]; private const NON_BIDI_MAP = [ Jc::START => Jc::LEFT, Jc::END => Jc::RIGHT, ]; /** * Write style. */ public function write(): void { $style = $this->getStyle(); if (!$style instanceof Style\Paragraph) { return; } $xmlWriter = $this->getXmlWriter(); $marginTop = $style->getSpaceBefore(); $marginBottom = $style->getSpaceAfter(); $xmlWriter->startElement('style:style'); $styleName = (string) $style->getStyleName(); $styleAuto = false; $mpm = ''; $psm = ''; $pagestart = -1; $breakafter = $breakbefore = $breakauto = false; if ($style->isAuto()) { if (substr($styleName, 0, 2) === 'PB') { $styleAuto = true; $breakafter = true; } elseif (substr($styleName, 0, 2) === 'SB') { $styleAuto = true; $mpm = 'Standard' . substr($styleName, 2); $psn = $style->getNumLevel(); $pagestart = $psn; } elseif (substr($styleName, 0, 2) === 'HD') { $styleAuto = true; $psm = 'Heading_' . substr($styleName, 2); $stylep = Style::getStyle($psm); if ($stylep instanceof Style\Font) { $stylep = $stylep->getParagraph(); } if ($stylep instanceof Style\Paragraph) { if ($stylep->hasPageBreakBefore()) { $breakbefore = true; } } } elseif (substr($styleName, 0, 2) === 'HE') { $styleAuto = true; $psm = 'Heading_' . substr($styleName, 2); $breakauto = true; } else { $styleAuto = true; $psm = 'Normal'; if (preg_match('/^P\\d+_(\\w+)$/', $styleName, $matches)) { $psm = $matches[1]; } } } $xmlWriter->writeAttribute('style:name', $style->getStyleName()); $xmlWriter->writeAttribute('style:family', 'paragraph'); if ($styleAuto) { $xmlWriter->writeAttributeIf($psm !== '', 'style:parent-style-name', $psm); $xmlWriter->writeAttributeIf($mpm !== '', 'style:master-page-name', $mpm); } $xmlWriter->startElement('style:paragraph-properties'); if ($styleAuto) { if ($breakafter) { $xmlWriter->writeAttribute('fo:break-after', 'page'); $xmlWriter->writeAttribute('fo:margin-top', '0cm'); $xmlWriter->writeAttribute('fo:margin-bottom', '0cm'); } elseif ($breakbefore) { $xmlWriter->writeAttribute('fo:break-before', 'page'); } elseif ($breakauto) { $xmlWriter->writeAttribute('fo:break-before', 'auto'); } if ($pagestart > 0) { $xmlWriter->writeAttribute('style:page-number', $pagestart); } } if (!$breakafter && !$breakbefore && !$breakauto) { $twipToPoint = Converter::INCH_TO_TWIP / Converter::INCH_TO_POINT; // 20 $xmlWriter->writeAttributeIf($marginTop !== null, 'fo:margin-top', ($marginTop / $twipToPoint) . 'pt'); $xmlWriter->writeAttributeIf($marginBottom !== null, 'fo:margin-bottom', ($marginBottom / $twipToPoint) . 'pt'); } $alignment = $style->getAlignment(); $bidi = $style->isBidi(); $defaultRtl = Settings::isDefaultRtl(); if ($alignment === '' && $bidi !== null) { $alignment = Jc::START; } if ($bidi) { $alignment = self::BIDI_MAP[$alignment] ?? $alignment; } elseif ($defaultRtl !== null) { $alignment = self::NON_BIDI_MAP[$alignment] ?? $alignment; } $xmlWriter->writeAttributeIf($alignment !== '', 'fo:text-align', $alignment); $temp = $style->getLineHeight(); $xmlWriter->writeAttributeIf($temp !== null, 'fo:line-height', ((string) ($temp * 100) . '%')); $xmlWriter->writeAttributeIf($style->hasPageBreakBefore() === true, 'fo:break-before', 'page'); $tabs = $style->getTabs(); if ($tabs !== null && count($tabs) > 0) { $xmlWriter->startElement('style:tab-stops'); foreach ($tabs as $tab) { $xmlWriter->startElement('style:tab-stop'); $xmlWriter->writeAttribute('style:type', $tab->getType()); $xmlWriter->writeAttribute('style:position', (string) ($tab->getPosition() / Converter::INCH_TO_TWIP) . 'in'); $xmlWriter->endElement(); } $xmlWriter->endElement(); } //Right to left $xmlWriter->writeAttributeIf($style->isBidi(), 'style:writing-mode', 'rl-tb'); //Indentation $indent = $style->getIndentation(); //if ($indent instanceof \PhpOffice\PhpWord\Style\Indentation) { if (!empty($indent)) { $marg = $indent->getLeft(); $xmlWriter->writeAttributeIf($marg !== null, 'fo:margin-left', (string) ($marg / Converter::INCH_TO_TWIP) . 'in'); $marg = $indent->getRight(); $xmlWriter->writeAttributeIf($marg !== null, 'fo:margin-right', (string) ($marg / Converter::INCH_TO_TWIP) . 'in'); } $xmlWriter->endElement(); //style:paragraph-properties if ($styleAuto && substr($styleName, 0, 2) === 'SB') { $xmlWriter->startElement('style:text-properties'); $xmlWriter->writeAttribute('text:display', 'none'); $xmlWriter->endElement(); } $xmlWriter->endElement(); //style:style } } ================================================ FILE: src/PhpWord/Writer/ODText/Style/Section.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Section) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('style:style'); $xmlWriter->writeAttribute('style:name', $style->getStyleName()); $xmlWriter->writeAttribute('style:family', 'section'); $xmlWriter->startElement('style:section-properties'); $xmlWriter->startElement('style:columns'); $xmlWriter->writeAttribute('fo:column-count', $style->getColsNum()); $xmlWriter->endElement(); // style:columns $xmlWriter->endElement(); // style:section-properties $xmlWriter->endElement(); // style:style } } ================================================ FILE: src/PhpWord/Writer/ODText/Style/Table.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Table) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('style:style'); $xmlWriter->writeAttribute('style:name', $style->getStyleName()); $xmlWriter->writeAttribute('style:family', 'table'); $xmlWriter->startElement('style:table-properties'); //$xmlWriter->writeAttribute('style:width', 'table'); $xmlWriter->writeAttribute('style:rel-width', 100); $xmlWriter->writeAttribute('table:align', 'center'); $xmlWriter->writeAttributeIf($style->isBidiVisual(), 'style:writing-mode', 'rl-tb'); $xmlWriter->endElement(); // style:table-properties $xmlWriter->endElement(); // style:style $cellWidths = $style->getColumnWidths(); $countCellWidths = $cellWidths === null ? 0 : count($cellWidths); for ($i = 0; $i < $countCellWidths; ++$i) { $width = $cellWidths[$i]; $xmlWriter->startElement('style:style'); $xmlWriter->writeAttribute('style:name', $style->getStyleName() . '.' . $i); $xmlWriter->writeAttribute('style:family', 'table-column'); $xmlWriter->startElement('style:table-column-properties'); $xmlWriter->writeAttribute('style:column-width', number_format($width * 0.0017638889, 2, '.', '') . 'cm'); $xmlWriter->endElement(); // style:table-column-properties $xmlWriter->endElement(); // style:style } } } ================================================ FILE: src/PhpWord/Writer/ODText.php ================================================ setPhpWord($phpWord); // Create parts $this->parts = [ 'Mimetype' => 'mimetype', 'Content' => 'content.xml', 'Meta' => 'meta.xml', 'Styles' => 'styles.xml', 'Manifest' => 'META-INF/manifest.xml', ]; foreach (array_keys($this->parts) as $partName) { $partClass = static::class . '\\Part\\' . $partName; if (class_exists($partClass)) { /** @var AbstractPart $partObject Type hint */ $partObject = new $partClass(); $partObject->setParentWriter($this); $this->writerParts[strtolower($partName)] = $partObject; } } // Set package paths $this->mediaPaths = ['image' => 'Pictures/']; } /** * Save PhpWord to file. */ public function save(string $filename): void { $filename = $this->getTempFile($filename); $zip = $this->getZipArchive($filename); // Add section media files $sectionMedia = Media::getElements('section'); if (!empty($sectionMedia)) { $this->addFilesToPackage($zip, $sectionMedia); } // Write parts foreach ($this->parts as $partName => $fileName) { if ($fileName === '') { continue; } $part = $this->getWriterPart($partName); if (!$part instanceof AbstractPart) { continue; } $part->setObjects($this->objects); $zip->addFromString($fileName, $part->write()); $this->objects = $part->getObjects(); } // Write objects charts if (!empty($this->objects)) { $writer = new MathML(); foreach ($this->objects as $idxObject => $object) { if ($object instanceof Formula) { $zip->addFromString('Formula' . $idxObject . '/content.xml', $writer->write($object->getMath())); } } } // Close zip archive and cleanup temp file $zip->close(); $this->cleanupTempFile(); } } ================================================ FILE: src/PhpWord/Writer/PDF/AbstractRenderer.php ================================================ 'A4', // (210 mm by 297 mm) ]; /** * Create new instance. * * @param PhpWord $phpWord PhpWord object */ public function __construct(PhpWord $phpWord) { parent::__construct($phpWord); $this->isPdf = true; if ($this->includeFile != null) { $includeFile = Settings::getPdfRendererPath() . '/' . $this->includeFile; if (file_exists($includeFile)) { /** @noinspection PhpIncludeInspection Dynamic includes */ require_once $includeFile; } else { // @codeCoverageIgnoreStart // Can't find any test case. Uncomment when found. throw new Exception('Unable to load PDF Rendering library'); // @codeCoverageIgnoreEnd } } // Configuration $options = Settings::getPdfRendererOptions(); if (!empty($options['font'])) { $this->setFont($options['font']); } } /** * Get Font. * * @return string */ public function getFont() { return $this->font; } /** * Set font. Examples: * 'arialunicid0-chinese-simplified' * 'arialunicid0-chinese-traditional' * 'arialunicid0-korean' * 'arialunicid0-japanese'. * * @param string $fontName * * @return self */ public function setFont($fontName) { $this->font = $fontName; return $this; } /** * Get Paper Size. * * @return int */ public function getPaperSize() { return $this->paperSize; } /** * Set Paper Size. * * @param int $value Paper size = PAPERSIZE_A4 * * @return self */ public function setPaperSize($value = 9) { $this->paperSize = $value; return $this; } /** * Get Orientation. * * @return string */ public function getOrientation() { return $this->orientation; } /** * Set Orientation. * * @param string $value Page orientation ORIENTATION_DEFAULT * * @return self */ public function setOrientation($value = 'default') { $this->orientation = $value; return $this; } /** * Save PhpWord to PDF file, pre-save. * * @param string $filename Name of the file to save as * * @return resource */ protected function prepareForSave($filename = null) { $fileHandle = fopen($filename, 'wb'); // @codeCoverageIgnoreStart // Can't find any test case. Uncomment when found. if ($fileHandle === false) { throw new Exception("Could not open file $filename for writing."); } // @codeCoverageIgnoreEnd return $fileHandle; } /** * Save PhpWord to PDF file, post-save. * * @param resource $fileHandle */ protected function restoreStateAfterSave($fileHandle): void { fclose($fileHandle); } } ================================================ FILE: src/PhpWord/Writer/PDF/DomPDF.php ================================================ getFont()) { $options->set('defaultFont', $this->getFont()); } return new DompdfLib($options); } /** * Save PhpWord to file. */ public function save(string $filename): void { $fileHandle = parent::prepareForSave($filename); // PDF settings $paperSize = 'A4'; $orientation = 'portrait'; // Create PDF $pdf = $this->createExternalWriterInstance(); $pdf->setPaper(strtolower($paperSize), $orientation); $pdf->loadHtml(str_replace(PHP_EOL, '', $this->getContent())); $pdf->render(); // Write to file fwrite($fileHandle, $pdf->output()); parent::restoreStateAfterSave($fileHandle); } } ================================================ FILE: src/PhpWord/Writer/PDF/MPDF.php ================================================ '; private const BODY_TAG = ''; /** * Overridden to set the correct includefile, only needed for MPDF 5. * * @codeCoverageIgnore */ public function __construct(PhpWord $phpWord) { if (file_exists(Settings::getPdfRendererPath() . '/mpdf.php')) { // MPDF version 5.* needs this file to be included, later versions not $this->includeFile = 'mpdf.php'; } parent::__construct($phpWord); } /** * Gets the implementation of external PDF library that should be used. * * @return \Mpdf\Mpdf implementation */ protected function createExternalWriterInstance() { $mPdfClass = $this->getMPdfClassName(); $options = []; if ($this->getFont()) { $options['default_font'] = $this->getFont(); } return new $mPdfClass($options); } /** * Save PhpWord to file. */ public function save(string $filename): void { $fileHandle = parent::prepareForSave($filename); // PDF settings $paperSize = strtoupper('A4'); $orientation = strtoupper('portrait'); // Create PDF $pdf = $this->createExternalWriterInstance(); $pdf->_setPageSize($paperSize, $orientation); $pdf->addPage($orientation); // Write document properties $phpWord = $this->getPhpWord(); $docProps = $phpWord->getDocInfo(); $pdf->setTitle($docProps->getTitle()); $pdf->setAuthor($docProps->getCreator()); $pdf->setSubject($docProps->getSubject()); $pdf->setKeywords($docProps->getKeywords()); $pdf->setCreator($docProps->getCreator()); $html = $this->getContent(); $bodyLocation = strpos($html, self::SIMULATED_BODY_START); if ($bodyLocation === false) { $bodyLocation = strpos($html, self::BODY_TAG); if ($bodyLocation !== false) { $bodyLocation += strlen(self::BODY_TAG); } } // Make sure first data presented to Mpdf includes body tag // (and any htmlpageheader/htmlpagefooter tags) // so that Mpdf doesn't parse it as content. Issue 2432. if ($bodyLocation !== false) { $pdf->WriteHTML(substr($html, 0, $bodyLocation)); $html = substr($html, $bodyLocation); } foreach (explode("\n", $html) as $line) { $pdf->WriteHTML("$line\n"); } // Write to file fwrite($fileHandle, $pdf->output($filename, 'S')); parent::restoreStateAfterSave($fileHandle); } /** * Return classname of MPDF to instantiate. * * @codeCoverageIgnore * * @return string */ private function getMPdfClassName() { if ($this->includeFile != null) { // MPDF version 5.* return '\mpdf'; } // MPDF version > 6.* return '\Mpdf\Mpdf'; } } ================================================ FILE: src/PhpWord/Writer/PDF/TCPDF.php ================================================ getFont()) { $instance->setFont($this->getFont(), $instance->getFontStyle(), $instance->getFontSizePt()); } return $instance; } /** * Overwriteable function to allow user to extend TCPDF. * There should always be an AddPage call, preceded or followed * by code to customize TCPDF configuration. * The customization below sets vertical spacing * between paragaraphs when the user has * explicitly set those values to numeric in default style. */ protected function prepareToWrite(TCPDFBase $pdf): void { $pdf->AddPage(); $customStyles = Style::getStyles(); $normal = $customStyles['Normal'] ?? null; if ($normal instanceof Style\Paragraph) { $before = $normal->getSpaceBefore(); $after = $normal->getSpaceAfter(); if (is_numeric($before) && is_numeric($after)) { $height = $normal->getLineHeight() ?? ''; $pdf->setHtmlVSpace([ 'p' => [ ['n' => $before, 'h' => $height], ['n' => $after, 'h' => $height], ], ]); } } } /** * Save PhpWord to file. */ public function save(string $filename): void { $fileHandle = parent::prepareForSave($filename); // PDF settings $paperSize = strtoupper(Settings::getDefaultPaper()); $orientation = 'P'; // Create PDF $pdf = $this->createExternalWriterInstance($orientation, 'pt', $paperSize); $pdf->setFontSubsetting(false); $pdf->setPrintHeader(false); $pdf->setPrintFooter(false); $pdf->SetFont($this->getFont()); $this->prepareToWrite($pdf); $pdf->writeHTML($this->getContent()); // Write document properties $phpWord = $this->getPhpWord(); $docProps = $phpWord->getDocInfo(); $pdf->SetTitle($docProps->getTitle()); $pdf->SetAuthor($docProps->getCreator()); $pdf->SetSubject($docProps->getSubject()); $pdf->SetKeywords($docProps->getKeywords()); $pdf->SetCreator($docProps->getCreator()); // Write to file fwrite($fileHandle, $pdf->Output($filename, 'S')); parent::restoreStateAfterSave($fileHandle); } } ================================================ FILE: src/PhpWord/Writer/PDF.php ================================================ renderer = new $rendererName($phpWord); } /** * Magic method to handle direct calls to the configured PDF renderer wrapper class. * * @param string $name Renderer library method name * @param mixed[] $arguments Array of arguments to pass to the renderer method * * @return mixed Returned data from the PDF renderer wrapper method */ public function __call($name, $arguments) { // Note: Commented because all exceptions should already be catched by `__construct` // if ($this->renderer === null) { // throw new Exception("PDF Rendering library has not been defined."); // } return call_user_func_array([$this->getRenderer(), $name], $arguments); } public function save(string $filename): void { $this->getRenderer()->save($filename); } public function getRenderer(): AbstractRenderer { return $this->renderer; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/AbstractElement.php ================================================ parentWriter = $parentWriter; $this->element = $element; $this->withoutP = $withoutP; $this->escaper = new Rtf(); } /** * Get font and paragraph styles. */ protected function getStyles(): void { /** @var WriterRTF $parentWriter Type hint */ $parentWriter = $this->parentWriter; /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */ $element = $this->element; // Font style if (method_exists($element, 'getFontStyle')) { $this->fontStyle = $element->getFontStyle(); if (is_string($this->fontStyle)) { $this->fontStyle = Style::getStyle($this->fontStyle); } } // Paragraph style if (method_exists($element, 'getParagraphStyle')) { $this->paragraphStyle = $element->getParagraphStyle(); if (is_string($this->paragraphStyle)) { $this->paragraphStyle = Style::getStyle($this->paragraphStyle); } if ($this->paragraphStyle !== null && !$this->withoutP) { if ($parentWriter->getLastParagraphStyle() != $element->getParagraphStyle()) { $parentWriter->setLastParagraphStyle($element->getParagraphStyle()); } else { $parentWriter->setLastParagraphStyle(); $this->paragraphStyle = null; } } else { $parentWriter->setLastParagraphStyle(); $this->paragraphStyle = null; } } } /** * Write opening. * * @return string */ protected function writeOpening() { if ($this->withoutP || !$this->paragraphStyle instanceof ParagraphStyle) { return ''; } $styleWriter = new ParagraphStyleWriter($this->paragraphStyle); $styleWriter->setNestedLevel($this->element->getNestedLevel()); return $styleWriter->write(); } /** * Write text. * * @param string $text * * @return string */ protected function writeText($text) { if (Settings::isOutputEscapingEnabled()) { return $this->escaper->escape($text); } return SharedText::toUnicode($text); // todo: replace with `return $text;` later. } /** * Write closing. * * @return string */ protected function writeClosing() { if ($this->withoutP) { return ''; } return '\par' . PHP_EOL; } /** * Write font style. * * @return string */ protected function writeFontStyle() { if (!$this->fontStyle instanceof FontStyle) { return ''; } /** @var WriterRTF $parentWriter Type hint */ $parentWriter = $this->parentWriter; // Create style writer and set color/name index $styleWriter = new FontStyleWriter($this->fontStyle); if ($this->fontStyle->getColor() != null) { $colorIndex = array_search($this->fontStyle->getColor(), $parentWriter->getColorTable()); if ($colorIndex !== false) { $styleWriter->setColorIndex($colorIndex + 1); } } if ($this->fontStyle->getName() != null) { $fontIndex = array_search($this->fontStyle->getName(), $parentWriter->getFontTable()); if ($fontIndex !== false) { $styleWriter->setNameIndex($fontIndex); } } // Write style $content = $styleWriter->write(); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Container.php ================================================ element; if (!$container instanceof ContainerElement) { return ''; } $containerClass = substr(get_class($container), strrpos(get_class($container), '\\') + 1); $withoutP = in_array($containerClass, ['TextRun', 'Footnote', 'Endnote']) ? true : false; $content = ''; $elements = $container->getElements(); foreach ($elements as $element) { $elementClass = get_class($element); $writerClass = str_replace('PhpOffice\\PhpWord\\Element', $this->namespace, $elementClass); if (class_exists($writerClass)) { /** @var AbstractElement $writer Type hint */ $writer = new $writerClass($this->parentWriter, $element, $withoutP); $content .= $writer->write(); } } return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Field.php ================================================ element; if (!$element instanceof ElementField) { return; } $this->getStyles(); $content = ''; $content .= $this->writeOpening(); $content .= '{'; $content .= $this->writeFontStyle(); $methodName = 'write' . ucfirst(strtolower($element->getType())); if (!method_exists($this, $methodName)) { // Unsupported field $content .= ''; } else { $content .= '\\field{\\*\\fldinst '; $content .= $this->$methodName($element); $content .= '}{\\fldrslt}'; } $content .= '}'; $content .= $this->writeClosing(); return $content; } protected function writePage() { return 'PAGE'; } protected function writeNumpages() { return 'NUMPAGES'; } protected function writeFilename(ElementField $element): string { $content = 'FILENAME'; $options = $element->getOptions(); if ($options != null && in_array('Path', $options)) { $content .= ' \\\\p'; } return $content; } protected function writeDate(ElementField $element) { $content = ''; $content .= 'DATE'; $properties = $element->getProperties(); if (isset($properties['dateformat'])) { $content .= ' \\\\@ "' . $properties['dateformat'] . '"'; } return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Image.php ================================================ element instanceof ImageElement) { return ''; } $this->getStyles(); $style = $this->element->getStyle(); $content = ''; $content .= $this->writeOpening(); $content .= '{\*\shppict {\pict'; $content .= '\pngblip\picscalex100\picscaley100'; $content .= '\picwgoal' . round(Converter::pixelToTwip($style->getWidth())); $content .= '\pichgoal' . round(Converter::pixelToTwip($style->getHeight())); $content .= PHP_EOL; $content .= $this->element->getImageStringData(); $content .= '}}'; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Link.php ================================================ element instanceof \PhpOffice\PhpWord\Element\Link) { return ''; } $this->getStyles(); $content = ''; $content .= $this->writeOpening(); $content .= '{\field {\*\fldinst {HYPERLINK "' . $this->element->getSource() . '"}}{\\fldrslt {'; $content .= $this->writeFontStyle(); $content .= $this->writeText($this->element->getText()); $content .= '}}}'; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/ListItem.php ================================================ element; $elementClass = str_replace('\\Writer\\RTF', '', static::class); if (!$element instanceof $elementClass || !is_string($element->getBaseTextRun()->getText())) { return ''; } $this->getStyles(); $content = ''; $content .= $this->writeOpening(); $content .= '{'; $content .= $this->writeFontStyle(); $content .= $this->writeText($element->getBaseTextRun()->getText()); $rubyText = $element->getRubyTextRun()->getText(); if ($rubyText !== '') { $content .= ' ('; $content .= $this->writeText($rubyText); $content .= ')'; } $content .= '}'; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Table.php ================================================ element instanceof TableElement) { return ''; } $element = $this->element; // No nesting table for now if ($element->getNestedLevel() >= 1) { return ''; } $content = ''; $style = $this->element->getStyle(); $bidiStyle = (is_object($style) && method_exists($style, 'isBidiVisual')) ? $style->isBidiVisual() : Settings::isDefaultRtl(); $bidi = $bidiStyle ? '\rtlrow' : ''; $rows = $element->getRows(); $rowCount = count($rows); if ($rowCount > 0) { $content .= '\pard' . PHP_EOL; for ($i = 0; $i < $rowCount; ++$i) { $content .= "\\trowd$bidi "; $content .= $this->writeRowDef($rows[$i]); $content .= PHP_EOL; $content .= $this->writeRow($rows[$i]); $content .= '\row' . PHP_EOL; } $content .= '\pard' . PHP_EOL; } return $content; } /** * Write column. * * @return string */ private function writeRowDef(RowElement $row) { $content = ''; $tableStyle = $this->element->getStyle(); if (is_string($tableStyle)) { $tableStyle = Style::getStyle($tableStyle); if (!($tableStyle instanceof TableStyle)) { $tableStyle = null; } } $rightMargin = 0; foreach ($row->getCells() as $cell) { $content .= $this->writeCellStyle($cell->getStyle(), $tableStyle); $width = $cell->getWidth(); $vMerge = $this->getVMerge($cell->getStyle()->getVMerge()); if ($width === null) { $width = 720; // Arbitrary default width } $rightMargin += $width; $content .= "{$vMerge}\\cellx{$rightMargin} "; } return $content; } /** * Write row. * * @return string */ private function writeRow(RowElement $row) { $content = ''; // Write cells foreach ($row->getCells() as $cell) { $content .= $this->writeCell($cell); } return $content; } /** * Write cell. * * @return string */ private function writeCell(CellElement $cell) { $content = '\intbl' . PHP_EOL; // Write content $writer = new Container($this->parentWriter, $cell); $content .= $writer->write(); $content .= '\cell' . PHP_EOL; return $content; } private function writeCellStyle(CellStyle $cell, ?TableStyle $table): string { $content = $this->writeCellBorder( 't', $cell->getBorderTopStyle() ?: ($table ? $table->getBorderTopStyle() : null), (int) round($cell->getBorderTopSize() ?: ($table ? ($table->getBorderTopSize() ?: 0) : 0)), $cell->getBorderTopColor() ?? ($table ? $table->getBorderTopColor() : null) ); $content .= $this->writeCellBorder( 'l', $cell->getBorderLeftStyle() ?: ($table ? $table->getBorderLeftStyle() : null), (int) round($cell->getBorderLeftSize() ?: ($table ? ($table->getBorderLeftSize() ?: 0) : 0)), $cell->getBorderLeftColor() ?? ($table ? $table->getBorderLeftColor() : null) ); $content .= $this->writeCellBorder( 'b', $cell->getBorderBottomStyle() ?: ($table ? $table->getBorderBottomStyle() : null), (int) round($cell->getBorderBottomSize() ?: ($table ? ($table->getBorderBottomSize() ?: 0) : 0)), $cell->getBorderBottomColor() ?? ($table ? $table->getBorderBottomColor() : null) ); $content .= $this->writeCellBorder( 'r', $cell->getBorderRightStyle() ?: ($table ? $table->getBorderRightStyle() : null), (int) round($cell->getBorderRightSize() ?: ($table ? ($table->getBorderRightSize() ?: 0) : 0)), $cell->getBorderRightColor() ?? ($table ? $table->getBorderRightColor() : null) ); return $content; } private function writeCellBorder(string $prefix, ?string $borderStyle, int $borderSize, ?string $borderColor): string { if ($borderSize == 0) { return ''; } $content = '\clbrdr' . $prefix; /** * \brdrs Single-thickness border. * \brdrth Double-thickness border. * \brdrsh Shadowed border. * \brdrdb Double border. * \brdrdot Dotted border. * \brdrdash Dashed border. * \brdrhair Hairline border. * \brdrinset Inset border. * \brdrdashsm Dash border (small). * \brdrdashd Dot dash border. * \brdrdashdd Dot dot dash border. * \brdroutset Outset border. * \brdrtriple Triple border. * \brdrtnthsg Thick thin border (small). * \brdrthtnsg Thin thick border (small). * \brdrtnthtnsg Thin thick thin border (small). * \brdrtnthmg Thick thin border (medium). * \brdrthtnmg Thin thick border (medium). * \brdrtnthtnmg Thin thick thin border (medium). * \brdrtnthlg Thick thin border (large). * \brdrthtnlg Thin thick border (large). * \brdrtnthtnlg Thin thick thin border (large). * \brdrwavy Wavy border. * \brdrwavydb Double wavy border. * \brdrdashdotstr Striped border. * \brdremboss Emboss border. * \brdrengrave Engrave border. */ switch ($borderStyle) { case Border::DOTTED: $content .= '\brdrdot'; break; case Border::SINGLE: default: $content .= '\brdrs'; break; } // \brdrwN N is the width in twips (1/20 pt) of the pen used to draw the paragraph border line. // N cannot be greater than 75. // To obtain a larger border width, the \brdth control word can be used to obtain a width double that of N. // $borderSize is in eights of a point, i.e. 4 / 8 = .5pt // 1/20 pt => 1/8 / 2.5 $content .= '\brdrw' . (int) ($borderSize / 2.5); // \brdrcfN N is the color of the paragraph border, specified as an index into the color table in the RTF header. $colorIndex = 0; $index = array_search($borderColor, $this->parentWriter->getColorTable()); if ($index !== false) { $colorIndex = (int) $index + 1; } $content .= '\brdrcf' . $colorIndex; $content .= PHP_EOL; return $content; } /** * Get vertical merge style. * * @param string $value * * @return string * * @todo Move to style */ private function getVMerge($value) { $style = ''; if ($value == 'restart') { $style = '\clvmgf'; } elseif ($value == 'continue') { $style = '\clvmrg'; } return $style; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Text.php ================================================ element; $elementClass = str_replace('\\Writer\\RTF', '', static::class); if (!$element instanceof $elementClass || !is_string($element->getText())) { return ''; } $this->getStyles(); $content = ''; $content .= $this->writeOpening(); $content .= '{'; $content .= $this->writeFontStyle(); $content .= $this->writeText($element->getText()); $content .= '}'; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/TextBreak.php ================================================ parentWriter; $parentWriter->setLastParagraphStyle(); return '\pard\par' . PHP_EOL; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/TextRun.php ================================================ parentWriter, $this->element); $this->getStyles(); $content = ''; $content .= $this->writeOpening(); $content .= '{'; $content .= $writer->write(); $content .= '}'; $content .= $this->writeClosing(); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Element/Title.php ================================================ element; $style = $element->getStyle(); $style = str_replace('Heading', 'Heading_', $style ?? ''); $style = \PhpOffice\PhpWord\Style::getStyle($style); if ($style instanceof \PhpOffice\PhpWord\Style\Font) { $this->fontStyle = $style; $pstyle = $style->getParagraph(); if ($pstyle instanceof \PhpOffice\PhpWord\Style\Paragraph && $pstyle->hasPageBreakBefore()) { $sect = $element->getParent(); if ($sect instanceof \PhpOffice\PhpWord\Element\Section) { $elems = $sect->getElements(); if ($elems[0] === $element) { $pstyle = clone $pstyle; $pstyle->setPageBreakBefore(false); } } } $this->paragraphStyle = $pstyle; } } /** * Write element. * * @return string */ public function write() { /** @var \PhpOffice\PhpWord\Element\Title $element Type hint */ $element = $this->element; $elementClass = str_replace('\\Writer\\RTF', '', static::class); if (!$element instanceof $elementClass) { return ''; } $textToWrite = $element->getText(); if ($textToWrite instanceof \PhpOffice\PhpWord\Element\TextRun) { $textToWrite = $textToWrite->getText(); // gets text from TextRun } $this->getStyles(); $content = ''; $content .= $this->writeOpening(); $endout = ''; $style = $element->getStyle(); if (is_string($style)) { $style = str_replace('Heading', '', $style); if ("$style" !== '') { $style = (int) $style - 1; if ($style >= 0 && $style <= 8) { $content .= '{\\outlinelevel' . $style; $endout = '}'; } } } $content .= '{'; $content .= $this->writeFontStyle(); $content .= $this->writeText($textToWrite); $content .= '}'; $content .= $this->writeClosing(); $content .= $endout; return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF/Part/AbstractPart.php ================================================ escaper = new Rtf(); } /** * @return string */ abstract public function write(); /** * @param \PhpOffice\PhpWord\Writer\RTF $writer */ public function setParentWriter(?AbstractWriter $writer = null): void { $this->parentWriter = $writer; } /** * @return \PhpOffice\PhpWord\Writer\RTF */ public function getParentWriter() { if ($this->parentWriter !== null) { return $this->parentWriter; } throw new Exception('No parent WriterInterface assigned.'); } } ================================================ FILE: src/PhpWord/Writer/RTF/Part/Document.php ================================================ writeInfo(); $content .= $this->writeFormatting(); $content .= $this->writeSections(); return $content; } /** * Write document information. * * @return string */ private function writeInfo() { $docProps = $this->getParentWriter()->getPhpWord()->getDocInfo(); $properties = [ 'title' => 'title', 'subject' => 'subject', 'category' => 'category', 'keywords' => 'keywords', 'comment' => 'description', 'author' => 'creator', 'operator' => 'lastModifiedBy', 'creatim' => 'created', 'revtim' => 'modified', 'company' => 'company', 'manager' => 'manager', ]; $dateFields = ['creatim', 'revtim']; $content = ''; $content .= '{'; $content .= '\info'; foreach ($properties as $property => $propertyMethod) { $method = 'get' . $propertyMethod; $value = $docProps->$method(); if (!in_array($property, $dateFields) && Settings::isOutputEscapingEnabled()) { $value = $this->escaper->escape($value); } $value = in_array($property, $dateFields) ? $this->getDateValue($value) : $value; $content .= "{\\{$property} {$value}}"; } $content .= '}'; $content .= PHP_EOL; return $content; } /** * Write document formatting properties. * * @return string */ private function writeFormatting() { $docSettings = $this->getParentWriter()->getPhpWord()->getSettings(); // Applies a language to a text run (defaults to 1036 : French (France)) $langId = $docSettings->getThemeFontLang() != null && $docSettings->getThemeFontLang()->getLangId() != null ? $docSettings->getThemeFontLang()->getLangId() : 1036; $content = ''; $content .= '\deftab720'; // Set the default tab size (720 twips) $content .= '\viewkind1'; // Set the view mode of the document $content .= '\uc1'; // Set the numberof bytes that follows a unicode character $content .= '\pard'; // Resets to default paragraph properties. $content .= '\nowidctlpar'; // No widow/orphan control $content .= '\lang' . $langId; $content .= '\kerning1'; // Point size (in half-points) above which to kern character pairs $content .= '\fs' . (Settings::getDefaultFontSize() * 2); // Set the font size in half-points if ($docSettings->hasEvenAndOddHeaders()) { $content .= '\\facingp'; } $content .= PHP_EOL; return $content; } /** * Write titlepg directive if any "f" headers or footers. * * @param \PhpOffice\PhpWord\Element\Section $section * * @return string */ private static function writeTitlepg($section) { foreach ($section->getHeaders() as $header) { if ($header->getType() === Footer::FIRST) { return '\\titlepg' . PHP_EOL; } } foreach ($section->getFooters() as $header) { if ($header->getType() === Footer::FIRST) { return '\\titlepg' . PHP_EOL; } } return ''; } /** * Write sections. * * @return string */ private function writeSections() { $content = ''; $sections = $this->getParentWriter()->getPhpWord()->getSections(); $evenOdd = $this->getParentWriter()->getPhpWord()->getSettings()->hasEvenAndOddHeaders(); $sectOwed = false; foreach ($sections as $section) { if ($sectOwed) { $content .= '\sect' . PHP_EOL; } else { $sectOwed = true; } $styleWriter = new SectionStyleWriter($section->getStyle()); $styleWriter->setParentWriter($this->getParentWriter()); $content .= $styleWriter->write(); $content .= self::writeTitlepg($section); foreach ($section->getHeaders() as $header) { $type = $header->getType(); if ($evenOdd || $type !== Footer::EVEN) { $content .= '{\\header'; if ($type === Footer::FIRST) { $content .= 'f'; } elseif ($evenOdd) { $content .= ($type === Footer::EVEN) ? 'l' : 'r'; } foreach ($header->getElements() as $element) { $cl = get_class($element); $cl2 = str_replace('Element', 'Writer\\RTF\\Element', $cl); if (class_exists($cl2)) { $elementWriter = new $cl2($this->getParentWriter(), $element); $content .= $elementWriter->write(); } } $content .= '}' . PHP_EOL; } } foreach ($section->getFooters() as $footer) { $type = $footer->getType(); if ($evenOdd || $type !== Footer::EVEN) { $content .= '{\\footer'; if ($type === Footer::FIRST) { $content .= 'f'; } elseif ($evenOdd) { $content .= ($type === Footer::EVEN) ? 'l' : 'r'; } foreach ($footer->getElements() as $element) { $cl = get_class($element); $cl2 = str_replace('Element', 'Writer\\RTF\\Element', $cl); if (class_exists($cl2)) { $elementWriter = new $cl2($this->getParentWriter(), $element); $content .= $elementWriter->write(); } } $content .= '}' . PHP_EOL; } } $elementWriter = new Container($this->getParentWriter(), $section); $content .= $elementWriter->write(); } return $content; } /** * Get date value. * * The format of date value is `\yr?\mo?\dy?\hr?\min?\sec?` * * @param int $value * * @return string */ private function getDateValue($value) { $dateParts = [ 'Y' => 'yr', 'm' => 'mo', 'd' => 'dy', 'H' => 'hr', 'i' => 'min', 's' => 'sec', ]; $result = ''; foreach ($dateParts as $dateFormat => $controlWord) { $result .= '\\' . $controlWord . date($dateFormat, $value); } return $result; } } ================================================ FILE: src/PhpWord/Writer/RTF/Part/Header.php ================================================ fontTable; } /** * Get color table. * * @return array */ public function getColorTable() { return $this->colorTable; } /** * Write part. * * @return string */ public function write() { $this->registerFont(); $content = ''; $content .= $this->writeCharset(); $content .= $this->writeDefaults(); $content .= $this->writeFontTable(); $content .= $this->writeColorTable(); $content .= $this->writeGenerator(); $content .= PHP_EOL; return $content; } /** * Write character set. * * @return string */ private function writeCharset() { $content = ''; $content .= '\ansi'; $content .= '\ansicpg1252'; $content .= PHP_EOL; return $content; } /** * Write header defaults. * * @return string */ private function writeDefaults() { $content = ''; $content .= '\deff0'; $content .= PHP_EOL; return $content; } /** * Write font table. * * @return string */ private function writeFontTable() { $content = ''; $content .= '{'; $content .= '\fonttbl'; foreach ($this->fontTable as $index => $font) { $content .= "{\\f{$index}\\fnil\\fcharset0 {$font};}"; } $content .= '}'; $content .= PHP_EOL; return $content; } /** * Write color table. * * @return string */ private function writeColorTable() { $content = ''; $content .= '{'; $content .= '\colortbl;'; foreach ($this->colorTable as $color) { [$red, $green, $blue] = Converter::htmlToRgb($color); $content .= "\\red{$red}\\green{$green}\\blue{$blue};"; } $content .= '}'; $content .= PHP_EOL; return $content; } /** * Write. * * @return string */ private function writeGenerator() { $content = ''; $content .= '{\*\generator PHPWord;}'; // Set the generator $content .= PHP_EOL; return $content; } /** * Register all fonts and colors in both named and inline styles to appropriate header table. */ private function registerFont(): void { $phpWord = $this->getParentWriter()->getPhpWord(); $this->fontTable[] = Settings::getDefaultFontName(); // Search named styles $styles = Style::getStyles(); foreach ($styles as $style) { $this->registerFontItems($style); } // Search inline styles $sections = $phpWord->getSections(); foreach ($sections as $section) { $elements = $section->getElements(); $this->registerBorderColor($section->getStyle()); foreach ($elements as $element) { if (method_exists($element, 'getFontStyle')) { $style = $element->getFontStyle(); $this->registerFontItems($style); } } } } /** * Register border colors. * * @param Style\Border $style */ private function registerBorderColor($style): void { $colors = $style->getBorderColor(); foreach ($colors as $color) { if ($color !== null) { $this->registerTableItem($this->colorTable, $color); } } } /** * Register fonts and colors. * * @param Style\AbstractStyle $style */ private function registerFontItems($style): void { $defaultFont = Settings::getDefaultFontName(); $defaultColor = Settings::DEFAULT_FONT_COLOR; if ($style instanceof Font) { $this->registerTableItem($this->fontTable, $style->getName(), $defaultFont); $this->registerTableItem($this->colorTable, $style->getColor(), $defaultColor); $this->registerTableItem($this->colorTable, $style->getFgColor(), $defaultColor); return; } if ($style instanceof Table) { $this->registerTableItem($this->colorTable, $style->getBorderTopColor(), $defaultColor); $this->registerTableItem($this->colorTable, $style->getBorderRightColor(), $defaultColor); $this->registerTableItem($this->colorTable, $style->getBorderLeftColor(), $defaultColor); $this->registerTableItem($this->colorTable, $style->getBorderBottomColor(), $defaultColor); } } /** * Register individual font and color. * * @param array &$table * @param string $value * @param string $default */ private function registerTableItem(&$table, $value, $default = null): void { if (in_array($value, $table) === false && $value !== null && $value != $default) { $table[] = $value; } } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/AbstractStyle.php ================================================ style = $style; } /** * Set parent writer. * * @param RTF $writer */ public function setParentWriter($writer): void { $this->parentWriter = $writer; } /** * Get parent writer. * * @return RTF */ public function getParentWriter() { return $this->parentWriter; } /** * Get style. * * @return null|array|string|StyleAbstract */ public function getStyle() { if (!$this->style instanceof StyleAbstract && !is_array($this->style)) { return ''; } return $this->style; } /** * Get value if ... * * @param null|bool $condition * @param string $value * * @return string */ protected function getValueIf($condition, $value) { return $condition == true ? $value : ''; } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/Border.php ================================================ sizes); // Page border measure // 8 = from text, infront off; 32 = from edge, infront on; 40 = from edge, infront off $content .= '\pgbrdropt32'; for ($i = 0; $i < $sizeCount; ++$i) { if ($this->sizes[$i] !== null) { $color = null; if (isset($this->colors[$i])) { $color = $this->colors[$i]; } $content .= $this->writeSide($sides[$i], $this->sizes[$i], $color); } } return $content; } /** * Write side. * * @param string $side * @param int $width * @param string $color * * @return string */ private function writeSide($side, $width, $color = '') { /** @var \PhpOffice\PhpWord\Writer\RTF $rtfWriter */ $rtfWriter = $this->getParentWriter(); $colorIndex = 0; if ($rtfWriter !== null) { $colorTable = $rtfWriter->getColorTable(); $index = array_search($color, $colorTable); if ($index !== false) { $colorIndex = $index + 1; } } $content = ''; $content .= '\pgbrdr' . substr($side, 0, 1); $content .= '\brdrs'; // Single-thickness border; @todo Get other type of border $content .= '\brdrw' . round($width); // Width $content .= '\brdrcf' . $colorIndex; // Color $content .= '\brsp480'; // Space in twips between borders and the paragraph (24pt, following OOXML) $content .= ' '; return $content; } /** * Set sizes. * * @param int[] $value */ public function setSizes($value): void { $this->sizes = $value; } /** * Set colors. * * @param string[] $value */ public function setColors($value): void { $this->colors = $value; } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/Font.php ================================================ getStyle(); if (!$style instanceof FontStyle) { return ''; } $content = ''; $content .= $this->getValueIf($style->isRTL(), '\rtlch'); $content .= '\cf' . $this->colorIndex; $content .= '\f' . $this->nameIndex; $size = $style->getSize(); $content .= $this->getValueIf(is_numeric($size), '\fs' . round($size * 2)); $content .= $this->getValueIf($style->isBold(), '\b'); $content .= $this->getValueIf($style->isItalic(), '\i'); $content .= $this->getValueIf($style->getUnderline() != FontStyle::UNDERLINE_NONE, '\ul'); $content .= $this->getValueIf($style->isStrikethrough(), '\strike'); $content .= $this->getValueIf($style->isSuperScript(), '\super'); $content .= $this->getValueIf($style->isSubScript(), '\sub'); return $content . ' '; } /** * Set font name index. * * @param int $value */ public function setNameIndex($value = 0): void { $this->nameIndex = $value; } /** * Set font color index. * * @param int $value */ public function setColorIndex($value = 0): void { $this->colorIndex = $value; } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/Indentation.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Indentation) { return ''; } $content = '\fi' . round($style->getFirstLine()); $content .= '\li' . round($style->getLeft()); $content .= '\ri' . round($style->getRight()); return $content . ' '; } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/Paragraph.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Paragraph) { return ''; } $alignments = [ Jc::START => '\ql', Jc::END => '\qr', Jc::CENTER => '\qc', Jc::BOTH => '\qj', self::LEFT => '\ql', self::RIGHT => '\qr', self::JUSTIFY => '\qj', ]; $bidiAlignments = [ Jc::START => '\qr', Jc::END => '\ql', Jc::CENTER => '\qc', Jc::BOTH => '\qj', self::LEFT => '\ql', self::RIGHT => '\qr', self::JUSTIFY => '\qj', ]; $spaceAfter = $style->getSpaceAfter(); $spaceBefore = $style->getSpaceBefore(); $content = ''; if ($this->nestedLevel == 0) { $content .= '\pard\nowidctlpar '; } $alignment = $style->getAlignment(); $bidi = $style->isBidi(); if ($alignment === '' && $bidi !== null) { $alignment = Jc::START; } if (isset($alignments[$alignment])) { $content .= $bidi ? $bidiAlignments[$alignment] : $alignments[$alignment]; } $content .= $this->writeIndentation($style->getIndentation()); $content .= $this->getValueIf($spaceBefore !== null, '\sb' . round($spaceBefore ?? 0)); $content .= $this->getValueIf($spaceAfter !== null, '\sa' . round($spaceAfter ?? 0)); $lineHeight = $style->getLineHeight(); if ($lineHeight) { $lineHeightAdjusted = (int) ($lineHeight * 240); $content .= "\\sl$lineHeightAdjusted\\slmult1"; } if ($style->hasPageBreakBefore()) { $content .= '\\page'; } $styles = $style->getStyleValues(); $content .= $this->writeTabs($styles['tabs']); return $content; } /** * Writes an \PhpOffice\PhpWord\Style\Indentation. * * @param null|\PhpOffice\PhpWord\Style\Indentation $indent * * @return string */ private function writeIndentation($indent = null) { if (isset($indent) && $indent instanceof \PhpOffice\PhpWord\Style\Indentation) { $writer = new Indentation($indent); return $writer->write(); } return ''; } /** * Writes tabs. * * @param \PhpOffice\PhpWord\Style\Tab[] $tabs * * @return string */ private function writeTabs($tabs = null) { $content = ''; if (!empty($tabs)) { foreach ($tabs as $tab) { $styleWriter = new Tab($tab); $content .= $styleWriter->write(); } } return $content; } /** * Set nested level. * * @param int $value */ public function setNestedLevel($value): void { $this->nestedLevel = $value; } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/Section.php ================================================ getStyle(); if (!$style instanceof SectionStyle) { return ''; } $content = ''; $content .= '\sectd '; // Size & margin $content .= $this->getValueIf($style->getPageSizeW() !== null, '\pgwsxn' . round($style->getPageSizeW())); $content .= $this->getValueIf($style->getPageSizeH() !== null, '\pghsxn' . round($style->getPageSizeH())); $content .= ' '; $content .= $this->getValueIf($style->getMarginTop() !== null, '\margtsxn' . round($style->getMarginTop())); $content .= $this->getValueIf($style->getMarginRight() !== null, '\margrsxn' . round($style->getMarginRight())); $content .= $this->getValueIf($style->getMarginBottom() !== null, '\margbsxn' . round($style->getMarginBottom())); $content .= $this->getValueIf($style->getMarginLeft() !== null, '\marglsxn' . round($style->getMarginLeft())); $content .= $this->getValueIf($style->getHeaderHeight() !== null, '\headery' . round($style->getHeaderHeight())); $content .= $this->getValueIf($style->getFooterHeight() !== null, '\footery' . round($style->getFooterHeight())); $content .= $this->getValueIf($style->getGutter() !== null, '\guttersxn' . round($style->getGutter())); $content .= $this->getValueIf($style->getPageNumberingStart() !== null, '\pgnstarts' . $style->getPageNumberingStart() . '\pgnrestart'); $content .= ' '; // Borders if ($style->hasBorder()) { $styleWriter = new Border($style); $styleWriter->setParentWriter($this->getParentWriter()); $styleWriter->setSizes($style->getBorderSize()); $styleWriter->setColors($style->getBorderColor()); $content .= $styleWriter->write(); } return $content . PHP_EOL; } } ================================================ FILE: src/PhpWord/Writer/RTF/Style/Tab.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Tab) { return; } $tabs = [ \PhpOffice\PhpWord\Style\Tab::TAB_STOP_RIGHT => '\tqr', \PhpOffice\PhpWord\Style\Tab::TAB_STOP_CENTER => '\tqc', \PhpOffice\PhpWord\Style\Tab::TAB_STOP_DECIMAL => '\tqdec', ]; $content = ''; if (isset($tabs[$style->getType()])) { $content .= $tabs[$style->getType()]; } $content .= '\tx' . round($style->getPosition()); return $content; } } ================================================ FILE: src/PhpWord/Writer/RTF.php ================================================ setPhpWord($phpWord); $this->parts = ['Header', 'Document']; foreach ($this->parts as $partName) { $partClass = static::class . '\\Part\\' . $partName; if (class_exists($partClass)) { /** @var RTF\Part\AbstractPart $part Type hint */ $part = new $partClass(); $part->setParentWriter($this); $this->writerParts[strtolower($partName)] = $part; } } } /** * Save content to file. */ public function save(string $filename): void { $this->writeFile($this->openFile($filename), $this->getContent()); } /** * Get content. * * @return string * * @since 0.11.0 */ private function getContent() { $content = ''; $content .= '{'; $content .= '\rtf1' . PHP_EOL; $content .= $this->getWriterPart('Header')->write(); $content .= $this->getWriterPart('Document')->write(); $content .= '}'; return $content; } /** * Get font table. * * @return array */ public function getFontTable() { return $this->getWriterPart('Header')->getFontTable(); } /** * Get color table. * * @return array */ public function getColorTable() { return $this->getWriterPart('Header')->getColorTable(); } /** * Get last paragraph style. * * @return mixed */ public function getLastParagraphStyle() { return $this->lastParagraphStyle; } /** * Set last paragraph style. * * @param mixed $value */ public function setLastParagraphStyle($value = ''): void { $this->lastParagraphStyle = $value; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/AbstractElement.php ================================================ xmlWriter = $xmlWriter; $this->element = $element; $this->withoutP = $withoutP; } /** * Get XML Writer. * * @return XMLWriter */ protected function getXmlWriter() { return $this->xmlWriter; } /** * Get element. * * @return Element */ protected function getElement() { return $this->element; } /** * Start w:p DOM element. * * @uses \PhpOffice\PhpWord\Writer\Word2007\Element\PageBreak::write() */ protected function startElementP(): void { if (!$this->withoutP) { $this->xmlWriter->startElement('w:p'); // Paragraph style if (method_exists($this->element, 'getParagraphStyle')) { $this->writeParagraphStyle(); } } $this->writeCommentRangeStart(); } /** * End w:p DOM element. */ protected function endElementP(): void { $this->writeCommentRangeEnd(); if (!$this->withoutP) { $this->xmlWriter->endElement(); // w:p } } /** * Writes the w:commentRangeStart DOM element. */ protected function writeCommentRangeStart(): void { if ($this->element->getCommentsRangeStart() != null) { foreach ($this->element->getCommentsRangeStart()->getItems() as $comment) { $this->xmlWriter->writeElementBlock('w:commentRangeStart', ['w:id' => $comment->getElementId()]); } } } /** * Writes the w:commentRangeEnd DOM element. */ protected function writeCommentRangeEnd(): void { if ($this->element->getCommentsRangeEnd() != null) { foreach ($this->element->getCommentsRangeEnd()->getItems() as $comment) { $this->xmlWriter->writeElementBlock('w:commentRangeEnd', ['w:id' => $comment->getElementId()]); $this->xmlWriter->startElement('w:r'); $this->xmlWriter->writeElementBlock('w:commentReference', ['w:id' => $comment->getElementId()]); $this->xmlWriter->endElement(); } } if ($this->element->getCommentsRangeStart() != null) { foreach ($this->element->getCommentsRangeStart()->getItems() as $comment) { if ($comment->getEndElement() == null) { $this->xmlWriter->writeElementBlock('w:commentRangeEnd', ['w:id' => $comment->getElementId()]); $this->xmlWriter->startElement('w:r'); $this->xmlWriter->writeElementBlock('w:commentReference', ['w:id' => $comment->getElementId()]); $this->xmlWriter->endElement(); } } } } /** * Write ending. */ protected function writeParagraphStyle(): void { $this->writeTextStyle('Paragraph'); } /** * Write ending. */ protected function writeFontStyle(): void { $this->writeTextStyle('Font'); } /** * Write text style. * * @param string $styleType Font|Paragraph */ private function writeTextStyle($styleType): void { $method = "get{$styleType}Style"; $class = "PhpOffice\\PhpWord\\Writer\\Word2007\\Style\\{$styleType}"; $styleObject = $this->element->$method(); /** @var \PhpOffice\PhpWord\Writer\Word2007\Style\AbstractStyle $styleWriter Type Hint */ $styleWriter = new $class($this->xmlWriter, $styleObject); if (method_exists($styleWriter, 'setIsInline')) { $styleWriter->setIsInline(true); } $styleWriter->write(); } /** * Convert text to valid format. * * @param string $text * * @return string */ protected function getText($text) { return SharedText::controlCharacterPHP2OOXML($text); } /** * Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled(). * * @param string $content The text string to write * * @return bool Returns true on success or false on failure */ protected function writeText($content) { if (Settings::isOutputEscapingEnabled()) { return $this->getXmlWriter()->text($content); } return $this->getXmlWriter()->writeRaw($content); } public function setPart(?AbstractPart $part): self { $this->part = $part; return $this; } public function getPart(): ?AbstractPart { return $this->part; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Bookmark.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Bookmark) { return; } $rId = $element->getRelationId(); $xmlWriter->startElement('w:bookmarkStart'); $xmlWriter->writeAttribute('w:id', $rId); $xmlWriter->writeAttribute('w:name', $element->getName()); $xmlWriter->endElement(); $xmlWriter->startElement('w:bookmarkEnd'); $xmlWriter->writeAttribute('w:id', $rId); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Chart.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof ChartElement) { return; } $rId = $element->getRelationId(); $style = $element->getStyle(); if (!$this->withoutP) { $xmlWriter->startElement('w:p'); } $this->writeCommentRangeStart(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:drawing'); $xmlWriter->startElement('wp:inline'); // EMU $xmlWriter->writeElementBlock('wp:extent', ['cx' => $style->getWidth(), 'cy' => $style->getHeight()]); $xmlWriter->writeElementBlock('wp:docPr', ['id' => $rId, 'name' => "Chart{$rId}"]); $xmlWriter->startElement('a:graphic'); $xmlWriter->writeAttribute('xmlns:a', 'http://schemas.openxmlformats.org/drawingml/2006/main'); $xmlWriter->startElement('a:graphicData'); $xmlWriter->writeAttribute('uri', 'http://schemas.openxmlformats.org/drawingml/2006/chart'); $xmlWriter->startElement('c:chart'); $xmlWriter->writeAttribute('r:id', "rId{$rId}"); $xmlWriter->writeAttribute('xmlns:c', 'http://schemas.openxmlformats.org/drawingml/2006/chart'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->endElement(); // c:chart $xmlWriter->endElement(); // a:graphicData $xmlWriter->endElement(); // a:graphic $xmlWriter->endElement(); // wp:inline $xmlWriter->endElement(); // w:drawing $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/CheckBox.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\CheckBox) { return; } $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->startElement('w:ffData'); $xmlWriter->startElement('w:name'); $xmlWriter->writeAttribute('w:val', $this->getText($element->getName())); $xmlWriter->endElement(); //w:name $xmlWriter->writeAttribute('w:enabled', ''); $xmlWriter->startElement('w:calcOnExit'); $xmlWriter->writeAttribute('w:val', '0'); $xmlWriter->endElement(); //w:calcOnExit $xmlWriter->startElement('w:checkBox'); $xmlWriter->writeAttribute('w:sizeAuto', ''); $xmlWriter->startElement('w:default'); $xmlWriter->writeAttribute('w:val', 0); $xmlWriter->endElement(); //w:default $xmlWriter->endElement(); //w:checkBox $xmlWriter->endElement(); // w:ffData $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text(' FORMCHECKBOX '); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'separate'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:t'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $this->writeText($this->getText($element->getText())); $xmlWriter->endElement(); // w:t $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Container.php ================================================ */ protected $containerWithoutP = ['TextRun', 'Footnote', 'Endnote', 'ListItemRun']; /** * Write element. */ public function write(): void { $container = $this->getElement(); if (!$container instanceof ContainerElement) { return; } $containerClass = substr(get_class($container), strrpos(get_class($container), '\\') + 1); $withoutP = in_array($containerClass, $this->containerWithoutP); $xmlWriter = $this->getXmlWriter(); // Loop through elements $elements = $container->getElements(); $elementClass = ''; foreach ($elements as $element) { $elementClass = $this->writeElement($xmlWriter, $element, $withoutP); } // Special case for Cell: They have to contain a w:p element at the end. // The $elementClass contains the last element name. If it's empty string // or Table, the last element is not w:p $writeLastTextBreak = ($containerClass == 'Cell') && ($elementClass == '' || $elementClass == 'Table'); if ($writeLastTextBreak) { $writerClass = $this->namespace . '\\TextBreak'; /** @var AbstractElement $writer Type hint */ $writer = new $writerClass($xmlWriter, new TextBreakElement(), $withoutP); $writer->write(); } } /** * Write individual element. */ private function writeElement(XMLWriter $xmlWriter, Element $element, bool $withoutP): string { $elementClass = substr(get_class($element), strrpos(get_class($element), '\\') + 1); $writerClass = $this->namespace . '\\' . $elementClass; if (class_exists($writerClass)) { /** @var AbstractElement $writer Type hint */ $writer = new $writerClass($xmlWriter, $element, $withoutP); $writer->setPart($this->getPart()); $writer->write(); } return $elementClass; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Endnote.php ================================================ getElement(); if (!$element instanceof ElementField) { return; } $methodName = 'write' . ucfirst(strtolower($element->getType())); if (method_exists($this, $methodName)) { $this->$methodName($element); } else { $this->writeDefault($element); } } private function writeDefault(ElementField $element): void { $xmlWriter = $this->getXmlWriter(); $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $instruction = ' ' . $element->getType() . ' '; if ($element->getText() != null) { if (is_string($element->getText())) { $instruction .= '"' . $element->getText() . '" '; $instruction .= $this->buildPropertiesAndOptions($element); } else { $instruction .= '"'; } } else { $instruction .= $this->buildPropertiesAndOptions($element); } $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text($instruction); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r if ($element->getText() != null) { if ($element->getText() instanceof TextRun) { $containerWriter = new Container($xmlWriter, $element->getText(), true); $containerWriter->write(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->text('"' . $this->buildPropertiesAndOptions($element)); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text(' '); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r } } $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'separate'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:noProof'); $xmlWriter->endElement(); // w:noProof $xmlWriter->endElement(); // w:rPr $xmlWriter->writeElement('w:t', $element->getText() != null && is_string($element->getText()) ? $element->getText() : '1'); $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } /** * Writes a macrobutton field. * * //TODO A lot of code duplication with general method, should maybe be refactored */ protected function writeMacrobutton(ElementField $element): void { $xmlWriter = $this->getXmlWriter(); $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $instruction = ' ' . $element->getType() . ' ' . $this->buildPropertiesAndOptions($element); if (is_string($element->getText())) { $instruction .= $element->getText() . ' '; } $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text($instruction); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r if ($element->getText() != null) { if ($element->getText() instanceof TextRun) { $containerWriter = new Container($xmlWriter, $element->getText(), true); $containerWriter->write(); } } $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } private function buildPropertiesAndOptions(ElementField $element) { $propertiesAndOptions = ''; $properties = $element->getProperties(); foreach ($properties as $propkey => $propval) { switch ($propkey) { case 'format': $propertiesAndOptions .= '\\* ' . $propval . ' '; break; case 'numformat': $propertiesAndOptions .= '\\# ' . $propval . ' '; break; case 'dateformat': $propertiesAndOptions .= '\\@ "' . $propval . '" '; break; case 'macroname': $propertiesAndOptions .= $propval . ' '; break; default: $propertiesAndOptions .= '"' . $propval . '" '; break; } } $options = $element->getOptions(); foreach ($options as $option) { switch ($option) { case 'PreserveFormat': $propertiesAndOptions .= '\\* MERGEFORMAT '; break; case 'LunarCalendar': $propertiesAndOptions .= '\\h '; break; case 'SakaEraCalendar': $propertiesAndOptions .= '\\s '; break; case 'LastUsedFormat': $propertiesAndOptions .= '\\l '; break; case 'Bold': $propertiesAndOptions .= '\\b '; break; case 'Italic': $propertiesAndOptions .= '\\i '; break; case 'Path': $propertiesAndOptions .= '\\p '; break; default: $propertiesAndOptions .= $option . ' '; } } return $propertiesAndOptions; } /** * Writes a REF field. */ protected function writeRef(ElementField $element): void { $xmlWriter = $this->getXmlWriter(); $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $instruction = ' ' . $element->getType() . ' '; foreach ($element->getProperties() as $property) { $instruction .= $property . ' '; } foreach ($element->getOptions() as $optionKey => $optionValue) { $instruction .= $this->convertRefOption($optionKey, $optionValue) . ' '; } $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text($instruction); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r if ($element->getText() != null) { if ($element->getText() instanceof TextRun) { $containerWriter = new Container($xmlWriter, $element->getText(), true); $containerWriter->write(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->text('"' . $this->buildPropertiesAndOptions($element)); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text(' '); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r } } $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'separate'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:noProof'); $xmlWriter->endElement(); // w:noProof $xmlWriter->endElement(); // w:rPr $xmlWriter->writeElement('w:t', $element->getText() != null && is_string($element->getText()) ? $element->getText() : '1'); $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } private function convertRefOption(string $optionKey, string $optionValue): string { if ($optionKey === 'NumberSeperatorSequence') { return '\\d ' . $optionValue; } switch ($optionValue) { case 'IncrementAndInsertText': return '\\f'; case 'CreateHyperLink': return '\\h'; case 'NoTrailingPeriod': return '\\n'; case 'IncludeAboveOrBelow': return '\\p'; case 'InsertParagraphNumberRelativeContext': return '\\r'; case 'SuppressNonDelimiterNonNumericalText': return '\\t'; case 'InsertParagraphNumberFullContext': return '\\w'; default: return ''; } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Footnote.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Footnote) { return; } $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:rStyle'); $xmlWriter->writeAttribute('w:val', ucfirst($this->referenceType)); $xmlWriter->endElement(); // w:rStyle $xmlWriter->endElement(); // w:rPr $xmlWriter->startElement("w:{$this->referenceType}"); $xmlWriter->writeAttribute('w:id', $element->getRelationId() + 1); $xmlWriter->endElement(); // w:$referenceType $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/FormField.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof FormFieldElement) { return; } $type = $element->getType(); $instructions = ['textinput' => 'FORMTEXT', 'checkbox' => 'FORMCHECKBOX', 'dropdown' => 'FORMDROPDOWN']; $instruction = $instructions[$type]; $writeFormField = "write{$type}"; $name = $element->getName(); if ($name === null) { $name = $type . $element->getElementId(); } $value = $element->getValue(); if ($value === null) { $value = str_repeat(' ', self::FILLER_LENGTH); } $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->startElement('w:ffData'); $xmlWriter->writeElementBlock('w:enabled', 'w:val', 1); $xmlWriter->writeElementBlock('w:name', 'w:val', $name); $xmlWriter->writeElementBlock('w:calcOnExit', 'w:val', 0); $this->$writeFormField($xmlWriter, $element); $xmlWriter->endElement(); // w:ffData $xmlWriter->endElement(); // w:fldChar $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text("{$instruction}"); $xmlWriter->endElement(); // w:instrText $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->writeElementBlock('w:fldChar', 'w:fldCharType', 'separate'); $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:t'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $this->writeText($value); $xmlWriter->endElement(); // w:t $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->writeElementBlock('w:fldChar', 'w:fldCharType', 'end'); $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } /** * Write textinput. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_FFTextInput.html */ private function writeTextInput(XMLWriter $xmlWriter, FormFieldElement $element): void { $default = $element->getDefault(); $xmlWriter->startElement('w:textInput'); $xmlWriter->writeElementBlock('w:default', 'w:val', $default); $xmlWriter->endElement(); } /** * Write checkbox. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_FFCheckBox.html */ private function writeCheckBox(XMLWriter $xmlWriter, FormFieldElement $element): void { $default = $element->getDefault() ? 1 : 0; $value = $element->getValue(); if ($value == null) { $value = $default; } $value = $value ? 1 : 0; $xmlWriter->startElement('w:checkBox'); $xmlWriter->writeElementBlock('w:sizeAuto', 'w:val', ''); $xmlWriter->writeElementBlock('w:default', 'w:val', $default); $xmlWriter->writeElementBlock('w:checked', 'w:val', $value); $xmlWriter->endElement(); } /** * Write dropdown. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_FFDDList.html */ private function writeDropDown(XMLWriter $xmlWriter, FormFieldElement $element): void { $default = $element->getDefault(); $value = $element->getValue(); if ($value == null) { $value = $default; } $entries = $element->getEntries(); $xmlWriter->startElement('w:ddList'); $xmlWriter->writeElementBlock('w:result', 'w:val', $value); $xmlWriter->writeElementBlock('w:default', 'w:val', $default); foreach ($entries as $entry) { if ($entry == null || $entry == '') { $entry = str_repeat(' ', self::FILLER_LENGTH); } $xmlWriter->writeElementBlock('w:listEntry', 'w:val', $entry); } $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Formula.php ================================================ getElement(); if (!$element instanceof FormulaElement) { return; } $this->startElementP(); $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:r'); $xmlWriter->writeElement('w:rPr'); $xmlWriter->endElement(); $xmlWriter->writeRaw((new OfficeMathML())->write($element->getMath())); $this->endElementP(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Image.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof ImageElement) { return; } if ($element->isWatermark()) { $this->writeWatermark($xmlWriter, $element); } else { $this->writeImage($xmlWriter, $element); } } /** * Write image element. */ private function writeImage(XMLWriter $xmlWriter, ImageElement $element): void { $rId = $element->getRelationId() + ($element->isInSection() ? 6 : 0); $style = $element->getStyle(); $styleWriter = new ImageStyleWriter($xmlWriter, $style); if (!$this->withoutP) { $xmlWriter->startElement('w:p'); $styleWriter->writeAlignment(); } $this->writeCommentRangeStart(); $xmlWriter->startElement('w:r'); // Write position $position = $style->getPosition(); if ($position && $style->getWrap() == FrameStyle::WRAP_INLINE) { $fontStyle = new FontStyle('text'); $fontStyle->setPosition($position); $fontStyleWriter = new FontStyleWriter($xmlWriter, $fontStyle); $fontStyleWriter->write(); } $xmlWriter->startElement('w:pict'); $xmlWriter->startElement('v:shape'); $xmlWriter->writeAttribute('type', '#_x0000_t75'); $xmlWriter->writeAttribute('stroked', 'f'); $styleWriter->write(); $xmlWriter->startElement('v:imagedata'); $xmlWriter->writeAttribute('r:id', 'rId' . $rId); $xmlWriter->writeAttribute('o:title', ''); $xmlWriter->endElement(); // v:imagedata $xmlWriter->endElement(); // v:shape $xmlWriter->endElement(); // w:pict $xmlWriter->endElement(); // w:r $this->endElementP(); } /** * Write watermark element. */ private function writeWatermark(XMLWriter $xmlWriter, ImageElement $element): void { $rId = $element->getRelationId(); $style = $element->getStyle(); $style->setPositioning('absolute'); $styleWriter = new ImageStyleWriter($xmlWriter, $style); if (!$this->withoutP) { $xmlWriter->startElement('w:p'); } $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:pict'); $xmlWriter->startElement('v:shape'); $xmlWriter->writeAttribute('type', '#_x0000_t75'); $xmlWriter->writeAttribute('stroked', 'f'); $styleWriter->write(); $xmlWriter->startElement('v:imagedata'); $xmlWriter->writeAttribute('r:id', 'rId' . $rId); $xmlWriter->writeAttribute('o:title', ''); $xmlWriter->endElement(); // v:imagedata $xmlWriter->endElement(); // v:shape $xmlWriter->endElement(); // w:pict $xmlWriter->endElement(); // w:r if (!$this->withoutP) { $xmlWriter->endElement(); // w:p } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Line.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof LineElement) { return; } $style = $element->getStyle(); $styleWriter = new LineStyleWriter($xmlWriter, $style); $elementId = $element->getElementIndex(); if (!$this->withoutP) { $xmlWriter->startElement('w:p'); $styleWriter->writeAlignment(); } $this->writeCommentRangeStart(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:pict'); // Shapetype could be defined for each line separately, but then a unique id would be necessary if ($elementId == 1) { $xmlWriter->startElement('v:shapetype'); $xmlWriter->writeAttribute('id', '_x0000_t32'); $xmlWriter->writeAttribute('coordsize', '21600,21600'); $xmlWriter->writeAttribute('o:spt', '32'); $xmlWriter->writeAttribute('o:oned', 't'); $xmlWriter->writeAttribute('path', 'm,l21600,21600e'); $xmlWriter->writeAttribute('filled', 'f'); $xmlWriter->startElement('v:path'); $xmlWriter->writeAttribute('arrowok', 't'); $xmlWriter->writeAttribute('fillok', 'f'); $xmlWriter->writeAttribute('o:connecttype', 'none'); $xmlWriter->endElement(); // v:path $xmlWriter->startElement('o:lock'); $xmlWriter->writeAttribute('v:ext', 'edit'); $xmlWriter->writeAttribute('shapetype', 't'); $xmlWriter->endElement(); // o:lock $xmlWriter->endElement(); // v:shapetype } $xmlWriter->startElement('v:shape'); $xmlWriter->writeAttribute('id', sprintf('_x0000_s1%1$03d', $elementId)); $xmlWriter->writeAttribute('type', '#_x0000_t32'); //type should correspond to shapetype id $styleWriter->write(); $styleWriter->writeStroke(); $xmlWriter->endElement(); // v:shape $xmlWriter->endElement(); // w:pict $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Link.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Link) { return; } $rId = $element->getRelationId() + ($element->isInSection() ? 6 : 0); $this->startElementP(); $xmlWriter->startElement('w:hyperlink'); if ($element->isInternal()) { $xmlWriter->writeAttribute('w:anchor', $element->getSource()); } else { $xmlWriter->writeAttribute('r:id', 'rId' . $rId); } $xmlWriter->writeAttribute('w:history', '1'); $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:t'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $this->writeText($element->getText()); $xmlWriter->endElement(); // w:t $xmlWriter->endElement(); // w:r $xmlWriter->endElement(); // w:hyperlink $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/ListItem.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\ListItem) { return; } $textObject = $element->getTextObject(); $styleWriter = new ParagraphStyleWriter($xmlWriter, $textObject->getParagraphStyle()); $styleWriter->setWithoutPPR(true); $styleWriter->setIsInline(true); $xmlWriter->startElement('w:p'); $xmlWriter->startElement('w:pPr'); $styleWriter->write(); $xmlWriter->startElement('w:numPr'); $xmlWriter->startElement('w:ilvl'); $xmlWriter->writeAttribute('w:val', $element->getDepth()); $xmlWriter->endElement(); // w:ilvl $xmlWriter->startElement('w:numId'); $xmlWriter->writeAttribute('w:val', $element->getStyle()->getNumId()); $xmlWriter->endElement(); // w:numId $xmlWriter->endElement(); // w:numPr $xmlWriter->endElement(); // w:pPr $elementWriter = new Text($xmlWriter, $textObject, true); $elementWriter->write(); $xmlWriter->endElement(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/ListItemRun.php ================================================ getElement(); if (!$element instanceof ListItemRunElement) { return; } $this->writeParagraph($element); } private function writeParagraph(ListItemRunElement $element): void { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:p'); $this->writeParagraphProperties($element); $containerWriter = new Container($xmlWriter, $element); $containerWriter->write(); $xmlWriter->endElement(); // w:p } private function writeParagraphProperties(ListItemRunElement $element): void { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:pPr'); $styleWriter = new ParagraphStyleWriter($xmlWriter, $element->getParagraphStyle()); $styleWriter->setIsInline(true); $styleWriter->setWithoutPPR(true); $styleWriter->write(); $this->writeParagraphPropertiesNumbering($element); $xmlWriter->endElement(); // w:pPr } private function writeParagraphPropertiesNumbering(ListItemRunElement $element): void { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:numPr'); $xmlWriter->writeElementBlock('w:ilvl', [ 'w:val' => $element->getDepth(), ]); $xmlWriter->writeElementBlock('w:numId', [ 'w:val' => $element->getStyle()->getNumId(), ]); $xmlWriter->endElement(); // w:numPr } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/OLEObject.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\OLEObject) { return; } $rIdObject = $element->getRelationId() + ($element->isInSection() ? 6 : 0); $rIdImage = $element->getImageRelationId() + ($element->isInSection() ? 6 : 0); $shapeId = md5($rIdObject . '_' . $rIdImage); $objectId = $element->getRelationId() + 1325353440; $style = $element->getStyle(); $styleWriter = new ImageStyleWriter($xmlWriter, $style); if (!$this->withoutP) { $xmlWriter->startElement('w:p'); $styleWriter->writeAlignment(); } $this->writeCommentRangeStart(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:object'); $xmlWriter->writeAttribute('w:dxaOrig', '249'); $xmlWriter->writeAttribute('w:dyaOrig', '160'); // Icon $xmlWriter->startElement('v:shape'); $xmlWriter->writeAttribute('id', $shapeId); $xmlWriter->writeAttribute('type', '#_x0000_t75'); $xmlWriter->writeAttribute('style', 'width:104px;height:67px'); $xmlWriter->writeAttribute('o:ole', ''); $xmlWriter->startElement('v:imagedata'); $xmlWriter->writeAttribute('r:id', 'rId' . $rIdImage); $xmlWriter->writeAttribute('o:title', ''); $xmlWriter->endElement(); // v:imagedata $xmlWriter->endElement(); // v:shape // Object $xmlWriter->startElement('o:OLEObject'); $xmlWriter->writeAttribute('Type', 'Embed'); $xmlWriter->writeAttribute('ProgID', 'Package'); $xmlWriter->writeAttribute('ShapeID', $shapeId); $xmlWriter->writeAttribute('DrawAspect', 'Icon'); $xmlWriter->writeAttribute('ObjectID', '_' . $objectId); $xmlWriter->writeAttribute('r:id', 'rId' . $rIdObject); $xmlWriter->endElement(); // o:OLEObject $xmlWriter->endElement(); // w:object $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/PageBreak.php ================================================ getXmlWriter(); $xmlWriter->startElement('w:p'); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:br'); $xmlWriter->writeAttribute('w:type', 'page'); $xmlWriter->endElement(); // w:br $xmlWriter->endElement(); // w:r $xmlWriter->endElement(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/ParagraphAlignment.php ================================================ attributes['w:val'] = $value; } /** * @since 0.13.0 * * @return string */ final public function getName() { return $this->name; } /** * @since 0.13.0 * * @return string[] */ final public function getAttributes() { return $this->attributes; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/PreserveText.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\PreserveText) { return; } $texts = $element->getText(); if (!is_array($texts)) { $texts = [$texts]; } $this->startElementP(); foreach ($texts as $text) { if (substr($text, 0, 1) == '{') { $text = substr($text, 1, -1); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $this->writeText($text); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'separate'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); $xmlWriter->endElement(); } else { $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $xmlWriter->startElement('w:t'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $this->writeText($this->getText($text)); $xmlWriter->endElement(); $xmlWriter->endElement(); } } $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Ruby.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Ruby) { return; } /** @var \PhpOffice\PhpWord\Element\Ruby $element */ $this->startElementP(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:ruby'); // write properties $xmlWriter->startElement('w:rubyPr'); $properties = $element->getProperties(); $xmlWriter->startElement('w:rubyAlign'); $xmlWriter->writeAttribute('w:val', $properties->getAlignment()); $xmlWriter->endElement(); // w:rubyAlign $xmlWriter->startElement('w:hps'); $xmlWriter->writeAttribute('w:val', $properties->getFontFaceSize()); $xmlWriter->endElement(); // w:hps $xmlWriter->startElement('w:hpsRaise'); $xmlWriter->writeAttribute('w:val', $properties->getFontPointsAboveBaseText()); $xmlWriter->endElement(); // w:hpsRaise $xmlWriter->startElement('w:hpsBaseText'); $xmlWriter->writeAttribute('w:val', $properties->getFontSizeForBaseText()); $xmlWriter->endElement(); // w:hpsBaseText $xmlWriter->startElement('w:lid'); $xmlWriter->writeAttribute('w:val', $properties->getLanguageId()); $xmlWriter->endElement(); // w:lid $xmlWriter->endElement(); // w:rubyPr // write ruby text $xmlWriter->startElement('w:rt'); $rubyTextRun = $element->getRubyTextRun(); $textRunWriter = new TextRun($xmlWriter, $rubyTextRun, true); $textRunWriter->write(); $xmlWriter->endElement(); // w:rt // write base text $xmlWriter->startElement('w:rubyBase'); $baseTextRun = $element->getBaseTextRun(); $textRunWriter = new TextRun($xmlWriter, $baseTextRun, true); $textRunWriter->write(); $xmlWriter->endElement(); // w:rubyBase $xmlWriter->endElement(); // w:ruby $xmlWriter->endElement(); // w:r $this->endElementP(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/SDT.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof SDTElement) { return; } $type = $element->getType(); $writeFormField = "write{$type}"; $alias = $element->getAlias(); $tag = $element->getTag(); $value = $element->getValue(); if ($value === null) { $value = 'Pick value'; } $this->startElementP(); $xmlWriter->startElement('w:sdt'); // Properties $xmlWriter->startElement('w:sdtPr'); $xmlWriter->writeElementIf($alias != null, 'w:alias', 'w:val', $alias); $xmlWriter->writeElementBlock('w:lock', 'w:val', 'sdtLocked'); $xmlWriter->writeElementBlock('w:id', 'w:val', mt_rand(100000000, 999999999)); $xmlWriter->writeElementIf($tag != null, 'w:tag', 'w:val', $tag); $this->$writeFormField($xmlWriter, $element); $xmlWriter->endElement(); // w:sdtPr // Content $xmlWriter->startElement('w:sdtContent'); $xmlWriter->startElement('w:r'); $xmlWriter->writeElement('w:t', $value); $xmlWriter->endElement(); // w:r $xmlWriter->endElement(); // w:sdtContent $xmlWriter->endElement(); // w:sdt $this->endElementP(); // w:p } /** * Write text. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_SdtText.html */ private function writePlainText(XMLWriter $xmlWriter): void { $xmlWriter->startElement('w:text'); $xmlWriter->endElement(); // w:text } /** * Write combo box. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_SdtComboBox.html */ private function writeComboBox(XMLWriter $xmlWriter, SDTElement $element): void { $type = $element->getType(); $listItems = $element->getListItems(); $xmlWriter->startElement("w:{$type}"); foreach ($listItems as $key => $val) { $xmlWriter->writeElementBlock('w:listItem', ['w:value' => $key, 'w:displayText' => $val]); } $xmlWriter->endElement(); // w:{$type} } /** * Write drop down list. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_SdtDropDownList.html */ private function writeDropDownList(XMLWriter $xmlWriter, SDTElement $element): void { $this->writeComboBox($xmlWriter, $element); } /** * Write date. * * @see http://www.datypic.com/sc/ooxml/t-w_CT_SdtDate.html */ private function writeDate(XMLWriter $xmlWriter, SDTElement $element): void { $type = $element->getType(); $xmlWriter->startElement("w:{$type}"); $xmlWriter->writeElementBlock('w:dateFormat', 'w:val', 'd/M/yyyy'); $xmlWriter->writeElementBlock('w:lid', 'w:val', 'en-US'); $xmlWriter->writeElementBlock('w:storeMappedDataAs', 'w:val', 'dateTime'); $xmlWriter->writeElementBlock('w:calendar', 'w:val', 'gregorian'); $xmlWriter->endElement(); // w:date } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Shape.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof ShapeElement) { return; } $style = $element->getStyle(); $styleWriter = new ShapeStyleWriter($xmlWriter, $style); $type = $element->getType(); if ($type == 'rect' && $style->getRoundness() !== null) { $type = 'roundrect'; } $method = "write{$type}"; if (!$this->withoutP) { $xmlWriter->startElement('w:p'); } $this->writeCommentRangeStart(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:pict'); $xmlWriter->startElement("v:{$type}"); // Element style if (method_exists($this, $method)) { $this->$method($xmlWriter, $style); } // Child style $styleWriter->write(); $xmlWriter->endElement(); // v:$type $xmlWriter->endElement(); // w:pict $xmlWriter->endElement(); // w:r $this->endElementP(); // w:p } /** * Write arc. */ private function writeArc(XMLWriter $xmlWriter, ShapeStyle $style): void { $points = $this->getPoints('arc', $style->getPoints()); $xmlWriter->writeAttributeIf($points['start'] !== null, 'startAngle', $points['start']); $xmlWriter->writeAttributeIf($points['end'] !== null, 'endAngle', $points['end']); } /** * Write curve. */ private function writeCurve(XMLWriter $xmlWriter, ShapeStyle $style): void { $points = $this->getPoints('curve', $style->getPoints()); $this->writeLine($xmlWriter, $style); $xmlWriter->writeAttributeIf($points['point1'] !== null, 'control1', $points['point1']); $xmlWriter->writeAttributeIf($points['point2'] !== null, 'control2', $points['point2']); } /** * Write line. */ private function writeLine(XMLWriter $xmlWriter, ShapeStyle $style): void { $points = $this->getPoints('line', $style->getPoints()); $xmlWriter->writeAttributeIf($points['start'] !== null, 'from', $points['start']); $xmlWriter->writeAttributeIf($points['end'] !== null, 'to', $points['end']); } /** * Write polyline. */ private function writePolyline(XMLWriter $xmlWriter, ShapeStyle $style): void { $xmlWriter->writeAttributeIf($style->getPoints() !== null, 'points', $style->getPoints()); } /** * Write rectangle. */ private function writeRoundRect(XMLWriter $xmlWriter, ShapeStyle $style): void { $xmlWriter->writeAttribute('arcsize', $style->getRoundness()); } /** * Set points. * * @param string $type * @param string $value * * @return array */ private function getPoints($type, $value) { $points = []; switch ($type) { case 'arc': case 'line': $points = explode(' ', $value); [$start, $end] = array_pad($points, 2, null); $points = ['start' => $start, 'end' => $end]; break; case 'curve': $points = explode(' ', $value); [$start, $end, $point1, $point2] = array_pad($points, 4, null); $points = ['start' => $start, 'end' => $end, 'point1' => $point1, 'point2' => $point2]; break; } return $points; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/TOC.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof TOCElement) { return; } $titles = $element->getTitles(); $writeFieldMark = true; foreach ($titles as $title) { $this->writeTitle($xmlWriter, $element, $title, $writeFieldMark); if ($writeFieldMark) { $writeFieldMark = false; } } $xmlWriter->startElement('w:p'); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->endElement(); } /** * Write title. */ private function writeTitle(XMLWriter $xmlWriter, TOCElement $element, Title $title, bool $writeFieldMark): void { $tocStyle = $element->getStyleTOC(); $fontStyle = $element->getStyleFont(); $isObject = ($fontStyle instanceof Font) ? true : false; $rId = $title->getRelationId(); $indent = (int) (($title->getDepth() - 1) * $tocStyle->getIndent()); $xmlWriter->startElement('w:p'); // Write style and field mark $this->writeStyle($xmlWriter, $element, $indent); if ($writeFieldMark) { $this->writeFieldMark($xmlWriter, $element); } // Hyperlink $xmlWriter->startElement('w:hyperlink'); $xmlWriter->writeAttribute('w:anchor', "_Toc{$rId}"); $xmlWriter->writeAttribute('w:history', '1'); // Title text $xmlWriter->startElement('w:r'); if ($isObject) { $styleWriter = new FontStyleWriter($xmlWriter, $fontStyle); $styleWriter->write(); } $xmlWriter->startElement('w:t'); $titleText = $title->getText(); $this->writeText(is_string($titleText) ? $titleText : ''); $xmlWriter->endElement(); // w:t $xmlWriter->endElement(); // w:r $xmlWriter->startElement('w:r'); $xmlWriter->writeElement('w:tab', null); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text("PAGEREF $rId \\h"); $xmlWriter->endElement(); $xmlWriter->endElement(); if ($title->getPageNumber() !== null) { $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'separate'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:t'); $xmlWriter->text((string) $title->getPageNumber()); $xmlWriter->endElement(); $xmlWriter->endElement(); } $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'end'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->endElement(); // w:hyperlink $xmlWriter->endElement(); // w:p } /** * Write style. */ private function writeStyle(XMLWriter $xmlWriter, TOCElement $element, int $indent): void { $tocStyle = $element->getStyleTOC(); $fontStyle = $element->getStyleFont(); $isObject = ($fontStyle instanceof Font) ? true : false; $xmlWriter->startElement('w:pPr'); // Paragraph if ($isObject && null !== $fontStyle->getParagraph()) { $styleWriter = new ParagraphStyleWriter($xmlWriter, $fontStyle->getParagraph()); $styleWriter->write(); } // Font if (!empty($fontStyle) && !$isObject) { $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:rStyle'); $xmlWriter->writeAttribute('w:val', $fontStyle); $xmlWriter->endElement(); $xmlWriter->endElement(); // w:rPr } // Tab $xmlWriter->startElement('w:tabs'); $styleWriter = new TabStyleWriter($xmlWriter, $tocStyle); $styleWriter->write(); $xmlWriter->endElement(); // Indent if ($indent > 0) { $xmlWriter->startElement('w:ind'); $xmlWriter->writeAttribute('w:left', $indent); $xmlWriter->endElement(); } $xmlWriter->endElement(); // w:pPr } /** * Write TOC Field. */ private function writeFieldMark(XMLWriter $xmlWriter, TOCElement $element): void { $minDepth = $element->getMinDepth(); $maxDepth = $element->getMaxDepth(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'begin'); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:instrText'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text("TOC \\o {$minDepth}-{$maxDepth} \\h \\z \\u"); $xmlWriter->endElement(); $xmlWriter->endElement(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:fldChar'); $xmlWriter->writeAttribute('w:fldCharType', 'separate'); $xmlWriter->endElement(); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Table.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof TableElement) { return; } $rows = $element->getRows(); $rowCount = count($rows); if ($rowCount > 0) { $xmlWriter->startElement('w:tbl'); // Write columns $this->writeColumns($xmlWriter, $element); // Write style $styleWriter = new TableStyleWriter($xmlWriter, $element->getStyle()); $styleWriter->setWidth($element->getWidth()); $styleWriter->write(); // Write rows for ($i = 0; $i < $rowCount; ++$i) { $this->writeRow($xmlWriter, $rows[$i]); } $xmlWriter->endElement(); // w:tbl } } /** * Write column. */ private function writeColumns(XMLWriter $xmlWriter, TableElement $element): void { $cellWidths = $element->findFirstDefinedCellWidths(); $xmlWriter->startElement('w:tblGrid'); foreach ($cellWidths as $width) { $xmlWriter->startElement('w:gridCol'); if ($width !== null) { $xmlWriter->writeAttribute('w:w', $width); $xmlWriter->writeAttribute('w:type', 'dxa'); } $xmlWriter->endElement(); } $xmlWriter->endElement(); // w:tblGrid } /** * Write row. */ private function writeRow(XMLWriter $xmlWriter, RowElement $row): void { $xmlWriter->startElement('w:tr'); // Write style $rowStyle = $row->getStyle(); if ($rowStyle instanceof RowStyle) { $styleWriter = new RowStyleWriter($xmlWriter, $rowStyle); $styleWriter->setHeight($row->getHeight()); $styleWriter->write(); } // Write cells $cells = $row->getCells(); if (count($cells) === 0) { // issue 2505 - Word treats doc as corrupt if row without cell $this->writeCell($xmlWriter, new CellElement()); } else { foreach ($cells as $cell) { $this->writeCell($xmlWriter, $cell); } } $xmlWriter->endElement(); // w:tr } /** * Write cell. */ private function writeCell(XMLWriter $xmlWriter, CellElement $cell): void { $xmlWriter->startElement('w:tc'); // Write style $cellStyle = $cell->getStyle(); if ($cellStyle instanceof CellStyle) { $styleWriter = new CellStyleWriter($xmlWriter, $cellStyle); $styleWriter->setWidth($cell->getWidth()); $styleWriter->write(); } // Write content $containerWriter = new Container($xmlWriter, $cell); $containerWriter->write(); $xmlWriter->endElement(); // w:tc } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/TableAlignment.php ================================================ attributes['w:val'] = $value; } /** * @since 0.13.0 * * @return string */ final public function getName() { return $this->name; } /** * @since 0.13.0 * * @return string[] */ final public function getAttributes() { return $this->attributes; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Text.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Text) { return; } $this->startElementP(); $this->writeOpeningTrackChange(); $xmlWriter->startElement('w:r'); $this->writeFontStyle(); $textElement = 'w:t'; //'w:delText' in case of deleted text $changed = $element->getTrackChange(); if ($changed != null && $changed->getChangeType() == TrackChange::DELETED) { $textElement = 'w:delText'; } $xmlWriter->startElement($textElement); $xmlWriter->writeAttribute('xml:space', 'preserve'); $this->writeText($this->getText($element->getText())); $xmlWriter->endElement(); $xmlWriter->endElement(); // w:r $this->writeClosingTrackChange(); $this->endElementP(); // w:p } /** * Write opening of changed element. */ protected function writeOpeningTrackChange(): void { $changed = $this->getElement()->getTrackChange(); if ($changed == null) { return; } $xmlWriter = $this->getXmlWriter(); if (($changed->getChangeType() == TrackChange::INSERTED)) { $xmlWriter->startElement('w:ins'); } elseif ($changed->getChangeType() == TrackChange::DELETED) { $xmlWriter->startElement('w:del'); } $xmlWriter->writeAttribute('w:author', $changed->getAuthor()); if ($changed->getDate() != null) { $xmlWriter->writeAttribute('w:date', $changed->getDate()->format('Y-m-d\TH:i:s\Z')); } $xmlWriter->writeAttribute('w:id', $this->getElement()->getElementId()); } /** * Write ending. */ protected function writeClosingTrackChange(): void { $changed = $this->getElement()->getTrackChange(); if ($changed == null) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->endElement(); // w:ins|w:del } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/TextBox.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\TextBox) { return; } $style = $element->getStyle(); $styleWriter = new TextBoxStyleWriter($xmlWriter, $style); if (!$this->withoutP) { $xmlWriter->startElement('w:p'); $styleWriter->writeAlignment(); } $this->writeCommentRangeStart(); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:pict'); $xmlWriter->startElement('v:shape'); $xmlWriter->writeAttribute('type', '#_x0000_t0202'); if ($style->getBgColor()) { $xmlWriter->writeAttribute('fillcolor', $style->getBgColor()); } else { $xmlWriter->writeAttribute('filled', 'f'); } if (!$style->getBorderColor()) { $xmlWriter->writeAttribute('stroked', 'f'); $xmlWriter->writeAttribute('strokecolor', 'white'); } $styleWriter->write(); $styleWriter->writeBorder(); $xmlWriter->startElement('v:textbox'); $styleWriter->writeInnerMargin(); // TextBox content, serving as a container $xmlWriter->startElement('w:txbxContent'); $containerWriter = new Container($xmlWriter, $element); $containerWriter->write(); $xmlWriter->endElement(); // w:txbxContent $xmlWriter->endElement(); // v: textbox $xmlWriter->endElement(); // v:shape $xmlWriter->endElement(); // w:pict $xmlWriter->endElement(); // w:r $this->endElementP(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/TextBreak.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\TextBreak) { return; } if (!$this->withoutP) { $hasStyle = $element->hasStyle(); $this->startElementP(); if ($hasStyle) { $xmlWriter->startElement('w:pPr'); $this->writeFontStyle(); $xmlWriter->endElement(); // w:pPr } $this->endElementP(); // w:p } else { $xmlWriter->writeElement('w:br'); } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/TextRun.php ================================================ getXmlWriter(); $element = $this->getElement(); $this->startElementP(); $containerWriter = new Container($xmlWriter, $element); $containerWriter->write(); $this->endElementP(); // w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Element/Title.php ================================================ getXmlWriter(); $element = $this->getElement(); if (!$element instanceof \PhpOffice\PhpWord\Element\Title) { return; } $style = $element->getStyle(); $xmlWriter->startElement('w:p'); if (!empty($style)) { $xmlWriter->startElement('w:pPr'); $xmlWriter->startElement('w:pStyle'); $xmlWriter->writeAttribute('w:val', $style); $xmlWriter->endElement(); $xmlWriter->endElement(); } $bookmarkRId = null; if ($element->getDepth() !== 0) { $rId = $element->getRelationId(); $bookmarkRId = $element->getPhpWord()->addBookmark(); // Bookmark start for TOC $xmlWriter->startElement('w:bookmarkStart'); $xmlWriter->writeAttribute('w:id', $bookmarkRId); $xmlWriter->writeAttribute('w:name', "_Toc{$rId}"); $xmlWriter->endElement(); //w:bookmarkStart } // Actual text $text = $element->getText(); if (is_string($text)) { $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:t'); $this->writeText($text); $xmlWriter->endElement(); // w:t $xmlWriter->endElement(); // w:r } if ($text instanceof \PhpOffice\PhpWord\Element\AbstractContainer) { $containerWriter = new Container($xmlWriter, $text); $containerWriter->write(); } if ($element->getDepth() !== 0) { // Bookmark end $xmlWriter->startElement('w:bookmarkEnd'); $xmlWriter->writeAttribute('w:id', $bookmarkRId); $xmlWriter->endElement(); //w:bookmarkEnd } $xmlWriter->endElement(); //w:p } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/AbstractPart.php ================================================ parentWriter = $writer; } /** * Get parent writer. * * @return AbstractWriter */ public function getParentWriter() { if (null !== $this->parentWriter) { return $this->parentWriter; } throw new Exception('No parent WriterInterface assigned.'); } /** * Get XML Writer. * * @return XMLWriter */ protected function getXmlWriter() { $useDiskCaching = false; if (null !== $this->parentWriter) { if ($this->parentWriter->isUseDiskCaching()) { $useDiskCaching = true; } } if ($useDiskCaching) { return new XMLWriter(XMLWriter::STORAGE_DISK, $this->parentWriter->getDiskCachingDirectory(), Settings::hasCompatibility()); } return new XMLWriter(XMLWriter::STORAGE_MEMORY, './', Settings::hasCompatibility()); } /** * Write an XML text, this will call text() or writeRaw() depending on the value of Settings::isOutputEscapingEnabled(). * * @param string $content The text string to write * * @return bool Returns true on success or false on failure */ protected function writeText($content) { if (Settings::isOutputEscapingEnabled()) { return $this->getXmlWriter()->text($content); } return $this->getXmlWriter()->writeRaw($content); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Chart.php ================================================ ['type' => 'pie', 'colors' => 1], 'doughnut' => ['type' => 'doughnut', 'colors' => 1, 'hole' => 75, 'no3d' => true], 'bar' => ['type' => 'bar', 'colors' => 0, 'axes' => true, 'bar' => 'bar', 'grouping' => 'clustered'], 'stacked_bar' => ['type' => 'bar', 'colors' => 0, 'axes' => true, 'bar' => 'bar', 'grouping' => 'stacked'], 'percent_stacked_bar' => ['type' => 'bar', 'colors' => 0, 'axes' => true, 'bar' => 'bar', 'grouping' => 'percentStacked'], 'column' => ['type' => 'bar', 'colors' => 0, 'axes' => true, 'bar' => 'col', 'grouping' => 'clustered'], 'stacked_column' => ['type' => 'bar', 'colors' => 0, 'axes' => true, 'bar' => 'col', 'grouping' => 'stacked'], 'percent_stacked_column' => ['type' => 'bar', 'colors' => 0, 'axes' => true, 'bar' => 'col', 'grouping' => 'percentStacked'], 'line' => ['type' => 'line', 'colors' => 0, 'axes' => true], 'area' => ['type' => 'area', 'colors' => 0, 'axes' => true], 'radar' => ['type' => 'radar', 'colors' => 0, 'axes' => true, 'radar' => 'standard', 'no3d' => true], 'scatter' => ['type' => 'scatter', 'colors' => 0, 'axes' => true, 'scatter' => 'marker', 'no3d' => true], ]; /** * Chart options. * * @var array */ private $options = []; /** * Set chart element. */ public function setElement(ChartElement $element): void { $this->element = $element; } /** * Write part. * * @return string */ public function write() { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('c:chartSpace'); $xmlWriter->writeAttribute('xmlns:c', 'http://schemas.openxmlformats.org/drawingml/2006/chart'); $xmlWriter->writeAttribute('xmlns:a', 'http://schemas.openxmlformats.org/drawingml/2006/main'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $this->writeChart($xmlWriter); $this->writeShape($xmlWriter); $xmlWriter->endElement(); // c:chartSpace return $xmlWriter->getData(); } /** * Write chart. * * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_Chart.html */ private function writeChart(XMLWriter $xmlWriter): void { $xmlWriter->startElement('c:chart'); $this->writePlotArea($xmlWriter); $xmlWriter->endElement(); // c:chart } /** * Write plot area. * * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_PlotArea.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_PieChart.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_DoughnutChart.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_BarChart.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_LineChart.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_AreaChart.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_RadarChart.html * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_ScatterChart.html */ private function writePlotArea(XMLWriter $xmlWriter): void { $type = $this->element->getType(); $style = $this->element->getStyle(); $this->options = $this->types[$type]; $title = $style->getTitle(); $showLegend = $style->isShowLegend(); $legendPosition = $style->getLegendPosition(); //Chart title if ($title) { $xmlWriter->startElement('c:title'); $xmlWriter->startElement('c:tx'); $xmlWriter->startElement('c:rich'); $xmlWriter->writeRaw(' ' . $title . ' '); $xmlWriter->endElement(); // c:rich $xmlWriter->endElement(); // c:tx $xmlWriter->endElement(); // c:title } else { $xmlWriter->writeElementBlock('c:autoTitleDeleted', 'val', 1); } //Chart legend if ($showLegend) { $xmlWriter->writeRaw(''); } $xmlWriter->startElement('c:plotArea'); $xmlWriter->writeElement('c:layout'); // Chart $chartType = $this->options['type']; $chartType .= $style->is3d() && !isset($this->options['no3d']) ? '3D' : ''; $chartType .= 'Chart'; $xmlWriter->startElement("c:{$chartType}"); $xmlWriter->writeElementBlock('c:varyColors', 'val', $this->options['colors']); if ($type == 'area') { $xmlWriter->writeElementBlock('c:grouping', 'val', 'standard'); } if (isset($this->options['hole'])) { $xmlWriter->writeElementBlock('c:holeSize', 'val', $this->options['hole']); } if (isset($this->options['bar'])) { $xmlWriter->writeElementBlock('c:barDir', 'val', $this->options['bar']); // bar|col $xmlWriter->writeElementBlock('c:grouping', 'val', $this->options['grouping']); // 3d; standard = percentStacked } if (isset($this->options['radar'])) { $xmlWriter->writeElementBlock('c:radarStyle', 'val', $this->options['radar']); } if (isset($this->options['scatter'])) { $xmlWriter->writeElementBlock('c:scatterStyle', 'val', $this->options['scatter']); } // Series $this->writeSeries($xmlWriter, isset($this->options['scatter'])); // don't overlap if grouping is 'clustered' if (!isset($this->options['grouping']) || $this->options['grouping'] != 'clustered') { $xmlWriter->writeElementBlock('c:overlap', 'val', '100'); } // Axes if (isset($this->options['axes'])) { $xmlWriter->writeElementBlock('c:axId', 'val', 1); $xmlWriter->writeElementBlock('c:axId', 'val', 2); } $xmlWriter->endElement(); // chart type // Axes if (isset($this->options['axes'])) { $this->writeAxis($xmlWriter, 'cat'); $this->writeAxis($xmlWriter, 'val'); } $xmlWriter->endElement(); // c:plotArea } /** * Write series. * * @param bool $scatter */ private function writeSeries(XMLWriter $xmlWriter, $scatter = false): void { $series = $this->element->getSeries(); $style = $this->element->getStyle(); $colors = $style->getColors(); $index = 0; $colorIndex = 0; foreach ($series as $seriesItem) { $categories = $seriesItem['categories']; $values = $seriesItem['values']; $xmlWriter->startElement('c:ser'); $xmlWriter->writeElementBlock('c:idx', 'val', $index); $xmlWriter->writeElementBlock('c:order', 'val', $index); if (null !== $seriesItem['name'] && $seriesItem['name'] != '') { $xmlWriter->startElement('c:tx'); $xmlWriter->startElement('c:strRef'); $xmlWriter->startElement('c:strCache'); $xmlWriter->writeElementBlock('c:ptCount', 'val', 1); $xmlWriter->startElement('c:pt'); $xmlWriter->writeAttribute('idx', 0); $xmlWriter->startElement('c:v'); $xmlWriter->writeRaw($seriesItem['name']); $xmlWriter->endElement(); // c:v $xmlWriter->endElement(); // c:pt $xmlWriter->endElement(); // c:strCache $xmlWriter->endElement(); // c:strRef $xmlWriter->endElement(); // c:tx } // The c:dLbls was added to make word charts look more like the reports in SurveyGizmo // This section needs to be made configurable before a pull request is made $xmlWriter->startElement('c:dLbls'); foreach ($style->getDataLabelOptions() as $option => $val) { $xmlWriter->writeElementBlock("c:{$option}", 'val', (int) $val); } $xmlWriter->endElement(); // c:dLbls if (isset($this->options['scatter'])) { $this->writeShape($xmlWriter); } if ($scatter === true) { $this->writeSeriesItem($xmlWriter, 'xVal', $categories); $this->writeSeriesItem($xmlWriter, 'yVal', $values); } else { $this->writeSeriesItem($xmlWriter, 'cat', $categories); $this->writeSeriesItem($xmlWriter, 'val', $values); // check that there are colors if (is_array($colors) && count($colors) > 0) { // assign a color to each value $valueIndex = 0; for ($i = 0; $i < count($values); ++$i) { // check that there are still enought colors $xmlWriter->startElement('c:dPt'); $xmlWriter->writeElementBlock('c:idx', 'val', $valueIndex); $xmlWriter->startElement('c:spPr'); $xmlWriter->startElement('a:solidFill'); $xmlWriter->writeElementBlock('a:srgbClr', 'val', $colors[$colorIndex++ % count($colors)]); $xmlWriter->endElement(); // a:solidFill $xmlWriter->endElement(); // c:spPr $xmlWriter->endElement(); // c:dPt ++$valueIndex; } } } $xmlWriter->endElement(); // c:ser ++$index; } } /** * Write series items. * * @param string $type * @param array $values */ private function writeSeriesItem(XMLWriter $xmlWriter, $type, $values): void { $types = [ 'cat' => ['c:cat', 'c:strLit'], 'val' => ['c:val', 'c:numLit'], 'xVal' => ['c:xVal', 'c:strLit'], 'yVal' => ['c:yVal', 'c:numLit'], ]; [$itemType, $itemLit] = $types[$type]; $xmlWriter->startElement($itemType); $xmlWriter->startElement($itemLit); $xmlWriter->writeElementBlock('c:ptCount', 'val', count($values)); $index = 0; foreach ($values as $value) { $xmlWriter->startElement('c:pt'); $xmlWriter->writeAttribute('idx', $index); if (\PhpOffice\PhpWord\Settings::isOutputEscapingEnabled()) { $xmlWriter->writeElement('c:v', $value); } else { $xmlWriter->startElement('c:v'); $xmlWriter->writeRaw($value); $xmlWriter->endElement(); // c:v } $xmlWriter->endElement(); // c:pt ++$index; } $xmlWriter->endElement(); // $itemLit $xmlWriter->endElement(); // $itemType } /** * Write axis. * * @see http://www.datypic.com/sc/ooxml/t-draw-chart_CT_CatAx.html * * @param string $type */ private function writeAxis(XMLWriter $xmlWriter, $type): void { $style = $this->element->getStyle(); $types = [ 'cat' => ['c:catAx', 1, 'b', 2], 'val' => ['c:valAx', 2, 'l', 1], ]; [$axisType, $axisId, $axisPos, $axisCross] = $types[$type]; $xmlWriter->startElement($axisType); $xmlWriter->writeElementBlock('c:axId', 'val', $axisId); $xmlWriter->writeElementBlock('c:axPos', 'val', $axisPos); $categoryAxisTitle = $style->getCategoryAxisTitle(); $valueAxisTitle = $style->getValueAxisTitle(); if ($axisType == 'c:catAx') { if (null !== $categoryAxisTitle) { $this->writeAxisTitle($xmlWriter, $categoryAxisTitle); } } elseif ($axisType == 'c:valAx') { if (null !== $valueAxisTitle) { $this->writeAxisTitle($xmlWriter, $valueAxisTitle); } } $xmlWriter->writeElementBlock('c:crossAx', 'val', $axisCross); $xmlWriter->writeElementBlock('c:auto', 'val', 1); if (isset($this->options['axes'])) { $xmlWriter->writeElementBlock('c:delete', 'val', 0); $xmlWriter->writeElementBlock('c:majorTickMark', 'val', $style->getMajorTickPosition()); $xmlWriter->writeElementBlock('c:minorTickMark', 'val', 'none'); if ($style->showAxisLabels()) { if ($axisType == 'c:catAx') { $xmlWriter->writeElementBlock('c:tickLblPos', 'val', $style->getCategoryLabelPosition()); } else { $xmlWriter->writeElementBlock('c:tickLblPos', 'val', $style->getValueLabelPosition()); } } else { $xmlWriter->writeElementBlock('c:tickLblPos', 'val', 'none'); } $xmlWriter->writeElementBlock('c:crosses', 'val', 'autoZero'); } if (isset($this->options['radar']) || ($type == 'cat' && $style->showGridX()) || ($type == 'val' && $style->showGridY())) { $xmlWriter->writeElement('c:majorGridlines'); } $xmlWriter->startElement('c:scaling'); $xmlWriter->writeElementBlock('c:orientation', 'val', 'minMax'); $xmlWriter->endElement(); // c:scaling $this->writeShape($xmlWriter, true); $xmlWriter->endElement(); // $axisType } /** * Write shape. * * @see http://www.datypic.com/sc/ooxml/t-a_CT_ShapeProperties.html * * @param bool $line */ private function writeShape(XMLWriter $xmlWriter, $line = false): void { $xmlWriter->startElement('c:spPr'); $xmlWriter->startElement('a:ln'); if ($line === true) { $xmlWriter->writeElement('a:solidFill'); } else { $xmlWriter->writeElement('a:noFill'); } $xmlWriter->endElement(); // a:ln $xmlWriter->endElement(); // c:spPr } private function writeAxisTitle(XMLWriter $xmlWriter, $title): void { $xmlWriter->startElement('c:title'); //start c:title $xmlWriter->startElement('c:tx'); //start c:tx $xmlWriter->startElement('c:rich'); // start c:rich $xmlWriter->writeElement('a:bodyPr'); $xmlWriter->writeElement('a:lstStyle'); $xmlWriter->startElement('a:p'); $xmlWriter->startElement('a:pPr'); $xmlWriter->writeElement('a:defRPr'); $xmlWriter->endElement(); // end a:pPr $xmlWriter->startElement('a:r'); $xmlWriter->writeElementBlock('a:rPr', 'lang', 'en-US'); $xmlWriter->startElement('a:t'); $xmlWriter->writeRaw($title); $xmlWriter->endElement(); //end a:t $xmlWriter->endElement(); // end a:r $xmlWriter->endElement(); //end a:p $xmlWriter->endElement(); //end c:rich $xmlWriter->endElement(); // end c:tx $xmlWriter->writeElementBlock('c:overlay', 'val', '0'); $xmlWriter->endElement(); // end c:title } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Comments.php ================================================ getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('w:comments'); $xmlWriter->writeAttribute('xmlns:ve', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); $xmlWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); $xmlWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml'); $xmlWriter->writeAttribute('xmlns:wp', 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'); $xmlWriter->writeAttribute('xmlns:w10', 'urn:schemas-microsoft-com:office:word'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); $xmlWriter->writeAttribute('xmlns:wne', 'http://schemas.microsoft.com/office/word/2006/wordml'); if ($this->elements !== null) { foreach ($this->elements as $element) { if ($element instanceof Comment) { $this->writeComment($xmlWriter, $element); } } } $xmlWriter->endElement(); // w:comments return $xmlWriter->getData(); } /** * Write comment item. */ protected function writeComment(XMLWriter $xmlWriter, Comment $comment): void { $xmlWriter->startElement('w:comment'); $xmlWriter->writeAttribute('w:id', $comment->getElementId()); $xmlWriter->writeAttribute('w:author', $comment->getAuthor()); if ($comment->getDate() != null) { $xmlWriter->writeAttribute('w:date', $comment->getDate()->format($this->dateFormat)); } $xmlWriter->writeAttributeIf($comment->getInitials() != null, 'w:initials', $comment->getInitials()); $containerWriter = new Container($xmlWriter, $comment); $containerWriter->write(); $xmlWriter->endElement(); // w:comment } /** * Set element. * * @param Comment[] $elements * * @return self */ public function setElements($elements) { $this->elements = $elements; return $this; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/ContentTypes.php ================================================ getParentWriter(); $contentTypes = $parentWriter->getContentTypes(); $openXMLPrefix = 'application/vnd.openxmlformats-'; $wordMLPrefix = $openXMLPrefix . 'officedocument.wordprocessingml.'; $drawingMLPrefix = $openXMLPrefix . 'officedocument.drawingml.'; $overrides = [ '/docProps/core.xml' => $openXMLPrefix . 'package.core-properties+xml', '/docProps/app.xml' => $openXMLPrefix . 'officedocument.extended-properties+xml', '/docProps/custom.xml' => $openXMLPrefix . 'officedocument.custom-properties+xml', '/word/document.xml' => $wordMLPrefix . 'document.main+xml', '/word/styles.xml' => $wordMLPrefix . 'styles+xml', '/word/numbering.xml' => $wordMLPrefix . 'numbering+xml', '/word/settings.xml' => $wordMLPrefix . 'settings+xml', '/word/theme/theme1.xml' => $openXMLPrefix . 'officedocument.theme+xml', '/word/webSettings.xml' => $wordMLPrefix . 'webSettings+xml', '/word/fontTable.xml' => $wordMLPrefix . 'fontTable+xml', '/word/comments.xml' => $wordMLPrefix . 'comments+xml', ]; $defaults = $contentTypes['default']; if (!empty($contentTypes['override'])) { foreach ($contentTypes['override'] as $key => $val) { if ($val == 'chart') { $overrides[$key] = $drawingMLPrefix . $val . '+xml'; } else { $overrides[$key] = $wordMLPrefix . $val . '+xml'; } } } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('Types'); $xmlWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/content-types'); $this->writeContentType($xmlWriter, $defaults, true); $this->writeContentType($xmlWriter, $overrides, false); $xmlWriter->endElement(); // Types return $xmlWriter->getData(); } /** * Write content types element. * * @param XMLWriter $xmlWriter XML Writer * @param array $parts * @param bool $isDefault */ private function writeContentType(XMLWriter $xmlWriter, $parts, $isDefault): void { foreach ($parts as $partName => $contentType) { $partType = $isDefault ? 'Default' : 'Override'; $partAttribute = $isDefault ? 'Extension' : 'PartName'; $xmlWriter->startElement($partType); $xmlWriter->writeAttribute($partAttribute, $partName); $xmlWriter->writeAttribute('ContentType', $contentType); $xmlWriter->endElement(); } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/DocPropsApp.php ================================================ getParentWriter()->getPhpWord(); $xmlWriter = $this->getXmlWriter(); $schema = 'http://schemas.openxmlformats.org/officeDocument/2006/extended-properties'; $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('Properties'); $xmlWriter->writeAttribute('xmlns', $schema); $xmlWriter->writeAttribute('xmlns:vt', 'http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes'); $xmlWriter->writeElement('Application', 'PHPWord'); $xmlWriter->writeElement('Company', $phpWord->getDocInfo()->getCompany()); $xmlWriter->writeElement('Manager', $phpWord->getDocInfo()->getManager()); $xmlWriter->endElement(); // Properties return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/DocPropsCore.php ================================================ getParentWriter()->getPhpWord(); $xmlWriter = $this->getXmlWriter(); $schema = 'http://schemas.openxmlformats.org/package/2006/metadata/core-properties'; $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('cp:coreProperties'); $xmlWriter->writeAttribute('xmlns:cp', $schema); $xmlWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/'); $xmlWriter->writeAttribute('xmlns:dcterms', 'http://purl.org/dc/terms/'); $xmlWriter->writeAttribute('xmlns:dcmitype', 'http://purl.org/dc/dcmitype/'); $xmlWriter->writeAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance'); $xmlWriter->writeElement('dc:creator', $phpWord->getDocInfo()->getCreator()); $xmlWriter->writeElement('dc:title', $phpWord->getDocInfo()->getTitle()); $xmlWriter->writeElement('dc:description', $phpWord->getDocInfo()->getDescription()); $xmlWriter->writeElement('dc:subject', $phpWord->getDocInfo()->getSubject()); $xmlWriter->writeElement('cp:keywords', $phpWord->getDocInfo()->getKeywords()); $xmlWriter->writeElement('cp:category', $phpWord->getDocInfo()->getCategory()); $xmlWriter->writeElement('cp:lastModifiedBy', $phpWord->getDocInfo()->getLastModifiedBy()); // dcterms:created $xmlWriter->startElement('dcterms:created'); $xmlWriter->writeAttribute('xsi:type', 'dcterms:W3CDTF'); $xmlWriter->text(date($this->dateFormat, $phpWord->getDocInfo()->getCreated())); $xmlWriter->endElement(); // dcterms:modified $xmlWriter->startElement('dcterms:modified'); $xmlWriter->writeAttribute('xsi:type', 'dcterms:W3CDTF'); $xmlWriter->text(date($this->dateFormat, $phpWord->getDocInfo()->getModified())); $xmlWriter->endElement(); $xmlWriter->endElement(); // cp:coreProperties return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/DocPropsCustom.php ================================================ getParentWriter()->getPhpWord(); $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('Properties'); $xmlWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/officeDocument/2006/custom-properties'); $xmlWriter->writeAttribute('xmlns:vt', 'http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes'); $docProps = $phpWord->getDocInfo(); $properties = $docProps->getCustomProperties(); foreach ($properties as $key => $property) { $propertyValue = $docProps->getCustomPropertyValue($property); $propertyType = $docProps->getCustomPropertyType($property); $xmlWriter->startElement('property'); $xmlWriter->writeAttribute('fmtid', '{D5CDD505-2E9C-101B-9397-08002B2CF9AE}'); $xmlWriter->writeAttribute('pid', $key + 2); $xmlWriter->writeAttribute('name', $property); switch ($propertyType) { case 'i': $xmlWriter->writeElement('vt:i4', $propertyValue); break; case 'f': $xmlWriter->writeElement('vt:r8', $propertyValue); break; case 'b': $xmlWriter->writeElement('vt:bool', ($propertyValue) ? 'true' : 'false'); break; case 'd': if ($propertyValue instanceof DateTime) { $xmlWriter->writeElement('vt:filetime', $propertyValue->format($this->dateFormat)); } else { $xmlWriter->writeElement('vt:filetime', date($this->dateFormat, $propertyValue)); } break; default: $xmlWriter->writeElement('vt:lpwstr', $propertyValue); break; } $xmlWriter->endElement(); // property } $xmlWriter->endElement(); // Properties return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Document.php ================================================ getParentWriter()->getPhpWord(); $xmlWriter = $this->getXmlWriter(); $sections = $phpWord->getSections(); $sectionCount = count($sections); $currentSection = 0; $drawingSchema = 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'; $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('w:document'); $xmlWriter->writeAttribute('xmlns:ve', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); $xmlWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); $xmlWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml'); $xmlWriter->writeAttribute('xmlns:wp', $drawingSchema); $xmlWriter->writeAttribute('xmlns:w10', 'urn:schemas-microsoft-com:office:word'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); $xmlWriter->writeAttribute('xmlns:wne', 'http://schemas.microsoft.com/office/word/2006/wordml'); $xmlWriter->startElement('w:body'); if ($sectionCount > 0) { foreach ($sections as $section) { ++$currentSection; $containerWriter = new Container($xmlWriter, $section); $containerWriter->write(); if ($currentSection == $sectionCount) { $this->writeSectionSettings($xmlWriter, $section); } else { $this->writeSection($xmlWriter, $section); } } } $xmlWriter->endElement(); // w:body $xmlWriter->endElement(); // w:document return $xmlWriter->getData(); } /** * Write begin section. */ private function writeSection(XMLWriter $xmlWriter, Section $section): void { $xmlWriter->startElement('w:p'); $xmlWriter->startElement('w:pPr'); $this->writeSectionSettings($xmlWriter, $section); $xmlWriter->endElement(); $xmlWriter->endElement(); } /** * Write end section. */ private function writeSectionSettings(XMLWriter $xmlWriter, Section $section): void { $xmlWriter->startElement('w:sectPr'); // Header reference foreach ($section->getHeaders() as $header) { $rId = $header->getRelationId(); $xmlWriter->startElement('w:headerReference'); $xmlWriter->writeAttribute('w:type', $header->getType()); $xmlWriter->writeAttribute('r:id', 'rId' . $rId); $xmlWriter->endElement(); } // Footer reference foreach ($section->getFooters() as $footer) { $rId = $footer->getRelationId(); $xmlWriter->startElement('w:footerReference'); $xmlWriter->writeAttribute('w:type', $footer->getType()); $xmlWriter->writeAttribute('r:id', 'rId' . $rId); $xmlWriter->endElement(); } // Different first page if ($section->hasDifferentFirstPage()) { $xmlWriter->startElement('w:titlePg'); $xmlWriter->endElement(); } // Footnote properties if ($section->getFootnoteProperties() !== null) { $xmlWriter->startElement('w:footnotePr'); if ($section->getFootnoteProperties()->getPos() != null) { $xmlWriter->startElement('w:pos'); $xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getPos()); $xmlWriter->endElement(); } if ($section->getFootnoteProperties()->getNumFmt() != null) { $xmlWriter->startElement('w:numFmt'); $xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getNumFmt()); $xmlWriter->endElement(); } if ($section->getFootnoteProperties()->getNumStart() != null) { $xmlWriter->startElement('w:numStart'); $xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getNumStart()); $xmlWriter->endElement(); } if ($section->getFootnoteProperties()->getNumRestart() != null) { $xmlWriter->startElement('w:numRestart'); $xmlWriter->writeAttribute('w:val', $section->getFootnoteProperties()->getNumRestart()); $xmlWriter->endElement(); } $xmlWriter->endElement(); } // Section settings $styleWriter = new SectionStyleWriter($xmlWriter, $section->getStyle()); $styleWriter->write(); $xmlWriter->endElement(); // w:sectPr } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Endnotes.php ================================================ '; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Footer.php ================================================ getXmlWriter(); $drawingSchema = 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'; $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement($this->rootElement); $xmlWriter->writeAttribute('xmlns:ve', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); $xmlWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); $xmlWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml'); $xmlWriter->writeAttribute('xmlns:wp', $drawingSchema); $xmlWriter->writeAttribute('xmlns:w10', 'urn:schemas-microsoft-com:office:word'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); $xmlWriter->writeAttribute('xmlns:wne', 'http://schemas.microsoft.com/office/word/2006/wordml'); $containerWriter = new Container($xmlWriter, $this->element); $containerWriter->write(); $xmlWriter->endElement(); // $this->rootElement return $xmlWriter->getData(); } /** * Set element. * * @param \PhpOffice\PhpWord\Element\Footer|\PhpOffice\PhpWord\Element\Header $element * * @return self */ public function setElement($element) { $this->element = $element; return $this; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Footnotes.php ================================================ getXmlWriter(); $drawingSchema = 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'; $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement($this->rootNode); $xmlWriter->writeAttribute('xmlns:ve', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); $xmlWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); $xmlWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml'); $xmlWriter->writeAttribute('xmlns:wp', $drawingSchema); $xmlWriter->writeAttribute('xmlns:w10', 'urn:schemas-microsoft-com:office:word'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); $xmlWriter->writeAttribute('xmlns:wne', 'http://schemas.microsoft.com/office/word/2006/wordml'); // Separator and continuation separator $xmlWriter->startElement($this->elementNode); $xmlWriter->writeAttribute('w:id', -1); $xmlWriter->writeAttribute('w:type', 'separator'); $xmlWriter->startElement('w:p'); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:separator'); $xmlWriter->endElement(); // w:separator $xmlWriter->endElement(); // w:r $xmlWriter->endElement(); // w:p $xmlWriter->endElement(); // $this->elementNode $xmlWriter->startElement($this->elementNode); $xmlWriter->writeAttribute('w:id', 0); $xmlWriter->writeAttribute('w:type', 'continuationSeparator'); $xmlWriter->startElement('w:p'); $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:continuationSeparator'); $xmlWriter->endElement(); // w:continuationSeparator $xmlWriter->endElement(); // w:r $xmlWriter->endElement(); // w:p $xmlWriter->endElement(); // $this->elementNode /** @var array $elements Type hint */ $elements = $this->elements; foreach ($elements as $element) { if ($element instanceof Footnote) { $this->writeNote($xmlWriter, $element); } } $xmlWriter->endElement(); // $this->rootNode return $xmlWriter->getData(); } /** * Set element. * * @param \PhpOffice\PhpWord\Collection\Endnotes|\PhpOffice\PhpWord\Collection\Footnotes $elements * * @return self */ public function setElements($elements) { $this->elements = $elements; return $this; } /** * Write note item. * * @param Footnote|\PhpOffice\PhpWord\Element\Endnote $element */ protected function writeNote(XMLWriter $xmlWriter, $element): void { $xmlWriter->startElement($this->elementNode); $xmlWriter->writeAttribute('w:id', $element->getRelationId() + 1); $xmlWriter->startElement('w:p'); // Paragraph style $styleWriter = new ParagraphStyleWriter($xmlWriter, $element->getParagraphStyle()); $styleWriter->setIsInline(true); $styleWriter->write(); // Reference symbol $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:rStyle'); $xmlWriter->writeAttribute('w:val', $this->refStyle); $xmlWriter->endElement(); // w:rStyle $xmlWriter->endElement(); // w:rPr $xmlWriter->writeElement($this->refNode); $xmlWriter->endElement(); // w:r // Empty space after refence symbol $xmlWriter->startElement('w:r'); $xmlWriter->startElement('w:t'); $xmlWriter->writeAttribute('xml:space', 'preserve'); $xmlWriter->text(' '); $xmlWriter->endElement(); // w:t $xmlWriter->endElement(); // w:r $containerWriter = new Container($xmlWriter, $element); $containerWriter->write(); $xmlWriter->endElement(); // w:p $xmlWriter->endElement(); // $this->elementNode } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Header.php ================================================ getXmlWriter(); $styles = Style::getStyles(); $drawingSchema = 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'; $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('w:numbering'); $xmlWriter->writeAttribute('xmlns:ve', 'http://schemas.openxmlformats.org/markup-compatibility/2006'); $xmlWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); $xmlWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml'); $xmlWriter->writeAttribute('xmlns:wp', $drawingSchema); $xmlWriter->writeAttribute('xmlns:w10', 'urn:schemas-microsoft-com:office:word'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); $xmlWriter->writeAttribute('xmlns:wne', 'http://schemas.microsoft.com/office/word/2006/wordml'); // Abstract numbering definitions foreach ($styles as $style) { if ($style instanceof NumberingStyle) { $levels = $style->getLevels(); $xmlWriter->startElement('w:abstractNum'); $xmlWriter->writeAttribute('w:abstractNumId', $style->getIndex()); $xmlWriter->startElement('w:nsid'); $xmlWriter->writeAttribute('w:val', $this->getRandomHexNumber()); $xmlWriter->endElement(); // w:nsid $xmlWriter->startElement('w:multiLevelType'); $xmlWriter->writeAttribute('w:val', $style->getType()); $xmlWriter->endElement(); // w:multiLevelType foreach ($levels as $level) { $this->writeLevel($xmlWriter, $level); } $xmlWriter->endElement(); // w:abstractNum } } // Numbering definition instances foreach ($styles as $style) { if ($style instanceof NumberingStyle) { $xmlWriter->startElement('w:num'); $xmlWriter->writeAttribute('w:numId', $style->getIndex()); $xmlWriter->startElement('w:abstractNumId'); $xmlWriter->writeAttribute('w:val', $style->getIndex()); $xmlWriter->endElement(); // w:abstractNumId $xmlWriter->endElement(); // w:num } } $xmlWriter->endElement(); // w:numbering return $xmlWriter->getData(); } /** * Write level. */ private function writeLevel(XMLWriter $xmlWriter, NumberingLevel $level): void { $xmlWriter->startElement('w:lvl'); $xmlWriter->writeAttribute('w:ilvl', $level->getLevel()); // Numbering level properties $properties = [ 'start' => 'start', 'format' => 'numFmt', 'restart' => 'lvlRestart', 'pStyle' => 'pStyle', 'suffix' => 'suff', 'text' => 'lvlText', 'alignment' => 'lvlJc', ]; foreach ($properties as $property => $nodeName) { $getMethod = "get{$property}"; if ('' !== $level->$getMethod() // this condition is now supported by `alignment` only && null !== $level->$getMethod()) { $xmlWriter->startElement("w:{$nodeName}"); $xmlWriter->writeAttribute('w:val', $level->$getMethod()); $xmlWriter->endElement(); // w:start } } // Paragraph & font styles $this->writeParagraph($xmlWriter, $level); $this->writeFont($xmlWriter, $level); $xmlWriter->endElement(); // w:lvl } /** * Write level paragraph. * * @since 0.11.0 * * @todo Use paragraph style writer */ private function writeParagraph(XMLWriter $xmlWriter, NumberingLevel $level): void { $tabPos = $level->getTabPos(); $left = $level->getLeft(); $hanging = $level->getHanging(); $xmlWriter->startElement('w:pPr'); $xmlWriter->startElement('w:tabs'); $xmlWriter->startElement('w:tab'); $xmlWriter->writeAttribute('w:val', 'num'); $xmlWriter->writeAttributeIf($tabPos !== null, 'w:pos', $tabPos); $xmlWriter->endElement(); // w:tab $xmlWriter->endElement(); // w:tabs $xmlWriter->startElement('w:ind'); $xmlWriter->writeAttributeIf($left !== null, 'w:left', $left); $xmlWriter->writeAttributeIf($hanging !== null, 'w:hanging', $hanging); $xmlWriter->endElement(); // w:ind $xmlWriter->endElement(); // w:pPr } /** * Write level font. * * @since 0.11.0 * * @todo Use font style writer */ private function writeFont(XMLWriter $xmlWriter, NumberingLevel $level): void { $font = $level->getFont(); $hint = $level->getHint(); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:rFonts'); $xmlWriter->writeAttributeIf($font !== null, 'w:ascii', $font); $xmlWriter->writeAttributeIf($font !== null, 'w:hAnsi', $font); $xmlWriter->writeAttributeIf($font !== null, 'w:cs', $font); $xmlWriter->writeAttributeIf($hint !== null, 'w:hint', $hint); $xmlWriter->endElement(); // w:rFonts $xmlWriter->endElement(); // w:rPr } /** * Get random hexadecimal number value. * * @param int $length * * @return string */ private function getRandomHexNumber($length = 8) { return strtoupper((string) substr(md5((string) mt_rand()), 0, $length)); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Rels.php ================================================ 'package/2006/relationships/metadata/core-properties', 'docProps/app.xml' => 'officeDocument/2006/relationships/extended-properties', 'docProps/custom.xml' => 'officeDocument/2006/relationships/custom-properties', 'word/document.xml' => 'officeDocument/2006/relationships/officeDocument', ]; $xmlWriter = $this->getXmlWriter(); $this->writeRels($xmlWriter, $xmlRels); return $xmlWriter->getData(); } /** * Write relationships. * * @param array $xmlRels * @param array $mediaRels * @param int $relId */ protected function writeRels(XMLWriter $xmlWriter, $xmlRels = [], $mediaRels = [], $relId = 1): void { $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('Relationships'); $xmlWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/relationships'); // XML files relationships foreach ($xmlRels as $target => $type) { $this->writeRel($xmlWriter, $relId++, $type, $target); } // Media relationships foreach ($mediaRels as $mediaRel) { $this->writeMediaRel($xmlWriter, $relId++, $mediaRel); } $xmlWriter->endElement(); // Relationships } /** * Write media relationships. * * @param int $relId * @param array $mediaRel */ private function writeMediaRel(XMLWriter $xmlWriter, $relId, $mediaRel): void { $typePrefix = 'officeDocument/2006/relationships/'; $typeMapping = ['image' => 'image', 'object' => 'oleObject', 'link' => 'hyperlink']; $targetMapping = ['image' => 'media/', 'object' => 'embeddings/']; $mediaType = $mediaRel['type']; $type = $typeMapping[$mediaType] ?? $mediaType; $targetPrefix = $targetMapping[$mediaType] ?? ''; $target = $mediaRel['target']; $targetMode = ($type == 'hyperlink') ? 'External' : ''; $this->writeRel($xmlWriter, $relId, $typePrefix . $type, $targetPrefix . $target, $targetMode); } /** * Write individual rels entry. * * Format: * * * @param int $relId Relationship ID * @param string $type Relationship type * @param string $target Relationship target * @param string $targetMode Relationship target mode */ private function writeRel(XMLWriter $xmlWriter, $relId, $type, $target, $targetMode = ''): void { if ($type != '' && $target != '') { if (strpos($relId, 'rId') === false) { $relId = 'rId' . $relId; } $xmlWriter->startElement('Relationship'); $xmlWriter->writeAttribute('Id', $relId); $xmlWriter->writeAttribute('Type', 'http://schemas.openxmlformats.org/' . $type); $xmlWriter->writeAttribute('Target', $target); if ($targetMode != '') { $xmlWriter->writeAttribute('TargetMode', $targetMode); } $xmlWriter->endElement(); } else { throw new Exception('Invalid parameters passed.'); } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/RelsDocument.php ================================================ 'officeDocument/2006/relationships/styles', 'numbering.xml' => 'officeDocument/2006/relationships/numbering', 'settings.xml' => 'officeDocument/2006/relationships/settings', 'theme/theme1.xml' => 'officeDocument/2006/relationships/theme', 'webSettings.xml' => 'officeDocument/2006/relationships/webSettings', 'fontTable.xml' => 'officeDocument/2006/relationships/fontTable', ]; $xmlWriter = $this->getXmlWriter(); /** @var \PhpOffice\PhpWord\Writer\Word2007 $parentWriter Type hint */ $parentWriter = $this->getParentWriter(); $this->writeRels($xmlWriter, $xmlRels, $parentWriter->getRelationships()); return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/RelsPart.php ================================================ getXmlWriter(); $this->writeRels($xmlWriter, [], $this->media); return $xmlWriter->getData(); } /** * Set media. * * @param array $media * * @return self */ public function setMedia($media) { $this->media = $media; return $this; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Settings.php ================================================ getSettings(); $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('w:settings'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); $xmlWriter->writeAttribute('xmlns:m', 'http://schemas.openxmlformats.org/officeDocument/2006/math'); $xmlWriter->writeAttribute('xmlns:sl', 'http://schemas.openxmlformats.org/schemaLibrary/2006/main'); $xmlWriter->writeAttribute('xmlns:o', 'urn:schemas-microsoft-com:office:office'); $xmlWriter->writeAttribute('xmlns:v', 'urn:schemas-microsoft-com:vml'); $xmlWriter->writeAttribute('xmlns:w10', 'urn:schemas-microsoft-com:office:word'); foreach ($this->settings as $settingKey => $settingValue) { $this->writeSetting($xmlWriter, $settingKey, $settingValue); } $xmlWriter->endElement(); // w:settings return $xmlWriter->getData(); } /** * Write indivual setting, recursive to any child settings. * * @param \PhpOffice\PhpWord\Shared\XMLWriter $xmlWriter * @param string $settingKey * @param array|string $settingValue */ protected function writeSetting($xmlWriter, $settingKey, $settingValue): void { if ($settingValue == '') { $xmlWriter->writeElement($settingKey); } elseif (is_array($settingValue) && !empty($settingValue)) { $xmlWriter->startElement($settingKey); /** @var array $settingValue Type hint */ foreach ($settingValue as $childKey => $childValue) { if ($childKey == '@attributes') { foreach ($childValue as $key => $val) { $xmlWriter->writeAttribute($key, $val); } } else { $this->writeSetting($xmlWriter, $childKey, $childValue); } } $xmlWriter->endElement(); } } /** * Get settings. */ private function getSettings(): void { /** @var \PhpOffice\PhpWord\Metadata\Settings $documentSettings */ $documentSettings = $this->getParentWriter()->getPhpWord()->getSettings(); // Default settings $this->settings = [ 'w:defaultTabStop' => ['@attributes' => ['w:val' => '708']], 'w:hyphenationZone' => ['@attributes' => ['w:val' => '425']], 'w:characterSpacingControl' => ['@attributes' => ['w:val' => 'doNotCompress']], 'w:decimalSymbol' => ['@attributes' => ['w:val' => $documentSettings->getDecimalSymbol()]], 'w:listSeparator' => ['@attributes' => ['w:val' => ';']], 'w:compat' => [], 'm:mathPr' => [ 'm:mathFont' => ['@attributes' => ['m:val' => 'Cambria Math']], 'm:brkBin' => ['@attributes' => ['m:val' => 'before']], 'm:brkBinSub' => ['@attributes' => ['m:val' => '--']], 'm:smallFrac' => ['@attributes' => ['m:val' => 'off']], 'm:dispDef' => '', 'm:lMargin' => ['@attributes' => ['m:val' => '0']], 'm:rMargin' => ['@attributes' => ['m:val' => '0']], 'm:defJc' => ['@attributes' => ['m:val' => 'centerGroup']], 'm:wrapIndent' => ['@attributes' => ['m:val' => '1440']], 'm:intLim' => ['@attributes' => ['m:val' => 'subSup']], 'm:naryLim' => ['@attributes' => ['m:val' => 'undOvr']], ], 'w:clrSchemeMapping' => [ '@attributes' => [ 'w:bg1' => 'light1', 'w:t1' => 'dark1', 'w:bg2' => 'light2', 'w:t2' => 'dark2', 'w:accent1' => 'accent1', 'w:accent2' => 'accent2', 'w:accent3' => 'accent3', 'w:accent4' => 'accent4', 'w:accent5' => 'accent5', 'w:accent6' => 'accent6', 'w:hyperlink' => 'hyperlink', 'w:followedHyperlink' => 'followedHyperlink', ], ], ]; $this->setOnOffValue('w:mirrorMargins', $documentSettings->hasMirrorMargins()); $this->setOnOffValue('w:hideSpellingErrors', $documentSettings->hasHideSpellingErrors()); $this->setOnOffValue('w:hideGrammaticalErrors', $documentSettings->hasHideGrammaticalErrors()); $this->setOnOffValue('w:trackRevisions', $documentSettings->hasTrackRevisions()); $this->setOnOffValue('w:doNotTrackMoves', $documentSettings->hasDoNotTrackMoves()); $this->setOnOffValue('w:doNotTrackFormatting', $documentSettings->hasDoNotTrackFormatting()); $this->setOnOffValue('w:evenAndOddHeaders', $documentSettings->hasEvenAndOddHeaders()); $this->setOnOffValue('w:updateFields', $documentSettings->hasUpdateFields()); $this->setOnOffValue('w:autoHyphenation', $documentSettings->hasAutoHyphenation()); $this->setOnOffValue('w:doNotHyphenateCaps', $documentSettings->hasDoNotHyphenateCaps()); $this->setOnOffValue('w:bookFoldPrinting', $documentSettings->hasBookFoldPrinting()); $this->setThemeFontLang($documentSettings->getThemeFontLang()); $this->setRevisionView($documentSettings->getRevisionView()); $this->setDocumentProtection($documentSettings->getDocumentProtection()); $this->setProofState($documentSettings->getProofState()); $this->setZoom($documentSettings->getZoom()); $this->setConsecutiveHyphenLimit($documentSettings->getConsecutiveHyphenLimit()); $this->setHyphenationZone($documentSettings->getHyphenationZone()); $this->setCompatibility(); } /** * Adds a boolean attribute to the settings array. * * @param string $settingName * @param null|bool $booleanValue */ private function setOnOffValue($settingName, $booleanValue): void { if (!is_bool($booleanValue)) { return; } $value = $booleanValue ? 'true' : 'false'; $this->settings[$settingName] = ['@attributes' => ['w:val' => $value]]; } /** * Get protection settings. * * @param \PhpOffice\PhpWord\Metadata\Protection $documentProtection */ private function setDocumentProtection($documentProtection): void { if ($documentProtection->getEditing() !== null) { if ($documentProtection->getPassword() == null) { $this->settings['w:documentProtection'] = [ '@attributes' => [ 'w:enforcement' => 1, 'w:edit' => $documentProtection->getEditing(), ], ]; } else { if ($documentProtection->getSalt() == null) { $documentProtection->setSalt((string) openssl_random_pseudo_bytes(16)); } $passwordHash = PasswordEncoder::hashPassword($documentProtection->getPassword(), $documentProtection->getAlgorithm(), $documentProtection->getSalt(), $documentProtection->getSpinCount()); $this->settings['w:documentProtection'] = [ '@attributes' => [ 'w:enforcement' => 1, 'w:edit' => $documentProtection->getEditing(), 'w:cryptProviderType' => 'rsaFull', 'w:cryptAlgorithmClass' => 'hash', 'w:cryptAlgorithmType' => 'typeAny', 'w:cryptAlgorithmSid' => PasswordEncoder::getAlgorithmId($documentProtection->getAlgorithm()), 'w:cryptSpinCount' => $documentProtection->getSpinCount(), 'w:hash' => $passwordHash, 'w:salt' => base64_encode($documentProtection->getSalt()), ], ]; } } } /** * Set the Proof state. */ private function setProofState(?ProofState $proofState = null): void { if ($proofState != null && $proofState->getGrammar() !== null && $proofState->getSpelling() !== null) { $this->settings['w:proofState'] = [ '@attributes' => [ 'w:spelling' => $proofState->getSpelling(), 'w:grammar' => $proofState->getGrammar(), ], ]; } } /** * Set the Revision View. */ private function setRevisionView(?TrackChangesView $trackChangesView = null): void { if ($trackChangesView != null) { $revisionView = []; $revisionView['w:markup'] = $trackChangesView->hasMarkup() ? 'true' : 'false'; $revisionView['w:comments'] = $trackChangesView->hasComments() ? 'true' : 'false'; $revisionView['w:insDel'] = $trackChangesView->hasInsDel() ? 'true' : 'false'; $revisionView['w:formatting'] = $trackChangesView->hasFormatting() ? 'true' : 'false'; $revisionView['w:inkAnnotations'] = $trackChangesView->hasInkAnnotations() ? 'true' : 'false'; $this->settings['w:revisionView'] = ['@attributes' => $revisionView]; } } /** * Sets the language. */ private function setThemeFontLang(?Language $language = null): void { $latinLanguage = ($language == null || $language->getLatin() === null) ? 'en-US' : $language->getLatin(); $lang = []; $lang['w:val'] = $latinLanguage; if ($language != null) { $lang['w:eastAsia'] = $language->getEastAsia() === null ? 'x-none' : $language->getEastAsia(); $lang['w:bidi'] = $language->getBidirectional() === null ? 'x-none' : $language->getBidirectional(); } $this->settings['w:themeFontLang'] = ['@attributes' => $lang]; } /** * Set the magnification. * * @param mixed $zoom */ private function setZoom($zoom = null): void { if ($zoom !== null) { $attr = is_int($zoom) ? 'w:percent' : 'w:val'; $this->settings['w:zoom'] = ['@attributes' => [$attr => $zoom]]; } } /** * @param null|int $consecutiveHyphenLimit */ private function setConsecutiveHyphenLimit($consecutiveHyphenLimit): void { if ($consecutiveHyphenLimit === null) { return; } $this->settings['w:consecutiveHyphenLimit'] = [ '@attributes' => ['w:val' => $consecutiveHyphenLimit], ]; } /** * @param null|float $hyphenationZone */ private function setHyphenationZone($hyphenationZone): void { if ($hyphenationZone === null) { return; } $this->settings['w:hyphenationZone'] = [ '@attributes' => ['w:val' => $hyphenationZone], ]; } /** * Get compatibility setting. */ private function setCompatibility(): void { $compatibility = $this->getParentWriter()->getPhpWord()->getCompatibility(); if ($compatibility->getOoxmlVersion() !== null) { $this->settings['w:compat']['w:compatSetting'] = [ '@attributes' => [ 'w:name' => 'compatibilityMode', 'w:uri' => 'http://schemas.microsoft.com/office/word', 'w:val' => $compatibility->getOoxmlVersion(), ], ]; } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Styles.php ================================================ getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('w:styles'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); // Write default styles $styles = Style::getStyles(); $this->writeDefaultStyles($xmlWriter, $styles); // Write styles if (count($styles) > 0) { foreach ($styles as $styleName => $style) { if ($styleName == 'Normal') { continue; } // Get style class and execute if the private method exists $styleClass = substr(get_class($style), strrpos(get_class($style), '\\') + 1); $method = "write{$styleClass}Style"; if (method_exists($this, $method)) { $this->$method($xmlWriter, $styleName, $style); } } } $xmlWriter->endElement(); // w:styles return $xmlWriter->getData(); } /** * Write default font and other default styles. * * @param Style\AbstractStyle[] $styles */ private function writeDefaultStyles(XMLWriter $xmlWriter, $styles): void { $phpWord = $this->getParentWriter()->getPhpWord(); $fontName = $phpWord->getDefaultFontName(); $asianFontName = $phpWord->getDefaultAsianFontName(); $fontSize = $phpWord->getDefaultFontSize(); $fontColor = $phpWord->getDefaultFontColor(); $language = $phpWord->getSettings()->getThemeFontLang(); $latinLanguage = ($language == null || $language->getLatin() === null) ? 'en-US' : $language->getLatin(); // Default font $xmlWriter->startElement('w:docDefaults'); $xmlWriter->startElement('w:rPrDefault'); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:rFonts'); $xmlWriter->writeAttribute('w:ascii', $fontName); $xmlWriter->writeAttribute('w:hAnsi', $fontName); $xmlWriter->writeAttribute('w:eastAsia', $asianFontName); $xmlWriter->writeAttribute('w:cs', $fontName); $xmlWriter->endElement(); // w:rFonts $xmlWriter->startElement('w:color'); $xmlWriter->writeAttribute('w:val', $fontColor); $xmlWriter->endElement(); $xmlWriter->startElement('w:sz'); $xmlWriter->writeAttribute('w:val', $fontSize * 2); $xmlWriter->endElement(); // w:sz $xmlWriter->startElement('w:szCs'); $xmlWriter->writeAttribute('w:val', $fontSize * 2); $xmlWriter->endElement(); // w:szCs $xmlWriter->startElement('w:lang'); $xmlWriter->writeAttribute('w:val', $latinLanguage); if ($language != null) { $xmlWriter->writeAttributeIf($language->getEastAsia() !== null, 'w:eastAsia', $language->getEastAsia()); $xmlWriter->writeAttributeIf($language->getBidirectional() !== null, 'w:bidi', $language->getBidirectional()); } $xmlWriter->endElement(); // w:lang $xmlWriter->endElement(); // w:rPr $xmlWriter->endElement(); // w:rPrDefault $xmlWriter->endElement(); // w:docDefaults // Normal style $xmlWriter->startElement('w:style'); $xmlWriter->writeAttribute('w:type', 'paragraph'); $xmlWriter->writeAttribute('w:default', '1'); $xmlWriter->writeAttribute('w:styleId', 'Normal'); $xmlWriter->startElement('w:name'); $xmlWriter->writeAttribute('w:val', 'Normal'); $xmlWriter->endElement(); // w:name if (isset($styles['Normal'])) { $normalStyle = $styles['Normal']; // w:pPr if ($normalStyle instanceof FontStyle && $normalStyle->getParagraph() != null) { $styleWriter = new ParagraphStyleWriter($xmlWriter, $normalStyle->getParagraph()); $styleWriter->write(); } elseif ($normalStyle instanceof ParagraphStyle) { $styleWriter = new ParagraphStyleWriter($xmlWriter, $normalStyle); $styleWriter->write(); } // w:rPr $styleWriter = new FontStyleWriter($xmlWriter, $normalStyle); $styleWriter->write(); } $xmlWriter->endElement(); // w:style // FootnoteReference style if (!isset($styles['FootnoteReference'])) { $xmlWriter->startElement('w:style'); $xmlWriter->writeAttribute('w:type', 'character'); $xmlWriter->writeAttribute('w:styleId', 'FootnoteReference'); $xmlWriter->startElement('w:name'); $xmlWriter->writeAttribute('w:val', 'Footnote Reference'); $xmlWriter->endElement(); // w:name $xmlWriter->writeElement('w:semiHidden'); $xmlWriter->writeElement('w:unhideWhenUsed'); $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:vertAlign'); $xmlWriter->writeAttribute('w:val', 'superscript'); $xmlWriter->endElement(); // w:vertAlign $xmlWriter->endElement(); // w:rPr $xmlWriter->endElement(); // w:style } } /** * Write font style. * * @param string $styleName */ private function writeFontStyle(XMLWriter $xmlWriter, $styleName, FontStyle $style): void { $paragraphStyle = $style->getParagraph(); $styleType = $style->getStyleType(); $type = ($styleType == 'title') ? 'paragraph' : 'character'; if (null !== $paragraphStyle) { $type = 'paragraph'; } $xmlWriter->startElement('w:style'); $xmlWriter->writeAttribute('w:type', $type); // Heading style if ($styleType == 'title') { $arrStyle = explode('_', $styleName); if (count($arrStyle) > 1) { $styleId = 'Heading' . $arrStyle[1]; $styleName = 'heading ' . $arrStyle[1]; $styleLink = 'Heading' . $arrStyle[1] . 'Char'; } else { $styleId = $styleName; $styleName = strtolower($styleName); $styleLink = $styleName . 'Char'; } $xmlWriter->writeAttribute('w:styleId', $styleId); $xmlWriter->startElement('w:link'); $xmlWriter->writeAttribute('w:val', $styleLink); $xmlWriter->endElement(); } elseif (null !== $paragraphStyle) { // if type is 'paragraph' it should have a styleId $xmlWriter->writeAttribute('w:styleId', $styleName); } // Style name $xmlWriter->startElement('w:name'); $xmlWriter->writeAttribute('w:val', $styleName); $xmlWriter->endElement(); // Parent style if (null !== $paragraphStyle) { if ($paragraphStyle->getStyleName() != null) { $xmlWriter->writeElementBlock('w:basedOn', 'w:val', $paragraphStyle->getStyleName()); } elseif ($paragraphStyle->getBasedOn() != null) { $xmlWriter->writeElementBlock('w:basedOn', 'w:val', $paragraphStyle->getBasedOn()); } } // w:pPr if (null !== $paragraphStyle) { $styleWriter = new ParagraphStyleWriter($xmlWriter, $paragraphStyle); $styleWriter->write(); } // w:rPr $styleWriter = new FontStyleWriter($xmlWriter, $style); $styleWriter->write(); $xmlWriter->endElement(); } /** * Write paragraph style. * * @param string $styleName */ private function writeParagraphStyle(XMLWriter $xmlWriter, $styleName, ParagraphStyle $style): void { $xmlWriter->startElement('w:style'); $xmlWriter->writeAttribute('w:type', 'paragraph'); $xmlWriter->writeAttribute('w:customStyle', '1'); $xmlWriter->writeAttribute('w:styleId', $styleName); $xmlWriter->startElement('w:name'); $xmlWriter->writeAttribute('w:val', $styleName); $xmlWriter->endElement(); // Parent style $basedOn = $style->getBasedOn(); $xmlWriter->writeElementIf(null !== $basedOn, 'w:basedOn', 'w:val', $basedOn); // Next paragraph style $next = $style->getNext(); $xmlWriter->writeElementIf(null !== $next, 'w:next', 'w:val', $next); // w:pPr $styleWriter = new ParagraphStyleWriter($xmlWriter, $style); $styleWriter->write(); $xmlWriter->endElement(); } /** * Write table style. * * @param string $styleName */ private function writeTableStyle(XMLWriter $xmlWriter, $styleName, TableStyle $style): void { $xmlWriter->startElement('w:style'); $xmlWriter->writeAttribute('w:type', 'table'); $xmlWriter->writeAttribute('w:customStyle', '1'); $xmlWriter->writeAttribute('w:styleId', $styleName); $xmlWriter->startElement('w:name'); $xmlWriter->writeAttribute('w:val', $styleName); $xmlWriter->endElement(); $xmlWriter->startElement('w:uiPriority'); $xmlWriter->writeAttribute('w:val', '99'); $xmlWriter->endElement(); $styleWriter = new TableStyleWriter($xmlWriter, $style); $styleWriter->write(); $xmlWriter->endElement(); // w:style } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/Theme.php ================================================ '; $str .= ''; $str .= ''; $str .= $this->writeColorScheme(); $str .= $this->writeFontScheme(); $str .= $this->writeFormatScheme(); $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } /** * Write color scheme. * * @return string */ private function writeColorScheme() { $str = ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } /** * Write font scheme. * * @return string */ private function writeFontScheme() { $str = ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } /** * Write format scheme. * * @return string */ private function writeFormatScheme() { $str = ''; $str .= ''; $str .= $this->writeFormatFill(); $str .= $this->writeFormatLine(); $str .= $this->writeFormatEffect(); $str .= $this->writeFormatBackground(); $str .= ''; return $str; } /** * Write fill format scheme. * * @return string */ private function writeFormatFill() { $str = ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } /** * Write line format scheme. * * @return string */ private function writeFormatLine() { $str = ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } /** * Write effect format scheme. * * @return string */ private function writeFormatEffect() { $str = ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } /** * Write background format scheme. * * @return string */ private function writeFormatBackground() { $str = ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; $str .= ''; return $str; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Part/WebSettings.php ================================================ '', ]; $xmlWriter = $this->getXmlWriter(); $xmlWriter->startDocument('1.0', 'UTF-8', 'yes'); $xmlWriter->startElement('w:webSettings'); $xmlWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'); $xmlWriter->writeAttribute('xmlns:w', 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'); foreach ($settings as $settingKey => $settingValue) { $this->writeSetting($xmlWriter, $settingKey, $settingValue); } $xmlWriter->endElement(); // w:settings return $xmlWriter->getData(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/AbstractStyle.php ================================================ xmlWriter = $xmlWriter; $this->style = $style; } /** * Get XML Writer. * * @return XMLWriter */ protected function getXmlWriter() { return $this->xmlWriter; } /** * Get Style. * * @return \PhpOffice\PhpWord\Style\AbstractStyle|string */ protected function getStyle() { return $this->style; } /** * Convert twip value. * * @param float|int $value * @param int $default (int|float) * * @return float|int */ protected function convertTwip($value, $default = 0) { $factors = [ Settings::UNIT_CM => 567, Settings::UNIT_MM => 56.7, Settings::UNIT_INCH => 1440, Settings::UNIT_POINT => 20, Settings::UNIT_PICA => 240, ]; $unit = Settings::getMeasurementUnit(); $factor = 1; if (array_key_exists($unit, $factors) && $value != $default) { $factor = $factors[$unit]; } return $value * $factor; } /** * Write child style. * * @param string $name * @param mixed $value */ protected function writeChildStyle(XMLWriter $xmlWriter, $name, $value): void { if ($value !== null) { $class = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Style\\' . $name; /** @var AbstractStyle $writer */ $writer = new $class($xmlWriter, $value); $writer->write(); } } /** * Writes boolean as 0 or 1. * * @param bool $value * * @return null|string */ protected function writeOnOf($value = null) { if ($value === null) { return null; } return $value ? '1' : '0'; } /** * Assemble style array into style string. * * @param array $styles * * @return string */ protected function assembleStyle($styles = []) { $style = ''; foreach ($styles as $key => $value) { if (null !== $value && $value != '') { $style .= "{$key}:{$value}; "; } } return trim($style); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Cell.php ================================================ getStyle(); if (!$style instanceof CellStyle) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:tcPr'); // Width if (null !== $this->width || null !== $style->getWidth()) { $width = null === $this->width ? $style->getWidth() : $this->width; $xmlWriter->startElement('w:tcW'); $xmlWriter->writeAttribute('w:w', $width); $xmlWriter->writeAttribute('w:type', $style->getUnit()); $xmlWriter->endElement(); // w:tcW } $paddingTop = $style->getPaddingTop(); $paddingLeft = $style->getPaddingLeft(); $paddingBottom = $style->getPaddingBottom(); $paddingRight = $style->getPaddingRight(); if ($paddingTop !== null || $paddingLeft !== null || $paddingBottom !== null || $paddingRight !== null) { $xmlWriter->startElement('w:tcMar'); if ($paddingTop !== null) { $xmlWriter->startElement('w:top'); $xmlWriter->writeAttribute('w:w', $paddingTop); $xmlWriter->writeAttribute('w:type', \PhpOffice\PhpWord\SimpleType\TblWidth::TWIP); $xmlWriter->endElement(); // w:top } if ($paddingLeft !== null) { $xmlWriter->startElement('w:start'); $xmlWriter->writeAttribute('w:w', $paddingLeft); $xmlWriter->writeAttribute('w:type', \PhpOffice\PhpWord\SimpleType\TblWidth::TWIP); $xmlWriter->endElement(); // w:start } if ($paddingBottom !== null) { $xmlWriter->startElement('w:bottom'); $xmlWriter->writeAttribute('w:w', $paddingBottom); $xmlWriter->writeAttribute('w:type', \PhpOffice\PhpWord\SimpleType\TblWidth::TWIP); $xmlWriter->endElement(); // w:bottom } if ($paddingRight !== null) { $xmlWriter->startElement('w:end'); $xmlWriter->writeAttribute('w:w', $paddingRight); $xmlWriter->writeAttribute('w:type', \PhpOffice\PhpWord\SimpleType\TblWidth::TWIP); $xmlWriter->endElement(); // w:end } $xmlWriter->endElement(); // w:tcMar } // Text direction $textDir = $style->getTextDirection(); $xmlWriter->writeElementIf(null !== $textDir, 'w:textDirection', 'w:val', $textDir); // Vertical alignment $vAlign = $style->getVAlign(); $xmlWriter->writeElementIf(null !== $vAlign, 'w:vAlign', 'w:val', $vAlign); // Border if ($style->hasBorder()) { $xmlWriter->startElement('w:tcBorders'); $styleWriter = new MarginBorder($xmlWriter); $styleWriter->setSizes($style->getBorderSize()); $styleWriter->setColors($style->getBorderColor()); $styleWriter->setStyles($style->getBorderStyle()); $styleWriter->setAttributes(['defaultColor' => CellStyle::DEFAULT_BORDER_COLOR]); $styleWriter->write(); $xmlWriter->endElement(); } // Shading $shading = $style->getShading(); if (null !== $shading) { $styleWriter = new Shading($xmlWriter, $shading); $styleWriter->write(); } // Colspan & rowspan $gridSpan = $style->getGridSpan(); $vMerge = $style->getVMerge(); $xmlWriter->writeElementIf(null !== $gridSpan, 'w:gridSpan', 'w:val', $gridSpan); $xmlWriter->writeElementIf(null !== $vMerge, 'w:vMerge', 'w:val', $vMerge); $xmlWriter->writeElementIf($style->getNoWrap(), 'w:noWrap'); $xmlWriter->endElement(); // w:tcPr } /** * Set width. * * @param int $value */ public function setWidth($value = null): void { $this->width = $value; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Extrusion.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Extrusion) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('o:extrusion'); $xmlWriter->writeAttribute('on', 't'); $xmlWriter->writeAttributeIf($style->getType() !== null, 'type', $style->getType()); $xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Fill.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Fill) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->writeAttribute('on', 't'); $xmlWriter->writeAttributeIf($style->getColor() !== null, 'fillcolor', $style->getColor()); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Font.php ================================================ getXmlWriter(); $isStyleName = $this->isInline && null !== $this->style && is_string($this->style); if ($isStyleName) { $xmlWriter->startElement('w:rPr'); $xmlWriter->startElement('w:rStyle'); $xmlWriter->writeAttribute('w:val', $this->style); $xmlWriter->endElement(); $style = \PhpOffice\PhpWord\Style::getStyle($this->style); if ($style instanceof \PhpOffice\PhpWord\Style\Font) { $xmlWriter->writeElementIf($style->isRTL(), 'w:rtl'); } $xmlWriter->endElement(); } else { $this->writeStyle(); } } /** * Write full style. */ private function writeStyle(): void { $style = $this->getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Font) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:rPr'); // Style name if ($this->isInline === true) { $styleName = $style->getStyleName(); $xmlWriter->writeElementIf($styleName !== null, 'w:rStyle', 'w:val', $styleName); } // Font name/family $font = $style->getName(); $hint = $style->getHint(); if ($font !== null) { $xmlWriter->startElement('w:rFonts'); $xmlWriter->writeAttribute('w:ascii', $font); $xmlWriter->writeAttribute('w:hAnsi', $font); $xmlWriter->writeAttribute('w:eastAsia', $font); $xmlWriter->writeAttribute('w:cs', $font); $xmlWriter->writeAttributeIf($hint !== null, 'w:hint', $hint); $xmlWriter->endElement(); } //Language $language = $style->getLang(); if ($language != null && ($language->getLatin() !== null || $language->getEastAsia() !== null || $language->getBidirectional() !== null)) { $xmlWriter->startElement('w:lang'); $xmlWriter->writeAttributeIf($language->getLatin() !== null, 'w:val', $language->getLatin()); $xmlWriter->writeAttributeIf($language->getEastAsia() !== null, 'w:eastAsia', $language->getEastAsia()); $xmlWriter->writeAttributeIf($language->getBidirectional() !== null, 'w:bidi', $language->getBidirectional()); //if bidi is not set but we are writing RTL, write the latin language in the bidi tag if ($style->isRTL() && $language->getBidirectional() === null && $language->getLatin() !== null) { $xmlWriter->writeAttribute('w:bidi', $language->getLatin()); } $xmlWriter->endElement(); } // Color $color = $style->getColor(); $xmlWriter->writeElementIf($color !== null, 'w:color', 'w:val', $color); // Size $size = $style->getSize(); $xmlWriter->writeElementIf($size !== null, 'w:sz', 'w:val', $size * 2); $xmlWriter->writeElementIf($size !== null, 'w:szCs', 'w:val', $size * 2); // Bold, italic $xmlWriter->writeElementIf($style->isBold() !== null, 'w:b', 'w:val', $this->writeOnOf($style->isBold())); $xmlWriter->writeElementIf($style->isBold() !== null, 'w:bCs', 'w:val', $this->writeOnOf($style->isBold())); $xmlWriter->writeElementIf($style->isItalic() !== null, 'w:i', 'w:val', $this->writeOnOf($style->isItalic())); $xmlWriter->writeElementIf($style->isItalic() !== null, 'w:iCs', 'w:val', $this->writeOnOf($style->isItalic())); // Strikethrough, double strikethrough $xmlWriter->writeElementIf($style->isStrikethrough(), 'w:strike', 'w:val', $this->writeOnOf($style->isStrikethrough())); $xmlWriter->writeElementIf($style->isDoubleStrikethrough(), 'w:dstrike', 'w:val', $this->writeOnOf($style->isDoubleStrikethrough())); // Small caps, all caps $xmlWriter->writeElementIf($style->isSmallCaps() !== null, 'w:smallCaps', 'w:val', $this->writeOnOf($style->isSmallCaps())); $xmlWriter->writeElementIf($style->isAllCaps() !== null, 'w:caps', 'w:val', $this->writeOnOf($style->isAllCaps())); //Hidden text $xmlWriter->writeElementIf($style->isHidden(), 'w:vanish', 'w:val', $this->writeOnOf($style->isHidden())); // Underline $xmlWriter->writeElementIf($style->getUnderline() != 'none', 'w:u', 'w:val', $style->getUnderline()); // Foreground-Color $xmlWriter->writeElementIf($style->getFgColor() !== null, 'w:highlight', 'w:val', $style->getFgColor()); // Superscript/subscript $xmlWriter->writeElementIf($style->isSuperScript(), 'w:vertAlign', 'w:val', 'superscript'); $xmlWriter->writeElementIf($style->isSubScript(), 'w:vertAlign', 'w:val', 'subscript'); // Spacing $xmlWriter->writeElementIf($style->getScale() !== null, 'w:w', 'w:val', $style->getScale()); $xmlWriter->writeElementIf($style->getSpacing() !== null, 'w:spacing', 'w:val', $style->getSpacing()); $xmlWriter->writeElementIf($style->getKerning() !== null, 'w:kern', 'w:val', $style->getKerning() * 2); // noProof $xmlWriter->writeElementIf($style->isNoProof() !== null, 'w:noProof', 'w:val', $this->writeOnOf($style->isNoProof())); // Background-Color $shading = $style->getShading(); if (null !== $shading) { $styleWriter = new Shading($xmlWriter, $shading); $styleWriter->write(); } // RTL if ($this->isInline === true) { $styleName = $style->getStyleName(); $xmlWriter->writeElementIf($styleName === null && $style->isRTL(), 'w:rtl'); } // Position $xmlWriter->writeElementIf($style->getPosition() !== null, 'w:position', 'w:val', $style->getPosition()); $xmlWriter->endElement(); } /** * Set is inline. * * @param bool $value */ public function setIsInline($value): void { $this->isInline = $value; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Frame.php ================================================ getStyle(); if (!$style instanceof FrameStyle) { return; } $xmlWriter = $this->getXmlWriter(); $maxZIndex = min(PHP_INT_MAX, self::PHP_32BIT_INT_MAX); $zIndices = [FrameStyle::WRAP_INFRONT => $maxZIndex, FrameStyle::WRAP_BEHIND => -$maxZIndex]; $properties = [ 'width' => 'width', 'height' => 'height', 'left' => 'margin-left', 'top' => 'margin-top', 'wrapDistanceTop' => 'mso-wrap-distance-top', 'wrapDistanceBottom' => 'mso-wrap-distance-bottom', 'wrapDistanceLeft' => 'mso-wrap-distance-left', 'wrapDistanceRight' => 'mso-wrap-distance-right', ]; $sizeStyles = $this->getStyles($style, $properties, $style->getUnit()); $properties = [ 'pos' => 'position', 'hPos' => 'mso-position-horizontal', 'vPos' => 'mso-position-vertical', 'hPosRelTo' => 'mso-position-horizontal-relative', 'vPosRelTo' => 'mso-position-vertical-relative', ]; $posStyles = $this->getStyles($style, $properties); $styles = array_merge($sizeStyles, $posStyles); // zIndex for infront & behind wrap $wrap = $style->getWrap(); if ($wrap !== null && isset($zIndices[$wrap])) { $styles['z-index'] = $zIndices[$wrap]; $wrap = null; } // Style attribute $xmlWriter->writeAttribute('style', $this->assembleStyle($styles)); $this->writeWrap($xmlWriter, $style, $wrap); } /** * Write alignment. */ public function writeAlignment(): void { $style = $this->getStyle(); if (!$style instanceof FrameStyle) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:pPr'); if ('' !== $style->getAlignment()) { $paragraphAlignment = new ParagraphAlignment($style->getAlignment()); $xmlWriter->startElement($paragraphAlignment->getName()); foreach ($paragraphAlignment->getAttributes() as $attributeName => $attributeValue) { $xmlWriter->writeAttribute($attributeName, $attributeValue); } $xmlWriter->endElement(); } $xmlWriter->endElement(); } /** * Write wrap. * * @param string $wrap */ private function writeWrap(XMLWriter $xmlWriter, FrameStyle $style, $wrap): void { if ($wrap !== null) { $xmlWriter->startElement('w10:wrap'); $xmlWriter->writeAttribute('type', $wrap); $relativePositions = [ FrameStyle::POS_RELTO_MARGIN => 'margin', FrameStyle::POS_RELTO_PAGE => 'page', FrameStyle::POS_RELTO_TMARGIN => 'margin', FrameStyle::POS_RELTO_BMARGIN => 'page', FrameStyle::POS_RELTO_LMARGIN => 'margin', FrameStyle::POS_RELTO_RMARGIN => 'page', ]; $pos = $style->getPos(); $hPos = $style->getHPosRelTo(); $vPos = $style->getVPosRelTo(); if ($pos == FrameStyle::POS_ABSOLUTE) { $xmlWriter->writeAttribute('anchorx', 'page'); $xmlWriter->writeAttribute('anchory', 'page'); } elseif ($pos == FrameStyle::POS_RELATIVE) { if (isset($relativePositions[$hPos])) { $xmlWriter->writeAttribute('anchorx', $relativePositions[$hPos]); } if (isset($relativePositions[$vPos])) { $xmlWriter->writeAttribute('anchory', $relativePositions[$vPos]); } } $xmlWriter->endElement(); // w10:wrap } } /** * Get style values in associative array. * * @param array $properties * @param string $suffix * * @return array */ private function getStyles(FrameStyle $style, $properties, $suffix = '') { $styles = []; foreach ($properties as $key => $property) { $method = "get{$key}"; $value = $style->$method(); if ($value !== null) { $styles[$property] = $style->$method() . $suffix; } } return $styles; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Image.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Indentation) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:ind'); $xmlWriter->writeAttribute('w:left', $this->convertTwip($style->getLeft())); $xmlWriter->writeAttribute('w:right', $this->convertTwip($style->getRight())); $firstLine = $style->getFirstLine(); $xmlWriter->writeAttributeIf(null !== $firstLine, 'w:firstLine', $this->convertTwip($firstLine)); $firstLineChars = $style->getFirstLineChars(); $xmlWriter->writeAttributeIf(0 !== $firstLineChars, 'w:firstLineChars', $this->convertTwip($firstLineChars)); $hanging = $style->getHanging(); $xmlWriter->writeAttributeIf(null !== $hanging, 'w:hanging', $this->convertTwip($hanging)); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Line.php ================================================ getXmlWriter(); $style = $this->getStyle(); if (!$style instanceof LineStyle) { return; } $dash = $style->getDash(); $dashStyles = [ LineStyle::DASH_STYLE_DASH => 'dash', LineStyle::DASH_STYLE_ROUND_DOT => '1 1', LineStyle::DASH_STYLE_SQUARE_DOT => '1 1', LineStyle::DASH_STYLE_DASH_DOT => 'dashDot', LineStyle::DASH_STYLE_LONG_DASH => 'longDash', LineStyle::DASH_STYLE_LONG_DASH_DOT => 'longDashDot', LineStyle::DASH_STYLE_LONG_DASH_DOT_DOT => 'longDashDotDot', ]; $xmlWriter->startElement('v:stroke'); $xmlWriter->writeAttributeIf($style->getWeight() !== null, 'weight', $style->getWeight() . 'pt'); $xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor()); $xmlWriter->writeAttributeIf($style->getBeginArrow() !== null, 'startarrow', $style->getBeginArrow()); $xmlWriter->writeAttributeIf($style->getEndArrow() !== null, 'endarrow', $style->getEndArrow()); if ($dash !== null) { if (isset($dashStyles[$dash])) { $xmlWriter->writeAttribute('dashstyle', $dashStyles[$dash]); } if ($dash == LineStyle::DASH_STYLE_ROUND_DOT) { $xmlWriter->writeAttribute('endcap', 'round'); } } $xmlWriter->endElement(); //v:stroke } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/LineNumbering.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\LineNumbering) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:lnNumType'); $xmlWriter->writeAttribute('w:start', $style->getStart() - 1); $xmlWriter->writeAttribute('w:countBy', $style->getIncrement()); $xmlWriter->writeAttribute('w:distance', $style->getDistance()); $xmlWriter->writeAttribute('w:restart', $style->getRestart()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/MarginBorder.php ================================================ getXmlWriter(); $sides = ['top', 'left', 'right', 'bottom', 'insideH', 'insideV']; foreach ($this->sizes as $i => $size) { if ($size !== null) { $color = null; if (isset($this->colors[$i])) { $color = $this->colors[$i]; } $style = $this->styles[$i] ?? 'single'; $this->writeSide($xmlWriter, $sides[$i], $this->sizes[$i], $color, $style); } } } /** * Write side. * * @param string $side * @param int $width * @param string $color * @param string $borderStyle */ private function writeSide(XMLWriter $xmlWriter, $side, $width, $color = null, $borderStyle = 'solid'): void { $xmlWriter->startElement('w:' . $side); if (!empty($this->colors)) { if ($color === null && !empty($this->attributes)) { if (isset($this->attributes['defaultColor'])) { $color = $this->attributes['defaultColor']; } } $xmlWriter->writeAttribute('w:val', $borderStyle); $xmlWriter->writeAttribute('w:sz', $width); $xmlWriter->writeAttributeIf($color != null, 'w:color', $color); if (!empty($this->attributes)) { if (isset($this->attributes['space'])) { $xmlWriter->writeAttribute('w:space', $this->attributes['space']); } } } else { $xmlWriter->writeAttribute('w:w', $width); $xmlWriter->writeAttribute('w:type', 'dxa'); } $xmlWriter->endElement(); } /** * Set sizes. * * @param int[] $value */ public function setSizes($value): void { $this->sizes = $value; } /** * Set colors. * * @param array $value */ public function setColors($value): void { $this->colors = $value; } /** * Set border styles. * * @param string[] $value */ public function setStyles($value): void { $this->styles = $value; } /** * Set attributes. * * @param array $value */ public function setAttributes($value): void { $this->attributes = $value; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Outline.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Outline) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('v:stroke'); $xmlWriter->writeAttribute('on', 't'); $xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor()); $xmlWriter->writeAttributeIf($style->getWeight() !== null, 'weight', $style->getWeight() . $style->getUnit()); $xmlWriter->writeAttributeIf($style->getDash() !== null, 'dashstyle', $style->getDash()); $xmlWriter->writeAttributeIf($style->getLine() !== null, 'linestyle', $style->getLine()); $xmlWriter->writeAttributeIf($style->getEndCap() !== null, 'endcap', $style->getEndCap()); $xmlWriter->writeAttributeIf($style->getStartArrow() !== null, 'startarrow', $style->getStartArrow()); $xmlWriter->writeAttributeIf($style->getEndArrow() !== null, 'endarrow', $style->getEndArrow()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Paragraph.php ================================================ getXmlWriter(); $isStyleName = $this->isInline && null !== $this->style && is_string($this->style); if ($isStyleName) { if (!$this->withoutPPR) { $xmlWriter->startElement('w:pPr'); } $xmlWriter->startElement('w:pStyle'); $xmlWriter->writeAttribute('w:val', $this->style); $xmlWriter->endElement(); if (!$this->withoutPPR) { $xmlWriter->endElement(); } } else { $this->writeStyle(); } } /** * Write full style. */ private function writeStyle(): void { $style = $this->getStyle(); if (!$style instanceof ParagraphStyle) { return; } $xmlWriter = $this->getXmlWriter(); $styles = $style->getStyleValues(); if (!$this->withoutPPR) { $xmlWriter->startElement('w:pPr'); } // Style name if ($this->isInline === true) { $xmlWriter->writeElementIf($styles['name'] !== null, 'w:pStyle', 'w:val', $styles['name']); } // Pagination $xmlWriter->writeElementIf($styles['pagination']['widowControl'] === false, 'w:widowControl', 'w:val', '0'); $xmlWriter->writeElementIf($styles['pagination']['keepNext'] === true, 'w:keepNext', 'w:val', '1'); $xmlWriter->writeElementIf($styles['pagination']['keepLines'] === true, 'w:keepLines', 'w:val', '1'); $xmlWriter->writeElementIf($styles['pagination']['pageBreak'] === true, 'w:pageBreakBefore', 'w:val', '1'); // Paragraph alignment if ('' !== $styles['alignment']) { $paragraphAlignment = new ParagraphAlignment($styles['alignment']); $xmlWriter->startElement($paragraphAlignment->getName()); foreach ($paragraphAlignment->getAttributes() as $attributeName => $attributeValue) { $xmlWriter->writeAttribute($attributeName, $attributeValue); } $xmlWriter->endElement(); } //Right to left $xmlWriter->writeElementIf($styles['bidi'] === true, 'w:bidi'); //Paragraph contextualSpacing $xmlWriter->writeElementIf($styles['contextualSpacing'] === true, 'w:contextualSpacing'); //Paragraph textAlignment $xmlWriter->writeElementIf($styles['textAlignment'] !== null, 'w:textAlignment', 'w:val', $styles['textAlignment']); // Hyphenation $xmlWriter->writeElementIf($styles['suppressAutoHyphens'] === true, 'w:suppressAutoHyphens'); // Child style: alignment, indentation, spacing, and shading $this->writeChildStyle($xmlWriter, 'Indentation', $styles['indentation']); $this->writeChildStyle($xmlWriter, 'Spacing', $styles['spacing']); $this->writeChildStyle($xmlWriter, 'Shading', $styles['shading']); // Tabs $this->writeTabs($xmlWriter, $styles['tabs']); // Numbering $this->writeNumbering($xmlWriter, $styles['numbering']); // Border if ($style->hasBorder()) { $xmlWriter->startElement('w:pBdr'); $styleWriter = new MarginBorder($xmlWriter); $styleWriter->setSizes($style->getBorderSize()); $styleWriter->setStyles($style->getBorderStyle()); $styleWriter->setColors($style->getBorderColor()); $styleWriter->write(); $xmlWriter->endElement(); } if (!$this->withoutPPR) { $xmlWriter->endElement(); // w:pPr } } /** * Write tabs. * * @param Style\Tab[] $tabs */ private function writeTabs(XMLWriter $xmlWriter, $tabs): void { if (!empty($tabs)) { $xmlWriter->startElement('w:tabs'); foreach ($tabs as $tab) { $styleWriter = new Tab($xmlWriter, $tab); $styleWriter->write(); } $xmlWriter->endElement(); } } /** * Write numbering. * * @param array $numbering */ private function writeNumbering(XMLWriter $xmlWriter, $numbering): void { $numStyle = $numbering['style']; $numLevel = $numbering['level']; /** @var Style\Numbering $numbering */ $numbering = Style::getStyle($numStyle); if ($numStyle !== null && $numbering !== null) { $xmlWriter->startElement('w:numPr'); $xmlWriter->startElement('w:numId'); $xmlWriter->writeAttribute('w:val', $numbering->getIndex()); $xmlWriter->endElement(); // w:numId $xmlWriter->startElement('w:ilvl'); $xmlWriter->writeAttribute('w:val', $numLevel); $xmlWriter->endElement(); // w:ilvl $xmlWriter->endElement(); // w:numPr $xmlWriter->startElement('w:outlineLvl'); $xmlWriter->writeAttribute('w:val', $numLevel); $xmlWriter->endElement(); // w:outlineLvl } } /** * Set without w:pPr. * * @param bool $value */ public function setWithoutPPR($value): void { $this->withoutPPR = $value; } /** * Set is inline. * * @param bool $value */ public function setIsInline($value): void { $this->isInline = $value; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Row.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Row) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:trPr'); if ($this->height !== null) { $xmlWriter->startElement('w:trHeight'); $xmlWriter->writeAttribute('w:val', $this->height); $xmlWriter->writeAttribute('w:hRule', ($style->isExactHeight() ? 'exact' : 'atLeast')); $xmlWriter->endElement(); } $xmlWriter->writeElementIf($style->isTblHeader(), 'w:tblHeader', 'w:val', '1'); $xmlWriter->writeElementIf($style->isCantSplit(), 'w:cantSplit', 'w:val', '1'); $xmlWriter->endElement(); // w:trPr } /** * Set height. * * @param int $value */ public function setHeight($value = null): void { $this->height = $value; } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Section.php ================================================ getStyle(); if (!$style instanceof SectionStyle) { return; } $xmlWriter = $this->getXmlWriter(); // Break type $breakType = $style->getBreakType(); $xmlWriter->writeElementIf(null !== $breakType, 'w:type', 'w:val', $breakType); // Page size & orientation $xmlWriter->startElement('w:pgSz'); $xmlWriter->writeAttribute('w:orient', $style->getOrientation()); $xmlWriter->writeAttribute('w:w', $style->getPageSizeW()); $xmlWriter->writeAttribute('w:h', $style->getPageSizeH()); $xmlWriter->endElement(); // w:pgSz // Vertical alignment $vAlign = $style->getVAlign(); $xmlWriter->writeElementIf(null !== $vAlign, 'w:vAlign', 'w:val', $vAlign); // Margins $margins = [ 'w:top' => ['getMarginTop', SectionStyle::DEFAULT_MARGIN], 'w:right' => ['getMarginRight', SectionStyle::DEFAULT_MARGIN], 'w:bottom' => ['getMarginBottom', SectionStyle::DEFAULT_MARGIN], 'w:left' => ['getMarginLeft', SectionStyle::DEFAULT_MARGIN], 'w:header' => ['getHeaderHeight', SectionStyle::DEFAULT_HEADER_HEIGHT], 'w:footer' => ['getFooterHeight', SectionStyle::DEFAULT_FOOTER_HEIGHT], 'w:gutter' => ['getGutter', SectionStyle::DEFAULT_GUTTER], ]; $xmlWriter->startElement('w:pgMar'); foreach ($margins as $attribute => $value) { [$method, $default] = $value; $xmlWriter->writeAttribute($attribute, $this->convertTwip($style->$method(), $default)); } $xmlWriter->endElement(); // Borders if ($style->hasBorder()) { $xmlWriter->startElement('w:pgBorders'); $xmlWriter->writeAttribute('w:offsetFrom', 'page'); $styleWriter = new MarginBorder($xmlWriter); $styleWriter->setSizes($style->getBorderSize()); $styleWriter->setColors($style->getBorderColor()); $styleWriter->setAttributes(['space' => '24']); $styleWriter->write(); $xmlWriter->endElement(); } // Columns $colsSpace = $style->getColsSpace(); $xmlWriter->startElement('w:cols'); $xmlWriter->writeAttribute('w:num', $style->getColsNum()); $xmlWriter->writeAttribute('w:space', $this->convertTwip($colsSpace, SectionStyle::DEFAULT_COLUMN_SPACING)); $xmlWriter->endElement(); // Page numbering start $pageNum = $style->getPageNumberingStart(); $xmlWriter->writeElementIf(null !== $pageNum, 'w:pgNumType', 'w:start', $pageNum); // Line numbering $styleWriter = new LineNumbering($xmlWriter, $style->getLineNumbering()); $styleWriter->write(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Shading.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Shading) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:shd'); $xmlWriter->writeAttributeIf(null !== $style->getPattern(), 'w:val', $style->getPattern()); $xmlWriter->writeAttributeIf(null !== $style->getColor(), 'w:color', $style->getColor()); $xmlWriter->writeAttributeIf(null !== $style->getFill(), 'w:fill', $style->getFill()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Shadow.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Shadow) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('v:shadow'); $xmlWriter->writeAttribute('on', 't'); $xmlWriter->writeAttributeIf($style->getColor() !== null, 'color', $style->getColor()); $xmlWriter->writeAttributeIf($style->getOffset() !== null, 'offset', $style->getOffset()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Shape.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Shape) { return; } $xmlWriter = $this->getXmlWriter(); $childStyles = ['Frame', 'Fill', 'Outline', 'Shadow', 'Extrusion']; foreach ($childStyles as $childStyle) { $method = "get{$childStyle}"; $this->writeChildStyle($xmlWriter, $childStyle, $style->$method()); } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Spacing.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Spacing) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:spacing'); $before = $style->getBefore(); $xmlWriter->writeAttributeIf(null !== $before, 'w:before', $this->convertTwip($before)); $after = $style->getAfter(); $xmlWriter->writeAttributeIf(null !== $after, 'w:after', $this->convertTwip($after)); $line = $style->getLine(); //if linerule is auto, the spacing is supposed to include the height of the line itself, which is 240 twips if (null !== $line && 'auto' === $style->getLineRule()) { $line += \PhpOffice\PhpWord\Style\Paragraph::LINE_HEIGHT; } $xmlWriter->writeAttributeIf(null !== $line, 'w:line', $line); $xmlWriter->writeAttributeIf(null !== $line, 'w:lineRule', $style->getLineRule()); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Tab.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\Tab) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:tab'); $xmlWriter->writeAttribute('w:val', $style->getType()); $xmlWriter->writeAttribute('w:leader', $style->getLeader()); $xmlWriter->writeAttribute('w:pos', $this->convertTwip($style->getPosition())); $xmlWriter->endElement(); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/Table.php ================================================ getStyle(); $xmlWriter = $this->getXmlWriter(); if ($style instanceof TableStyle) { $this->writeStyle($xmlWriter, $style); } elseif (is_string($style)) { $xmlWriter->startElement('w:tblPr'); $xmlWriter->startElement('w:tblStyle'); $xmlWriter->writeAttribute('w:val', $style); $xmlWriter->endElement(); if (null !== $this->width) { $this->writeTblWidth($xmlWriter, 'w:tblW', TblWidth::PERCENT, $this->width); } $xmlWriter->endElement(); } } /** * Write full style. */ private function writeStyle(XMLWriter $xmlWriter, TableStyle $style): void { // w:tblPr $xmlWriter->startElement('w:tblPr'); // Table alignment if ('' !== $style->getAlignment()) { $tableAlignment = new TableAlignment($style->getAlignment()); $xmlWriter->startElement($tableAlignment->getName()); foreach ($tableAlignment->getAttributes() as $attributeName => $attributeValue) { $xmlWriter->writeAttribute($attributeName, $attributeValue); } $xmlWriter->endElement(); } $this->writeTblWidth($xmlWriter, 'w:tblW', $style->getUnit(), $style->getWidth()); $this->writeTblWidth($xmlWriter, 'w:tblCellSpacing', TblWidth::TWIP, $style->getCellSpacing()); $this->writeIndent($xmlWriter, $style); $this->writeLayout($xmlWriter, $style->getLayout()); // Position $styleWriter = new TablePosition($xmlWriter, $style->getPosition()); $styleWriter->write(); //Right to left $xmlWriter->writeElementIf($style->isBidiVisual() !== null, 'w:bidiVisual', 'w:val', $this->writeOnOf($style->isBidiVisual())); $this->writeMargin($xmlWriter, $style); $this->writeBorder($xmlWriter, $style); $xmlWriter->endElement(); // w:tblPr $this->writeShading($xmlWriter, $style); // First row style $firstRow = $style->getFirstRow(); if ($firstRow instanceof TableStyle) { $this->writeFirstRow($xmlWriter, $firstRow); } } /** * Enable/Disable automatic resizing of the table. * * @param string $layout autofit / fixed */ private function writeLayout(XMLWriter $xmlWriter, $layout): void { $xmlWriter->startElement('w:tblLayout'); $xmlWriter->writeAttribute('w:type', $layout); $xmlWriter->endElement(); // w:tblLayout } /** * Write margin. */ private function writeMargin(XMLWriter $xmlWriter, TableStyle $style): void { if ($style->hasMargin()) { $xmlWriter->startElement('w:tblCellMar'); $styleWriter = new MarginBorder($xmlWriter); $styleWriter->setSizes($style->getCellMargin()); $styleWriter->write(); $xmlWriter->endElement(); // w:tblCellMar } } /** * Write border. */ private function writeBorder(XMLWriter $xmlWriter, TableStyle $style): void { if ($style->hasBorder()) { $xmlWriter->startElement('w:tblBorders'); $styleWriter = new MarginBorder($xmlWriter); $styleWriter->setSizes($style->getBorderSize()); $styleWriter->setColors($style->getBorderColor()); $styleWriter->write(); $xmlWriter->endElement(); // w:tblBorders } } /** * Writes a table width. * * @param string $elementName * @param string $unit * @param null|float|int $width */ private function writeTblWidth(XMLWriter $xmlWriter, $elementName, $unit, $width = null): void { if (null === $width) { return; } $xmlWriter->startElement($elementName); $xmlWriter->writeAttribute('w:w', $width); $xmlWriter->writeAttribute('w:type', $unit); $xmlWriter->endElement(); } /** * Write row style. */ private function writeFirstRow(XMLWriter $xmlWriter, TableStyle $style): void { $xmlWriter->startElement('w:tblStylePr'); $xmlWriter->writeAttribute('w:type', 'firstRow'); $xmlWriter->startElement('w:tcPr'); $this->writeBorder($xmlWriter, $style); $this->writeShading($xmlWriter, $style); $xmlWriter->endElement(); // w:tcPr $xmlWriter->endElement(); // w:tblStylePr } /** * Write shading. */ private function writeShading(XMLWriter $xmlWriter, TableStyle $style): void { if (null !== $style->getShading()) { $xmlWriter->startElement('w:tcPr'); $styleWriter = new Shading($xmlWriter, $style->getShading()); $styleWriter->write(); $xmlWriter->endElement(); } } /** * Set width. * * @param int $value */ public function setWidth($value = null): void { $this->width = $value; } private function writeIndent(XMLWriter $xmlWriter, TableStyle $style): void { $indent = $style->getIndent(); if ($indent === null) { return; } $this->writeTblWidth($xmlWriter, 'w:tblInd', $indent->getType(), $indent->getValue()); } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/TablePosition.php ================================================ getStyle(); if (!$style instanceof \PhpOffice\PhpWord\Style\TablePosition) { return; } $values = []; $properties = [ 'leftFromText', 'rightFromText', 'topFromText', 'bottomFromText', 'vertAnchor', 'horzAnchor', 'tblpXSpec', 'tblpX', 'tblpYSpec', 'tblpY', ]; foreach ($properties as $property) { $method = 'get' . $property; if (method_exists($style, $method)) { $values[$property] = $style->$method(); } } $values = array_filter($values); if ($values) { $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('w:tblpPr'); foreach ($values as $property => $value) { $xmlWriter->writeAttribute('w:' . $property, $value); } $xmlWriter->endElement(); } } } ================================================ FILE: src/PhpWord/Writer/Word2007/Style/TextBox.php ================================================ getStyle(); if (!$style instanceof TextBoxStyle || !$style->hasInnerMargins()) { return; } $xmlWriter = $this->getXmlWriter(); $margins = implode(', ', $style->getInnerMargin()); $xmlWriter->writeAttribute('inset', $margins); } /** * Writer border. */ public function writeBorder(): void { $style = $this->getStyle(); if (!$style instanceof TextBoxStyle) { return; } $xmlWriter = $this->getXmlWriter(); $xmlWriter->startElement('v:stroke'); $xmlWriter->writeAttributeIf($style->getBorderSize() !== null, 'weight', $style->getBorderSize() . 'pt'); $xmlWriter->writeAttributeIf($style->getBorderColor() !== null, 'color', $style->getBorderColor()); $xmlWriter->endElement(); // v:stroke } } ================================================ FILE: src/PhpWord/Writer/Word2007.php ================================================ [], 'override' => []]; /** * Document relationship. * * @var array */ private $relationships = []; /** * Create new Word2007 writer. */ public function __construct(?PhpWord $phpWord = null) { // Assign PhpWord $this->setPhpWord($phpWord); // Create parts // The first four files need to be in this order for Mimetype detection to work $this->parts = [ 'ContentTypes' => '[Content_Types].xml', 'Rels' => '_rels/.rels', 'RelsDocument' => 'word/_rels/document.xml.rels', 'Document' => 'word/document.xml', 'DocPropsApp' => 'docProps/app.xml', 'DocPropsCore' => 'docProps/core.xml', 'DocPropsCustom' => 'docProps/custom.xml', 'Comments' => 'word/comments.xml', 'Styles' => 'word/styles.xml', 'Numbering' => 'word/numbering.xml', 'Settings' => 'word/settings.xml', 'WebSettings' => 'word/webSettings.xml', 'FontTable' => 'word/fontTable.xml', 'Theme' => 'word/theme/theme1.xml', 'RelsPart' => '', 'Header' => '', 'Footer' => '', 'Footnotes' => '', 'Endnotes' => '', 'Chart' => '', ]; foreach (array_keys($this->parts) as $partName) { $partClass = static::class . '\\Part\\' . $partName; if (class_exists($partClass)) { /** @var Word2007\Part\AbstractPart $part Type hint */ $part = new $partClass(); $part->setParentWriter($this); $this->writerParts[strtolower($partName)] = $part; } } // Set package paths $this->mediaPaths = ['image' => 'word/media/', 'object' => 'word/embeddings/']; } /** * Save document by name. */ public function save(string $filename): void { $filename = $this->getTempFile($filename); $zip = $this->getZipArchive($filename); $phpWord = $this->getPhpWord(); // Content types $this->contentTypes['default'] = [ 'rels' => 'application/vnd.openxmlformats-package.relationships+xml', 'xml' => 'application/xml', ]; // Add section media files $sectionMedia = Media::getElements('section'); if (!empty($sectionMedia)) { $this->addFilesToPackage($zip, $sectionMedia); $this->registerContentTypes($sectionMedia); foreach ($sectionMedia as $element) { $this->relationships[] = $element; } } // Add header/footer media files & relations $this->addHeaderFooterMedia($zip, 'header'); $this->addHeaderFooterMedia($zip, 'footer'); // Add header/footer contents $rId = Media::countElements('section') + 6; //@see Rels::writeDocRels for 6 first elements $sections = $phpWord->getSections(); foreach ($sections as $section) { $this->addHeaderFooterContent($section, $zip, 'header', $rId); $this->addHeaderFooterContent($section, $zip, 'footer', $rId); } $this->addNotes($zip, $rId, 'footnote'); $this->addNotes($zip, $rId, 'endnote'); $this->addComments($zip, $rId); $this->addChart($zip, $rId); // Write parts foreach ($this->parts as $partName => $fileName) { if ($fileName != '') { $zip->addFromString($fileName, $this->getWriterPart($partName)->write()); } } // Close zip archive and cleanup temp file $zip->close(); $this->cleanupTempFile(); } /** * Get content types. * * @return array */ public function getContentTypes() { return $this->contentTypes; } /** * Get content types. * * @return array */ public function getRelationships() { return $this->relationships; } /** * Add header/footer media files, e.g. footer1.xml.rels. * * @param string $docPart */ private function addHeaderFooterMedia(ZipArchive $zip, $docPart): void { $elements = Media::getElements($docPart); if (!empty($elements)) { foreach ($elements as $file => $media) { if (count($media) > 0) { if (!empty($media)) { $this->addFilesToPackage($zip, $media); $this->registerContentTypes($media); } /** @var Word2007\Part\AbstractPart $writerPart Type hint */ $writerPart = $this->getWriterPart('relspart')->setMedia($media); $zip->addFromString("word/_rels/{$file}.xml.rels", $writerPart->write()); } } } } /** * Add header/footer content. * * @param string $elmType header|footer * @param int &$rId */ private function addHeaderFooterContent(Section &$section, ZipArchive $zip, $elmType, &$rId): void { $getFunction = $elmType == 'header' ? 'getHeaders' : 'getFooters'; $elmCount = ($section->getSectionId() - 1) * 3; $elements = $section->$getFunction(); /** @var \PhpOffice\PhpWord\Element\AbstractElement $element Type hint */ foreach ($elements as &$element) { ++$elmCount; $element->setRelationId(++$rId); $elmFile = "{$elmType}{$elmCount}.xml"; // e.g. footer1.xml $this->contentTypes['override']["/word/$elmFile"] = $elmType; $this->relationships[] = ['target' => $elmFile, 'type' => $elmType, 'rID' => $rId]; /** @var Word2007\Part\AbstractPart $writerPart Type hint */ $writerPart = $this->getWriterPart($elmType)->setElement($element); $zip->addFromString("word/$elmFile", $writerPart->write()); } } /** * Add footnotes/endnotes. * * @param int &$rId * @param string $noteType */ private function addNotes(ZipArchive $zip, &$rId, $noteType = 'footnote'): void { $phpWord = $this->getPhpWord(); $noteType = ($noteType == 'endnote') ? 'endnote' : 'footnote'; $partName = "{$noteType}s"; $method = 'get' . ucfirst($partName); $collection = $phpWord->$method(); // Add footnotes media files, relations, and contents if ($collection->countItems() > 0) { $media = Media::getElements($noteType); $this->addFilesToPackage($zip, $media); $this->registerContentTypes($media); $this->contentTypes['override']["/word/{$partName}.xml"] = $partName; $this->relationships[] = ['target' => "{$partName}.xml", 'type' => $partName, 'rID' => ++$rId]; // Write relationships file, e.g. word/_rels/footnotes.xml if (!empty($media)) { /** @var Word2007\Part\AbstractPart $writerPart Type hint */ $writerPart = $this->getWriterPart('relspart')->setMedia($media); $zip->addFromString("word/_rels/{$partName}.xml.rels", $writerPart->write()); } // Write content file, e.g. word/footnotes.xml $writerPart = $this->getWriterPart($partName)->setElements($collection->getItems()); $zip->addFromString("word/{$partName}.xml", $writerPart->write()); } } /** * Add comments. * * @param int &$rId */ private function addComments(ZipArchive $zip, &$rId): void { $phpWord = $this->getPhpWord(); $collection = $phpWord->getComments(); $partName = 'comments'; // Add comment relations and contents if ($collection->countItems() > 0) { $this->relationships[] = ['target' => "{$partName}.xml", 'type' => $partName, 'rID' => ++$rId]; // Write content file, e.g. word/comments.xml $writerPart = $this->getWriterPart($partName)->setElements($collection->getItems()); $zip->addFromString("word/{$partName}.xml", $writerPart->write()); } } /** * Add chart. * * @param int &$rId */ private function addChart(ZipArchive $zip, &$rId): void { $phpWord = $this->getPhpWord(); $collection = $phpWord->getCharts(); $index = 0; if ($collection->countItems() > 0) { /** @var \PhpOffice\PhpWord\Element\Chart $chart */ foreach ($collection->getItems() as $chart) { ++$index; ++$rId; $filename = "charts/chart{$index}.xml"; // ContentTypes.xml $this->contentTypes['override']["/word/{$filename}"] = 'chart'; // word/_rels/document.xml.rel $this->relationships[] = ['target' => $filename, 'type' => 'chart', 'rID' => $rId]; // word/charts/chartN.xml $chart->setRelationId($rId); $writerPart = $this->getWriterPart('Chart'); $writerPart->setElement($chart); $zip->addFromString("word/{$filename}", $writerPart->write()); } } } /** * Register content types for each media. * * @param array $media */ private function registerContentTypes($media): void { foreach ($media as $medium) { $mediumType = $medium['type']; if ($mediumType == 'image') { $extension = $medium['imageExtension']; if (!isset($this->contentTypes['default'][$extension])) { $this->contentTypes['default'][$extension] = $medium['imageType']; } } elseif ($mediumType == 'object') { if (!isset($this->contentTypes['default']['bin'])) { $this->contentTypes['default']['bin'] = 'application/vnd.openxmlformats-officedocument.oleObject'; } } } } } ================================================ FILE: src/PhpWord/Writer/WriterInterface.php ================================================ ['class' => 'PhpOffice\PhpWord\Reader\Word2007\Styles', 'xml' => '{toReplace}'], 'document' => ['class' => 'PhpOffice\PhpWord\Reader\Word2007\Document', 'xml' => '{toReplace}'], 'footnotes' => ['class' => 'PhpOffice\PhpWord\Reader\Word2007\Footnotes', 'xml' => '{toReplace}'], 'endnotes' => ['class' => 'PhpOffice\PhpWord\Reader\Word2007\Endnotes', 'xml' => '{toReplace}'], 'settings' => ['class' => 'PhpOffice\PhpWord\Reader\Word2007\Settings', 'xml' => '{toReplace}'], ]; /** * Builds a PhpWord instance based on the xml passed. * * @return PhpWord */ protected function getDocumentFromString(array $partXmls = []) { $file = __DIR__ . '/_files/temp.docx'; $zip = new ZipArchive(); $zip->open($file, ZipArchive::CREATE | ZipArchive::OVERWRITE); foreach ($this->parts as $partName => $part) { if (array_key_exists($partName, $partXmls)) { $zip->addFromString("{$partName}.xml", str_replace('{toReplace}', $partXmls[$partName], $this->parts[$partName]['xml'])); } } $zip->close(); $phpWord = new PhpWord(); foreach ($this->parts as $partName => $part) { if (array_key_exists($partName, $partXmls)) { $className = $this->parts[$partName]['class']; $reader = new $className($file, "{$partName}.xml"); $reader->read($phpWord); } } unlink($file); return $phpWord; } } ================================================ FILE: tests/PhpWordTests/AbstractWebServerEmbedded.php ================================================ start(); while (!self::$httpServer->isRunning()) { usleep(1000); } } public static function tearDownAfterClass(): void { self::$httpServer->stop(); } protected static function getBaseUrl() { return 'http://localhost:8080'; } protected static function getRemoteImageUrl() { if (self::$httpServer) { return self::getBaseUrl() . '/images/new-php-logo.png'; } return 'http://php.net/images/logos/new-php-logo.png'; } protected static function getRemoteImageUrlWithoutExtension(): string { if (self::$httpServer) { return self::getBaseUrl() . '/images/new-php-logo'; } return 'http://placekitten.com/200/300'; } protected static function getRemoteGifImageUrl() { if (self::$httpServer) { return self::getBaseUrl() . '/images/mario.gif'; } return 'http://php.net/images/logos/php-med-trans-light.gif'; } protected static function getRemoteBmpImageUrl() { if (self::$httpServer) { return self::getBaseUrl() . '/images/duke_nukem.bmp'; } return 'https://samples.libav.org/image-samples/RACECAR.BMP'; } } ================================================ FILE: tests/PhpWordTests/AutoloaderTest.php ================================================ addItem(new Footnote()); // addItem #1 self::assertEquals(1, $object->addItem(new Footnote())); // addItem #2. Should returns new item index self::assertCount(2, $object->getItems()); // getItems returns array self::assertInstanceOf(Footnote::class, $object->getItem(1)); // getItem returns object self::assertNull($object->getItem(3)); // getItem returns null when invalid index is referenced $object->setItem(2, null); // Set item #2 to null self::assertNull($object->getItem(2)); // Check if it's null } public function testCollectionSetItem(): void { $object = new Footnotes(); $object->addItem(new Footnote()); self::assertCount(1, $object->getItems()); $object->setItem(0, new Footnote()); self::assertCount(1, $object->getItems()); } } ================================================ FILE: tests/PhpWordTests/ComplexType/FootnotePropertiesTest.php ================================================ setPos(FootnoteProperties::POSITION_DOC_END); $footnoteProp->setNumFmt(NumberFormat::LOWER_ROMAN); $footnoteProp->setNumStart(2); $footnoteProp->setNumRestart(FootnoteProperties::RESTART_NUMBER_EACH_PAGE); self::assertEquals(FootnoteProperties::POSITION_DOC_END, $footnoteProp->getPos()); self::assertEquals(NumberFormat::LOWER_ROMAN, $footnoteProp->getNumFmt()); self::assertEquals(2, $footnoteProp->getNumStart()); self::assertEquals(FootnoteProperties::RESTART_NUMBER_EACH_PAGE, $footnoteProp->getNumRestart()); } /** * Test throws exception if wrong position given. */ public function testWrongPos(): void { $this->expectException(InvalidArgumentException::class); $footnoteProp = new FootnoteProperties(); $footnoteProp->setPos(NumberFormat::LOWER_ROMAN); } /** * Test throws exception if wrong number format given. */ public function testWrongNumFmt(): void { $this->expectException(InvalidArgumentException::class); $footnoteProp = new FootnoteProperties(); $footnoteProp->setNumFmt(FootnoteProperties::POSITION_DOC_END); } /** * Test throws exception if wrong number restart given. */ public function testWrongNumRestart(): void { $this->expectException(InvalidArgumentException::class); $footnoteProp = new FootnoteProperties(); $footnoteProp->setNumRestart(NumberFormat::LOWER_ROMAN); } } ================================================ FILE: tests/PhpWordTests/ComplexType/ProofStateTest.php ================================================ setGrammar(ProofState::CLEAN); $pState->setSpelling(ProofState::DIRTY); self::assertEquals(ProofState::CLEAN, $pState->getGrammar()); self::assertEquals(ProofState::DIRTY, $pState->getSpelling()); } /** * Test throws exception if wrong grammar proof state value given. */ public function testWrongGrammar(): void { $this->expectException(InvalidArgumentException::class); $pState = new ProofState(); $pState->setGrammar('Wrong'); } /** * Test throws exception if wrong spelling proof state value given. */ public function testWrongSpelling(): void { $this->expectException(InvalidArgumentException::class); $pState = new ProofState(); $pState->setSpelling('Wrong'); } } ================================================ FILE: tests/PhpWordTests/ComplexType/RubyPropertiesTest.php ================================================ getAlignment()); self::assertNotEmpty($properties->getAlignment()); self::assertIsFloat($properties->getFontFaceSize()); self::assertIsFloat($properties->getFontPointsAboveBaseText()); self::assertIsFloat($properties->getFontSizeForBaseText()); self::assertIsString($properties->getLanguageId()); self::assertTrue($properties->getLanguageId() !== ''); } /** * Get/set alignment. */ public function testAlignment(): void { $properties = new RubyProperties(); self::assertIsString($properties->getAlignment()); self::assertNotEmpty($properties->getAlignment()); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); self::assertEquals(RubyProperties::ALIGNMENT_RIGHT_VERTICAL, $properties->getAlignment()); } /** * Set valid alignments. Make sure we can set all valid types - should not throw exception. */ public function testValidAlignments(): void { $properties = new RubyProperties(); $types = [ RubyProperties::ALIGNMENT_CENTER, RubyProperties::ALIGNMENT_DISTRIBUTE_LETTER, RubyProperties::ALIGNMENT_DISTRIBUTE_SPACE, RubyProperties::ALIGNMENT_LEFT, RubyProperties::ALIGNMENT_RIGHT, RubyProperties::ALIGNMENT_RIGHT_VERTICAL, ]; foreach ($types as $type) { $properties->setAlignment($type); self::assertEquals($type, $properties->getAlignment()); } } /** * Test throws exception on invalid alignment type. */ public function testInvalidAlignment(): void { $this->expectException(InvalidArgumentException::class); $properties = new RubyProperties(); $properties->setAlignment('invalid alignment type'); } /** * Get/set font face size. */ public function testFontFaceSize(): void { $properties = new RubyProperties(); self::assertTrue($properties->getFontFaceSize() > 0); $properties->setFontFaceSize(42.42); self::assertEqualsWithDelta(42.42, $properties->getFontFaceSize(), 0.00001); // use delta as it is a float compare self::assertIsFloat($properties->getFontFaceSize()); } /** * Get/set font points above base text. */ public function testFontPointsAboveBaseText(): void { $properties = new RubyProperties(); self::assertTrue($properties->getFontPointsAboveBaseText() > 0); $properties->setFontPointsAboveBaseText(43.42); self::assertEqualsWithDelta(43.42, $properties->getFontPointsAboveBaseText(), 0.00001); // use delta as it is a float compare self::assertIsFloat($properties->getFontPointsAboveBaseText()); } /** * Get/set font size for base text. */ public function testFontSizeForBaseText(): void { $properties = new RubyProperties(); self::assertTrue($properties->getFontSizeForBaseText() > 0); $properties->setFontSizeForBaseText(45.42); self::assertEqualsWithDelta(45.42, $properties->getFontSizeForBaseText(), 0.00001); // use delta as it is a float compare self::assertIsFloat($properties->getFontSizeForBaseText()); } /** * Get/set language id. */ public function testLanguageId(): void { $properties = new RubyProperties(); self::assertNotEmpty($properties->getLanguageId()); $properties->setLanguageId('en-US'); self::assertIsString($properties->getLanguageId()); self::assertEquals('en-US', $properties->getLanguageId()); } } ================================================ FILE: tests/PhpWordTests/Element/AbstractElementTest.php ================================================ getMockForAbstractClass(AbstractElement::class); } else { /** @var AbstractElement $stub */ $stub = new class() extends AbstractElement { }; } $ival = mt_rand(0, 100); $stub->setElementIndex($ival); self::assertEquals($ival, $stub->getElementIndex()); } /** * Test set/get element unique Id. */ public function testElementId(): void { // @phpstan-ignore-next-line if (method_exists($this, 'getMockForAbstractClass')) { $stub = $this->getMockForAbstractClass(AbstractElement::class); } else { /** @var AbstractElement $stub */ $stub = new class() extends AbstractElement { }; } $stub->setElementId(); self::assertEquals(6, strlen($stub->getElementId())); } } ================================================ FILE: tests/PhpWordTests/Element/BookmarkTest.php ================================================ getName()); } } ================================================ FILE: tests/PhpWordTests/Element/CellTest.php ================================================ getWidth()); } /** * New instance with array. */ public function testConstructWithStyleArray(): void { $oCell = new Cell(null, ['valign' => 'center']); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Cell', $oCell->getStyle()); self::assertNull($oCell->getWidth()); } /** * Add text. */ public function testAddText(): void { $oCell = new Cell(); $element = $oCell->addText('text'); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); } /** * Add non-UTF8. */ public function testAddTextNotUTF8(): void { $oCell = new Cell(); $element = $oCell->addText(utf8decode('ééé')); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertEquals('ééé', $element->getText()); } /** * Add link. */ public function testAddLink(): void { $oCell = new Cell(); $element = $oCell->addLink(utf8decode('ééé'), utf8decode('ééé')); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Link', $element); } /** * Add text break. */ public function testAddTextBreak(): void { $oCell = new Cell(); $oCell->addTextBreak(); self::assertCount(1, $oCell->getElements()); } /** * Add list item. */ public function testAddListItem(): void { $oCell = new Cell(); $element = $oCell->addListItem('text'); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\ListItem', $element); self::assertEquals('text', $element->getTextObject()->getText()); } /** * Add list item non-UTF8. */ public function testAddListItemNotUTF8(): void { $oCell = new Cell(); $element = $oCell->addListItem(utf8decode('ééé')); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\ListItem', $element); self::assertEquals('ééé', $element->getTextObject()->getText()); } /** * Add image section. */ public function testAddImageSection(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oCell = new Cell(); $element = $oCell->addImage($src); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add image header. */ public function testAddImageHeader(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oCell = new Cell('header', 1); $element = $oCell->addImage($src); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add image footer. */ public function testAddImageFooter(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oCell = new Cell('footer', 1); $element = $oCell->addImage($src); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add image section by URL. */ public function testAddImageSectionByUrl(): void { $oCell = new Cell(); $element = $oCell->addImage(self::getRemoteGifImageUrl()); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add object. */ public function testAddObjectXLS(): void { $src = __DIR__ . '/../_files/documents/sheet.xls'; $oCell = new Cell(); $element = $oCell->addObject($src); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\OLEObject', $element); } /** * Test add object exception. */ public function testAddObjectException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidObjectException::class); $src = __DIR__ . '/../_files/xsl/passthrough.xsl'; $oCell = new Cell(); $oCell->addObject($src); } /** * Add preserve text. */ public function testAddPreserveText(): void { $oCell = new Cell(); $oCell->setDocPart('Header', 1); $element = $oCell->addPreserveText('text'); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\PreserveText', $element); } /** * Add preserve text non-UTF8. */ public function testAddPreserveTextNotUTF8(): void { $oCell = new Cell(); $oCell->setDocPart('Header', 1); $element = $oCell->addPreserveText(utf8decode('ééé')); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\PreserveText', $element); self::assertEquals(['ééé'], $element->getText()); } /** * Add preserve text exception. */ public function testAddPreserveTextException(): void { $this->expectException(BadMethodCallException::class); $oCell = new Cell(); $oCell->setDocPart('TextRun', 1); $oCell->addPreserveText('text'); } /** * Add text run. */ public function testCreateTextRun(): void { $oCell = new Cell(); $element = $oCell->addTextRun(); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\TextRun', $element); } /** * Add check box. */ public function testAddCheckBox(): void { $oCell = new Cell(); $element = $oCell->addCheckBox(utf8decode('ééé'), utf8decode('ééé')); self::assertCount(1, $oCell->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\CheckBox', $element); } /** * Get elements. */ public function testGetElements(): void { $oCell = new Cell(); self::assertIsArray($oCell->getElements()); } } ================================================ FILE: tests/PhpWordTests/Element/CheckBoxTest.php ================================================ getText()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $oCheckBox->getFontStyle()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oCheckBox->getParagraphStyle()); } /** * Get name and text. */ public function testCheckBox(): void { $oCheckBox = new CheckBox('chkBox', 'CheckBox'); self::assertEquals('chkBox', $oCheckBox->getName()); self::assertEquals('CheckBox', $oCheckBox->getText()); } /** * Get font style. */ public function testFont(): void { $oCheckBox = new CheckBox('chkBox', 'CheckBox', 'fontStyle'); self::assertEquals('fontStyle', $oCheckBox->getFontStyle()); $oCheckBox->setFontStyle(['bold' => true, 'italic' => true, 'size' => 16]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $oCheckBox->getFontStyle()); } /** * Font style as object. */ public function testFontObject(): void { $font = new Font(); $oCheckBox = new CheckBox('chkBox', 'CheckBox', $font); self::assertEquals($font, $oCheckBox->getFontStyle()); } /** * Get paragraph style. */ public function testParagraph(): void { $oCheckBox = new CheckBox('chkBox', 'CheckBox', 'fontStyle', 'paragraphStyle'); self::assertEquals('paragraphStyle', $oCheckBox->getParagraphStyle()); $oCheckBox->setParagraphStyle(['alignment' => Jc::CENTER, 'spaceAfter' => 100]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oCheckBox->getParagraphStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/CommentTest.php ================================================ setStartElement($oText); $oComment->setEndElement($oText); self::assertEquals($author, $oComment->getAuthor()); self::assertEquals($date, $oComment->getDate()); self::assertEquals($initials, $oComment->getInitials()); self::assertEquals($oText, $oComment->getStartElement()); self::assertEquals($oText, $oComment->getEndElement()); } /** * Two comments on same text. */ public function testTwoCommentsOnSameText(): void { $section = new Section(0); $text = $section->addText('Text'); $comment1 = new Comment('Author1', new DateTime(), 'A1'); $comment1->addText('Comment1'); $comment2 = new Comment('Author2', new DateTime(), 'A2'); $comment2->addText('Comment2'); $comment1->setStartElement($text); $comment2->setStartElement($text); $text->setCommentRangeStart($comment1); $text->setCommentRangeEnd($comment1); $text->setCommentRangeStart($comment2); $text->setCommentRangeEnd($comment2); self::assertEquals(2, $text->getCommentsRangeStart()->countItems()); self::assertEquals(2, $text->getCommentsRangeEnd()->countItems()); self::assertEquals($text->getCommentsRangeStart()->getItem(0)->getElementId(), $comment1->getElementId()); self::assertEquals($text->getCommentsRangeEnd()->getItem(0)->getElementId(), $comment1->getElementId()); self::assertEquals($text->getCommentsRangeStart()->getItem(1)->getElementId(), $comment2->getElementId()); self::assertEquals($text->getCommentsRangeEnd()->getItem(1)->getElementId(), $comment2->getElementId()); } /** * Add text. */ public function testAddText(): void { $oComment = new Comment('Test User', new DateTime(), 'my_initials'); $element = $oComment->addText('text'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oComment->getElements()); self::assertEquals('text', $element->getText()); } /** * Get elements. */ public function testGetElements(): void { $oComment = new Comment('Test User', new DateTime(), 'my_initials'); self::assertIsArray($oComment->getElements()); } /** * Set/get relation Id. */ public function testRelationId(): void { $oComment = new Comment('Test User', new DateTime(), 'my_initials'); $iVal = mt_rand(1, 1000); $oComment->setRelationId($iVal); self::assertEquals($iVal, $oComment->getRelationId()); } public function testExceptionOnCommentStartOnComment(): void { $this->expectException(InvalidArgumentException::class); $dummyComment = new Comment('Test User', new DateTime(), 'my_initials'); $oComment = new Comment('Test User', new DateTime(), 'my_initials'); $oComment->setCommentRangeStart($dummyComment); } public function testExceptionOnCommentEndOnComment(): void { $this->expectException(InvalidArgumentException::class); $dummyComment = new Comment('Test User', new DateTime(), 'my_initials'); $oComment = new Comment('Test User', new DateTime(), 'my_initials'); $oComment->setCommentRangeEnd($dummyComment); } } ================================================ FILE: tests/PhpWordTests/Element/FieldTest.php ================================================ getType()); } /** * New instance with type and properties. */ public function testConstructWithTypeProperties(): void { $oField = new Field('DATE', ['dateformat' => 'd-M-yyyy']); self::assertEquals('DATE', $oField->getType()); self::assertEquals(['dateformat' => 'd-M-yyyy'], $oField->getProperties()); } /** * New instance with type and properties and options. */ public function testConstructWithTypePropertiesOptions(): void { $oField = new Field('DATE', ['dateformat' => 'd-M-yyyy'], ['SakaEraCalendar', 'PreserveFormat']); self::assertEquals('DATE', $oField->getType()); self::assertEquals(['dateformat' => 'd-M-yyyy'], $oField->getProperties()); self::assertEquals(['SakaEraCalendar', 'PreserveFormat'], $oField->getOptions()); } /** * New instance with type and properties and options and text. */ public function testConstructWithTypePropertiesOptionsText(): void { $oField = new Field('XE', [], ['Bold', 'Italic'], 'FieldValue'); self::assertEquals('XE', $oField->getType()); self::assertEquals([], $oField->getProperties()); self::assertEquals(['Bold', 'Italic'], $oField->getOptions()); self::assertEquals('FieldValue', $oField->getText()); } /** * New instance with type and properties and options and text as TextRun. */ public function testConstructWithTypePropertiesOptionsTextAsTextRun(): void { $textRun = new TextRun(); $textRun->addText('test string'); $oField = new Field('XE', [], ['Bold', 'Italic'], $textRun); self::assertEquals('XE', $oField->getType()); self::assertEquals([], $oField->getProperties()); self::assertEquals(['Bold', 'Italic'], $oField->getOptions()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\TextRun', $oField->getText()); } public function testConstructWithOptionValue(): void { $oField = new Field('INDEX', [], ['\\c "3" \\h "A"']); self::assertEquals('INDEX', $oField->getType()); self::assertEquals([], $oField->getProperties()); self::assertEquals(['\\c "3" \\h "A"'], $oField->getOptions()); } /** * Test setType exception. */ public function testSetTypeException(): void { $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessage('Invalid type'); $object = new Field(); $object->setType('foo'); } /** * Test setProperties exception. */ public function testSetPropertiesException(): void { $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessage('Invalid property'); $object = new Field('PAGE'); $object->setProperties(['foo' => 'bar']); } /** * Test setOptions exception. */ public function testSetOptionsException(): void { $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessage('Invalid option'); $object = new Field('PAGE'); $object->setOptions(['foo' => 'bar']); } /** * Test setText exception. */ public function testSetTextException(): void { $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessage('Invalid text'); $object = new Field('XE'); $object->setText([]); } } ================================================ FILE: tests/PhpWordTests/Element/FooterTest.php ================================================ getSectionId()); } /** * Add text. */ public function testAddText(): void { $oFooter = new Footer(1); $element = $oFooter->addText('text'); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); } /** * Add text non-UTF8. */ public function testAddTextNotUTF8(): void { $oFooter = new Footer(1); $element = $oFooter->addText(utf8decode('ééé')); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertEquals('ééé', $element->getText()); } /** * Add text break. */ public function testAddTextBreak(): void { $oFooter = new Footer(1); $iVal = mt_rand(1, 1000); $oFooter->addTextBreak($iVal); self::assertCount($iVal, $oFooter->getElements()); } /** * Add text run. */ public function testCreateTextRun(): void { $oFooter = new Footer(1); $element = $oFooter->addTextRun(); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\TextRun', $element); } /** * Add table. */ public function testAddTable(): void { $oFooter = new Footer(1); $element = $oFooter->addTable(); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Table', $element); } /** * Add image. */ public function testAddImage(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oFooter = new Footer(1); $element = $oFooter->addImage($src); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add image by URL. */ public function testAddImageByUrl(): void { $oFooter = new Footer(1); $element = $oFooter->addImage(self::getRemoteGifImageUrl()); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add preserve text. */ public function testAddPreserveText(): void { $oFooter = new Footer(1); $element = $oFooter->addPreserveText('text'); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\PreserveText', $element); } /** * Add preserve text non-UTF8. */ public function testAddPreserveTextNotUTF8(): void { $oFooter = new Footer(1); $element = $oFooter->addPreserveText(utf8decode('ééé')); self::assertCount(1, $oFooter->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\PreserveText', $element); self::assertEquals(['ééé'], $element->getText()); } /** * Get elements. */ public function testGetElements(): void { $oFooter = new Footer(1); self::assertIsArray($oFooter->getElements()); } /** * Set/get relation Id. */ public function testRelationID(): void { $oFooter = new Footer(0); $iVal = mt_rand(1, 1000); $oFooter->setRelationId($iVal); self::assertEquals($iVal, $oFooter->getRelationId()); self::assertEquals(Footer::AUTO, $oFooter->getType()); } } ================================================ FILE: tests/PhpWordTests/Element/FootnoteTest.php ================================================ getElements()); self::assertNull($oFootnote->getParagraphStyle()); } /** * New instance with string parameter. */ public function testConstructString(): void { $oFootnote = new Footnote('pStyle'); self::assertEquals('pStyle', $oFootnote->getParagraphStyle()); } /** * New instance with array parameter. */ public function testConstructArray(): void { $oFootnote = new Footnote(['spacing' => 100]); self::assertInstanceOf( 'PhpOffice\\PhpWord\\Style\\Paragraph', $oFootnote->getParagraphStyle() ); } /** * Add text element. */ public function testAddText(): void { $oFootnote = new Footnote(); $element = $oFootnote->addText('text'); self::assertCount(1, $oFootnote->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); } /** * Add text break element. */ public function testAddTextBreak(): void { $oFootnote = new Footnote(); $oFootnote->addTextBreak(2); self::assertCount(2, $oFootnote->getElements()); } /** * Add link element. */ public function testAddLink(): void { $oFootnote = new Footnote(); $element = $oFootnote->addLink('https://github.com/PHPOffice/PHPWord'); self::assertCount(1, $oFootnote->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Link', $element); } /** * Set/get reference Id. */ public function testReferenceId(): void { $oFootnote = new Footnote(); $iVal = mt_rand(1, 1000); $oFootnote->setRelationId($iVal); self::assertEquals($iVal, $oFootnote->getRelationId()); } /** * Get elements. */ public function testGetElements(): void { $oFootnote = new Footnote(); self::assertIsArray($oFootnote->getElements()); } } ================================================ FILE: tests/PhpWordTests/Element/FormulaTest.php ================================================ add(new Element\Fraction( new Element\Numeric(2), new Element\Identifier('π') )); $element = new Formula(new Math()); self::assertEquals(new Math(), $element->getMath()); self::assertNotEquals($math, $element->getMath()); $element->setMath($math); self::assertNotEquals(new Math(), $element->getMath()); self::assertEquals($math, $element->getMath()); } } ================================================ FILE: tests/PhpWordTests/Element/HeaderTest.php ================================================ getSectionId()); self::assertEquals(Header::AUTO, $oHeader->getType()); } /** * Add text. */ public function testAddText(): void { $oHeader = new Header(1); $element = $oHeader->addText('text'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oHeader->getElements()); self::assertEquals('text', $element->getText()); } /** * Add text non-UTF8. */ public function testAddTextNotUTF8(): void { $oHeader = new Header(1); $element = $oHeader->addText(utf8decode('ééé')); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oHeader->getElements()); self::assertEquals('ééé', $element->getText()); } /** * Add text break. */ public function testAddTextBreak(): void { $oHeader = new Header(1); $oHeader->addTextBreak(); self::assertCount(1, $oHeader->getElements()); } /** * Add text break with params. */ public function testAddTextBreakWithParams(): void { $oHeader = new Header(1); $iVal = mt_rand(1, 1000); $oHeader->addTextBreak($iVal); self::assertCount($iVal, $oHeader->getElements()); } /** * Add text run. */ public function testCreateTextRun(): void { $oHeader = new Header(1); $element = $oHeader->addTextRun(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\TextRun', $element); self::assertCount(1, $oHeader->getElements()); } /** * Add table. */ public function testAddTable(): void { $oHeader = new Header(1); $element = $oHeader->addTable(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Table', $element); self::assertCount(1, $oHeader->getElements()); } /** * Add image. */ public function testAddImage(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oHeader = new Header(1); $element = $oHeader->addImage($src); self::assertCount(1, $oHeader->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add image by URL. */ public function testAddImageByUrl(): void { $oHeader = new Header(1); $element = $oHeader->addImage(self::getRemoteGifImageUrl()); self::assertCount(1, $oHeader->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Add preserve text. */ public function testAddPreserveText(): void { $oHeader = new Header(1); $element = $oHeader->addPreserveText('text'); self::assertCount(1, $oHeader->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\PreserveText', $element); } /** * Add preserve text non-UTF8. */ public function testAddPreserveTextNotUTF8(): void { $oHeader = new Header(1); $element = $oHeader->addPreserveText(utf8decode('ééé')); self::assertCount(1, $oHeader->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\PreserveText', $element); self::assertEquals(['ééé'], $element->getText()); } /** * Add watermark. */ public function testAddWatermark(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oHeader = new Header(1); $element = $oHeader->addWatermark($src); self::assertCount(1, $oHeader->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); } /** * Get elements. */ public function testGetElements(): void { $oHeader = new Header(1); self::assertIsArray($oHeader->getElements()); } /** * Set/get relation Id. */ public function testRelationId(): void { $oHeader = new Header(1); $iVal = mt_rand(1, 1000); $oHeader->setRelationId($iVal); self::assertEquals($iVal, $oHeader->getRelationId()); } /** * Reset type. */ public function testResetType(): void { $oHeader = new Header(1); $oHeader->firstPage(); $oHeader->resetType(); self::assertEquals(Header::AUTO, $oHeader->getType()); } /** * First page. */ public function testFirstPage(): void { $oHeader = new Header(1); $oHeader->firstPage(); self::assertEquals(Header::FIRST, $oHeader->getType()); } /** * Even page. */ public function testEvenPage(): void { $oHeader = new Header(1); $oHeader->evenPage(); self::assertEquals(Header::EVEN, $oHeader->getType()); } /** * Add footnote exception. */ public function testAddFootnoteException(): void { $this->expectException(BadMethodCallException::class); $header = new Header(1); $header->addFootnote(); } /** * Set/get type. */ public function testSetGetType(): void { $object = new Header(1); self::assertEquals(Header::AUTO, $object->getType()); $object->setType('ODD'); self::assertEquals(Header::AUTO, $object->getType()); } } ================================================ FILE: tests/PhpWordTests/Element/ImageTest.php ================================================ getSource()); self::assertEquals(md5($src), $oImage->getMediaId()); self::assertFalse($oImage->isWatermark()); self::assertEquals(Image::SOURCE_LOCAL, $oImage->getSourceType()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oImage->getStyle()); } /** * New instance with style. */ public function testConstructWithStyle(): void { $src = __DIR__ . '/../_files/images/firefox.png'; $oImage = new Image( $src, [ 'width' => 210, 'height' => 210, 'alignment' => Jc::CENTER, 'wrappingStyle' => \PhpOffice\PhpWord\Style\Image::WRAPPING_STYLE_BEHIND, ] ); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oImage->getStyle()); } /** * Valid image types. * * @dataProvider providerImages */ public function testImages($source, $type, $extension, $createFunction, $imageFunction, $imageQuality): void { $nam = ucfirst((string) strtok($source, '.')); $source = __DIR__ . "/../_files/images/{$source}"; $image = new Image($source, null, null, $nam); self::assertEquals($source, $image->getSource()); self::assertEquals($nam, $image->getName()); self::assertEquals(md5($source), $image->getMediaId()); self::assertEquals($type, $image->getImageType()); self::assertEquals($extension, $image->getImageExtension()); self::assertEquals($createFunction, $image->getImageCreateFunction()); if ($imageFunction) { self::assertNotNull($image->getImageFunction()); } else { self::assertNull($image->getImageFunction()); } self::assertEquals($imageQuality, $image->getImageQuality()); self::assertFalse($image->isMemImage()); self::assertNotNull($image->getImageStringData()); } public static function providerImages(): array { return [ ['mars.jpg', 'image/jpeg', 'jpg', 'imagecreatefromjpeg', true, 100], ['mario.gif', 'image/gif', 'gif', 'imagecreatefromgif', true, null], ['firefox.png', 'image/png', 'png', 'imagecreatefrompng', true, -1], ['duke_nukem.bmp', 'image/bmp', 'bmp', null, false, null], ['angela_merkel.tif', 'image/tiff', 'tif', null, false, null], ]; } /** * Get style. */ public function testStyle(): void { $oImage = new Image( __DIR__ . '/../_files/images/earth.jpg', ['height' => 210, 'alignment' => Jc::CENTER] ); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oImage->getStyle()); } /** * Test invalid local image. */ public function testInvalidImageLocal(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidImageException::class); new Image(__DIR__ . '/../_files/images/thisisnotarealimage'); } /** * Test invalid PHP Image. */ public function testInvalidImagePhp(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidImageException::class); $object = new Image('test.php'); $source = $object->getSource(); } /** * Test unsupported image. */ public function testUnsupportedImage(): void { $this->expectException(\PhpOffice\PhpWord\Exception\UnsupportedImageTypeException::class); //disable ssl verification, never do this in real application, you should pass the certificiate instead!!! $arrContextOptions = [ 'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false, ], ]; stream_context_set_default($arrContextOptions); $object = new Image(self::getRemoteBmpImageUrl()); $source = $object->getSource(); } /** * Get relation Id. */ public function testRelationID(): void { $oImage = new Image(__DIR__ . '/../_files/images/earth.jpg', ['width' => 100]); $iVal = mt_rand(1, 1000); $oImage->setRelationId($iVal); self::assertEquals($iVal, $oImage->getRelationId()); } /** * Test archived image. */ public function testArchivedImage(): void { $archiveFile = __DIR__ . '/../_files/documents/reader.docx'; $imageFile = 'word/media/image1.jpeg'; $image = new Image("zip://{$archiveFile}#{$imageFile}"); self::assertEquals('image/jpeg', $image->getImageType()); } /** * Test getting image as string. */ public function testImageAsStringFromFile(): void { $image = new Image(__DIR__ . '/../_files/images/earth.jpg'); self::assertNotNull($image->getImageStringData()); self::assertNotNull($image->getImageStringData(true)); } /** * Test getting image from zip as string. */ public function testImageAsStringFromZip(): void { $archiveFile = __DIR__ . '/../_files/documents/reader.docx'; $imageFile = 'word/media/image1.jpeg'; $image = new Image("zip://{$archiveFile}#{$imageFile}"); self::assertNotNull($image->getImageStringData()); self::assertNotNull($image->getImageStringData(true)); } /** * Test construct from string. */ public function testConstructFromString(): void { $source = file_get_contents(__DIR__ . '/../_files/images/earth.jpg'); $image = new Image($source); self::assertEquals($source, $image->getSource()); self::assertEquals(md5((string) $source), $image->getMediaId()); self::assertEquals('image/jpeg', $image->getImageType()); self::assertEquals('jpg', $image->getImageExtension()); self::assertEquals('imagecreatefromstring', $image->getImageCreateFunction()); self::assertNotNull($image->getImageFunction()); self::assertEquals(100, $image->getImageQuality()); self::assertTrue($image->isMemImage()); self::assertNotNull($image->getImageStringData()); self::assertNotNull($image->getImageStringData(true)); } /** * Test construct from GD. */ public function testConstructFromGd(): void { $source = self::getRemoteImageUrl(); $image = new Image($source); self::assertEquals($source, $image->getSource()); self::assertEquals(md5($source), $image->getMediaId()); self::assertEquals('image/png', $image->getImageType()); self::assertEquals('png', $image->getImageExtension()); self::assertEquals('imagecreatefrompng', $image->getImageCreateFunction()); self::assertNotNull($image->getImageFunction()); self::assertEquals(-1, $image->getImageQuality()); self::assertTrue($image->isMemImage()); self::assertNotNull($image->getImageStringData()); self::assertNotNull($image->getImageStringData(true)); } /** * Test invalid string image. */ public function testInvalidImageString(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidImageException::class); $object = new Image('this_is-a_non_valid_image'); $source = $object->getSource(); } } ================================================ FILE: tests/PhpWordTests/Element/LineTest.php ================================================ getStyle()); } /** * Get style name. */ public function testStyleText(): void { $oLine = new Line('lineStyle'); self::assertEquals('lineStyle', $oLine->getStyle()); } /** * Get style array. */ public function testStyleArray(): void { $oLine = new Line( [ 'width' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(14), 'height' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(4), 'positioning' => 'absolute', 'posHorizontalRel' => 'page', 'posVerticalRel' => 'page', 'flip' => true, 'marginLeft' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(5), 'marginTop' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(3), 'wrappingStyle' => \PhpOffice\PhpWord\Style\Image::WRAPPING_STYLE_SQUARE, 'beginArrow' => \PhpOffice\PhpWord\Style\Line::ARROW_STYLE_BLOCK, 'endArrow' => \PhpOffice\PhpWord\Style\Line::ARROW_STYLE_OVAL, 'dash' => \PhpOffice\PhpWord\Style\Line::DASH_STYLE_LONG_DASH_DOT_DOT, 'weight' => 10, ] ); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Line', $oLine->getStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/LinkTest.php ================================================ getSource()); self::assertEquals($oLink->getSource(), $oLink->getText()); self::assertNull($oLink->getFontStyle()); self::assertNull($oLink->getParagraphStyle()); } /** * Create new instance with array. */ public function testConstructWithParamsArray(): void { $oLink = new Link( 'https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub', ['color' => '0000FF', 'underline' => Font::UNDERLINE_SINGLE], ['marginLeft' => 600, 'marginRight' => 600, 'marginTop' => 600, 'marginBottom' => 600] ); self::assertEquals('https://github.com/PHPOffice/PHPWord', $oLink->getSource()); self::assertEquals('PHPWord on GitHub', $oLink->getText()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $oLink->getFontStyle()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oLink->getParagraphStyle()); } /** * Create new instance with style name string. */ public function testConstructWithParamsString(): void { $oLink = new Link('https://github.com/PHPOffice/PHPWord', null, 'fontStyle', 'paragraphStyle'); self::assertEquals('fontStyle', $oLink->getFontStyle()); self::assertEquals('paragraphStyle', $oLink->getParagraphStyle()); } /** * Set/get relation Id. */ public function testRelationId(): void { $oLink = new Link('https://github.com/PHPOffice/PHPWord'); $iVal = mt_rand(1, 1000); $oLink->setRelationId($iVal); self::assertEquals($iVal, $oLink->getRelationId()); } } ================================================ FILE: tests/PhpWordTests/Element/ListItemRunTest.php ================================================ getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oListItemRun->getParagraphStyle()); } /** * New instance with string. */ public function testConstructString(): void { $oListItemRun = new ListItemRun(0, null, 'pStyle'); self::assertCount(0, $oListItemRun->getElements()); self::assertEquals('pStyle', $oListItemRun->getParagraphStyle()); } /** * New instance with string. */ public function testConstructListString(): void { $oListItemRun = new ListItemRun(0, 'numberingStyle'); self::assertCount(0, $oListItemRun->getElements()); } /** * New instance with array. */ public function testConstructArray(): void { $oListItemRun = new ListItemRun(0, null, ['spacing' => 100]); self::assertCount(0, $oListItemRun->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oListItemRun->getParagraphStyle()); } /** * Get style. */ public function testStyle(): void { $oListItemRun = new ListItemRun(1, ['listType' => \PhpOffice\PhpWord\Style\ListItem::TYPE_NUMBER]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\ListItem', $oListItemRun->getStyle()); self::assertEquals(\PhpOffice\PhpWord\Style\ListItem::TYPE_NUMBER, $oListItemRun->getStyle()->getListType()); } /** * getDepth. */ public function testDepth(): void { $iVal = mt_rand(1, 1000); $oListItemRun = new ListItemRun($iVal); self::assertEquals($iVal, $oListItemRun->getDepth()); } /** * Add text. */ public function testAddText(): void { $oListItemRun = new ListItemRun(); $element = $oListItemRun->addText('text'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oListItemRun->getElements()); self::assertEquals('text', $element->getText()); } /** * Add text non-UTF8. */ public function testAddTextNotUTF8(): void { $oListItemRun = new ListItemRun(); $element = $oListItemRun->addText(utf8decode('ééé')); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oListItemRun->getElements()); self::assertEquals('ééé', $element->getText()); } /** * Add link. */ public function testAddLink(): void { $oListItemRun = new ListItemRun(); $element = $oListItemRun->addLink('https://github.com/PHPOffice/PHPWord'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Link', $element); self::assertCount(1, $oListItemRun->getElements()); self::assertEquals('https://github.com/PHPOffice/PHPWord', $element->getSource()); } /** * Add link with name. */ public function testAddLinkWithName(): void { $oListItemRun = new ListItemRun(); $element = $oListItemRun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Link', $element); self::assertCount(1, $oListItemRun->getElements()); self::assertEquals('https://github.com/PHPOffice/PHPWord', $element->getSource()); self::assertEquals('PHPWord on GitHub', $element->getText()); } /** * Add text break. */ public function testAddTextBreak(): void { $oListItemRun = new ListItemRun(); $oListItemRun->addTextBreak(2); self::assertCount(2, $oListItemRun->getElements()); } /** * Add image. */ public function testAddImage(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oListItemRun = new ListItemRun(); $element = $oListItemRun->addImage($src); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); self::assertCount(1, $oListItemRun->getElements()); } } ================================================ FILE: tests/PhpWordTests/Element/ListItemTest.php ================================================ getTextObject()); } /** * Get style. */ public function testStyle(): void { $oListItem = new ListItem('text', 1, null, ['listType' => \PhpOffice\PhpWord\Style\ListItem::TYPE_NUMBER]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\ListItem', $oListItem->getStyle()); self::assertEquals(\PhpOffice\PhpWord\Style\ListItem::TYPE_NUMBER, $oListItem->getStyle()->getListType()); } /** * Get depth. */ public function testDepth(): void { $iVal = mt_rand(1, 1000); $oListItem = new ListItem('text', $iVal); self::assertEquals($iVal, $oListItem->getDepth()); } } ================================================ FILE: tests/PhpWordTests/Element/ObjectTest.php ================================================ getStyle()); self::assertEquals($src, $oObject->getSource()); } /** * Create new instance with supported files. */ public function testConstructWithSupportedFilesLong(): void { $src = __DIR__ . '/../_files/documents/sheet.xls'; $oObject = new OLEObject($src); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oObject->getStyle()); self::assertEquals($src, $oObject->getSource()); } /** * Create new instance with non-supported files. */ public function testConstructWithNotSupportedFiles(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidObjectException::class); $src = __DIR__ . '/../_files/xsl/passthrough.xsl'; $oObject = new OLEObject($src); $source = $oObject->getSource(); } /** * Create with style. */ public function testConstructWithSupportedFilesAndStyle(): void { $src = __DIR__ . '/../_files/documents/sheet.xls'; $oObject = new OLEObject($src, ['width' => '230px']); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Image', $oObject->getStyle()); self::assertEquals($src, $oObject->getSource()); } /** * Set/get relation Id. */ public function testRelationId(): void { $src = __DIR__ . '/../_files/documents/sheet.xls'; $oObject = new OLEObject($src); $iVal = mt_rand(1, 1000); $oObject->setRelationId($iVal); self::assertEquals($iVal, $oObject->getRelationId()); } /** * Set/get image relation Id. */ public function testImageRelationId(): void { $src = __DIR__ . '/../_files/documents/sheet.xls'; $oObject = new OLEObject($src); $iVal = mt_rand(1, 1000); $oObject->setImageRelationId($iVal); self::assertEquals($iVal, $oObject->getImageRelationId()); } } ================================================ FILE: tests/PhpWordTests/Element/PreserveTextTest.php ================================================ getText()); self::assertNull($oPreserveText->getFontStyle()); self::assertNull($oPreserveText->getParagraphStyle()); } /** * Create new instance with style name. */ public function testConstructWithString(): void { $oPreserveText = new PreserveText('text', 'styleFont', 'styleParagraph'); self::assertEquals(['text'], $oPreserveText->getText()); self::assertEquals('styleFont', $oPreserveText->getFontStyle()); self::assertEquals('styleParagraph', $oPreserveText->getParagraphStyle()); } /** * Create new instance with array. */ public function testConstructWithArray(): void { $oPreserveText = new PreserveText('text', ['size' => 16, 'color' => '1B2232'], ['alignment' => Jc::CENTER]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $oPreserveText->getFontStyle()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oPreserveText->getParagraphStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/RowTest.php ================================================ getHeight()); self::assertIsArray($oRow->getCells()); self::assertCount(0, $oRow->getCells()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Row', $oRow->getStyle()); } /** * Create new instance with parameters. */ public function testConstructWithParams(): void { $iVal = mt_rand(1, 1000); $oRow = new Row($iVal, ['borderBottomSize' => 18, 'borderBottomColor' => '0000FF', 'bgColor' => '66BBFF']); self::assertEquals($iVal, $oRow->getHeight()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Row', $oRow->getStyle()); } /** * Add cell. */ public function testAddCell(): void { $oRow = new Row(); $element = $oRow->addCell(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Cell', $element); self::assertCount(1, $oRow->getCells()); } } ================================================ FILE: tests/PhpWordTests/Element/RubyTest.php ================================================ getBaseTextRun()->getText()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $ruby->getBaseTextRun()->getParagraphStyle()); self::assertEquals('', $ruby->getRubyTextRun()->getText()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $ruby->getRubyTextRun()->getParagraphStyle()); self::assertEquals(RubyProperties::ALIGNMENT_DISTRIBUTE_SPACE, $ruby->getProperties()->getAlignment()); } /** * Get/set base text. */ public function testBaseText(): void { $ruby = new Ruby(new TextRun(), new TextRun(), new RubyProperties()); self::assertEquals('', $ruby->getBaseTextRun()->getText()); $tr = new TextRun(); $tr->addText('Hello, world'); $ruby->setBaseTextRun($tr); self::assertEquals('Hello, world', $ruby->getBaseTextRun()->getText()); } /** * Get/set ruby text. */ public function testRubyText(): void { $ruby = new Ruby(new TextRun(), new TextRun(), new RubyProperties()); self::assertEquals('', $ruby->getRubyTextRun()->getText()); $tr = new TextRun(); $tr->addText('Hello, ruby'); $ruby->setRubyTextRun($tr); self::assertEquals('Hello, ruby', $ruby->getRubyTextRun()->getText()); } /** * Get/set ruby properties. */ public function testRubyProperties(): void { $ruby = new Ruby(new TextRun(), new TextRun(), new RubyProperties()); self::assertEquals(RubyProperties::ALIGNMENT_DISTRIBUTE_SPACE, $ruby->getProperties()->getAlignment()); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); $properties->setFontFaceSize(1); $properties->setFontPointsAboveBaseText(2); $properties->setFontSizeForBaseText(3); $properties->setLanguageId('en-US'); $ruby->setProperties($properties); self::assertEquals(RubyProperties::ALIGNMENT_RIGHT_VERTICAL, $ruby->getProperties()->getAlignment()); self::assertEquals(1, $ruby->getProperties()->getFontFaceSize()); self::assertEquals(2, $ruby->getProperties()->getFontPointsAboveBaseText()); self::assertEquals(3, $ruby->getProperties()->getFontSizeForBaseText()); self::assertEquals('en-US', $ruby->getProperties()->getLanguageId()); } } ================================================ FILE: tests/PhpWordTests/Element/SDTTest.php ================================================ setValue($value); $object->setListItems($types); $object->setAlias($alias); $object->setTag($tag); self::assertEquals($type, $object->getType()); self::assertEquals($types, $object->getListItems()); self::assertEquals($value, $object->getValue()); self::assertEquals($alias, $object->getAlias()); self::assertEquals($tag, $object->getTag()); } /** * Test set type exception. */ public function testSetTypeException(): void { $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessage('Invalid style value'); $object = new SDT('comboBox'); $object->setType('foo'); } /** * Test set type. */ public function testSetTypeNull(): void { $object = new SDT('comboBox'); $object->setType(' '); self::assertEquals('comboBox', $object->getType()); } } ================================================ FILE: tests/PhpWordTests/Element/SectionTest.php ================================================ getStyle()); } public function testConstructorWithArrayStyle(): void { $section = new Section(0, ['orientation' => 'landscape']); $style = $section->getStyle(); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Section', $style); self::assertEquals('landscape', $style->getOrientation()); } public function testConstructorWithObjectStyle(): void { $style = new SectionStyle(); $section = new Section(0, $style); self::assertSame($style, $section->getStyle()); } /** * @covers ::setStyle */ public function testSetStyle(): void { $expected = 'landscape'; $object = new Section(0); $object->setStyle(['orientation' => $expected, 'foo' => null]); self::assertEquals($expected, $object->getStyle()->getOrientation()); } /** * @coversNothing */ public function testAddElements(): void { $objectSource = __DIR__ . '/../_files/documents/reader.docx'; $imageSource = __DIR__ . '/../_files/images/PhpWord.png'; $section = new Section(0); $section->setPhpWord(new PhpWord()); $section->addText(utf8decode('ä')); $section->addLink(utf8decode('http://äää.com'), utf8decode('ä')); $section->addTextBreak(); $section->addPageBreak(); $section->addTable(); $section->addListItem(utf8decode('ä')); $section->addObject($objectSource); $section->addImage($imageSource); $section->addTitle(utf8decode('ä'), 1); $section->addTextRun(); $section->addFootnote(); $section->addCheckBox(utf8decode('chkä'), utf8decode('Contentä')); $section->addTOC(); $elementCollection = $section->getElements(); $elementTypes = [ 'Text', 'Link', 'TextBreak', 'PageBreak', 'Table', 'ListItem', 'OLEObject', 'Image', 'Title', 'TextRun', 'Footnote', 'CheckBox', 'TOC', ]; $elmCount = 0; foreach ($elementTypes as $elementType) { self::assertInstanceOf("PhpOffice\\PhpWord\\Element\\{$elementType}", $elementCollection[$elmCount]); ++$elmCount; } } /** * @coversNothing */ public function testAddObjectException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidObjectException::class); $source = __DIR__ . '/_files/xsl/passthrough.xsl'; $section = new Section(0); $section->addObject($source); } /** * Add title with predefined style. * * @coversNothing */ public function testAddTitleWithStyle(): void { Style::addTitleStyle(1, ['size' => 14]); $section = new Section(0); $section->setPhpWord(new PhpWord()); $section->addTitle('Test', 1); $elementCollection = $section->getElements(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Title', $elementCollection[0]); } /** * @covers ::addFooter * @covers ::addHeader * @covers ::hasDifferentFirstPage */ public function testAddHeaderFooter(): void { $object = new Section(0); $elements = ['Header', 'Footer']; foreach ($elements as $element) { $method = "add{$element}"; self::assertInstanceOf("PhpOffice\\PhpWord\\Element\\{$element}", $object->$method()); } self::assertFalse($object->hasDifferentFirstPage()); } /** * @covers ::addHeader * @covers ::hasDifferentFirstPage */ public function testHasDifferentFirstPageFooter(): void { $object = new Section(1); $object->addFooter(Header::FIRST); self::assertTrue($object->hasDifferentFirstPage()); } /** * @covers ::addHeader * @covers ::hasDifferentFirstPage */ public function testHasDifferentFirstPage(): void { $object = new Section(1); $header = $object->addHeader(); $header->setType(Header::FIRST); self::assertTrue($object->hasDifferentFirstPage()); } /** * @covers ::addHeader */ public function testAddHeaderException(): void { $this->expectException(Exception::class); $this->expectExceptionMessage('Invalid header/footer type.'); $object = new Section(1); $object->addHeader('ODD'); } /** * @covers \PhpOffice\PhpWord\Element\AbstractContainer::removeElement */ public function testRemoveElementByIndex(): void { $section = new Section(1); $section->addText('firstText'); $section->addText('secondText'); self::assertEquals(2, $section->countElements()); $section->removeElement(1); self::assertEquals(1, $section->countElements()); } /** * @covers \PhpOffice\PhpWord\Element\AbstractContainer::removeElement */ public function testRemoveElementByElement(): void { $section = new Section(1); $firstText = $section->addText('firstText'); $secondText = $section->addText('secondText'); self::assertEquals(2, $section->countElements()); $section->removeElement($firstText); self::assertEquals(1, $section->countElements()); self::assertEquals($secondText->getElementId(), $section->getElement(1)->getElementId()); } } ================================================ FILE: tests/PhpWordTests/Element/TOCTest.php ================================================ 9062, 'leader' => \PhpOffice\PhpWord\Style\Tab::TAB_LEADER_DOT, 'indent' => 200, ]; $object = new TOC(['size' => 11], ['position' => $expected['position']]); $tocStyle = $object->getStyleTOC(); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\TOC', $tocStyle); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $object->getStyleFont()); foreach ($expected as $key => $value) { $method = "get{$key}"; self::assertEquals($value, $tocStyle->$method()); } } /** * Construct with named font style. */ public function testConstructWithStyleName(): void { $object = new TOC('Font Style'); // $tocStyle = $object->getStyleTOC(); self::assertEquals('Font Style', $object->getStyleFont()); } /** * Test when no PHPWord object is assigned:. */ public function testNoPhpWord(): void { $object = new TOC(); self::assertEmpty($object->getTitles()); self::assertNull($object->getPhpWord()); } /** * Set/get minDepth and maxDepth. */ public function testSetGetMinMaxDepth(): void { $titles = [ 'Heading 1' => 1, 'Heading 2' => 2, 'Heading 3' => 3, 'Heading 4' => 4, ]; $phpWord = new PhpWord(); foreach ($titles as $text => $depth) { $phpWord->addTitle(new Title($text, $depth)); } $toc = new TOC(); $toc->setPhpWord($phpWord); self::assertEquals(1, $toc->getMinDepth()); self::assertEquals(9, $toc->getMaxDepth()); $toc->setMinDepth(2); $toc->setMaxDepth(3); $toc->getTitles(); self::assertEquals(2, $toc->getMinDepth()); self::assertEquals(3, $toc->getMaxDepth()); } } ================================================ FILE: tests/PhpWordTests/Element/TableTest.php ================================================ getStyle()); self::assertNull($oTable->getWidth()); self::assertEquals([], $oTable->getRows()); self::assertCount(0, $oTable->getRows()); } /** * Get style name. */ public function testStyleText(): void { $oTable = new Table('tableStyle'); self::assertEquals('tableStyle', $oTable->getStyle()); } /** * Get style array. */ public function testStyleArray(): void { $oTable = new Table(['borderSize' => 6, 'borderColor' => '006699', 'cellMargin' => 80]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Table', $oTable->getStyle()); } /** * Set/get width. */ public function testWidth(): void { $oTable = new Table(); $iVal = mt_rand(1, 1000); $oTable->setWidth($iVal); self::assertEquals($iVal, $oTable->getWidth()); } /** * Add/get row. */ public function testRow(): void { $oTable = new Table(); $element = $oTable->addRow(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Row', $element); self::assertCount(1, $oTable->getRows()); } /** * Add cell. */ public function testCell(): void { $oTable = new Table(); $oTable->addRow(); $element = $oTable->addCell(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Cell', $element); } /** * Add cell. */ public function testCountColumns(): void { $oTable = new Table(); $oTable->addRow(); $oTable->addCell(); self::assertEquals($oTable->countColumns(), 1); $oTable->addCell(); $oTable->addCell(); self::assertEquals($oTable->countColumns(), 3); } } ================================================ FILE: tests/PhpWordTests/Element/TextBoxTest.php ================================================ getStyle()); } /** * Get style name. */ public function testStyleText(): void { $oTextBox = new TextBox('textBoxStyle'); self::assertEquals('textBoxStyle', $oTextBox->getStyle()); } /** * Get style array. */ public function testStyleArray(): void { $oTextBox = new TextBox( [ 'width' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(4.5), 'height' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(17.5), 'positioning' => 'absolute', 'marginLeft' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(15.4), 'marginTop' => \PhpOffice\PhpWord\Shared\Converter::cmToPixel(9.9), 'stroke' => 0, 'innerMargin' => 0, 'borderSize' => 1, 'borderColor' => '', ] ); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\TextBox', $oTextBox->getStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/TextBreakTest.php ================================================ getFontStyle()); self::assertNull($object->getParagraphStyle()); } /** * Construct with style object. */ public function testConstructWithStyleObject(): void { $fStyle = new Font(); $pStyle = new Paragraph(); $object = new TextBreak($fStyle, $pStyle); self::assertEquals($fStyle, $object->getFontStyle()); self::assertEquals($pStyle, $object->getParagraphStyle()); } /** * Construct with style array. */ public function testConstructWithStyleArray(): void { $fStyle = ['size' => 12]; $pStyle = ['spacing' => 240]; $object = new TextBreak($fStyle, $pStyle); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $object->getFontStyle()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $object->getParagraphStyle()); } /** * Construct with style name. */ public function testConstructWithStyleName(): void { $fStyle = 'fStyle'; $pStyle = 'pStyle'; $object = new TextBreak($fStyle, $pStyle); self::assertEquals($fStyle, $object->getFontStyle()); self::assertEquals($pStyle, $object->getParagraphStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/TextRunTest.php ================================================ getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oTextRun->getParagraphStyle()); } /** * New instance with string. */ public function testConstructString(): void { $oTextRun = new TextRun('pStyle'); self::assertCount(0, $oTextRun->getElements()); self::assertEquals('pStyle', $oTextRun->getParagraphStyle()); } /** * New instance with array. */ public function testConstructArray(): void { $oTextRun = new TextRun(['spacing' => 100]); self::assertCount(0, $oTextRun->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oTextRun->getParagraphStyle()); } /** * New instance with object. */ public function testConstructObject(): void { $oParagraphStyle = new Paragraph(); $oParagraphStyle->setAlignment(Jc::BOTH); $oTextRun = new TextRun($oParagraphStyle); self::assertCount(0, $oTextRun->getElements()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oTextRun->getParagraphStyle()); self::assertEquals(Jc::BOTH, $oTextRun->getParagraphStyle()->getAlignment()); } /** * Add text. */ public function testAddText(): void { $oTextRun = new TextRun(); $element = $oTextRun->addText('text'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oTextRun->getElements()); self::assertEquals('text', $element->getText()); } /** * Add text non-UTF8. */ public function testAddTextNotUTF8(): void { $oTextRun = new TextRun(); $element = $oTextRun->addText(utf8decode('ééé')); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Text', $element); self::assertCount(1, $oTextRun->getElements()); self::assertEquals('ééé', $element->getText()); } /** * Add link. */ public function testAddLink(): void { $oTextRun = new TextRun(); $element = $oTextRun->addLink('https://github.com/PHPOffice/PHPWord'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Link', $element); self::assertCount(1, $oTextRun->getElements()); self::assertEquals('https://github.com/PHPOffice/PHPWord', $element->getSource()); } /** * Add link with name. */ public function testAddLinkWithName(): void { $oTextRun = new TextRun(); $element = $oTextRun->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Link', $element); self::assertCount(1, $oTextRun->getElements()); self::assertEquals('https://github.com/PHPOffice/PHPWord', $element->getSource()); self::assertEquals('PHPWord on GitHub', $element->getText()); } /** * Add text break. */ public function testAddTextBreak(): void { $oTextRun = new TextRun(); $oTextRun->addTextBreak(2); self::assertCount(2, $oTextRun->getElements()); } /** * Add image. */ public function testAddImage(): void { $src = __DIR__ . '/../_files/images/earth.jpg'; $oTextRun = new TextRun(); $element = $oTextRun->addImage($src); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Image', $element); self::assertCount(1, $oTextRun->getElements()); } /** * Add footnote. */ public function testCreateFootnote(): void { $oTextRun = new TextRun(); $oTextRun->setPhpWord(new PhpWord()); $element = $oTextRun->addFootnote(); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Footnote', $element); self::assertCount(1, $oTextRun->getElements()); } /** * Get paragraph style. */ public function testParagraph(): void { $oText = new TextRun('paragraphStyle'); self::assertEquals('paragraphStyle', $oText->getParagraphStyle()); $oText->setParagraphStyle(['alignment' => Jc::CENTER, 'spaceAfter' => 100]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oText->getParagraphStyle()); } /** * Add ruby element and get raw text. */ public function testRubyElementGetText(): void { $oTextRun = new TextRun(); $oTextRun->setPhpWord(new PhpWord()); $properties = new RubyProperties(); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $element = $oTextRun->addRuby($baseTextRun, $rubyTextRun, $properties); self::assertInstanceOf('PhpOffice\\PhpWord\\Element\\Ruby', $element); self::assertCount(1, $oTextRun->getElements()); self::assertEquals('私 (わたし)', $oTextRun->getText()); } } ================================================ FILE: tests/PhpWordTests/Element/TextTest.php ================================================ getText()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $oText->getFontStyle()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oText->getParagraphStyle()); } /** * Get text. */ public function testText(): void { $oText = new Text('text'); self::assertEquals('text', $oText->getText()); } /** * Get font style. */ public function testFont(): void { $oText = new Text('text', 'fontStyle'); self::assertEquals('fontStyle', $oText->getFontStyle()); $oText->setFontStyle(['bold' => true, 'italic' => true, 'size' => 16]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', $oText->getFontStyle()); } /** * Get font style as object. */ public function testFontObject(): void { $font = new Font(); $oText = new Text('text', $font); self::assertEquals($font, $oText->getFontStyle()); } /** * Get paragraph style. */ public function testParagraph(): void { $oText = new Text('text', 'fontStyle', 'paragraphStyle'); self::assertEquals('paragraphStyle', $oText->getParagraphStyle()); $oText->setParagraphStyle(['alignment' => Jc::CENTER, 'spaceAfter' => 100]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', $oText->getParagraphStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/TitleTest.php ================================================ getText()); self::assertEquals(1, $title->getDepth()); self::assertNull($title->getPageNumber()); self::assertNull($title->getStyle()); } /** * Create new instance with TextRun. */ public function testConstructWithTextRun(): void { $textRun = new TextRun(); $textRun->addText('text'); $title = new Title($textRun); self::assertInstanceOf(TextRun::class, $title->getText()); self::assertEquals(1, $title->getDepth()); self::assertNull($title->getPageNumber()); self::assertNull($title->getStyle()); } public function testConstructWithInvalidArgument(): void { $this->expectException(InvalidArgumentException::class); new Title(new PageBreak()); } public function testConstructWithPageNumber(): void { $title = new Title('text', 1, 0); self::assertEquals('text', $title->getText()); self::assertEquals(0, $title->getPageNumber()); self::assertNull($title->getStyle()); } } ================================================ FILE: tests/PhpWordTests/Element/TrackChangeTest.php ================================================ setTrackChange($oTrackChange); self::assertEquals($author, $oTrackChange->getAuthor()); self::assertEquals($date, $oTrackChange->getDate()); self::assertEquals(TrackChange::INSERTED, $oTrackChange->getChangeType()); } /** * New instance with invalid \DateTime (produced by \DateTime::createFromFormat(...)). */ public function testConstructDefaultWithInvalidDate(): void { $author = 'Test User'; $date = false; $oTrackChange = new TrackChange(TrackChange::INSERTED, $author, $date); $oText = new Text('dummy text'); $oText->setTrackChange($oTrackChange); self::assertEquals($author, $oTrackChange->getAuthor()); self::assertEquals($date, null); self::assertEquals(TrackChange::INSERTED, $oTrackChange->getChangeType()); } } ================================================ FILE: tests/PhpWordTests/Escaper/RtfEscaper2Test.php ================================================ write()); return $txt2; } public function expect($str) { return self::HEADER . $str . self::TRAILER; } /** * Test special characters which require escaping. */ public function testSpecial(): void { $str = 'Special characters { open brace } close brace \\ backslash'; $expect = $this->expect('Special characters \\{ open brace \\} close brace \\\\ backslash'); self::assertEquals($expect, $this->escapestring($str)); } /** * Test accented character. */ public function testAccent(): void { $str = 'Voilà - string with accented char'; $expect = $this->expect('Voil\\uc0{\\u224} - string with accented char'); self::assertEquals($expect, $this->escapestring($str)); } /** * Test Hebrew. */ public function testHebrew(): void { $str = 'Hebrew - שלום'; $expect = $this->expect('Hebrew - \\uc0{\\u1513}\\uc0{\\u1500}\\uc0{\\u1493}\\uc0{\\u1501}'); self::assertEquals($expect, $this->escapestring($str)); } /** * Test tab. */ public function testTab(): void { $str = "Here's a tab\tfollowed by more characters."; $expect = $this->expect("Here's a tab{\\tab}followed by more characters."); self::assertEquals($expect, $this->escapestring($str)); } } ================================================ FILE: tests/PhpWordTests/Escaper/RtfEscaper3Test.php ================================================ write()); return $txt2; } public function expect(string $str, bool $rtl = false): string { return ($rtl ? self:: HEADER_RTL : self::HEADER) . $str . self::TRAILER; } /** * Test special characters which require escaping. */ public function testSpecial(): void { Settings::setDefaultRtl(false); $str = 'Special characters { open brace } close brace \\ backslash'; $expect = $this->expect('Special characters \\{ open brace \\} close brace \\\\ backslash'); self::assertEquals($expect, $this->escapestring($str)); } /** * Test accented character. */ public function testAccent(): void { Settings::setDefaultRtl(false); $str = 'Voilà - string with accented char'; $expect = $this->expect('Voil\\uc0{\\u224} - string with accented char'); self::assertEquals($expect, $this->escapestring($str)); } /** * Test Hebrew. */ public function testHebrew(): void { Settings::setDefaultRtl(true); $str = 'Hebrew - שלום'; $expect = $this->expect('Hebrew - \\uc0{\\u1513}\\uc0{\\u1500}\\uc0{\\u1493}\\uc0{\\u1501}', true); self::assertEquals($expect, $this->escapestring($str)); } /** * Test tab. */ public function testTab(): void { Settings::setDefaultRtl(false); $str = "Here's a tab\tfollowed by more characters."; $expect = $this->expect("Here's a tab{\\tab}followed by more characters."); self::assertEquals($expect, $this->escapestring($str)); } } ================================================ FILE: tests/PhpWordTests/Exception/CopyFileExceptionTest.php ================================================ expectException(CopyFileException::class); throw new CopyFileException('C:\source\dummy.txt', 'C:\destination\dummy.txt'); } } ================================================ FILE: tests/PhpWordTests/Exception/CreateTemporaryFileExceptionTest.php ================================================ expectException(CreateTemporaryFileException::class); throw new CreateTemporaryFileException(); } } ================================================ FILE: tests/PhpWordTests/Exception/ExceptionTest.php ================================================ expectException(Exception::class); throw new Exception(); } } ================================================ FILE: tests/PhpWordTests/Exception/InvalidImageExceptionTest.php ================================================ expectException(InvalidImageException::class); throw new InvalidImageException(); } } ================================================ FILE: tests/PhpWordTests/Exception/InvalidStyleExceptionTest.php ================================================ expectException(InvalidStyleException::class); throw new InvalidStyleException(); } } ================================================ FILE: tests/PhpWordTests/Exception/UnsupportedImageTypeExceptionTest.php ================================================ expectException(UnsupportedImageTypeException::class); throw new UnsupportedImageTypeException(); } } ================================================ FILE: tests/PhpWordTests/IOFactoryTest.php ================================================ expectException(Exception::class); IOFactory::createWriter(new PhpWord(), 'Word2006'); } /** * Create existing reader. */ public function testExistingReaderCanBeCreated(): void { self::assertInstanceOf( 'PhpOffice\\PhpWord\\Reader\\Word2007', IOFactory::createReader('Word2007') ); } /** * Create non-existing reader. */ public function testNonexistentReaderCanNotBeCreated(): void { $this->expectException(Exception::class); IOFactory::createReader('Word2006'); } /** * Load document. */ public function testLoad(): void { $file = __DIR__ . '/_files/templates/blank.docx'; self::assertInstanceOf( 'PhpOffice\\PhpWord\\PhpWord', IOFactory::load($file) ); } /** * Test for extractVariables method. */ public function testExtractVariables(): void { $file = __DIR__ . '/_files/templates/extract-variable.docx'; $extractedVariables = IOFactory::extractVariables($file, 'Word2007'); $expectedVariables = ['date', 'A1', 'B1']; self::assertEquals($expectedVariables, $extractedVariables, 'Extracted variables do not match expected variables.'); } } ================================================ FILE: tests/PhpWordTests/MediaTest.php ================================================ expectException(Exception::class); $this->expectExceptionMessage('Image object not assigned.'); Media::addElement('section', 'image', __DIR__ . '/_files/images/mars.jpg'); } } ================================================ FILE: tests/PhpWordTests/Metadata/DocInfoTest.php ================================================ setCreator(); self::assertEquals('', $oProperties->getCreator()); $oProperties->setCreator('AAA'); self::assertEquals('AAA', $oProperties->getCreator()); } /** * Last modified by. */ public function testLastModifiedBy(): void { $oProperties = new DocInfo(); $oProperties->setLastModifiedBy(); self::assertEquals('', $oProperties->getLastModifiedBy()); $oProperties->setLastModifiedBy('AAA'); self::assertEquals('AAA', $oProperties->getLastModifiedBy()); } /** * Created. */ public function testCreated(): void { $oProperties = new DocInfo(); $oProperties->setCreated(); self::assertEquals(time(), $oProperties->getCreated()); $iTime = time() + 3600; $oProperties->setCreated($iTime); self::assertEquals($iTime, $oProperties->getCreated()); } /** * Modified. */ public function testModified(): void { $oProperties = new DocInfo(); $oProperties->setModified(); self::assertEquals(time(), $oProperties->getModified()); $iTime = time() + 3600; $oProperties->setModified($iTime); self::assertEquals($iTime, $oProperties->getModified()); } /** * Title. */ public function testTitle(): void { $oProperties = new DocInfo(); $oProperties->setTitle(); self::assertEquals('', $oProperties->getTitle()); $oProperties->setTitle('AAA'); self::assertEquals('AAA', $oProperties->getTitle()); } /** * Description. */ public function testDescription(): void { $oProperties = new DocInfo(); $oProperties->setDescription(); self::assertEquals('', $oProperties->getDescription()); $oProperties->setDescription('AAA'); self::assertEquals('AAA', $oProperties->getDescription()); } /** * Subject. */ public function testSubject(): void { $oProperties = new DocInfo(); $oProperties->setSubject(); self::assertEquals('', $oProperties->getSubject()); $oProperties->setSubject('AAA'); self::assertEquals('AAA', $oProperties->getSubject()); } /** * Keywords. */ public function testKeywords(): void { $oProperties = new DocInfo(); $oProperties->setKeywords(); self::assertEquals('', $oProperties->getKeywords()); $oProperties->setKeywords('AAA'); self::assertEquals('AAA', $oProperties->getKeywords()); } /** * Category. */ public function testCategory(): void { $oProperties = new DocInfo(); $oProperties->setCategory(); self::assertEquals('', $oProperties->getCategory()); $oProperties->setCategory('AAA'); self::assertEquals('AAA', $oProperties->getCategory()); } /** * Company. */ public function testCompany(): void { $oProperties = new DocInfo(); $oProperties->setCompany(); self::assertEquals('', $oProperties->getCompany()); $oProperties->setCompany('AAA'); self::assertEquals('AAA', $oProperties->getCompany()); } /** * Manager. */ public function testManager(): void { $oProperties = new DocInfo(); $oProperties->setManager(); self::assertEquals('', $oProperties->getManager()); $oProperties->setManager('AAA'); self::assertEquals('AAA', $oProperties->getManager()); } /** * Custom properties. */ public function testCustomProperty(): void { $oProperties = new DocInfo(); $oProperties->setCustomProperty('key1', null); $oProperties->setCustomProperty('key2', true); $oProperties->setCustomProperty('key3', 3); $oProperties->setCustomProperty('key4', 4.4); $oProperties->setCustomProperty('key5', 'value5'); self::assertEquals(DocInfo::PROPERTY_TYPE_STRING, $oProperties->getCustomPropertyType('key1')); self::assertEquals(DocInfo::PROPERTY_TYPE_BOOLEAN, $oProperties->getCustomPropertyType('key2')); self::assertEquals(DocInfo::PROPERTY_TYPE_INTEGER, $oProperties->getCustomPropertyType('key3')); self::assertEquals(DocInfo::PROPERTY_TYPE_FLOAT, $oProperties->getCustomPropertyType('key4')); self::assertEquals(DocInfo::PROPERTY_TYPE_STRING, $oProperties->getCustomPropertyType('key5')); self::assertNull($oProperties->getCustomPropertyType('key6')); self::assertNull($oProperties->getCustomPropertyValue('key1')); self::assertTrue($oProperties->getCustomPropertyValue('key2')); self::assertEquals(3, $oProperties->getCustomPropertyValue('key3')); self::assertEquals(4.4, $oProperties->getCustomPropertyValue('key4')); self::assertEquals('value5', $oProperties->getCustomPropertyValue('key5')); self::assertNull($oProperties->getCustomPropertyValue('key6')); self::assertTrue($oProperties->isCustomPropertySet('key5')); self::assertNotTrue($oProperties->isCustomPropertySet('key6')); self::assertEquals(['key1', 'key2', 'key3', 'key4', 'key5'], $oProperties->getCustomProperties()); } /** * Convert property. */ public function testConvertProperty(): void { self::assertEquals('', DocInfo::convertProperty('a', 'empty')); self::assertNull(DocInfo::convertProperty('a', 'null')); self::assertEquals(8, DocInfo::convertProperty('8', 'int')); self::assertEquals(8, DocInfo::convertProperty('8.3', 'uint')); self::assertEquals(8.3, DocInfo::convertProperty('8.3', 'decimal')); self::assertEquals('8.3', DocInfo::convertProperty('8.3', 'lpstr')); self::assertEquals(strtotime('10/11/2013'), DocInfo::convertProperty('10/11/2013', 'date')); self::assertTrue(DocInfo::convertProperty('true', 'bool')); self::assertNotTrue(DocInfo::convertProperty('1', 'bool')); self::assertEquals('1', DocInfo::convertProperty('1', 'array')); self::assertEquals('1', DocInfo::convertProperty('1', '')); self::assertEquals(DocInfo::PROPERTY_TYPE_INTEGER, DocInfo::convertPropertyType('int')); self::assertEquals(DocInfo::PROPERTY_TYPE_INTEGER, DocInfo::convertPropertyType('uint')); self::assertEquals(DocInfo::PROPERTY_TYPE_FLOAT, DocInfo::convertPropertyType('decimal')); self::assertEquals(DocInfo::PROPERTY_TYPE_STRING, DocInfo::convertPropertyType('lpstr')); self::assertEquals(DocInfo::PROPERTY_TYPE_DATE, DocInfo::convertPropertyType('date')); self::assertEquals(DocInfo::PROPERTY_TYPE_BOOLEAN, DocInfo::convertPropertyType('bool')); self::assertEquals(DocInfo::PROPERTY_TYPE_UNKNOWN, DocInfo::convertPropertyType('array')); self::assertEquals(DocInfo::PROPERTY_TYPE_UNKNOWN, DocInfo::convertPropertyType('')); } } ================================================ FILE: tests/PhpWordTests/Metadata/SettingsTest.php ================================================ setEvenAndOddHeaders(true); self::assertTrue($oSettings->hasEvenAndOddHeaders()); } /** * HideGrammaticalErrors. */ public function testHideGrammaticalErrors(): void { $oSettings = new Settings(); $oSettings->setHideGrammaticalErrors(true); self::assertTrue($oSettings->hasHideGrammaticalErrors()); } /** * HideSpellingErrors. */ public function testHideSpellingErrors(): void { $oSettings = new Settings(); $oSettings->setHideSpellingErrors(true); self::assertTrue($oSettings->hasHideSpellingErrors()); } /** * DocumentProtection. */ public function testDocumentProtection(): void { $oSettings = new Settings(); $oSettings->setDocumentProtection(new Protection('trackedChanges')); self::assertNotNull($oSettings->getDocumentProtection()); self::assertEquals('trackedChanges', $oSettings->getDocumentProtection()->getEditing()); } /** * Test setting an invalid salt. */ public function testInvalidSalt(): void { $this->expectException(InvalidArgumentException::class); $protection = new Protection(); $protection->setSalt('123'); } /** * TrackRevistions. */ public function testTrackRevisions(): void { $oSettings = new Settings(); $oSettings->setTrackRevisions(true); self::assertTrue($oSettings->hasTrackRevisions()); } /** * DoNotTrackFormatting. */ public function testDoNotTrackFormatting(): void { $oSettings = new Settings(); $oSettings->setDoNotTrackFormatting(true); self::assertTrue($oSettings->hasDoNotTrackFormatting()); } /** * DoNotTrackMoves. */ public function testDoNotTrackMoves(): void { $oSettings = new Settings(); $oSettings->setDoNotTrackMoves(true); self::assertTrue($oSettings->hasDoNotTrackMoves()); } /** * ProofState. */ public function testProofState(): void { $proofState = new ProofState(); $proofState->setGrammar(ProofState::CLEAN); $proofState->setSpelling(ProofState::DIRTY); $oSettings = new Settings(); $oSettings->setProofState($proofState); self::assertNotNull($oSettings->getProofState()); self::assertEquals(ProofState::CLEAN, $oSettings->getProofState()->getGrammar()); self::assertEquals(ProofState::DIRTY, $oSettings->getProofState()->getSpelling()); } public function testWrongProofStateGrammar(): void { $this->expectException(InvalidArgumentException::class); $proofState = new ProofState(); $proofState->setGrammar('wrong'); } public function testWrongProofStateSpelling(): void { $this->expectException(InvalidArgumentException::class); $proofState = new ProofState(); $proofState->setSpelling('wrong'); } /** * Zoom as percentage. */ public function testZoomPercentage(): void { $oSettings = new Settings(); $oSettings->setZoom(75); self::assertEquals(75, $oSettings->getZoom()); } /** * Zoom as string. */ public function testZoomEnum(): void { $oSettings = new Settings(); $oSettings->setZoom(Zoom::FULL_PAGE); self::assertEquals('fullPage', $oSettings->getZoom()); } /** * Test Update Fields on update. */ public function testUpdateFields(): void { $oSettings = new Settings(); $oSettings->setUpdateFields(true); self::assertTrue($oSettings->hasUpdateFields()); } public function testAutoHyphenation(): void { $oSettings = new Settings(); $oSettings->setAutoHyphenation(true); self::assertTrue($oSettings->hasAutoHyphenation()); } public function testDefaultAutoHyphenation(): void { $oSettings = new Settings(); self::assertNull($oSettings->hasAutoHyphenation()); } public function testConsecutiveHyphenLimit(): void { $consecutiveHypenLimit = 2; $oSettings = new Settings(); $oSettings->setConsecutiveHyphenLimit($consecutiveHypenLimit); self::assertSame($consecutiveHypenLimit, $oSettings->getConsecutiveHyphenLimit()); } public function testDefaultConsecutiveHyphenLimit(): void { $oSettings = new Settings(); self::assertNull($oSettings->getConsecutiveHyphenLimit()); } public function testHyphenationZone(): void { $hyphenationZoneInTwip = 100; $oSettings = new Settings(); $oSettings->setHyphenationZone($hyphenationZoneInTwip); self::assertSame($hyphenationZoneInTwip, $oSettings->getHyphenationZone()); } public function testDefaultHyphenationZone(): void { $oSettings = new Settings(); self::assertNull($oSettings->getHyphenationZone()); } public function testDoNotHyphenateCaps(): void { $oSettings = new Settings(); $oSettings->setDoNotHyphenateCaps(true); self::assertTrue($oSettings->hasDoNotHyphenateCaps()); } public function testDefaultDoNotHyphenateCaps(): void { $oSettings = new Settings(); self::assertNull($oSettings->hasDoNotHyphenateCaps()); } public function testBookFoldPrinting(): void { $oSettings = new Settings(); $oSettings->setBookFoldPrinting(true); self::assertTrue($oSettings->hasBookFoldPrinting()); $oSettings->setBookFoldPrinting(false); self::assertFalse($oSettings->hasBookFoldPrinting()); } public function testDefaultBookFoldPrinting(): void { $oSettings = new Settings(); self::assertFalse($oSettings->hasBookFoldPrinting()); } } ================================================ FILE: tests/PhpWordTests/PhpWordTest.php ================================================ format('s'); $phpWord = new PhpWord(); $docInfo = new DocInfo(); $endSecond = (new DateTimeImmutable('now'))->format('s'); } while ($startSecond !== $endSecond); self::assertEquals($docInfo, $phpWord->getDocInfo()); self::assertEquals(Settings::DEFAULT_FONT_NAME, $phpWord->getDefaultFontName()); self::assertEquals(Settings::DEFAULT_FONT_SIZE, $phpWord->getDefaultFontSize()); } /** * Test create/get section. */ public function testCreateGetSections(): void { $phpWord = new PhpWord(); $phpWord->addSection(); self::assertCount(1, $phpWord->getSections()); } /** * Test set/get default font name. */ public function testSetGetDefaultFontName(): void { $phpWord = new PhpWord(); $fontName = 'Times New Roman'; self::assertEquals(Settings::DEFAULT_FONT_NAME, $phpWord->getDefaultFontName()); $phpWord->setDefaultFontName($fontName); self::assertEquals($fontName, $phpWord->getDefaultFontName()); } /** * Test set/get default font size. */ public function testSetGetDefaultFontSize(): void { $phpWord = new PhpWord(); $fontSize = 16; self::assertEquals(Settings::DEFAULT_FONT_SIZE, $phpWord->getDefaultFontSize()); $phpWord->setDefaultFontSize($fontSize); self::assertEquals($fontSize, $phpWord->getDefaultFontSize()); } /** * Test set/get default asian font name. */ public function testSetGetDefaultAsianFontName(): void { $phpWord = new PhpWord(); $fontName = 'Times New Roman'; self::assertEquals(Settings::DEFAULT_FONT_NAME, $phpWord->getDefaultAsianFontName()); $phpWord->setDefaultAsianFontName($fontName); self::assertEquals($fontName, $phpWord->getDefaultAsianFontName()); } /** * Test set/get default font color. */ public function testSetGetDefaultFontColor(): void { $phpWord = new PhpWord(); $fontColor = 'FF0000'; self::assertEquals(Settings::DEFAULT_FONT_COLOR, $phpWord->getDefaultFontColor()); $phpWord->setDefaultFontColor($fontColor); self::assertEquals($fontColor, $phpWord->getDefaultFontColor()); } /** * Test set default paragraph style. */ public function testSetDefaultParagraphStyle(): void { $phpWord = new PhpWord(); $phpWord->setDefaultParagraphStyle([]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', Style::getStyle('Normal')); } /** * Test add styles. */ public function testAddStyles(): void { $phpWord = new PhpWord(); $styles = [ 'Paragraph' => 'Paragraph', 'Font' => 'Font', 'Table' => 'Table', 'Link' => 'Font', ]; foreach ($styles as $key => $value) { $method = "add{$key}Style"; $styleId = "{$key} Style"; $phpWord->$method($styleId, []); self::assertInstanceOf("PhpOffice\\PhpWord\\Style\\{$value}", Style::getStyle($styleId)); } } /** * Test add title style. */ public function testAddTitleStyle(): void { $phpWord = new PhpWord(); $titleLevel = 1; $titleName = "Heading_{$titleLevel}"; $phpWord->addTitleStyle($titleLevel, []); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', Style::getStyle($titleName)); } /** * Test save. */ public function testSave(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Hello world!'); ob_start(); self::assertTrue($phpWord->save('test.docx', 'Word2007', true)); $contents = ob_get_contents(); self::assertTrue(ob_end_clean()); self::assertNotEmpty($contents); } /** * Test calling undefined method. */ public function testCallUndefinedMethod(): void { $this->expectException(BadMethodCallException::class); $this->expectExceptionMessage('is not defined'); $phpWord = new PhpWord(); $phpWord->undefinedMethod(); } /** * @covers \PhpOffice\PhpWord\PhpWord::getSection */ public function testGetNotExistingSection(): void { $phpWord = new PhpWord(); $section = $phpWord->getSection(0); self::assertNull($section); } /** * @covers \PhpOffice\PhpWord\PhpWord::getSection */ public function testGetSection(): void { $phpWord = new PhpWord(); $phpWord->addSection(); $section = $phpWord->getSection(0); self::assertNotNull($section); } /** * @covers \PhpOffice\PhpWord\PhpWord::sortSections */ public function testSortSections(): void { $phpWord = new PhpWord(); $section1 = $phpWord->addSection(); $section1->addText('test1'); $section2 = $phpWord->addSection(); $section2->addText('test2'); $section2->addText('test3'); self::assertEquals(1, $phpWord->getSection(0)->countElements()); self::assertEquals(2, $phpWord->getSection(1)->countElements()); $phpWord->sortSections(function ($a, $b) { $numElementsInA = $a->countElements(); $numElementsInB = $b->countElements(); if ($numElementsInA === $numElementsInB) { return 0; } elseif ($numElementsInA > $numElementsInB) { return -1; } return 1; }); self::assertEquals(2, $phpWord->getSection(0)->countElements()); self::assertEquals(1, $phpWord->getSection(1)->countElements()); } /** * @covers \PhpOffice\PhpWord\PhpWord::getSettings */ public function testGetSettings(): void { $phpWord = new PhpWord(); self::assertInstanceOf('PhpOffice\\PhpWord\\Metadata\\Settings', $phpWord->getSettings()); } } ================================================ FILE: tests/PhpWordTests/Reader/HTMLTest.php ================================================ expectException(Exception::class); $this->expectExceptionMessage('Cannot read'); $filename = __DIR__ . '/../_files/documents/foo.html'; IOFactory::load($filename, 'HTML'); } } ================================================ FILE: tests/PhpWordTests/Reader/MsDocTest.php ================================================ canRead($filename)); } /** * Can read exception. */ public function testCanReadFailed(): void { $object = new MsDoc(); $filename = __DIR__ . '/../_files/documents/foo.doc'; self::assertFalse($object->canRead($filename)); } public function testLoadBasic(): void { $filename = __DIR__ . '/../_files/documents/reader.doc'; $phpWord = IOFactory::load($filename, 'MsDoc'); self::assertInstanceOf(PhpWord::class, $phpWord); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $elements = $sections[0]->getElements(); self::assertArrayHasKey(0, $elements); /** @var Text $element0 */ $element0 = $elements[0]; self::assertInstanceOf(Text::class, $element0); self::assertEquals('Welcome to PhpWord', $element0->getText()); } public function testLoadHalfPointFont(): void { $filename = __DIR__ . '/../_files/documents/reader.font-halfpoint.doc'; $phpWord = IOFactory::load($filename, 'MsDoc'); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $elements = $sections[0]->getElements(); self::assertArrayHasKey(0, $elements); $element0 = $elements[0]; if (method_exists($element0, 'getFontStyle')) { self::assertSame(19.5, $element0->getFontStyle()->getSize()); } else { self::fail('Unexpected no font style for first element'); } } public function testLoadChinese(): void { $filename = __DIR__ . '/../_files/documents/docChinese.doc'; $phpWord = IOFactory::load($filename, 'MsDoc'); self::assertInstanceOf(PhpWord::class, $phpWord); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $elements = $sections[0]->getElements(); self::assertArrayHasKey(0, $elements); /** @var Text $element0 */ $element0 = $elements[0]; self::assertInstanceOf(Text::class, $element0); self::assertEquals('OKKI AI 客户案例', $element0->getText()); } public function testLoadCzech(): void { $filename = __DIR__ . '/../_files/documents/docCzech.doc'; $phpWord = IOFactory::load($filename, 'MsDoc'); self::assertInstanceOf(PhpWord::class, $phpWord); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $elements = $sections[0]->getElements(); self::assertArrayHasKey(0, $elements); /** @var Text $element0 */ $element0 = $elements[0]; self::assertInstanceOf(Text::class, $element0); self::assertEquals('Příliš žluťoučký kůň pěl ďábelské ódy', $element0->getText()); } public function testLoadSlovak(): void { $filename = __DIR__ . '/../_files/documents/docSlovak.doc'; $phpWord = IOFactory::load($filename, 'MsDoc'); self::assertInstanceOf(PhpWord::class, $phpWord); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $elements = $sections[0]->getElements(); self::assertArrayHasKey(0, $elements); /** @var Text $element0 */ $element0 = $elements[0]; self::assertInstanceOf(Text::class, $element0); self::assertEquals('Pondelok', $element0->getText()); } /** * Test exception on not existing file. */ public function testFailIfFileNotReadable(): void { $this->expectException(Exception::class); $filename = __DIR__ . '/../_files/documents/not_existing_reader.doc'; IOFactory::load($filename, 'MsDoc'); } /** * Test exception on non OLE document. */ public function testFailIfFileNotOle(): void { $this->expectException(Exception::class); $filename = __DIR__ . '/../_files/documents/reader.odt'; IOFactory::load($filename, 'MsDoc'); } } ================================================ FILE: tests/PhpWordTests/Reader/ODText/ODTextSectionTest.php ================================================ filename !== '') { unlink($this->filename); $this->filename = ''; } } public function testWriteThenReadSection(): void { $dir = 'tests/PhpWordTests/_files'; Settings::setOutputEscapingEnabled(true); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $inputText = ['days', 'monday', 'tuesday']; $inputText[] = "Tab\tthen two spaces then done."; foreach ($inputText as $text) { $section->addText($text); } $writer = IOFactory::createWriter($phpWord, 'ODText'); $this->filename = "$dir/sectiontest.odt"; $writer->save($this->filename); $reader = IOFactory::createReader('ODText'); $phpWord2 = $reader->load($this->filename); $outputText = []; foreach ($phpWord2->getSections() as $section) { foreach ($section->getElements() as $element) { if (is_object($element) && method_exists($element, 'getText')) { $outputText[] = $element->getText(); } } } self::assertSame($inputText, $outputText); } public function testReadNoSections(): void { $dir = 'tests/PhpWordTests/_files/documents'; $inputText = ['days', 'monday', 'tuesday']; $reader = IOFactory::createReader('ODText'); $filename = "$dir/word.2493.nosection.odt"; $phpWord2 = $reader->load($filename); $outputText = []; foreach ($phpWord2->getSections() as $section) { foreach ($section->getElements() as $element) { if (is_object($element) && method_exists($element, 'getText')) { $outputText[] = $element->getText(); } } } self::assertSame($inputText, $outputText); } } ================================================ FILE: tests/PhpWordTests/Reader/ODTextTest.php ================================================ getSections(); self::assertCount(1, $sections); $section = $sections[0]; self::assertInstanceOf(Section::class, $section); $elements = $section->getElements(); self::assertCount(1, $elements); $element = $elements[0]; self::assertInstanceOf(Formula::class, $element); $elements = $element->getMath()->getElements(); self::assertCount(1, $elements); self::assertInstanceOf(Element\Semantics::class, $elements[0]); } } ================================================ FILE: tests/PhpWordTests/Reader/RTFTest.php ================================================ expectException(Exception::class); $this->expectExceptionMessage('Cannot read'); $filename = __DIR__ . '/../_files/documents/foo.rtf'; IOFactory::load($filename, 'RTF'); } } ================================================ FILE: tests/PhpWordTests/Reader/Word2007/ElementTest.php ================================================ Test node value '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); self::assertInstanceOf(Text::class, $elements[0]->getElement(0)); $text = $elements[0]; self::assertEquals('Test node value', trim($text->getElement(0)->getText())); } /** * Test reading of textbreak. */ public function testReadTextBreak(): void { $documentXml = ' test string '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $elements[0]; self::assertInstanceOf('PhpOffice\PhpWord\Element\TextBreak', $textRun->getElement(0)); self::assertInstanceOf(Text::class, $textRun->getElement(1)); self::assertEquals('test string', $textRun->getElement(1)->getText()); } /** * Test reading content inside w:smartTag. */ public function testSmartTag(): void { $documentXml = ' test string '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $elements[0]; self::assertInstanceOf(Text::class, $textRun->getElement(0)); self::assertEquals('test string', $textRun->getElement(0)->getText()); } /** * Test reading of textbreak. */ public function testReadListItemRunWithFormatting(): void { $documentXml = ' Two with bold '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $sections = $phpWord->getSection(0); self::assertNull($sections->getElement(999)); self::assertInstanceOf('PhpOffice\PhpWord\Element\ListItemRun', $sections->getElement(0)); self::assertEquals(0, $sections->getElement(0)->getDepth()); $listElements = $sections->getElement(0)->getElements(); /** @var Text $listElement0 */ $listElement0 = $listElements[0]; self::assertInstanceOf(Text::class, $listElement0); self::assertEquals('Two', $listElement0->getText()); /** @var Text $listElement1 */ $listElement1 = $listElements[1]; self::assertEquals(' with ', $listElement1->getText()); /** @var Text $listElement2 */ $listElement2 = $listElements[2]; self::assertEquals('bold', $listElement2->getText()); /** @var Font $listElement2FontStyle */ $listElement2FontStyle = $listElement2->getFontStyle(); self::assertInstanceOf(Font::class, $listElement2FontStyle); self::assertTrue($listElement2FontStyle->isBold()); } /** * Test reading track changes. */ public function testReadTrackChange(): void { $documentXml = ' One two three '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); /** @var \PhpOffice\PhpWord\Element\TextRun $elements */ $textRun = $elements[0]; self::assertEquals('One ', $textRun->getElement(0)->getText()); self::assertEquals('two', $textRun->getElement(1)->getText()); self::assertNotNull($textRun->getElement(1)->getTrackChange()); /** @var TrackChange $trackChange */ $trackChange = $textRun->getElement(1)->getTrackChange(); self::assertEquals(TrackChange::DELETED, $trackChange->getChangeType()); self::assertEquals('three', $textRun->getElement(2)->getText()); self::assertNotNull($textRun->getElement(2)->getTrackChange()); /** @var TrackChange $trackChange */ $trackChange = $textRun->getElement(2)->getTrackChange(); self::assertEquals(TrackChange::INSERTED, $trackChange->getChangeType()); } /** * Test reading of tab. */ public function testReadTab(): void { $documentXml = ' One Two '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $elements[0]; self::assertInstanceOf(Text::class, $textRun->getElement(0)); self::assertEquals('One', $textRun->getElement(0)->getText()); self::assertInstanceOf(Text::class, $textRun->getElement(1)); self::assertEquals("\t", $textRun->getElement(1)->getText()); self::assertInstanceOf(Text::class, $textRun->getElement(2)); self::assertEquals('Two', $textRun->getElement(2)->getText()); } /** * Test reading Title style. */ public function testReadTitleStyle(): void { $documentXml = ' This is a non formatted title This is a bold title '; $stylesXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml, 'styles' => $stylesXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Title', $elements[0]); /** @var \PhpOffice\PhpWord\Element\Title $title */ $title = $elements[0]; self::assertEquals('Title', $title->getStyle()); self::assertEquals('This is a non formatted title', $title->getText()); self::assertInstanceOf(\PhpOffice\PhpWord\Element\Title::class, $elements[1]); /** @var \PhpOffice\PhpWord\Element\Title $formattedTitle */ $formattedTitle = $elements[1]; self::assertEquals('Title', $formattedTitle->getStyle()); self::assertInstanceOf(\PhpOffice\PhpWord\Element\TextRun::class, $formattedTitle->getText()); } /** * Test reading of nested table. */ public function testReadNestedTable(): void { $documentXml = ' ${Field} '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $section = $phpWord->getSection(0); $table = $section->getElement(0); $rows = $table->getRows(); $cells = $rows[0]->getCells(); $nestedTable = $cells[0]->getElement(0); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $nestedTable); } /** * Test reading Drawing. */ public function testReadDrawing(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); } /** * Test reading FormField - DROPDOWN. */ public function testReadFormFieldDropdown(): void { $documentXml = ' Reference FORMDROPDOWN '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); $subElements = $elements[0]->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $subElements[0]); self::assertEquals('Reference', $subElements[0]->getText()); self::assertInstanceOf('PhpOffice\PhpWord\Element\FormField', $subElements[1]); self::assertEquals('dropdown', $subElements[1]->getType()); self::assertEquals('DropDownList1', $subElements[1]->getName()); self::assertEquals('2', $subElements[1]->getValue()); self::assertEquals('Option Two', $subElements[1]->getText()); self::assertEquals(['TBD', 'Option One', 'Option Two', 'Option Three', 'Other'], $subElements[1]->getEntries()); } /** * Test reading FormField - textinput. */ public function testReadFormFieldTextinput(): void { $documentXml = ' Fieldname FORMTEXT This is some sample text '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); $subElements = $elements[0]->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $subElements[0]); self::assertEquals('Fieldname', $subElements[0]->getText()); self::assertInstanceOf('PhpOffice\PhpWord\Element\FormField', $subElements[1]); self::assertEquals('textinput', $subElements[1]->getType()); self::assertEquals('TextInput2', $subElements[1]->getName()); self::assertEquals('This is some sample text', $subElements[1]->getValue()); self::assertEquals('This is some sample text', $subElements[1]->getText()); } /** * Test reading FormField - checkbox. */ public function testReadFormFieldCheckbox(): void { $documentXml = ' FORMCHECKBOX '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); $subElements = $elements[0]->getElements(); // $this->assertInstanceOf('PhpOffice\PhpWord\Element\Text', $subElements[0]); // $this->assertEquals('Fieldname', $subElements[0]->getText()); self::assertInstanceOf('PhpOffice\PhpWord\Element\FormField', $subElements[0]); self::assertEquals('checkbox', $subElements[0]->getType()); self::assertEquals('SomeCheckbox', $subElements[0]->getName()); } /** * Test reading of ruby. */ public function testReadRuby(): void { $documentXml = ' わたし 私 '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); $subElements = $elements[0]->getElements(); // self::assertInstanceOf('PhpOffice\PhpWord\Element\Ruby', $subElements[0]); /** @var RubyProperties $rubyProperties */ $rubyProperties = $subElements[0]->getProperties(); self::assertEquals(RubyProperties::ALIGNMENT_DISTRIBUTE_SPACE, $rubyProperties->getAlignment()); self::assertEquals(12, $rubyProperties->getFontFaceSize()); self::assertEquals(22, $rubyProperties->getFontPointsAboveBaseText()); self::assertEquals(24, $rubyProperties->getFontSizeForBaseText()); self::assertEquals('ja-JP', $rubyProperties->getLanguageId()); /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $subElements[0]->getBaseTextRun(); self::assertEquals('私', $textRun->getText()); $textRun = $subElements[0]->getRubyTextRun(); self::assertEquals('わたし', $textRun->getText()); } /** * Test reading of ruby title. */ public function testReadRubyTitle(): void { $documentXml = ' かみ 神 '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Title', $elements[0]); /** @var \PhpOffice\PhpWord\Element\Title $title */ $title = $elements[0]; /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $title->getText(); $subElements = $textRun->getElements(); // self::assertInstanceOf('PhpOffice\PhpWord\Element\Ruby', $subElements[0]); /** @var Ruby $ruby */ $ruby = $subElements[0]; /** @var RubyProperties $rubyProperties */ $rubyProperties = $ruby->getProperties(); self::assertEquals(RubyProperties::ALIGNMENT_DISTRIBUTE_SPACE, $rubyProperties->getAlignment()); self::assertEquals(20, $rubyProperties->getFontFaceSize()); self::assertEquals(38, $rubyProperties->getFontPointsAboveBaseText()); self::assertEquals(40, $rubyProperties->getFontSizeForBaseText()); self::assertEquals('ja-JP', $rubyProperties->getLanguageId()); /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $ruby->getBaseTextRun(); self::assertEquals('神', $textRun->getText()); $textRun = $ruby->getRubyTextRun(); self::assertEquals('かみ', $textRun->getText()); } } ================================================ FILE: tests/PhpWordTests/Reader/Word2007/PartTest.php ================================================ This is a test And another one '; $footnotesXml = ' footnote text '; $endnotesXml = ' This is an endnote '; $phpWord = $this->getDocumentFromString(['document' => $documentXml, 'footnotes' => $footnotesXml, 'endnotes' => $endnotesXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $elements[0]); /** @var \PhpOffice\PhpWord\Element\TextRun $textRun */ $textRun = $elements[0]; //test the text in the first paragraph /** @var \PhpOffice\PhpWord\Element\Text $text */ $text = $elements[0]->getElement(0); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $text); self::assertEquals('This is a test', $text->getText()); //test the presence of the footnote in the document.xml /** @var \PhpOffice\PhpWord\Element\Footnote $footnote */ $documentFootnote = $textRun->getElement(1); self::assertInstanceOf('PhpOffice\PhpWord\Element\Footnote', $documentFootnote); self::assertEquals(1, $documentFootnote->getRelationId()); //test the presence of the footnote in the footnote.xml /** @var \PhpOffice\PhpWord\Element\Footnote $footnote */ $footnote = $phpWord->getFootnotes()->getItem(1); self::assertInstanceOf('PhpOffice\PhpWord\Element\Footnote', $footnote); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $footnote->getElement(0)); self::assertEquals('footnote text', $footnote->getElement(0)->getText()); self::assertEquals(1, $footnote->getRelationId()); //test the text in the second paragraph /** @var \PhpOffice\PhpWord\Element\Text $text */ $text = $elements[1]->getElement(0); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $text); self::assertEquals('And another one', $text->getText()); //test the presence of the endnote in the document.xml /** @var \PhpOffice\PhpWord\Element\Endnote $endnote */ $documentEndnote = $elements[1]->getElement(1); self::assertInstanceOf('PhpOffice\PhpWord\Element\Endnote', $documentEndnote); self::assertEquals(2, $documentEndnote->getRelationId()); //test the presence of the endnote in the endnote.xml /** @var \PhpOffice\PhpWord\Element\Endnote $endnote */ $endnote = $phpWord->getEndnotes()->getItem(1); self::assertInstanceOf('PhpOffice\PhpWord\Element\Endnote', $endnote); self::assertEquals(2, $endnote->getRelationId()); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $endnote->getElement(0)); self::assertEquals('This is an endnote', $endnote->getElement(0)->getText()); } public function testReadHeadingWithOverriddenStyle(): void { $documentXml = ' This is a bold heading but with parts not in bold '; $stylesXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml, 'styles' => $stylesXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Title', $elements[0]); /** @var \PhpOffice\PhpWord\Element\Title $title */ $title = $elements[0]; self::assertEquals('Heading1', $title->getStyle()); /** @var \PhpOffice\PhpWord\Element\Text $text */ $text = $title->getText()->getElement(0); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $text); self::assertEquals('This is a bold ', $text->getText()); /** @var \PhpOffice\PhpWord\Element\Text $text */ $text = $title->getText()->getElement(1); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $text); self::assertEquals('heading', $text->getText()); self::assertFalse($text->getFontStyle()->isBold()); /** @var \PhpOffice\PhpWord\Element\Text $text */ $text = $title->getText()->getElement(2); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $text); self::assertEquals(' but with parts not in bold', $text->getText()); } } ================================================ FILE: tests/PhpWordTests/Reader/Word2007/StyleTest.php ================================================ '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); self::assertInstanceOf('PhpOffice\PhpWord\Style\Table', $elements[0]->getStyle()); self::assertEquals(Table::LAYOUT_FIXED, $elements[0]->getStyle()->getLayout()); } /** * Test reading of table position. */ public function testReadTablePosition(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); self::assertInstanceOf('PhpOffice\PhpWord\Style\Table', $elements[0]->getStyle()); self::assertNotNull($elements[0]->getStyle()->getPosition()); self::assertInstanceOf('PhpOffice\PhpWord\Style\TablePosition', $elements[0]->getStyle()->getPosition()); /** @var TablePosition $tableStyle */ $tableStyle = $elements[0]->getStyle()->getPosition(); self::assertEquals(10, $tableStyle->getLeftFromText()); self::assertEquals(20, $tableStyle->getRightFromText()); self::assertEquals(30, $tableStyle->getTopFromText()); self::assertEquals(40, $tableStyle->getBottomFromText()); self::assertEquals(TablePosition::VANCHOR_PAGE, $tableStyle->getVertAnchor()); self::assertEquals(TablePosition::HANCHOR_MARGIN, $tableStyle->getHorzAnchor()); self::assertEquals(TablePosition::XALIGN_CENTER, $tableStyle->getTblpXSpec()); self::assertEquals(50, $tableStyle->getTblpX()); self::assertEquals(TablePosition::YALIGN_TOP, $tableStyle->getTblpYSpec()); self::assertEquals(60, $tableStyle->getTblpY()); } public function testReadTableCellNoWrap(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); $rows = $elements[0]->getRows(); $cells = $rows[0]->getCells(); self::assertTrue($cells[0]->getStyle()->getNoWrap()); } /** * Test reading of cell spacing. */ public function testReadTableCellSpacing(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); self::assertInstanceOf('PhpOffice\PhpWord\Style\Table', $elements[0]->getStyle()); /** @var Table $tableStyle */ $tableStyle = $elements[0]->getStyle(); self::assertEquals(TblWidth::AUTO, $tableStyle->getUnit()); self::assertEquals(10.5, $tableStyle->getCellSpacing()); } public function testReadTableCellStyle(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); $rows = $elements[0]->getRows(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Row', $rows[0]); $cells = $rows[0]->getCells(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Cell', $cells[0]); $styleCell = $cells[0]->getStyle(); self::assertInstanceOf('PhpOffice\PhpWord\Style\Cell', $styleCell); self::assertEquals(4, $styleCell->getBorderTopSize()); self::assertEquals(Border::SINGLE, $styleCell->getBorderTopStyle()); self::assertEquals('auto', $styleCell->getBorderTopColor()); self::assertEquals(4, $styleCell->getBorderBottomSize()); self::assertEquals(Border::DOUBLE, $styleCell->getBorderBottomStyle()); self::assertEquals('auto', $styleCell->getBorderBottomColor()); } public function testReadTableCellsWithVerticalMerge(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $table = $phpWord->getSection(0)->getElements()[0]; self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $table); $rows = $table->getRows(); self::assertCount(3, $rows); foreach ($rows as $row) { self::assertCount(1, $row->getCells()); } self::assertSame('restart', $rows[0]->getCells()[0]->getStyle()->getVMerge()); self::assertSame('continue', $rows[1]->getCells()[0]->getStyle()->getVMerge()); self::assertNull($rows[2]->getCells()[0]->getStyle()->getVMerge()); } /** * Test reading of position. */ public function testReadPosition(): void { $documentXml = ' This text is lowered '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); /** @var TextRun $elements */ $textRun = $elements[0]; self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $textRun); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $textRun->getElement(0)); self::assertInstanceOf('PhpOffice\PhpWord\Style\Font', $textRun->getElement(0)->getFontStyle()); /** @var Style\Font $fontStyle */ $fontStyle = $textRun->getElement(0)->getFontStyle(); self::assertEquals(15, $fontStyle->getPosition()); } public function testReadIndent(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); self::assertInstanceOf('PhpOffice\PhpWord\Style\Table', $elements[0]->getStyle()); /** @var Table $tableStyle */ $tableStyle = $elements[0]->getStyle(); self::assertSame(TblWidth::TWIP, $tableStyle->getIndent()->getType()); self::assertSame(2160, $tableStyle->getIndent()->getValue()); } public function testReadTableRTL(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); self::assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]); self::assertInstanceOf('PhpOffice\PhpWord\Style\Table', $elements[0]->getStyle()); /** @var Table $tableStyle */ $tableStyle = $elements[0]->getStyle(); self::assertTrue($tableStyle->isBidiVisual()); } public function testReadHidden(): void { $documentXml = ' This text is hidden '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $elements = $phpWord->getSection(0)->getElements(); /** @var TextRun $elements */ $textRun = $elements[0]; self::assertInstanceOf('PhpOffice\PhpWord\Element\TextRun', $textRun); self::assertInstanceOf('PhpOffice\PhpWord\Element\Text', $textRun->getElement(0)); self::assertInstanceOf('PhpOffice\PhpWord\Style\Font', $textRun->getElement(0)->getFontStyle()); /** @var Style\Font $fontStyle */ $fontStyle = $textRun->getElement(0)->getFontStyle(); self::assertTrue($fontStyle->isHidden()); } public function testReadHeading(): void { Style::resetStyles(); $documentXml = ' '; $name = 'Heading_1'; $this->getDocumentFromString(['styles' => $documentXml]); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Font', Style::getStyle($name)); } public function testPageVerticalAlign(): void { $documentXml = ' '; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $sectionStyle = $phpWord->getSection(0)->getStyle(); self::assertEquals(VerticalJc::CENTER, $sectionStyle->getVAlign()); } /** * @dataProvider providerIndentation */ public function testIndentation( string $indent, float $left, float $right, ?float $hanging, float $firstLine, int $firstLineChars ): void { $documentXml = " $indent 1. "; $phpWord = $this->getDocumentFromString(['document' => $documentXml]); $section = $phpWord->getSection(0); $textRun = $section->getElements()[0]; self::assertInstanceOf(TextRun::class, $textRun); $paragraphStyle = $textRun->getParagraphStyle(); self::assertInstanceOf(Style\Paragraph::class, $paragraphStyle); $indentation = $paragraphStyle->getIndentation(); self::assertSame($left, $indentation->getLeft()); self::assertSame($right, $indentation->getRight()); self::assertSame($hanging, $indentation->getHanging()); self::assertSame($firstLine, $indentation->getFirstLine()); self::assertSame($firstLineChars, $indentation->getFirstLineChars()); } /** * @return Generator */ public static function providerIndentation() { yield [ '', 709.00, 488.00, 10.0, 490.00, 140, ]; yield [ '', 709.00, 488.00, 10.0, 490.00, 0, ]; yield [ '', 0, 0, 10.0, 490.00, 0, ]; yield [ '', 709.00, 0, 0, 0, 0, ]; yield [ '', 0, 488.00, 0, 0, 0, ]; } } ================================================ FILE: tests/PhpWordTests/Reader/Word2007Test.php ================================================ canRead(dirname(__DIR__, 1) . '/_files/documents/reader.docx')); } /** * Can read exception. */ public function testCanReadFailed(): void { $object = new Word2007(); self::assertFalse($object->canRead(dirname(__DIR__, 1) . '/_files/documents/foo.docx')); } /** * Load. */ public function testLoad(): void { $phpWord = IOFactory::load(dirname(__DIR__, 1) . '/_files/documents/reader.docx', 'Word2007'); self::assertInstanceOf(PhpWord::class, $phpWord); self::assertTrue($phpWord->getSettings()->hasDoNotTrackMoves()); self::assertFalse($phpWord->getSettings()->hasDoNotTrackFormatting()); self::assertEquals(100, $phpWord->getSettings()->getZoom()); $doc = TestHelperDOCX::getDocument($phpWord); self::assertEquals('0', $doc->getElementAttribute('/w:document/w:body/w:p/w:r[w:t/node()="italics"]/w:rPr/w:b', 'w:val')); } public function testLoadStyles(): void { $phpWord = IOFactory::load(dirname(__DIR__, 1) . '/_files/documents/reader-styles.docx', 'Word2007'); self::assertInstanceOf(PhpWord::class, $phpWord); $section2 = $phpWord->getSection(2); self::assertInstanceOf(Section::class, $section2); $element2e31 = $section2->getElement(31); self::assertInstanceOf(TextRun::class, $element2e31); self::assertEquals('This is a paragraph with border differents', $element2e31->getText()); /** @var Paragraph $element2e31pStyle */ $element2e31pStyle = $element2e31->getParagraphStyle(); self::assertInstanceOf(Paragraph::class, $element2e31pStyle); // Top self::assertEquals('FFFF00', $element2e31pStyle->getBorderTopColor()); self::assertEquals('10', $element2e31pStyle->getBorderTopSize()); self::assertEquals('dotted', $element2e31pStyle->getBorderTopStyle()); // Right self::assertEquals('00A933', $element2e31pStyle->getBorderRightColor()); self::assertEquals('4', $element2e31pStyle->getBorderRightSize()); self::assertEquals('dashed', $element2e31pStyle->getBorderRightStyle()); // Bottom self::assertEquals('F10D0C', $element2e31pStyle->getBorderBottomColor()); self::assertEquals('8', $element2e31pStyle->getBorderBottomSize()); self::assertEquals('dashSmallGap', $element2e31pStyle->getBorderBottomStyle()); // Left self::assertEquals('3465A4', $element2e31pStyle->getBorderLeftColor()); self::assertEquals('8', $element2e31pStyle->getBorderLeftSize()); self::assertEquals('dashed', $element2e31pStyle->getBorderLeftStyle()); } /** * Load a Word 2011 file. */ public function testLoadWord2011(): void { $reader = new Word2007(); $phpWord = $reader->load(dirname(__DIR__, 1) . '/_files/documents/reader-2011.docx'); self::assertInstanceOf(PhpWord::class, $phpWord); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[3]/w:r/w:pict/v:shape/v:imagedata')); } /** * Load a Word without/withoutImages. * * @dataProvider providerSettingsImageLoading */ public function testLoadWord2011SettingsImageLoading(bool $hasImageLoading): void { $reader = new Word2007(); $reader->setImageLoading($hasImageLoading); $phpWord = $reader->load(dirname(__DIR__, 1) . '/_files/documents/reader-2011.docx'); self::assertInstanceOf(PhpWord::class, $phpWord); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $section = $sections[0]; $elements = $section->getElements(); self::assertCount(3, $elements); $element = $elements[2]; self::assertInstanceOf(TextRun::class, $element); $subElements = $element->getElements(); if ($hasImageLoading) { self::assertCount(1, $subElements); $subElement = $subElements[0]; self::assertInstanceOf(Image::class, $subElement); } else { self::assertCount(0, $subElements); } } public static function providerSettingsImageLoading(): iterable { return [ [true], [false], ]; } public function testLoadComments(): void { $phpWord = IOFactory::load(dirname(__DIR__, 1) . '/_files/documents/reader-comments.docx'); self::assertInstanceOf(PhpWord::class, $phpWord); self::assertEquals(2, $phpWord->getComments()->countItems()); /** @var Comment $comment */ $comment = $phpWord->getComments()->getItem(0); self::assertInstanceOf(Comment::class, $comment); self::assertEquals('shaedrich', $comment->getAuthor()); self::assertEquals(new DateTime('2021-10-28T13:56:55Z'), $comment->getDate()); self::assertEquals('SH', $comment->getInitials()); self::assertCount(1, $comment->getElements()); self::assertInstanceOf(Text::class, $comment->getElement(0)); self::assertEquals('This this be lowercase', $comment->getElement(0)->getText()); /** @var Font $fontStyle */ $fontStyle = $comment->getElement(0)->getFontStyle(); self::assertInstanceOf(Font::class, $fontStyle); self::assertEquals('de-DE', $fontStyle->getLang()->getLatin()); /** @var Comment $comment */ $comment = $phpWord->getComments()->getItem(1); self::assertInstanceOf(Comment::class, $comment); self::assertEquals('shaedrich', $comment->getAuthor()); self::assertEquals(new DateTime('2021-11-02T19:10:00Z'), $comment->getDate()); self::assertEquals('SH', $comment->getInitials()); self::assertCount(1, $comment->getElements()); self::assertInstanceOf(Text::class, $comment->getElement(0)); self::assertEquals('But this should be uppercase', $comment->getElement(0)->getText()); /** @var Font $fontStyle */ $fontStyle = $comment->getElement(0)->getFontStyle(); self::assertInstanceOf(Font::class, $fontStyle); self::assertEquals('de-DE', $fontStyle->getLang()->getLatin()); } public function testLoadFormula(): void { $phpWord = IOFactory::load(dirname(__DIR__, 1) . '/_files/documents/reader-formula.docx'); self::assertInstanceOf(PhpWord::class, $phpWord); $sections = $phpWord->getSections(); self::assertCount(1, $sections); $section = $sections[0]; self::assertInstanceOf(Section::class, $section); $elements = $section->getElements(); self::assertCount(1, $elements); $element = $elements[0]; self::assertInstanceOf(Formula::class, $element); $elements = $element->getMath()->getElements(); self::assertCount(5, $elements); /** @var Element\Fraction $element */ $element = $elements[0]; self::assertInstanceOf(Element\Fraction::class, $element); /** @var Element\Identifier $numerator */ $numerator = $element->getNumerator(); self::assertInstanceOf(Element\Identifier::class, $numerator); self::assertEquals('π', $numerator->getValue()); /** @var Element\Numeric $denominator */ $denominator = $element->getDenominator(); self::assertInstanceOf(Element\Numeric::class, $denominator); self::assertEquals(2, $denominator->getValue()); /** @var Element\Operator $element */ $element = $elements[1]; self::assertInstanceOf(Element\Operator::class, $element); self::assertEquals('+', $element->getValue()); /** @var Element\Identifier $element */ $element = $elements[2]; self::assertInstanceOf(Element\Identifier::class, $element); self::assertEquals('a', $element->getValue()); /** @var Element\Operator $element */ $element = $elements[3]; self::assertInstanceOf(Element\Operator::class, $element); self::assertEquals('∗', $element->getValue()); /** @var Element\Numeric $element */ $element = $elements[4]; self::assertInstanceOf(Element\Numeric::class, $element); self::assertEquals(2, $element->getValue()); } } ================================================ FILE: tests/PhpWordTests/SettingsTest.php ================================================ compatibility = Settings::hasCompatibility(); $this->defaultFontColor = Settings::getDefaultFontColor(); $this->defaultFontSize = Settings::getDefaultFontSize(); $this->defaultFontName = Settings::getDefaultFontName(); $this->defaultPaper = Settings::getDefaultPaper(); $this->measurementUnit = Settings::getMeasurementUnit(); $this->outputEscapingEnabled = Settings::isOutputEscapingEnabled(); $this->pdfRendererName = Settings::getPdfRendererName(); $this->pdfRendererOptions = Settings::getPdfRendererOptions(); $this->pdfRendererPath = Settings::getPdfRendererPath(); $this->tempDir = Settings::getTempDir(); $this->zipClass = Settings::getZipClass(); $this->defaultRtl = Settings::isDefaultRtl(); } protected function tearDown(): void { Settings::setCompatibility($this->compatibility); Settings::setDefaultFontColor($this->defaultFontColor); Settings::setDefaultFontSize($this->defaultFontSize); Settings::setDefaultFontName($this->defaultFontName); Settings::setDefaultPaper($this->defaultPaper); Settings::setMeasurementUnit($this->measurementUnit); Settings::setOutputEscapingEnabled($this->outputEscapingEnabled); Settings::setPdfRendererName($this->pdfRendererName); Settings::setPdfRendererOptions($this->pdfRendererOptions); Settings::setPdfRendererPath($this->pdfRendererPath); Settings::setTempDir($this->tempDir); Settings::setZipClass($this->zipClass); Settings::setDefaultRtl($this->defaultRtl); } /** * Test set/get compatibity option. */ public function testSetGetCompatibility(): void { self::assertTrue(Settings::hasCompatibility()); self::assertTrue(Settings::setCompatibility(false)); self::assertFalse(Settings::hasCompatibility()); } /** * Test set/get outputEscapingEnabled option. */ public function testSetGetOutputEscapingEnabled(): void { self::assertFalse(Settings::isOutputEscapingEnabled()); Settings::setOutputEscapingEnabled(true); self::assertTrue(Settings::isOutputEscapingEnabled()); } public function testSetGetDefaultRtl(): void { self::assertNull(Settings::isDefaultRtl()); Settings::setDefaultRtl(true); self::assertTrue(Settings::isDefaultRtl()); Settings::setDefaultRtl(false); self::assertFalse(Settings::isDefaultRtl()); Settings::setDefaultRtl(null); self::assertNull(Settings::isDefaultRtl()); } /** * Test set/get zip class. */ public function testSetGetZipClass(): void { self::assertEquals(Settings::ZIPARCHIVE, Settings::getZipClass()); self::assertFalse(Settings::setZipClass('foo')); self::assertEquals(Settings::ZIPARCHIVE, Settings::getZipClass()); self::assertTrue(Settings::setZipClass(Settings::PCLZIP)); self::assertEquals(Settings::getZipClass(), Settings::PCLZIP); self::assertFalse(Settings::setZipClass('foo')); self::assertEquals(Settings::getZipClass(), Settings::PCLZIP); } /** * Test set/get PDF renderer. */ public function testSetGetPdfRenderer(): void { $domPdfPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/dompdf/dompdf'); self::assertFalse(Settings::setPdfRenderer('FOO', 'dummy/path')); self::assertTrue(Settings::setPdfRenderer(Settings::PDF_RENDERER_DOMPDF, $domPdfPath)); self::assertEquals(Settings::PDF_RENDERER_DOMPDF, Settings::getPdfRendererName()); self::assertEquals($domPdfPath, Settings::getPdfRendererPath()); self::assertFalse(Settings::setPdfRendererPath('dummy/path')); self::assertEquals($domPdfPath, Settings::getPdfRendererPath()); } /** * Test set/get PDF renderer. */ public function testSetGetPdfOptions(): void { $domPdfPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/dompdf/dompdf'); self::assertEquals([], Settings::getPdfRendererOptions()); Settings::setPdfRendererOptions([ 'font' => 'Arial', ]); self::assertEquals([ 'font' => 'Arial', ], Settings::getPdfRendererOptions()); } /** * Test set/get measurement unit. */ public function testSetGetMeasurementUnit(): void { self::assertEquals(Settings::UNIT_TWIP, Settings::getMeasurementUnit()); self::assertFalse(Settings::setMeasurementUnit('foo')); self::assertEquals(Settings::UNIT_TWIP, Settings::getMeasurementUnit()); self::assertTrue(Settings::setMeasurementUnit(Settings::UNIT_INCH)); self::assertEquals(Settings::UNIT_INCH, Settings::getMeasurementUnit()); self::assertFalse(Settings::setMeasurementUnit('foo')); self::assertEquals(Settings::UNIT_INCH, Settings::getMeasurementUnit()); } /** * @covers ::getTempDir */ public function testPhpTempDirIsUsedByDefault(): void { self::assertEquals(sys_get_temp_dir(), Settings::getTempDir()); } /** * @covers ::getTempDir * @covers ::setTempDir * * @depends testPhpTempDirIsUsedByDefault */ public function testTempDirCanBeSet(): void { $userDefinedTempDir = 'C:\PhpWordTemp'; Settings::setTempDir($userDefinedTempDir); $currentTempDir = Settings::getTempDir(); self::assertEquals($userDefinedTempDir, $currentTempDir); self::assertNotEquals(sys_get_temp_dir(), $currentTempDir); } /** * Test set/get default font name. */ public function testSetGetDefaultFontName(): void { self::assertEquals(Settings::DEFAULT_FONT_NAME, Settings::getDefaultFontName()); self::assertFalse(Settings::setDefaultFontName(' ')); self::assertEquals(Settings::DEFAULT_FONT_NAME, Settings::getDefaultFontName()); self::assertTrue(Settings::setDefaultFontName('Times New Roman')); self::assertEquals('Times New Roman', Settings::getDefaultFontName()); self::assertFalse(Settings::setDefaultFontName(' ')); self::assertEquals('Times New Roman', Settings::getDefaultFontName()); } /** * Test set/get default font name. */ public function testSetGetDefaultAsianFontName(): void { self::assertEquals(Settings::DEFAULT_FONT_NAME, Settings::getDefaultAsianFontName()); self::assertFalse(Settings::setDefaultAsianFontName(' ')); self::assertEquals(Settings::DEFAULT_FONT_NAME, Settings::getDefaultAsianFontName()); self::assertTrue(Settings::setDefaultAsianFontName('Times New Roman')); self::assertEquals('Times New Roman', Settings::getDefaultAsianFontName()); self::assertFalse(Settings::setDefaultAsianFontName(' ')); self::assertEquals('Times New Roman', Settings::getDefaultAsianFontName()); } /** * Test set/get default font size. */ public function testSetGetDefaultFontSize(): void { self::assertEquals(Settings::DEFAULT_FONT_SIZE, Settings::getDefaultFontSize()); self::assertFalse(Settings::setDefaultFontSize(null)); self::assertEquals(Settings::DEFAULT_FONT_SIZE, Settings::getDefaultFontSize()); self::assertTrue(Settings::setDefaultFontSize(12)); self::assertEquals(12, Settings::getDefaultFontSize()); self::assertFalse(Settings::setDefaultFontSize(null)); self::assertEquals(12, Settings::getDefaultFontSize()); self::assertTrue(Settings::setDefaultFontSize(12.5)); self::assertEquals(12.5, Settings::getDefaultFontSize()); self::assertFalse(Settings::setDefaultFontSize(0.5)); self::assertEquals(12.5, Settings::getDefaultFontSize()); self::assertFalse(Settings::setDefaultFontSize(0)); self::assertEquals(12.5, Settings::getDefaultFontSize()); } /** * Test set/get default font color. */ public function testSetGetDefaultFontColor(): void { self::assertEquals(Settings::DEFAULT_FONT_COLOR, Settings::getDefaultFontColor()); self::assertFalse(Settings::setDefaultFontColor(' ')); self::assertEquals(Settings::DEFAULT_FONT_COLOR, Settings::getDefaultFontColor()); self::assertTrue(Settings::setDefaultFontColor('FF0000')); self::assertEquals('FF0000', Settings::getDefaultFontColor()); self::assertFalse(Settings::setDefaultFontColor(' ')); self::assertEquals('FF0000', Settings::getDefaultFontColor()); } /** * Test set/get default paper. */ public function testSetGetDefaultPaper(): void { $dflt = Settings::DEFAULT_PAPER; $chng = 'A4'; $doc = new PhpWord(); self::assertEquals($dflt, Settings::getDefaultPaper()); $sec1 = $doc->addSection(); self::assertEquals($dflt, $sec1->getStyle()->getPaperSize()); self::assertFalse(Settings::setDefaultPaper('')); self::assertEquals($dflt, Settings::getDefaultPaper()); self::assertTrue(Settings::setDefaultPaper($chng)); self::assertEquals($chng, Settings::getDefaultPaper()); $sec2 = $doc->addSection(); self::assertEquals($chng, $sec2->getStyle()->getPaperSize()); $sec3 = $doc->addSection(['paperSize' => 'Legal']); self::assertEquals('Legal', $sec3->getStyle()->getPaperSize()); self::assertFalse(Settings::setDefaultPaper('')); self::assertEquals($chng, Settings::getDefaultPaper()); } /** * Test load config. */ public function testLoadConfig(): void { $expected = [ 'compatibility' => true, 'zipClass' => 'ZipArchive', 'pdfRendererName' => 'DomPDF', 'pdfRendererPath' => '', 'defaultFontName' => 'Arial', 'defaultFontSize' => 10, 'defaultFontColor' => '000000', 'outputEscapingEnabled' => false, 'defaultPaper' => 'A4', ]; // Test default value self::assertEquals($expected, Settings::loadConfig()); // Test with valid file self::assertEquals($expected, Settings::loadConfig(__DIR__ . '/../../phpword.ini.dist')); foreach ($expected as $key => $value) { if ($key === 'compatibility') { $meth = 'hasCompatibility'; } elseif ($key === 'outputEscapingEnabled') { $meth = 'isOutputEscapingEnabled'; } else { $meth = 'get' . ucfirst($key); } self::assertEquals(Settings::$meth(), $value); } // Test with invalid file self::assertEmpty(Settings::loadConfig(__DIR__ . '/../../phpunit.xml.dist')); } } ================================================ FILE: tests/PhpWordTests/Shared/ConverterTest.php ================================================ process(); self::assertEquals([], $css->getStyles()); } public function testBasicCss(): void { $cssContent = '.pStyle { font-size:15px; }'; $css = new Css($cssContent); $css->process(); self::assertEquals([ '.pStyle' => [ 'font-size' => '15px', ], ], $css->getStyles()); self::assertEquals([ 'font-size' => '15px', ], $css->getStyle('.pStyle')); } } ================================================ FILE: tests/PhpWordTests/Shared/DrawingTest.php ================================================ addSection(); self::assertCount(0, $section->getElements()); // Heading $styles = ['strong', 'em', 'sup', 'sub']; for ($level = 1; $level <= 6; ++$level) { $content .= "Heading {$level}"; } // Styles $content .= '

    '; foreach ($styles as $style) { $content .= "<{$style}>{$style}"; } $content .= '

    '; // Add HTML Html::addHtml($section, $content); self::assertCount(7, $section->getElements()); // Other parts $section = $phpWord->addSection(); $content = ''; $content .= '
    HeaderContent
    '; $content .= '
    • Bullet
      • Bullet
    '; $content .= '
    1. Bullet
    '; $content .= "'Single Quoted Text'"; $content .= '"Double Quoted Text"'; $content .= '& Ampersand'; $content .= '<>“‘’«»‹›'; $content .= '&•°…™©®—'; $content .= '–   ²³¼½¾'; Html::addHtml($section, $content); } /** * Test that html already in body element can be read. * * @ignore */ public function testParseFullHtml(): void { $section = new Section(1); Html::addHtml($section, '

    test paragraph1

    test paragraph2

    ', true); self::assertCount(2, $section->getElements()); } public function testParseHeader(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    Text

    '); self::assertCount(1, $section->getElements()); $element = $section->getElement(0); self::assertInstanceOf(TextRun::class, $element); self::assertInstanceOf(Paragraph::class, $element->getParagraphStyle()); self::assertEquals('Heading1', $element->getParagraphStyle()->getStyleName()); self::assertEquals('', $element->getParagraphStyle()->getAlignment()); self::assertEquals('Text', $element->getText()); self::assertCount(1, $element->getElements()); $subElement = $element->getElement(0); self::assertInstanceOf(Text::class, $subElement); self::assertInstanceOf(Font::class, $subElement->getFontStyle()); self::assertNull($subElement->getFontStyle()->getColor()); self::assertEquals('Text', $subElement->getText()); } public function testParseHeaderStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    Text

    '); self::assertCount(1, $section->getElements()); $element = $section->getElement(0); self::assertInstanceOf(TextRun::class, $element); self::assertInstanceOf(Paragraph::class, $element->getParagraphStyle()); self::assertEquals('Heading1', $element->getParagraphStyle()->getStyleName()); self::assertEquals('center', $element->getParagraphStyle()->getAlignment()); self::assertEquals('Text', $element->getText()); self::assertCount(1, $element->getElements()); $subElement = $element->getElement(0); self::assertInstanceOf(Text::class, $subElement); self::assertInstanceOf(Font::class, $subElement->getFontStyle()); self::assertEquals('ff0000', $subElement->getFontStyle()->getColor()); self::assertEquals('Text', $subElement->getText()); } /** * Test HTML entities. */ public function testParseHtmlEntities(): void { \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled(true); $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, 'text with entities <my text>'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:t')); self::assertEquals('text with entities ', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->nodeValue); } public function testParseStyle(): void { $html = '

    Calculator

    '; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]/w:r')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]/w:r/w:t')); self::assertEquals('Calculator', $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:t')->nodeValue); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]/w:r/w:rPr')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]/w:r/w:rPr/w:sz')); self::assertEquals('22.5', $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:r/w:rPr/w:sz', 'w:val')); } public function testParseStyleTableClassName(): void { $html = '
    '; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); self::assertInstanceOf(Table::class, $section->getElement(0)); self::assertEquals('pStyle', $section->getElement(0)->getStyle()->getStyleName()); } /** * Test text-decoration style. */ public function testParseTextDecoration(): void { $html = 'test'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:u')); self::assertEquals('single', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:rPr/w:u', 'w:val')); } /** * Test underline. */ public function testParseUnderline(): void { $html = 'test'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:u')); self::assertEquals('single', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:rPr/w:u', 'w:val')); } /** * Test width. * * @dataProvider providerParseWidth */ public function testParseWidth(string $htmlSize, float $docxSize, string $docxUnit): void { $html = '
    A
    '; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $xpath = '/w:document/w:body/w:tbl/w:tblPr/w:tblW'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals($docxSize, $doc->getElement($xpath)->getAttribute('w:w')); self::assertEquals($docxUnit, $doc->getElement($xpath)->getAttribute('w:type')); } /** * Test font-variant style. */ public function testParseFontVariant(): void { $html = 'test'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:smallCaps')); self::assertEquals('1', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:rPr/w:smallCaps', 'w:val')); } /** * Test font. */ public function testParseFont(): void { $html = 'test'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr')); //TODO check style } /** * Test line-height style. */ public function testParseLineHeight(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:pPr/w:spacing')); self::assertEquals(Paragraph::LINE_HEIGHT * 1.5, $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:spacing', 'w:line')); self::assertEquals(LineSpacingRule::AUTO, $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:spacing', 'w:lineRule')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]/w:pPr/w:spacing')); self::assertEquals(300, $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:pPr/w:spacing', 'w:line')); self::assertEquals(LineSpacingRule::EXACT, $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:pPr/w:spacing', 'w:lineRule')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[3]/w:pPr/w:spacing')); self::assertEquals(Paragraph::LINE_HEIGHT * 1.2, $doc->getElementAttribute('/w:document/w:body/w:p[3]/w:pPr/w:spacing', 'w:line')); self::assertEquals(LineSpacingRule::AUTO, $doc->getElementAttribute('/w:document/w:body/w:p[3]/w:pPr/w:spacing', 'w:lineRule')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[4]/w:pPr/w:spacing')); self::assertEquals(244.8, $doc->getElementAttribute('/w:document/w:body/w:p[4]/w:pPr/w:spacing', 'w:line')); self::assertEquals(LineSpacingRule::EXACT, $doc->getElementAttribute('/w:document/w:body/w:p[4]/w:pPr/w:spacing', 'w:lineRule')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[5]/w:pPr/w:spacing')); self::assertEquals(Paragraph::LINE_HEIGHT, $doc->getElementAttribute('/w:document/w:body/w:p[5]/w:pPr/w:spacing', 'w:line')); self::assertEquals(LineSpacingRule::AUTO, $doc->getElementAttribute('/w:document/w:body/w:p[5]/w:pPr/w:spacing', 'w:lineRule')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[6]/w:pPr/w:spacing')); self::assertEquals(Paragraph::LINE_HEIGHT, $doc->getElementAttribute('/w:document/w:body/w:p[6]/w:pPr/w:spacing', 'w:line')); self::assertEquals(LineSpacingRule::AUTO, $doc->getElementAttribute('/w:document/w:body/w:p[6]/w:pPr/w:spacing', 'w:lineRule')); } public function testParseCellPaddingStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $top = 10; $right = 11; $bottom = 12; $left = 13; $testValTop = Converter::pixelToTwip($top); $testValRight = Converter::pixelToTwip($right); $testValBottom = Converter::pixelToTwip($bottom); $testValLeft = Converter::pixelToTwip($left); $html = '
    full mix top bottom left
    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[1]/w:tcPr/w:tcMar/w:top'; self::assertTrue($doc->elementExists($path)); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[1]/w:tcPr/w:tcMar/w:bottom'; self::assertTrue($doc->elementExists($path)); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[1]/w:tcPr/w:tcMar/w:end'; self::assertTrue($doc->elementExists($path)); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[1]/w:tcPr/w:tcMar/w:start'; self::assertTrue($doc->elementExists($path)); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[2]/w:tcPr/w:tcMar/w:end'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValRight, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[3]/w:tcPr/w:tcMar/w:top'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValTop, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[4]/w:tcPr/w:tcMar/w:bottom'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValBottom, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); $path = '/w:document/w:body/w:tbl/w:tr/w:tc[5]/w:tcPr/w:tcMar/w:start'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValLeft, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); } /** * Test text-indent style. */ public function testParseTextIndent(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    test

    '); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:ind')); self::assertEquals(750, $doc->getElementAttribute('/w:document/w:body/w:p/w:pPr/w:ind', 'w:firstLine')); } /** * Test text-align style. */ public function testParseTextAlign(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); Html::addHtml($section, '

    test

    '); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:jc')); self::assertEquals(Jc::START, $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:jc', 'w:val')); self::assertEquals(Jc::END, $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:pPr/w:jc', 'w:val')); self::assertEquals(Jc::CENTER, $doc->getElementAttribute('/w:document/w:body/w:p[3]/w:pPr/w:jc', 'w:val')); self::assertEquals(Jc::BOTH, $doc->getElementAttribute('/w:document/w:body/w:p[4]/w:pPr/w:jc', 'w:val')); } /** * Test font-size style. */ public function testParseFontSize(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, 'test'); Html::addHtml($section, 'test'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:sz')); self::assertEquals('20', $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:r/w:rPr/w:sz', 'w:val')); self::assertEquals('15', $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:r/w:rPr/w:sz', 'w:val')); } /** * Test direction style. */ public function testParseTextDirection(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, 'test'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:rtl')); } /** * Test html lang. */ public function testParseLang(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, 'test'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:lang')); self::assertEquals('fr-BE', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:rPr/w:lang', 'w:val')); } /** * Test font-family style. */ public function testParseFontFamily(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, 'test'); Html::addHtml($section, 'test'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:rFonts')); self::assertEquals('Arial', $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:r/w:rPr/w:rFonts', 'w:ascii')); self::assertEquals('Times New Roman', $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:r/w:rPr/w:rFonts', 'w:ascii')); } /** * Test parsing paragraph and span styles. */ public function testParseParagraphAndSpanStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    test

    '); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:jc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:spacing')); self::assertEquals(Jc::CENTER, $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:jc', 'w:val')); self::assertEquals('single', $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:r/w:rPr/w:u', 'w:val')); } /** * Test parsing paragraph with `page-break-after` style. */ public function testParseParagraphWithPageBreak(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, '

    '); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:br')); self::assertEquals('page', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:br', 'w:type')); } /** * Test parsing table. */ public function testParseTable(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    header a

    		 header b header c
    12
    This is bold text5

    6
    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr/w:tc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tblPr/w:jc')); self::assertEquals(Jc::START, $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tblPr/w:jc', 'w:val')); //check border colors self::assertEquals('00EE00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]/w:tcPr/w:tcBorders/w:top', 'w:color')); self::assertEquals('00EE00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]/w:tcPr/w:tcBorders/w:right', 'w:color')); self::assertEquals('00EE00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]/w:tcPr/w:tcBorders/w:bottom', 'w:color')); self::assertEquals('00EE00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]/w:tcPr/w:tcBorders/w:left', 'w:color')); self::assertEquals('00AA00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[3]/w:tcPr/w:tcBorders/w:top', 'w:color')); self::assertEquals('00BB00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[3]/w:tcPr/w:tcBorders/w:right', 'w:color')); self::assertEquals('00CC00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[3]/w:tcPr/w:tcBorders/w:bottom', 'w:color')); self::assertEquals('00DD00', $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr[1]/w:tc[3]/w:tcPr/w:tcBorders/w:left', 'w:color')); //check borders are not propagated inside cells self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[1]/w:p')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[1]/w:p/w:pPr/w:pBdr')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]/w:p')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]/w:p/w:pPr/w:pBdr')); } /** * Parse widths in tables and cells, which also allows for controlling column width. */ public function testParseTableAndCellWidth(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection([ 'orientation' => \PhpOffice\PhpWord\Style\Section::ORIENTATION_LANDSCAPE, ]); // borders & backgrounds are here just for better visual comparison $html = <<
    25%
    400px
    T2.R2.C1 50pt T2.R2.C3
    300px T2.R3.C3
    HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); // outer table grid $xpath = '/w:document/w:body/w:tbl/w:tblGrid/w:gridCol'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals(25 * 50, $doc->getElement($xpath)->getAttribute('w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElement($xpath)->getAttribute('w:type')); // elementExists($xpath)); self::assertEquals(6000, $doc->getElement($xpath)->getAttribute('w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElement($xpath)->getAttribute('w:type')); // elementExists($xpath)); self::assertEquals(4500, $doc->getElement($xpath)->getAttribute('w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElement($xpath)->getAttribute('w:type')); } /** * Parse heights in rows, which also allows for controlling column height. */ public function testParseTableRowHeight(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection([ 'orientation' => \PhpOffice\PhpWord\Style\Section::ORIENTATION_LANDSCAPE, ]); $html = << 100px 200pt
    300px
    HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); // elementExists($xpath)); self::assertEquals(4000, $doc->getElement($xpath)->getAttribute('w:val')); self::assertEquals('exact', $doc->getElement($xpath)->getAttribute('w:hRule')); // Header Cell 1 Cell 2 '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tblPr')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tblPr/w:tblBorders')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tblPr/w:tblBorders/w:top')); // 10 pixels = 150 twips self::assertEquals(150, $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tblPr/w:tblBorders/w:top', 'w:sz')); } /** * Test parsing background color for table rows and table cellspacing. */ public function testParseTableCellspacingRowBgColor(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection([ 'orientation' => \PhpOffice\PhpWord\Style\Section::ORIENTATION_LANDSCAPE, ]); // borders & backgrounds are here just for better visual comparison $html = << A B C D HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $xpath = '/w:document/w:body/w:tbl/w:tblPr/w:tblCellSpacing'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals(3 * 15, $doc->getElement($xpath)->getAttribute('w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElement($xpath)->getAttribute('w:type')); $xpath = '/w:document/w:body/w:tbl/w:tr[1]/w:tc[1]/w:tcPr/w:shd'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('lightgreen', $doc->getElement($xpath)->getAttribute('w:fill')); $xpath = '/w:document/w:body/w:tbl/w:tr[2]/w:tc[1]/w:tcPr/w:shd'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('FF0000', $doc->getElement($xpath)->getAttribute('w:fill')); } /** * Test parsing background color for table rows and table cellspacing. */ public function testParseTableStyleAttributeInlineStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection([ 'orientation' => \PhpOffice\PhpWord\Style\Section::ORIENTATION_LANDSCAPE, ]); $html = '
    A
    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $xpath = '/w:document/w:body/w:tbl/w:tblPr/w:tblW'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals(100 * 50, $doc->getElement($xpath)->getAttribute('w:w')); self::assertEquals(TblWidth::PERCENT, $doc->getElement($xpath)->getAttribute('w:type')); $xpath = '/w:document/w:body/w:tbl/w:tr[1]/w:tc[1]/w:tcPr/w:shd'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('red', $doc->getElement($xpath)->getAttribute('w:fill')); } /** * Tests parsing of ul/li. */ public function testParseList(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '
    • list item1
    • list item2
    '; Html::addHtml($section, $html, false, false); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:numPr/w:numId')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:t')); self::assertEquals('list item1', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->nodeValue); self::assertEquals('list item2', $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:t')->nodeValue); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:b')); } /** * Tests parsing of ul/li. */ public function testOrderedListNumbering(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '
    1. List 1 item 1
    2. List 1 item 2

    Some Text

    1. List 2 item 1
    2. List 2 item 2
    '; Html::addHtml($section, $html, false, false); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:numPr/w:numId')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:t')); self::assertEquals('List 1 item 1', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->nodeValue); self::assertEquals('List 2 item 1', $doc->getElement('/w:document/w:body/w:p[4]/w:r/w:t')->nodeValue); $firstListnumId = $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:numPr/w:numId', 'w:val'); $secondListnumId = $doc->getElementAttribute('/w:document/w:body/w:p[4]/w:pPr/w:numPr/w:numId', 'w:val'); self::assertNotEquals($firstListnumId, $secondListnumId); } /** * Tests parsing of nested ul/li. */ public function testOrderedNestedListNumbering(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '
    1. List 1 item 1
    2. List 1 item 2

    Some Text

    1. List 2 item 1
      1. sub list 1
      2. sub list 2
    '; Html::addHtml($section, $html, false, false); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:numPr/w:numId')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:t')); self::assertEquals('List 1 item 1', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->nodeValue); self::assertEquals('List 2 item 1', $doc->getElement('/w:document/w:body/w:p[4]/w:r/w:t')->nodeValue); $firstListnumId = $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:numPr/w:numId', 'w:val'); $secondListnumId = $doc->getElementAttribute('/w:document/w:body/w:p[4]/w:pPr/w:numPr/w:numId', 'w:val'); self::assertNotEquals($firstListnumId, $secondListnumId); } /** * Tests parsing of ul/li. */ public function testParseListWithFormat(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = preg_replace('/\s+/', ' ', '
    • Some text before list item1 bold with text after bold and some after
    • list item2
    '); Html::addHtml($section, $html, false, false); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:numPr/w:numId')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:t')); self::assertEquals('list item2', $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:t')->nodeValue); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r[3]/w:rPr/w:b')); self::assertEquals('bold', $doc->getElement('/w:document/w:body/w:p[1]/w:r[3]/w:t')->nodeValue); } /** * Tests parsing of br. */ public function testParseLineBreak(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    This is some text
    with a linebreak.

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:br')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:t')); self::assertEquals('This is some text', $doc->getElement('/w:document/w:body/w:p/w:r[1]/w:t')->nodeValue); self::assertEquals('with a linebreak.', $doc->getElement('/w:document/w:body/w:p/w:r[2]/w:t')->nodeValue); } /** * Test parsing of img. */ public function testParseImage(): void { $src = __DIR__ . '/../_files/images/firefox.png'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); self::assertStringMatchesFormat('%Swidth:150px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); self::assertStringMatchesFormat('%Sheight:200px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); self::assertStringMatchesFormat('%Smso-position-horizontal:right%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); self::assertStringMatchesFormat('%Smso-position-horizontal:left%S', $doc->getElementAttribute($baseXpath . '[2]/w:pict/v:shape', 'style')); } /** * Test parsing of img. */ public function testParseImageSizeInPixels(): void { $src = __DIR__ . '/../_files/images/firefox.png'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); self::assertStringMatchesFormat('%Swidth:150px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); self::assertStringMatchesFormat('%Sheight:200px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); } /** * Test parsing of img. */ public function testParseImageSizeInPoints(): void { $src = __DIR__ . '/../_files/images/firefox.png'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); self::assertStringMatchesFormat('%Swidth:200px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); self::assertStringMatchesFormat('%Sheight:266.66666666667%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); } /** * Test parsing of img. */ public function testParseImageSizeWithoutUnits(): void { $src = __DIR__ . '/../_files/images/firefox.png'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); self::assertStringMatchesFormat('%Swidth:150px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); self::assertStringMatchesFormat('%Sheight:200px%S', $doc->getElementAttribute($baseXpath . '[1]/w:pict/v:shape', 'style')); } /** * Test parsing of remote img. */ public function testParseRemoteImage(): void { $src = self::getRemoteImageUrl(); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); } /** * Test parsing of remote img without extension. */ public function testParseRemoteImageWithoutExtension(): void { $src = self::getRemoteImageUrlWithoutExtension(); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); } /** * Test parsing embedded image. */ public function testParseEmbeddedImage(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); } /** * Test parsing of remote img that can be found locally. */ public function testParseRemoteLocalImage(): void { $src = 'https://fakedomain.io/images/firefox.png'; $localPath = __DIR__ . '/../_files/images/'; $options = [ 'IMG_SRC_SEARCH' => 'https://fakedomain.io/images/', 'IMG_SRC_REPLACE' => $localPath, ]; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html, false, true, $options); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $baseXpath = '/w:document/w:body/w:p/w:r'; self::assertTrue($doc->elementExists($baseXpath . '/w:pict/v:shape')); } /** * Test parsing of remote img that can be found locally. */ public function testCouldNotLoadImage(): void { $this->expectException(Exception::class); $src = 'https://fakedomain.io/images/firefox.png'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    '; Html::addHtml($section, $html, false, true); } public function testParseLink(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    link text

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:hyperlink')); self::assertEquals('link text', $doc->getElement('/w:document/w:body/w:p/w:hyperlink/w:r/w:t')->nodeValue); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:hyperlink/w:r/w:rPr/w:u')); self::assertEquals('single', $doc->getElementAttribute('/w:document/w:body/w:p/w:hyperlink/w:r/w:rPr/w:u', 'w:val')); } public function testParseLink2(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addBookmark('bookmark'); $html = '

    internal link text

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:hyperlink')); self::assertTrue($doc->getElement('/w:document/w:body/w:p/w:hyperlink')->hasAttribute('w:anchor')); self::assertEquals('bookmark', $doc->getElement('/w:document/w:body/w:p/w:hyperlink')->getAttribute('w:anchor')); } public function testParseLinkAllowsAbsenceOfHref(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    text of href-less link

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:hyperlink')); self::assertEquals('text of href-less link', $doc->getElement('/w:document/w:body/w:p/w:hyperlink/w:r/w:t')->nodeValue); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    text of empty-href link

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:hyperlink')); self::assertEquals('text of empty-href link', $doc->getElement('/w:document/w:body/w:p/w:hyperlink/w:r/w:t')->nodeValue); } public function testParseMalformedStyleIsIgnored(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    text

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertFalse($doc->elementExists('/w:document/w:body/w:p[1]/w:pPr/w:jc')); } /** * Tests parsing hidden text. */ public function testParseHiddenText(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    This is some hidden text.

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:vanish')); } /** * Tests parsing letter spacing. */ public function testParseLetterSpacing(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = '

    This is some text with letter spacing.

    '; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:rPr/w:spacing')); self::assertEquals(150 * 15, $doc->getElement('/w:document/w:body/w:p/w:r/w:rPr/w:spacing')->getAttribute('w:val')); } /** * Tests checkbox input field. */ public function testInputCheckbox(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $html = ''; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:fldChar/w:ffData/w:checkBox')); self::assertEquals(1, $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:fldChar/w:ffData/w:checkBox/w:checked')->getAttribute('w:val')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[2]/w:r/w:fldChar/w:ffData/w:checkBox')); self::assertEquals(0, $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:fldChar/w:ffData/w:checkBox/w:checked')->getAttribute('w:val')); } /** * Parse horizontal rule. */ public function testParseHorizontalRule(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // borders & backgrounds are here just for better visual comparison $html = <<Simple default rule:

    Custom style rule:

    END

    HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); // default rule $xpath = '/w:document/w:body/w:p[2]/w:pPr/w:pBdr/w:bottom'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('single', $doc->getElement($xpath)->getAttribute('w:val')); // solid self::assertEquals('1', $doc->getElement($xpath)->getAttribute('w:sz')); // 1 twip self::assertEquals('000000', $doc->getElement($xpath)->getAttribute('w:color')); // black // custom style rule $xpath = '/w:document/w:body/w:p[4]/w:pPr/w:pBdr/w:bottom'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('single', $doc->getElement($xpath)->getAttribute('w:val')); self::assertEquals((int) (5 * 15 / 2), $doc->getElement($xpath)->getAttribute('w:sz')); self::assertEquals('lightblue', $doc->getElement($xpath)->getAttribute('w:color')); $xpath = '/w:document/w:body/w:p[4]/w:pPr/w:spacing'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals(450, $doc->getElement($xpath)->getAttribute('w:before')); self::assertEquals(0, $doc->getElement($xpath)->getAttribute('w:after')); self::assertEquals(240, $doc->getElement($xpath)->getAttribute('w:line')); } /** * Parse ordered list start & numbering style. */ public function testParseOrderedList(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // borders & backgrounds are here just for better visual comparison $html = <<
  • standard ordered list line 1
  • standard ordered list line 2
    1. ordered list alphabetical, line 5 => E
    2. ordered list alphabetical, line 6 => F
    1. ordered list roman lower, line 3 => iii
    2. ordered list roman lower, line 4 => iv
    HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); // compare numbering file $xmlFile = 'word/numbering.xml'; // default - decimal start = 1 $xpath = '/w:numbering/w:abstractNum[1]/w:lvl[1]/w:start'; self::assertTrue($doc->elementExists($xpath, $xmlFile)); self::assertEquals('1', $doc->getElement($xpath, $xmlFile)->getAttribute('w:val')); $xpath = '/w:numbering/w:abstractNum[1]/w:lvl[1]/w:numFmt'; self::assertTrue($doc->elementExists($xpath, $xmlFile)); self::assertEquals('decimal', $doc->getElement($xpath, $xmlFile)->getAttribute('w:val')); // second list - start = 5, type A = upperLetter $xpath = '/w:numbering/w:abstractNum[2]/w:lvl[1]/w:start'; self::assertTrue($doc->elementExists($xpath, $xmlFile)); self::assertEquals('5', $doc->getElement($xpath, $xmlFile)->getAttribute('w:val')); $xpath = '/w:numbering/w:abstractNum[2]/w:lvl[1]/w:numFmt'; self::assertTrue($doc->elementExists($xpath, $xmlFile)); self::assertEquals('upperLetter', $doc->getElement($xpath, $xmlFile)->getAttribute('w:val')); // third list - start = 3, type i = lowerRoman $xpath = '/w:numbering/w:abstractNum[3]/w:lvl[1]/w:start'; self::assertTrue($doc->elementExists($xpath, $xmlFile)); self::assertEquals('3', $doc->getElement($xpath, $xmlFile)->getAttribute('w:val')); $xpath = '/w:numbering/w:abstractNum[3]/w:lvl[1]/w:numFmt'; self::assertTrue($doc->elementExists($xpath, $xmlFile)); self::assertEquals('lowerRoman', $doc->getElement($xpath, $xmlFile)->getAttribute('w:val')); } /** * Parse ordered list start & numbering style. */ public function testParseVerticalAlign(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // borders & backgrounds are here just for better visual comparison $html = << default top middle bottom






    HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $xpath = '/w:document/w:body/w:tbl/w:tr/w:tc[1]/w:tcPr/w:vAlign'; self::assertFalse($doc->elementExists($xpath)); $xpath = '/w:document/w:body/w:tbl/w:tr/w:tc[2]/w:tcPr/w:vAlign'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('top', $doc->getElement($xpath)->getAttribute('w:val')); $xpath = '/w:document/w:body/w:tbl/w:tr/w:tc[3]/w:tcPr/w:vAlign'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('center', $doc->getElement($xpath)->getAttribute('w:val')); $xpath = '/w:document/w:body/w:tbl/w:tr/w:tc[4]/w:tcPr/w:vAlign'; self::assertTrue($doc->elementExists($xpath)); self::assertEquals('bottom', $doc->getElement($xpath)->getAttribute('w:val')); } /** * Fix bug - don't decode double quotes inside double quoted string. */ public function testDontDecodeAlreadyEncodedDoubleQuotes(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // borders & backgrounds are here just for better visual comparison $html = <<This would crash if inline quotes also decoded at loading XML into DOMDocument!
    HTML; Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertIsObject($doc); } public static function providerParseWidth(): array { return [ ['auto', 5000, TblWidth::PERCENT], ['100%', 5000, TblWidth::PERCENT], ['200pt', 3999.999999999999, TblWidth::TWIP], ['300px', 4500, TblWidth::TWIP], ['400', 6000, TblWidth::TWIP], ]; } /** * Test ruby. */ public function testParseRubyHtml(): void { $html = << base text ( ruby text ) HTML; $phpWord = new PhpWord(); $section = $phpWord->addSection(); Html::addHtml($section, $html); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby')); self::assertEquals('ruby text', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rt/w:r/w:t')->textContent); self::assertEquals( 'base text', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyBase/w:r/w:t')->textContent ); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:rubyAlign')); self::assertEquals( RubyProperties::ALIGNMENT_CENTER, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:rubyAlign', 'w:val') ); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hps')); self::assertEquals( 10, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hps', 'w:val') ); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hpsBaseText')); self::assertEquals( 20, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hpsBaseText', 'w:val') ); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:lid')); self::assertEquals( 'en-US', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:lid', 'w:val') ); } } ================================================ FILE: tests/PhpWordTests/Shared/Microsoft/PasswordEncoderTest.php ================================================ getDomFromString('AAA'); self::assertTrue($reader->elementExists('/element/child')); self::assertEquals('AAA', $reader->getElement('/element/child')->textContent); self::assertEquals('AAA', $reader->getValue('/element/child')); self::assertEquals('test', $reader->getAttribute('attr', $reader->getElement('/element'))); self::assertEquals('subtest', $reader->getAttribute('attr', $reader->getElement('/element'), 'child')); } /** * Test reading XML from zip. */ public function testDomFromZip(): void { $archiveFile = __DIR__ . '/../_files/xml/reader.zip'; $reader = new XMLReader(); $reader->getDomFromZip($archiveFile, 'test.xml'); self::assertTrue($reader->elementExists('/element/child')); self::assertFalse($reader->getDomFromZip($archiveFile, 'non_existing_xml_file.xml')); } /** * Office 365 add some slash before the path of XML file. */ public function testDomFromZipOffice365(): void { $archiveFile = __DIR__ . '/../_files/xml/reader.zip'; $reader = new XMLReader(); $reader->getDomFromZip($archiveFile, '/test.xml'); self::assertTrue($reader->elementExists('/element/child')); self::assertFalse($reader->getDomFromZip($archiveFile, 'non_existing_xml_file.xml')); } /** * Test that read from non existing archive throws exception. */ public function testThrowsExceptionOnNonExistingArchive(): void { $this->expectException(Exception::class); $archiveFile = __DIR__ . '/../_files/xml/readers.zip'; $reader = new XMLReader(); $reader->getDomFromZip($archiveFile, 'test.xml'); } /** * Test that read from invalid archive throws exception. */ public function testThrowsExceptionOnZipArchiveOpenErrors(): void { $tempPath = tempnam(sys_get_temp_dir(), 'PhpWord') ?: 'tempNameFile'; // Simulate a corrupt archive file_put_contents($tempPath, mt_rand()); $exceptionMessage = null; try { $reader = new XMLReader(); $reader->getDomFromZip($tempPath, 'test.xml'); } catch (Exception $e) { $exceptionMessage = $e->getMessage(); } self::assertNotNull($exceptionMessage); unlink($tempPath); } /** * Test elements count. */ public function testCountElements(): void { $reader = new XMLReader(); $reader->getDomFromString('AAABBB'); self::assertEquals(2, $reader->countElements('/element/child')); } /** * Test read non existing elements. */ public function testReturnNullOnNonExistingNode(): void { $reader = new XMLReader(); self::assertSame(0, $reader->getElements('/element/children')->length); $reader->getDomFromString('AAA'); self::assertNull($reader->getElement('/element/children')); self::assertNull($reader->getValue('/element/children')); } /** * Test that xpath fails if custom namespace is not registered. */ public function testShouldThrowExceptionIfNamespaceIsNotKnown(): void { try { $reader = new XMLReader(); $reader->getDomFromString('AAA'); self::assertTrue($reader->elementExists('/element/test:child')); self::assertEquals('AAA', $reader->getElement('/element/test:child')->textContent); self::fail(); } catch (Exception $e) { // @phpstan-ignore-next-line self::assertTrue(true); } } /** * Test reading XML with manually registered namespace. */ public function testShouldParseXmlWithCustomNamespace(): void { $reader = new XMLReader(); $reader->getDomFromString('AAA'); $reader->registerNamespace('test', 'http://phpword.com/my/custom/namespace'); self::assertTrue($reader->elementExists('/element/test:child')); self::assertEquals('AAA', $reader->getElement('/element/test:child')->textContent); } /** * Test that xpath fails if custom namespace is not registered. */ public function testShouldThowExceptionIfTryingToRegisterNamespaceBeforeReadingDoc(): void { $this->expectException(InvalidArgumentException::class); $reader = new XMLReader(); $reader->registerNamespace('test', 'http://phpword.com/my/custom/namespace'); } } ================================================ FILE: tests/PhpWordTests/Shared/XMLWriterTest.php ================================================ startElement('element'); $object->text('AAA'); $object->endElement(); self::assertEquals('AAA' . chr(10), $object->getData()); // Disk $object = new XMLWriter(XMLWriter::STORAGE_DISK); $object->startElement('element'); $object->text('BBB'); $object->endElement(); self::assertEquals('BBB' . chr(10), $object->getData()); } public function testWriteAttribute(): void { $xmlWriter = new XMLWriter(); $xmlWriter->startElement('element'); $xmlWriter->writeAttribute('name', 'value'); $xmlWriter->endElement(); self::assertSame('' . chr(10), $xmlWriter->getData()); } public function testWriteAttributeShouldWriteFloatValueLocaleIndependent(): void { $value = 1.2; $xmlWriter = new XMLWriter(); $xmlWriter->startElement('element'); $xmlWriter->writeAttribute('name', $value); $xmlWriter->endElement(); $currentLocale = setlocale(LC_NUMERIC, 0); setlocale(LC_NUMERIC, 'de_DE.UTF-8', 'de'); self::assertSame('' . chr(10), $xmlWriter->getData()); setlocale(LC_NUMERIC, $currentLocale); } } ================================================ FILE: tests/PhpWordTests/Shared/ZipArchiveTest.php ================================================ open($zipFile, ZipArchive::CREATE); // $object->addFromString('content/string.txt', 'Test'); // // Lock the file // $resource = fopen($zipFile, "w"); // flock($resource, LOCK_EX); // // Closing the file should throws an exception // $object->close(); // // Unlock the file // flock($resource, LOCK_UN); // fclose($resource); // @unlink($zipFile); // } /** * Test all methods. * * @param string $zipClass */ public function testZipArchive($zipClass = 'ZipArchive'): void { // Preparation $existingFile = __DIR__ . '/../_files/documents/sheet.xls'; $zipFile = __DIR__ . '/../_files/documents/ziptest.zip'; $destination1 = __DIR__ . '/../_files/documents/extract1'; $destination2 = __DIR__ . '/../_files/documents/extract2'; @mkdir($destination1); @mkdir($destination2); Settings::setZipClass($zipClass); $object = new ZipArchive(); $object->open($zipFile, ZipArchive::CREATE); $object->addFile($existingFile, 'xls/new.xls'); $object->addFromString('content/string.txt', 'Test'); $object->close(); $object->open($zipFile); // Run tests self::assertEquals(0, $object->locateName('xls/new.xls')); self::assertFalse($object->locateName('blablabla')); self::assertEquals('Test', $object->getFromName('content/string.txt')); self::assertEquals('Test', $object->getFromName('/content/string.txt')); self::assertFalse($object->getNameIndex(-1)); self::assertEquals('content/string.txt', $object->getNameIndex(1)); self::assertFalse($object->extractTo('blablabla')); self::assertTrue($object->extractTo($destination1)); self::assertTrue($object->extractTo($destination2, 'xls/new.xls')); self::assertFalse($object->extractTo($destination2, 'blablabla')); // Cleanup $this->deleteDir($destination1); $this->deleteDir($destination2); @unlink($zipFile); } /** * Test PclZip. */ public function testPCLZip(): void { $this->testZipArchive('PhpOffice\PhpWord\Shared\ZipArchive'); } /** * Delete directory. * * @param string $dir */ private function deleteDir($dir): void { foreach (scandir($dir) as $file) { if ('.' === $file || '..' === $file) { continue; } elseif (is_file($dir . '/' . $file)) { unlink($dir . '/' . $file); } elseif (is_dir($dir . '/' . $file)) { $this->deleteDir($dir . '/' . $file); } } rmdir($dir); } } ================================================ FILE: tests/PhpWordTests/Style/AbstractStyleTest.php ================================================ getMockForAbstractClass(AbstractStyle::class); } else { /** @var AbstractStyle $stub */ $stub = new class() extends AbstractStyle { }; } $stub->setStyleByArray(['index' => 1]); self::assertEquals(1, $stub->getIndex()); } public function testSetStyleByArrayWithAlign(): void { $stub = new Paragraph(); $stub->setStyleByArray(['align' => Jc::CENTER]); self::assertEquals(Jc::CENTER, $stub->getAlignment()); } public function testSetStyleByArrayWithAlignment(): void { $stub = new Paragraph(); $stub->setStyleByArray(['alignment' => Jc::CENTER]); self::assertEquals(Jc::CENTER, $stub->getAlignment()); } /** * Test setBoolVal, setIntVal, setFloatVal, setEnumVal with normal value. */ public function testSetValNormal(): void { // @phpstan-ignore-next-line if (method_exists($this, 'getMockForAbstractClass')) { $stub = $this->getMockForAbstractClass(AbstractStyle::class); } else { /** @var AbstractStyle $stub */ $stub = new class() extends AbstractStyle { }; } self::assertTrue(self::callProtectedMethod($stub, 'setBoolVal', [true, false])); self::assertEquals(12, self::callProtectedMethod($stub, 'setIntVal', [12, 200])); self::assertEquals(871.1, self::callProtectedMethod($stub, 'setFloatVal', [871.1, 2.1])); self::assertEquals(871.1, self::callProtectedMethod($stub, 'setFloatVal', ['871.1', 2.1])); self::assertEquals('a', self::callProtectedMethod($stub, 'setEnumVal', ['a', ['a', 'b'], 'b'])); } /** * Test setBoolVal, setIntVal, setFloatVal, setEnumVal with default value. */ public function testSetValDefault(): void { // @phpstan-ignore-next-line if (method_exists($this, 'getMockForAbstractClass')) { $stub = $this->getMockForAbstractClass(AbstractStyle::class); } else { /** @var AbstractStyle $stub */ $stub = new class() extends AbstractStyle { }; } self::assertNotTrue(self::callProtectedMethod($stub, 'setBoolVal', ['a', false])); self::assertEquals(200, self::callProtectedMethod($stub, 'setIntVal', ['foo', 200])); self::assertEquals(2.1, self::callProtectedMethod($stub, 'setFloatVal', ['foo', 2.1])); self::assertEquals('b', self::callProtectedMethod($stub, 'setEnumVal', [null, ['a', 'b'], 'b'])); } /** * Test setEnumVal exception. */ public function testSetValEnumException(): void { $this->expectException(InvalidArgumentException::class); // @phpstan-ignore-next-line if (method_exists($this, 'getMockForAbstractClass')) { $stub = $this->getMockForAbstractClass(AbstractStyle::class); } else { /** @var AbstractStyle $stub */ $stub = new class() extends AbstractStyle { }; } self::assertEquals('b', self::callProtectedMethod($stub, 'setEnumVal', ['z', ['a', 'b'], 'b'])); } /** * Helper function to call protected method. * * @param mixed $object * @param string $method */ public static function callProtectedMethod($object, $method, array $args = []) { $class = new ReflectionClass(get_class($object)); $method = $class->getMethod($method); $method->setAccessible(true); return $method->invokeArgs($object, $args); } } ================================================ FILE: tests/PhpWordTests/Style/CellTest.php ================================================ 120, 'borderLeftSize' => 120, 'borderRightSize' => 120, 'borderBottomSize' => 120, 'gridSpan' => 2, ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; self::assertNull($object->$get()); // Init with null value $object->$set($value); self::assertEquals($value, $object->$get()); } } public function testSetGetNormalString(): void { $object = new Cell(); foreach ([ 'valign' => VerticalJc::TOP, 'textDirection' => Cell::TEXT_DIR_BTLR, 'bgColor' => 'FFFF00', 'borderTopColor' => 'FFFF00', 'borderLeftColor' => 'FFFF00', 'borderRightColor' => 'FFFF00', 'borderBottomColor' => 'FFFF00', 'vMerge' => Cell::VMERGE_RESTART, ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; self::assertNull($object->$get()); // Init with null value $object->$set($value); self::assertEquals($value, $object->$get()); } } /** * Test border color. */ public function testBorderColor(): void { $object = new Cell(); $value = 'FF0000'; $object->setStyleValue('borderColor', $value); $expected = [$value, $value, $value, $value]; self::assertEquals($expected, $object->getBorderColor()); } /** * Test border size. */ public function testBorderSize(): void { $object = new Cell(); $value = 120; $expected = [$value, $value, $value, $value]; $object->setStyleValue('borderSize', $value); self::assertEquals($expected, $object->getBorderSize()); } /** * Test cell padding. */ public function testPadding(): void { $object = new Cell(); $methods = [ 'paddingTop' => 10, 'paddingBottom' => 20, 'paddingLeft' => 30, 'paddingRight' => 40, ]; foreach ($methods as $methodName => $methodValue) { $object->setStyleValue($methodName, $methodValue); $getterName = 'get' . ucfirst($methodName); self::assertEquals($methodValue, $object->$getterName()); } } } ================================================ FILE: tests/PhpWordTests/Style/ChartTest.php ================================================ getWidth(), 1000000); $chart->setWidth(200); self::assertEquals($chart->getWidth(), 200); } /** * Testing getter and setter for chart height. */ public function testSetGetHeight(): void { $chart = new Chart(); self::assertEquals($chart->getHeight(), 1000000); $chart->setHeight(200); self::assertEquals($chart->getHeight(), 200); } /** * Testing getter and setter for is3d. */ public function testSetIs3d(): void { $chart = new Chart(); self::assertEquals($chart->is3d(), false); $chart->set3d(true); self::assertEquals($chart->is3d(), true); } /** * Testing getter and setter for chart colors. */ public function testSetGetColors(): void { $chart = new Chart(); self::assertIsArray($chart->getColors()); self::assertEquals(count($chart->getColors()), 0); $chart->setColors(['FFFFFFFF', 'FF000000', 'FFFF0000']); self::assertEquals($chart->getColors(), ['FFFFFFFF', 'FF000000', 'FFFF0000']); } /** * Testing getter and setter for dataLabelOptions. */ public function testSetGetDataLabelOptions(): void { $chart = new Chart(); $originalDataLabelOptions = [ 'showVal' => true, 'showCatName' => true, 'showLegendKey' => false, 'showSerName' => false, 'showPercent' => false, 'showLeaderLines' => false, 'showBubbleSize' => false, ]; self::assertEquals($chart->getDataLabelOptions(), $originalDataLabelOptions); $changedDataLabelOptions = [ 'showVal' => false, 'showCatName' => false, 'showLegendKey' => true, 'showSerName' => true, 'showPercent' => true, 'showLeaderLines' => true, 'showBubbleSize' => true, ]; $chart->setDataLabelOptions( [ 'showVal' => false, 'showCatName' => false, 'showLegendKey' => true, 'showSerName' => true, 'showPercent' => true, 'showLeaderLines' => true, 'showBubbleSize' => true, ] ); self::assertEquals($chart->getDataLabelOptions(), $changedDataLabelOptions); } /** * Testing categoryLabelPosition getter and setter. */ public function testSetGetCategoryLabelPosition(): void { $chart = new Chart(); self::assertEquals($chart->getCategoryLabelPosition(), 'nextTo'); $chart->setCategoryLabelPosition('high'); self::assertEquals($chart->getCategoryLabelPosition(), 'high'); } /** * Testing valueLabelPosition getter and setter. */ public function testSetGetValueLabelPosition(): void { $chart = new Chart(); self::assertEquals($chart->getValueLabelPosition(), 'nextTo'); $chart->setValueLabelPosition('low'); self::assertEquals($chart->getValueLabelPosition(), 'low'); } /** * Testing categoryAxisTitle getter and setter. */ public function testSetGetCategoryAxisTitle(): void { $chart = new Chart(); self::assertEquals($chart->getCategoryAxisTitle(), null); $chart->setCategoryAxisTitle('Test Category Axis Title'); self::assertEquals($chart->getCategoryAxisTitle(), 'Test Category Axis Title'); } /** * Testing valueAxisTitle getter and setter. */ public function testSetGetValueAxisTitle(): void { $chart = new Chart(); self::assertEquals($chart->getValueAxisTitle(), null); $chart->setValueAxisTitle('Test Value Axis Title'); self::assertEquals($chart->getValueAxisTitle(), 'Test Value Axis Title'); } } ================================================ FILE: tests/PhpWordTests/Style/FontTest.php ================================================ Jc::BOTH]); self::assertEquals('text', $object->getStyleType()); self::assertInstanceOf(\PhpOffice\PhpWord\Style\Paragraph::class, $object->getParagraph()); self::assertIsArray($object->getStyleValues()); } /** * Test setting style values with null or empty value. */ public function testSetStyleValueWithNullOrEmpty(): void { $object = new Font(); $attributes = [ 'name' => null, 'size' => null, 'hint' => null, 'color' => null, 'bold' => false, 'italic' => false, 'underline' => Font::UNDERLINE_NONE, 'superScript' => false, 'subScript' => false, 'strikethrough' => false, 'doubleStrikethrough' => false, 'smallCaps' => false, 'allCaps' => false, 'rtl' => false, 'fgColor' => null, 'bgColor' => null, 'scale' => null, 'spacing' => null, 'kerning' => null, 'lang' => null, 'hidden' => false, 'whiteSpace' => '', 'fallbackFont' => '', ]; foreach ($attributes as $key => $default) { $get = is_bool($default) ? "is{$key}" : "get{$key}"; self::assertEquals($default, $object->$get()); $object->setStyleValue($key, null); self::assertEquals($default, $object->$get()); $object->setStyleValue($key, ''); self::assertEquals($default, $object->$get()); } } /** * Test setting style values with normal value. */ public function testSetStyleValueNormal(): void { $object = new Font(); $attributes = [ 'name' => 'Times New Roman', 'size' => 9, 'color' => '999999', 'hint' => 'eastAsia', 'bold' => true, 'italic' => true, 'underline' => Font::UNDERLINE_HEAVY, 'superScript' => true, 'subScript' => false, 'strikethrough' => true, 'doubleStrikethrough' => false, 'smallCaps' => true, 'allCaps' => false, 'fgColor' => Font::FGCOLOR_YELLOW, 'bgColor' => 'FFFF00', 'lineHeight' => 2, 'scale' => 150, 'spacing' => 240, 'kerning' => 10, 'rtl' => true, 'noProof' => true, 'lang' => new Language(Language::EN_US), 'hidden' => true, 'whiteSpace' => 'pre-wrap', 'fallbackFont' => 'serif', ]; $object->setStyleByArray($attributes); foreach ($attributes as $key => $value) { $get = is_bool($value) ? "is{$key}" : "get{$key}"; self::assertEquals($value, $object->$get()); } } /** * Test set line height. */ public function testLineHeight(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // Test style array $text = $section->addText('This is a test', ['line-height' => 2.0]); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:p/w:pPr/w:spacing'); $lineHeight = $element->getAttribute('w:line'); $lineRule = $element->getAttribute('w:lineRule'); self::assertEquals(480, $lineHeight); self::assertEquals('auto', $lineRule); // Test setter TestHelperDOCX::clear(); $text->getFontStyle()->setLineHeight(3.0); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:p/w:pPr/w:spacing'); $lineHeight = $element->getAttribute('w:line'); $lineRule = $element->getAttribute('w:lineRule'); self::assertEquals(720, $lineHeight); self::assertEquals('auto', $lineRule); } /** * Test line height floatval. */ public function testLineHeightFloatval(): void { $object = new Font(null, ['alignment' => Jc::CENTER]); $object->setLineHeight('1.5pt'); self::assertEquals(1.5, $object->getLineHeight()); } /** * Test line height exception by using nonnumeric value. */ public function testLineHeightException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidStyleException::class); $object = new Font(); $object->setLineHeight('a'); } /** * Test setting the language as a string. */ public function testSetLangAsString(): void { $object = new Font(); $object->setLang(Language::FR_BE); self::assertInstanceOf('PhpOffice\PhpWord\Style\Language', $object->getLang()); self::assertEquals(Language::FR_BE, $object->getLang()->getLatin()); } public function testRTL(): void { $object = new Font(); self::assertNull($object->isRTL()); self::assertInstanceOf(Font::class, $object->setRTL(true)); self::assertTrue($object->isRTL()); self::assertInstanceOf(Font::class, $object->setRTL(false)); self::assertFalse($object->isRTL()); } public function testRTLSettings(): void { Settings::setDefaultRtl(null); $object = new Font(); self::assertNull($object->isRTL()); Settings::setDefaultRtl(true); $object = new Font(); self::assertTrue($object->isRTL()); Settings::setDefaultRtl(false); $object = new Font(); self::assertFalse($object->isRTL()); Settings::setDefaultRtl(null); } } ================================================ FILE: tests/PhpWordTests/Style/ImageTest.php ================================================ 200, 'height' => 200, 'marginTop' => 240, 'marginLeft' => 240, 'wrapDistanceLeft' => 10, 'wrapDistanceRight' => 20, 'wrapDistanceTop' => 30, 'wrapDistanceBottom' => 40, ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } public function testSetGetNormalString(): void { $object = new Image(); foreach ([ 'alignment' => Jc::START, 'wrappingStyle' => 'inline', ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } /** * Test setStyleValue method. */ public function testSetStyleValue(): void { $object = new Image(); $properties = [ 'width' => 200, 'height' => 200, 'alignment' => Jc::START, 'marginTop' => 240, 'marginLeft' => 240, 'position' => 10, 'positioning' => Image::POSITION_ABSOLUTE, 'posHorizontal' => Image::POSITION_HORIZONTAL_CENTER, 'posVertical' => Image::POSITION_VERTICAL_TOP, 'posHorizontalRel' => Image::POSITION_RELATIVE_TO_COLUMN, 'posVerticalRel' => Image::POSITION_RELATIVE_TO_IMARGIN, 'wrapDistanceLeft' => 10, 'wrapDistanceRight' => 20, 'wrapDistanceTop' => 30, 'wrapDistanceBottom' => 40, ]; foreach ($properties as $key => $value) { $get = "get{$key}"; $object->setStyleValue("{$key}", $value); self::assertEquals($value, $object->$get()); } } /** * Test setWrappingStyle exception. */ public function testSetWrappingStyleException(): void { $this->expectException(InvalidArgumentException::class); $object = new Image(); $object->setWrappingStyle('foo'); } } ================================================ FILE: tests/PhpWordTests/Style/IndentationTest.php ================================================ [0, 10], 'right' => [0, 10], 'firstLine' => [null, 20], 'firstLineChars' => [0, 20], 'hanging' => [null, 20], ]; foreach ($properties as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } } ================================================ FILE: tests/PhpWordTests/Style/LanguageTest.php ================================================ [null, 1036], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } public function testGetSetPropertiesString(): void { $object = new Language(); foreach ([ 'latin' => [null, 'fr-BE'], 'eastAsia' => [null, 'ja-JP'], 'bidirectional' => [null, 'ar-SA'], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } /** * Test throws exception if wrong locale is given. */ public function testWrongLanguage(): void { $this->expectException(InvalidArgumentException::class); $language = new Language(); $language->setLatin('fra'); } /** * Tests that a language can be set with just a 2 char code. */ public function testShortLanguage(): void { //when $language = new Language(); $language->setLatin('fr'); //then Assert::assertEquals('fr-FR', $language->getLatin()); } } ================================================ FILE: tests/PhpWordTests/Style/LineNumberingTest.php ================================================ [1, 2], 'increment' => [1, 10], 'distance' => [null, 10], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } public function testGetSetPropertiesString(): void { $object = new LineNumbering(); foreach ([ 'restart' => [null, 'continuous'], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } } ================================================ FILE: tests/PhpWordTests/Style/LineTest.php ================================================ 10, ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } public function testSetGetNormalString(): void { $object = new Line(); foreach ([ 'connectorType' => Line::CONNECTOR_TYPE_STRAIGHT, 'beginArrow' => Line::ARROW_STYLE_BLOCK, 'endArrow' => Line::ARROW_STYLE_OVAL, 'dash' => Line::DASH_STYLE_LONG_DASH_DOT_DOT, 'color' => 'red', ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } /** * Test setStyleValue method. */ public function testSetStyleValue(): void { $object = new Line(); $properties = [ 'connectorType' => Line::CONNECTOR_TYPE_STRAIGHT, 'beginArrow' => Line::ARROW_STYLE_BLOCK, 'endArrow' => Line::ARROW_STYLE_OVAL, 'dash' => Line::DASH_STYLE_LONG_DASH_DOT_DOT, 'weight' => 10, 'color' => 'red', ]; foreach ($properties as $key => $value) { $get = "get{$key}"; $object->setStyleValue("{$key}", $value); self::assertEquals($value, $object->$get()); } } /** * Test set/get flip. */ public function testSetGetFlip(): void { $expected = true; $object = new Line(); $object->setFlip($expected); self::assertEquals($expected, $object->isFlip()); } /** * Test set/get connectorType. */ public function testSetGetConnectorType(): void { $expected = Line::CONNECTOR_TYPE_STRAIGHT; $object = new Line(); $object->setConnectorType($expected); self::assertEquals($expected, $object->getConnectorType()); } /** * Test set/get weight. */ public function testSetGetWeight(): void { $expected = 10; $object = new Line(); $object->setWeight($expected); self::assertEquals($expected, $object->getWeight()); } /** * Test set/get color. */ public function testSetGetColor(): void { $expected = 'red'; $object = new Line(); $object->setColor($expected); self::assertEquals($expected, $object->getColor()); } /** * Test set/get dash. */ public function testSetGetDash(): void { $expected = Line::DASH_STYLE_LONG_DASH_DOT_DOT; $object = new Line(); $object->setDash($expected); self::assertEquals($expected, $object->getDash()); } /** * Test set/get beginArrow. */ public function testSetGetBeginArrow(): void { $expected = Line::ARROW_STYLE_BLOCK; $object = new Line(); $object->setBeginArrow($expected); self::assertEquals($expected, $object->getBeginArrow()); } /** * Test set/get endArrow. */ public function testSetGetEndArrow(): void { $expected = Line::ARROW_STYLE_CLASSIC; $object = new Line(); $object->setEndArrow($expected); self::assertEquals($expected, $object->getEndArrow()); } } ================================================ FILE: tests/PhpWordTests/Style/ListItemTest.php ================================================ getListType()); } /** * Test set style value. */ public function testSetStyleValue(): void { $object = new ListItem(); $value = ListItem::TYPE_ALPHANUM; $object->setStyleValue('listType', $value); self::assertEquals($value, $object->getListType()); } /** * Test list type. */ public function testListType(): void { $object = new ListItem(); $value = ListItem::TYPE_ALPHANUM; $object->setListType($value); self::assertEquals($value, $object->getListType()); } /** * Test set/get numbering style name. */ public function testSetGetNumStyle(): void { $expected = 'List Name'; $object = new ListItem(); $object->setNumStyle($expected); self::assertEquals($expected, $object->getNumStyle()); } } ================================================ FILE: tests/PhpWordTests/Style/NumberingLevelTest.php ================================================ 1, 'start' => 1, 'restart' => 1, 'left' => 360, 'hanging' => 360, 'tabPos' => 360, ]; foreach ($attributes as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } public function testSetGetNormalString(): void { $object = new NumberingLevel(); $attributes = [ 'format' => 'decimal', 'pStyle' => 'pStyle', 'suffix' => 'space', 'text' => '%1.', 'alignment' => Jc::START, 'font' => 'Arial', 'hint' => 'default', ]; foreach ($attributes as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } } ================================================ FILE: tests/PhpWordTests/Style/NumberingTest.php ================================================ [null, 1], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } public function testGetSetPropertiesString(): void { $object = new Numbering(); foreach ([ 'type' => [null, 'singleLevel'], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } public function testGetLevels(): void { $object = new Numbering(); self::assertEmpty($object->getLevels()); } } ================================================ FILE: tests/PhpWordTests/Style/PaperTest.php ================================================ getSize()); } /** * Test paper size for B5 format. */ public function testB5Size(): void { $object = new Paper('B5'); self::assertEquals('B5', $object->getSize()); self::assertEqualsWithDelta(9977.9527559055, $object->getWidth(), 0.000000001); self::assertEqualsWithDelta(14173.228346457, $object->getHeight(), 0.000000001); } /** * Test paper size for Folio format. */ public function testFolioSize(): void { $object = new Paper(); $object->setSize('Folio'); self::assertEquals('Folio', $object->getSize()); self::assertEqualsWithDelta(12240, $object->getWidth(), 0.1); self::assertEqualsWithDelta(18720, $object->getHeight(), 0.1); } } ================================================ FILE: tests/PhpWordTests/Style/ParagraphTest.php ================================================ true, 'keepNext' => false, 'keepLines' => false, 'pageBreakBefore' => false, 'contextualSpacing' => false, ]; foreach ($attributes as $key => $default) { $get = $this->findGetter($key, $default, $object); $object->setStyleValue($key, null); self::assertEquals($default, $object->$get()); $object->setStyleValue($key, ''); self::assertEquals($default, $object->$get()); } } /** * Test setting style values with normal value. */ public function testSetStyleValueNormal(): void { $object = new Paragraph(); $attributes = [ 'spaceAfter' => 240, 'spaceBefore' => 240, 'indent' => 1, 'hanging' => 1, 'spacing' => 120, 'spacingLineRule' => LineSpacingRule::AT_LEAST, 'basedOn' => 'Normal', 'next' => 'Normal', 'numStyle' => 'numStyle', 'numLevel' => 1, 'widowControl' => false, 'keepNext' => true, 'keepLines' => true, 'pageBreakBefore' => true, 'contextualSpacing' => true, 'textAlignment' => 'auto', 'bidi' => true, 'suppressAutoHyphens' => true, ]; foreach ($attributes as $key => $value) { $get = $this->findGetter($key, $value, $object); $object->setStyleValue("$key", $value); if (('indent' == $key || 'hanging' == $key) && is_numeric($value)) { $value = $value * 720; } self::assertEquals($value, $object->$get()); } } /** * @param string $key * @param mixed $value * @param object $object * * @return string */ private function findGetter($key, $value, $object) { if (is_bool($value)) { if (method_exists($object, "is{$key}")) { return "is{$key}"; } elseif (method_exists($object, "has{$key}")) { return "has{$key}"; } } return "get{$key}"; } /** * Test get null style value. */ public function testGetNullStyleValue(): void { $object = new Paragraph(); $attributes = ['spacing', 'indent', 'hanging', 'spaceBefore', 'spaceAfter', 'textAlignment']; foreach ($attributes as $key) { $get = $this->findGetter($key, null, $object); self::assertNull($object->$get()); } } /** * Test tabs. */ public function testTabs(): void { $object = new Paragraph(); $object->setTabs([new Tab('left', 1550), new Tab('right', 5300)]); self::assertCount(2, $object->getTabs()); } public function testHanging(): void { $rand = mt_rand(0, 255); $object = new Paragraph(); self::assertNull($object->getHanging()); $object->setHanging($rand); self::assertEquals($rand, $object->getHanging()); $object->setHanging(null); self::assertNull($object->getHanging()); $object->setHanging($rand); self::assertEquals($rand, $object->getHanging()); $object->setHanging(); self::assertNull($object->getHanging()); } public function testIndent(): void { $rand = mt_rand(0, 255); $object = new Paragraph(); self::assertNull($object->getIndent()); $object->setIndent($rand); self::assertEquals($rand, $object->getIndent()); $object->setIndent(null); self::assertNull($object->getIndent()); $object->setIndent($rand); self::assertEquals($rand, $object->getIndent()); $object->setIndent(); self::assertNull($object->getIndent()); } public function testIndentation(): void { $rand = mt_rand(0, 255); $rand2 = mt_rand(0, 255); $object = new Paragraph(); self::assertNull($object->getIndentation()); // Set Basic indentation $object->setIndentation([]); self::assertNotNull($object->getIndentation()); self::assertEquals(0, $object->getIndentation()->getLeft()); self::assertEquals(0, $object->getIndentation()->getRight()); self::assertEquals(0, $object->getIndentation()->getHanging()); self::assertEquals(0, $object->getIndentation()->getFirstLine()); // Set indentation : left $object->setIndentation([ 'left' => $rand, ]); self::assertNotNull($object->getIndentation()); self::assertEquals($rand, $object->getIndentation()->getLeft()); self::assertEquals(0, $object->getIndentation()->getRight()); self::assertEquals(0, $object->getIndentation()->getHanging()); self::assertEquals(0, $object->getIndentation()->getFirstLine()); // Set indentation : right $object->setIndentation([ 'right' => $rand, ]); self::assertNotNull($object->getIndentation()); self::assertEquals($rand, $object->getIndentation()->getLeft()); self::assertEquals($rand, $object->getIndentation()->getRight()); self::assertEquals(0, $object->getIndentation()->getHanging()); self::assertEquals(0, $object->getIndentation()->getFirstLine()); // Set indentation : hanging $object->setIndentation([ 'hanging' => $rand, ]); self::assertNotNull($object->getIndentation()); self::assertEquals($rand, $object->getIndentation()->getLeft()); self::assertEquals($rand, $object->getIndentation()->getRight()); self::assertEquals($rand, $object->getIndentation()->getHanging()); self::assertEquals(0, $object->getIndentation()->getFirstLine()); // Set indentation : firstline $object->setIndentation([ 'firstline' => $rand, ]); self::assertNotNull($object->getIndentation()); self::assertEquals($rand, $object->getIndentation()->getLeft()); self::assertEquals($rand, $object->getIndentation()->getRight()); self::assertEquals($rand, $object->getIndentation()->getHanging()); self::assertEquals($rand, $object->getIndentation()->getFirstLine()); // Replace indentation : left & firstline $object->setIndentation([ 'left' => $rand2, 'firstline' => $rand2, ]); self::assertNotNull($object->getIndentation()); self::assertEquals($rand2, $object->getIndentation()->getLeft()); self::assertEquals($rand, $object->getIndentation()->getRight()); self::assertEquals($rand, $object->getIndentation()->getHanging()); self::assertEquals($rand2, $object->getIndentation()->getFirstLine()); // Replace indentation : N/A $object->setIndentation(); self::assertNotNull($object->getIndentation()); self::assertEquals($rand2, $object->getIndentation()->getLeft()); self::assertEquals($rand, $object->getIndentation()->getRight()); self::assertEquals($rand, $object->getIndentation()->getHanging()); self::assertEquals($rand2, $object->getIndentation()->getFirstLine()); } public function testIndentFirstLine(): void { $rand = mt_rand(0, 255); $object = new Paragraph(); self::assertNull($object->getIndentFirstLine()); $object->setIndentFirstLine($rand); self::assertEquals($rand, $object->getIndentFirstLine()); $object->setIndentFirstLine(null); self::assertNull($object->getIndentFirstLine()); $object->setIndentFirstLine($rand); self::assertEquals($rand, $object->getIndentFirstLine()); $object->setIndentFirstLine(); self::assertNull($object->getIndentFirstLine()); } public function testIndentLeft(): void { $rand = mt_rand(0, 255); $object = new Paragraph(); self::assertNull($object->getIndentLeft()); $object->setIndentLeft($rand); self::assertEquals($rand, $object->getIndentLeft()); $object->setIndentLeft(null); self::assertNull($object->getIndentLeft()); $object->setIndentLeft($rand); self::assertEquals($rand, $object->getIndentLeft()); $object->setIndentLeft(); self::assertNull($object->getIndentLeft()); } public function testIndentRight(): void { $rand = mt_rand(0, 255); $object = new Paragraph(); self::assertNull($object->getIndentRight()); $object->setIndentRight($rand); self::assertEquals($rand, $object->getIndentRight()); $object->setIndentRight(null); self::assertNull($object->getIndentRight()); $object->setIndentRight($rand); self::assertEquals($rand, $object->getIndentRight()); $object->setIndentRight(); self::assertNull($object->getIndentRight()); } /** * Line height. */ public function testLineHeight(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // Test style array $text = $section->addText('This is a test', [], ['line-height' => 2.0]); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:p/w:pPr/w:spacing'); $lineHeight = $element->getAttribute('w:line'); $lineRule = $element->getAttribute('w:lineRule'); self::assertEquals(480, $lineHeight); self::assertEquals('auto', $lineRule); // Test setter $text->getParagraphStyle()->setLineHeight(3.0); TestHelperDOCX::clear(); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:p/w:pPr/w:spacing'); $lineHeight = $element->getAttribute('w:line'); $lineRule = $element->getAttribute('w:lineRule'); self::assertEquals(720, $lineHeight); self::assertEquals('auto', $lineRule); } /** * Test setLineHeight validation. */ public function testLineHeightValidation(): void { $object = new Paragraph(); $object->setLineHeight('12.5pt'); self::assertEquals(12.5, $object->getLineHeight()); } /** * Test line height exception by using nonnumeric value. */ public function testLineHeightException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\InvalidStyleException::class); $object = new Paragraph(); $object->setLineHeight('a'); } public function testBidiVisual(): void { $object = new Paragraph(); self::assertNull($object->isBidi()); $object->setBidi(true); self::assertTrue($object->isBidi()); $object->setBidi(false); self::assertFalse($object->isBidi()); $object->setBidi(null); self::assertNull($object->isBidi()); } public function testBidiVisualSettings(): void { Settings::setDefaultRtl(null); $object = new Paragraph(); self::assertNull($object->isBidi()); Settings::setDefaultRtl(true); $object = new Paragraph(); self::assertTrue($object->isBidi()); Settings::setDefaultRtl(false); $object = new Paragraph(); self::assertFalse($object->isBidi()); Settings::setDefaultRtl(null); } } ================================================ FILE: tests/PhpWordTests/Style/RowTest.php ================================================ true, 'cantSplit' => false, 'exactHeight' => true, ]; foreach ($properties as $key => $value) { // set/get $set = "set{$key}"; $get = "is{$key}"; $expected = $value ? 1 : 0; $object->$set($value); self::assertEquals($expected, $object->$get()); // setStyleValue $value = !$value; $expected = $value ? 1 : 0; $object->setStyleValue("{$key}", $value); self::assertEquals($expected, $object->$get()); } } } ================================================ FILE: tests/PhpWordTests/Style/SectionTest.php ================================================ getOrientation()); self::assertEqualsWithDelta(Section::DEFAULT_WIDTH, $oSettings->getPageSizeW(), 0.000000001); self::assertEqualsWithDelta(Section::DEFAULT_HEIGHT, $oSettings->getPageSizeH(), 0.000000001); self::assertEquals('A4', $oSettings->getPaperSize()); $oSettings->setSettingValue('orientation', 'landscape'); self::assertEquals('landscape', $oSettings->getOrientation()); self::assertEqualsWithDelta(Section::DEFAULT_HEIGHT, $oSettings->getPageSizeW(), 0.000000001); self::assertEqualsWithDelta(Section::DEFAULT_WIDTH, $oSettings->getPageSizeH(), 0.000000001); $iVal = mt_rand(1, 1000); $oSettings->setSettingValue('borderSize', $iVal); self::assertEquals([$iVal, $iVal, $iVal, $iVal], $oSettings->getBorderSize()); self::assertEquals($iVal, $oSettings->getBorderBottomSize()); self::assertEquals($iVal, $oSettings->getBorderLeftSize()); self::assertEquals($iVal, $oSettings->getBorderRightSize()); self::assertEquals($iVal, $oSettings->getBorderTopSize()); $oSettings->setSettingValue('borderColor', 'FF00AA'); self::assertEquals(['FF00AA', 'FF00AA', 'FF00AA', 'FF00AA'], $oSettings->getBorderColor()); self::assertEquals('FF00AA', $oSettings->getBorderBottomColor()); self::assertEquals('FF00AA', $oSettings->getBorderLeftColor()); self::assertEquals('FF00AA', $oSettings->getBorderRightColor()); self::assertEquals('FF00AA', $oSettings->getBorderTopColor()); $iVal = mt_rand(1, 1000); $oSettings->setSettingValue('headerHeight', $iVal); self::assertEquals($iVal, $oSettings->getHeaderHeight()); $oSettings->setSettingValue('lineNumbering', []); $oSettings->setSettingValue( 'lineNumbering', [ 'start' => 1, 'increment' => 1, 'distance' => 240, 'restart' => 'newPage', ] ); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\LineNumbering', $oSettings->getLineNumbering()); $oSettings->setSettingValue('lineNumbering', null); self::assertNull($oSettings->getLineNumbering()); } /** * Set/get margin. */ public function testMargin(): void { // Section Settings $oSettings = new Section(); $iVal = mt_rand(1, 1000); $oSettings->setMarginTop($iVal); self::assertEquals($iVal, $oSettings->getMarginTop()); $iVal = mt_rand(1, 1000); $oSettings->setMarginBottom($iVal); self::assertEquals($iVal, $oSettings->getMarginBottom()); $iVal = mt_rand(1, 1000); $oSettings->setMarginLeft($iVal); self::assertEquals($iVal, $oSettings->getMarginLeft()); $iVal = mt_rand(1, 1000); $oSettings->setMarginRight($iVal); self::assertEquals($iVal, $oSettings->getMarginRight()); } /** * Set/get page width. */ public function testPageWidth(): void { // Section Settings $oSettings = new Section(); self::assertEqualsWithDelta(Section::DEFAULT_WIDTH, $oSettings->getPageSizeW(), 0.000000001); $iVal = mt_rand(1, 1000); $oSettings->setSettingValue('pageSizeW', $iVal); self::assertEquals($iVal, $oSettings->getPageSizeW()); } /** * Set/get page height. */ public function testPageHeight(): void { // Section Settings $oSettings = new Section(); self::assertEqualsWithDelta(Section::DEFAULT_HEIGHT, $oSettings->getPageSizeH(), 0.000000001); $iVal = mt_rand(1, 1000); $oSettings->setSettingValue('pageSizeH', $iVal); self::assertEquals($iVal, $oSettings->getPageSizeH()); } /** * Set/get landscape orientation. */ public function testOrientationLandscape(): void { // Section Settings $oSettings = new Section(); $oSettings->setLandscape(); self::assertEquals('landscape', $oSettings->getOrientation()); self::assertEqualsWithDelta(Section::DEFAULT_HEIGHT, $oSettings->getPageSizeW(), 0.000000001); self::assertEqualsWithDelta(Section::DEFAULT_WIDTH, $oSettings->getPageSizeH(), 0.000000001); } /** * Set/get portrait orientation. */ public function testOrientationPortrait(): void { // Section Settings $oSettings = new Section(); $oSettings->setPortrait(); self::assertEquals('portrait', $oSettings->getOrientation()); self::assertEqualsWithDelta(Section::DEFAULT_WIDTH, $oSettings->getPageSizeW(), 0.000000001); self::assertEqualsWithDelta(Section::DEFAULT_HEIGHT, $oSettings->getPageSizeH(), 0.000000001); } /** * Set/get border size. */ public function testBorderSize(): void { // Section Settings $oSettings = new Section(); $iVal = mt_rand(1, 1000); $oSettings->setBorderSize($iVal); self::assertEquals([$iVal, $iVal, $iVal, $iVal], $oSettings->getBorderSize()); self::assertEquals($iVal, $oSettings->getBorderBottomSize()); self::assertEquals($iVal, $oSettings->getBorderLeftSize()); self::assertEquals($iVal, $oSettings->getBorderRightSize()); self::assertEquals($iVal, $oSettings->getBorderTopSize()); $iVal = mt_rand(1, 1000); $oSettings->setBorderBottomSize($iVal); self::assertEquals($iVal, $oSettings->getBorderBottomSize()); $iVal = mt_rand(1, 1000); $oSettings->setBorderLeftSize($iVal); self::assertEquals($iVal, $oSettings->getBorderLeftSize()); $iVal = mt_rand(1, 1000); $oSettings->setBorderRightSize($iVal); self::assertEquals($iVal, $oSettings->getBorderRightSize()); $iVal = mt_rand(1, 1000); $oSettings->setBorderTopSize($iVal); self::assertEquals($iVal, $oSettings->getBorderTopSize()); } /** * Set/get border color. */ public function testBorderColor(): void { // Section Settings $oSettings = new Section(); $oSettings->setBorderColor('FF00AA'); self::assertEquals(['FF00AA', 'FF00AA', 'FF00AA', 'FF00AA'], $oSettings->getBorderColor()); self::assertEquals('FF00AA', $oSettings->getBorderBottomColor()); self::assertEquals('FF00AA', $oSettings->getBorderLeftColor()); self::assertEquals('FF00AA', $oSettings->getBorderRightColor()); self::assertEquals('FF00AA', $oSettings->getBorderTopColor()); $oSettings->setBorderBottomColor('BBCCDD'); self::assertEquals('BBCCDD', $oSettings->getBorderBottomColor()); $oSettings->setBorderLeftColor('CCDDEE'); self::assertEquals('CCDDEE', $oSettings->getBorderLeftColor()); $oSettings->setBorderRightColor('11EE22'); self::assertEquals('11EE22', $oSettings->getBorderRightColor()); $oSettings->setBorderTopColor('22FF33'); self::assertEquals('22FF33', $oSettings->getBorderTopColor()); } /** * Set/get page numbering start. */ public function testNumberingStart(): void { // Section Settings $oSettings = new Section(); self::assertNull($oSettings->getPageNumberingStart()); $iVal = mt_rand(1, 1000); $oSettings->setPageNumberingStart($iVal); self::assertEquals($iVal, $oSettings->getPageNumberingStart()); $oSettings->setPageNumberingStart(); self::assertNull($oSettings->getPageNumberingStart()); } /** * Set/get header height. */ public function testHeader(): void { $oSettings = new Section(); self::assertEquals(720, $oSettings->getHeaderHeight()); $iVal = mt_rand(1, 1000); $oSettings->setHeaderHeight($iVal); self::assertEquals($iVal, $oSettings->getHeaderHeight()); $oSettings->setHeaderHeight(); self::assertEquals(720, $oSettings->getHeaderHeight()); } /** * Set/get footer height. */ public function testFooter(): void { // Section Settings $oSettings = new Section(); self::assertEquals(720, $oSettings->getFooterHeight()); $iVal = mt_rand(1, 1000); $oSettings->setFooterHeight($iVal); self::assertEquals($iVal, $oSettings->getFooterHeight()); $oSettings->setFooterHeight(); self::assertEquals(720, $oSettings->getFooterHeight()); } /** * Set/get column number. */ public function testColumnsNum(): void { // Section Settings $oSettings = new Section(); // Default self::assertEquals(1, $oSettings->getColsNum()); // Null value $oSettings->setColsNum(); self::assertEquals(1, $oSettings->getColsNum()); // Random value $iVal = mt_rand(1, 1000); $oSettings->setColsNum($iVal); self::assertEquals($iVal, $oSettings->getColsNum()); } /** * Set/get column spacing. */ public function testColumnsSpace(): void { // Section Settings $oSettings = new Section(); // Default self::assertEquals(720, $oSettings->getColsSpace()); $iVal = mt_rand(1, 1000); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Section', $oSettings->setColsSpace($iVal)); self::assertEquals($iVal, $oSettings->getColsSpace()); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Section', $oSettings->setColsSpace()); self::assertEquals(720, $oSettings->getColsSpace()); } /** * Set/get break type. */ public function testBreakType(): void { // Section Settings $oSettings = new Section(); self::assertNull($oSettings->getBreakType()); $oSettings->setBreakType('continuous'); self::assertEquals('continuous', $oSettings->getBreakType()); $oSettings->setBreakType(); self::assertNull($oSettings->getBreakType()); } /** * Vertical page alignment. */ public function testVerticalAlign(): void { // Section Settings $oSettings = new Section(); self::assertNull($oSettings->getVAlign()); $oSettings->setVAlign(VerticalJc::BOTH); self::assertEquals('both', $oSettings->getVAlign()); } } ================================================ FILE: tests/PhpWordTests/Style/ShadingTest.php ================================================ ['clear', 'solid'], 'color' => [null, 'FF0000'], 'fill' => [null, 'FF0000'], ]; foreach ($properties as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } } ================================================ FILE: tests/PhpWordTests/Style/SpacingTest.php ================================================ [null, 10], 'after' => [null, 10], 'line' => [null, 10], ]; foreach ($properties as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } public function testGetSetPropertiesString(): void { $object = new Spacing(); $properties = [ 'lineRule' => ['auto', 'exact'], ]; foreach ($properties as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } } ================================================ FILE: tests/PhpWordTests/Style/TOCTest.php ================================================ [9062, 10], 'indent' => [200, 10], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } public function testGetSetString(): void { $object = new TOC(); foreach ([ 'tabLeader' => [TOC::TAB_LEADER_DOT, TOC::TAB_LEADER_UNDERSCORE], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } } ================================================ FILE: tests/PhpWordTests/Style/TabTest.php ================================================ [0, 10], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } /** * Test get/set. */ public function testGetSetPropertiesString(): void { $object = new Tab(); foreach ([ 'type' => [Tab::TAB_STOP_CLEAR, Tab::TAB_STOP_RIGHT], 'leader' => [Tab::TAB_LEADER_NONE, Tab::TAB_LEADER_DOT], ] as $property => $value) { [$default, $expected] = $value; $get = "get{$property}"; $set = "set{$property}"; self::assertEquals($default, $object->$get()); // Default value $object->$set($expected); self::assertEquals($expected, $object->$get()); // New value } } } ================================================ FILE: tests/PhpWordTests/Style/TablePositionTest.php ================================================ TablePosition::VANCHOR_PAGE, 'bottomFromText' => 20]; $object = new TablePosition($styleTable); self::assertEquals(TablePosition::VANCHOR_PAGE, $object->getVertAnchor()); self::assertEquals(20, $object->getBottomFromText()); } /** * Test setting style with normal value. */ public function testSetGetNormalInt(): void { $object = new TablePosition(); foreach ([ 'leftFromText' => 4, 'rightFromText' => 4, 'topFromText' => 4, 'bottomFromText' => 4, 'tblpX' => 5, 'tblpY' => 6, ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } /** * Test setting style with normal value. */ public function testSetGetNormalString(): void { $object = new TablePosition(); foreach ([ 'vertAnchor' => TablePosition::VANCHOR_PAGE, 'horzAnchor' => TablePosition::HANCHOR_TEXT, 'tblpXSpec' => TablePosition::XALIGN_CENTER, 'tblpYSpec' => TablePosition::YALIGN_OUTSIDE, ] as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } } ================================================ FILE: tests/PhpWordTests/Style/TableTest.php ================================================ 'FF0000']; $styleFirstRow = ['borderBottomSize' => 3]; $object = new Table($styleTable, $styleFirstRow); self::assertEquals('FF0000', $object->getBgColor()); $firstRow = $object->getFirstRow(); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Table', $firstRow); self::assertEquals(3, $firstRow->getBorderBottomSize()); } /** * Test default values when passing no style. */ public function testDefaultValues(): void { $object = new Table(); self::assertNull($object->getBgColor()); self::assertEquals(Table::LAYOUT_AUTO, $object->getLayout()); self::assertEquals(TblWidth::AUTO, $object->getUnit()); self::assertNull($object->getIndent()); } /** * Test setting style with normal value. */ public function testSetGetNormal(): void { $object = new Table(); $attributes = [ 'bgColor' => 'FF0000', 'borderTopSize' => 4, 'borderTopColor' => 'FF0000', 'borderLeftSize' => 4, 'borderLeftColor' => 'FF0000', 'borderRightSize' => 4, 'borderRightColor' => 'FF0000', 'borderBottomSize' => 4, 'borderBottomColor' => 'FF0000', 'borderInsideHSize' => 4, 'borderInsideHColor' => 'FF0000', 'borderInsideVSize' => 4, 'borderInsideVColor' => 'FF0000', 'cellMarginTop' => 240, 'cellMarginLeft' => 240, 'cellMarginRight' => 240, 'cellMarginBottom' => 240, 'alignment' => JcTable::CENTER, 'width' => 100, 'unit' => 'pct', 'layout' => Table::LAYOUT_FIXED, ]; foreach ($attributes as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } public function testBidiVisual(): void { $object = new Table(); self::assertNull($object->isBidiVisual()); self::assertInstanceOf(Table::class, $object->setBidiVisual(true)); self::assertTrue($object->isBidiVisual()); self::assertInstanceOf(Table::class, $object->setBidiVisual(false)); self::assertFalse($object->isBidiVisual()); self::assertInstanceOf(Table::class, $object->setBidiVisual(null)); self::assertNull($object->isBidiVisual()); } public function testBidiVisualSettings(): void { Settings::setDefaultRtl(null); $object = new Table(); self::assertNull($object->isBidiVisual()); Settings::setDefaultRtl(true); $object = new Table(); self::assertTrue($object->isBidiVisual()); Settings::setDefaultRtl(false); $object = new Table(); self::assertFalse($object->isBidiVisual()); Settings::setDefaultRtl(null); } /** * Test border color. * * Set border color and test if each part has the same color * While looping, push values array to be asserted with getBorderColor */ public function testBorderColor(): void { $object = new Table(); $parts = ['Top', 'Left', 'Right', 'Bottom', 'InsideH', 'InsideV']; $value = 'FF0000'; $object->setBorderColor($value); $values = []; foreach ($parts as $part) { $get = "getBorder{$part}Color"; $values[] = $value; self::assertEquals($value, $object->$get()); } self::assertEquals($values, $object->getBorderColor()); } /** * Test border size. * * Set border size and test if each part has the same size * While looping, push values array to be asserted with getBorderSize * Value is in eights of a point, i.e. 4 / 8 = .5pt */ public function testBorderSize(): void { $object = new Table(); $parts = ['Top', 'Left', 'Right', 'Bottom', 'InsideH', 'InsideV']; $value = 4; $object->setBorderSize($value); $values = []; foreach ($parts as $part) { $get = "getBorder{$part}Size"; $values[] = $value; self::assertEquals($value, $object->$get()); } self::assertEquals($values, $object->getBorderSize()); } /** * Test cell margin. * * Set cell margin and test if each part has the same margin * While looping, push values array to be asserted with getCellMargin * Value is in twips */ public function testCellMargin(): void { $object = new Table(); $parts = ['Top', 'Left', 'Right', 'Bottom']; $value = 240; $object->setCellMargin($value); $values = []; foreach ($parts as $part) { $get = "getCellMargin{$part}"; $values[] = $value; self::assertEquals($value, $object->$get()); } self::assertEquals($values, $object->getCellMargin()); self::assertTrue($object->hasMargin()); } /** * Set style value for various special value types. */ public function testSetStyleValue(): void { $object = new Table(); $object->setStyleValue('borderSize', 120); $object->setStyleValue('cellMargin', 240); $object->setStyleValue('borderColor', '999999'); self::assertEquals([120, 120, 120, 120, 120, 120], $object->getBorderSize()); self::assertEquals([240, 240, 240, 240], $object->getCellMargin()); self::assertEquals( ['999999', '999999', '999999', '999999', '999999', '999999'], $object->getBorderColor() ); } /** * Tests table cell spacing. */ public function testTableCellSpacing(): void { $object = new Table(); self::assertNull($object->getCellSpacing()); $object = new Table(['cellSpacing' => 20]); self::assertEquals(20, $object->getCellSpacing()); } /** * Tests table floating position. */ public function testTablePosition(): void { $object = new Table(); self::assertNull($object->getPosition()); $object->setPosition(['vertAnchor' => TablePosition::VANCHOR_PAGE]); self::assertNotNull($object->getPosition()); self::assertEquals(TablePosition::VANCHOR_PAGE, $object->getPosition()->getVertAnchor()); } public function testIndent(): void { $indent = new TblWidthComplexType(100, TblWidth::TWIP); $table = new Table(['indent' => $indent]); self::assertSame($indent, $table->getIndent()); } } ================================================ FILE: tests/PhpWordTests/Style/TextBoxTest.php ================================================ 200, 'height' => 200, 'alignment' => Jc::START, 'marginTop' => 240, 'marginLeft' => 240, 'wrappingStyle' => 'inline', 'positioning' => 'absolute', 'posHorizontal' => 'center', 'posVertical' => 'top', 'posHorizontalRel' => 'margin', 'posVerticalRel' => 'page', 'innerMarginTop' => '5', 'innerMarginRight' => '5', 'innerMarginBottom' => '5', 'innerMarginLeft' => '5', 'borderSize' => '2', 'borderColor' => 'red', 'bgColor' => 'blue', ]; foreach ($properties as $key => $value) { $set = "set{$key}"; $get = "get{$key}"; $object->$set($value); self::assertEquals($value, $object->$get()); } } /** * Test setStyleValue method. */ public function testSetStyleValue(): void { $object = new TextBox(); $properties = [ 'width' => 200, 'height' => 200, 'alignment' => Jc::START, 'marginTop' => 240, 'marginLeft' => 240, 'wrappingStyle' => 'inline', 'positioning' => 'absolute', 'posHorizontal' => 'center', 'posVertical' => 'top', 'posHorizontalRel' => 'margin', 'posVerticalRel' => 'page', 'innerMarginTop' => '5', 'innerMarginRight' => '5', 'innerMarginBottom' => '5', 'innerMarginLeft' => '5', 'borderSize' => '2', 'borderColor' => 'red', 'bgColor' => 'blue', ]; foreach ($properties as $key => $value) { $get = "get{$key}"; $object->setStyleValue("{$key}", $value); self::assertEquals($value, $object->$get()); } } /** * Test setWrappingStyle exception. */ public function testSetWrappingStyleException(): void { $this->expectException(InvalidArgumentException::class); $object = new TextBox(); $object->setWrappingStyle('foo'); } /** * Test set/get width. */ public function testSetGetWidth(): void { $expected = 200; $object = new TextBox(); $object->setWidth($expected); self::assertEquals($expected, $object->getWidth()); } /** * Test set/get height. */ public function testSetGetHeight(): void { $expected = 200; $object = new TextBox(); $object->setHeight($expected); self::assertEquals($expected, $object->getHeight()); } /** * Test set/get height. */ public function testSetGetAlign(): void { $textBox = new TextBox(); $expectedAlignment = Jc::START; $textBox->setAlignment($expectedAlignment); self::assertEquals($expectedAlignment, $textBox->getAlignment()); } /** * Test set/get marginTop. */ public function testSetGetMarginTop(): void { $expected = 5; $object = new TextBox(); $object->setMarginTop($expected); self::assertEquals($expected, $object->getMarginTop()); } /** * Test set/get marginLeft. */ public function testSetGetMarginLeft(): void { $expected = 5; $object = new TextBox(); $object->setMarginLeft($expected); self::assertEquals($expected, $object->getMarginLeft()); } /** * Test set/get innerMarginTop. */ public function testSetGetInnerMarginTop(): void { $expected = 5; $object = new TextBox(); $object->setInnerMarginTop($expected); self::assertEquals($expected, $object->getInnerMarginTop()); } /** * Test set/get wrappingStyle. */ public function testSetGetWrappingStyle(): void { $expected = 'inline'; $object = new TextBox(); $object->setWrappingStyle($expected); self::assertEquals($expected, $object->getWrappingStyle()); } /** * Test set/get positioning. */ public function testSetGetPositioning(): void { $expected = 'absolute'; $object = new TextBox(); $object->setPositioning($expected); self::assertEquals($expected, $object->getPositioning()); } /** * Test set/get posHorizontal. */ public function testSetGetPosHorizontal(): void { $expected = 'center'; $object = new TextBox(); $object->setPosHorizontal($expected); self::assertEquals($expected, $object->getPosHorizontal()); } /** * Test set/get posVertical. */ public function testSetGetPosVertical(): void { $expected = 'top'; $object = new TextBox(); $object->setPosVertical($expected); self::assertEquals($expected, $object->getPosVertical()); } /** * Test set/get posHorizontalRel. */ public function testSetGetPosHorizontalRel(): void { $expected = 'margin'; $object = new TextBox(); $object->setPosHorizontalRel($expected); self::assertEquals($expected, $object->getPosHorizontalRel()); } /** * Test set/get posVerticalRel. */ public function testSetGetPosVerticalRel(): void { $expected = 'page'; $object = new TextBox(); $object->setPosVerticalRel($expected); self::assertEquals($expected, $object->getPosVerticalRel()); } /** * Test set/get innerMarginRight. */ public function testSetGetInnerMarginRight(): void { $expected = 5; $object = new TextBox(); $object->setInnerMarginRight($expected); self::assertEquals($expected, $object->getInnerMarginRight()); } /** * Test set/get innerMarginBottom. */ public function testSetGetInnerMarginBottom(): void { $expected = 5; $object = new TextBox(); $object->setInnerMarginBottom($expected); self::assertEquals($expected, $object->getInnerMarginBottom()); } /** * Test set/get innerMarginLeft. */ public function testSetGetInnerMarginLeft(): void { $expected = 5; $object = new TextBox(); $object->setInnerMarginLeft($expected); self::assertEquals($expected, $object->getInnerMarginLeft()); } /** * Test set/get innerMarginLeft. */ public function testSetGetInnerMargin(): void { $expected = 5; $object = new TextBox(); $object->setInnerMargin($expected); self::assertEquals([$expected, $expected, $expected, $expected], $object->getInnerMargin()); } /** * Test set/get borderSize. */ public function testSetGetBorderSize(): void { $expected = 2; $object = new TextBox(); $object->setBorderSize($expected); self::assertEquals($expected, $object->getBorderSize()); } /** * Test set/get borderColor. */ public function testSetGetBorderColor(): void { $expected = 'red'; $object = new TextBox(); $object->setBorderColor($expected); self::assertEquals($expected, $object->getBorderColor()); } /** * Test set/get bgColor. */ public function testSetGetBgColor(): void { $expected = 'blue'; $object = new TextBox(); $object->setBgColor($expected); self::assertEquals($expected, $object->getBgColor()); } } ================================================ FILE: tests/PhpWordTests/StyleTest.php ================================================ Jc::CENTER]; $font = ['italic' => true, '_bold' => true]; $table = ['bgColor' => 'CCCCCC']; $numbering = [ 'type' => 'multilevel', 'levels' => [ [ 'start' => 1, 'format' => 'decimal', 'restart' => 1, 'suffix' => 'space', 'text' => '%1.', 'alignment' => Jc::START, ], ], ]; $styles = [ 'Paragraph' => 'Paragraph', 'Font' => 'Font', 'Link' => 'Font', 'Table' => 'Table', 'Heading_1' => 'Font', 'Normal' => 'Paragraph', 'Numbering' => 'Numbering', ]; Style::addParagraphStyle('Paragraph', $paragraph); Style::addFontStyle('Font', $font); Style::addLinkStyle('Link', $font); Style::addNumberingStyle('Numbering', $numbering); Style::addTitleStyle(1, $font); Style::addTableStyle('Table', $table); Style::setDefaultParagraphStyle($paragraph); self::assertCount(count($styles), Style::getStyles()); foreach ($styles as $name => $style) { self::assertInstanceOf("PhpOffice\\PhpWord\\Style\\{$style}", Style::getStyle($name)); } self::assertNull(Style::getStyle('Unknown')); Style::resetStyles(); self::assertCount(0, Style::getStyles()); } /** * Test default paragraph style. * * @covers ::setDefaultParagraphStyle */ public function testDefaultParagraphStyle(): void { $paragraph = ['alignment' => Jc::CENTER]; Style::setDefaultParagraphStyle($paragraph); self::assertInstanceOf('PhpOffice\\PhpWord\\Style\\Paragraph', Style::getStyle('Normal')); } } ================================================ FILE: tests/PhpWordTests/TemplateProcessorTest.php ================================================ templateProcessor = new TemplateProcessor($filename); return $this->templateProcessor; } protected function tearDown(): void { if ($this->templateProcessor !== null) { $filename = $this->templateProcessor->getTempDocumentFilename(); $this->templateProcessor = null; if (file_exists($filename)) { @unlink($filename); } } } /** * Construct test. * * @covers ::__construct * @covers ::__destruct * @covers \PhpOffice\PhpWord\Shared\ZipArchive::close */ public function testTheConstruct(): void { $object = $this->getTemplateProcessor(__DIR__ . '/_files/templates/blank.docx'); self::assertEquals([], $object->getVariables()); $object->save(); try { $object->zip()->close(); self::fail('Expected exception for double close'); } catch (Throwable $e) { // nothing to do here } } /** * Template can be saved in temporary location. * * @covers ::save * @covers ::zip */ public function xtestTemplateCanBeSavedInTemporaryLocation(string $templateFqfn, TemplateProcessor $templateProcessor): string { $xslDomDocument = new DOMDocument(); $xslDomDocument->load(__DIR__ . '/_files/xsl/remove_tables_by_needle.xsl'); foreach (['${employee.', '${scoreboard.', '${reference.'] as $needle) { $templateProcessor->applyXslStyleSheet($xslDomDocument, ['needle' => $needle]); } $embeddingText = 'The quick Brown Fox jumped over the lazy^H^H^H^Htired unitTester'; $templateProcessor->zip()->AddFromString('word/embeddings/fox.bin', $embeddingText); $documentFqfn = $templateProcessor->save(); self::assertNotEmpty($documentFqfn, 'FQFN of the saved document is empty.'); self::assertFileExists($documentFqfn, "The saved document \"{$documentFqfn}\" doesn't exist."); $templateZip = new ZipArchive(); $templateZip->open($templateFqfn); $templateHeaderXml = $templateZip->getFromName('word/header1.xml'); $templateMainPartXml = $templateZip->getFromName('word/document.xml'); $templateFooterXml = $templateZip->getFromName('word/footer1.xml'); if (false === $templateZip->close()) { throw new Exception("Could not close zip file \"{$templateZip}\"."); } $documentZip = new ZipArchive(); $documentZip->open($documentFqfn); $documentHeaderXml = $documentZip->getFromName('word/header1.xml'); $documentMainPartXml = $documentZip->getFromName('word/document.xml'); $documentFooterXml = $documentZip->getFromName('word/footer1.xml'); $documentEmbedding = $documentZip->getFromName('word/embeddings/fox.bin'); if (false === $documentZip->close()) { throw new Exception("Could not close zip file \"{$documentZip}\"."); } self::assertNotEquals($templateHeaderXml, $documentHeaderXml); self::assertNotEquals($templateMainPartXml, $documentMainPartXml); self::assertNotEquals($templateFooterXml, $documentFooterXml); self::assertEquals($embeddingText, $documentEmbedding); return $documentFqfn; } /** * XSL stylesheet can be applied. * * @covers ::applyXslStyleSheet */ public function testXslStyleSheetCanBeApplied(): void { $templateFqfn = __DIR__ . '/_files/templates/with_table_macros.docx'; $templateProcessor = $this->getTemplateProcessor($templateFqfn); $actualDocumentFqfn = $this->xtestTemplateCanBeSavedInTemporaryLocation($templateFqfn, $templateProcessor); $expectedDocumentFqfn = __DIR__ . '/_files/documents/without_table_macros.docx'; $actualDocumentZip = new ZipArchive(); $actualDocumentZip->open($actualDocumentFqfn); $actualHeaderXml = $actualDocumentZip->getFromName('word/header1.xml'); $actualMainPartXml = $actualDocumentZip->getFromName('word/document.xml'); $actualFooterXml = $actualDocumentZip->getFromName('word/footer1.xml'); if (false === $actualDocumentZip->close()) { throw new Exception("Could not close zip file \"{$actualDocumentFqfn}\"."); } $expectedDocumentZip = new ZipArchive(); $expectedDocumentZip->open($expectedDocumentFqfn); $expectedHeaderXml = $expectedDocumentZip->getFromName('word/header1.xml'); $expectedMainPartXml = $expectedDocumentZip->getFromName('word/document.xml'); $expectedFooterXml = $expectedDocumentZip->getFromName('word/footer1.xml'); if (false === $expectedDocumentZip->close()) { throw new Exception("Could not close zip file \"{$expectedDocumentFqfn}\"."); } self::assertSame($expectedHeaderXml, $actualHeaderXml); self::assertSame($expectedMainPartXml, $actualMainPartXml); self::assertSame($expectedFooterXml, $actualFooterXml); } /** * XSL stylesheet cannot be applied on failure in setting parameter value. * * @covers ::applyXslStyleSheet */ public function testXslStyleSheetCanNotBeAppliedOnFailureOfSettingParameterValue(): void { if (\PHP_VERSION_ID >= 80000) { // PHP 8+ internal validation throws TypeError. $this->expectException(TypeError::class); $this->expectExceptionMessage('must contain only string keys'); } else { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('Could not set values for the given XSL style sheet parameters.'); } $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/blank.docx'); $xslDomDocument = new DOMDocument(); $xslDomDocument->load(__DIR__ . '/_files/xsl/passthrough.xsl'); /* * We have to use error control below, because \XSLTProcessor::setParameter omits warning on failure. * This warning fails the test. */ @$templateProcessor->applyXslStyleSheet($xslDomDocument, [1 => 'somevalue']); } /** * XSL stylesheet can be applied on failure of loading XML from template. * * @covers ::applyXslStyleSheet */ public function testXslStyleSheetCanNotBeAppliedOnFailureOfLoadingXmlFromTemplate(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('Could not load the given XML document.'); $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/corrupted_main_document_part.docx'); $xslDomDocument = new DOMDocument(); $xslDomDocument->load(__DIR__ . '/_files/xsl/passthrough.xsl'); /* * We have to use error control below, because \DOMDocument::loadXML omits warning on failure. * This warning fails the test. */ @$templateProcessor->applyXslStyleSheet($xslDomDocument); } /** * @covers ::deleteRow * @covers ::getVariables * @covers ::saveAs */ public function testDeleteRow(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/delete-row.docx'); self::assertEquals( ['deleteMe', 'deleteMeToo'], $templateProcessor->getVariables() ); $docName = 'delete-row-test-result.docx'; $templateProcessor->deleteRow('deleteMe'); self::assertEquals( [], $templateProcessor->getVariables() ); $templateProcessor->saveAs($docName); $docFound = file_exists($docName); unlink($docName); self::assertTrue($docFound); } /** * @covers ::cloneRow * @covers ::saveAs * @covers ::setValue */ public function testCloneRow(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/clone-merge.docx'); self::assertEquals( ['tableHeader', 'userId', 'userName', 'userLocation'], $templateProcessor->getVariables() ); $docName = 'clone-test-result.docx'; $templateProcessor->setValue('tableHeader', 'ééé'); $templateProcessor->cloneRow('userId', 1); $templateProcessor->setValue('userId#1', 'Test'); $templateProcessor->saveAs($docName); $docFound = file_exists($docName); unlink($docName); self::assertTrue($docFound); } /** * @covers ::cloneRow * @covers ::saveAs * @covers ::setValue */ public function testCloneRowWithCustomMacro(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/clone-merge-with-custom-macro.docx'); $templateProcessor->setMacroOpeningChars('{#'); $templateProcessor->setMacroClosingChars('#}'); self::assertEquals( ['tableHeader', 'userId', 'userName', 'userLocation'], $templateProcessor->getVariables() ); $docName = 'clone-test-result.docx'; $templateProcessor->setValue('tableHeader', 'ééé'); $templateProcessor->cloneRow('userId', 1); $templateProcessor->setValue('userId#1', 'Test'); $templateProcessor->saveAs($docName); $docFound = file_exists($docName); unlink($docName); self::assertTrue($docFound); } /** * @covers ::cloneRow * @covers ::saveAs * @covers ::setValue */ public function testCloneRowAndSetValues(): void { $mainPart = ' ${userId} ${userName} ${userLocation} '; $templateProcessor = new TestableTemplateProcesor($mainPart); self::assertEquals( ['userId', 'userName', 'userLocation'], $templateProcessor->getVariables() ); $values = [ ['userId' => 1, 'userName' => 'Batman', 'userLocation' => 'Gotham City'], ['userId' => 2, 'userName' => 'Superman', 'userLocation' => 'Metropolis'], ]; $templateProcessor->setValue('tableHeader', 'My clonable table'); $templateProcessor->cloneRowAndSetValues('userId', $values); self::assertStringContainsString('Superman', $templateProcessor->getMainPart()); self::assertStringContainsString('Metropolis', $templateProcessor->getMainPart()); } public function testCloneNotExistingRowShouldThrowException(): void { $this->expectException(Exception::class); $mainPart = 'text'; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->cloneRow('fake_search', 2); } /** * @covers ::cloneRow * @covers ::saveAs * @covers ::setValue */ public function testCloneRowAndSetValuesWithCustomMacro(): void { $mainPart = ' {{userId}} {{userName}} {{userLocation}} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroOpeningChars('{{'); $templateProcessor->setMacroClosingChars('}}'); self::assertEquals( ['userId', 'userName', 'userLocation'], $templateProcessor->getVariables() ); $values = [ ['userId' => 1, 'userName' => 'Batman', 'userLocation' => 'Gotham City'], ['userId' => 2, 'userName' => 'Superman', 'userLocation' => 'Metropolis'], ]; $templateProcessor->setValue('tableHeader', 'My clonable table'); $templateProcessor->cloneRowAndSetValues('userId', $values); self::assertStringContainsString('Superman', $templateProcessor->getMainPart()); self::assertStringContainsString('Metropolis', $templateProcessor->getMainPart()); } /** * @covers ::saveAs * @covers ::setValue */ public function testMacrosCanBeReplacedInHeaderAndFooter(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/header-footer.docx'); self::assertEquals(['documentContent', 'headerValue:100:100', 'footerValue'], $templateProcessor->getVariables()); $macroNames = ['headerValue', 'documentContent', 'footerValue']; $macroValues = ['Header Value', 'Document text.', 'Footer Value']; $templateProcessor->setValue($macroNames, $macroValues); $docName = 'header-footer-test-result.docx'; $templateProcessor->saveAs($docName); $docFound = file_exists($docName); unlink($docName); self::assertTrue($docFound); } /** * @covers ::saveAs * @covers ::setValue */ public function testCustomMacrosCanBeReplacedInHeaderAndFooter(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/header-footer-with-custom-macro.docx'); $templateProcessor->setMacroOpeningChars('{{'); $templateProcessor->setMacroClosingChars('}}'); self::assertEquals(['documentContent', 'headerValue:100:100', 'footerValue'], $templateProcessor->getVariables()); $macroNames = ['headerValue', 'documentContent', 'footerValue']; $macroValues = ['Header Value', 'Document text.', 'Footer Value']; $templateProcessor->setValue($macroNames, $macroValues); $docName = 'header-footer-test-result.docx'; $templateProcessor->saveAs($docName); $docFound = file_exists($docName); unlink($docName); self::assertTrue($docFound); } /** * @covers ::setValue */ public function testSetValue(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/clone-merge.docx'); Settings::setOutputEscapingEnabled(true); $helloworld = "hello\nworld"; $templateProcessor->setValue('userName', $helloworld); self::assertEquals( ['tableHeader', 'userId', 'userLocation'], $templateProcessor->getVariables() ); } /** * @covers ::setValue */ public function testSetValueWithCustomMacro(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/clone-merge-with-custom-macro.docx'); $templateProcessor->setMacroChars('{#', '#}'); Settings::setOutputEscapingEnabled(true); $helloworld = "hello\nworld"; $templateProcessor->setValue('userName', $helloworld); self::assertEquals( ['tableHeader', 'userId', 'userLocation'], $templateProcessor->getVariables() ); } public function testSetComplexValue(): void { $title = new TextRun(); $title->addText('This is my title'); $firstname = new Text('Donald'); $lastname = new Text('Duck'); $mainPart = ' Hello ${document-title} Hello ${firstname} ${lastname} '; $result = ' This is my title Hello Donald Duck '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setComplexBlock('document-title', $title); $templateProcessor->setComplexValue('firstname', $firstname); $templateProcessor->setComplexValue('lastname', $lastname); self::assertEquals(preg_replace('/>\s+<', $result), preg_replace('/>\s+<', $templateProcessor->getMainPart())); } public function testSetComplexValueWithCustomMacro(): void { $title = new TextRun(); $title->addText('This is my title'); $firstname = new Text('Donald'); $lastname = new Text('Duck'); $mainPart = ' Hello {{document-title}} Hello {{firstname}} {{lastname}} '; $result = ' This is my title Hello Donald Duck '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{{', '}}'); $templateProcessor->setComplexBlock('document-title', $title); $templateProcessor->setComplexValue('firstname', $firstname); $templateProcessor->setComplexValue('lastname', $lastname); self::assertEquals(preg_replace('/>\s+<', $result), preg_replace('/>\s+<', $templateProcessor->getMainPart())); } /** * @covers ::setValues */ public function testSetValues(): void { $mainPart = ' Hello ${firstname} ${lastname} Hello ${firstname} ${lastname} Hello ${firstname} ${lastname} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setValues(['firstname' => 'John', 'lastname' => 'Doe']); self::assertStringContainsString('Hello John Doe', $templateProcessor->getMainPart()); self::assertStringNotContainsString('Hello ${firstname} ${lastname}', $templateProcessor->getMainPart()); // test with a specific limit that is lower than the number of replacements $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setValues(['firstname' => 'Jane', 'lastname' => 'Smith'], 2); $variablesCounts = $templateProcessor->getVariableCount(); self::assertStringContainsString('Hello Jane Smith', $templateProcessor->getMainPart()); self::assertStringContainsString('Hello ${firstname} ${lastname}', $templateProcessor->getMainPart()); self::assertEquals(1, $variablesCounts['firstname']); self::assertEquals(1, $variablesCounts['lastname']); // test with a limit for only one replacement $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setValues(['firstname' => 'Alice', 'lastname' => 'Wonderland'], 1); $variablesCounts = $templateProcessor->getVariableCount(); self::assertStringContainsString('Hello Alice Wonderland', $templateProcessor->getMainPart()); self::assertStringContainsString('Hello ${firstname} ${lastname}', $templateProcessor->getMainPart()); self::assertEquals(2, $variablesCounts['firstname']); self::assertEquals(2, $variablesCounts['lastname']); // Test with a limit of 0 for a result with no replacements $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setValues(['firstname' => 'Test', 'lastname' => 'User'], 0); $variablesCounts = $templateProcessor->getVariableCount(); self::assertStringContainsString('Hello ${firstname} ${lastname}', $templateProcessor->getMainPart()); self::assertStringNotContainsString('Hello Test User', $templateProcessor->getMainPart()); self::assertEquals(3, $variablesCounts['firstname']); self::assertEquals(3, $variablesCounts['lastname']); } /** * @covers ::setValues */ public function testSetValuesMultiLine(): void { $mainPart = ' Address: ${address} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setValues(['address' => "Peter Pan\nNeverland"]); self::assertStringContainsString('Address: Peter PanNeverland', $templateProcessor->getMainPart()); } /** * @covers ::setValues */ public function testSetValuesWithCustomMacro(): void { $mainPart = ' Hello {#firstname#} {#lastname#} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{#', '#}'); $templateProcessor->setValues(['firstname' => 'John', 'lastname' => 'Doe']); self::assertStringContainsString('Hello John Doe', $templateProcessor->getMainPart()); } /** * @covers ::setCheckbox */ public function testSetCheckbox(): void { $mainPart = ' ☐ ☒ '; $result = ' ☒ ☐ '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setCheckbox('checkbox', true); $templateProcessor->setCheckbox('checkbox2', false); self::assertEquals(preg_replace('/>\s+<', $result), preg_replace('/>\s+<', $templateProcessor->getMainPart())); } /** * @covers ::setCheckbox */ public function testSetCheckboxWithCustomMacro(): void { $mainPart = ' ☐ ☒ '; $result = ' ☒ ☐ '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{#', '#}'); $templateProcessor->setCheckbox('checkbox', true); $templateProcessor->setCheckbox('checkbox2', false); self::assertEquals(preg_replace('/>\s+<', $result), preg_replace('/>\s+<', $templateProcessor->getMainPart())); } /** * @covers ::setImageValue */ public function testSetImageValue(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/header-footer.docx'); $imagePath = __DIR__ . '/_files/images/earth.jpg'; $variablesReplace = [ 'headerValue' => function () use ($imagePath) { return $imagePath; }, 'documentContent' => ['path' => $imagePath, 'width' => 500, 'height' => 500], 'footerValue' => ['path' => $imagePath, 'width' => 100, 'height' => 50, 'ratio' => false], ]; $templateProcessor->setImageValue(array_keys($variablesReplace), $variablesReplace); $docName = 'header-footer-images-test-result.docx'; $templateProcessor->saveAs($docName); self::assertFileExists($docName, "Generated file '{$docName}' not found!"); $expectedDocumentZip = new ZipArchive(); $expectedDocumentZip->open($docName); $expectedContentTypesXml = $expectedDocumentZip->getFromName('[Content_Types].xml'); $expectedDocumentRelationsXml = $expectedDocumentZip->getFromName('word/_rels/document.xml.rels'); $expectedHeaderRelationsXml = $expectedDocumentZip->getFromName('word/_rels/header1.xml.rels'); $expectedFooterRelationsXml = $expectedDocumentZip->getFromName('word/_rels/footer1.xml.rels'); $expectedMainPartXml = $expectedDocumentZip->getFromName('word/document.xml'); $expectedHeaderPartXml = $expectedDocumentZip->getFromName('word/header1.xml'); $expectedFooterPartXml = $expectedDocumentZip->getFromName('word/footer1.xml'); $expectedImage = $expectedDocumentZip->getFromName('word/media/image_rId11_document.jpeg'); if (false === $expectedDocumentZip->close()) { throw new Exception("Could not close zip file \"{$docName}\"."); } self::assertNotEmpty($expectedImage, 'Embed image doesn\'t found.'); self::assertStringContainsString('/word/media/image_rId11_document.jpeg', $expectedContentTypesXml, '[Content_Types].xml missed "/word/media/image5_document.jpeg"'); self::assertStringContainsString('/word/_rels/header1.xml.rels', $expectedContentTypesXml, '[Content_Types].xml missed "/word/_rels/header1.xml.rels"'); self::assertStringContainsString('/word/_rels/footer1.xml.rels', $expectedContentTypesXml, '[Content_Types].xml missed "/word/_rels/footer1.xml.rels"'); self::assertStringNotContainsString('${documentContent}', $expectedMainPartXml, 'word/document.xml has no image.'); self::assertStringNotContainsString('${headerValue}', $expectedHeaderPartXml, 'word/header1.xml has no image.'); self::assertStringNotContainsString('${footerValue}', $expectedFooterPartXml, 'word/footer1.xml has no image.'); self::assertStringContainsString('media/image_rId11_document.jpeg', $expectedDocumentRelationsXml, 'word/_rels/document.xml.rels missed "media/image5_document.jpeg"'); self::assertStringContainsString('media/image_rId11_document.jpeg', $expectedHeaderRelationsXml, 'word/_rels/header1.xml.rels missed "media/image5_document.jpeg"'); self::assertStringContainsString('media/image_rId11_document.jpeg', $expectedFooterRelationsXml, 'word/_rels/footer1.xml.rels missed "media/image5_document.jpeg"'); unlink($docName); // dynamic generated doc $testFileName = 'images-test-sample.docx'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('${Test:width=100:ratio=true}'); $objWriter = IOFactory::createWriter($phpWord, 'Word2007'); $objWriter->save($testFileName); self::assertFileExists($testFileName, "Generated file '{$testFileName}' not found!"); $resultFileName = 'images-test-result.docx'; $templateProcessor = new TemplateProcessor($testFileName); unlink($testFileName); $templateProcessor->setImageValue('Test', $imagePath); $templateProcessor->setImageValue('Test1', $imagePath); $templateProcessor->setImageValue('Test2', $imagePath); $templateProcessor->saveAs($resultFileName); self::assertFileExists($resultFileName, "Generated file '{$resultFileName}' not found!"); $expectedDocumentZip = new ZipArchive(); $expectedDocumentZip->open($resultFileName); $expectedMainPartXml = $expectedDocumentZip->getFromName('word/document.xml'); if (false === $expectedDocumentZip->close()) { throw new Exception("Could not close zip file \"{$resultFileName}\"."); } unlink($resultFileName); self::assertStringNotContainsString('${Test}', $expectedMainPartXml, 'word/document.xml has no image.'); } /** * @covers ::cloneBlock * @covers ::deleteBlock * @covers ::saveAs */ public function testCloneDeleteBlock(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/clone-delete-block.docx'); self::assertEquals( ['DELETEME', '/DELETEME', 'CLONEME', 'blockVariable', '/CLONEME'], $templateProcessor->getVariables() ); $docName = 'clone-delete-block-result.docx'; $templateProcessor->cloneBlock('CLONEME', 3); $templateProcessor->deleteBlock('DELETEME'); $templateProcessor->setValue('blockVariable#3', 'Test'); $templateProcessor->saveAs($docName); $docFound = file_exists($docName); unlink($docName); self::assertTrue($docFound); } /** * @covers ::getVariableCount */ public function testGetVariableCountCountsHowManyTimesEachPlaceholderIsPresent(): void { // create template with placeholders $phpWord = new PhpWord(); $section = $phpWord->addSection(); $header = $section->addHeader(); $header->addText('${a_field_that_is_present_three_times}'); $footer = $section->addFooter(); $footer->addText('${a_field_that_is_present_twice}'); $section2 = $phpWord->addSection(); $section2->addText(' ${a_field_that_is_present_one_time} ${a_field_that_is_present_three_times} ${a_field_that_is_present_twice} ${a_field_that_is_present_three_times} '); $objWriter = IOFactory::createWriter($phpWord); $templatePath = 'test.docx'; $objWriter->save($templatePath); $templateProcessor = $this->getTemplateProcessor($templatePath); $variableCount = $templateProcessor->getVariableCount(); unlink($templatePath); self::assertEquals( [ 'a_field_that_is_present_three_times' => 3, 'a_field_that_is_present_twice' => 2, 'a_field_that_is_present_one_time' => 1, ], $variableCount ); } /** * @covers ::getVariableCount */ public function testGetVariableCountCountsHowManyTimesEachPlaceholderIsPresentWithCustomMacro(): void { // create template with placeholders $phpWord = new PhpWord(); $section = $phpWord->addSection(); $header = $section->addHeader(); $header->addText('{{a_field_that_is_present_three_times}}'); $footer = $section->addFooter(); $footer->addText('{{a_field_that_is_present_twice}}'); $section2 = $phpWord->addSection(); $section2->addText(' {{a_field_that_is_present_one_time}} {{a_field_that_is_present_three_times}} {{a_field_that_is_present_twice}} {{a_field_that_is_present_three_times}} '); $objWriter = IOFactory::createWriter($phpWord); $templatePath = 'test.docx'; $objWriter->save($templatePath); $templateProcessor = $this->getTemplateProcessor($templatePath); $templateProcessor->setMacroChars('{{', '}}'); $variableCount = $templateProcessor->getVariableCount(); unlink($templatePath); self::assertEquals( [ 'a_field_that_is_present_three_times' => 3, 'a_field_that_is_present_twice' => 2, 'a_field_that_is_present_one_time' => 1, ], $variableCount ); } /** * @covers ::cloneBlock */ public function testCloneBlockCanCloneABlockTwice(): void { // create template with placeholders and block $phpWord = new PhpWord(); $section = $phpWord->addSection(); $documentElements = [ 'Title: ${title}', '${subreport}', '${subreport.id}: ${subreport.text}. ', '${/subreport}', ]; foreach ($documentElements as $documentElement) { $section->addText($documentElement); } $objWriter = IOFactory::createWriter($phpWord); $templatePath = 'test.docx'; $objWriter->save($templatePath); // replace placeholders and save the file $templateProcessor = $this->getTemplateProcessor($templatePath); $templateProcessor->setValue('title', 'Some title'); $templateProcessor->cloneBlock('subreport', 2); $templateProcessor->setValue('subreport.id', '123', 1); $templateProcessor->setValue('subreport.text', 'Some text', 1); $templateProcessor->setValue('subreport.id', '456', 1); $templateProcessor->setValue('subreport.text', 'Some other text', 1); $templateProcessor->saveAs($templatePath); // assert the block has been cloned twice // and the placeholders have been replaced correctly $phpWord = IOFactory::load($templatePath); $sections = $phpWord->getSections(); /** @var TextRun[] $actualElements */ $actualElements = $sections[0]->getElements(); unlink($templatePath); $expectedElements = [ 'Title: Some title', '123: Some text. ', '456: Some other text. ', ]; self::assertCount(count($expectedElements), $actualElements); foreach ($expectedElements as $i => $expectedElement) { self::assertEquals( $expectedElement, $actualElements[$i]->getElement(0)->getText() ); } } /** * @covers ::cloneBlock */ public function testCloneBlockCanCloneABlockTwiceWithCustomMacro(): void { // create template with placeholders and block $phpWord = new PhpWord(); $section = $phpWord->addSection(); $documentElements = [ 'Title: {{title}}', '{{subreport}}', '{{subreport.id}}: {{subreport.text}}. ', '{{/subreport}}', ]; foreach ($documentElements as $documentElement) { $section->addText($documentElement); } $objWriter = IOFactory::createWriter($phpWord); $templatePath = 'test.docx'; $objWriter->save($templatePath); // replace placeholders and save the file $templateProcessor = $this->getTemplateProcessor($templatePath); $templateProcessor->setMacroChars('{{', '}}'); $templateProcessor->setValue('title', 'Some title'); $templateProcessor->cloneBlock('subreport', 2); $templateProcessor->setValue('subreport.id', '123', 1); $templateProcessor->setValue('subreport.text', 'Some text', 1); $templateProcessor->setValue('subreport.id', '456', 1); $templateProcessor->setValue('subreport.text', 'Some other text', 1); $templateProcessor->saveAs($templatePath); // assert the block has been cloned twice // and the placeholders have been replaced correctly $phpWord = IOFactory::load($templatePath); $sections = $phpWord->getSections(); /** @var TextRun[] $actualElements */ $actualElements = $sections[0]->getElements(); unlink($templatePath); $expectedElements = [ 'Title: Some title', '123: Some text. ', '456: Some other text. ', ]; self::assertCount(count($expectedElements), $actualElements); foreach ($expectedElements as $i => $expectedElement) { self::assertEquals( $expectedElement, $actualElements[$i]->getElement(0)->getText() ); } } /** * @covers ::cloneBlock */ public function testCloneBlock(): void { $mainPart = ' ${CLONEME} This block will be cloned with ${variable} ${/CLONEME} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->cloneBlock('CLONEME', 3); self::assertEquals(3, substr_count($templateProcessor->getMainPart(), 'This block will be cloned with ${variable}')); } /** * @covers ::cloneBlock */ public function testCloneBlockWithCustomMacro(): void { $mainPart = ' {{CLONEME}} This block will be cloned with {{variable}} {{/CLONEME}} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{{', '}}'); $templateProcessor->cloneBlock('CLONEME', 3); self::assertEquals(3, substr_count($templateProcessor->getMainPart(), 'This block will be cloned with {{variable}}')); } /** * @covers ::cloneBlock */ public function testCloneBlockWithVariables(): void { $mainPart = ' ${CLONEME} Address ${address}, Street ${street} ${/CLONEME} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->cloneBlock('CLONEME', 3, true, true); self::assertStringContainsString('Address ${address#1}, Street ${street#1}', $templateProcessor->getMainPart()); self::assertStringContainsString('Address ${address#2}, Street ${street#2}', $templateProcessor->getMainPart()); self::assertStringContainsString('Address ${address#3}, Street ${street#3}', $templateProcessor->getMainPart()); } /** * @covers ::cloneBlock */ public function testCloneBlockWithVariablesAndCustomMacro(): void { $mainPart = ' {{CLONEME}} Address {{address}}, Street {{street}} {{/CLONEME}} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{{', '}}'); $templateProcessor->cloneBlock('CLONEME', 3, true, true); self::assertStringContainsString('Address {{address#1}}, Street {{street#1}}', $templateProcessor->getMainPart()); self::assertStringContainsString('Address {{address#2}}, Street {{street#2}}', $templateProcessor->getMainPart()); self::assertStringContainsString('Address {{address#3}}, Street {{street#3}}', $templateProcessor->getMainPart()); } public function testCloneBlockWithVariableReplacements(): void { $mainPart = ' ${CLONEME} City: ${city}, Street: ${street} ${/CLONEME} '; $replacements = [ ['city' => 'London', 'street' => 'Baker Street'], ['city' => 'New York', 'street' => '5th Avenue'], ['city' => 'Rome', 'street' => 'Via della Conciliazione'], ]; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->cloneBlock('CLONEME', 0, true, false, $replacements); self::assertStringContainsString('City: London, Street: Baker Street', $templateProcessor->getMainPart()); self::assertStringContainsString('City: New York, Street: 5th Avenue', $templateProcessor->getMainPart()); self::assertStringContainsString('City: Rome, Street: Via della Conciliazione', $templateProcessor->getMainPart()); } public function testCloneBlockWithVariableReplacementsAndCustomMacro(): void { $mainPart = ' {{CLONEME}} City: {{city}}, Street: {{street}} {{/CLONEME}} '; $replacements = [ ['city' => 'London', 'street' => 'Baker Street'], ['city' => 'New York', 'street' => '5th Avenue'], ['city' => 'Rome', 'street' => 'Via della Conciliazione'], ]; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{{', '}}'); $templateProcessor->cloneBlock('CLONEME', 0, true, false, $replacements); self::assertStringContainsString('City: London, Street: Baker Street', $templateProcessor->getMainPart()); self::assertStringContainsString('City: New York, Street: 5th Avenue', $templateProcessor->getMainPart()); self::assertStringContainsString('City: Rome, Street: Via della Conciliazione', $templateProcessor->getMainPart()); } /** * Template macros can be fixed. * * @covers ::fixBrokenMacros */ public function testFixBrokenMacros(): void { $templateProcessor = new TestableTemplateProcesor(); $fixed = $templateProcessor->fixBrokenMacros('normal text'); self::assertEquals('normal text', $fixed); $fixed = $templateProcessor->fixBrokenMacros('${documentContent}'); self::assertEquals('${documentContent}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('${documentContent}'); self::assertEquals('${documentContent}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('$1500${documentContent}'); self::assertEquals('$1500${documentContent}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('$1500${documentContent}'); self::assertEquals('$1500${documentContent}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('25$ plus some info {hint}'); self::assertEquals('25$ plus some info {hint}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('$15,000.00. ${variable_name}'); self::assertEquals('$15,000.00. ${variable_name}', $fixed); } /** * Template macros can be fixed even with cutome macro. * * @covers ::fixBrokenMacros */ public function testFixBrokenMacrosWithCustomMacro(): void { $templateProcessor = new TestableTemplateProcesor(); $templateProcessor->setMacroChars('{{', '}}'); $fixed = $templateProcessor->fixBrokenMacros('normal text'); self::assertEquals('normal text', $fixed); $fixed = $templateProcessor->fixBrokenMacros('{{documentContent}}'); self::assertEquals('{{documentContent}}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('{{documentContent}}'); self::assertEquals('{{documentContent}}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('$1500{{documentContent}}'); self::assertEquals('$1500{{documentContent}}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('$1500{{documentContent}}'); self::assertEquals('$1500{{documentContent}}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('25$ plus some info {hint}'); self::assertEquals('25$ plus some info {hint}', $fixed); $fixed = $templateProcessor->fixBrokenMacros('$15,000.00. {{variable_name}}'); self::assertEquals('$15,000.00. {{variable_name}}', $fixed); } /** * @covers ::getMainPartName */ public function testMainPartNameDetection(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/document22-xml.docx'); $variables = ['test']; self::assertEquals($variables, $templateProcessor->getVariables()); } /** * @covers ::getMainPartName */ public function testMainPartNameDetectionWithCustomMacro(): void { $templateProcessor = $this->getTemplateProcessor(__DIR__ . '/_files/templates/document22-with-custom-macro-xml.docx'); $templateProcessor->setMacroOpeningChars('{#'); $templateProcessor->setMacroClosingChars('#}'); $variables = ['test']; self::assertEquals($variables, $templateProcessor->getVariables()); } /** * @covers ::getVariables */ public function testGetVariables(): void { $templateProcessor = new TestableTemplateProcesor(); $variables = $templateProcessor->getVariablesForPart('normal text'); self::assertEquals([], $variables); $variables = $templateProcessor->getVariablesForPart('${documentContent}'); self::assertEquals(['documentContent'], $variables); $variables = $templateProcessor->getVariablesForPart('$15,000.00. ${variable_name}'); self::assertEquals(['variable_name'], $variables); } /** * @covers ::getVariables */ public function testGetVariablesWithCustomMacro(): void { $templateProcessor = new TestableTemplateProcesor(); $templateProcessor->setMacroOpeningChars('{{'); $templateProcessor->setMacroClosingChars('}}'); $variables = $templateProcessor->getVariablesForPart('normal text'); self::assertEquals([], $variables); $variables = $templateProcessor->getVariablesForPart('{{documentContent}}'); self::assertEquals(['documentContent'], $variables); $variables = $templateProcessor->getVariablesForPart('{15,000.00. {{variable_name}}'); self::assertEquals(['variable_name'], $variables); } /** * @covers ::textNeedsSplitting */ public function testTextNeedsSplitting(): void { $templateProcessor = new TestableTemplateProcesor(); self::assertFalse($templateProcessor->textNeedsSplitting('${nothing-to-replace}')); $text = 'Hello ${firstname} ${lastname}'; self::assertTrue($templateProcessor->textNeedsSplitting($text)); $splitText = $templateProcessor->splitTextIntoTexts($text); self::assertFalse($templateProcessor->textNeedsSplitting($splitText)); } /** * @covers ::textNeedsSplitting */ public function testTextNeedsSplittingWithCustomMacro(): void { $templateProcessor = new TestableTemplateProcesor(); $templateProcessor->setMacroChars('{{', '}}'); self::assertFalse($templateProcessor->textNeedsSplitting('{{nothing-to-replace}}')); $text = 'Hello {{firstname}} {{lastname}}'; self::assertTrue($templateProcessor->textNeedsSplitting($text)); $splitText = $templateProcessor->splitTextIntoTexts($text); self::assertFalse($templateProcessor->textNeedsSplitting($splitText)); } /** * @covers ::splitTextIntoTexts */ public function testSplitTextIntoTexts(): void { $templateProcessor = new TestableTemplateProcesor(); $splitText = $templateProcessor->splitTextIntoTexts('${nothing-to-replace}'); self::assertEquals('${nothing-to-replace}', $splitText); $splitText = $templateProcessor->splitTextIntoTexts('Hello ${firstname} ${lastname}'); self::assertEquals('Hello ${firstname} ${lastname}', $splitText); } /** * @covers ::splitTextIntoTexts */ public function testSplitTextIntoTextsWithCustomMacro(): void { $templateProcessor = new TestableTemplateProcesor(); $templateProcessor->setMacroChars('{{', '}}'); $splitText = $templateProcessor->splitTextIntoTexts('{{nothing-to-replace}}'); self::assertEquals('{{nothing-to-replace}}', $splitText); $splitText = $templateProcessor->splitTextIntoTexts('Hello {{firstname}} {{lastname}}'); self::assertEquals('Hello {{firstname}} {{lastname}}', $splitText); } public function testFindXmlBlockStart(): void { $toFind = ' This whole paragraph will be replaced with my ${title} '; $mainPart = ' ${value1} ${value2} . ' . $toFind . ' '; $templateProcessor = new TestableTemplateProcesor($mainPart); $position = $templateProcessor->findContainingXmlBlockForMacro('${title}', 'w:r'); self::assertEquals($toFind, $templateProcessor->getSlice($position['start'], $position['end'])); } public function testFindXmlBlockStartWithCustomMacro(): void { $toFind = ' This whole paragraph will be replaced with my {{title}} '; $mainPart = ' {{value1}} {{value2}} . ' . $toFind . ' '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{{', '}}'); $position = $templateProcessor->findContainingXmlBlockForMacro('{{title}}', 'w:r'); self::assertEquals($toFind, $templateProcessor->getSlice($position['start'], $position['end'])); } public function testShouldReturnFalseIfXmlBlockNotFound(): void { $mainPart = ' this is my text containing a ${macro} '; $templateProcessor = new TestableTemplateProcesor($mainPart); //non-existing macro $result = $templateProcessor->findContainingXmlBlockForMacro('${fake-macro}', 'w:p'); self::assertFalse($result); //existing macro but not inside node looked for $result = $templateProcessor->findContainingXmlBlockForMacro('${macro}', 'w:fake-node'); self::assertFalse($result); //existing macro but end tag not found after macro $result = $templateProcessor->findContainingXmlBlockForMacro('${macro}', 'w:rPr'); self::assertFalse($result); } public function testShouldReturnFalseIfXmlBlockNotFoundWithCustomMacro(): void { $mainPart = ' this is my text containing a ${macro} '; $templateProcessor = new TestableTemplateProcesor($mainPart); $templateProcessor->setMacroChars('{{', '}}'); //non-existing macro $result = $templateProcessor->findContainingXmlBlockForMacro('{{fake-macro}}', 'w:p'); self::assertFalse($result); //existing macro but not inside node looked for $result = $templateProcessor->findContainingXmlBlockForMacro('{{macro}}', 'w:fake-node'); self::assertFalse($result); //existing macro but end tag not found after macro $result = $templateProcessor->findContainingXmlBlockForMacro('{{macro}}', 'w:rPr'); self::assertFalse($result); } public function testShouldMakeFieldsUpdateOnOpen(): void { $settingsPart = ' '; $templateProcessor = new TestableTemplateProcesor(null, $settingsPart); $templateProcessor->setUpdateFields(true); self::assertStringContainsString('', $templateProcessor->getSettingsPart()); $templateProcessor->setUpdateFields(false); self::assertStringContainsString('', $templateProcessor->getSettingsPart()); } public function testShouldMakeFieldsUpdateOnOpenWithCustomMacro(): void { $settingsPart = ' '; $templateProcessor = new TestableTemplateProcesor(null, $settingsPart); $templateProcessor->setMacroChars('{{', '}}'); $templateProcessor->setUpdateFields(true); self::assertStringContainsString('', $templateProcessor->getSettingsPart()); $templateProcessor->setUpdateFields(false); self::assertStringContainsString('', $templateProcessor->getSettingsPart()); } public function testEnsureUtf8Encoded(): void { $mainPart = ' ${stringZero} ${intZero} ${stringTest} ${null} ${floatZero} ${intTen} ${boolFalse} ${boolTrue} '; $templateProcessor = new TestableTemplateProcesor($mainPart); self::assertEquals( ['stringZero', 'intZero', 'stringTest', 'null', 'floatZero', 'intTen', 'boolFalse', 'boolTrue'], $templateProcessor->getVariables() ); $templateProcessor->setValue('stringZero', '0'); self::assertStringContainsString('0', $templateProcessor->getMainPart()); $templateProcessor->setValue('intZero', 0); self::assertStringContainsString('0', $templateProcessor->getMainPart()); $templateProcessor->setValue('stringTest', 'test'); self::assertStringContainsString('test', $templateProcessor->getMainPart()); $templateProcessor->setValue('null', null); self::assertStringContainsString('', $templateProcessor->getMainPart()); $templateProcessor->setValue('floatZero', 0.00); self::assertStringContainsString('0', $templateProcessor->getMainPart()); $templateProcessor->setValue('intTen', 10); self::assertStringContainsString('10', $templateProcessor->getMainPart()); $templateProcessor->setValue('boolFalse', false); self::assertStringContainsString('', $templateProcessor->getMainPart()); $templateProcessor->setValue('boolTrue', true); self::assertStringContainsString('1', $templateProcessor->getMainPart()); } } ================================================ FILE: tests/PhpWordTests/TestHelperDOCX.php ================================================ save(self::$file); $zip = new ZipArchive(); $res = $zip->open(self::$file); if (true === $res) { $zip->extractTo(Settings::getTempDir() . '/PhpWord_Unit_Test/'); $zip->close(); } $doc = new XmlDocument(Settings::getTempDir() . '/PhpWord_Unit_Test/'); if ($writerName === 'ODText') { $doc->setDefaultFile('content.xml'); } return $doc; } /** * Clear document. */ public static function clear(): void { if (self::$file && file_exists(self::$file)) { unlink(self::$file); self::$file = ''; } if (is_dir(Settings::getTempDir() . '/PhpWord_Unit_Test/')) { self::deleteDir(Settings::getTempDir() . '/PhpWord_Unit_Test/'); } } /** * Delete directory. * * @param string $dir */ public static function deleteDir($dir): void { foreach (scandir($dir) as $file) { if ('.' === $file || '..' === $file) { continue; } elseif (is_file($dir . '/' . $file)) { unlink($dir . '/' . $file); } elseif (is_dir($dir . '/' . $file)) { self::deleteDir($dir . '/' . $file); } } @rmdir($dir); } /** * Get file. * * @return string */ public static function getFile() { return self::$file; } } ================================================ FILE: tests/PhpWordTests/TestableTemplateProcesor.php ================================================ tempDocumentMainPart = $mainPart; $this->tempDocumentSettingsPart = $settingsPart; } public function fixBrokenMacros($documentPart) { return parent::fixBrokenMacros($documentPart); } public function splitTextIntoTexts($text) { return parent::splitTextIntoTexts($text); } public function textNeedsSplitting($text) { return parent::textNeedsSplitting($text); } public function getVariablesForPart($documentPartXML) { $documentPartXML = parent::fixBrokenMacros($documentPartXML); return parent::getVariablesForPart($documentPartXML); } public function findXmlBlockStart($offset, $blockType) { return parent::findXmlBlockStart($offset, $blockType); } public function findContainingXmlBlockForMacro($macro, $blockType = 'w:p') { return parent::findContainingXmlBlockForMacro($macro, $blockType); } public function getSlice($startPosition, $endPosition = 0) { return parent::getSlice($startPosition, $endPosition); } /** * @return string */ public function getMainPart() { return $this->tempDocumentMainPart; } /** * @return string */ public function getSettingsPart() { return $this->tempDocumentSettingsPart; } } ================================================ FILE: tests/PhpWordTests/WriteReadback/ODTextTest.php ================================================ addSection(); $sectionWriter->addText($testText); $writer = new ODText($phpWordWriter); $file = __DIR__ . '/../_files/temp.odt'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'ODText'); self::assertCount(1, $phpWordReader->getSections()); self::assertCount(1, $phpWordReader->getSections()[0]->getElements()); self::assertInstanceOf(TextRun::class, $phpWordReader->getSections()[0]->getElements()[0]); self::assertEquals($testText, $phpWordReader->getSections()[0]->getElements()[0]->getText()); unlink($file); } } ================================================ FILE: tests/PhpWordTests/WriteReadback/Word2007Test.php ================================================ setDefaultFontName($testDefaultFontName); $writer = new Word2007($phpWordWriter); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'Word2007'); self::assertEquals($testDefaultFontName, $phpWordReader->getDefaultFontName()); unlink($file); } /** * Test default Asian font name. */ public function testDefaultAsianFontName(): void { $phpWordWriter = new PhpWord(); $testDefaultFontName = '標楷體'; $phpWordWriter->setDefaultAsianFontName($testDefaultFontName); $writer = new Word2007($phpWordWriter); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'Word2007'); self::assertEquals($testDefaultFontName, $phpWordReader->getDefaultAsianFontName()); unlink($file); } /** * Test default font size. */ public function testDefaulFontSize(): void { $phpWordWriter = new PhpWord(); $testDefaultFontSize = 144; $phpWordWriter->setDefaultFontSize($testDefaultFontSize); $writer = new Word2007($phpWordWriter); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'Word2007'); self::assertEquals($testDefaultFontSize, $phpWordReader->getDefaultFontSize()); unlink($file); } /** * Test default font color. */ public function testDefaultFontColor(): void { $phpWordWriter = new PhpWord(); $testDefaultFontColor = '00FF00'; $phpWordWriter->setDefaultFontColor($testDefaultFontColor); $writer = new Word2007($phpWordWriter); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'Word2007'); self::assertEquals($testDefaultFontColor, $phpWordReader->getDefaultFontColor()); unlink($file); } /** * Test Zoom. */ public function testZoom(): void { $phpWordWriter = new PhpWord(); $zoomLevel = 75; $phpWordWriter->getSettings()->setZoom($zoomLevel); $writer = new Word2007($phpWordWriter); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'Word2007'); self::assertEquals($zoomLevel, $phpWordReader->getSettings()->getZoom()); unlink($file); } /** * Test a document with one section and text. */ public function testOneSectionWithText(): void { $phpWordWriter = new PhpWord(); $testText = 'Hello World!'; $sectionWriter = $phpWordWriter->addSection(); $sectionWriter->addText($testText); $writer = new Word2007($phpWordWriter); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); $phpWordReader = IOFactory::load($file, 'Word2007'); self::assertCount(1, $phpWordReader->getSections()); self::assertCount(1, $phpWordReader->getSections()[0]->getElements()); self::assertInstanceOf(TextRun::class, $phpWordReader->getSections()[0]->getElements()[0]); self::assertEquals($testText, $phpWordReader->getSections()[0]->getElements()[0]->getText()); unlink($file); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Element/ImageTest.php ================================================ xmlWriter = new XMLWriter(); $style = new ImageStyle(); $style->setWidth(100); $style->setHeight(100); $this->element = new Image('tests/PhpWordTests/_files/images/earth.jpg', $style); $this->writer = new ImageWriter($this->xmlWriter, $this->element); } public function testWrite(): void { $this->writer->write(); $expected = '

    '; self::assertEquals($expected, $this->xmlWriter->getData()); } public function testWriteWithoutP(): void { $style = new ImageStyle(); $style->setWidth(100); $style->setHeight(100); $this->element = new Image('tests/PhpWordTests/_files/images/earth.jpg', $style); $this->writer = new ImageWriter($this->xmlWriter, $this->element, true); $this->writer->write(); $expected = ''; self::assertEquals($expected, $this->xmlWriter->getData()); } public function testWriteWithInvalidElement(): void { $invalidElement = $this->createMock(\PhpOffice\PhpWord\Element\AbstractElement::class); $writer = new ImageWriter($this->xmlWriter, $invalidElement); $writer->write(); self::assertEquals('', $this->xmlWriter->getData()); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Element/TextTest.php ================================================ xmlWriter = new XMLWriter(); $this->element = new Text('Sample Text'); $this->writer = new TextWriter($this->xmlWriter, $this->element); } public function testWrite(): void { $this->writer->write(); $expected = "

    \n Sample Text\n

    \n"; self::assertEquals($expected, $this->xmlWriter->getData()); } public function testWriteWithFontStyle(): void { $this->element->setFontStyle('customStyle'); $this->writer->write(); $expected = "

    \n Sample Text\n

    \n"; self::assertEquals($expected, $this->xmlWriter->getData()); } public function testWriteWithParagraphStyle(): void { $this->element->setParagraphStyle('paragraphStyle'); $this->writer->write(); $expected = "

    \n Sample Text\n

    \n"; self::assertEquals($expected, $this->xmlWriter->getData()); } public function testWriteWithoutP(): void { $text = new Text('Sample Text'); $xmlWriter = new XMLWriter(); $this->writer = new TextWriter($xmlWriter, $text, true); $this->writer->write(); $expected = "Sample Text\n"; self::assertEquals($expected, $xmlWriter->getData()); } public function testWriteWithInvalidElement(): void { $invalidElement = $this->createMock(\PhpOffice\PhpWord\Element\AbstractElement::class); $writer = new TextWriter($this->xmlWriter, $invalidElement); $writer->write(); self::assertEquals('', $this->xmlWriter->getData()); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/ElementTest.php ================================================ expectException(\PhpOffice\PhpWord\Exception\Exception::class); $element = $this->createMock(AbstractElement::class); WriterElement::getElementClass($element); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Part/AbstractPartTest.php ================================================ part = $this->getMockForAbstractClass(AbstractPart::class); } else { $this->part = new class() extends AbstractPart { public function write(): string { return ''; } }; } } public function testParentWriter(): void { $writer = new EPub3(); $this->part->setParentWriter($writer); self::assertInstanceOf(EPub3::class, $this->part->getParentWriter()); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Part/ContentTest.php ================================================ content = new Content($phpWord); $section = $phpWord->addSection(); $section->addText('Test content'); $writer = new EPub3($phpWord); $this->content->setParentWriter($writer); } public function testWrite(): void { $result = $this->content->write(); self::assertIsString($result); self::assertStringContainsString('', $result); self::assertStringContainsString('', $result); self::assertStringContainsString('', $result); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Part/ManifestTest.php ================================================ manifest = new Manifest(); $phpWord = new PhpWord(); $writer = new EPub3($phpWord); $this->manifest->setParentWriter($writer); } public function testWrite(): void { $result = $this->manifest->write(); self::assertStringContainsString('', $result); self::assertIsString($result); self::assertStringContainsString('', $result); self::assertStringContainsString('meta = new Meta(); $phpWord = new PhpWord(); $writer = new EPub3($phpWord); $this->meta->setParentWriter($writer); } public function testWrite(): void { $result = $this->meta->write(); self::assertIsString($result); self::assertStringContainsString('', $result); self::assertStringContainsString('getDocInfo(); $properties->setCreator('PHPWord'); $properties->setTitle('Test Title'); $properties->setKeywords('test, keywords'); $writer = new EPub3($phpWord); $this->meta->setParentWriter($writer); $expected = '\nTest Titleenurn:uuid:12345PHPWord2023-01-01T00:00:00Z'; $result = $this->meta->write(); self::assertStringContainsString('PHPWord', $result); self::assertStringContainsString('Test Title', $result); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Part/MimetypeTest.php ================================================ mimetype = new Mimetype(); $phpWord = new PhpWord(); $writer = new EPub3($phpWord); $this->mimetype->setParentWriter($writer); } public function testWrite(): void { $result = $this->mimetype->write(); self::assertIsString($result); self::assertEquals('application/epub+zip', $result); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Part/NavTest.php ================================================ write(); // Test that valid XML is generated $dom = new DOMDocument(); $dom->loadXML($xml); // Test required XML elements and attributes exist self::assertEquals('html', $dom->documentElement->nodeName); self::assertEquals('http://www.w3.org/1999/xhtml', $dom->documentElement->getAttribute('xmlns')); self::assertEquals('http://www.idpf.org/2007/ops', $dom->documentElement->getAttribute('xmlns:epub')); // Test nav element $navElements = $dom->getElementsByTagName('nav'); self::assertEquals(1, $navElements->length); $navElement = $navElements->item(0); self::assertEquals('toc', $navElement->getAttribute('epub:type')); self::assertEquals('toc', $navElement->getAttribute('id')); // Test title exists $titleElements = $dom->getElementsByTagName('title'); self::assertEquals(1, $titleElements->length); self::assertEquals('Navigation', $titleElements->item(0)->nodeValue); // Test TOC header exists $h1Elements = $dom->getElementsByTagName('h1'); self::assertEquals(1, $h1Elements->length); self::assertEquals('Table of Contents', $h1Elements->item(0)->nodeValue); // Test TOC list structure exists $olElements = $dom->getElementsByTagName('ol'); self::assertEquals(1, $olElements->length); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/PartTest.php ================================================ expectException(\PhpOffice\PhpWord\Exception\Exception::class); Part::getPartClass('InvalidType'); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Style/AbstractStyleTest.php ================================================ getMockForAbstractClass(AbstractStyle::class); } else { /** @var AbstractStyle $style */ $style = new class() extends AbstractStyle { public function write(): string { return ''; } }; } $result = $style->setParentWriter($parentWriter); self::assertSame($style, $result); self::assertSame($parentWriter, $style->getParentWriter()); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Style/FontTest.php ================================================ write(); self::assertStringContainsString('font-family: "Times New Roman", Times, serif;', $content); self::assertStringContainsString('font-size: 12pt;', $content); self::assertStringContainsString('color: #000000;', $content); self::assertStringStartsWith('body {', $content); self::assertStringEndsWith('}', $content); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Style/ParagraphTest.php ================================================ write(); self::assertStringContainsString('margin-top: 0;', $content); self::assertStringContainsString('margin-bottom: 1em;', $content); self::assertStringContainsString('text-align: left;', $content); self::assertStringStartsWith('p {', $content); self::assertStringEndsWith('}', $content); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/Style/TableTest.php ================================================ write(); self::assertStringContainsString('border-collapse: collapse;', $content); self::assertStringContainsString('width: 100%;', $content); self::assertStringContainsString('border: 1px solid black;', $content); self::assertStringContainsString('padding: 8px;', $content); self::assertStringContainsString('text-align: left;', $content); self::assertStringContainsString('table {', $content); self::assertStringContainsString('th, td {', $content); self::assertStringEndsWith('}', $content); } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3/StyleTest.php ================================================ setXmlWriter($xmlWriter); $object->write(); self::assertEquals('', $xmlWriter->getData()); } } } ================================================ FILE: tests/PhpWordTests/Writer/EPub3Test.php ================================================ getPhpWord()); self::assertEquals('./', $object->getDiskCachingDirectory()); foreach (['Content', 'Manifest', 'Mimetype'] as $part) { self::assertInstanceOf( "PhpOffice\\PhpWord\\Writer\\Epub3\\Part\\{$part}", $object->getWriterPart($part) ); self::assertInstanceOf( 'PhpOffice\\PhpWord\\Writer\\Epub3', $object->getWriterPart($part)->getParentWriter() ); } } /** * Test construction with null. */ public function testConstructWithNull(): void { $this->expectException(Exception::class); $this->expectExceptionMessage('No PhpWord assigned.'); $writer = new EPub3(); $writer->getWriterPart('content')->write(); } /** * Test saving document. */ public function testSave(): void { $imageSrc = __DIR__ . '/../_files/images/PhpWord.png'; $file = __DIR__ . '/../_files/temp.epub'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Test 1'); $section->addTextBreak(); $section->addText('Test 2', null, ['alignment' => Jc::CENTER]); $section->addLink('https://github.com/PHPOffice/PHPWord'); $section->addTitle('Test', 1); $section->addPageBreak(); $section->addImage($imageSrc); $writer = new EPub3($phpWord); $writer->save($file); self::assertFileExists($file); unlink($file); } /** * Test PHP output. */ public function testSavePhpOutput(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Test'); $writer = new EPub3($phpWord); ob_start(); $writer->save('php://output'); $contents = ob_get_contents(); self::assertTrue(ob_end_clean()); self::assertNotEmpty($contents); } /** * Test disk caching. */ public function testSetGetUseDiskCaching(): void { $object = new EPub3(); $object->setUseDiskCaching(true, PHPWORD_TESTS_BASE_DIR); self::assertTrue($object->isUseDiskCaching()); self::assertEquals(PHPWORD_TESTS_BASE_DIR, $object->getDiskCachingDirectory()); } /** * Test disk caching exception. */ public function testSetUseDiskCachingException(): void { $this->expectException(Exception::class); $dir = implode(DIRECTORY_SEPARATOR, [PHPWORD_TESTS_BASE_DIR, 'foo']); $object = new EPub3(); $object->setUseDiskCaching(true, $dir); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/DirectionTest.php ================================================ addSection(); $html = '

    الألم الذي ربما تنجم عنه بعض ا.

    '; SharedHtml::addHtml($section, $html, false, false); $english = '

    LTR in RTL document.

    '; SharedHtml::addHtml($section, $english, false, false); SharedHtml::addHtml($section, $english, false, false); SharedHtml::addHtml($section, $html, false, false); SharedHtml::addHtml($section, $html, false, false); $writer = new HTML($doc); $content = $writer->getContent(); self::assertSame(3, substr_count($content, '')); self::assertSame(2, substr_count($content, '')); self::assertSame(3, substr_count($content, '

    ')); self::assertSame(2, substr_count($content, '

    ')); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/Element/PageBreakTest.php ================================================  ' . PHP_EOL, $object->write()); } public function testMPDF(): void { $rendererName = Settings::PDF_RENDERER_MPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/mpdf/mpdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); $writer = new PDF(new PhpWord()); $object = new PageBreak($writer->getRenderer(), new BasePageBreak()); self::assertEquals('', $object->write()); } public function testDOMPDF(): void { $rendererName = Settings::PDF_RENDERER_DOMPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/dompdf/dompdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); $writer = new PDF(new PhpWord()); $object = new PageBreak($writer->getRenderer(), new BasePageBreak()); self::assertEquals('', $object->write()); } public function testTCPDF(): void { $rendererName = Settings::PDF_RENDERER_TCPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/tecnickcom/tcpdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); $writer = new PDF(new PhpWord()); $object = new PageBreak($writer->getRenderer(), new BasePageBreak()); self::assertEquals('
    ', $object->write()); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/Element/RubyTest.php ================================================ addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_CENTER); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(20); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $section->addRuby($baseTextRun, $rubyTextRun, $properties); $dom = Helper::getAsHTML($phpWord, '', '', ['ruby', 'rt', 'rp']); $xpath = new DOMXPath($dom); self::assertEquals(1, $xpath->query('/html/body/div/ruby')->length); // ensure text is right $rubyElement = $dom->getElementsByTagName('ruby')->item(0); $rtElement = $dom->getElementsByTagName('rt')->item(0); self::assertNotNull($rubyElement); self::assertNotNull($rtElement); self::assertEquals($baseTextRun->getText() . ' (' . $rubyTextRun->getText() . ')', $rubyElement->textContent); self::assertEquals($rubyTextRun->getText(), $rtElement->textContent); // check style self::assertEquals('font-size:20pt;ruby-align:center;', $rubyElement->attributes->getNamedItem('style')->textContent); self::assertEquals('font-size:10pt;', $rtElement->attributes->getNamedItem('style')->textContent); } /** * Tests writing ruby HTML. */ public function testWriteRubyHtmlParagraphStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_CENTER); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(20); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(['lineHeight' => '8']); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(['lineHeight' => '4']); $rubyTextRun->addText('わたし'); $section->addRuby($baseTextRun, $rubyTextRun, $properties); $dom = Helper::getAsHTML($phpWord, '', '', ['ruby', 'rt', 'rp']); $xpath = new DOMXPath($dom); self::assertEquals(1, $xpath->query('/html/body/div/ruby')->length); // ensure text is right $rubyElement = $dom->getElementsByTagName('ruby')->item(0); $rtElement = $dom->getElementsByTagName('rt')->item(0); self::assertNotNull($rubyElement); self::assertNotNull($rtElement); self::assertEquals($baseTextRun->getText() . ' (' . $rubyTextRun->getText() . ')', $rubyElement->textContent); self::assertEquals($rubyTextRun->getText(), $rtElement->textContent); // check style self::assertEquals('line-height: 8;font-size:20pt;ruby-align:center;', $rubyElement->attributes->getNamedItem('style')->textContent); self::assertEquals('line-height: 4;font-size:10pt;', $rtElement->attributes->getNamedItem('style')->textContent); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/Element/TableTest.php ================================================ addSection(); $bsnone = ['borderStyle' => 'none']; $table1 = $section->addTable($bsnone); $row1 = $table1->addRow(); $row1->addCell(null, $bsnone)->addText('Row 1 Cell 1'); $row1->addCell(null, $bsnone)->addText('Row 1 Cell 2'); $row2 = $table1->addRow(); $row2->addCell(null, $bsnone)->addText('Row 2 Cell 1'); $row2->addCell(null, $bsnone)->addText('Row 2 Cell 2'); $table1 = $section->addTable(); $row1 = $table1->addRow(); $row1->addCell()->addText('Row 1 Cell 1'); $row1->addCell()->addText('Row 1 Cell 2'); $row2 = $table1->addRow(); $row2->addCell()->addText('Row 2 Cell 1'); $row2->addCell()->addText('Row 2 Cell 2'); $bstyle = ['borderStyle' => 'dashed', 'borderColor' => 'red']; $table1 = $section->addTable($bstyle); $row1 = $table1->addRow(); $row1->addCell(null, $bstyle)->addText('Row 1 Cell 1'); $row1->addCell(null, $bstyle)->addText('Row 1 Cell 2'); $row2 = $table1->addRow(); $row2->addCell(null, $bstyle)->addText('Row 2 Cell 1'); $row2->addCell(null, $bstyle)->addText('Row 2 Cell 2'); $bstyle = [ 'borderTopStyle' => 'dotted', 'borderLeftStyle' => 'dashed', 'borderRightStyle' => 'dashed', 'borderBottomStyle' => 'dotted', 'borderTopColor' => 'blue', 'borderLeftColor' => 'green', 'borderRightColor' => 'green', 'borderBottomColor' => 'blue', ]; $table1 = $section->addTable($bstyle); $row1 = $table1->addRow(); $row1->addCell(null, $bstyle)->addText('Row 1 Cell 1'); $row1->addCell(null, $bstyle)->addText('Row 1 Cell 2'); $row2 = $table1->addRow(); $row2->addCell(null, $bstyle)->addText('Row 2 Cell 1'); $row2->addCell(null, $bstyle)->addText('Row 2 Cell 2'); $bstyle = ['borderStyle' => 'solid', 'borderSize' => 5]; $table1 = $section->addTable($bstyle); $row1 = $table1->addRow(); $row1->addCell(null, $bstyle)->addText('Row 1 Cell 1'); $row1->addCell(null, $bstyle)->addText('Row 1 Cell 2'); $row2 = $table1->addRow(); $row2->addCell(null, $bstyle)->addText('Row 2 Cell 1'); $row2->addCell(null, $bstyle)->addText('Row 2 Cell 2'); $phpWord->addTableStyle('tstyle', ['borderStyle' => 'solid', 'borderSize' => 5]); $table1 = $section->addTable('tstyle'); $row1 = $table1->addRow(); $row1->addCell(null, 'tstyle')->addText('Row 1 Cell 1'); $row1->addCell(null, 'tstyle')->addText('Row 1 Cell 2'); $row2 = $table1->addRow(); $row2->addCell(null, 'tstyle')->addText('Row 2 Cell 1'); $row2->addCell(null, 'tstyle')->addText('Row 2 Cell 2'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $cssnone = 'border-top-style: none;' . ' border-left-style: none;' . ' border-bottom-style: none;' . ' border-right-style: none;'; self::assertEquals("table-layout: auto; $cssnone", Helper::getTextContent($xpath, '/html/body/div/table[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[1]/tr[1]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[1]/tr[1]/td[2]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[1]/tr[2]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[1]/tr[2]/td[2]', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/table[2]', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/table[2]/tr[1]/td[1]', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/table[2]/tr[1]/td[2]', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/table[2]/tr[2]/td[1]', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/table[2]/tr[2]/td[2]', 'style')); $cssnone = 'border-top-style: dashed;' . ' border-top-color: red;' . ' border-left-style: dashed;' . ' border-left-color: red;' . ' border-bottom-style: dashed;' . ' border-bottom-color: red;' . ' border-right-style: dashed;' . ' border-right-color: red;'; self::assertEquals("table-layout: auto; $cssnone", Helper::getTextContent($xpath, '/html/body/div/table[3]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[3]/tr[1]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[3]/tr[1]/td[2]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[3]/tr[2]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[3]/tr[2]/td[2]', 'style')); $cssnone = 'border-top-style: dotted;' . ' border-top-color: blue;' . ' border-left-style: dashed;' . ' border-left-color: green;' . ' border-bottom-style: dotted;' . ' border-bottom-color: blue;' . ' border-right-style: dashed;' . ' border-right-color: green;'; self::assertEquals("table-layout: auto; $cssnone", Helper::getTextContent($xpath, '/html/body/div/table[4]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[4]/tr[1]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[4]/tr[1]/td[2]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[4]/tr[2]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[4]/tr[2]/td[2]', 'style')); $cssnone = 'border-top-style: solid;' . ' border-top-width: 0.25pt;' . ' border-left-style: solid;' . ' border-left-width: 0.25pt;' . ' border-bottom-style: solid;' . ' border-bottom-width: 0.25pt;' . ' border-right-style: solid;' . ' border-right-width: 0.25pt;'; self::assertEquals("table-layout: auto; $cssnone", Helper::getTextContent($xpath, '/html/body/div/table[5]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[5]/tr[1]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[5]/tr[1]/td[2]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[5]/tr[2]/td[1]', 'style')); self::assertEquals($cssnone, Helper::getTextContent($xpath, '/html/body/div/table[5]/tr[2]/td[2]', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/table[6]', 'style')); self::assertEquals('tstyle', Helper::getTextContent($xpath, '/html/body/div/table[6]', 'class')); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(preg_match('/^[.]tstyle[^\\r\\n]*/m', $style, $matches)); self::assertEquals(".tstyle {table-layout: auto; $cssnone}", $matches[0]); } public function testWriteTableCellVAlign(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(); $row = $table->addRow(); $cell = $row->addCell(); $cell->addText('top text'); $cell->getStyle()->setVAlign(VerticalJc::TOP); $cell = $row->addCell(); $cell->addText('bottom text'); $cell->getStyle()->setVAlign(VerticalJc::BOTTOM); $cell = $row->addCell(); $cell->addText('no vAlign'); $cell->getStyle()->setVAlign(VerticalJc::BOTTOM); $cell->getStyle()->setVAlign(); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $cell1Style = Helper::getTextContent($xpath, '//table/tr/td[1]', 'style'); $cell2Style = Helper::getTextContent($xpath, '//table/tr/td[2]', 'style'); self::assertSame('vertical-align: top;', $cell1Style); self::assertSame('vertical-align: bottom;', $cell2Style); $cell3Query = $xpath->query('//table/tr/td[3]'); self::assertNotFalse($cell3Query); self::assertCount(1, $cell3Query); $cell3Style = $cell3Query->item(0)->attributes->getNamedItem('style'); self::assertNull($cell3Style); } public function testWriteTableCellVMerge(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(); $cell = $table->addRow()->addCell(); $cell->addText('text'); $cell->getStyle()->setVMerge(Style\Cell::VMERGE_RESTART); $cell = $table->addRow()->addCell(); $cell->getStyle()->setVMerge(Style\Cell::VMERGE_CONTINUE); $cell = $table->addRow()->addCell(); $cell->addText('no vMerge'); $cell->getStyle()->setVMerge(Style\Cell::VMERGE_CONTINUE); $cell->getStyle()->setVMerge(); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $cell1Style = Helper::getTextContent($xpath, '//table/tr[1]/td[1]', 'rowspan'); self::assertSame('2', $cell1Style); $cell3Query = $xpath->query('//table/tr[3]/td[1]'); self::assertNotFalse($cell3Query); self::assertCount(1, $cell3Query); self::assertNull($cell3Query->item(0)->attributes->getNamedItem('rowspan')); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/Element/TextTest.php ================================================  

    ' . PHP_EOL, $object->write()); } public function testHTMLEmptyString(): void { $writer = new HTML(); $object = new Text($writer, new BaseText('')); self::assertEquals('

     

    ' . PHP_EOL, $object->write()); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/ElementTest.php ================================================ write()); } } /** * Test write element text. */ public function testWriteTextElement(): void { $object = new Text(new HTML(), new TextElement(htmlspecialchars('A', ENT_COMPAT, 'UTF-8'))); $object->setOpeningText(htmlspecialchars('-', ENT_COMPAT, 'UTF-8')); $object->setClosingText(htmlspecialchars('-', ENT_COMPAT, 'UTF-8')); $object->setWithoutP(true); self::assertEquals(htmlspecialchars('-A-', ENT_COMPAT, 'UTF-8'), $object->write()); } /** * Test write TrackChange. */ public function testWriteTrackChanges(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $text = $section->addText('my dummy text'); $text->setChangeInfo(TrackChange::INSERTED, 'author name'); $text2 = $section->addText('my other text'); $text2->setTrackChange(new TrackChange(TrackChange::DELETED, 'another author', new DateTime())); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals(1, $xpath->query('/html/body/div/p[1]/ins')->length); self::assertEquals(1, $xpath->query('/html/body/div/p[2]/del')->length); } /** * Tests writing table with col span. */ public function testWriteColSpan(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(); $row1 = $table->addRow(); $cell11 = $row1->addCell(1000, ['gridSpan' => 2, 'bgColor' => '6086B8']); $cell11->addText('cell spanning 2 bellow'); $row2 = $table->addRow(); $cell21 = $row2->addCell(500, ['bgColor' => 'ffffff']); $cell21->addText('first cell'); $cell22 = $row2->addCell(500); $cell22->addText('second cell'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals(1, $xpath->query('/html/body/div/table/tr[1]/td')->length); self::assertEquals('2', $xpath->query('/html/body/div/table/tr/td[1]')->item(0)->attributes->getNamedItem('colspan')->textContent); self::assertEquals(2, $xpath->query('/html/body/div/table/tr[2]/td')->length); self::assertEquals('#6086B8', $xpath->query('/html/body/div/table/tr[1]/td')->item(0)->attributes->getNamedItem('bgcolor')->textContent); self::assertEquals('#ffffff', $xpath->query('/html/body/div/table/tr[1]/td')->item(0)->attributes->getNamedItem('color')->textContent); self::assertEquals('#ffffff', $xpath->query('/html/body/div/table/tr[2]/td')->item(0)->attributes->getNamedItem('bgcolor')->textContent); self::assertNull($xpath->query('/html/body/div/table/tr[2]/td')->item(0)->attributes->getNamedItem('color')); } /** * Tests writing table with row span. */ public function testWriteRowSpan(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(); $row1 = $table->addRow(); $row1->addCell(1000, ['vMerge' => 'restart'])->addText('row spanning 3 bellow'); $row1->addCell(500)->addText('first cell being spanned'); $row2 = $table->addRow(); $row2->addCell(null, ['vMerge' => 'continue']); $row2->addCell(500)->addText('second cell being spanned'); $row3 = $table->addRow(); $row3->addCell(null, ['vMerge' => 'continue']); $row3->addCell(500)->addText('third cell being spanned'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals(2, $xpath->query('/html/body/div/table/tr[1]/td')->length); self::assertEquals('3', $xpath->query('/html/body/div/table/tr[1]/td[1]')->item(0)->attributes->getNamedItem('rowspan')->textContent); self::assertEquals(1, $xpath->query('/html/body/div/table/tr[2]/td')->length); } /** * Tests writing table with rowspan and colspan. */ public function testWriteRowSpanAndColSpan(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(); $row1 = $table->addRow(); $row1->addCell(500)->addText('A'); $row1->addCell(1000, ['gridSpan' => 2])->addText('B'); $row1->addCell(500, ['vMerge' => 'restart'])->addText('C'); $row2 = $table->addRow(); $row2->addCell(1500, ['gridSpan' => 3])->addText('D'); $row2->addCell(null, ['vMerge' => 'continue']); $row3 = $table->addRow(); $row3->addCell(500)->addText('E'); $row3->addCell(500)->addText('F'); $row3->addCell(500)->addText('G'); $row3->addCell(null, ['vMerge' => 'continue']); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals(3, $xpath->query('/html/body/div/table/tr[1]/td')->length); self::assertEquals('2', $xpath->query('/html/body/div/table/tr[1]/td[2]')->item(0)->attributes->getNamedItem('colspan')->textContent); self::assertEquals('3', $xpath->query('/html/body/div/table/tr[1]/td[3]')->item(0)->attributes->getNamedItem('rowspan')->textContent); self::assertEquals(1, $xpath->query('/html/body/div/table/tr[2]/td')->length); self::assertEquals('3', $xpath->query('/html/body/div/table/tr[2]/td[1]')->item(0)->attributes->getNamedItem('colspan')->textContent); self::assertEquals(3, $xpath->query('/html/body/div/table/tr[3]/td')->length); } public function testWriteTitleTextRun(): void { $expected = 'Title with TextRun'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $textRun = new TextRun(); $textRun->addText($expected); $section->addTitle($textRun); $htmlWriter = new HTML($phpWord); $content = $htmlWriter->getContent(); self::assertStringContainsString($expected, $content); } /** * Test write element ListItemRun. */ public function testListItemRun(): void { $expected1 = 'List item run 1'; $expected2 = 'List item run 1 in bold'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $listItemRun = $section->addListItemRun(0, null, 'MyParagraphStyle'); $listItemRun->addText($expected1); $listItemRun->addText($expected2, ['bold' => true]); $htmlWriter = new HTML($phpWord); $content = $htmlWriter->getContent(); $dom = new DOMDocument(); $dom->loadHTML($content); self::assertEquals($expected1, $dom->getElementsByTagName('p')->item(0)->textContent); self::assertEquals($expected2, $dom->getElementsByTagName('p')->item(1)->textContent); } /** * Tests writing table with layout. */ public function testWriteTableLayout(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addTable(); $table1 = $section->addTable(['layout' => \PhpOffice\PhpWord\Style\Table::LAYOUT_FIXED]); $row1 = $table1->addRow(); $row1->addCell()->addText('fixed layout table'); $table2 = $section->addTable(['layout' => \PhpOffice\PhpWord\Style\Table::LAYOUT_AUTO]); $row2 = $table2->addRow(); $row2->addCell()->addText('auto layout table'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('table-layout: fixed;', $xpath->query('/html/body/div/table[1]')->item(0)->attributes->getNamedItem('style')->textContent); self::assertEquals('table-layout: auto;', $xpath->query('/html/body/div/table[2]')->item(0)->attributes->getNamedItem('style')->textContent); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/FontTest.php ================================================ defaultFontName = Settings::getDefaultFontName(); $this->defaultFontSize = Settings::getDefaultFontSize(); $this->defaultFontColor = Settings::getDefaultFontColor(); } /** * Executed after each method of the class. */ protected function tearDown(): void { Settings::setDefaultFontName($this->defaultFontName); Settings::setDefaultFontSize($this->defaultFontSize); Settings::setDefaultFontColor($this->defaultFontColor); } public function testDefaultDefaults(): void { $phpWord = new PhpWord(); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $style = Helper::getTextContent($xpath, '/html/head/style[1]'); $prg = preg_match('/body {(.*?)}/', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('body {font-family: \'Arial\'; font-size: 12pt; color: #000000;}', $matches[0]); } public function testSettingDefaultFontColor(): void { $phpWord = new PhpWord(); $defaultFontColor = '00FF00'; $phpWord->setDefaultFontColor($defaultFontColor); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $style = Helper::getTextContent($xpath, '/html/head/style[1]'); $prg = preg_match('/body {(.*?)}/', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('body {font-family: \'Arial\'; font-size: 12pt; color: #00FF00;}', $matches[0]); } /** * Tests font names - without generics. */ public function testFontNames1(): void { $phpWord = new PhpWord(); $phpWord->setDefaultFontName('Courier New'); $phpWord->setDefaultFontSize(12); $phpWord->addFontStyle('style1', ['name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true]); $phpWord->addFontStyle('style2', ['name' => 'Arial', 'size' => 10]); $phpWord->addFontStyle('style3', ['name' => 'hack attempt\'}; display:none', 'size' => 10]); $phpWord->addFontStyle('style4', ['name' => 'padmaa 1.1', 'size' => 10, 'bold' => true]); $phpWord->addFontStyle('style5', ['name' => 'MingLiU-ExtB', 'size' => 10, 'bold' => true]); $section1 = $phpWord->addSection(); $section1->addText('Default font'); $section1->addText('Tahoma', 'style1'); $section1->addText('Arial', 'style2'); $section1->addText('hack attempt', 'style3'); $section1->addText('padmaa 1.1 bold', 'style4'); $section1->addText('MingLiu-ExtB bold', 'style5'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[1]', 'class')); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[1]/span')); self::assertEquals('style1', Helper::getTextContent($xpath, '/html/body/div/p[2]/span', 'class')); self::assertEquals('style2', Helper::getTextContent($xpath, '/html/body/div/p[3]/span', 'class')); self::assertEquals('style3', Helper::getTextContent($xpath, '/html/body/div/p[4]/span', 'class')); self::assertEquals('style4', Helper::getTextContent($xpath, '/html/body/div/p[5]/span', 'class')); self::assertEquals('style5', Helper::getTextContent($xpath, '/html/body/div/p[6]/span', 'class')); $style = Helper::getTextContent($xpath, '/html/head/style'); $prg = preg_match('/^[*][^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('* {font-family: \'Courier New\'; font-size: 12pt; color: #000000;}', $matches[0]); $prg = preg_match('/^[.]style1[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style1 {font-family: \'Tahoma\'; font-size: 10pt; color: #1B2232; font-weight: bold;}', $matches[0]); $prg = preg_match('/^[.]style2[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style2 {font-family: \'Arial\'; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style3[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style3 {font-family: \'hack attempt'}; display:none\'; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style4[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style4 {font-family: \'padmaa 1.1\'; font-size: 10pt; font-weight: bold;}', $matches[0]); $prg = preg_match('/^[.]style5[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style5 {font-family: \'MingLiU-ExtB\'; font-size: 10pt; font-weight: bold;}', $matches[0]); } /** * Tests font names - with generics. */ public function testFontNames2(): void { $phpWord = new PhpWord(); $phpWord->setDefaultFontName('Courier New'); $phpWord->setDefaultFontSize(12); $phpWord->addFontStyle('style1', ['name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true]); $phpWord->addFontStyle('style2', ['name' => 'Arial', 'size' => 10, 'fallbackFont' => 'sans-serif']); $phpWord->addFontStyle('style3', ['name' => 'DejaVu Sans Monospace', 'size' => 10, 'fallbackFont' => 'monospace']); $phpWord->addFontStyle('style4', ['name' => 'Arial', 'size' => 10, 'fallbackFont' => 'invalid']); $section1 = $phpWord->addSection(); $section1->addText('Default font'); $section1->addText('Tahoma', 'style1'); $section1->addText('Arial', 'style2'); $section1->addText('DejaVu Sans Monospace', 'style3'); $section1->addText('Arial with invalid fallback', 'style4'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[1]', 'class')); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[1]/span')); self::assertEquals('style1', Helper::getTextContent($xpath, '/html/body/div/p[2]/span', 'class')); self::assertEquals('style2', Helper::getTextContent($xpath, '/html/body/div/p[3]/span', 'class')); self::assertEquals('style3', Helper::getTextContent($xpath, '/html/body/div/p[4]/span', 'class')); self::assertEquals('style4', Helper::getTextContent($xpath, '/html/body/div/p[5]/span', 'class')); $style = Helper::getTextContent($xpath, '/html/head/style'); $prg = preg_match('/^[*][^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('* {font-family: \'Courier New\'; font-size: 12pt; color: #000000;}', $matches[0]); $prg = preg_match('/^[.]style1[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style1 {font-family: \'Tahoma\'; font-size: 10pt; color: #1B2232; font-weight: bold;}', $matches[0]); $prg = preg_match('/^[.]style2[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style2 {font-family: \'Arial\', sans-serif; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style3[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style3 {font-family: \'DejaVu Sans Monospace\', monospace; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style4[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style4 {font-family: \'Arial\'; font-size: 10pt;}', $matches[0]); } /** * Tests font names - with generics including for default font. */ public function testFontNames3(): void { $phpWord = new PhpWord(); $phpWord->setDefaultFontName('Courier New'); $phpWord->setDefaultFontSize(12); $phpWord->addFontStyle('style1', ['name' => 'Tahoma', 'size' => 10, 'color' => '1B2232', 'bold' => true]); $phpWord->addFontStyle('style2', ['name' => 'Arial', 'size' => 10, 'fallbackFont' => 'sans-serif']); $phpWord->addFontStyle('style3', ['name' => 'DejaVu Sans Monospace', 'size' => 10, 'fallbackFont' => 'monospace']); $phpWord->addFontStyle('style4', ['name' => 'Arial', 'size' => 10, 'fallbackFont' => 'invalid']); $section1 = $phpWord->addSection(); $section1->addText('Default font'); $section1->addText('Tahoma', 'style1'); $section1->addText('Arial', 'style2'); $section1->addText('DejaVu Sans Monospace', 'style3'); $section1->addText('Arial with invalid fallback', 'style4'); $dom = Helper::getAsHTML($phpWord, '', 'monospace'); $xpath = new DOMXPath($dom); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[1]', 'class')); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[1]/span')); self::assertEquals('style1', Helper::getTextContent($xpath, '/html/body/div/p[2]/span', 'class')); self::assertEquals('style2', Helper::getTextContent($xpath, '/html/body/div/p[3]/span', 'class')); self::assertEquals('style3', Helper::getTextContent($xpath, '/html/body/div/p[4]/span', 'class')); self::assertEquals('style4', Helper::getTextContent($xpath, '/html/body/div/p[5]/span', 'class')); $style = Helper::getTextContent($xpath, '/html/head/style'); $prg = preg_match('/^[*][^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('* {font-family: \'Courier New\', monospace; font-size: 12pt; color: #000000;}', $matches[0]); $prg = preg_match('/^[.]style1[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style1 {font-family: \'Tahoma\'; font-size: 10pt; color: #1B2232; font-weight: bold;}', $matches[0]); $prg = preg_match('/^[.]style2[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style2 {font-family: \'Arial\', sans-serif; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style3[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style3 {font-family: \'DejaVu Sans Monospace\', monospace; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style4[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style4 {font-family: \'Arial\'; font-size: 10pt;}', $matches[0]); } /** * Tests white space. */ public function testWhiteSpace(): void { $phpWord = new PhpWord(); $phpWord->setDefaultFontSize(12); $phpWord->addFontStyle('style1', ['name' => 'Courier New', 'size' => 10, 'whiteSpace' => 'pre-wrap']); $phpWord->addFontStyle('style2', ['name' => 'Courier New', 'size' => 10, 'whiteSpace' => 'invalid']); $phpWord->addFontStyle('style3', ['name' => 'Courier New', 'size' => 10, 'whiteSpace' => 'normal']); $phpWord->addFontStyle('style4', ['name' => 'Courier New', 'size' => 10, 'whiteSpace' => 'invalid']); $text = 'This is a long line which will be split over 2 lines with pre-wrap'; $section1 = $phpWord->addSection(); $section1->addText($text); $section1->addText($text, 'style1'); $section1->addText($text, 'style2'); $section1->addText($text, 'style3'); $section1->addText($text, 'style4'); $dom = Helper::getAsHTML($phpWord, 'pre-wrap'); $xpath = new DOMXPath($dom); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(preg_match('/^[*][^\\r\\n]*/m', $style, $matches)); self::assertEquals('* {font-family: \'Arial\'; font-size: 12pt; color: #000000; white-space: pre-wrap;}', $matches[0]); $prg = preg_match('/^[.]style1[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style1 {font-family: \'Courier New\'; font-size: 10pt; white-space: pre-wrap;}', $matches[0]); $prg = preg_match('/^[.]style2[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style2 {font-family: \'Courier New\'; font-size: 10pt;}', $matches[0]); $prg = preg_match('/^[.]style3[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style3 {font-family: \'Courier New\'; font-size: 10pt; white-space: normal;}', $matches[0]); $prg = preg_match('/^[.]style4[^\\r\\n]*/m', $style, $matches); self::assertNotEmpty($matches); self::assertNotFalse($prg); self::assertEquals('.style4 {font-family: \'Courier New\'; font-size: 10pt;}', $matches[0]); } /** * Tests inline font style. */ public function testInline(): void { $phpWord = new PhpWord(); $style1 = ['name' => 'Courier New', 'size' => 10, 'whiteSpace' => 'pre-wrap']; $style2 = ['name' => 'Verdana', 'size' => 8.5]; $text = 'This is a paragraph.'; $section1 = $phpWord->addSection(); $section1->addText($text, $style1); $section1->addText($text, $style2); $section1->addText($text); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('font-family: \'Courier New\'; font-size: 10pt; white-space: pre-wrap;', Helper::getTextContent($xpath, '/html/body/div/p[1]/span', 'style')); self::assertEquals('font-family: \'Verdana\'; font-size: 8.5pt;', Helper::getTextContent($xpath, '/html/body/div/p[2]/span', 'style')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[3]', 'class')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[3]', 'style')); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[3]/span')); } /** * Tests languages. */ public function testLanguages(): void { $phpWord = new PhpWord(); $langarabic = new Language('', '', 'ar-DZ'); $phpWord->addFontStyle('arabic', ['lang' => $langarabic]); $langhindi = new Language('', 'hi-IN'); $phpWord->addFontStyle('hindi', ['lang' => $langhindi, 'name' => 'Arial']); $phpWord->addFontStyle('nolang', ['name' => 'Verdana', 'size' => '10']); $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText('سلام این یک پاراگراف راست به چپ است', ['rtl' => true, 'lang' => $langarabic]); $section->addText('Ce texte-ci est en français.', ['lang' => 'fr-BE']); $section->addText('Ce texte-ci aussi.', ['lang' => 'fr-BE', 'name' => 'Verdana']); $section->addText('Text with no language'); $section->addText('पाठ हिंदी में', 'hindi'); $section->addText('Non-existent style', 'nonexistent'); $section->addText('Style without language', 'nolang'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('ar-DZ', Helper::getTextContent($xpath, '/html/body/div/p[1]/span', 'lang')); self::assertEquals('fr-BE', Helper::getTextContent($xpath, '/html/body/div/p[2]/span', 'lang')); self::assertEquals('fr-BE', Helper::getTextContent($xpath, '/html/body/div/p[3]/span', 'lang')); self::assertEquals('font-family: \'Verdana\';', Helper::getTextContent($xpath, '/html/body/div/p[3]/span', 'style')); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[4]/span')); self::assertEquals('hi-IN', Helper::getTextContent($xpath, '/html/body/div/p[5]/span', 'lang')); self::assertEquals('hindi', Helper::getTextContent($xpath, '/html/body/div/p[5]/span', 'class')); self::assertEquals('nonexistent', Helper::getTextContent($xpath, '/html/body/div/p[6]/span', 'class')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[6]/span', 'lang')); self::assertEquals('nolang', Helper::getTextContent($xpath, '/html/body/div/p[7]/span', 'class')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[7]/span', 'lang')); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/Helper.php ================================================ query($query); if ($item === false) { self::fail('Unexpected false return from xpath query'); } else { $item2 = $item->item($itemNumber); if ($item2 === null) { self::fail('Unexpected null return requesting item'); } elseif ($namedItem !== '') { $item3 = $item2->attributes->getNamedItem($namedItem); if ($item3 === null) { self::fail('Unexpected null return requesting namedItem'); } else { $returnVal = $item3->textContent; } } else { $returnVal = $item2->textContent; } } return $returnVal; } /** @return mixed */ public static function getNamedItem(DOMXPath $xpath, string $query, string $namedItem, int $itemNumber = 0) { $returnVal = ''; $item = $xpath->query($query); if ($item === false) { self::fail('Unexpected false return from xpath query'); } else { $item2 = $item->item($itemNumber); if ($item2 === null) { self::fail('Unexpected null return requesting item'); } else { $returnValue = $item2->attributes->getNamedItem($namedItem); } } return $returnVal; } public static function getLength(DOMXPath $xpath, string $query): int { $returnVal = 0; $item = $xpath->query($query); if ($item === false) { self::fail('Unexpected false return from xpath query'); } else { $returnVal = $item->length; } return $returnVal; } public static function getAsHTML(PhpWord $phpWord, string $defaultWhiteSpace = '', string $defaultGenericFont = '', array $validTags = []): DOMDocument { $htmlWriter = new HTML($phpWord); $htmlWriter->setDefaultWhiteSpace($defaultWhiteSpace); $htmlWriter->setDefaultGenericFont($defaultGenericFont); $dom = new DOMDocument(); // DOMDocument does not always accept HTML5 tags like // So, we can manually filter out those errors for testing purposes ONLY. $original = libxml_use_internal_errors(true); $dom->loadHTML($htmlWriter->getContent()); $errors = libxml_get_errors(); $errorsToReport = []; foreach ($errors as $error) { /** @var LibXMLError $error */ if ($error->code === 801) { $didFindValidTag = false; foreach ($validTags as $tag) { if (trim($error->message) === ('Tag ' . $tag . ' invalid')) { $didFindValidTag = true; break; } } if (!$didFindValidTag) { $errorsToReport[] = $error; } } else { $errorsToReport[] = $error; } } libxml_clear_errors(); libxml_use_internal_errors($original); if (count($errorsToReport) > 0) { throw new Exception('Errors when loading DOMDocument: ' . print_r($errors, true)); } return $dom; } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/ParagraphTest.php ================================================ 0, 'spaceAfter' => 0, 'lineHeight' => 1.08]; $phpWord->addParagraphStyle('indented', [ 'indentation' => ['left' => 0.50 * Converter::INCH_TO_TWIP, 'right' => 0.60 * Converter::INCH_TO_TWIP], ]); $text = 'This is a paragraph. It should be long enough to show the effects of indentation on both the right and left sides.'; $section1 = $phpWord->addSection(); $section1->addText($text, null, $pstyle1); $section1->addText($text, null, 'indented'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[1]/span')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[1]', 'class')); self::assertEquals('margin-top: 0pt; margin-bottom: 0pt; line-height: 1.08;', Helper::getTextContent($xpath, '/html/body/div/p[1]', 'style')); self::assertEquals(0, Helper::getLength($xpath, '/html/body/div/p[2]/span')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[2]', 'style')); self::assertEquals('indented', Helper::getTextContent($xpath, '/html/body/div/p[2]', 'class')); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(preg_match('/^[.]indented[^\\r\\n]*/m', $style, $matches)); self::assertEquals('.indented {margin-left: 0.5in; margin-right: 0.6in;}', $matches[0]); } /** * Tests paragraph and font styles specified togeter, both inline and named. */ public function testParagraphAndFontStyles(): void { $phpWord = new PhpWord(); $pstyle1 = ['spaceBefore' => 0, 'spaceAfter' => 0, 'lineHeight' => 1.08]; $phpWord->addParagraphStyle('indented', [ 'indentation' => ['left' => 0.50 * Converter::INCH_TO_TWIP, 'right' => 0.60 * Converter::INCH_TO_TWIP], ]); $phpWord->addFontStyle('style1', ['name' => 'Courier New', 'size' => 10, 'whiteSpace' => 'pre-wrap', 'fallbackFont' => 'monospace']); $text = 'This is a paragraph. It should be long enough to show the effects of indentation on both the right and left sides.'; $section1 = $phpWord->addSection(); $section1->addText($text, 'style1', $pstyle1); $section1->addText($text, ['name' => 'Verdana', 'size' => '12'], 'indented'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals(1, Helper::getLength($xpath, '/html/body/div/p[1]/span')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[1]', 'class')); self::assertEquals('margin-top: 0pt; margin-bottom: 0pt; line-height: 1.08;', Helper::getTextContent($xpath, '/html/body/div/p[1]', 'style')); self::assertEquals('style1', Helper::getTextContent($xpath, '/html/body/div/p[1]/span', 'class')); self::assertEquals(1, Helper::getLength($xpath, '/html/body/div/p[2]/span')); self::assertEmpty(Helper::getNamedItem($xpath, '/html/body/div/p[2]', 'style')); self::assertEquals('indented', Helper::getTextContent($xpath, '/html/body/div/p[2]', 'class')); self::assertEquals('font-family: \'Verdana\'; font-size: 12pt;', Helper::getTextContent($xpath, '/html/body/div/p[2]/span', 'style')); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(preg_match('/^[.]indented[^\\r\\n]*/m', $style, $matches)); self::assertEquals('.indented {margin-left: 0.5in; margin-right: 0.6in;}', $matches[0]); self::assertNotFalse(preg_match('/^[.]style1[^\\r\\n]*/m', $style, $matches)); self::assertEquals('.style1 {font-family: \'Courier New\', monospace; font-size: 10pt; white-space: pre-wrap;}', $matches[0]); } /** * Tests page break before. */ public function testPageBreakBefore(): void { $phpWord = new PhpWord(); $pstyle1 = ['lineHeight' => 1.08]; $pstyle2 = ['lineHeight' => 1.08, 'pageBreakBefore' => true]; $section1 = $phpWord->addSection(); $section1->addText('1st paragraph 1st page', null, $pstyle1); $section1->addText('2nd paragraph 1st page', null, $pstyle1); $section1->addText('1st paragraph 2nd page', null, $pstyle2); $section1->addText('2nd paragraph 2nd page', null, $pstyle1); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('line-height: 1.08;', Helper::getTextContent($xpath, '/html/body/div/p[1]', 'style')); self::assertEquals('line-height: 1.08;', Helper::getTextContent($xpath, '/html/body/div/p[2]', 'style')); self::assertEquals('line-height: 1.08; page-break-before: always;', Helper::getTextContent($xpath, '/html/body/div/p[3]', 'style')); self::assertEquals('line-height: 1.08;', Helper::getTextContent($xpath, '/html/body/div/p[4]', 'style')); } /** * Tests blank paragraph. */ public function testBlankParagraph(): void { $phpWord = new PhpWord(); $section1 = $phpWord->addSection(); $section1->addText('Text before blank text'); $section1->addText(''); $section1->addText('Text after blank text'); $htmlWriter = new HTML($phpWord); $body = $htmlWriter->getWriterPart('Body')->write(); $bodylines = explode(PHP_EOL, $body); self::assertEquals('

    Text before blank text

    ', $bodylines[2]); self::assertEquals('

     

    ', $bodylines[3]); self::assertEquals('

    Text after blank text

    ', $bodylines[4]); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/PartTest.php ================================================ expectException(\PhpOffice\PhpWord\Exception\Exception::class); $object = new Body(); $object->getParentWriter(); } /** * Tests writing multiple sections. */ public function testWriteSections(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setThemeFontLang(new \PhpOffice\PhpWord\Style\Language('en-US')); $section1 = $phpWord->addSection(); $mtop = 0.5 * Converter::INCH_TO_TWIP; $mbot = 0.5 * Converter::INCH_TO_TWIP; $mrig = 0.75 * Converter::INCH_TO_TWIP; $mlef = 0.75 * Converter::INCH_TO_TWIP; $section1 ->getStyle() ->setPaperSize('Letter') ->setMarginTop($mtop) ->setMarginBottom($mbot) ->setMarginLeft($mlef) ->setMarginRight($mrig); $section1->getStyle()->setPortrait(); $section1->addText('In theory, this will be printed portrait on letter paper'); $section2 = $phpWord->addSection(); $mtop = 0.6 * Converter::INCH_TO_TWIP; $mbot = 0.6 * Converter::INCH_TO_TWIP; $mrig = 0.65 * Converter::INCH_TO_TWIP; $mlef = 0.65 * Converter::INCH_TO_TWIP; $section2 ->getStyle() ->setPaperSize('A4') ->setMarginTop($mtop) ->setMarginBottom($mbot) ->setMarginLeft($mlef) ->setMarginRight($mrig); $section2->getStyle()->setLandscape(); $section2->addText('In theory, this will be printed landscape on A4 paper'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('en-US', Helper::getTextContent($xpath, '/html', 'lang')); self::assertEquals(2, Helper::getLength($xpath, '/html/body/div')); self::assertEquals('page: page1', Helper::getTextContent($xpath, '/html/body/div[1]', 'style')); self::assertEquals('page: page2', Helper::getTextContent($xpath, '/html/body/div[2]', 'style')); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(strpos($style, 'body > div + div {page-break-before: always;}')); self::assertNotFalse(strpos($style, 'div > *:first-child {page-break-before: auto;}')); self::assertNotFalse(strpos($style, '@page page1 {size: Letter portrait; margin-right: 0.75in; margin-left: 0.75in; margin-top: 0.5in; margin-bottom: 0.5in; }')); self::assertNotFalse(strpos($style, '@page page2 {size: A4 landscape; margin-right: 0.65in; margin-left: 0.65in; margin-top: 0.6in; margin-bottom: 0.6in; }')); } /** * Tests theme font East Asian. */ public function testThemeFontEastAsian(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setThemeFontLang(new \PhpOffice\PhpWord\Style\Language('', 'hi-IN')); $section1 = $phpWord->addSection(); $section1->addText('??? ????? ???'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('hi-IN', Helper::getTextContent($xpath, '/html', 'lang')); } /** * Tests theme font bidirectional. */ public function testThemeBidirecional(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setThemeFontLang(new \PhpOffice\PhpWord\Style\Language('', '', 'he-IL')); $section1 = $phpWord->addSection(); $section1->addText('????'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEquals('he-IL', Helper::getTextContent($xpath, '/html', 'lang')); } /** * Tests writing when default paragraph style is specified. */ public function testDefaultParagraphStyle(): void { $phpWord = new PhpWord(); $nospacebeforeafter = ['spaceBefore' => 0, 'spaceAfter' => 0]; $phpWord->setDefaultParagraphStyle($nospacebeforeafter); $section1 = $phpWord->addSection(); $section1->addText('First paragraph with no space before or after'); $section1->addText('Second paragraph with no space before or after'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); self::assertEmpty(Helper::getNamedItem($xpath, '/html', 'lang')); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(strpos($style, 'p, .Normal {margin-top: 0pt; margin-bottom: 0pt;}')); } /** * Tests writing when default paragraph style is omitted. */ public function testNoDefaultParagraphStyle(): void { $phpWord = new PhpWord(); $section1 = $phpWord->addSection(); $section1->addText('First paragraph with no space before or after'); $section1->addText('Second paragraph with no space before or after'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertFalse(strpos($style, 'Normal')); } /** * Tests title styles. */ public function testTitleStyles(): void { $phpWord = new PhpWord(); $phpWord->setDefaultParagraphStyle(['spaceBefore' => 0, 'spaceAfter' => 0]); $phpWord->addTitleStyle(1, ['bold' => true, 'name' => 'Calibri'], ['spaceBefore' => 10, 'spaceAfter' => 10]); $phpWord->addTitleStyle(2, ['italic' => true, 'name' => 'Times New Roman'], ['spaceBefore' => 5, 'spaceAfter' => 5]); $section1 = $phpWord->addSection(); $section1->addTitle('Header 1 #1', 1); $section1->addTitle('Header 2 #1', 2); $section1->addText('Paragraph under header 2 #1'); $section1->addTitle('Header 2 #2', 2); $section1->addText('Paragraph under header 2 #2'); $dom = Helper::getAsHTML($phpWord); $xpath = new DOMXPath($dom); $style = Helper::getTextContent($xpath, '/html/head/style'); self::assertNotFalse(strpos($style, 'h1 {font-family: \'Calibri\'; font-weight: bold;}')); self::assertNotFalse(strpos($style, 'h1 {margin-top: 0.5pt; margin-bottom: 0.5pt;}')); self::assertNotFalse(strpos($style, 'h2 {font-family: \'Times New Roman\'; font-style: italic;}')); self::assertNotFalse(strpos($style, 'h2 {margin-top: 0.25pt; margin-bottom: 0.25pt;}')); self::assertEquals(1, Helper::getLength($xpath, '/html/body/div/h1')); self::assertEquals(2, Helper::getLength($xpath, '/html/body/div/h2')); } } ================================================ FILE: tests/PhpWordTests/Writer/HTML/StyleTest.php ================================================ write()); } } } ================================================ FILE: tests/PhpWordTests/Writer/HTMLTest.php ================================================ getPhpWord()); } /** * Construct with null. */ public function testConstructWithNull(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('No PhpWord assigned.'); $object = new HTML(); $object->getPhpWord(); } public function testEditCallback(): void { $object = new HTML(new PhpWord()); self::assertNull($object->getEditCallback()); $object->setEditCallback(function (string $html): string { return $html; }); self::assertIsCallable($object->getEditCallback()); $object->setEditCallback(null); self::assertNull($object->getEditCallback()); } public function testDefaultGenericFont(): void { $object = new HTML(new PhpWord()); self::assertEquals('', $object->getDefaultGenericFont()); $object->setDefaultGenericFont('test'); self::assertEquals('', $object->getDefaultGenericFont()); $object->setDefaultGenericFont('cursive'); self::assertEquals('cursive', $object->getDefaultGenericFont()); } public function testDefaultWhiteSpace(): void { $object = new HTML(new PhpWord()); self::assertEquals('', $object->getDefaultWhiteSpace()); $object->setDefaultWhiteSpace('test'); self::assertEquals('', $object->getDefaultWhiteSpace()); $object->setDefaultWhiteSpace('pre-line'); self::assertEquals('pre-line', $object->getDefaultWhiteSpace()); } /** * Save. */ public function testSave(): void { $localImage = __DIR__ . '/../_files/images/PhpWord.png'; $archiveImage = 'zip://' . __DIR__ . '/../_files/documents/reader.docx#word/media/image1.jpeg'; $gdImage = self::getRemoteGifImageUrl(); $objectSrc = __DIR__ . '/../_files/documents/sheet.xls'; $file = __DIR__ . '/../_files/temp.html'; $phpWord = new PhpWord(); $docProps = $phpWord->getDocInfo(); $docProps->setTitle(htmlspecialchars('HTML Test', ENT_COMPAT, 'UTF-8')); $phpWord->addTitleStyle(1, ['bold' => true]); $phpWord->addFontStyle( 'Font', ['name' => 'Verdana', 'size' => 11, 'color' => 'FF0000', 'fgColor' => 'FF0000'] ); $phpWord->addParagraphStyle('Paragraph', ['alignment' => Jc::CENTER, 'spaceAfter' => 20, 'spaceBefore' => 20]); $section = $phpWord->addSection(); $section->addBookmark('top'); $section->addText(htmlspecialchars('Test 1', ENT_COMPAT, 'UTF-8'), 'Font', 'Paragraph'); $section->addTextBreak(); $section->addText( htmlspecialchars('Test 2', ENT_COMPAT, 'UTF-8'), ['name' => 'Tahoma', 'bold' => true, 'italic' => true, 'subscript' => true] ); $section->addLink('https://github.com/PHPOffice/PHPWord'); $section->addTitle(htmlspecialchars('Test', ENT_COMPAT, 'UTF-8'), 1); $section->addPageBreak(); $section->addListItem(htmlspecialchars('Test', ENT_COMPAT, 'UTF-8')); $section->addImage($localImage); $section->addImage($archiveImage); $section->addImage($gdImage); $section->addObject($objectSrc); $section->addFootnote(); $section->addEndnote(); $section = $phpWord->addSection(); $textrun = $section->addTextRun(['alignment' => Jc::CENTER]); $textrun->addText(htmlspecialchars('Test 3', ENT_COMPAT, 'UTF-8')); $textrun->addTextBreak(); $textrun = $section->addTextRun(['alignment' => Jc::START]); $textrun->addText(htmlspecialchars('Text left aligned', ENT_COMPAT, 'UTF-8')); $textrun = $section->addTextRun(['alignment' => Jc::BOTH]); $textrun->addText(htmlspecialchars('Text justified', ENT_COMPAT, 'UTF-8')); $textrun = $section->addTextRun(['alignment' => Jc::END]); $textrun->addText(htmlspecialchars('Text right aligned', ENT_COMPAT, 'UTF-8')); $textrun = $section->addTextRun('Paragraph'); $textrun->addLink('https://github.com/PHPOffice/PHPWord'); $textrun->addImage($localImage); $textrun->addFootnote()->addText(htmlspecialchars('Footnote', ENT_COMPAT, 'UTF-8')); $textrun->addEndnote()->addText(htmlspecialchars('Endnote', ENT_COMPAT, 'UTF-8')); $section = $phpWord->addSection(); $table = $section->addTable(); $cell = $table->addRow()->addCell(); $cell->addText( htmlspecialchars('Test 1', ENT_COMPAT, 'UTF-8'), ['superscript' => true, 'underline' => 'dash', 'strikethrough' => true] ); $cell->addTextRun(); $cell->addLink('https://github.com/PHPOffice/PHPWord'); $cell->addTextBreak(); $cell->addListItem(htmlspecialchars('Test', ENT_COMPAT, 'UTF-8')); $cell->addImage($localImage); $cell->addObject($objectSrc); $cell->addFootnote(); $cell->addEndnote(); $cell = $table->addRow()->addCell(); $section->addLink('top', 'back to top', null, null, true); $writer = new HTML($phpWord); $writer->save($file); self::assertFileExists($file); unlink($file); Settings::setOutputEscapingEnabled(true); $writer->save($file); self::assertFileExists($file); unlink($file); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Element/FieldTest.php ================================================ addSection(); $section->addField('FILENAME'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); self::assertTrue($doc->elementExists('/office:document-content/office:body/office:text/text:section/text:span/text:file-name')); self::assertEquals('false', $doc->getElementAttribute('/office:document-content/office:body/office:text/text:section/text:span/text:file-name', 'text:fixed')); self::assertEquals('name', $doc->getElementAttribute('/office:document-content/office:body/office:text/text:section/text:span/text:file-name', 'text:display')); } public function testFieldFilenameOptionPath(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addField('FILENAME', [], ['Path']); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); self::assertTrue($doc->elementExists('/office:document-content/office:body/office:text/text:section/text:span/text:file-name')); self::assertEquals('false', $doc->getElementAttribute('/office:document-content/office:body/office:text/text:section/text:span/text:file-name', 'text:fixed')); self::assertEquals('full', $doc->getElementAttribute('/office:document-content/office:body/office:text/text:section/text:span/text:file-name', 'text:display')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Element/FormulaTest.php ================================================ add( new Element\Fraction( new Element\Numeric(2), new Element\Identifier('π') ) ) ->add( new Element\Operator('+') ) ->add( new Element\Identifier('a') ) ->add( new Element\Operator('∗') ) ->add( new Element\Numeric(2) ); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addFormula($math); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); self::assertTrue($doc->elementExists('/office:document-content/office:body/office:text/text:section/text:p/draw:frame/draw:object')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Element/ImageTest.php ================================================ addSection(); $section->addImage(__DIR__ . '/../../../_files/images/earth.jpg'); $section->addImage(__DIR__ . '/../../../_files/images/mario.gif', ['align' => 'end']); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[3]"; self::assertEquals('IM1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[4]"; self::assertEquals('IM2', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('end', $doc->getElementAttribute($element, 'fo:text-align')); $path = '/office:document-content/office:body/office:text/text:section/text:p[2]'; self::assertTrue($doc->elementExists($path)); self::assertFalse($doc->hasElementAttribute($path, 'draw:text-style-name')); self::assertEquals('IM1', $doc->getElementAttribute($path, 'text:style-name')); $path = '/office:document-content/office:body/office:text/text:section/text:p[3]'; self::assertTrue($doc->elementExists($path)); self::assertFalse($doc->hasElementAttribute($path, 'draw:text-style-name')); self::assertEquals('IM2', $doc->getElementAttribute($path, 'text:style-name')); } /** * Test writing image, with non-default bidi. */ public function testImage2(): void { $phpWord = new PhpWord(); Settings::setDefaultRtl(false); $section = $phpWord->addSection(); $section->addImage(__DIR__ . '/../../../_files/images/earth.jpg'); $section->addImage(__DIR__ . '/../../../_files/images/mario.gif', ['align' => 'end']); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[3]"; self::assertEquals('IM1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('left', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[4]"; self::assertEquals('IM2', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('right', $doc->getElementAttribute($element, 'fo:text-align')); $path = '/office:document-content/office:body/office:text/text:section/text:p[2]'; self::assertTrue($doc->elementExists($path)); self::assertEquals('IM1', $doc->getElementAttribute($path, 'text:style-name')); self::assertFalse($doc->hasElementAttribute($path, 'draw:text-style-name')); $path = '/office:document-content/office:body/office:text/text:section/text:p[3]'; self::assertTrue($doc->elementExists($path)); self::assertEquals('IM2', $doc->getElementAttribute($path, 'text:style-name')); self::assertFalse($doc->hasElementAttribute($path, 'draw:text-style-name')); } /** * Test writing image not in a section. */ public function testImageInTextRun(): void { $phpWord = new PhpWord(); Settings::setDefaultRtl(false); $section = $phpWord->addSection(); $textRun = $section->addTextRun(); $textRun->addImage(__DIR__ . '/../../../_files/images/earth.jpg'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[4]"; self::assertEquals('IM1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('left', $doc->getElementAttribute($element, 'fo:text-align')); $path = '/office:document-content/office:body/office:text/text:section/text:p[2]'; self::assertTrue($doc->elementExists($path)); self::assertEquals('P1', $doc->getElementAttribute($path, 'text:style-name')); $path = '/office:document-content/office:body/office:text/text:section/text:p[2]/draw:frame'; self::assertTrue($doc->elementExists($path)); self::assertTrue($doc->hasElementAttribute($path, 'draw:text-style-name')); self::assertEquals('IM1', $doc->getElementAttribute($path, 'draw:text-style-name')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Element/ListItemRunTest.php ================================================ addSection() ->addListItemRun() ->addText($expected); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $xPath = '/office:document-content/office:body/office:text/text:section/text:list'; self::assertTrue($doc->elementExists($xPath)); self::assertTrue($doc->hasElementAttribute($xPath, 'text:style-name')); self::assertEquals('PHPWordListType3', $doc->getElementAttribute($xPath, 'text:style-name')); self::assertTrue($doc->elementExists($xPath . '/text:list-item')); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:p')); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:p/text:span')); self::assertEquals($expected, $doc->getElement($xPath . '/text:list-item/text:p/text:span')->nodeValue); } public function testAddListItemRunLevels(): void { $expected = 'List item run : '; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addListItemRun(0)->addText($expected . '1'); $section->addListItemRun(1)->addText($expected . '2'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $xPath = '/office:document-content/office:body/office:text/text:section/text:list'; self::assertTrue($doc->elementExists($xPath)); self::assertTrue($doc->hasElementAttribute($xPath, 'text:style-name')); self::assertEquals('PHPWordListType3', $doc->getElementAttribute($xPath, 'text:style-name')); self::assertTrue($doc->elementExists($xPath . '/text:list-item')); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:p')); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:p/text:span')); self::assertEquals($expected . '1', $doc->getElement($xPath . '/text:list-item/text:p/text:span')->nodeValue); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:list/text:list-item')); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:list/text:list-item/text:p')); self::assertTrue($doc->elementExists($xPath . '/text:list-item/text:list/text:list-item/text:p/text:span')); self::assertEquals($expected . '2', $doc->getElement($xPath . '/text:list-item/text:list/text:list-item/text:p/text:span')->nodeValue); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/ElementTest.php ================================================ write(); self::assertEquals('', $xmlWriter->getData()); } } // ODT Line Element not yet implemented // ODT Bookmark not yet implemented // ODT Table with style name not yet implemented (Word test defective) // ODT Shape Elements not yet implemented // ODT Chart Elements not yet implemented // ODT adding Field to Section not yet implemented // ODT List not yet implemented // ODT Macro Button not yet implemented // ODT Form Field not yet implemented // ODT SDT not yet implemented // ODT Comment not yet implemented // ODT Track Changes implemented, possibly not correctly // ODT List Item not yet implemented /** * Test link element. */ public function testLinkElement(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $extlink = 'https://github.com/PHPOffice/PHPWord'; $section->addLink($extlink); $intlink = 'internal_link'; $section->addLink($intlink, null, null, null, true); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $p2t = '/office:document-content/office:body/office:text/text:section'; $element = "$p2t/text:p[2]/text:a"; self::assertTrue($doc->elementExists($element)); self::assertEquals($extlink, $doc->getElementAttribute($element, 'xlink:href')); $element = "$p2t/text:p[3]/text:a"; self::assertTrue($doc->elementExists($element)); self::assertEquals("#$intlink", $doc->getElementAttribute($element, 'xlink:href')); } /** * Basic test for table element. */ public function testTableElements(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(['alignment' => \PhpOffice\PhpWord\SimpleType\JcTable::CENTER]); $table->addRow(900); $table->addCell(2000)->addText('Row 1'); $table->addCell(2000)->addText('Row 2'); $table->addCell(2000)->addText('Row 3'); $table->addCell(2000)->addText('Row 4'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $p2s = '/office:document-content/office:automatic-styles'; $tableStyleNum = 1; /** @var null|string $tableStyleName */ $tableStyleName = null; $element = ''; while ($tableStyleName === null) { $element = "$p2s/style:style[$tableStyleNum]"; if (!$doc->elementExists($element)) { break; } if ($doc->getElementAttribute($element, 'style:family') === 'table') { $tableStyleName = $doc->getElementAttribute($element, 'style:name'); break; } ++$tableStyleNum; } self::assertNotNull($tableStyleName); $element = "$element/style:table-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals(\PhpOffice\PhpWord\SimpleType\JcTable::CENTER, $doc->getElementAttribute($element, 'table:align')); $p2t = '/office:document-content/office:body/office:text/text:section'; $tableRootElement = "$p2t/table:table"; self::assertTrue($doc->elementExists($tableRootElement)); self::assertEquals($tableStyleName, $doc->getElementAttribute($tableRootElement, 'table:style-name')); self::assertTrue($doc->elementExists($tableRootElement . '/table:table-column[4]')); } /** * Test Title and Headings. */ public function testTitleAndHeading(): void { $phpWord = new PhpWord(); $phpWord->addTitleStyle(0, ['size' => 14, 'italic' => true]); $phpWord->addTitleStyle(1, ['size' => 20, 'color' => '333333', 'bold' => true]); $section = $phpWord->addSection(); $section->addTitle('This is a title', 0); $section->addTitle('Heading 1', 1); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $p2t = '/office:document-content/office:body/office:text/text:section'; $element = "$p2t/text:h[1]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('HE0', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('0', $doc->getElementAttribute($element, 'text:outline-level')); $span = "$element/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals('This is a title', $doc->getElement($span)->textContent); self::assertEquals('Title', $doc->getElementAttribute($span, 'text:style-name')); $element = "$p2t/text:h[2]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('HD1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('1', $doc->getElementAttribute($element, 'text:outline-level')); $span = "$element/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals('Heading 1', $doc->getElement($span)->textContent); self::assertEquals('Heading_1', $doc->getElementAttribute($span, 'text:style-name')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style[1]'; self::assertTrue($doc->elementExists($element)); self::assertEquals('Title', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('14pt', $doc->getElementAttribute($element, 'fo:font-size')); self::assertEquals('italic', $doc->getElementAttribute($element, 'fo:font-style')); self::assertEquals('', $doc->getElementAttribute($element, 'fo:font-weight')); self::assertEquals('', $doc->getElementAttribute($element, 'fo:color')); $element = '/office:document-styles/office:styles/style:style[2]'; self::assertTrue($doc->elementExists($element)); self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('20pt', $doc->getElementAttribute($element, 'fo:font-size')); self::assertEquals('', $doc->getElementAttribute($element, 'fo:font-style')); self::assertEquals('bold', $doc->getElementAttribute($element, 'fo:font-weight')); self::assertEquals('#333333', $doc->getElementAttribute($element, 'fo:color')); } /** * Test title specified as text run rather than text. */ public function testTextRunTitle(): void { $phpWord = new PhpWord(); $phpWord->addTitleStyle(1, ['name' => 'Times New Roman', 'size' => 18, 'bold' => true]); $section = $phpWord->addSection(); $section->addTitle('Text Title', 1); $section->addText('Text following Text Title'); $textRun = new TextRun(); $textRun->addText('Text Run'); $textRun->addText(' Title'); $section->addTitle($textRun, 1); $section->addText('Text following Text Run Title'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $p2t = '/office:document-content/office:body/office:text/text:section'; $element = "$p2t/text:h[1]"; self::assertEquals('HE1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('1', $doc->getElementAttribute($element, 'text:outline-level')); $span = "$element/text:span"; self::assertEquals('Text Title', $doc->getElement($span)->textContent); self::assertEquals('Heading_1', $doc->getElementAttribute($span, 'text:style-name')); $element = "$p2t/text:p[2]/text:span"; self::assertEquals('Text following Text Title', $doc->getElement($element)->nodeValue); $element = "$p2t/text:h[2]"; self::assertEquals('HD1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('1', $doc->getElementAttribute($element, 'text:outline-level')); $span = "$element/text:span"; self::assertEquals('Text Run', $doc->getElement("$span/text:span[1]")->textContent); self::assertTrue($doc->elementExists("$span/text:span[2]/text:s")); self::assertEquals('Title', $doc->getElement("$span/text:span[2]")->textContent); self::assertEquals('Heading_1', $doc->getElementAttribute($span, 'text:style-name')); $element = "$p2t/text:p[3]/text:span"; self::assertEquals('Text following Text Run Title', $doc->getElement($element)->nodeValue); } /** * Test correct writing of text with ampersand in it. */ public function testTextWithAmpersand(): void { $esc = \PhpOffice\PhpWord\Settings::isOutputEscapingEnabled(); \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled(true); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $txt = 'this text contains an & (ampersand)'; $section->addText($txt); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled($esc); $p2t = '/office:document-content/office:body/office:text/text:section'; $element = "$p2t/text:p[2]"; self::assertTrue($doc->elementExists($element)); $span = "$element/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($txt, $doc->getElement($span)->nodeValue); } /** * Test PageBreak. */ public function testPageBreak(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('test'); $section->addPageBreak(); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $element = '/office:document-content/office:body/office:text/text:section/text:p[3]'; self::assertTrue($doc->elementExists($element, 'content.xml')); self::assertEquals('PB', $doc->getElementAttribute($element, 'text:style-name', 'content.xml')); } /** * Test tracked changes. */ public function testTrackedChanges(): void { $phpWord = new PhpWord(); // New portrait section $section = $phpWord->addSection(); $textRun = $section->addTextRun(); $text = $textRun->addText('Hello World! Time to '); $text = $textRun->addText('wake ', ['bold' => true]); $text->setChangeInfo(TrackChange::INSERTED, 'Fred', time() - 1800); $text = $textRun->addText('up'); $text->setTrackChange(new TrackChange(TrackChange::INSERTED, 'Fred')); $text = $textRun->addText('go to sleep'); $text->setChangeInfo(TrackChange::DELETED, 'Barney', new DateTime('@' . (time() - 3600))); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $tcs = '/office:document-content/office:body/office:text/text:tracked-changes'; $tc1 = "$tcs/text:changed-region[1]"; $tc1id = $doc->getElementAttribute($tc1, 'text:id'); $element = "$tc1/text:insertion"; self::assertTrue($doc->elementExists($element)); $element .= '/office:change-info'; self::AssertEquals('Fred', $doc->getElement("$element/dc:creator")->nodeValue); self::assertTrue($doc->elementExists("$element/dc:date")); $tc2 = "$tcs/text:changed-region[2]"; $tc2id = $doc->getElementAttribute($tc2, 'text:id'); $element = "$tc2/text:insertion"; self::assertTrue($doc->elementExists($element)); $element .= '/office:change-info'; self::AssertEquals('Fred', $doc->getElement("$element/dc:creator")->nodeValue); //self::assertTrue($doc->elementExists("$element/dc:date")); $tc3 = "$tcs/text:changed-region[3]"; $tc3id = $doc->getElementAttribute($tc3, 'text:id'); $element = "$tc3/text:deletion"; self::assertTrue($doc->elementExists($element)); $element .= '/office:change-info'; self::AssertEquals('Barney', $doc->getElement("$element/dc:creator")->nodeValue); self::assertTrue($doc->elementExists("$element/dc:date")); $p2t = '/office:document-content/office:body/office:text/text:section/text:p[2]'; $element = "$p2t/text:span[2]/text:change-start"; self::AssertEquals($tc1id, $doc->getElementAttribute($element, 'text:change-id')); $element = "$p2t/text:span[3]/text:change-start"; self::AssertEquals($tc2id, $doc->getElementAttribute($element, 'text:change-id')); $element = "$p2t/text:change"; self::AssertEquals($tc3id, $doc->getElementAttribute($element, 'text:change-id')); } /** * Test ruby output. * Note that this test will need to be updated when ODT Ruby output supports * ODT's native ruby functionality. */ public function testRubyText(): void { $esc = \PhpOffice\PhpWord\Settings::isOutputEscapingEnabled(); \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled(true); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $section->addRuby($baseTextRun, $rubyTextRun, $properties); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled($esc); $p2t = '/office:document-content/office:body/office:text/text:section'; $element = "$p2t/text:p[2]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('私 (わたし)', $doc->getElement($element)->nodeValue); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Part/AbstractPartTest.php ================================================ getMockForAbstractClass(ODText\Part\AbstractPart::class); } else { /** @var ODText\Part\AbstractPart $object */ $object = new class() extends ODText\Part\AbstractPart { public function write(): string { return ''; } }; } $object->setParentWriter(new ODText()); self::assertEquals(new ODText(), $object->getParentWriter()); } /** * covers ::getParentWriter. */ public function testSetGetParentWriterNull(): void { $this->expectException(Exception::class); $this->expectExceptionMessage('No parent WriterInterface assigned.'); // @phpstan-ignore-next-line if (method_exists($this, 'getMockForAbstractClass')) { $object = $this->getMockForAbstractClass(ODText\Part\AbstractPart::class); } else { /** @var ODText\Part\AbstractPart $object */ $object = new class() extends ODText\Part\AbstractPart { public function write(): string { return ''; } }; } $object->getParentWriter(); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Part/ContentTest.php ================================================ getDocInfo(); $docProps->setCustomProperty('Company', 'PHPWord'); $phpWord->setDefaultFontName('Verdana'); $phpWord->addFontStyle('Font', ['size' => 11]); $phpWord->addParagraphStyle('Paragraph', ['alignment' => Jc::CENTER]); $phpWord->addTableStyle('tblStyle', ['width' => 100]); $section = $phpWord->addSection(['colsNum' => 2]); $section->addText($expected); $section->addText('Test font style', 'Font'); $section->addText('Test paragraph style', null, 'Paragraph'); $section->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); $section->addTitle('Test title', 1); $section->addTextBreak(); $section->addPageBreak(); $section->addListItem('Test list item'); $section->addImage($imageSrc, ['width' => 50]); $section->addObject($objectSrc); $section->addTOC(); $textrun = $section->addTextRun(); $textrun->addText('Test text run'); $table = $section->addTable(['width' => 50]); $cell = $table->addRow()->addCell(); $cell = $table->addRow()->addCell(); $cell->addText('Test'); $cell->addLink('https://github.com/PHPOffice/PHPWord', 'PHPWord on GitHub'); $cell->addTextBreak(); $cell->addListItem('Test list item'); $cell->addImage($imageSrc); $cell->addObject($objectSrc); $textrun = $cell->addTextRun(); $textrun->addText('Test text run'); $section->addPageBreak(); $footer = $section->addFooter(); $footer->addPreserveText('{PAGE}'); $table = $section->addTable('tblStyle')->addRow()->addCell(); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $element = '/office:document-content/office:body/office:text/text:section/text:p[2]'; self::assertEquals($expected, $doc->getElement($element, 'content.xml')->nodeValue); } /** * Test no paragraph style. */ public function testWriteNoStyle(): void { $phpWord = new PhpWord(); $phpWord->addFontStyle('Font', ['size' => 11]); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $element = '/office:document-content/office:automatic-styles/style:style'; self::assertTrue($doc->elementExists($element, 'content.xml')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Part/ManifestTest.php ================================================ addSection(); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); self::assertFalse($doc->elementExists( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/content.xml"]', 'META-INF/manifest.xml' )); self::assertFalse($doc->elementExists( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/"]', 'META-INF/manifest.xml' )); } public function testWriteFormula(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $math = new Math(); $math->add( new Element\Fraction( new Element\Numeric(2), new Element\Identifier('π') ) ); $section->addFormula($math); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); self::assertTrue($doc->elementExists( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/content.xml"]', 'META-INF/manifest.xml' )); self::assertEquals('text/xml', $doc->getElementAttribute( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/content.xml"]', 'manifest:media-type', 'META-INF/manifest.xml' )); self::assertTrue($doc->elementExists( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/"]', 'META-INF/manifest.xml' )); self::assertEquals('1.2', $doc->getElementAttribute( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/"]', 'manifest:version', 'META-INF/manifest.xml' )); self::assertEquals('application/vnd.oasis.opendocument.formula', $doc->getElementAttribute( '/manifest:manifest/manifest:file-entry[@manifest:full-path="Formula0/"]', 'manifest:media-type', 'META-INF/manifest.xml' )); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Style/FontTest.php ================================================ elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('#000000', $element->getAttribute('fo:color')); self::assertEquals('false', $element->getAttribute('style:use-window-font-color')); //has to be set to false so that fo:color can take effect } public function testSettingDefaults(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $defaultFontColor = '00FF00'; $phpWord->setDefaultFontColor($defaultFontColor); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $file = 'styles.xml'; $path = '/office:document-styles/office:styles/style:default-style/style:text-properties'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('#' . $defaultFontColor, $element->getAttribute('fo:color')); } /** * Test colors. */ public function testColors(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addText('This is red (800) in rtf/html, default in docx/odt', ['color' => '800']); $section->addText('This should be cyanish (008787)', ['color' => '008787']); $section->addText('This should be dark green (FGCOLOR_DARKGREEN)', ['color' => Font::FGCOLOR_DARKGREEN]); $section->addText('This color is default (unknow)', ['color' => 'unknow']); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $s2t = '/office:document-content/office:body/office:text/text:section'; self::assertTrue($doc->elementExists($s2t)); $element = "$s2a/style:style[5]"; self::assertTrue($doc->elementExists($element)); $style = $doc->getElementAttribute($element, 'style:name'); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('#008787', $doc->getElementAttribute($element, 'fo:color')); $span = "$s2t/text:p[3]/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($style, $doc->getElementAttribute($span, 'text:style-name')); self::assertEquals('This should be cyanish (008787)', $doc->getElement($span)->nodeValue); $element = "$s2a/style:style[7]"; self::assertTrue($doc->elementExists($element)); $style = $doc->getElementAttribute($element, 'style:name'); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('#006400', $doc->getElementAttribute($element, 'fo:color')); $span = "$s2t/text:p[4]/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($style, $doc->getElementAttribute($span, 'text:style-name')); self::assertEquals('This should be dark green (FGCOLOR_DARKGREEN)', $doc->getElement($span)->nodeValue); } public static function providerAllNamedColors() { return [ [Font::FGCOLOR_YELLOW, 'FFFF00'], [Font::FGCOLOR_LIGHTGREEN, '90EE90'], [Font::FGCOLOR_CYAN, '00FFFF'], [Font::FGCOLOR_MAGENTA, 'FF00FF'], [Font::FGCOLOR_BLUE, '0000FF'], [Font::FGCOLOR_RED, 'FF0000'], [Font::FGCOLOR_DARKBLUE, '00008B'], [Font::FGCOLOR_DARKCYAN, '008B8B'], [Font::FGCOLOR_DARKGREEN, '006400'], [Font::FGCOLOR_DARKMAGENTA, '8B008B'], [Font::FGCOLOR_DARKRED, '8B0000'], [Font::FGCOLOR_DARKYELLOW, '8B8B00'], [Font::FGCOLOR_DARKGRAY, 'A9A9A9'], [Font::FGCOLOR_LIGHTGRAY, 'D3D3D3'], [Font::FGCOLOR_BLACK, '000000'], ['unknow', 'unknow'], ['unknown', 'unknown'], ]; } /** * @dataProvider providerAllNamedColors * * @param string $namedColor * @param string $rgbColor */ public function testAllNamedColors($namedColor, $rgbColor): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addText('This is red (800) in rtf/html, default in docx/odt', ['color' => '800']); $section->addText('This should be cyanish (008787)', ['color' => '008787']); $section->addText($namedColor, ['color' => $namedColor]); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $s2t = '/office:document-content/office:body/office:text/text:section'; self::assertTrue($doc->elementExists($s2t)); $element = "$s2a/style:style[7]"; self::assertTrue($doc->elementExists($element)); $style = $doc->getElementAttribute($element, 'style:name'); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals("#$rgbColor", $doc->getElementAttribute($element, 'fo:color')); $span = "$s2t/text:p[4]/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($style, $doc->getElementAttribute($span, 'text:style-name')); self::assertEquals($namedColor, $doc->getElement($span)->nodeValue); } /** * Test noproof. */ public function testNoProof(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addText('Noproof not specified', ['color' => 'black']); $section->addText('Noproof is true', ['color' => 'black', 'noproof' => true]); $section->addText('Noproof is false', ['color' => 'black', 'noproof' => false]); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $s2t = '/office:document-content/office:body/office:text/text:section'; self::assertTrue($doc->elementExists($s2t)); $element = "$s2a/style:style[3]"; self::assertTrue($doc->elementExists($element)); $style = $doc->getElementAttribute($element, 'style:name'); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:language')); $span = "$s2t/text:p[2]/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($style, $doc->getElementAttribute($span, 'text:style-name')); self::assertEquals('Noproof not specified', $doc->getElement($span)->nodeValue); $element = "$s2a/style:style[5]"; self::assertTrue($doc->elementExists($element)); $style = $doc->getElementAttribute($element, 'style:name'); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('zxx', $doc->getElementAttribute($element, 'fo:language')); self::assertEquals('zxx', $doc->getElementAttribute($element, 'style:language-asian')); self::assertEquals('zxx', $doc->getElementAttribute($element, 'style:language-complex')); self::assertEquals('none', $doc->getElementAttribute($element, 'fo:country')); self::assertEquals('none', $doc->getElementAttribute($element, 'style:country-asian')); self::assertEquals('none', $doc->getElementAttribute($element, 'style:country-complex')); $span = "$s2t/text:p[3]/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($style, $doc->getElementAttribute($span, 'text:style-name')); self::assertEquals('Noproof is true', $doc->getElement($span)->nodeValue); $element = "$s2a/style:style[7]"; self::assertTrue($doc->elementExists($element)); $style = $doc->getElementAttribute($element, 'style:name'); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:language')); $span = "$s2t/text:p[4]/text:span"; self::assertTrue($doc->elementExists($span)); self::assertEquals($style, $doc->getElementAttribute($span, 'text:style-name')); self::assertEquals('Noproof is false', $doc->getElement($span)->nodeValue); } /** * Test using object with a name as font style for addText. */ public function testNamedStyleAsObject(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $named = $phpWord->addFontStyle('namedobject', ['color' => '008787']); $section = $phpWord->addSection(); $section->addText('Let us see what color we wind up with', $named); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2t = '/office:document-content/office:body/office:text/text:section'; self::assertTrue($doc->elementExists($s2t)); $element = "$s2t/text:p[2]/text:span"; self::assertTrue($doc->elementExists($element)); self::assertEquals('namedobject', $doc->getElementAttribute($element, 'text:style-name')); } /** * Test supplying field font style as array or object or string. */ public function testFieldStyles(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $namedstyle = $phpWord->addFontStyle('namedstyle', ['color' => '800000']); $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $fld = $textrun->addField('DATE'); $fld->setFontStyle('namedstyle'); $textrun = $section->addTextRun(); $fld = $textrun->addField('DATE'); $fld->setFontStyle(['color' => '008000']); $textrun = $section->addTextRun(); $fld = $textrun->addField('DATE'); $font = new Font(); $font->setColor('000080'); $fld->setFontStyle($font); $textrun = $section->addTextRun(); $fld = $textrun->addField('DATE'); $fld->setFontStyle($namedstyle); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $s2t = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/style:style[5]"; self::assertEquals('T1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('#008000', $doc->getElementAttribute("$element/style:text-properties", 'fo:color')); $element = "$s2a/style:style[7]"; self::assertEquals('T2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('#000080', $doc->getElementAttribute("$element/style:text-properties", 'fo:color')); $element = "$s2t/text:p[2]/text:span"; self::assertEquals('namedstyle', $doc->getElementAttribute($element, 'text:style-name')); self::assertTrue($doc->elementExists("$element/text:date")); $element = "$s2t/text:p[3]/text:span"; self::assertEquals('T1', $doc->getElementAttribute($element, 'text:style-name')); self::assertTrue($doc->elementExists("$element/text:date")); $element = "$s2t/text:p[4]/text:span"; self::assertEquals('T2', $doc->getElementAttribute($element, 'text:style-name')); self::assertTrue($doc->elementExists("$element/text:date")); $element = "$s2t/text:p[5]/text:span"; self::assertEquals('namedstyle', $doc->getElementAttribute($element, 'text:style-name')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Style/NumberingTest.php ================================================ addNumberingStyle($expected, [ 'type' => 'multilevel', 'levels' => [ [ 'start' => 1, 'format' => 'decimal', 'restart' => 1, 'suffix' => 'space', 'text' => '%1.', 'alignment' => Jc::START, ], ], ]); $phpWord->addSection() ->addListItemRun(0, $expected) ->addText('List item run 1'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $doc->setDefaultFile('styles.xml'); $xPath = '/office:document-styles/office:styles'; self::assertTrue($doc->elementExists($xPath)); self::assertTrue($doc->elementExists($xPath . '/text:list-style')); self::assertTrue($doc->hasElementAttribute($xPath . '/text:list-style', 'style:name')); self::assertEquals($expected, $doc->getElementAttribute($xPath . '/text:list-style', 'style:name')); self::assertTrue($doc->elementExists($xPath . '/text:list-style/text:list-level-style-bullet')); self::assertTrue($doc->elementExists($xPath . '/text:list-style/text:list-level-style-bullet/style:list-level-properties')); self::assertTrue($doc->elementExists($xPath . '/text:list-style/text:list-level-style-bullet/style:list-level-properties/style:list-level-label-alignment')); self::assertTrue($doc->elementExists($xPath . '/text:list-style/text:list-level-style-bullet/style:text-properties')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Style/Paragraph2Test.php ================================================ 'end']; $align2 = ['alignment' => 'start']; $phpWord->setDefaultParagraphStyle($align1); $section = $phpWord->addSection(); $section->addText('Should use default alignment (right for this doc)'); $section->addText('Explicit right alignment', null, $align2); $section->addText('Explicit left alignment', null, $align1); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[4]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('right', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[6]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('right', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[8]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('left', $doc->getElementAttribute($element, 'fo:text-align')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style'; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('left', $doc->getElementAttribute($element, 'fo:text-align')); } /** * Test text run paragraph style using named style. */ public function testTextRun(): void { $phpWord = new PhpWord(); Settings::setDefaultRtl(false); $phpWord->addParagraphStyle('parstyle1', ['align' => 'start']); $phpWord->addParagraphStyle('parstyle2', ['align' => 'end']); $section = $phpWord->addSection(); $trx = $section->addTextRun('parstyle1'); $trx->addText('First text in textrun. '); $trx->addText('Second text - paragraph style is specified but ignored.', null, 'parstyle2'); $section->addText('Third text added to section not textrun - paragraph style is specified and used.', null, 'parstyle2'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[3]"; self::assertEquals('P1_parstyle1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('parstyle1', $doc->getElementAttribute($element, 'style:parent-style-name')); $element = "$s2a/style:style[9]"; self::assertEquals('P4_parstyle2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('parstyle2', $doc->getElementAttribute($element, 'style:parent-style-name')); $s2a = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/text:p[2]"; self::assertEquals('P1_parstyle1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:p[3]"; self::assertEquals('P4_parstyle2', $doc->getElementAttribute($element, 'text:style-name')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style[1]'; self::assertEquals('parstyle1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('left', $doc->getElementAttribute($element, 'fo:text-align')); $element = '/office:document-styles/office:styles/style:style[2]'; self::assertEquals('parstyle2', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('right', $doc->getElementAttribute($element, 'fo:text-align')); } /** * Test text run paragraph style using unnamed style. */ public function testTextRunUnnamed(): void { $phpWord = new PhpWord(); Settings::setDefaultRtl(false); $parstyle1 = ['align' => 'start']; $parstyle2 = ['align' => 'end']; $section = $phpWord->addSection(); $trx = $section->addTextRun($parstyle1); $trx->addText('First text in textrun. '); $trx->addText('Second text - paragraph style is specified but ignored.', null, $parstyle2); $section->addText('Third text added to section not textrun - paragraph style is specified and used.', null, $parstyle2); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[3]"; self::assertEquals('P1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertEquals('left', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[9]"; self::assertEquals('P4', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertEquals('right', $doc->getElementAttribute($element, 'fo:text-align')); $s2a = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/text:p[2]"; self::assertEquals('P1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:p[3]"; self::assertEquals('P4', $doc->getElementAttribute($element, 'text:style-name')); } public function testWhenNullifed(): void { $dflt1 = Settings::isDefaultRtl(); self::assertFalse($dflt1); $phpWord = new PhpWord(); $dflt2 = Settings::isDefaultRtl(); self::assertNull($dflt2); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Style/ParagraphTest.php ================================================ addSection(); $section->addText('Text on first page'); $section->addPageBreak(); $section->addText('Text on second page'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[1]"; self::assertEquals('PB', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('page', $doc->getElementAttribute($element, 'fo:break-after')); self::assertEquals('0cm', $doc->getElementAttribute($element, 'fo:margin-top')); self::assertEquals('0cm', $doc->getElementAttribute($element, 'fo:margin-bottom')); $s2a = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/text:p[3]"; self::assertEquals('PB', $doc->getElementAttribute($element, 'text:style-name')); } /** * Test normal/indent. */ public function testNormalIndent(): void { $phpWord = new PhpWord(); $cvt = Converter::INCH_TO_TWIP; $indent1 = ['indentation' => ['left' => 0.50 * $cvt]]; $indent2 = ['indentation' => ['left' => 1.00 * $cvt, 'right' => 1.05 * $cvt]]; $indent3 = ['indentation' => ['left' => -0.50 * $cvt]]; $indent4 = ['indentation' => ['left' => 0 * $cvt]]; $phpWord->setDefaultParagraphStyle($indent1); $section = $phpWord->addSection(); $section->addText('Should use default indent (0.5)'); $section->addText('Should use non-default indent (1.0) on both sides, and here\'s an extra long line to prove it', null, $indent2); $section->addText('Should use non-default indent (-0.5)', null, $indent3); $section->addText('Should use non-default indent (0)', null, $indent4); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[4]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:margin-left')); self::assertEquals('', $doc->getElementAttribute($element, 'fo:margin-right')); $element = "$s2a/style:style[6]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('1in', $doc->getElementAttribute($element, 'fo:margin-left')); self::assertEquals('1.05in', $doc->getElementAttribute($element, 'fo:margin-right')); $element = "$s2a/style:style[8]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('-0.5in', $doc->getElementAttribute($element, 'fo:margin-left')); self::assertEquals('0in', $doc->getElementAttribute($element, 'fo:margin-right')); $element = "$s2a/style:style[10]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('0in', $doc->getElementAttribute($element, 'fo:margin-left')); self::assertEquals('0in', $doc->getElementAttribute($element, 'fo:margin-right')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style'; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('0.5in', $doc->getElementAttribute($element, 'fo:margin-left')); self::assertEquals('0in', $doc->getElementAttribute($element, 'fo:margin-right')); } /** * Test textAlign. */ public function testTextAlign(): void { $phpWord = new PhpWord(); $align1 = ['alignment' => 'end']; $align2 = ['alignment' => 'start']; $phpWord->setDefaultParagraphStyle($align1); $section = $phpWord->addSection(); $section->addText('Should use default alignment (right for this doc)'); $section->addText('Explicit left alignment', null, $align2); $section->addText('Explicit right alignment', null, $align1); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[4]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[6]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('start', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[8]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('end', $doc->getElementAttribute($element, 'fo:text-align')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style'; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('end', $doc->getElementAttribute($element, 'fo:text-align')); } /** * Test lineHeight. */ public function testLineHeight(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Should use line height 1.08, and here\'s a long line which ought to overflow onto a second line to prove it', null, ['lineHeight' => 1.08]); $section->addText('Should use line height 1.20, and here\'s a long line which ought to overflow onto a second line to prove it', null, ['lineHeight' => 1.20]); $section->addText('Should use line height 0.90, and here\'s a long line which ought to overflow onto a second line to prove it', null, ['lineHeight' => 0.90]); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[4]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('108%', $doc->getElementAttribute($element, 'fo:line-height')); $element = "$s2a/style:style[6]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('120%', $doc->getElementAttribute($element, 'fo:line-height')); $element = "$s2a/style:style[8]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('90%', $doc->getElementAttribute($element, 'fo:line-height')); } /** * Test SpaceBeforeAfter. */ public function testSpaceBeforeAfter(): void { $phpWord = new PhpWord(); $phpWord->setDefaultParagraphStyle(['spaceBefore' => 0, 'spaceAfter' => 0]); $section = $phpWord->addSection(); $section->addText('No spacing between this paragraph and next'); $section->addText('No spacing between this paragraph and previous'); $section->addText('No spacing before this but 100 after', null, ['spaceAfter' => 100]); $section->addText('No spacing for this paragraph but previous specified 100 after and next specifies 100 before'); $section->addText('No spacing after this but 100 before', null, ['spaceBefore' => 100]); $section->addText('No spacing before this paragraph'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[8]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:margin-top')); self::assertEquals('5pt', $doc->getElementAttribute($element, 'fo:margin-bottom')); $element = "$s2a/style:style[12]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('5pt', $doc->getElementAttribute($element, 'fo:margin-top')); self::assertEquals('', $doc->getElementAttribute($element, 'fo:margin-bottom')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style'; self::assertTrue($doc->elementExists($element)); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('0pt', $doc->getElementAttribute($element, 'fo:margin-top')); self::assertEquals('0pt', $doc->getElementAttribute($element, 'fo:margin-bottom')); } /** * Test Page Break Before. */ public function testPageBreakBefore(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('This is my first paragraph.'); $section->addText('This is my second paragraph, on a new page.', null, ['pageBreakBefore' => true]); $section->addText('This is my third paragraph, on same page as second.'); $section->addText('This is my fourth paragraph, on a new page.', null, ['pageBreakBefore' => true]); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[4]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[6]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('page', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[8]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[10]/style:paragraph-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('page', $doc->getElementAttribute($element, 'fo:break-before')); } /** * Test Heading Page Break Before. */ public function testHeadingPageBreakBefore(): void { $phpWord = new PhpWord(); $phpWord->addTitleStyle(1, null, ['pageBreakBefore' => true]); $phpWord->addTitleStyle(2, null, []); $section = $phpWord->addSection(); $section->addTitle('Section1 Heading1 #1', 1); $section->addTitle('Section1 Heading2 #1', 2); $section->addTitle('Section1 Heading1 #2', 1); $section->addTitle('Section1 Heading2 #2', 2); $section = $phpWord->addSection(); $section->addTitle('Section2 Heading1 #1', 1); $section->addTitle('Section2 Heading2 #1', 2); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[4]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('HD1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('page', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[5]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('HE1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('auto', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[6]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('HD2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Heading_2', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[7]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('HE2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Heading_2', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('auto', $doc->getElementAttribute($element, 'fo:break-before')); $s2a = '/office:document-content/office:body/office:text/text:section[1]'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/text:h[1]"; self::assertEquals('HE1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('1', $doc->getElementAttribute($element, 'text:outline-level')); $element .= '/text:span'; self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:h[2]"; self::assertEquals('HD2', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('2', $doc->getElementAttribute($element, 'text:outline-level')); $element .= '/text:span'; self::assertEquals('Heading_2', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:h[3]"; self::assertEquals('HD1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('1', $doc->getElementAttribute($element, 'text:outline-level')); $element .= '/text:span'; self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:h[4]"; self::assertEquals('HD2', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('2', $doc->getElementAttribute($element, 'text:outline-level')); $element .= '/text:span'; self::assertEquals('Heading_2', $doc->getElementAttribute($element, 'text:style-name')); $s2a = '/office:document-content/office:body/office:text/text:section[2]'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/text:h[1]"; self::assertEquals('HE1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('1', $doc->getElementAttribute($element, 'text:outline-level')); $element .= '/text:span'; self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:h[2]"; self::assertEquals('HD2', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('2', $doc->getElementAttribute($element, 'text:outline-level')); $element .= '/text:span'; self::assertEquals('Heading_2', $doc->getElementAttribute($element, 'text:style-name')); $doc->setDefaultFile('styles.xml'); $s2a = '/office:document-styles/office:styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:style[1]"; self::assertEquals('Heading_1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('paragraph', $doc->getElementAttribute($element, 'style:family')); $element .= '/style:paragraph-properties'; self::assertEquals('page', $doc->getElementAttribute($element, 'fo:break-before')); $element = "$s2a/style:style[3]"; self::assertEquals('Heading_2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('paragraph', $doc->getElementAttribute($element, 'style:family')); $element .= '/style:paragraph-properties'; self::assertEquals('', $doc->getElementAttribute($element, 'fo:break-before')); } /** * Test text run paragraph style using named style. */ public function testTextRun(): void { $phpWord = new PhpWord(); $phpWord->addParagraphStyle('parstyle1', ['align' => 'start']); $phpWord->addParagraphStyle('parstyle2', ['align' => 'end']); $section = $phpWord->addSection(); $trx = $section->addTextRun('parstyle1'); $trx->addText('First text in textrun. '); $trx->addText('Second text - paragraph style is specified but ignored.', null, 'parstyle2'); $section->addText('Third text added to section not textrun - paragraph style is specified and used.', null, 'parstyle2'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[3]"; self::assertEquals('P1_parstyle1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('parstyle1', $doc->getElementAttribute($element, 'style:parent-style-name')); $element = "$s2a/style:style[9]"; self::assertEquals('P4_parstyle2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('parstyle2', $doc->getElementAttribute($element, 'style:parent-style-name')); $s2a = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/text:p[2]"; self::assertEquals('P1_parstyle1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:p[3]"; self::assertEquals('P4_parstyle2', $doc->getElementAttribute($element, 'text:style-name')); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:style[1]'; self::assertEquals('parstyle1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('start', $doc->getElementAttribute($element, 'fo:text-align')); $element = '/office:document-styles/office:styles/style:style[2]'; self::assertEquals('parstyle2', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:paragraph-properties'; self::assertEquals('end', $doc->getElementAttribute($element, 'fo:text-align')); } /** * Test text run paragraph style using unnamed style. */ public function testTextRunUnnamed(): void { $phpWord = new PhpWord(); $parstyle1 = ['align' => 'start']; $parstyle2 = ['align' => 'end']; $section = $phpWord->addSection(); $trx = $section->addTextRun($parstyle1); $trx->addText('First text in textrun. '); $trx->addText('Second text - paragraph style is specified but ignored.', null, $parstyle2); $section->addText('Third text added to section not textrun - paragraph style is specified and used.', null, $parstyle2); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $element = "$s2a/style:style[3]"; self::assertEquals('P1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertEquals('start', $doc->getElementAttribute($element, 'fo:text-align')); $element = "$s2a/style:style[9]"; self::assertEquals('P4', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Normal', $doc->getElementAttribute($element, 'style:parent-style-name')); $element .= '/style:paragraph-properties'; self::assertEquals('end', $doc->getElementAttribute($element, 'fo:text-align')); $s2a = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/text:p[2]"; self::assertEquals('P1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2a/text:p[3]"; self::assertEquals('P4', $doc->getElementAttribute($element, 'text:style-name')); } /** * Test Empty font and paragraph styles. */ public function testEmptyFontAndParagraphStyles(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $phpWord->addFontStyle('namedfont', ['name' => 'Courier New', 'size' => 8]); $phpWord->addParagraphStyle('namedpar', ['lineHeight' => 1.08]); $section->addText('Empty Font Style and Empty Paragraph Style', '', ''); $section->addText('Named Font Style and Empty Paragraph Style', 'namedfont', ''); $section->addText('Empty Font Style and Named Paragraph Style', '', 'namedpar'); $section->addText('Named Font Style and Named Paragraph Style', 'namedfont', 'namedpar'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:body/office:text/text:section'; $element = "$s2a/text:p[2]"; self::assertEquals('Normal', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals(5, $doc->getElementAttribute("$element/text:s", 'text:c')); self::assertFalse($doc->elementExists("$element/text:span")); $element = "$s2a/text:p[3]"; self::assertEquals('Normal', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('namedfont', $doc->getElementAttribute("$element/text:span", 'text:style-name')); $element = "$s2a/text:p[4]"; self::assertEquals('P1_namedpar', $doc->getElementAttribute($element, 'text:style-name')); self::assertFalse($doc->elementExists("$element/text:span")); $element = "$s2a/text:p[5]"; self::assertEquals('P2_namedpar', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('namedfont', $doc->getElementAttribute("$element/text:span", 'text:style-name')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/Style/SectionTest.php ================================================ addFontStyle('hdrstyle1', ['name' => 'Courier New', 'size' => 8]); $section = $phpWord->addSection(['paperSize' => 'Letter', 'marginTop' => $margins, 'marginBottom' => $margins]); $header = $section->addHeader(); $phpWord->addParagraphStyle('centerheader', ['align' => 'center']); $header->addText('Centered Header', 'hdrstyle1', 'centerheader'); $footer = $section->addFooter(); $sizew = $section->getStyle()->getPageSizeW(); $sizel = $section->getStyle()->getMarginLeft(); $sizer = $section->getStyle()->getMarginRight(); $footerwidth = $sizew - $sizel - $sizer; $phpWord->addParagraphStyle( 'footerTab', [ 'tabs' => [ new \PhpOffice\PhpWord\Style\Tab('center', (int) ($footerwidth / 2)), new \PhpOffice\PhpWord\Style\Tab('right', (int) $footerwidth), ], ] ); $textrun = $footer->addTextRun('footerTab'); $textrun->addText('Left footer', 'hdrstyle1'); $textrun->addText("\t", 'hdrstyle1'); $fld = $textrun->addField('DATE'); $fld->setFontStyle('hdrstyle1'); $textrun->addText("\t", 'hdrstyle1'); $textrun->addText('Page ', 'hdrstyle1'); $fld = $textrun->addField('PAGE'); $fld->setFontStyle('hdrstyle1'); $textrun->addText(' of ', 'hdrstyle1'); $fld = $textrun->addField('NUMPAGES'); $fld->setFontStyle('hdrstyle1'); $section->addText('First page'); $section->addPageBreak(); $section->addText('Second page'); $section->addPageBreak(); $section->addText('Third page'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $doc->setDefaultFile('styles.xml'); $s2a = '/office:document-styles/office:automatic-styles'; $element = "$s2a/style:page-layout/style:page-layout-properties"; self::assertTrue($doc->elementExists($element)); self::assertEquals('8.5in', $doc->getElementAttribute($element, 'fo:page-width')); self::assertEquals('11in', $doc->getElementAttribute($element, 'fo:page-height')); self::assertEquals('0.5in', $doc->getElementAttribute($element, 'fo:margin-top')); self::assertEquals('0.5in', $doc->getElementAttribute($element, 'fo:margin-bottom')); $s2s = '/office:document-styles/office:styles'; $element = "$s2s/style:style[1]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('hdrstyle1', $doc->getElementAttribute($element, 'style:name')); $tprop = "$element/style:text-properties"; self::assertTrue($doc->elementExists($tprop)); self::assertEquals('Courier New', $doc->getElementAttribute($tprop, 'style:font-name')); $element = "$s2s/style:style[2]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('centerheader', $doc->getElementAttribute($element, 'style:name')); $tprop = "$element/style:paragraph-properties"; self::assertTrue($doc->elementExists($tprop)); self::assertEquals('center', $doc->getElementAttribute($tprop, 'fo:text-align')); $element = "$s2s/style:style[3]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('footerTab', $doc->getElementAttribute($element, 'style:name')); $tprop = "$element/style:paragraph-properties/style:tab-stops"; self::assertTrue($doc->elementExists($tprop)); $tstop = "$tprop/style:tab-stop[1]"; self::assertTrue($doc->elementExists($tstop)); self::assertEquals('center', $doc->getElementAttribute($tstop, 'style:type')); self::assertEquals('3.25in', $doc->getElementAttribute($tstop, 'style:position')); $tstop = "$tprop/style:tab-stop[2]"; self::assertTrue($doc->elementExists($tstop)); self::assertEquals('right', $doc->getElementAttribute($tstop, 'style:type')); self::assertEquals('6.5in', $doc->getElementAttribute($tstop, 'style:position')); $s2s = '/office:document-styles/office:master-styles/style:master-page/style:footer/text:p'; self::assertTrue($doc->elementExists($s2s)); $element = "$s2s/text:span[1]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('hdrstyle1', $doc->getElementAttribute($element, 'text:style-name')); self::assertEquals('Left footer', $doc->getElement($element)->nodeValue); $element = "$s2s/text:span[2]/text:tab"; self::assertTrue($doc->elementExists($element)); $element = "$s2s/text:span[3]/text:date"; self::assertTrue($doc->elementExists($element)); $element = "$s2s/text:span[4]/text:tab"; self::assertTrue($doc->elementExists($element)); $element = "$s2s/text:span[5]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Page', $doc->getElement($element)->nodeValue); self::assertTrue($doc->elementExists("$element/text:s")); $element = "$s2s/text:span[6]/text:page-number"; self::assertTrue($doc->elementExists($element)); $element = "$s2s/text:span[7]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('of', $doc->getElement($element)->nodeValue); self::assertTrue($doc->elementExists("$element/text:s")); self::assertTrue($doc->elementExists("$element/text:s[2]")); $element = "$s2s/text:span[8]/text:page-count"; self::assertTrue($doc->elementExists($element)); } /** * Test HideErrors. */ public function testHideErrors(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setHideGrammaticalErrors(true); $phpWord->getSettings()->setHideSpellingErrors(true); $phpWord->getSettings()->setThemeFontLang(new \PhpOffice\PhpWord\Style\Language('en-US')); $phpWord->getSettings()->getThemeFontLang()->setLangId(\PhpOffice\PhpWord\Style\Language::EN_US_ID); $section = $phpWord->addSection(); $section->addText('Here is a paragraph with some speling errorz'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $doc->setDefaultFile('styles.xml'); $element = '/office:document-styles/office:styles/style:default-style/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('zxx', $doc->getElementAttribute($element, 'fo:language')); self::assertEquals('zxx', $doc->getElementAttribute($element, 'style:language-asian')); self::assertEquals('zxx', $doc->getElementAttribute($element, 'style:language-complex')); self::assertEquals('none', $doc->getElementAttribute($element, 'fo:country')); self::assertEquals('none', $doc->getElementAttribute($element, 'style:country-asian')); self::assertEquals('none', $doc->getElementAttribute($element, 'style:country-complex')); } /** * Test SpaceBeforeAfter. */ public function testMultipleSections(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(['paperSize' => 'Letter', 'Orientation' => 'portrait']); $section->addText('This section uses Letter paper in portrait orientation.'); $section = $phpWord->addSection(['paperSize' => 'A4', 'Orientation' => 'landscape', 'pageNumberingStart' => '9']); $header = $section->addHeader(); $header->addField('PAGE'); $section->addText('This section uses A4 paper in landscape orientation. It should have a page break beforehand. It artificially starts on page 9.'); $doc = TestHelperDOCX::getDocument($phpWord, 'ODText'); $s2a = '/office:document-content/office:automatic-styles'; $s2t = '/office:document-content/office:body/office:text'; self::assertTrue($doc->elementExists($s2a)); self::assertTrue($doc->elementExists($s2t)); $element = "$s2a/style:style[2]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('SB1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Standard1', $doc->getElementAttribute($element, 'style:master-page-name')); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('none', $doc->getElementAttribute($element, 'text:display')); $element = "$s2a/style:style[3]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('SB2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Standard2', $doc->getElementAttribute($element, 'style:master-page-name')); $elemen2 = "$element/style:paragraph-properties"; self::assertEquals('9', $doc->getElementAttribute($elemen2, 'style:page-number')); $element .= '/style:text-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('none', $doc->getElementAttribute($element, 'text:display')); $element = "$s2t/text:section[1]"; self::assertTrue($doc->elementExists($element)); $element .= '/text:p[1]'; self::assertEquals('SB1', $doc->getElementAttribute($element, 'text:style-name')); $element = "$s2t/text:section[2]"; self::assertTrue($doc->elementExists($element)); $element .= '/text:p[1]'; self::assertEquals('SB2', $doc->getElementAttribute($element, 'text:style-name')); $doc->setDefaultFile('styles.xml'); $s2a = '/office:document-styles/office:automatic-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:page-layout[1]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Mpm1', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:page-layout-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('8.5in', $doc->getElementAttribute($element, 'fo:page-width')); self::assertEquals('11in', $doc->getElementAttribute($element, 'fo:page-height')); self::assertEquals('portrait', $doc->getElementAttribute($element, 'style:print-orientation')); $element = "$s2a/style:page-layout[2]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Mpm2', $doc->getElementAttribute($element, 'style:name')); $element .= '/style:page-layout-properties'; self::assertTrue($doc->elementExists($element)); self::assertEquals('29.7cm', $doc->getElementAttribute($element, 'fo:page-width')); self::assertEquals('21cm', $doc->getElementAttribute($element, 'fo:page-height')); self::assertEquals('landscape', $doc->getElementAttribute($element, 'style:print-orientation')); $s2a = '/office:document-styles/office:master-styles'; self::assertTrue($doc->elementExists($s2a)); $element = "$s2a/style:master-page[1]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Standard1', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Mpm1', $doc->getElementAttribute($element, 'style:page-layout-name')); $element = "$s2a/style:master-page[2]"; self::assertTrue($doc->elementExists($element)); self::assertEquals('Standard2', $doc->getElementAttribute($element, 'style:name')); self::assertEquals('Mpm2', $doc->getElementAttribute($element, 'style:page-layout-name')); } } ================================================ FILE: tests/PhpWordTests/Writer/ODText/StyleTest.php ================================================ write(); self::assertEquals('', $xmlWriter->getData()); } } } ================================================ FILE: tests/PhpWordTests/Writer/ODTextTest.php ================================================ getPhpWord()); self::assertEquals('./', $object->getDiskCachingDirectory()); foreach (['Content', 'Manifest', 'Meta', 'Mimetype', 'Styles'] as $part) { self::assertInstanceOf( "PhpOffice\\PhpWord\\Writer\\ODText\\Part\\{$part}", $object->getWriterPart($part) ); self::assertInstanceOf( 'PhpOffice\\PhpWord\\Writer\\ODText', $object->getWriterPart($part)->getParentWriter() ); } } /** * Construct with null. */ public function testConstructWithNull(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('No PhpWord assigned.'); $object = new ODText(); $object->getPhpWord(); } /** * Save. */ public function testSave(): void { $imageSrc = __DIR__ . '/../_files/images/PhpWord.png'; $objectSrc = __DIR__ . '/../_files/documents/sheet.xls'; $file = __DIR__ . '/../_files/temp.odt'; $phpWord = new PhpWord(); $phpWord->addFontStyle('Font', ['size' => 11]); $phpWord->addParagraphStyle('Paragraph', ['alignment' => Jc::CENTER]); $section = $phpWord->addSection(); $section->addText('Test 1', 'Font'); $section->addTextBreak(); $section->addText('Test 2', null, 'Paragraph'); $section->addLink('https://github.com/PHPOffice/PHPWord'); $section->addTitle('Test', 1); $section->addPageBreak(); $section->addTable()->addRow()->addCell()->addText('Test'); $section->addListItem('Test'); $section->addImage($imageSrc); $section->addObject($objectSrc); $section->addTOC(); $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText('Test 3'); $writer = new ODText($phpWord); $writer->save($file); self::assertFileExists($file); unlink($file); } /** * Save php output. * * @todo Haven't got any method to test this */ public function testSavePhpOutput(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Test'); $writer = new ODText($phpWord); ob_start(); $writer->save('php://output'); $contents = ob_get_contents(); self::assertTrue(ob_end_clean()); self::assertNotEmpty($contents); } /** * Get writer part return null value. */ public function testGetWriterPartNull(): void { $object = new ODText(); self::assertNull($object->getWriterPart('foo')); } /** * Set/get use disk caching. */ public function testSetGetUseDiskCaching(): void { $object = new ODText(); $object->setUseDiskCaching(true, PHPWORD_TESTS_BASE_DIR); self::assertTrue($object->isUseDiskCaching()); self::assertEquals(PHPWORD_TESTS_BASE_DIR, $object->getDiskCachingDirectory()); } /** * Use disk caching exception. */ public function testSetUseDiskCachingException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $dir = implode(DIRECTORY_SEPARATOR, [PHPWORD_TESTS_BASE_DIR, 'foo']); $object = new ODText(); $object->setUseDiskCaching(true, $dir); } } ================================================ FILE: tests/PhpWordTests/Writer/PDF/DomPDFTest.php ================================================ addSection(); $section->addText('Test 1'); $rendererName = Settings::PDF_RENDERER_DOMPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/dompdf/dompdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); $writer = new PDF($phpWord); $writer->save($file); self::assertFileExists($file); unlink($file); } /** * Test set/get abstract renderer properties. */ public function testSetGetAbstractRendererProperties(): void { define('DOMPDF_ENABLE_AUTOLOAD', false); $rendererName = Settings::PDF_RENDERER_DOMPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/dompdf/dompdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); $writer = new PDF(new PhpWord()); $writer->setFont('arial'); self::assertEquals('arial', $writer->getFont()); $writer->setPaperSize(); self::assertEquals(9, $writer->getPaperSize()); $writer->setOrientation(); self::assertEquals('default', $writer->getOrientation()); $writer->setTempDir(Settings::getTempDir()); self::assertEquals(Settings::getTempDir(), $writer->getTempDir()); } /** * Test set/get abstract renderer options. */ public function testSetGetAbstractRendererOptions(): void { define('DOMPDF_ENABLE_AUTOLOAD', false); $rendererName = Settings::PDF_RENDERER_DOMPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/dompdf/dompdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); Settings::setPdfRendererOptions([ 'font' => 'Arial', ]); $writer = new PDF(new PhpWord()); self::assertEquals('Arial', $writer->getFont()); } } ================================================ FILE: tests/PhpWordTests/Writer/PDF/MPDFTest.php ================================================ addSection(); $section->addText('Test 1'); $section->addPageBreak(); $section->addText('Test 2'); $oSettings = new \PhpOffice\PhpWord\Style\Section(); $oSettings->setSettingValue('orientation', 'landscape'); $section = $phpWord->addSection($oSettings); // @phpstan-ignore-line $section->addText('Section 2 - landscape'); $writer = new MPDF($phpWord); $writer->save($file); self::assertFileExists($file); unlink($file); } public function testEditCallback(): void { $file = __DIR__ . '/../../_files/mpdf.pdf'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Test 1'); $section->addPageBreak(); $section->addText('Test 2'); $oSettings = new \PhpOffice\PhpWord\Style\Section(); $oSettings->setSettingValue('orientation', 'landscape'); $section = $phpWord->addSection($oSettings); // @phpstan-ignore-line $section->addText('Section 2 - landscape'); $writer = new MPDF($phpWord); /** @var callable */ $callback = [self::class, 'cbEditContent']; $writer->setEditCallback($callback); $writer->save($file); self::assertFileExists($file); unlink($file); } // add a footer public static function cbEditContent(string $html): string { $afterBody = '
    {PAGENO}
    ' . MPDF::SIMULATED_BODY_START; $beforeBody = ''; $needle = ''; $pos = strpos($html, $needle); if ($pos !== false) { $html = (string) substr_replace($html, "$beforeBody\n$needle", $pos, strlen($needle)); } $needle = ''; $pos = strpos($html, $needle); if ($pos !== false) { $html = (string) substr_replace($html, "$needle\n$afterBody", $pos, strlen($needle)); } return $html; } /** * Test set/get abstract renderer options. */ public function testSetGetAbstractRendererOptions(): void { $rendererName = Settings::PDF_RENDERER_MPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/mpdf/mpdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); Settings::setPdfRendererOptions([ 'font' => 'Arial', ]); $writer = new PDF(new PhpWord()); self::assertEquals('Arial', $writer->getFont()); } } ================================================ FILE: tests/PhpWordTests/Writer/PDF/TCPDFTest.php ================================================ setDefaultParagraphStyle(['spaceBefore' => 0, 'spaceAfter' => 0]); $section = $phpWord->addSection(); $section->addText('Test 1'); $rendererName = Settings::PDF_RENDERER_TCPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/tecnickcom/tcpdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); $writer = new PDF($phpWord); $writer->save($file); self::assertFileExists($file); unlink($file); } /** * Test set/get abstract renderer options. */ public function testSetGetAbstractRendererOptions(): void { $rendererName = Settings::PDF_RENDERER_TCPDF; $rendererLibraryPath = realpath(PHPWORD_TESTS_BASE_DIR . '/../vendor/tecnickcom/tcpdf'); Settings::setPdfRenderer($rendererName, $rendererLibraryPath); Settings::setPdfRendererOptions([ 'font' => 'Arial', ]); $writer = new PDF(new PhpWord()); self::assertEquals('Arial', $writer->getFont()); } } ================================================ FILE: tests/PhpWordTests/Writer/PDFTest.php ================================================ save($file); self::assertFileExists($file); unlink($file); } /** * Test construct exception. */ public function testConstructException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('PDF rendering library or library path has not been defined.'); $writer = new PDF(new PhpWord()); $writer->save('unknown.file'); } } ================================================ FILE: tests/PhpWordTests/Writer/RTF/Element/TableTest.php ================================================ write()); } public function testTable(): void { Settings::setDefaultRtl(false); $parentWriter = new RTF(); $element = new Table(); $width = 100; $width2 = 2 * $width; $element->addRow(); $tce = $element->addCell($width); $tce->addText('1'); $tce = $element->addCell($width); $tce->addText('2'); $element->addRow(); $tce = $element->addCell($width); $tce->addText('3'); $tce = $element->addCell($width); $tce->addText('4'); $table = new WriterTable($parentWriter, $element); $expect = implode("\n", [ '\\pard', "\\trowd \\cellx$width \\cellx$width2 ", '\\intbl', '\\ql{\\cf0\\f0 1}\\par', '\\cell', '\\intbl', '{\\cf0\\f0 2}\\par', '\\cell', '\\row', "\\trowd \\cellx$width \\cellx$width2 ", '\\intbl', '\\ql{\\cf0\\f0 3}\\par', '\\cell', '\\intbl', '{\\cf0\\f0 4}\par', '\\cell', '\\row', '\\pard', '', ]); self::assertEquals($expect, $this->removeCr($table)); } public function testTableStyle(): void { $width = 100; Settings::setDefaultRtl(false); $parentWriter = new RTF(); Style::addTableStyle('TableStyle', ['borderSize' => 6, 'borderColor' => '006699']); $element = new Table('TableStyle'); $element->addRow(); $elementCell = $element->addCell($width); $elementCell->addText('1'); $expect = implode("\n", [ '\\pard', '\\trowd \\clbrdrt\\brdrs\\brdrw2\\brdrcf0', '\\clbrdrl\\brdrs\\brdrw2\\brdrcf0', '\\clbrdrb\\brdrs\\brdrw2\\brdrcf0', '\\clbrdrr\\brdrs\\brdrw2\\brdrcf0', "\\cellx$width ", '\\intbl', '\\ql{\\cf0\\f0 1}\\par', '\\cell', '\\row', '\\pard', '', ]); self::assertEquals($expect, $this->removeCr(new WriterTable($parentWriter, $element))); } public function testTableStyleNotExisting(): void { $width = 100; Settings::setDefaultRtl(false); $parentWriter = new RTF(); $element = new Table('TableStyleNotExisting'); $element->addRow(); $elementCell = $element->addCell($width); $elementCell->addText('1'); $expect = implode("\n", [ '\\pard', "\\trowd \\cellx$width ", '\\intbl', '\\ql{\\cf0\\f0 1}\\par', '\\cell', '\\row', '\\pard', '', ]); self::assertEquals($expect, $this->removeCr(new WriterTable($parentWriter, $element))); } public function testTableCellStyle(): void { $width = 100; Settings::setDefaultRtl(false); $parentWriter = new RTF(); $element = new Table(); $element->addRow(); $elementCell = $element->addCell($width, ['borderSize' => 6, 'borderColor' => '006699', 'borderStyle' => Border::DOTTED]); $elementCell->addText('1'); $expect = implode("\n", [ '\\pard', '\\trowd \\clbrdrt\\brdrdot\\brdrw2\\brdrcf0', '\\clbrdrl\\brdrdot\\brdrw2\\brdrcf0', '\\clbrdrb\\brdrdot\\brdrw2\\brdrcf0', '\\clbrdrr\\brdrdot\\brdrw2\\brdrcf0', "\\cellx$width ", '\\intbl', '\\ql{\\cf0\\f0 1}\\par', '\\cell', '\\row', '\\pard', '', ]); self::assertEquals($expect, $this->removeCr(new WriterTable($parentWriter, $element))); } } ================================================ FILE: tests/PhpWordTests/Writer/RTF/Element2Test.php ================================================ write()); } public function testTextRun(): void { Settings::setDefaultRtl(false); $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\TextRun(); $element->addText('Hello '); $element->addText('there.'); $textrun = new WriterTextRun($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\ql{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n"; self::assertEquals($expect, $this->removeCr($textrun)); } public function testTextRunParagraphStyle(): void { Settings::setDefaultRtl(false); $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\TextRun(['spaceBefore' => 0, 'spaceAfter' => 0]); $element->addText('Hello '); $element->addText('there.'); $textrun = new WriterTextRun($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\ql\\sb0\\sa0{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n"; self::assertEquals($expect, $this->removeCr($textrun)); } public function testTitle(): void { $parentWriter = new RTF(); $phpWord = new \PhpOffice\PhpWord\PhpWord(); Settings::setDefaultRtl(false); $phpWord->addTitleStyle(1, [], ['spaceBefore' => 0, 'spaceAfter' => 0]); $section = $phpWord->addSection(); $element = $section->addTitle('First Heading', 1); $elwrite = new WriterTitle($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\ql\\sb0\\sa0{\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}"; self::assertEquals($expect, $this->removeCr($elwrite)); Settings::setDefaultRtl(null); } } ================================================ FILE: tests/PhpWordTests/Writer/RTF/ElementTest.php ================================================ write()); } /** * Test unmatched elements. */ public function testUnmatchedElements(): void { $elements = ['Container', 'Text', 'Title', 'Link', 'Image', 'Table', 'Field']; foreach ($elements as $element) { $objectClass = 'PhpOffice\\PhpWord\\Writer\\RTF\\Element\\' . $element; $parentWriter = new RTF(); $newElement = new \PhpOffice\PhpWord\Element\PageBreak(); $object = new $objectClass($parentWriter, $newElement); self::assertEquals('', $object->write()); } } public function testFilenameField(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Field('FILENAME'); $field = new RTF\Element\Field($parentWriter, $element); self::assertEquals("{\\field{\\*\\fldinst FILENAME}{\\fldrslt}}\\par\n", $this->removeCr($field)); } public function testFilenameFieldOptionsPath(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Field('FILENAME', [], ['Path']); $field = new RTF\Element\Field($parentWriter, $element); self::assertEquals("{\\field{\\*\\fldinst FILENAME \\\\p}{\\fldrslt}}\\par\n", $this->removeCr($field)); } public function testPageField(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Field('PAGE'); $field = new RTF\Element\Field($parentWriter, $element); self::assertEquals("{\\field{\\*\\fldinst PAGE}{\\fldrslt}}\\par\n", $this->removeCr($field)); } public function testNumpageField(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Field('NUMPAGES'); $field = new RTF\Element\Field($parentWriter, $element); self::assertEquals("{\\field{\\*\\fldinst NUMPAGES}{\\fldrslt}}\\par\n", $this->removeCr($field)); } public function testDateField(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Field('DATE', ['dateformat' => 'd MM yyyy H:mm:ss']); $field = new RTF\Element\Field($parentWriter, $element); self::assertEquals("{\\field{\\*\\fldinst DATE \\\\@ \"d MM yyyy H:mm:ss\"}{\\fldrslt}}\\par\n", $this->removeCr($field)); } public function testIndexField(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Field('INDEX'); $field = new RTF\Element\Field($parentWriter, $element); self::assertEquals("{}\\par\n", $this->removeCr($field)); } public function testTable(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Table(); $width = 100; $width2 = 2 * $width; $element->addRow(); $tce = $element->addCell($width); $tce->addText('1'); $tce = $element->addCell($width); $tce->addText('2'); $element->addRow(); $tce = $element->addCell($width); $tce->addText('3'); $tce = $element->addCell($width); $tce->addText('4'); $table = new RTF\Element\Table($parentWriter, $element); $expect = implode("\n", [ '\\pard', "\\trowd \\cellx$width \\cellx$width2 ", '\\intbl', '{\\cf0\\f0 1}\\par', '\\cell', '\\intbl', '{\\cf0\\f0 2}\\par', '\\cell', '\\row', "\\trowd \\cellx$width \\cellx$width2 ", '\\intbl', '{\\cf0\\f0 3}\\par', '\\cell', '\\intbl', '{\\cf0\\f0 4}\par', '\\cell', '\\row', '\\pard', '', ]); self::assertEquals($expect, $this->removeCr($table)); } public function testTextRun(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\TextRun(); $element->addText('Hello '); $element->addText('there.'); $textrun = new RTF\Element\TextRun($parentWriter, $element); $expect = "\\pard\\nowidctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n"; self::assertEquals($expect, $this->removeCr($textrun)); } public function testTextRunParagraphStyle(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\TextRun(['spaceBefore' => 0, 'spaceAfter' => 0]); $element->addText('Hello '); $element->addText('there.'); $textrun = new RTF\Element\TextRun($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\sb0\\sa0{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n"; self::assertEquals($expect, $this->removeCr($textrun)); } public function testTitle(): void { $parentWriter = new RTF(); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $phpWord->addTitleStyle(1, [], ['spaceBefore' => 0, 'spaceAfter' => 0]); $section = $phpWord->addSection(); $element = $section->addTitle('First Heading', 1); $elwrite = new RTF\Element\Title($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\sb0\\sa0{\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}"; self::assertEquals($expect, $this->removeCr($elwrite)); } public function testRuby(): void { $parentWriter = new RTF(); $properties = new \PhpOffice\PhpWord\ComplexType\RubyProperties(); $baseTextRun = new \PhpOffice\PhpWord\Element\TextRun(null); $baseTextRun->addText('base text'); $rubyTextRun = new \PhpOffice\PhpWord\Element\TextRun(null); $rubyTextRun->addText('ruby'); $element = new \PhpOffice\PhpWord\Element\TextRun(); $element->addRuby($baseTextRun, $rubyTextRun, $properties); $textrun = new RTF\Element\TextRun($parentWriter, $element); $expect = "\\pard\\nowidctlpar {{base text (ruby)}}\\par\n"; self::assertEquals($expect, $this->removeCr($textrun)); } public function testRubyTitle(): void { $parentWriter = new RTF(); $properties = new \PhpOffice\PhpWord\ComplexType\RubyProperties(); $baseTextRun = new \PhpOffice\PhpWord\Element\TextRun(null); $baseTextRun->addText('base text'); $rubyTextRun = new \PhpOffice\PhpWord\Element\TextRun(null); $rubyTextRun->addText('ruby'); $textRun = new \PhpOffice\PhpWord\Element\TextRun(); $textRun->addRuby($baseTextRun, $rubyTextRun, $properties); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $phpWord->addTitleStyle( 1, ['size' => 24, 'bold' => true, 'color' => '000099'], ['spaceBefore' => 0, 'spaceAfter' => 2] ); $section = $phpWord->addSection(); $element = $section->addTitle($textRun, 1); $elwrite = new RTF\Element\Title($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\sb0\\sa2{\\outlinelevel0{\\cf0\\f0\\fs48\\b base text (ruby)}\\par\n}"; self::assertEquals($expect, $this->removeCr($elwrite)); } } ================================================ FILE: tests/PhpWordTests/Writer/RTF/HeaderFooterTest.php ================================================ addSection(); $section->addText('Doc without header or footer'); $contents = $parentWriter->getWriterPart('Document')->write(); self::assertEquals(0, preg_match('/\\\\header[rlf]?\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\footer[rlf]?\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\titlepg\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\facingp\\b/', $contents)); } public function testNoHeaderYesFooter(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $parentWriter = new RTF($phpWord); $section = $phpWord->addSection(); $footer = $section->addFooter(); $footer->addText('Auto footer'); $section->addText('Doc without header but with footer'); $contents = $parentWriter->getWriterPart('Document')->write(); self::assertEquals(0, preg_match('/\\\\header[rlf]?\\b/', $contents)); self::assertEquals(1, preg_match('/\\\\footer[rlf]?\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\titlepg\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\facingp\\b/', $contents)); } public function testEvenHeaderFirstFooter(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $phpWord->getSettings()->setEvenAndOddHeaders(true); $parentWriter = new RTF($phpWord); $section = $phpWord->addSection(); $footer = $section->addFooter(Footer::FIRST); $footer->addText('First footer'); $footer = $section->addHeader(Footer::EVEN); $footer->addText('Even footer'); $footer = $section->addHeader(Footer::AUTO); $footer->addText('Odd footer'); $section->addText('Doc with even/odd header and first footer'); $contents = $parentWriter->getWriterPart('Document')->write(); self::assertEquals(1, preg_match('/\\\\headerr\\b/', $contents)); self::assertEquals(1, preg_match('/\\\\headerl\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\header[f]?\\b/', $contents)); self::assertEquals(1, preg_match('/\\\\footerf\\b/', $contents)); self::assertEquals(0, preg_match('/\\\\footer[rl]?\\b/', $contents)); self::assertEquals(1, preg_match('/\\\\titlepg\\b/', $contents)); self::assertEquals(1, preg_match('/\\\\facingp\\b/', $contents)); } } ================================================ FILE: tests/PhpWordTests/Writer/RTF/StyleTest.php ================================================ write()); } /** * Test empty styles. */ public function testEmptyStyles(): void { $styles = ['Font', 'Paragraph', 'Section', 'Tab', 'Indentation']; foreach ($styles as $style) { $objectClass = 'PhpOffice\\PhpWord\\Writer\\RTF\\Style\\' . $style; $object = new $objectClass(); self::assertEquals('', $object->write()); } } public function testBorderWithNonRegisteredColors(): void { $border = new Border(); $border->setSizes([1, 2, 3, 4]); $border->setColors(['#FF0000', '#FF0000', '#FF0000', '#FF0000']); $border->setSizes([20, 20, 20, 20]); $content = $border->write(); $expected = '\pgbrdropt32'; $expected .= '\pgbrdrt\brdrs\brdrw20\brdrcf0\brsp480 '; $expected .= '\pgbrdrl\brdrs\brdrw20\brdrcf0\brsp480 '; $expected .= '\pgbrdrr\brdrs\brdrw20\brdrcf0\brsp480 '; $expected .= '\pgbrdrb\brdrs\brdrw20\brdrcf0\brsp480 '; self::assertEquals($expected, $content); } public function testIndentation(): void { $indentation = new \PhpOffice\PhpWord\Style\Indentation(); $indentation->setLeft(1); $indentation->setRight(2); $indentation->setFirstLine(3); $indentWriter = new RTF\Style\Indentation($indentation); $indentWriter->setParentWriter(new RTF()); $result = $indentWriter->write(); Assert::assertEquals('\fi3\li1\ri2 ', $result); } public function testRightTab(): void { $tabRight = new \PhpOffice\PhpWord\Style\Tab(); $tabRight->setType(\PhpOffice\PhpWord\Style\Tab::TAB_STOP_RIGHT); $tabRight->setPosition(5); $tabWriter = new RTF\Style\Tab($tabRight); $tabWriter->setParentWriter(new RTF()); $result = $tabWriter->write(); Assert::assertEquals('\tqr\tx5', $result); } public function testCenterTab(): void { $tabRight = new \PhpOffice\PhpWord\Style\Tab(); $tabRight->setType(\PhpOffice\PhpWord\Style\Tab::TAB_STOP_CENTER); $tabWriter = new RTF\Style\Tab($tabRight); $tabWriter->setParentWriter(new RTF()); $result = $tabWriter->write(); Assert::assertEquals('\tqc\tx0', $result); } public function testDecimalTab(): void { $tabRight = new \PhpOffice\PhpWord\Style\Tab(); $tabRight->setType(\PhpOffice\PhpWord\Style\Tab::TAB_STOP_DECIMAL); $tabWriter = new RTF\Style\Tab($tabRight); $tabWriter->setParentWriter(new RTF()); $result = $tabWriter->write(); Assert::assertEquals('\tqdec\tx0', $result); } public function testRTL(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Text('אב גד', ['RTL' => true]); $text = new RTF\Element\Text($parentWriter, $element); $expect = "\\pard\\nowidctlpar {\\rtlch\\cf0\\f0 \\uc0{\\u1488}\\uc0{\\u1489} \\uc0{\\u1490}\\uc0{\\u1491}}\\par\n"; self::assertEquals($expect, $this->removeCr($text)); } public function testRTL2(): void { Settings::setDefaultRtl(true); $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Text('אב גד'); $text = new RTF\Element\Text($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\qr{\\rtlch\\cf0\\f0 \\uc0{\\u1488}\\uc0{\\u1489} \\uc0{\\u1490}\\uc0{\\u1491}}\\par\n"; self::assertEquals($expect, $this->removeCr($text)); } public function testPageBreakLineHeight(): void { $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Text('New page', null, ['lineHeight' => 1.08, 'pageBreakBefore' => true]); $text = new RTF\Element\Text($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\sl259\\slmult1\\page{\\cf0\\f0 New page}\\par\n"; self::assertEquals($expect, $this->removeCr($text)); } public function testPageBreakLineHeight2(): void { Settings::setDefaultRtl(false); $parentWriter = new RTF(); $element = new \PhpOffice\PhpWord\Element\Text('New page', null, ['lineHeight' => 1.08, 'pageBreakBefore' => true]); $text = new RTF\Element\Text($parentWriter, $element); $expect = "\\pard\\nowidctlpar \\ql\\sl259\\slmult1\\page{\\cf0\\f0 New page}\\par\n"; self::assertEquals($expect, $this->removeCr($text)); } public function testPageNumberRestart(): void { //$parentWriter = new RTF(); $phpword = new \PhpOffice\PhpWord\PhpWord(); $section = $phpword->addSection(['pageNumberingStart' => 5]); $styleWriter = new RTF\Style\Section($section->getStyle()); $wstyle = $this->removeCr($styleWriter); // following have default values which might change so don't use them $wstyle = preg_replace('/\\\\pgwsxn\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\pghsxn\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\margtsxn\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\margrsxn\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\margbsxn\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\marglsxn\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\headery\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\footery\\d+/', '', $wstyle); $wstyle = preg_replace('/\\\\guttersxn\\d+/', '', $wstyle); $wstyle = preg_replace('/ +/', ' ', $wstyle); $expect = "\\sectd \\pgnstarts5\\pgnrestart \n"; self::assertEquals($expect, $wstyle); } } ================================================ FILE: tests/PhpWordTests/Writer/RTFTest.php ================================================ getPhpWord()); } /** * Construct with null. */ public function testConstructWithNull(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('No PhpWord assigned.'); $object = new RTF(); $object->getPhpWord(); } /** * Save. */ public function testSave(): void { $imageSrc = __DIR__ . '/../_files/images/PhpWord.png'; $objectSrc = __DIR__ . '/../_files/documents/sheet.xls'; $file = __DIR__ . '/../_files/temp.rtf'; $phpWord = new PhpWord(); $phpWord->addFontStyle( 'Font', ['name' => 'Verdana', 'size' => 11, 'color' => 'FF0000', 'fgColor' => '00FF00'] ); $phpWord->addParagraphStyle('Paragraph', ['alignment' => Jc::CENTER]); $section = $phpWord->addSection(); $section->addText(htmlspecialchars('Test 1', ENT_COMPAT, 'UTF-8'), 'Font', 'Paragraph'); $section->addTextBreak(); $section->addText(htmlspecialchars('Test 2', ENT_COMPAT, 'UTF-8'), ['name' => 'Tahoma', 'bold' => true, 'italic' => true]); $section->addLink('https://github.com/PHPOffice/PHPWord'); $section->addTitle(htmlspecialchars('Test', ENT_COMPAT, 'UTF-8'), 1); $section->addPageBreak(); // Rowspan $table = $section->addTable(); $table->addRow()->addCell(null, ['vMerge' => 'restart'])->addText('Test'); $table->addRow()->addCell(null, ['vMerge' => 'continue'])->addText('Test'); // Nested table $cell = $section->addTable()->addRow()->addCell(); $cell->addTable()->addRow()->addCell(); $section->addListItem(htmlspecialchars('Test', ENT_COMPAT, 'UTF-8')); $section->addImage($imageSrc); $section->addObject($objectSrc); $section->addTOC(); $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText(htmlspecialchars('Test 3', ENT_COMPAT, 'UTF-8')); $textrun->addTextBreak(); $writer = new RTF($phpWord); $writer->save($file); self::assertFileExists($file); @unlink($file); } /** * Save. * * @todo Haven't got any method to test this */ public function testSavePhpOutput(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText(htmlspecialchars('Test', ENT_COMPAT, 'UTF-8')); $writer = new RTF($phpWord); ob_start(); $writer->save('php://output'); $contents = ob_get_contents(); self::assertTrue(ob_end_clean()); self::assertNotEmpty($contents); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/ChartTest.php ================================================ outputEscapingEnabled = Settings::isOutputEscapingEnabled(); } /** * Executed after each method of the class. */ protected function tearDown(): void { Settings::setOutputEscapingEnabled($this->outputEscapingEnabled); TestHelperDOCX::clear(); } /** * Test chart elements. */ public function testChartElements(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $style = [ 'width' => 5000000, 'height' => 5000000, 'showAxisLabels' => true, 'showGridX' => true, 'showGridY' => true, 'showLegend' => false, ]; $chartTypes = ['pie', 'doughnut', 'bar', 'line', 'area', 'scatter', 'radar']; $categories = ['A', 'B', 'C', 'D', 'E']; $series1 = [1, 3, 2, 5, 4]; foreach ($chartTypes as $chartType) { $section->addChart($chartType, $categories, $series1, $style); } $colorArray = ['FFFFFF', '000000', 'FF0000', '00FF00', '0000FF']; $numColor = count($colorArray); $chart = $section->addChart('pie', $categories, $series1, $style); $chart->getStyle()->setColors($colorArray)->setTitle('3d chart')->set3d(true); $chart = $section->addChart('stacked_bar', $categories, $series1, $style); $chart->getStyle()->setColors($colorArray)->setShowLegend(true); $chart = $section->addChart('scatter', $categories, $series1, $style); $chart->getStyle()->setMajorTickPosition('cross'); $section->addChart('scatter', $categories, $series1, $style, 'seriesname'); $doc = TestHelperDOCX::getDocument($phpWord); $index = 0; foreach ($chartTypes as $chartType) { ++$index; $file = "word/charts/chart{$index}.xml"; $path = "/c:chartSpace/c:chart/c:plotArea/c:{$chartType}Chart"; self::assertTrue($doc->elementExists($path, $file), "chart type $chartType"); } $index = 11; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'scatter'; $path = "/c:chartSpace/c:chart/c:plotArea/c:{$chartType}Chart"; self::assertEquals('seriesname', $doc->getElement($path . '/c:ser/c:tx/c:strRef/c:strCache/c:pt/c:v')->nodeValue); $index = 8; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'pie3D'; $path = "/c:chartSpace/c:chart/c:plotArea/c:{$chartType}Chart"; for ($idx = 0; $idx < $numColor; ++$idx) { $idxp1 = $idx + 1; $element = $path . "/c:ser/c:dPt[$idxp1]/c:spPr/a:solidFill/a:srgbClr"; self::assertEquals($colorArray[$idx], $doc->getElementAttribute($element, 'val'), "pie3d chart idx=$idx"); } $index = 9; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'bar'; $path = "/c:chartSpace/c:chart/c:plotArea/c:{$chartType}Chart"; for ($idxp1 = 1; $idxp1 < $numColor; ++$idxp1) { $idx = $idxp1; // stacked bar chart is shifted $element = $path . "/c:ser/c:dPt[$idxp1]/c:spPr/a:solidFill/a:srgbClr"; self::assertEquals($colorArray[$idx - 1], $doc->getElementAttribute($element, 'val'), "bar chart idx=$idx"); } } public function testChartEscapingEnabled(): void { Settings::setOutputEscapingEnabled(true); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $style = [ 'width' => 5000000, 'height' => 5000000, 'showAxisLabels' => true, 'showGridX' => true, 'showGridY' => true, 'showLegend' => false, 'valueAxisTitle' => 'Values', ]; $categories = ['A&B', 'C', 'E', 'F', 'G']; $series1 = [1, 3, 2, 5, 4]; $section->addChart('bar', $categories, $series1, $style); $doc = TestHelperDOCX::getDocument($phpWord); $index = 1; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'bar'; $path = "/c:chartSpace/c:chart/c:plotArea/c:{$chartType}Chart/c:ser/c:cat/c:strLit"; $element = "$path/c:pt[1]/c:v"; self::assertEquals('A&B', $doc->getElement($element)->nodeValue); $element = "$path/c:pt[2]/c:v"; self::assertEquals('C', $doc->getElement($element)->nodeValue); } public function testChartEscapingDisabled(): void { Settings::setOutputEscapingEnabled(false); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $style = [ 'width' => 5000000, 'height' => 5000000, 'showAxisLabels' => true, 'showGridX' => true, 'showGridY' => true, 'showLegend' => false, 'valueAxisTitle' => 'Values', ]; $categories = ['A&B', 'C<D>', 'E', 'F', 'G']; $series1 = [1, 3, 2, 5, 4]; $section->addChart('bar', $categories, $series1, $style); $doc = TestHelperDOCX::getDocument($phpWord); $index = 1; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'bar'; $path = "/c:chartSpace/c:chart/c:plotArea/c:{$chartType}Chart/c:ser/c:cat/c:strLit"; $element = "$path/c:pt[1]/c:v"; self::assertEquals('A&B', $doc->getElement($element)->nodeValue); $element = "$path/c:pt[2]/c:v"; self::assertEquals('C', $doc->getElement($element)->nodeValue); } public function testValueAxisTitle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $style = [ 'width' => 5000000, 'height' => 5000000, 'showAxisLabels' => true, 'showGridX' => true, 'showGridY' => true, 'showLegend' => false, 'valueAxisTitle' => 'Values', ]; $chartType = 'line'; $categories = ['A', 'B', 'C', 'D', 'E']; $series1 = [1, 3, 2, 5, 4]; $section->addChart($chartType, $categories, $series1, $style); $doc = TestHelperDOCX::getDocument($phpWord); $index = 1; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'line'; $path = '/c:chartSpace/c:chart/c:plotArea'; $element = "$path/c:{$chartType}Chart"; self::assertTrue($doc->elementExists($path)); $element = "$path/c:valAx"; self::assertTrue($doc->elementExists($element)); $element .= '/c:title/c:tx/c:rich/a:p/a:r/a:t'; self::assertEquals('Values', $doc->getElement($element)->nodeValue); } public function testNoAxisLabels(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $style = [ 'width' => 5000000, 'height' => 5000000, 'showAxisLabels' => false, 'showGridX' => true, 'showGridY' => true, 'showLegend' => false, 'valueAxisTitle' => 'Values', ]; $chartType = 'line'; $categories = ['A', 'B', 'C', 'D', 'E']; $series1 = [1, 3, 2, 5, 4]; $section->addChart($chartType, $categories, $series1, $style); $doc = TestHelperDOCX::getDocument($phpWord); $index = 1; $file = "word/charts/chart{$index}.xml"; $doc->setDefaultFile($file); $chartType = 'line'; $path = '/c:chartSpace/c:chart/c:plotArea'; $element = "$path/c:{$chartType}Chart"; $element = "$path/c:valAx"; $element .= '/c:tickLblPos'; self::assertEquals('none', $doc->getElementAttribute($element, 'val')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/FieldTest.php ================================================ addSection(); $section->addField( 'REF', [ 'name' => 'my-bookmark', ], [ 'InsertParagraphNumberRelativeContext', 'CreateHyperLink', ] ); $section->addListItem('line one item'); $section->addListItem('line two item'); $section->addBookmark('my-bookmark'); $section->addListItem('line three item'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $refFieldPath = '/w:document/w:body/w:p[1]/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($refFieldPath)); $bookMarkElement = $doc->getElement($refFieldPath); self::assertNotNull($bookMarkElement); self::assertEquals(' REF my-bookmark \r \h ', $bookMarkElement->textContent); $bookmarkPath = '/w:document/w:body/w:bookmarkStart'; self::assertTrue($doc->elementExists($bookmarkPath)); self::assertEquals('my-bookmark', $doc->getElementAttribute("$bookmarkPath", 'w:name')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/FormFieldTest.php ================================================ addSection(); $section->addFormField('textinput')->setName('MyTextBox'); $section->addFormField('checkbox')->setDefault(true)->setValue('Your name'); $section->addFormField('checkbox')->setDefault(true); $section->addFormField('dropdown')->setEntries(['Choice 1', 'Choice 2', 'Choice 3', '']); $doc = TestHelperDOCX::getDocument($phpWord); $path = '/w:document/w:body/w:p[1]/w:r/w:fldChar/w:ffData'; self::assertTrue($doc->elementExists("$path/w:textInput")); self::assertEquals('MyTextBox', $doc->getElementAttribute("$path/w:name", 'w:val')); $path = '/w:document/w:body/w:p[2]/w:r/w:fldChar/w:ffData'; self::assertTrue($doc->elementExists("$path/w:checkBox")); $path = '/w:document/w:body/w:p[2]/w:r[4]/w:t'; self::assertEquals('Your name', $doc->getElement($path)->textContent); $path = '/w:document/w:body/w:p[3]/w:r/w:fldChar/w:ffData'; self::assertTrue($doc->elementExists("$path/w:checkBox")); $path = '/w:document/w:body/w:p[4]/w:r/w:fldChar/w:ffData/w:ddList'; self::assertTrue($doc->elementExists($path)); self::assertEquals('Choice 1', $doc->getElementAttribute("$path/w:listEntry[1]", 'w:val')); self::assertEquals('Choice 2', $doc->getElementAttribute("$path/w:listEntry[2]", 'w:val')); self::assertEquals('Choice 3', $doc->getElementAttribute("$path/w:listEntry[3]", 'w:val')); self::assertEquals('', trim($doc->getElementAttribute("$path/w:listEntry[4]", 'w:val'), ' ')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/FormulaTest.php ================================================ add( new Element\Fraction( new Element\Numeric(2), new Element\Identifier('π') ) ) ->add( new Element\Operator('+') ) ->add( new Element\Identifier('a') ) ->add( new Element\Operator('∗') ) ->add( new Element\Numeric(2) ); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addFormula($math); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/m:oMathPara')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/m:oMathPara/m:oMath')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/TOCTest.php ================================================ addSection(); $section->addTOC(); $section->addTitle('TestTitle 1', 1, $expectedPageNum); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:hyperlink/w:r[1]/w:t')); self::assertEquals('TestTitle 1', $doc->getElement('/w:document/w:body/w:p[1]/w:hyperlink/w:r[1]/w:t')->textContent); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:hyperlink/w:r[5]/w:fldChar')); self::assertEquals('separate', $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:hyperlink/w:r[5]/w:fldChar', 'w:fldCharType')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:hyperlink/w:r[6]/w:t')); self::assertEquals($expectedPageNum, $doc->getElement('/w:document/w:body/w:p[1]/w:hyperlink/w:r[6]/w:t')->textContent); } public function testWriteTitleWithoutpageNumber(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addTOC(); $staticHtml = '

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor. Cras elementum ultrices diam. Maecenas ligula massa, varius a, semper congue, euismod non, mi.

    Proin porttitor, orci nec nonummy molestie, enim est eleifend mi, non fermentum diam nisl sit amet erat. Duis semper. Duis arcu massa, scelerisque vitae, consequat in, pretium a, enim.

    '; //more than one title and random text for create more than one page for ($i = 1; $i <= 10; ++$i) { $section->addTitle('Title ' . $i, 1); \PhpOffice\PhpWord\Shared\Html::addHtml($section, $staticHtml, false, false); $section->addPageBreak(); } $doc = TestHelperDOCX::getDocument($phpWord); for ($i = 1; $i <= 10; ++$i) { self::assertTrue($doc->elementExists('/w:document/w:body/w:p[' . $i . ']/w:hyperlink/w:r[1]/w:t')); self::assertEquals('Title ' . $i, $doc->getElement('/w:document/w:body/w:p[' . $i . ']/w:hyperlink/w:r[1]/w:t')->textContent); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[' . $i . ']/w:hyperlink/w:r[4]/w:instrText')); self::assertEquals('preserve', $doc->getElementAttribute('/w:document/w:body/w:p[' . $i . ']/w:hyperlink/w:r[4]/w:instrText', 'xml:space')); self::assertEquals('PAGEREF ' . ($i - 1) . ' \\h', $doc->getElement('/w:document/w:body/w:p[' . $i . ']/w:hyperlink/w:r[4]/w:instrText')->nodeValue); } } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/TableTest.php ================================================ addSection(); $section->addText('Before table (normal).'); $table = $section->addTable(['width' => 5000, 'unit' => TblWidth::PERCENT]); $row = $table->addRow(); $tc = $table->addCell(); $tc->addText('R1C1'); $tc = $table->addCell(); $tc->addText('R1C2'); $row = $table->addRow(); $tc = $table->addCell(); $tc->addText('R2C1'); $tc = $table->addCell(); $tc->addText('R2C2'); $row = $table->addRow(); $tc = $table->addCell(); $tc->addText('R3C1'); $tc = $table->addCell(); $tc->addText('R3C2'); $section->addText('After table.'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl[2]'), 'should be only 1 table'); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[3]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]/w:tc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]/w:tc[2]')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]/w:tc[3]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]/w:tc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]/w:tc[2]')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]/w:tc[3]')); } public static function testSomeRowWithNoCells(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Before table (row 2 has no cells).'); $table = $section->addTable(['width' => 5000, 'unit' => TblWidth::PERCENT]); $row = $table->addRow(); $tc = $table->addCell(); $tc->addText('R1C1'); $tc = $table->addCell(); $tc->addText('R1C2'); $row = $table->addRow(); $row = $table->addRow(); $tc = $table->addCell(); $tc->addText('R3C1'); $tc = $table->addCell(); $tc->addText('R3C2'); $section->addText('After table.'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl[2]'), 'should be only 1 table'); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[3]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]/w:tc')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]/w:tc[2]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]/w:tc')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]/w:tc[2]')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[3]/w:tc[3]')); } public static function testOnly1RowWithNoCells(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Before table (only 1 row and it has no cells).'); $table = $section->addTable(['width' => 5000, 'unit' => TblWidth::PERCENT]); $row = $table->addRow(); $section->addText('After table.'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl[2]'), 'only 1 table should be written'); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[1]/w:tc[2]')); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl/w:tr[2]')); } public static function testNoRows(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Before table (no rows therefore omitted).'); $table = $section->addTable(['width' => 5000, 'unit' => TblWidth::PERCENT]); $section->addText('After table.'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertFalse($doc->elementExists('/w:document/w:body/w:tbl[1]'), 'no table should be written'); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/TextBoxTest.php ================================================ setBgColor($bgColor); } if ($borderColor !== null) { $style->setBorderColor($borderColor); } $textBoxElement = new TextBoxElement($style); $textBox = new TextBox($xmlWriter, $textBoxElement); // Act $textBox->write(); $output = $xmlWriter->getData(); // Assert self::assertStringContainsString($expectedFillColorAttribute, $output, 'Background color should be applied.'); self::assertStringContainsString($expectedBorderColorAttribute, $output, 'Border color should be applied correctly.'); } /** * Data provider for testing different combinations of background and border colors. */ public static function textBoxColorProvider(): array { return [ // Case 1: Background color set, border color set 'With both colors' => [ '#FF0000', '#000000', 'fillcolor="#FF0000"', 'stroke color="#000000"', ], // Case 2: Background color set, no border color 'With background only' => [ '#00FF00', null, 'fillcolor="#00FF00"', 'stroked="f" strokecolor="white"', ], // Case 3: No background color, border color set 'With border only' => [ null, '#123456', 'filled="f"', 'stroke color="#123456"', ], // Case 4: Neither background nor border color set 'Without any colors' => [ null, null, 'filled="f"', 'stroked="f" strokecolor="white"', ], ]; } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Element/TitleTest.php ================================================ addTitleStyle(0, ['size' => 14, 'italic' => true]); $section = $phpWord->addSection(); $section->addTitle('Test Title0', 0); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:t')); self::assertEquals('Test Title0', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->textContent); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:pPr/w:pStyle')); self::assertEquals('Title', $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:pStyle', 'w:val')); } public function testWriteTitleWithoutStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addTitle('Test Title0', 0); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:t')); self::assertEquals('Test Title0', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->textContent); self::assertFalse($doc->elementExists('/w:document/w:body/w:p[1]/w:pPr')); } public function testWriteHeadingWithStyle(): void { $phpWord = new PhpWord(); $phpWord->addTitleStyle(1, ['bold' => true], ['spaceAfter' => 240]); $section = $phpWord->addSection(); $section->addTitle('TestHeading 1', 1); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:t')); self::assertEquals('TestHeading 1', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->textContent); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:pPr/w:pStyle')); self::assertEquals('Heading1', $doc->getElementAttribute('/w:document/w:body/w:p[1]/w:pPr/w:pStyle', 'w:val')); } public function testWriteHeadingWithoutStyle(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addTitle('TestHeading 1', 1); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p[1]/w:r/w:t')); self::assertEquals('TestHeading 1', $doc->getElement('/w:document/w:body/w:p[1]/w:r/w:t')->textContent); self::assertFalse($doc->elementExists('/w:document/w:body/w:p[1]/w:pPr')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/ElementTest.php ================================================ write(); self::assertEquals('', $xmlWriter->getData()); } } /** * Test line element. */ public function testLineElement(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addLine(['width' => 1000, 'height' => 1000, 'positioning' => 'absolute', 'flip' => true]); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r/w:pict/v:shapetype'; self::assertTrue($doc->elementExists($element)); } /** * Test bookmark element. */ public function testBookmark(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addBookmark('test_bookmark'); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:bookmarkStart'; self::assertTrue($doc->elementExists($element)); self::assertEquals('test_bookmark', $doc->getElementAttribute($element, 'w:name')); $element = '/w:document/w:body/w:bookmarkEnd'; self::assertTrue($doc->elementExists($element)); } /** * Test link element. */ public function testLinkElement(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addLink('https://github.com/PHPOffice/PHPWord'); $section->addLink('internal_link', null, null, null, true); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p[1]/w:hyperlink/w:r/w:t'; self::assertTrue($doc->elementExists($element)); $element = '/w:document/w:body/w:p[2]/w:hyperlink/w:r/w:t'; self::assertTrue($doc->elementExists($element)); self::assertEquals('internal_link', $doc->getElementAttribute('/w:document/w:body/w:p[2]/w:hyperlink', 'w:anchor')); } /** * Basic test for table element. */ public function testTableElements(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(['alignment' => \PhpOffice\PhpWord\SimpleType\JcTable::CENTER]); $table->addRow(900); $table->addCell(2000)->addText('Row 1'); $table->addCell(2000)->addText('Row 2'); $table->addCell(2000)->addText('Row 3'); $table->addCell(2000)->addText('Row 4'); $doc = TestHelperDOCX::getDocument($phpWord); $tableRootElement = '/w:document/w:body/w:tbl'; self::assertTrue($doc->elementExists($tableRootElement . '/w:tblGrid/w:gridCol')); self::assertTrue($doc->elementExists($tableRootElement . '/w:tblPr/w:jc')); self::assertEquals('center', $doc->getElementAttribute($tableRootElement . '/w:tblPr/w:jc', 'w:val')); } /** * Tests that the style name gets added. */ public function testTableWithStyleName(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable('my_predefined_style'); $table->setWidth(75); $table->addRow(900); $doc = TestHelperDOCX::getDocument($phpWord); $tableRootElement = '/w:document/w:body/w:tbl'; self::assertTrue($doc->elementExists($tableRootElement . '/w:tblPr/w:tblStyle')); self::assertEquals('my_predefined_style', $doc->getElementAttribute($tableRootElement . '/w:tblPr/w:tblStyle', 'w:val')); } /** * Test shape elements. */ public function testShapeElements(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); // Arc $section->addShape( 'arc', [ 'points' => '-90 20', 'frame' => ['width' => 120, 'height' => 120], 'outline' => ['color' => '#333333', 'weight' => 2, 'startArrow' => 'oval', 'endArrow' => 'open'], ] ); // Curve $section->addShape( 'curve', [ 'points' => '1,100 200,1 1,50 200,50', 'connector' => 'elbow', 'outline' => [ 'color' => '#66cc00', 'weight' => 2, 'dash' => 'dash', 'startArrow' => 'diamond', 'endArrow' => 'block', ], ] ); // Line $section->addShape( 'line', [ 'points' => '1,1 150,30', 'outline' => [ 'color' => '#cc00ff', 'line' => 'thickThin', 'weight' => 3, 'startArrow' => 'oval', 'endArrow' => 'classic', 'endCap' => 'round', ], ] ); // Polyline $section->addShape( 'polyline', [ 'points' => '1,30 20,10 55,20 75,10 100,40 115,50, 120,15 200,50', 'outline' => [ 'color' => '#cc6666', 'weight' => 2, 'startArrow' => 'none', 'endArrow' => 'classic', ], ] ); // Rectangle $section->addShape( 'rect', [ 'roundness' => 0.2, 'frame' => ['width' => 100, 'height' => 100, 'left' => 1, 'top' => 1], 'fill' => ['color' => '#FFCC33'], 'outline' => ['color' => '#990000', 'weight' => 1], 'shadow' => ['color' => '#EEEEEE', 'offset' => '3pt,3pt'], ] ); // Oval $section->addShape( 'oval', [ 'frame' => ['width' => 100, 'height' => 70, 'left' => 1, 'top' => 1], 'fill' => ['color' => '#33CC99'], 'outline' => ['color' => '#333333', 'weight' => 2], 'extrusion' => ['type' => 'perspective', 'color' => '#EEEEEE'], ] ); $doc = TestHelperDOCX::getDocument($phpWord); $elements = ['arc', 'curve', 'line', 'polyline', 'roundrect', 'oval']; foreach ($elements as $element) { $path = "/w:document/w:body/w:p/w:r/w:pict/v:{$element}"; self::assertTrue($doc->elementExists($path)); } } // testChartElements moved to Writer/Word2007/Element/ChartTest public function testFieldElement(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addField('INDEX', [], ['\\c "3"']); $section->addField('XE', [], ['Bold', 'Italic'], 'Index Entry'); $section->addField('DATE', ['dateformat' => 'd-M-yyyy'], ['PreserveFormat', 'LastUsedFormat']); $section->addField('DATE', [], ['LunarCalendar']); $section->addField('DATE', [], ['SakaEraCalendar']); $section->addField('NUMPAGES', ['format' => 'roman', 'numformat' => '0,00'], ['SakaEraCalendar']); $section->addField('STYLEREF', ['StyleIdentifier' => 'Heading 1']); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' INDEX \\c "3" ', $doc->getElement($element)->textContent); } public function testUnstyledFieldElement(): void { $phpWord = new PhpWord(); $phpWord->addFontStyle('h1', ['name' => 'Courier New', 'size' => 8]); $section = $phpWord->addSection(); $section->addField('PAGE'); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' PAGE ', $doc->getElement($element)->textContent); $sty = '/w:document/w:body/w:p/w:r[2]/w:rPr'; self::assertFalse($doc->elementExists($sty)); } public function testStyledFieldElement(): void { $phpWord = new PhpWord(); $stnam = 'h1'; $phpWord->addFontStyle($stnam, ['name' => 'Courier New', 'size' => 8]); $section = $phpWord->addSection(); $fld = $section->addField('PAGE'); $fld->setFontStyle($stnam); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' PAGE ', $doc->getElement($element)->textContent); $sty = '/w:document/w:body/w:p/w:r[2]/w:rPr'; self::assertTrue($doc->elementExists($sty)); self::assertEquals($stnam, $doc->getElementAttribute($sty . '/w:rStyle', 'w:val')); } public function testFieldElementFilename(): void { $phpWord = new PhpWord(); $stnam = 'h1'; $phpWord->addFontStyle($stnam, ['name' => 'Courier New', 'size' => 8]); $section = $phpWord->addSection(); $fld = $section->addField('FILENAME'); $fld->setFontStyle($stnam); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' FILENAME ', $doc->getElement($element)->textContent); $sty = '/w:document/w:body/w:p/w:r[2]/w:rPr'; self::assertTrue($doc->elementExists($sty)); self::assertEquals($stnam, $doc->getElementAttribute($sty . '/w:rStyle', 'w:val')); } public function testFieldElementFilenameOptionsPath(): void { $phpWord = new PhpWord(); $stnam = 'h1'; $phpWord->addFontStyle($stnam, ['name' => 'Courier New', 'size' => 8]); $section = $phpWord->addSection(); $fld = $section->addField('FILENAME', [], ['Path']); $fld->setFontStyle($stnam); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' FILENAME \p ', $doc->getElement($element)->textContent); $sty = '/w:document/w:body/w:p/w:r[2]/w:rPr'; self::assertTrue($doc->elementExists($sty)); self::assertEquals($stnam, $doc->getElementAttribute($sty . '/w:rStyle', 'w:val')); } public function testFieldElementWithComplexText(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $text = new TextRun(); $text->addText('test string', ['bold' => true]); $section->addField('XE', [], ['Bold', 'Italic'], $text); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' XE "', $doc->getElement($element)->textContent); $element = '/w:document/w:body/w:p/w:r[3]/w:rPr/w:b'; self::assertTrue($doc->elementExists($element)); $element = '/w:document/w:body/w:p/w:r[3]/w:t'; self::assertTrue($doc->elementExists($element)); self::assertEquals('test string', $doc->getElement($element)->textContent); $element = '/w:document/w:body/w:p/w:r[4]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals('"\\b \\i ', $doc->getElement($element)->textContent); } /** * Test writing the macrobutton field. */ public function testMacroButtonField(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $macroText = new TextRun(); $macroText->addText('Double click', ['bold' => true]); $macroText->addText(' to '); $macroText->addText('zoom to 100%', ['italic' => true]); $section->addField('MACROBUTTON', ['macroname' => 'Zoom100'], [], $macroText); $section->addField('MACROBUTTON', ['macroname' => 'Zoom100'], [], 'double click to zoom'); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p[1]/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' MACROBUTTON Zoom100 ', $doc->getElement($element)->textContent); $element = '/w:document/w:body/w:p[1]/w:r[3]/'; self::assertTrue($doc->elementExists($element . 'w:t')); self::assertEquals('Double click', $doc->getElement($element . 'w:t')->textContent); self::assertTrue($doc->elementExists($element . 'w:rPr/w:b')); $element = '/w:document/w:body/w:p[2]/w:r[2]/w:instrText'; self::assertTrue($doc->elementExists($element)); self::assertEquals(' MACROBUTTON Zoom100 double click to zoom ', $doc->getElement($element)->textContent); } // testFormFieldElements moved to Writer/Word2007/Element/FormFieldTest /** * Test SDT elements. */ public function testSDTElements(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addSDT('comboBox')->setListItems(['1' => 'Choice 1', '2' => 'Choice 2'])->setValue('select value'); $section->addSDT('dropDownList'); $section->addSDT('date')->setAlias('date_alias')->setTag('my_tag'); $section->addSDT('plainText'); $doc = TestHelperDOCX::getDocument($phpWord); $path = '/w:document/w:body/w:p'; self::assertTrue($doc->elementExists($path . '[1]/w:sdt/w:sdtContent/w:r/w:t')); self::assertEquals('select value', $doc->getElement($path . '[1]/w:sdt/w:sdtContent/w:r/w:t')->nodeValue); self::assertTrue($doc->elementExists($path . '[1]/w:sdt/w:sdtPr/w:comboBox')); self::assertTrue($doc->elementExists($path . '[1]/w:sdt/w:sdtPr/w:comboBox/w:listItem')); self::assertEquals('1', $doc->getElementAttribute($path . '[1]/w:sdt/w:sdtPr/w:comboBox/w:listItem[1]', 'w:value')); self::assertEquals('Choice 1', $doc->getElementAttribute($path . '[1]/w:sdt/w:sdtPr/w:comboBox/w:listItem[1]', 'w:displayText')); self::assertTrue($doc->elementExists($path . '[2]/w:sdt/w:sdtPr/w:dropDownList')); self::assertFalse($doc->elementExists($path . '[2]/w:sdt/w:sdtPr/w:alias')); self::assertTrue($doc->elementExists($path . '[3]/w:sdt/w:sdtPr/w:date')); self::assertTrue($doc->elementExists($path . '[3]/w:sdt/w:sdtPr/w:alias')); self::assertTrue($doc->elementExists($path . '[3]/w:sdt/w:sdtPr/w:tag')); self::assertTrue($doc->elementExists($path . '[4]/w:sdt/w:sdtPr/w:text')); } /** * Test Comment element. */ public function testCommentWithoutEndElement(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $comment = new Comment('tester'); $phpWord->addComment($comment); $element = $section->addText('this is a test'); $element->setCommentRangeStart($comment); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:commentRangeStart')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:commentRangeEnd')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:commentReference')); } /** * Test Comment element. */ public function testCommentWithEndElement(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $comment = new Comment('tester'); $phpWord->addComment($comment); $element = $section->addText('this is a test'); $element->setCommentRangeStart($comment); $element->setCommentRangeEnd($comment); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:commentRangeStart')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:commentRangeEnd')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:commentReference')); } /** * Test Track changes. */ public function testTrackChange(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $text = $section->addText('my dummy text'); $text->setChangeInfo(TrackChange::INSERTED, 'author name'); $text2 = $section->addText('my other text'); $text2->setTrackChange(new TrackChange(TrackChange::DELETED, 'another author', new DateTime())); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:ins/w:r')); self::assertEquals('author name', $doc->getElementAttribute('/w:document/w:body/w:p/w:ins', 'w:author')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:del/w:r/w:delText')); } /** * Test correct writing of text with ampersant in it. */ public function testTextWithAmpersant(): void { \PhpOffice\PhpWord\Settings::setOutputEscapingEnabled(true); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('this text contains an & (ampersant)'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:t')); self::assertEquals('this text contains an & (ampersant)', $doc->getElement('/w:document/w:body/w:p/w:r/w:t')->nodeValue); } /** * Test ListItemRun paragraph style writing. */ public function testListItemRunStyleWriting(): void { $phpWord = new PhpWord(); $phpWord->addParagraphStyle('MyParagraphStyle', ['spaceBefore' => 400]); $section = $phpWord->addSection(); $listItemRun = $section->addListItemRun(0, null, 'MyParagraphStyle'); $listItemRun->addText('List item'); $listItemRun->addText(' in bold', ['bold' => true]); $doc = TestHelperDOCX::getDocument($phpWord); self::assertFalse($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:pPr')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:pStyle')); self::assertEquals('List item', $doc->getElement('/w:document/w:body/w:p/w:r[1]/w:t')->nodeValue); self::assertEquals(' in bold', $doc->getElement('/w:document/w:body/w:p/w:r[2]/w:t')->nodeValue); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r[2]/w:rPr/w:b')); } /** * Test Ruby writing. */ public function testRubyWriting(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $section->addRuby($baseTextRun, $rubyTextRun, $properties); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby')); // check props self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr')); self::assertEquals( RubyProperties::ALIGNMENT_RIGHT_VERTICAL, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:rubyAlign', 'w:val') ); self::assertEquals( 10, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hps', 'w:val') ); self::assertEquals( 4, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hpsRaise', 'w:val') ); self::assertEquals( 18, $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hpsBaseText', 'w:val') ); self::assertEquals( 'ja-JP', $doc->getElementAttribute('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:lid', 'w:val') ); // check ruby text self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rt/w:r/w:t')); self::assertEquals( 'わたし', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rt/w:r/w:t')->nodeValue ); // check base text self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyBase/w:r/w:t')); self::assertEquals( '私', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyBase/w:r/w:t')->nodeValue ); } /** * Test Ruby title writing. */ public function testRubyTitleWriting(): void { $phpWord = new PhpWord(); $phpWord->addTitleStyle(1, ['name' => 'Arial', 'size' => 24, 'bold' => true, 'color' => '990000']); $section = $phpWord->addSection(); $properties = new RubyProperties(); $properties->setAlignment(RubyProperties::ALIGNMENT_RIGHT_VERTICAL); $properties->setFontFaceSize(10); $properties->setFontPointsAboveBaseText(4); $properties->setFontSizeForBaseText(18); $properties->setLanguageId('ja-JP'); $baseTextRun = new TextRun(null); $baseTextRun->addText('私'); $rubyTextRun = new TextRun(null); $rubyTextRun->addText('わたし'); $textRun = new TextRun(); $textRun->addRuby($baseTextRun, $rubyTextRun, $properties); $section->addTitle($textRun, 1); $doc = TestHelperDOCX::getDocument($phpWord); // make sure style made it in self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:pPr/w:pStyle')); self::assertEquals( 'Heading1', $doc->getElement('/w:document/w:body/w:p/w:pPr/w:pStyle')->getAttribute('w:val') ); // check ruby props self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr')); self::assertEquals( RubyProperties::ALIGNMENT_RIGHT_VERTICAL, $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:rubyAlign')->getAttribute('w:val') ); self::assertEquals( 10, $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hps')->getAttribute('w:val') ); self::assertEquals( 4, $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hpsRaise')->getAttribute('w:val') ); self::assertEquals( 18, $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:hpsBaseText')->getAttribute('w:val') ); self::assertEquals( 'ja-JP', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyPr/w:lid')->getAttribute('w:val') ); // check ruby text self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rt/w:r/w:t')); self::assertEquals( 'わたし', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rt/w:r/w:t')->nodeValue ); // check base text self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:ruby/w:rubyBase/w:r/w:t')); self::assertEquals( '私', $doc->getElement('/w:document/w:body/w:p/w:r/w:ruby/w:rubyBase/w:r/w:t')->nodeValue ); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/AbstractPartTest.php ================================================ getMockForAbstractClass(Word2007\Part\AbstractPart::class); } else { /** @var Word2007\Part\AbstractPart $stub */ $stub = new class() extends Word2007\Part\AbstractPart { public function write(): string { return ''; } }; } $stub->setParentWriter(new Word2007()); self::assertEquals(new Word2007(), $stub->getParentWriter()); } /** * covers ::getParentWriter. */ public function testSetGetParentWriterNull(): void { $this->expectException(Exception::class); $this->expectExceptionMessage('No parent WriterInterface assigned.'); // @phpstan-ignore-next-line if (method_exists($this, 'getMockForAbstractClass')) { $stub = $this->getMockForAbstractClass(Word2007\Part\AbstractPart::class); } else { /** @var Word2007\Part\AbstractPart $stub */ $stub = new class() extends Word2007\Part\AbstractPart { public function write(): string { return ''; } }; } $stub->getParentWriter(); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/CommentsTest.php ================================================ addText('Test'); $phpWord = new PhpWord(); $phpWord->addComment($comment); $doc = TestHelperDOCX::getDocument($phpWord); $path = '/w:comments/w:comment'; $file = 'word/comments.xml'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertNotNull($element->getAttribute('w:id')); self::assertEquals('Authors name', $element->getAttribute('w:author')); self::assertEquals('my_initials', $element->getAttribute('w:initials')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/DocumentTest.php ================================================ getDocInfo(); $docInfo->setCustomProperty('key1', null); $docInfo->setCustomProperty('key2', true); $docInfo->setCustomProperty('key3', 3); $docInfo->setCustomProperty('key4', 4.4); $docInfo->setCustomProperty('key5', 'value5'); $docInfo->setCustomProperty('key6', new DateTime()); $docInfo->setCustomProperty('key7', time(), DocInfo::PROPERTY_TYPE_DATE); $doc = TestHelperDOCX::getDocument($phpWord); self::assertNotNull($doc); // $this->assertTrue($doc->elementExists('/Properties/property[name="key1"]/vt:lpwstr')); // $this->assertTrue($doc->elementExists('/Properties/property[name="key2"]/vt:bool')); // $this->assertTrue($doc->elementExists('/Properties/property[name="key3"]/vt:i4')); // $this->assertTrue($doc->elementExists('/Properties/property[name="key4"]/vt:r8')); // $this->assertTrue($doc->elementExists('/Properties/property[name="key5"]/vt:lpwstr')); } /** * Write end section page numbering. */ public function testWriteEndSectionPageNumbering(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addHeader(); $section->addHeader('first'); $style = $section->getStyle(); $style->setLandscape(); $style->setPageNumberingStart(2); $style->setBorderSize(240); $style->setBreakType('nextPage'); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:sectPr/w:pgNumType'); self::assertEquals(2, $element->getAttribute('w:start')); } /** * Write section footnote properties. */ public function testSectionFootnoteProperties(): void { $properties = new FootnoteProperties(); $properties->setPos(FootnoteProperties::POSITION_DOC_END); $properties->setNumFmt(NumberFormat::LOWER_ROMAN); $properties->setNumStart(1); $properties->setNumRestart(FootnoteProperties::RESTART_NUMBER_EACH_PAGE); $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->setFootnoteProperties($properties); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:sectPr/w:footnotePr/w:pos'); self::assertEquals(FootnoteProperties::POSITION_DOC_END, $element->getAttribute('w:val')); $element = $doc->getElement('/w:document/w:body/w:sectPr/w:footnotePr/w:numFmt'); self::assertEquals(NumberFormat::LOWER_ROMAN, $element->getAttribute('w:val')); $element = $doc->getElement('/w:document/w:body/w:sectPr/w:footnotePr/w:numStart'); self::assertEquals(1, $element->getAttribute('w:val')); $element = $doc->getElement('/w:document/w:body/w:sectPr/w:footnotePr/w:numRestart'); self::assertEquals(FootnoteProperties::RESTART_NUMBER_EACH_PAGE, $element->getAttribute('w:val')); } /** * Write elements. */ public function testElements(): void { $objectSrc = __DIR__ . '/../../../_files/documents/sheet.xls'; $phpWord = new PhpWord(); $phpWord->addTitleStyle(1, ['color' => '333333', 'bold' => true]); $phpWord->addTitleStyle(2, ['color' => '666666']); $section = $phpWord->addSection(); $section->addTOC(); $section->addPageBreak(); $section->addText('After page break.'); $section->addTitle('Title 1', 1); $section->addListItem('List Item 1', 0); $section->addListItem('List Item 2', 0); $section->addListItem('List Item 3', 0); $section = $phpWord->addSection(); $section->addTitle('Title 2', 2); $section->addObject($objectSrc); $section->addTextBox([]); $section->addTextBox( [ 'wrappingStyle' => 'square', 'positioning' => 'relative', 'posHorizontalRel' => 'margin', 'posVerticalRel' => 'margin', 'innerMargin' => 10, 'borderSize' => 1, 'borderColor' => '#FF0', ] ); $section->addTextBox(['wrappingStyle' => 'tight', 'positioning' => 'absolute', 'alignment' => Jc::CENTER]); $section->addListItemRun()->addText('List item run 1'); $section->addField( 'DATE', ['dateformat' => 'dddd d MMMM yyyy H:mm:ss'], ['PreserveFormat', 'LunarCalendar'] ); $section->addField( 'DATE', ['dateformat' => 'dddd d MMMM yyyy H:mm:ss'], ['PreserveFormat', 'SakaEraCalendar'] ); $section->addField( 'DATE', ['dateformat' => 'dddd d MMMM yyyy H:mm:ss'], ['PreserveFormat', 'LastUsedFormat'] ); $section->addField('PAGE', ['format' => 'ArabicDash']); $section->addLine( [ 'width' => 10, 'height' => 10, 'positioning' => 'absolute', 'beginArrow' => 'block', 'endArrow' => 'open', 'dash' => 'rounddot', 'weight' => 10, ] ); $doc = TestHelperDOCX::getDocument($phpWord); // TOC $element = $doc->getElement('/w:document/w:body/w:p[1]/w:pPr/w:tabs/w:tab'); self::assertEquals('right', $element->getAttribute('w:val')); self::assertEquals('dot', $element->getAttribute('w:leader')); self::assertEquals(9062, $element->getAttribute('w:pos')); // Page break $element = $doc->getElement('/w:document/w:body/w:p[4]/w:r/w:br'); self::assertEquals('page', $element->getAttribute('w:type')); // Title $element = $doc->getElement('/w:document/w:body/w:p[6]/w:pPr/w:pStyle'); self::assertEquals('Heading1', $element->getAttribute('w:val')); // List item $element = $doc->getElement('/w:document/w:body/w:p[7]/w:pPr/w:numPr/w:numId'); self::assertEquals(3, $element->getAttribute('w:val')); // Object $element = $doc->getElement('/w:document/w:body/w:p[12]/w:r/w:object/o:OLEObject'); self::assertEquals('Embed', $element->getAttribute('Type')); } /** * Write element with some styles. */ public function testElementStyles(): void { $objectSrc = __DIR__ . '/../../../_files/documents/sheet.xls'; $tabs = [new \PhpOffice\PhpWord\Style\Tab('right', 9090)]; $phpWord = new PhpWord(); $phpWord->addParagraphStyle( 'pStyle', [ 'alignment' => Jc::CENTER, 'tabs' => $tabs, 'shading' => ['fill' => 'FFFF99'], 'borderSize' => 4, ] ); // Style #1 $phpWord->addFontStyle( 'fStyle', [ 'size' => '20', 'bold' => true, 'allCaps' => true, 'scale' => 200, 'spacing' => 240, 'kerning' => 10, ] ); // Style #2 $phpWord->addTitleStyle(1, ['color' => '333333', 'doubleStrikethrough' => true]); // Style #3 $phpWord->addTableStyle('tStyle', ['borderSize' => 1]); $fontStyle = new Font('text', ['alignment' => Jc::CENTER]); $section = $phpWord->addSection(); $section->addListItem('List Item', 0, null, null, 'pStyle'); // Style #5 $section->addObject($objectSrc, ['alignment' => Jc::CENTER]); $section->addTOC($fontStyle); $section->addTitle('Title 1', 1); $section->addTOC('fStyle'); $table = $section->addTable('tStyle'); $table->setWidth(100); $doc = TestHelperDOCX::getDocument($phpWord); // List item $element = $doc->getElement('/w:document/w:body/w:p[1]/w:pPr/w:numPr/w:numId'); self::assertEquals(5, $element->getAttribute('w:val')); // Object $element = $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:object/o:OLEObject'); self::assertEquals('Embed', $element->getAttribute('Type')); // TOC $element = $doc->getElement('/w:document/w:body/w:p[3]/w:pPr/w:tabs/w:tab'); self::assertEquals('right', $element->getAttribute('w:val')); self::assertEquals('dot', $element->getAttribute('w:leader')); self::assertEquals(9062, $element->getAttribute('w:pos')); } /** * Test write text element. */ public function testWriteText(): void { $rStyle = 'rStyle'; $pStyle = 'pStyle'; $phpWord = new PhpWord(); $phpWord->addFontStyle($rStyle, ['bold' => true]); $phpWord->addParagraphStyle($pStyle, ['hanging' => 120, 'indent' => 120]); $section = $phpWord->addSection(); $section->addText('Test', $rStyle, $pStyle); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r/w:rPr/w:rStyle'; self::assertEquals($rStyle, $doc->getElementAttribute($element, 'w:val')); $element = '/w:document/w:body/w:p/w:pPr/w:pStyle'; self::assertEquals($pStyle, $doc->getElementAttribute($element, 'w:val')); } /** * Test write textrun element. */ public function testWriteTextRun(): void { $pStyle = 'pStyle'; $aStyle = ['alignment' => Jc::BOTH, 'spaceBefore' => 120, 'spaceAfter' => 120]; $imageSrc = __DIR__ . '/../../../_files/images/earth.jpg'; $phpWord = new PhpWord(); $phpWord->addParagraphStyle($pStyle, $aStyle); $section = $phpWord->addSection('Test'); $textrun = $section->addTextRun($pStyle); $textrun->addText('Test'); $textrun->addTextBreak(); $textrun = $section->addTextRun($aStyle); $textrun->addLink('https://github.com/PHPOffice/PHPWord'); $textrun->addImage($imageSrc, ['alignment' => Jc::CENTER]); $textrun->addFootnote(); $doc = TestHelperDOCX::getDocument($phpWord); $parent = '/w:document/w:body/w:p'; self::assertTrue($doc->elementExists("{$parent}/w:pPr/w:pStyle[@w:val='{$pStyle}']")); } /** * Test write link element. */ public function testWriteLink(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $fontStyleArray = ['bold' => true]; $fontStyleName = 'Font Style'; $paragraphStyleArray = ['alignment' => Jc::CENTER]; $paragraphStyleName = 'Paragraph Style'; $expected = 'PHPWord on GitHub'; $section->addLink('https://github.com/PHPOffice/PHPWord', $expected); $section->addLink('https://github.com/PHPOffice/PHPWord', 'Test', $fontStyleArray, $paragraphStyleArray); $section->addLink('https://github.com/PHPOffice/PHPWord', 'Test', $fontStyleName, $paragraphStyleName); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:p/w:hyperlink/w:r/w:t'); self::assertEquals($expected, $element->nodeValue); } /** * Test write preserve text element. */ public function testWritePreserveText(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $footer = $section->addFooter(); $fontStyleArray = ['bold' => true]; $fontStyleName = 'Font'; $paragraphStyleArray = ['alignment' => Jc::END]; $paragraphStyleName = 'Paragraph'; $footer->addPreserveText('Page {PAGE}'); $footer->addPreserveText('{PAGE}', $fontStyleArray, $paragraphStyleArray); $footer->addPreserveText('{PAGE}', $fontStyleName, $paragraphStyleName); $doc = TestHelperDOCX::getDocument($phpWord); $preserve = $doc->getElement('w:p/w:r[2]/w:instrText', 'word/footer1.xml'); self::assertEquals('PAGE', $preserve->nodeValue); self::assertEquals('preserve', $preserve->getAttribute('xml:space')); } /** * Test write text break. */ public function testWriteTextBreak(): void { $fArray = ['size' => 12]; $pArray = ['spacing' => 240]; $fName = 'fStyle'; $pName = 'pStyle'; $phpWord = new PhpWord(); $phpWord->addFontStyle($fName, $fArray); $phpWord->addParagraphStyle($pName, $pArray); $section = $phpWord->addSection(); $section->addTextBreak(); $section->addTextBreak(1, $fArray, $pArray); $section->addTextBreak(1, $fName, $pName); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:p/w:pPr/w:rPr/w:rStyle'); self::assertEquals($fName, $element->getAttribute('w:val')); $element = $doc->getElement('/w:document/w:body/w:p/w:pPr/w:pStyle'); self::assertEquals($pName, $element->getAttribute('w:val')); } /** * covers ::_writeImage. */ public function testWriteImage(): void { $phpWord = new PhpWord(); $styles = ['alignment' => Jc::START, 'width' => 40, 'height' => 40, 'marginTop' => -1, 'marginLeft' => -1]; $wraps = ['inline', 'behind', 'infront', 'square', 'tight']; $section = $phpWord->addSection(); foreach ($wraps as $wrap) { $styles['wrappingStyle'] = $wrap; $section->addImage(__DIR__ . '/../../../_files/images/earth.jpg', $styles); } $archiveFile = realpath(__DIR__ . '/../../../_files/documents/reader.docx'); $imageFile = 'word/media/image1.jpeg'; $source = 'zip://' . $archiveFile . '#' . $imageFile; $section->addImage($source); $doc = TestHelperDOCX::getDocument($phpWord); // behind $element = $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:pict/v:shape'); $style = $element->getAttribute('style'); // @phpstan-ignore-next-line if (method_exists(self::class, 'assertMatchesRegularExpression')) { self::assertMatchesRegularExpression('/z\-index:\-[0-9]*/', $style); } elseif (method_exists(self::class, 'assertRegExp')) { // @phpstan-ignore-line self::assertRegExp('/z\-index:\-[0-9]*/', $style); } else { self::fail('Unsure how to test regexp'); } // square $element = $doc->getElement('/w:document/w:body/w:p[4]/w:r/w:pict/v:shape/w10:wrap'); self::assertEquals('square', $element->getAttribute('type')); } /** * covers ::_writeWatermark. */ public function testWriteWatermark(): void { $imageSrc = __DIR__ . '/../../../_files/images/earth.jpg'; $phpWord = new PhpWord(); $section = $phpWord->addSection(); $header = $section->addHeader(); $header->addWatermark($imageSrc); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:sectPr/w:headerReference'); self::assertStringStartsWith('rId', $element->getAttribute('r:id')); } /** * covers ::_writeTitle. */ public function testWriteTitle(): void { $phpWord = new PhpWord(); $phpWord->addTitleStyle(1, ['bold' => true], ['spaceAfter' => 240]); $phpWord->addSection()->addTitle('Test', 1); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:pPr/w:pStyle'; self::assertEquals('Heading1', $doc->getElementAttribute($element, 'w:val')); } /** * covers ::_writeCheckbox. */ public function testWriteCheckbox(): void { $rStyle = 'rStyle'; $pStyle = 'pStyle'; $phpWord = new PhpWord(); // $phpWord->addFontStyle($rStyle, array('bold' => true)); // $phpWord->addParagraphStyle($pStyle, array('hanging' => 120, 'indent' => 120)); $section = $phpWord->addSection(); $section->addCheckBox('Check1', 'Test', $rStyle, $pStyle); $doc = TestHelperDOCX::getDocument($phpWord); $element = '/w:document/w:body/w:p/w:r/w:fldChar/w:ffData/w:name'; self::assertEquals('Check1', $doc->getElementAttribute($element, 'w:val')); } /** * covers ::_writeParagraphStyle. */ public function testWriteParagraphStyle(): void { // Create the doc $phpWord = new PhpWord(); $section = $phpWord->addSection(); $attributes = [ 'alignment' => Jc::END, 'widowControl' => false, 'keepNext' => true, 'keepLines' => true, 'pageBreakBefore' => true, ]; foreach ($attributes as $attribute => $value) { $section->addText('Test', null, [$attribute => $value]); } $doc = TestHelperDOCX::getDocument($phpWord); // Test the attributes $attributeCount = 0; foreach ($attributes as $key => $value) { ++$attributeCount; $nodeName = ($key == 'alignment') ? 'jc' : $key; $path = "/w:document/w:body/w:p[{$attributeCount}]/w:pPr/w:{$nodeName}"; if ('alignment' != $key) { $value = $value ? 1 : 0; } $element = $doc->getElement($path); self::assertEquals($value, $element->getAttribute('w:val')); } } /** * covers ::_writeTextStyle. */ public function testWriteFontStyle(): void { $phpWord = new PhpWord(); $styles['name'] = 'Verdana'; $styles['size'] = 14; $styles['bold'] = true; $styles['italic'] = true; $styles['underline'] = 'dash'; $styles['strikethrough'] = true; $styles['superScript'] = true; $styles['color'] = 'FF0000'; $styles['fgColor'] = 'yellow'; $styles['bgColor'] = 'FFFF00'; $styles['hint'] = 'eastAsia'; $styles['smallCaps'] = true; $section = $phpWord->addSection(); $section->addText('Test', $styles); $doc = TestHelperDOCX::getDocument($phpWord); $parent = '/w:document/w:body/w:p/w:r/w:rPr'; self::assertEquals($styles['name'], $doc->getElementAttribute("{$parent}/w:rFonts", 'w:ascii')); self::assertEquals($styles['size'] * 2, $doc->getElementAttribute("{$parent}/w:sz", 'w:val')); self::assertTrue($doc->elementExists("{$parent}/w:b")); self::assertTrue($doc->elementExists("{$parent}/w:i")); self::assertEquals($styles['underline'], $doc->getElementAttribute("{$parent}/w:u", 'w:val')); self::assertTrue($doc->elementExists("{$parent}/w:strike")); self::assertFalse($doc->elementExists("{$parent}/w:dstrike")); self::assertEquals('superscript', $doc->getElementAttribute("{$parent}/w:vertAlign", 'w:val')); self::assertEquals($styles['color'], $doc->getElementAttribute("{$parent}/w:color", 'w:val')); self::assertEquals($styles['fgColor'], $doc->getElementAttribute("{$parent}/w:highlight", 'w:val')); self::assertTrue($doc->elementExists("{$parent}/w:smallCaps")); } /** * covers ::_writeTextStyle. * * @dataProvider providerFontStyleStrikethrough */ public function testWriteFontStyleStrikethrough( bool $isStrikethrough, bool $isDoubleStrikethrough, bool $expectedStrikethrough, bool $expectedDoubleStrikethrough ): void { $phpWord = new PhpWord(); $styles['strikethrough'] = $isStrikethrough; $styles['doublestrikethrough'] = $isDoubleStrikethrough; $section = $phpWord->addSection(); $section->addText('Test', $styles); $doc = TestHelperDOCX::getDocument($phpWord); $parent = '/w:document/w:body/w:p/w:r/w:rPr'; self::assertSame($expectedStrikethrough, $doc->elementExists("{$parent}/w:strike")); self::assertSame($expectedDoubleStrikethrough, $doc->elementExists("{$parent}/w:dstrike")); } public static function providerFontStyleStrikethrough(): iterable { return [ [true, true, false, true], [true, false, true, false], [false, true, false, true], [false, false, false, false], ]; } /** * Tests that if no color is set on a cell a border gets writen with the default color. */ public function testWriteDefaultColor(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $cStyles['borderTopSize'] = 120; $table = $section->addTable(); $table->addRow(); $cell = $table->addCell(null, $cStyles); $cell->addText('Test'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertEquals( Cell::DEFAULT_BORDER_COLOR, $doc->getElementAttribute( '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcBorders/w:top', 'w:color' ) ); } /** * covers ::_writeTableStyle. */ public function testWriteTableStyle(): void { $phpWord = new PhpWord(); $rHeight = 120; $cWidth = 120; $imageSrc = __DIR__ . '/../../../_files/images/earth.jpg'; $objectSrc = __DIR__ . '/../../../_files/documents/sheet.xls'; $tStyles['width'] = 50; $tStyles['cellMarginTop'] = 120; $tStyles['cellMarginRight'] = 120; $tStyles['cellMarginBottom'] = 120; $tStyles['cellMarginLeft'] = 120; $rStyles['tblHeader'] = true; $rStyles['cantSplit'] = true; $cStyles['valign'] = 'top'; $cStyles['textDirection'] = 'btLr'; $cStyles['bgColor'] = 'FF0000'; $cStyles['borderTopSize'] = 120; $cStyles['borderBottomSize'] = 120; $cStyles['borderLeftSize'] = 120; $cStyles['borderRightSize'] = 120; $cStyles['borderTopColor'] = 'FF0000'; $cStyles['borderBottomColor'] = 'FF0000'; $cStyles['borderLeftColor'] = 'FF0000'; $cStyles['borderRightColor'] = 'FF0000'; $cStyles['vMerge'] = 'restart'; $section = $phpWord->addSection(); $table = $section->addTable($tStyles); $table->setWidth(100); $table->addRow($rHeight, $rStyles); $cell = $table->addCell($cWidth, $cStyles); $cell->addText('Test'); $cell->addTextBreak(); $cell->addLink('https://github.com/PHPOffice/PHPWord'); $cell->addListItem('Test'); $cell->addImage($imageSrc); $cell->addObject($objectSrc); $textrun = $cell->addTextRun(); $textrun->addText('Test'); $doc = TestHelperDOCX::getDocument($phpWord); $parent = '/w:document/w:body/w:tbl/w:tblPr/w:tblCellMar'; $parent = '/w:document/w:body/w:tbl/w:tr/w:trPr'; self::assertEquals($rHeight, $doc->getElementAttribute("{$parent}/w:trHeight", 'w:val')); self::assertEquals($rStyles['tblHeader'], $doc->getElementAttribute("{$parent}/w:tblHeader", 'w:val')); self::assertEquals($rStyles['cantSplit'], $doc->getElementAttribute("{$parent}/w:cantSplit", 'w:val')); $parent = '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr'; self::assertEquals($cWidth, $doc->getElementAttribute("{$parent}/w:tcW", 'w:w')); self::assertEquals($cStyles['valign'], $doc->getElementAttribute("{$parent}/w:vAlign", 'w:val')); self::assertEquals($cStyles['textDirection'], $doc->getElementAttribute("{$parent}/w:textDirection", 'w:val')); } /** * covers ::_writeCellStyle. */ public function testWriteCellStyleCellGridSpan(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable(); $table->addRow(); $cell = $table->addCell(200); $cell->getStyle()->setGridSpan(5); $table->addRow(); $table->addCell(40); $table->addCell(40); $table->addCell(40); $table->addCell(40); $table->addCell(40); $table->addRow(); $cell = $table->addCell(200, ['borderRightColor' => 'FF0000']); $cell->getStyle()->setGridSpan(5); $doc = TestHelperDOCX::getDocument($phpWord); $element = $doc->getElement('/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:gridSpan'); self::assertEquals(5, $element->getAttribute('w:val')); } /** * Test write gutter and line numbering. */ public function testWriteGutterAndLineNumbering(): void { $pageMarginPath = '/w:document/w:body/w:sectPr/w:pgMar'; $lineNumberingPath = '/w:document/w:body/w:sectPr/w:lnNumType'; $phpWord = new PhpWord(); $phpWord->addSection(['gutter' => 240, 'lineNumbering' => []]); $doc = TestHelperDOCX::getDocument($phpWord); self::assertEquals(240, $doc->getElement($pageMarginPath)->getAttribute('w:gutter')); self::assertTrue($doc->elementExists($lineNumberingPath)); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/FooterTest.php ================================================ addText(''); $container->addPreserveText(''); $container->addTextBreak(); $container->addTextRun(); $container->addTable()->addRow()->addCell()->addText(''); $container->addImage($imageSrc); $writer = new Word2007(); $dir = Settings::getTempDir() . DIRECTORY_SEPARATOR . 'phpwordcachefooter'; if (!is_dir($dir) && !mkdir($dir)) { self::fail('Unable to create temp directory'); } $writer->setUseDiskCaching(true, $dir); $object = new Footer(); $object->setParentWriter($writer); $object->setElement($container); $xml = simplexml_load_string($object->write()); self::assertInstanceOf('SimpleXMLElement', $xml); TestHelperDOCX::deleteDir($dir); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/FootnotesTest.php ================================================ addParagraphStyle('pStyle', ['alignment' => Jc::START]); $section = $phpWord->addSection(); $section->addText('Text'); $footnote1 = $section->addFootnote('pStyle'); $footnote1->addText('Footnote'); $footnote1->addTextBreak(); $footnote1->addLink('https://github.com/PHPOffice/PHPWord'); $footnote2 = $section->addEndnote(['alignment' => Jc::START]); $footnote2->addText('Endnote'); $doc = TestHelperDOCX::getDocument($phpWord); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:footnoteReference')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:endnoteReference')); self::assertFalse($doc->elementExists('/w:document/w:body/w:p/w:r/w:footnoteReference[@w:id="0"]')); self::assertTrue($doc->elementExists('/w:document/w:body/w:p/w:r/w:footnoteReference[@w:id="1"]')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/HeaderTest.php ================================================ addText('Test'); $container->addPreserveText(''); $container->addTextBreak(); $container->addTextRun(); $container->addTable()->addRow()->addCell()->addText(''); $container->addImage($imageSrc); $container->addWatermark($imageSrc); $writer = new Word2007(); $dir = Settings::getTempDir() . DIRECTORY_SEPARATOR . 'phpwordcachefooter'; if (!is_dir($dir) && !mkdir($dir)) { self::fail('Unable to create temp directory'); } $writer->setUseDiskCaching(true, $dir); $object = new Header(); $object->setParentWriter($writer); $object->setElement($container); $xml = simplexml_load_string($object->write()); self::assertInstanceOf('SimpleXMLElement', $xml); TestHelperDOCX::deleteDir($dir); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/NumberingTest.php ================================================ addNumberingStyle( 'numStyle', [ 'type' => 'multilevel', 'levels' => [ [ 'start' => 1, 'format' => NumberFormat::DECIMAL, 'restart' => 1, 'suffix' => 'space', 'text' => '%1.', 'alignment' => Jc::START, 'left' => 360, 'hanging' => 360, 'tabPos' => 360, 'font' => 'Arial', 'hint' => 'default', ], ], ] ); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); self::assertTrue($doc->elementExists('/w:numbering/w:abstractNum', $xmlFile)); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/SettingsTest.php ================================================ getSettings()->getDocumentProtection()->setEditing('forms'); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:documentProtection'; self::assertTrue($doc->elementExists($path, $file)); } /** * Test document protection with password. */ public function testDocumentProtectionWithPassword(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->getDocumentProtection()->setEditing('readOnly'); $phpWord->getSettings()->getDocumentProtection()->setPassword('testÄö@€!$&'); $phpWord->getSettings()->getDocumentProtection()->setSalt(base64_decode('uq81pJRRGFIY5U+E9gt8tA==')); $phpWord->getSettings()->getDocumentProtection()->setAlgorithm(PasswordEncoder::ALGORITHM_MD2); $phpWord->getSettings()->getDocumentProtection()->setSpinCount(10); $sect = $phpWord->addSection(); $sect->addText('This is a protected document'); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:documentProtection'; self::assertTrue($doc->elementExists($path, $file)); self::assertEquals('rUuJbk6LuN2/qFyp7IUPQA==', $doc->getElement($path, $file)->getAttribute('w:hash')); self::assertEquals('1', $doc->getElement($path, $file)->getAttribute('w:cryptAlgorithmSid')); self::assertEquals('10', $doc->getElement($path, $file)->getAttribute('w:cryptSpinCount')); } /** * Test document protection with password without setting salt. */ public function testDocumentProtectionWithPasswordNoSalt(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->getDocumentProtection()->setEditing('readOnly'); $phpWord->getSettings()->getDocumentProtection()->setPassword('testÄö@€!$&'); //$phpWord->getSettings()->getDocumentProtection()->setSalt(base64_decode('uq81pJRRGFIY5U+E9gt8tA==')); $phpWord->getSettings()->getDocumentProtection()->setAlgorithm(PasswordEncoder::ALGORITHM_MD2); $phpWord->getSettings()->getDocumentProtection()->setSpinCount(10); $sect = $phpWord->addSection(); $sect->addText('This is a protected document'); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:documentProtection'; self::assertTrue($doc->elementExists($path, $file)); //$this->assertEquals('rUuJbk6LuN2/qFyp7IUPQA==', $doc->getElement($path, $file)->getAttribute('w:hash')); self::assertEquals('1', $doc->getElement($path, $file)->getAttribute('w:cryptAlgorithmSid')); self::assertEquals('10', $doc->getElement($path, $file)->getAttribute('w:cryptSpinCount')); } /** * Test compatibility. */ public function testCompatibility(): void { $phpWord = new PhpWord(); $phpWord->getCompatibility()->setOoxmlVersion(15); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:compat/w:compatSetting'; self::assertTrue($doc->elementExists($path, $file)); self::assertEquals($phpWord->getCompatibility()->getOoxmlVersion(), 15); } /** * Test language. */ public function testDefaultLanguage(): void { $phpWord = new PhpWord(); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:themeFontLang'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('en-US', $element->getAttribute('w:val')); } /** * Test language. */ public function testLanguage(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setThemeFontLang(new Language(Language::DE_DE, Language::KO_KR, Language::HE_IL)); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:themeFontLang'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals(Language::DE_DE, $element->getAttribute('w:val')); self::assertEquals(Language::KO_KR, $element->getAttribute('w:eastAsia')); self::assertEquals(Language::HE_IL, $element->getAttribute('w:bidi')); } /** * Test proofState. */ public function testProofState(): void { $proofState = new ProofState(); $proofState->setSpelling(ProofState::DIRTY); $proofState->setGrammar(ProofState::DIRTY); $phpWord = new PhpWord(); $phpWord->getSettings()->setProofState($proofState); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:proofState'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('dirty', $element->getAttribute('w:spelling')); self::assertEquals('dirty', $element->getAttribute('w:grammar')); } /** * Test spelling. */ public function testSpelling(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setHideSpellingErrors(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:hideSpellingErrors'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } /** * Test even and odd headers. */ public function testEvenAndOddHeaders(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setEvenAndOddHeaders(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:evenAndOddHeaders'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } public function testUpdateFields(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setUpdateFields(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:updateFields'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } /** * Test zoom percentage. */ public function testZoomPercentage(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setZoom(75); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:zoom'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('75', $element->getAttribute('w:percent')); } /** * Test zoom value. */ public function testZoomValue(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setZoom(Zoom::FULL_PAGE); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:zoom'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('fullPage', $element->getAttribute('w:val')); } public function testMirrorMargins(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setMirrorMargins(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:mirrorMargins'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } /** * Test Revision View. */ public function testRevisionView(): void { $trackChangesView = new TrackChangesView(); $trackChangesView->setFormatting(false); $trackChangesView->setComments(true); $phpWord = new PhpWord(); $phpWord->getSettings()->setRevisionView($trackChangesView); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:revisionView'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('false', $element->getAttribute('w:formatting')); self::assertEquals('true', $element->getAttribute('w:comments')); } public function testHideSpellingErrors(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setHideSpellingErrors(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:hideSpellingErrors'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } public function testHideGrammaticalErrors(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setHideGrammaticalErrors(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:hideGrammaticalErrors'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } /** * Test track Revisions. */ public function testTrackRevisions(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setTrackRevisions(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:trackRevisions'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } /** * Test doNotTrackMoves. */ public function testDoNotTrackMoves(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setDoNotTrackMoves(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:doNotTrackMoves'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } /** * Test DoNotTrackFormatting. */ public function testDoNotTrackFormatting(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setDoNotTrackFormatting(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:doNotTrackFormatting'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } public function testAutoHyphenation(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setAutoHyphenation(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:autoHyphenation'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } public function testConsecutiveHyphenLimit(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setConsecutiveHyphenLimit(2); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:consecutiveHyphenLimit'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('2', $element->getAttribute('w:val')); } public function testHyphenationZone(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setHyphenationZone(100); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:hyphenationZone'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('100', $element->getAttribute('w:val')); } public function testDoNotHyphenateCaps(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setDoNotHyphenateCaps(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:doNotHyphenateCaps'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } public function testBookFoldPrinting(): void { $phpWord = new PhpWord(); $phpWord->getSettings()->setBookFoldPrinting(true); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/settings.xml'; $path = '/w:settings/w:bookFoldPrinting'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertSame('true', $element->getAttribute('w:val')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Part/StylesTest.php ================================================ Jc::BOTH]; $pBase = ['basedOn' => 'Normal']; $pNew = ['basedOn' => 'Base Style', 'next' => 'Normal']; $rStyle = ['size' => 20]; $tStyle = ['bgColor' => 'FF0000', 'cellMargin' => 120, 'borderSize' => 120]; $firstRowStyle = ['bgColor' => '0000FF', 'borderSize' => 120, 'borderColor' => '00FF00']; $phpWord->setDefaultParagraphStyle($pStyle); $phpWord->addParagraphStyle('Base Style', $pBase); $phpWord->addParagraphStyle('New Style', $pNew); $phpWord->addFontStyle('New Style', $rStyle, $pStyle); $phpWord->addTableStyle('Table Style', $tStyle, $firstRowStyle); $phpWord->addTitleStyle(1, $rStyle, $pStyle); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/styles.xml'; // Normal style generated? $path = '/w:styles/w:style[@w:styleId="Normal"]/w:name'; $element = $doc->getElement($path, $file); self::assertEquals('Normal', $element->getAttribute('w:val')); // Parent style referenced? $path = '/w:styles/w:style[@w:styleId="New Style"]/w:basedOn'; $element = $doc->getElement($path, $file); self::assertEquals('Base Style', $element->getAttribute('w:val')); // Next paragraph style correct? $path = '/w:styles/w:style[@w:styleId="New Style"]/w:next'; $element = $doc->getElement($path, $file); self::assertEquals('Normal', $element->getAttribute('w:val')); } public function testFontStyleBasedOn(): void { $phpWord = new PhpWord(); $baseParagraphStyle = new Paragraph(); $baseParagraphStyle->setAlignment(Jc::CENTER); $baseParagraphStyle = $phpWord->addParagraphStyle('BaseStyle', $baseParagraphStyle); $childFont = new Font(); $childFont->setParagraph($baseParagraphStyle); $childFont->setSize(16); $childFont = $phpWord->addFontStyle('ChildFontStyle', $childFont); $otherFont = new Font(); $otherFont->setSize(20); $otherFont = $phpWord->addFontStyle('OtherFontStyle', $otherFont); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/styles.xml'; // Normal style generated? $path = '/w:styles/w:style[@w:styleId="BaseStyle"]/w:name'; $element = $doc->getElement($path, $file); self::assertEquals('BaseStyle', $element->getAttribute('w:val')); // Font style with paragraph should have it's base style set to that paragraphs style name $path = '/w:styles/w:style[w:name/@w:val="ChildFontStyle"]/w:basedOn'; $element = $doc->getElement($path, $file); self::assertEquals('BaseStyle', $element->getAttribute('w:val')); // Font style without paragraph should not have a base style set $path = '/w:styles/w:style[w:name/@w:val="OtherFontStyle"]/w:basedOn'; $element = $doc->getElement($path, $file); self::assertNull($element); } public function testFontStyleBasedOnOtherFontStyle(): void { $phpWord = new PhpWord(); $styleGenerationP = new Paragraph(); $styleGenerationP->setAlignment(Jc::BOTH); $styleGeneration = new Font(); $styleGeneration->setParagraph($styleGenerationP); $styleGeneration->setSize(9.5); $phpWord->addFontStyle('Generation', $styleGeneration); $styleGenerationEteinteP = new Paragraph(); $styleGenerationEteinteP->setBasedOn('Generation'); $styleGenerationEteinte = new Font(); $styleGenerationEteinte->setParagraph($styleGenerationEteinteP); $styleGenerationEteinte->setSize(8.5); $phpWord->addFontStyle('GeneratEteinte', $styleGenerationEteinte); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/styles.xml'; $path = '/w:styles/w:style[@w:styleId="GeneratEteinte"]/w:basedOn'; $element = $doc->getElement($path, $file); self::assertEquals('Generation', $element->getAttribute('w:val')); } /** * Test default font color. */ public function testDefaultDefaultFontColor(): void { $phpWord = new PhpWord(); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/styles.xml'; $path = '/w:styles/w:docDefaults/w:rPrDefault/w:rPr/w:color'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals('000000', $element->getAttribute('w:val')); } /** * Test default font color. */ public function testDefaultFontColor(): void { $phpWord = new PhpWord(); $defaultFontColor = '00FF00'; $phpWord->setDefaultFontColor($defaultFontColor); $doc = TestHelperDOCX::getDocument($phpWord); $file = 'word/styles.xml'; $path = '/w:styles/w:docDefaults/w:rPrDefault/w:rPr/w:color'; self::assertTrue($doc->elementExists($path, $file)); $element = $doc->getElement($path, $file); self::assertEquals($defaultFontColor, $element->getAttribute('w:val')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/PartTest.php ================================================ expectException(\PhpOffice\PhpWord\Exception\Exception::class); $this->expectExceptionMessage('Invalid parameters passed.'); $object = new RelsPart(); $object->setMedia([['type' => '', 'target' => '']]); $object->write(); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/DirectionTest.php ================================================ addSection(); $html = '

    الألم الذي ربما تنجم عنه بعض ا.

    '; SharedHtml::addHtml($section, $html, false, false); $english = '

    LTR in RTL document.

    '; SharedHtml::addHtml($section, $english, false, false); $doc = TestHelperDOCX::getDocument($word, 'Word2007'); $path = '/w:document/w:body/w:p[1]/w:pPr/w:bidi'; self::assertTrue($doc->elementExists($path)); $path = '/w:document/w:body/w:p[2]/w:pPr/w:bidi'; self::assertFalse($doc->elementExists($path)); $path = '/w:document/w:body/w:p[1]/w:pPr/w:jc'; self::assertFalse($doc->elementExists($path)); $path = '/w:document/w:body/w:p[2]/w:pPr/w:jc'; self::assertTrue($doc->elementExists($path)); self::assertSame('start', $doc->getElementAttribute($path, 'w:val')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/FontTest.php ================================================ addSection(); $textrun = $section->addTextRun(); $textrun->addText('سلام این یک پاراگراف راست به چپ است', ['rtl' => true, 'lang' => 'ar-DZ']); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $file = 'word/document.xml'; $path = '/w:document/w:body/w:p/w:r/w:rPr/w:rtl'; self::assertTrue($doc->elementExists($path, $file)); } public function testFontRTLNamed(): void { $phpWord = new PhpWord(); $stnam = 'fstyle'; $phpWord->addFontStyle($stnam, [ 'rtl' => true, 'name' => 'Courier New', 'size' => 8, ]); $section = $phpWord->addSection(); $txt = 'היום יום שני'; // Translation = Today is Monday $section->addText($txt, $stnam); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $element = '/w:document/w:body/w:p/w:r'; $txtelem = $element . '/w:t'; $styelem = $element . '/w:rPr'; self::assertTrue($doc->elementExists($txtelem)); self::assertEquals($txt, $doc->getElement($txtelem)->textContent); self::assertTrue($doc->elementExists($styelem)); self::assertTrue($doc->elementExists($styelem . '/w:rStyle')); self::assertEquals($stnam, $doc->getElementAttribute($styelem . '/w:rStyle', 'w:val')); self::assertTrue($doc->elementExists($styelem . '/w:rtl')); } public function testFontNotRTLNamed(): void { $phpWord = new PhpWord(); $stnam = 'fstyle'; $phpWord->addFontStyle($stnam, [ //'rtl' => true, 'name' => 'Courier New', 'size' => 8, ]); $section = $phpWord->addSection(); $txt = 'היום יום שני'; // Translation = Today is Monday $section->addText($txt, $stnam); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $element = '/w:document/w:body/w:p/w:r'; $txtelem = $element . '/w:t'; $styelem = $element . '/w:rPr'; self::assertTrue($doc->elementExists($txtelem)); self::assertEquals($txt, $doc->getElement($txtelem)->textContent); self::assertTrue($doc->elementExists($styelem)); self::assertTrue($doc->elementExists($styelem . '/w:rStyle')); self::assertEquals($stnam, $doc->getElementAttribute($styelem . '/w:rStyle', 'w:val')); self::assertFalse($doc->elementExists($styelem . '/w:rtl')); } public function testNoProof(): void { $phpWord = new PhpWord(); $fontStyle = [ 'noProof' => true, 'name' => 'Courier New', 'size' => 8, ]; $section = $phpWord->addSection(); $txt = 'spellung error'; $section->addText($txt, $fontStyle); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $element = '/w:document/w:body/w:p/w:r'; $txtelem = $element . '/w:t'; $styelem = $element . '/w:rPr'; $noproofelem = $styelem . '/w:noProof'; self::assertTrue($doc->elementExists($txtelem)); self::assertEquals($txt, $doc->getElement($txtelem)->textContent); self::assertTrue($doc->elementExists($styelem)); self::assertTrue($doc->elementExists($noproofelem)); self::assertEquals('1', $doc->getElementAttribute($noproofelem, 'w:val')); } /** * Test writing font with language. */ public function testFontWithLang(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Ce texte-ci est en français.', ['lang' => \PhpOffice\PhpWord\Style\Language::FR_BE]); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $file = 'word/document.xml'; $path = '/w:document/w:body/w:p/w:r/w:rPr/w:lang'; self::assertTrue($doc->elementExists($path, $file)); } /** * Test writing position. */ public function testPosition(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('This text is lowered', ['position' => -20]); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p/w:r/w:rPr/w:position'; self::assertTrue($doc->elementExists($path)); self::assertEquals(-20, $doc->getElementAttribute($path, 'w:val')); } public static function testRgb(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(['pageNumberingStart' => 1]); $html = implode( "\n", [ '', '', '', '', '', '', '', '
    This one is in color.This one too.
    ', ] ); Html::addHtml($section, $html, false, false); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $element = '/w:document/w:body/w:tbl/w:tr/w:tc/w:p/w:r'; $txtelem = $element . '/w:t'; $styelem = $element . '/w:rPr'; self::assertTrue($doc->elementExists($txtelem)); self::assertSame('This one is in color.', $doc->getElement($txtelem)->textContent); self::assertTrue($doc->elementExists($styelem)); self::assertTrue($doc->elementExists($styelem . '/w:color')); self::assertSame('A7D9C1', $doc->getElementAttribute($styelem . '/w:color', 'w:val')); $element = '/w:document/w:body/w:tbl/w:tr/w:tc[2]/w:p/w:r'; $txtelem = $element . '/w:t'; $styelem = $element . '/w:rPr'; self::assertTrue($doc->elementExists($txtelem)); self::assertSame('This one too.', $doc->getElement($txtelem)->textContent); self::assertTrue($doc->elementExists($styelem)); self::assertTrue($doc->elementExists($styelem . '/w:color')); self::assertSame('A7D9C1', $doc->getElementAttribute($styelem . '/w:color', 'w:val')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/ImageTest.php ================================================ Image::WRAP_INLINE, 'wrapDistanceLeft' => 10, 'wrapDistanceRight' => 20, 'wrapDistanceTop' => 30, 'wrapDistanceBottom' => 40, ]; $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addImage(__DIR__ . '/../../../_files/images/earth.jpg', $styles); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p[1]/w:r/w:rPr/w:position'; self::assertFalse($doc->elementExists($path)); $path = '/w:document/w:body/w:p[1]/w:r/w:pict/v:shape'; self::assertTrue($doc->elementExists($path . '/w10:wrap')); self::assertEquals('inline', $doc->getElementAttribute($path . '/w10:wrap', 'type')); self::assertTrue($doc->elementExists($path)); $style = $doc->getElement($path)->getAttribute('style'); self::assertNotNull($style); self::assertStringContainsString('mso-wrap-distance-left:10pt;', $style); self::assertStringContainsString('mso-wrap-distance-right:20pt;', $style); self::assertStringContainsString('mso-wrap-distance-top:30pt;', $style); self::assertStringContainsString('mso-wrap-distance-bottom:40pt;', $style); } /** * Test writing image wrapping. */ public function testWrappingWithPosition(): void { $styles = [ 'wrap' => Image::WRAP_INLINE, 'wrapDistanceLeft' => 10, 'wrapDistanceRight' => 20, 'wrapDistanceTop' => 30, 'wrapDistanceBottom' => 40, 'position' => 10, ]; $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addImage(__DIR__ . '/../../../_files/images/earth.jpg', $styles); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p[1]/w:r/w:rPr/w:position'; self::assertEquals('10', $doc->getElement($path)->getAttribute('w:val')); $path = '/w:document/w:body/w:p[1]/w:r/w:pict/v:shape'; self::assertTrue($doc->elementExists($path . '/w10:wrap')); self::assertEquals('inline', $doc->getElementAttribute($path . '/w10:wrap', 'type')); self::assertTrue($doc->elementExists($path)); $style = $doc->getElement($path)->getAttribute('style'); self::assertNotNull($style); self::assertStringContainsString('mso-wrap-distance-left:10pt;', $style); self::assertStringContainsString('mso-wrap-distance-right:20pt;', $style); self::assertStringContainsString('mso-wrap-distance-top:30pt;', $style); self::assertStringContainsString('mso-wrap-distance-bottom:40pt;', $style); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/IndentationTest.php ================================================ addSection(); $text = $section->addText('AA'); $paragraphStyle = $text->getParagraphStyle(); self::assertInstanceOf(Paragraph::class, $paragraphStyle); $paragraphStyle->setIndentation([]); $doc = TestHelperDOCX::getDocument($word, 'Word2007'); $path = '/w:document/w:body/w:p[1]/w:pPr/w:ind'; self::assertTrue($doc->elementExists($path)); self::assertFalse($doc->hasElementAttribute($path, 'w:firstLineChars')); } public function testFirstLineChars(): void { $word = new PhpWord(); Settings::setDefaultRtl(true); $section = $word->addSection(); $text = $section->addText('AA'); $paragraphStyle = $text->getParagraphStyle(); self::assertInstanceOf(Paragraph::class, $paragraphStyle); $paragraphStyle->setIndentation([ 'firstLineChars' => 1440, ]); $doc = TestHelperDOCX::getDocument($word, 'Word2007'); $path = '/w:document/w:body/w:p[1]/w:pPr/w:ind'; self::assertTrue($doc->elementExists($path)); self::assertTrue($doc->hasElementAttribute($path, 'w:firstLineChars')); self::assertSame('1440', $doc->getElementAttribute($path, 'w:firstLineChars')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/ParagraphTest.php ================================================ addParagraphStyle('testStyle', ['indent' => '10']); $section = $phpWord->addSection(); $section->addText('test', null, ['numStyle' => 'testStyle', 'numLevel' => '1']); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p/w:pPr/w:numPr/w:ilvl'; self::assertTrue($doc->elementExists($path)); } public function testLineSpacingExact(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addText('test', null, ['spacing' => 240, 'spacingLineRule' => 'exact']); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p/w:pPr/w:spacing'; self::assertTrue($doc->elementExists($path)); self::assertEquals('exact', $doc->getElementAttribute($path, 'w:lineRule')); self::assertEquals('240', $doc->getElementAttribute($path, 'w:line')); } public function testLineSpacingAuto(): void { $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addText('test', null, ['spacing' => 240, 'spacingLineRule' => 'auto']); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p/w:pPr/w:spacing'; self::assertTrue($doc->elementExists($path)); self::assertEquals('auto', $doc->getElementAttribute($path, 'w:lineRule')); self::assertEquals('480', $doc->getElementAttribute($path, 'w:line')); } public function testSuppressAutoHyphens(): void { $paragraphStyle = new ParagraphStyle(); $paragraphStyle->setSuppressAutoHyphens(true); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $section->addText('test', null, $paragraphStyle); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:p/w:pPr/w:suppressAutoHyphens'; self::assertTrue($doc->elementExists($path)); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/SectionTest.php ================================================ addSection(); $section->getStyle()->setMarginTop(0.1)->setMarginBottom(0.4)->setMarginLeft(0.2)->setMarginRight(0.3); $section->addText('test'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); Settings::setMeasurementUnit($unit); $path = '/w:document/w:body/w:sectPr/w:pgMar'; self::assertEquals('144', $doc->getElementAttribute($path, 'w:top')); self::assertEquals('432', $doc->getElementAttribute($path, 'w:right')); self::assertEquals('576', $doc->getElementAttribute($path, 'w:bottom')); self::assertEquals('288', $doc->getElementAttribute($path, 'w:left')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/TableCellTest.php ================================================ addSection(); $table = $section->addTable(); $table->addRow(); $testValTop = Converter::pixelToTwip(10); $testValRight = Converter::pixelToTwip(11); $testValBottom = Converter::pixelToTwip(12); $testValLeft = Converter::pixelToTwip(13); $cellStyle = [ 'paddingTop' => $testValTop, 'paddingRight' => $testValRight, 'paddingBottom' => $testValBottom, 'paddingLeft' => $testValLeft, ]; $table->addCell(null, $cellStyle)->addText('Some text'); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcMar/w:top'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValTop, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); $path = '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcMar/w:start'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValLeft, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); $path = '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcMar/w:bottom'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValBottom, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); $path = '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcMar/w:end'; self::assertTrue($doc->elementExists($path)); self::assertEquals($testValRight, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/Style/TableTest.php ================================================ setLayout(Table::LAYOUT_FIXED); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable($tableStyle); $table->addRow(); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tblPr/w:tblLayout'; self::assertTrue($doc->elementExists($path)); self::assertEquals(Table::LAYOUT_FIXED, $doc->getElementAttribute($path, 'w:type')); } /** * Test write styles. */ public function testCellSpacing(): void { $tableStyle = new Table(); $tableStyle->setCellSpacing(10.3); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable($tableStyle); $table->addRow(); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tblPr/w:tblCellSpacing'; self::assertTrue($doc->elementExists($path)); self::assertEquals(10.3, $doc->getElementAttribute($path, 'w:w')); self::assertEquals(TblWidth::TWIP, $doc->getElementAttribute($path, 'w:type')); } /** * Test write table position. */ public function testTablePosition(): void { $tablePosition = [ 'leftFromText' => 10, 'rightFromText' => 20, 'topFromText' => 30, 'bottomFromText' => 40, 'vertAnchor' => TablePosition::VANCHOR_PAGE, 'horzAnchor' => TablePosition::HANCHOR_MARGIN, 'tblpXSpec' => TablePosition::XALIGN_CENTER, 'tblpX' => 50, 'tblpYSpec' => TablePosition::YALIGN_TOP, 'tblpY' => 60, ]; $tableStyle = new Table(); $tableStyle->setPosition($tablePosition); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable($tableStyle); $table->addRow(); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tblPr/w:tblpPr'; self::assertTrue($doc->elementExists($path)); self::assertEquals(10, $doc->getElementAttribute($path, 'w:leftFromText')); self::assertEquals(20, $doc->getElementAttribute($path, 'w:rightFromText')); self::assertEquals(30, $doc->getElementAttribute($path, 'w:topFromText')); self::assertEquals(40, $doc->getElementAttribute($path, 'w:bottomFromText')); self::assertEquals(TablePosition::VANCHOR_PAGE, $doc->getElementAttribute($path, 'w:vertAnchor')); self::assertEquals(TablePosition::HANCHOR_MARGIN, $doc->getElementAttribute($path, 'w:horzAnchor')); self::assertEquals(TablePosition::XALIGN_CENTER, $doc->getElementAttribute($path, 'w:tblpXSpec')); self::assertEquals(50, $doc->getElementAttribute($path, 'w:tblpX')); self::assertEquals(TablePosition::YALIGN_TOP, $doc->getElementAttribute($path, 'w:tblpYSpec')); self::assertEquals(60, $doc->getElementAttribute($path, 'w:tblpY')); } public function testIndent(): void { $value = 100; $type = TblWidth::TWIP; $tableStyle = new Table(); $tableStyle->setIndent(new TblWidthComplexType($value, $type)); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable($tableStyle); $table->addRow(); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tblPr/w:tblInd'; self::assertTrue($doc->elementExists($path)); self::assertSame($value, (int) $doc->getElementAttribute($path, 'w:w')); self::assertSame($type, $doc->getElementAttribute($path, 'w:type')); } public function testRigthToLeft(): void { $tableStyle = new Table(); $tableStyle->setBidiVisual(true); $phpWord = new \PhpOffice\PhpWord\PhpWord(); $section = $phpWord->addSection(); $table = $section->addTable($tableStyle); $table->addRow(); $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007'); $path = '/w:document/w:body/w:tbl/w:tblPr/w:bidiVisual'; self::assertTrue($doc->elementExists($path)); self::assertEquals('1', $doc->getElementAttribute($path, 'w:val')); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007/StyleTest.php ================================================ write(); self::assertEquals('', $xmlWriter->getData()); } } /** * Test method exceptions. */ public function testMethodExceptionsFrame(): void { $xmlWriter = new XMLWriter(); $object = new Frame($xmlWriter); $object->writeAlignment(); self::assertEquals('', $xmlWriter->getData()); } /** * Test method exceptions. */ public function testMethodExceptionsLine(): void { $xmlWriter = new XMLWriter(); $object = new Line($xmlWriter); $object->writeStroke(); self::assertEquals('', $xmlWriter->getData()); } /** * Test method exceptions. */ public function testMethodExceptionsTextBox(): void { $xmlWriter = new XMLWriter(); $object = new TextBox($xmlWriter); $object->writeBorder(); self::assertEquals('', $xmlWriter->getData()); } } ================================================ FILE: tests/PhpWordTests/Writer/Word2007Test.php ================================================ 'ContentTypes', 'Rels' => 'Rels', 'DocPropsApp' => 'DocPropsApp', 'Document' => 'Document', 'Styles' => 'Styles', 'Numbering' => 'Numbering', 'Settings' => 'Settings', 'WebSettings' => 'WebSettings', 'Header' => 'Header', 'Footer' => 'Footer', 'Footnotes' => 'Footnotes', 'Endnotes' => 'Footnotes', ]; foreach ($writerParts as $part => $type) { self::assertInstanceOf( "PhpOffice\\PhpWord\\Writer\\Word2007\\Part\\{$type}", $object->getWriterPart($part) ); self::assertInstanceOf( 'PhpOffice\\PhpWord\\Writer\\Word2007', $object->getWriterPart($part)->getParentWriter() ); } } /** * Save. */ public function testSave(): void { $localImage = __DIR__ . '/../_files/images/earth.jpg'; $remoteImage = self::getRemoteGifImageUrl(); $phpWord = new PhpWord(); $phpWord->addFontStyle('Font', ['size' => 11]); $phpWord->addParagraphStyle('Paragraph', ['alignment' => Jc::CENTER]); $section = $phpWord->addSection(); $section->addText('Test 1', 'Font', 'Paragraph'); $section->addTextBreak(); $section->addText('Test 2'); $section = $phpWord->addSection(); $textrun = $section->addTextRun(); $textrun->addText('Test 3'); $footnote = $textrun->addFootnote(); $footnote->addLink('https://github.com/PHPOffice/PHPWord'); $header = $section->addHeader(); $header->addImage($localImage); $footer = $section->addFooter(); $footer->addImage($remoteImage); $writer = new Word2007($phpWord); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); unlink($file); } /** * Save using disk caching. */ public function testSaveUseDiskCaching(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Test'); $footnote = $section->addFootnote(); $footnote->addText('Test'); $writer = new Word2007($phpWord); $dir = Settings::getTempDir() . DIRECTORY_SEPARATOR . 'phpwordcachefooter'; if (!is_dir($dir) && !mkdir($dir)) { self::fail('Unable to create temp directory'); } $writer->setUseDiskCaching(true, $dir); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); self::assertFileExists($file); unlink($file); TestHelperDOCX::deleteDir($dir); } /** * Check content types. */ public function testCheckContentTypes(): void { $images = [ 'mars_noext_jpg' => '1.jpg', 'mars.jpg' => '2.jpg', 'mario.gif' => '3.gif', 'firefox.png' => '4.png', 'duke_nukem.bmp' => '5.bmp', 'angela_merkel.tif' => '6.tif', ]; $phpWord = new PhpWord(); $section = $phpWord->addSection(); foreach ($images as $source => $target) { $section->addImage(__DIR__ . "/../_files/images/{$source}"); } $doc = TestHelperDOCX::getDocument($phpWord); $mediaPath = $doc->getPath() . '/word/media'; foreach ($images as $source => $target) { self::assertFileEquals( __DIR__ . "/../_files/images/{$source}", $mediaPath . "/section_image{$target}" ); } } /** * Get writer part return null value. */ public function testGetWriterPartNull(): void { $object = new Word2007(); self::assertNull($object->getWriterPart()); } /** * Set/get use disk caching. */ public function testSetGetUseDiskCaching(): void { $phpWord = new PhpWord(); $phpWord->addSection(); $object = new Word2007($phpWord); $object->setUseDiskCaching(true, PHPWORD_TESTS_BASE_DIR); $writer = new Word2007($phpWord); ob_start(); $writer->save('php://output'); $contents = ob_get_contents(); self::assertTrue(ob_end_clean()); self::assertTrue($object->isUseDiskCaching()); self::assertNotEmpty($contents); } /** * Use disk caching exception. */ public function testSetUseDiskCachingException(): void { $this->expectException(\PhpOffice\PhpWord\Exception\Exception::class); $dir = implode(DIRECTORY_SEPARATOR, [PHPWORD_TESTS_BASE_DIR, 'foo']); $object = new Word2007(); $object->setUseDiskCaching(true, $dir); } /** * File is detected as Word 2007. */ public function testMime(): void { $phpWord = new PhpWord(); $section = $phpWord->addSection(); $section->addText('Test 1'); $writer = new Word2007($phpWord); $file = __DIR__ . '/../_files/temp.docx'; $writer->save($file); $finfo = new finfo(FILEINFO_MIME_TYPE); $mime = $finfo->file($file); self::assertEquals('application/vnd.openxmlformats-officedocument.wordprocessingml.document', $mime); unlink($file); } } ================================================ FILE: tests/PhpWordTests/XmlDocument.php ================================================ path = realpath($path); } /** * Get default file. */ public function getDefaultFile(): string { return $this->defaultFile; } /** * Set default file. */ public function setDefaultFile(string $file): string { $temp = $this->defaultFile; $this->defaultFile = $file; return $temp; } /** * Get file name. */ public function getFile(): string { return $this->file; } /** * Get path. */ public function getPath(): string { return $this->path; } /** * Get DOM from file. */ public function getFileDom(string $file = ''): DOMDocument { if (!$file) { $file = $this->defaultFile; } if (null !== $this->dom && $file === $this->file) { return $this->dom; } $this->xpath = null; $this->file = $file; $file = $this->path . '/' . $file; if (\PHP_VERSION_ID < 80000) { $orignalLibEntityLoader = libxml_disable_entity_loader(false); } $this->dom = new DOMDocument(); $this->dom->load($file); if (\PHP_VERSION_ID < 80000) { libxml_disable_entity_loader($orignalLibEntityLoader); } return $this->dom; } /** * Get node list. * * @return DOMNodeList */ public function getNodeList(string $path, string $file = ''): DOMNodeList { if (!$file) { $file = $this->defaultFile; } if (null === $this->dom || $file !== $this->file) { $this->getFileDom($file); } if (null === $this->xpath) { $this->xpath = new DOMXPath($this->dom); $this->xpath->registerNamespace('w14', 'http://schemas.microsoft.com/office/word/2010/wordml'); } return $this->xpath->query($path); } /** * Get element. */ public function getElement(string $path, string $file = ''): ?DOMElement { return $this->getNodeList($path, $file)->item(0); } /** * Get element attribute. */ public function getElementAttribute(string $path, string $attribute, string $file = ''): string { return $this->getElement($path, $file)->getAttribute($attribute); } /** * Return if element attribute exists. */ public function hasElementAttribute(string $path, string $attribute, string $file = ''): bool { return $this->getElement($path, $file)->hasAttribute($attribute); } /** * Check if element exists. */ public function elementExists(string $path, string $file = ''): bool { $nodeList = $this->getNodeList($path, $file); return $nodeList->length != 0; } /** * Returns the xml, or part of it as a formatted string. * * @return false|string */ public function printXml(string $path = '/', string $file = '') { $element = $this->getElement($path, $file); $newdoc = new DOMDocument(); $newdoc->formatOutput = true; $newdoc->preserveWhiteSpace = false; $node = $newdoc->importNode($element, true); $newdoc->appendChild($node); return $newdoc->saveXML($node); } } ================================================ FILE: tests/PhpWordTests/_files/documents/reader.html ================================================ PHPWord

    Adding element via HTML

    Some well formed HTML snippet needs to be used

    With for example some1 inline formatting1

    Unordered (bulleted) list:

    • Item 1
    • Item 2
      • Item 2.1
      • Item 2.1

    Ordered (numbered) list:

    1. Item 1
    2. Item 2
    ================================================ FILE: tests/PhpWordTests/_files/documents/reader.rtf ================================================ {\rtf1 \ansi\ansicpg1252 \deff0 {\fonttbl{\f0\fnil\fcharset0 Arial;}{\f1\fnil\fcharset0 Times New Roman;}} {\colortbl;\red255\green0\blue0;\red14\green0\blue0} {\*\generator PhpWord;} {\info{\title }{\subject }{\category }{\keywords }{\comment }{\author }{\operator }{\creatim \yr2014\mo05\dy27\hr23\min36\sec45}{\revtim \yr2014\mo05\dy27\hr23\min36\sec45}{\company }{\manager }} \deftab720\viewkind1\uc1\pard\nowidctlpar\lang1036\kerning1\fs20 {Welcome to PhpWord}\par \pard\nowidctlpar{\cf0\f0 Hello World!}\par \par \par \pard\nowidctlpar{\cf0\f0\fs32\b\i I am styled by a definition.}\par \pard\nowidctlpar{\cf0\f0 I am styled by a paragraph style definition.}\par \pard\nowidctlpar\qc\sa100{\cf0\f0\fs32\b\i I am styled by both font and paragraph style.}\par \pard\nowidctlpar{\cf1\f1\fs40\b\i\ul\strike\super I am inline styled.}\par \par {\field {\*\fldinst {HYPERLINK "https://github.com/PHPOffice/PHPWord"}}{\fldrslt {PHPWord on GitHub}}}\par \par } ================================================ FILE: tests/PhpWordTests/_files/xsl/passthrough.xsl ================================================ ================================================ FILE: tests/PhpWordTests/_files/xsl/remove_tables_by_needle.xsl ================================================ ================================================ FILE: tests/bootstrap.php ================================================