\PhpOffice\PhpWordPhpWord

__construct()

__construct() 

Create new instance

Collections are created dynamically

__call()

__call(mixed  $function, mixed  $args) : mixed

Dynamic function call to reduce static dependency

Parameters

Throws

\BadMethodCallException

Returns

getDocInfo()

getDocInfo() : \PhpOffice\PhpWord\Metadata\DocInfo

Get document properties object

Returns

getProtection()

getProtection() : \PhpOffice\PhpWord\Metadata\Protection

Get protection

Returns

getCompatibility()

getCompatibility() : \PhpOffice\PhpWord\Metadata\Compatibility

Get compatibility

Returns

getSettings()

getSettings() : \PhpOffice\PhpWord\Metadata\Settings

Get compatibility

Returns

getSections()

getSections() : array<mixed,\PhpOffice\PhpWord\Element\Section>

Get all sections

Returns

getSection()

getSection(integer  $index) : \PhpOffice\PhpWord\Element\Section|null

Returns the section at the requested position

Parameters

Returns

addSection()

addSection(array  $style = null) : \PhpOffice\PhpWord\Element\Section

Create new section

Parameters

Returns

sortSections()

sortSections(callable  $sorter) 

Sorts the sections using the callable passed

Parameters

getDefaultFontName()

getDefaultFontName() : string

Get default font name

Returns

setDefaultFontName()

setDefaultFontName(string  $fontName) 

Set default font name.

Parameters

getDefaultFontSize()

getDefaultFontSize() : integer

Get default font size

Returns

setDefaultFontSize()

setDefaultFontSize(integer  $fontSize) 

Set default font size.

Parameters

setDefaultParagraphStyle()

setDefaultParagraphStyle(array  $styles) : \PhpOffice\PhpWord\Style\Paragraph

Set default paragraph style definition to styles.xml

Parameters

Returns

loadTemplate()

loadTemplate(string  $filename) : \PhpOffice\PhpWord\TemplateProcessor

Load template by filename

Parameters

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

save()

save(string  $filename, string  $format = 'Word2007', boolean  $download = false) : boolean

Save to file or download

All exceptions should already been handled by the writers

Parameters

Returns

createSection()

createSection(array  $settings = null) : \PhpOffice\PhpWord\Element\Section

Create new section

Parameters

Returns

getDocumentProperties()

getDocumentProperties() : \PhpOffice\PhpWord\Metadata\DocInfo

Get document properties object

Returns

setDocumentProperties()

setDocumentProperties(\PhpOffice\PhpWord\Metadata\DocInfo  $documentProperties) : self

Set document properties object

Parameters

Returns

getTitles()

getTitles() : \PhpOffice\PhpWord\Collection\Titles

Returns

getFootnotes()

getFootnotes() : \PhpOffice\PhpWord\Collection\Footnotes

Returns

getEndnotes()

getEndnotes() : \PhpOffice\PhpWord\Collection\Endnotes

Returns

getCharts()

getCharts() : \PhpOffice\PhpWord\Collection\Charts

Returns

getComments()

getComments() : \PhpOffice\PhpWord\Collection\Comments

Returns

addBookmark()

addBookmark(\Element\Bookmark  $bookmark) : integer

Parameters

Returns

addTitle()

addTitle(\Element\Title  $title) : integer

Parameters

Returns

addFootnote()

addFootnote(\Element\Footnote  $footnote) : integer

Parameters

Returns

addEndnote()

addEndnote(\Element\Endnote  $endnote) : integer

Parameters

Returns

addChart()

addChart(\Element\Chart  $chart) : integer

Parameters

Returns

addComment()

addComment(\Element\Comment  $comment) : integer

Parameters

Returns

addParagraphStyle()

addParagraphStyle(string  $styleName, mixed  $styles) : \PhpOffice\PhpWord\Style\Paragraph

Parameters

Returns

addFontStyle()

addFontStyle(string  $styleName, mixed  $fontStyle, mixed  $paragraphStyle = null) : \PhpOffice\PhpWord\Style\Font

Parameters

Returns

addLinkStyle()

addLinkStyle(string  $styleName, mixed  $styles) : \PhpOffice\PhpWord\Style\Font

Parameters

Returns

addTitleStyle()

addTitleStyle(mixed  $depth, mixed  $fontStyle, mixed  $paragraphStyle = null) : \PhpOffice\PhpWord\Style\Font

Parameters

Returns

addTableStyle()

addTableStyle(string  $styleName, mixed  $styleTable, mixed  $styleFirstRow = null) : \PhpOffice\PhpWord\Style\Table

Parameters

Returns

addNumberingStyle()

addNumberingStyle(string  $styleName, mixed  $styles) : \PhpOffice\PhpWord\Style\Numbering

Parameters

Returns