\PhpOffice\PhpWord\SharedHtml

Common Html functions

Summary

Methods

Properties

Constants

addHtml()

No public properties found

No constants found

parseInlineStyle()
parseNode()

No protected properties found

N/A

parseChildNodes()
parseParagraph()
parseHeading()
parseText()
parseProperty()
parseSpan()
parseTable()
parseRow()
parseCell()
shouldAddTextRun()
recursiveParseStylesInHierarchy()
parseList()
getListStyle()
parseListItem()
parseStyle()
parseImage()
mapBorderStyle()
mapAlign()
parseLineBreak()
parseLink()

$listIndex
$xpath
$options

N/A

File: vendor/phpoffice/phpword/src/PhpWord/Shared/Html.php
Package: Default
Class hierarchy: \PhpOffice\PhpWord\Shared\Html

Tags

SuppressWarnings	(PHPMD.UnusedPrivateMethod) For readWPNode

Properties

$listIndex

$listIndex :

Type

$xpath

$xpath :

Type

$options

$options :

Type

Methods

addHtml()

addHtml(\PhpOffice\PhpWord\Element\AbstractContainer  $element, string  $html, boolean  $fullHTML = false, boolean  $preserveWhiteSpace = true,   $options = null)

Add HTML parts.

Note: $stylesheet parameter is removed to avoid PHPMD error for unused parameter Warning: Do not pass user-generated HTML here, as that would allow an attacker to read arbitrary files or perform server-side request forgery by passing local file paths or URLs in .

Parameters

\PhpOffice\PhpWord\Element\AbstractContainer	$element	Where the parts need to be added
string	$html	The code to parse
boolean	$fullHTML	If it's a full HTML, no need to add 'body' tag
boolean	$preserveWhiteSpace	If false, the whitespaces between nodes will be removed
	$options

parseInlineStyle()

parseInlineStyle(\DOMNode  $node, array  $styles = array()) : array

parse Inline style of a node

Parameters

\DOMNode	$node	Node to check on attributes and to compile a style array
array	$styles	is supplied, the inline style attributes are added to the already existing style

Returns

array

parseNode()

parseNode(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element, array  $styles = array(), array  $data = array())

Parse a node and add a corresponding element to the parent element.

Parameters

\DOMNode	$node	node to parse
\PhpOffice\PhpWord\Element\AbstractContainer	$element	object to add an element corresponding with the node
array	$styles	Array with all styles
array	$data	Array to transport data to a next level in the DOM tree, for example level of listitems

parseChildNodes()

parseChildNodes(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element, array  $styles, array  $data)

Parse child nodes.

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
array	$styles
array	$data

parseParagraph()

parseParagraph(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element,   $styles) : \PhpOffice\PhpWord\Element\TextRun

Parse paragraph node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
	$styles

Returns

\PhpOffice\PhpWord\Element\TextRun

parseHeading()

parseHeading(\PhpOffice\PhpWord\Element\AbstractContainer  $element,   $styles, string  $argument1) : \PhpOffice\PhpWord\Element\TextRun

Parse heading node

Parameters

\PhpOffice\PhpWord\Element\AbstractContainer	$element
	$styles
string	$argument1	Name of heading style

Returns

\PhpOffice\PhpWord\Element\TextRun

static

Inherited from: \PhpOffice\PhpWord\Shared\Html

Tags

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

parseText()

parseText(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element,   $styles)

Parse text node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
	$styles

parseProperty()

parseProperty(  $styles, string  $argument1, string  $argument2)

Parse property node

Parameters

	$styles
string	$argument1	Style name
string	$argument2	Style value

parseSpan()

parseSpan(\DOMNode  $node,   $styles)

Parse span node

Parameters

\DOMNode	$node
	$styles

parseTable()

parseTable(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element,   $styles) : \PhpOffice\PhpWord\Element\Table

Parse table node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
	$styles

Returns

\PhpOffice\PhpWord\Element\Table —

$element

static

Inherited from: \PhpOffice\PhpWord\Shared\Html

Tags

todo	As soon as TableItem, RowItem and CellItem support relative width and height

parseRow()

parseRow(\DOMNode  $node, \PhpOffice\PhpWord\Element\Table  $element,   $styles) : \PhpOffice\PhpWord\Element\Row

Parse a table row

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\Table	$element
	$styles

Returns

\PhpOffice\PhpWord\Element\Row —

$element

parseCell()

parseCell(\DOMNode  $node, \PhpOffice\PhpWord\Element\Table  $element,   $styles) : \PhpOffice\PhpWord\Element\Cell|\PhpOffice\PhpWord\Element\TextRun

Parse table cell

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\Table	$element
	$styles

Returns

\PhpOffice\PhpWord\Element\Cell|\PhpOffice\PhpWord\Element\TextRun —

$element

shouldAddTextRun()

shouldAddTextRun(\DOMNode  $node) : boolean

Checks if $node contains an HTML element that cannot be added to TextRun

Parameters

\DOMNode

$node

Returns

boolean —

Returns true if the node contains an HTML element that cannot be added to TextRun

recursiveParseStylesInHierarchy()

recursiveParseStylesInHierarchy(\DOMNode  $node, array  $style)

Recursively parses styles on parent nodes TODO if too slow, add caching of parent nodes, !! everything is static here so watch out for concurrency !!

Parameters

\DOMNode	$node
array	$style

parseList()

parseList(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element,   $styles,   $data)

Parse list node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
	$styles
	$data

getListStyle()

getListStyle(boolean  $isOrderedList) : array

Parameters

boolean

$isOrderedList

Returns

array

parseListItem()

parseListItem(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element,   $styles, array  $data)

Parse list item node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
	$styles
array	$data

static

Inherited from: \PhpOffice\PhpWord\Shared\Html

Tags

todo	This function is almost the same like `parseChildNodes`. Merged? As soon as ListItem inherits from AbstractContainer or TextRun delete parsing part of childNodes

parseStyle()

parseStyle(\DOMAttr  $attribute, array  $styles) : array

Parse style

Parameters

\DOMAttr	$attribute
array	$styles

Returns

array

parseImage()

parseImage(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element) : \PhpOffice\PhpWord\Element\Image

Parse image node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element

Returns

\PhpOffice\PhpWord\Element\Image

mapBorderStyle()

mapBorderStyle(string  $cssBorderStyle) : null|string

Transforms a CSS border style into a word border style

Parameters

string

$cssBorderStyle

Returns

null|string

mapAlign()

mapAlign(string  $cssAlignment) : string|null

Transforms a HTML/CSS alignment into a \PhpOffice\PhpWord\SimpleType\Jc

Parameters

string

$cssAlignment

Returns

string|null

parseLineBreak()

parseLineBreak(\PhpOffice\PhpWord\Element\AbstractContainer  $element)

Parse line break

Parameters

\PhpOffice\PhpWord\Element\AbstractContainer

$element

parseLink()

parseLink(\DOMNode  $node, \PhpOffice\PhpWord\Element\AbstractContainer  $element, array  $styles)

Parse link node

Parameters

\DOMNode	$node
\PhpOffice\PhpWord\Element\AbstractContainer	$element
array	$styles