[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Reader/Wrapper/ -> XMLReader.php (summary)

(no description)

File Size: 184 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

XMLReader:: (10 methods):
  open()
  convertURIToUseRealPath()
  isZipStream()
  isRunningHHVM()
  fileExistsWithinZip()
  read()
  readUntilNodeFound()
  next()
  isPositionedOnStartingNode()
  isPositionedOnEndingNode()


Class: XMLReader  - X-Ref

Class XMLReader
Wrapper around the built-in XMLReader

open($URI, $encoding = null, $options = 0)   X-Ref
Set the URI containing the XML to parse

param: string $URI URI pointing to the document
param: string|null|void $encoding The document encoding
param: int $options A bitmask of the LIBXML_* constants
return: bool TRUE on success or FALSE on failure

convertURIToUseRealPath($URI)   X-Ref
Updates the given URI to use a real path.
This is to avoid issues on some Windows setup.

param: string $URI URI
return: string The URI using a real path

isZipStream($URI)   X-Ref
Returns whether the given URI is a zip stream.

param: string $URI URI pointing to a document
return: bool TRUE if URI is a zip stream, FALSE otherwise

isRunningHHVM()   X-Ref
Returns whether the current environment is HHVM

return: bool TRUE if running on HHVM, FALSE otherwise

fileExistsWithinZip($zipStreamURI)   X-Ref
Returns whether the file at the given location exists

param: string $zipStreamURI URI of a zip stream, e.g. "zip://file.zip#path/inside.xml"
return: bool TRUE if the file exists, FALSE otherwise

read()   X-Ref
Move to next node in document

return: bool TRUE on success or FALSE on failure

readUntilNodeFound($nodeName)   X-Ref
Read until the element with the given name is found, or the end of the file.

param: string $nodeName Name of the node to find
return: bool TRUE on success or FALSE on failure

next($localName = null)   X-Ref
Move cursor to next node skipping all subtrees

param: string|void $localName The name of the next node to move to
return: bool TRUE on success or FALSE on failure

isPositionedOnStartingNode($nodeName)   X-Ref

param: string $nodeName
return: bool Whether the XML Reader is currently positioned on the starting node with given name

isPositionedOnEndingNode($nodeName)   X-Ref

param: string $nodeName
return: bool Whether the XML Reader is currently positioned on the ending node with given name



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1