Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Query Class Reference

Query DOM structures based on CSS selectors and/or XPath. More...

Public Member Functions

 __construct ($document=null, $encoding=null)
 Constructor.
 
 setEncoding ($encoding)
 Set document encoding.
 
 getEncoding ()
 Get document encoding.
 
 setDocument ($document, $encoding=null)
 Set document to query.
 
 setDocumentHtml ($document, $encoding=null)
 Register HTML document.
 
 setDocumentXhtml ($document, $encoding=null)
 Register XHTML document.
 
 setDocumentXml ($document, $encoding=null)
 Register XML document.
 
 getDocument ()
 Retrieve current document.
 
 getDocumentType ()
 Get document type.
 
 getDocumentErrors ()
 Get any DOMDocument errors found.
 
 execute ($query, DOMNode $contextNode=null)
 Perform a CSS selector query.
 
 queryXpath ($xpathQuery, $query=null, DOMNode $contextNode=null)
 Perform an XPath query.
 
 registerXpathNamespaces ($xpathNamespaces)
 Register XPath namespaces.
 
 registerXpathPhpFunctions ($xpathPhpFunctions=true)
 Register PHP Functions to use in internal DOMXPath.
 

Public Attributes

const DOC_XML = 'docXml'
 #@+ Document types
 
const DOC_HTML = 'docHtml'
 
const DOC_XHTML = 'docXhtml'
 

Protected Member Functions

 getNodeList ($document, $xpathQuery, DOMNode $contextNode=null)
 Prepare node list.
 

Protected Attributes

 $document
 
 $documentErrors = false
 
 $docType
 
 $encoding
 
 $xpathNamespaces = []
 
 $xpathPhpFunctions
 

Detailed Description

Query DOM structures based on CSS selectors and/or XPath.

Deprecated:
See Also

Constructor & Destructor Documentation

__construct (   $document = null,
  $encoding = null 
)

Constructor.

Parameters
null | string$document
null | string$encoding

Member Function Documentation

execute (   $query,
DOMNode  $contextNode = null 
)

Perform a CSS selector query.

Parameters
string$query
DOMNode$contextNode
Returns
NodeList
getDocument ( )

Retrieve current document.

Returns
string
getDocumentErrors ( )

Get any DOMDocument errors found.

Returns
false|array
getDocumentType ( )

Get document type.

Returns
string
getEncoding ( )

Get document encoding.

Returns
null|string
getNodeList (   $document,
  $xpathQuery,
DOMNode  $contextNode = null 
)
protected

Prepare node list.

Parameters
DOMDocument$document
string | array$xpathQuery
DOMNode$contextNode
Returns
Exceptions
\ErrorExceptionIf query cannot be executed
queryXpath (   $xpathQuery,
  $query = null,
DOMNode  $contextNode = null 
)

Perform an XPath query.

Parameters
string | array$xpathQuery
string | null$queryCSS selector query
DOMNode$contextNode$contextNode
Exceptions
Exception\RuntimeException
Returns
NodeList
registerXpathNamespaces (   $xpathNamespaces)

Register XPath namespaces.

Parameters
array$xpathNamespaces
Returns
void
registerXpathPhpFunctions (   $xpathPhpFunctions = true)

Register PHP Functions to use in internal DOMXPath.

Parameters
bool$xpathPhpFunctions
Returns
void
setDocument (   $document,
  $encoding = null 
)

Set document to query.

Parameters
string$document
null | string$encodingDocument encoding
Returns
Query
setDocumentHtml (   $document,
  $encoding = null 
)

Register HTML document.

Parameters
string$document
null | string$encodingDocument encoding
Returns
Query
setDocumentXhtml (   $document,
  $encoding = null 
)

Register XHTML document.

Parameters
string$document
null | string$encodingDocument encoding
Returns
Query
setDocumentXml (   $document,
  $encoding = null 
)

Register XML document.

Parameters
string$document
null | string$encodingDocument encoding
Returns
Query
setEncoding (   $encoding)

Set document encoding.

Parameters
string$encoding
Returns
Query

Member Data Documentation

$docType
protected
$document
protected
$documentErrors = false
protected
$encoding
protected
$xpathNamespaces = []
protected
$xpathPhpFunctions
protected
const DOC_HTML = 'docHtml'
const DOC_XHTML = 'docXhtml'
const DOC_XML = 'docXml'

#@+ Document types