README

Xmltoolkit is a PHP class that provides various utilities for manipulating XML documents. It allows loading XML from files or strings, performing XPath queries (with namespace support), and modifying XML elements and attributes.

Installation

Use Composer to install the package:

composer require ottosmops/xmltoolkit

Usage

$elements = $xml->findElementsByAttributeRegex('type', '/^sp./'); $xml->replaceAttributeValueRegex('type', '/^sp./', 'normal'); $elements = $xml->findElementsByTextRegex('/old./'); $xml->replaceElementTextRegex('/old./', 'newtext');

require 'vendor/autoload.php';
use Ottosmops\Xmltoolkit;

$xml = new Xmltoolkit();
$xml->loadFromFile('example.xml');
$xml->renameTagByXPath('//a', 'ref');
$xml->saveToFile('example.xml', true); // pretty print

// Find elements by attribute value
$elements = $xml->findElementsByAttributeValue('type', 'special');

// Replace attribute value
$xml->replaceAttributeValue('type', 'special', 'normal');

// Find elements by text content
$elements = $xml->findElementsByTextContent('oldtext');

// Replace text content
$xml->replaceElementTextContent('oldtext', 'newtext');

// Save as pretty-printed string
$prettyXml = $xml->saveToString(true);

Namespace Support

You can register XML namespaces for XPath queries:

$xml = new Ottosmops\Xmltoolkit();
$xml->registerNamespaces(['ns' => 'http://example.com/ns']);
$xml->loadFromFile('example.xml');
$nodes = $xml->queryXPath('//ns:tag');

Methods

...existing code...

Load an XML file into the DOM object and ensure it is UTF-8 encoded.

public function loadFromFile(string $filePath): bool

Load an XML string into the DOM object and ensure it is UTF-8 encoded.

public function loadFromString(string $xmlString): bool

Load an XML/HTML Fragment

public function loadFromFragment(string $xmlFragment): bool

Save the XML document to a file and ensure it is UTF-8 encoded.

public function saveToFile(string $filePath, bool $prettyPrint = false): bool

Returns the XML as a string and ensures it is UTF-8 encoded.

public function saveToString(bool $prettyPrint = false): string

Find elements by attribute value.

public function findElementsByAttributeValue(string $attributeName, string $attributeValue): array

Replace attribute value for all elements with a given attribute value.

public function replaceAttributeValue(string $attributeName, string $oldValue, string $newValue): void

Find elements by text content.

public function findElementsByTextContent(string $textContent): array

Replace text content for all elements with a given text content.

public function replaceElementTextContent(string $oldText, string $newText): void

Rename a tag found by an XPath expression.

public function renameTagByXPath(string $xpathExpression, string $newTagName): 
void

Rename an attribute found by an XPath expression.

public function renameAttributeByXPath(string $xpathExpression, string $oldAttributeName, string $newAttributeName): void

Add a new attribute to a tag found by an XPath expression.

public function addAttributeByXPath(string $xpathExpression, string $attributeName, string $attributeValue): void

Remove an attribute from a tag found by an XPath expression.

public function removeAttributeByXPath(string $xpathExpression, string $attributeName): void

Does an arbitrary XPath query and returns the found nodes as an array.

public function queryXPath(string $xpathExpression): array

Inserts an HTML string after the nodes found by an XPath expression.

public function appendHtmlToXPath(string $xpathExpression, string $htmlString): void

Removes an element found by an XPath expression.

    public function removeElementByXPath(string $xpathExpression): void

Wrap an element found by an XPath expression with a new element.

public function wrapElementByXPath(string $xpathExpression, string $wrapperTagName): void

Remove an element but keep its content (unwrap the element) based on an XPath expression.

public function unwrapElementByXPath(string $xpathExpression): void

Tests

Regex Features

Methods

Find elements by attribute value using regex:

public function findElementsByAttributeRegex(string $attributeName, string $pattern): array

Replace attribute value using regex:

public function replaceAttributeValueRegex(string $attributeName, string $pattern, string $replacement): void

Find elements by text content using regex:

public function findElementsByTextRegex(string $pattern): array

Replace text content using regex:

public function replaceElementTextRegex(string $pattern, string $replacement): void

Usage

$elements = $xml->findElementsByAttributeRegex('type', '/^sp.*/');
$xml->replaceAttributeValueRegex('type', '/^sp.*/', 'normal');
$elements = $xml->findElementsByTextRegex('/old.*/');
$xml->replaceElementTextRegex('/old.*/', 'newtext');

Tests

Run the tests with PHPUnit:

vendor/bin/phpunit