\PhpOffice\CommonXMLReader

XML Reader wrapper

Summary

Methods

Properties

Constants

getDomFromZip()
getDomFromString()
getElements()
registerNamespace()
getElement()
getAttribute()
getValue()
countElements()
elementExists()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$dom
$xpath

N/A

File: vendor/phpoffice/common/src/Common/XMLReader.php
Package: Default
Class hierarchy: \PhpOffice\Common\XMLReader

Properties

$dom

$dom : \DOMDocument

DOMDocument object

Type

\DOMDocument

$xpath

$xpath : \DOMXpath

DOMXpath object

Type

\DOMXpath

Methods

getDomFromZip()

getDomFromZip(string  $zipFile, string  $xmlFile) : \DOMDocument|false

Get DOMDocument from ZipArchive

Parameters

string	$zipFile
string	$xmlFile

Throws

\Exception

Returns

\DOMDocument|false

getDomFromString()

getDomFromString(string  $content) : \DOMDocument

Get DOMDocument from content string

Parameters

string

$content

Returns

\DOMDocument

getElements()

getElements(string  $path, \DOMElement  $contextNode = null) : \DOMNodeList

Get elements

Parameters

string	$path
\DOMElement	$contextNode

Returns

\DOMNodeList

registerNamespace()

registerNamespace(string  $prefix, string  $namespaceURI) : boolean

Registers the namespace with the DOMXPath object

Parameters

string	$prefix	The prefix
string	$namespaceURI	The URI of the namespace

Throws

\InvalidArgumentException: If called before having loaded the DOM document

Returns

boolean —

true on success or false on failure

getElement()

getElement(string  $path, \DOMElement  $contextNode = null) : \DOMElement|null

Get element

Parameters

string	$path
\DOMElement	$contextNode

Returns

\DOMElement|null

getAttribute()

getAttribute(string  $attribute, \DOMElement  $contextNode = null, string  $path = null) : string|null

Get element attribute

Parameters

string	$attribute
\DOMElement	$contextNode
string	$path

Returns

string|null

getValue()

getValue(string  $path, \DOMElement  $contextNode = null) : string|null

Get element value

Parameters

string	$path
\DOMElement	$contextNode

Returns

string|null

countElements()

countElements(string  $path, \DOMElement  $contextNode = null) : integer

Count elements

Parameters

string	$path
\DOMElement	$contextNode

Returns

integer

elementExists()

elementExists(string  $path, \DOMElement  $contextNode = null) : boolean

Element exists

Parameters

string	$path
\DOMElement	$contextNode

Returns

boolean