A common use for XMLReader::close is processing data without rebuilding the operation manually. Closes the reader and releases the XML input source.
What Is XMLReader::close in PHP?
Closes the reader and releases the XML input source.
Syntax:
XMLReader::close()
Parameters and Return Value
This method takes no arguments.
Check the returned value, including false when applicable, or handle exceptions for invalid input. The required XML/DOM extension must be installed.
Example 1: Basic Usage
This example demonstrates the main operation with a small, controlled input.
<?php
$xmlReader = new XMLReader();
$xmlReader->XML("<catalog><book id=\"b1\">Guide</book><book id=\"b2\">Reference</book></catalog>");
$xmlReader->close();
echo "Reader closed";
The result depends on the supplied data and the documented operation. Output is not shown as a fixed value when files, locales or runtime configuration can change it.
Example 2: Another Input
This example changes the input or surrounding setup to illustrate another behavior.
<?php
$xmlReader = new XMLReader();
$xmlReader->XML("<catalog><book id=\"b1\">Updated guide</book><book id=\"b2\">Reference</book></catalog>");
$xmlReader->close();
echo "Reader closed";
The result depends on the supplied data and the documented operation. Output is not shown as a fixed value when files, locales or runtime configuration can change it.
Practical Example
This application-style example shows a self-contained usage pattern and checks its result.
<?php
$xmlReader = new XMLReader();
$xmlReader->XML("<inventory><book id=\"b1\">Inventory item</book><book id=\"b2\">Reference</book></inventory>");
$xmlReader->close();
echo "Reader closed";
The result depends on the supplied data and the documented operation. Output is not shown as a fixed value when files, locales or runtime configuration can change it.
Important Behavior and Edge Cases
- The cursor is forward-only; position it on the intended element before reading attributes or text. Disable network access for untrusted XML, and validate document size.
- Use the intended input type and handle empty or malformed values explicitly.
- Where this API requires an extension, version, or file, document that dependency before using it in a real application.
Comparison With Related Functions
| Function or Method | When to Use It |
|---|---|
XMLReader::close | Closes the reader and releases the XML input source. |
XMLReader::read | Advances the streaming cursor to the next XML node. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Using this API without checking the required input or extension | The cursor is forward-only; position it on the intended element before reading attributes or text. Disable network access for untrusted XML, and validate document size. |
| Reading an attribute before positioning the cursor | Call read() until the reader reaches the expected element; only then inspect its attributes. |
| Reusing a forward-only cursor | Create a new reader or buffer only the selected data when another pass is necessary. |
Key Takeaways
- Closes the reader and releases the XML input source.
- The cursor is forward-only; position it on the intended element before reading attributes or text. Disable network access for untrusted XML, and validate document size.
- Test both the expected case and at least one failure or empty-input case before deployment.
Closes the reader and releases the XML input source. Use it when the operation fits your input, output and validation requirements.