|
const | ZIP_WRAPPER = 'zip://' |
|
◆ fileExistsWithinZip()
Box\Spout\Reader\Wrapper\XMLReader::fileExistsWithinZip |
( |
| $zipStreamURI | ) |
|
|
protected |
Returns whether the file at the given location exists.
- Parameters
-
string | $zipStreamURI | URI of a zip stream, e.g. "zip://file.zip#path/inside.xml" |
- Return values
-
bool | TRUE if the file exists, FALSE otherwise |
◆ getCurrentNodeName()
Box\Spout\Reader\Wrapper\XMLReader::getCurrentNodeName |
( |
| ) |
|
- Return values
-
string | The name of the current node, un-prefixed |
◆ getRealPathURIForFileInZip()
Box\Spout\Reader\Wrapper\XMLReader::getRealPathURIForFileInZip |
( |
| $zipFilePath, |
|
|
| $fileInsideZipPath ) |
Returns the real path for the given path components.
This is useful to avoid issues on some Windows setup.
- Parameters
-
string | $zipFilePath | Path to the ZIP file |
string | $fileInsideZipPath | Relative or absolute path of the file inside the zip |
- Return values
-
◆ isPositionedOnEndingNode()
Box\Spout\Reader\Wrapper\XMLReader::isPositionedOnEndingNode |
( |
| $nodeName | ) |
|
- Parameters
-
- Return values
-
bool | Whether the XML Reader is currently positioned on the ending node with given name |
◆ isPositionedOnStartingNode()
Box\Spout\Reader\Wrapper\XMLReader::isPositionedOnStartingNode |
( |
| $nodeName | ) |
|
- Parameters
-
- Return values
-
bool | Whether the XML Reader is currently positioned on the starting node with given name |
◆ next()
Box\Spout\Reader\Wrapper\XMLReader::next |
( |
| $localName = null | ) |
|
Move cursor to next node skipping all subtrees.
- See also
- XMLReader::next
- Parameters
-
string | null | $localName | The name of the next node to move to |
- Exceptions
-
- Return values
-
bool | TRUE on success or FALSE on failure |
◆ openFileInZip()
Box\Spout\Reader\Wrapper\XMLReader::openFileInZip |
( |
| $zipFilePath, |
|
|
| $fileInsideZipPath ) |
Opens the XML Reader to read a file located inside a ZIP file.
- Parameters
-
string | $zipFilePath | Path to the ZIP file |
string | $fileInsideZipPath | Relative or absolute path of the file inside the zip |
- Return values
-
bool | TRUE on success or FALSE on failure |
◆ read()
Box\Spout\Reader\Wrapper\XMLReader::read |
( |
| ) |
|
Move to next node in document.
- See also
- XMLReader::read
- Exceptions
-
- Return values
-
bool | TRUE on success or FALSE on failure |
◆ readUntilNodeFound()
Box\Spout\Reader\Wrapper\XMLReader::readUntilNodeFound |
( |
| $nodeName | ) |
|
Read until the element with the given name is found, or the end of the file.
- Parameters
-
string | $nodeName | Name of the node to find |
- Exceptions
-
- Return values
-
bool | TRUE on success or FALSE on failure |
The documentation for this class was generated from the following file:
- lib/spout/src/Spout/Reader/Wrapper/XMLReader.php