Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/spout/src/Spout/Reader/Wrapper/ -> XMLReader.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

(no description)

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

Defines 1 class

XMLReader:: (10 methods):
  openFileInZip()
  getRealPathURIForFileInZip()
  fileExistsWithinZip()
  read()
  readUntilNodeFound()
  next()
  isPositionedOnStartingNode()
  isPositionedOnEndingNode()
  isPositionedOnNode()
  getCurrentNodeName()


Class: XMLReader  - X-Ref

Class XMLReader
Wrapper around the built-in XMLReader

openFileInZip($zipFilePath, $fileInsideZipPath)   X-Ref
Opens the XML Reader to read a file located inside a ZIP file.

param: string $zipFilePath Path to the ZIP file
param: string $fileInsideZipPath Relative or absolute path of the file inside the zip
return: bool TRUE on success or FALSE on failure

getRealPathURIForFileInZip($zipFilePath, $fileInsideZipPath)   X-Ref
Returns the real path for the given path components.
This is useful to avoid issues on some Windows setup.

param: string $zipFilePath Path to the ZIP file
param: string $fileInsideZipPath Relative or absolute path of the file inside the zip
return: string The real path URI

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|null $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

isPositionedOnNode($nodeName, $nodeType)   X-Ref

param: string $nodeName
param: int $nodeType
return: bool Whether the XML Reader is currently positioned on the node with given name and type

getCurrentNodeName()   X-Ref

return: string The name of the current node, un-prefixed