webservco / document-object-model

v2.3.0 2026-10-11 16:34 UTC

Requires

• php: ^8.4

Requires (Dev)

• pds/skeleton: ^1
• phan/phan: ^6
• php-parallel-lint/php-console-highlighter: ^1
• php-parallel-lint/php-parallel-lint: ^1
• phpmd/phpmd: ^3
• phpstan/phpstan: ^2
• phpstan/phpstan-deprecation-rules: ^2
• phpstan/phpstan-phpunit: ^2
• phpstan/phpstan-strict-rules: ^2
• phpunit/phpunit: ^13
• slevomat/coding-standard: ^8
• squizlabs/php_codesniffer: ^4
• vimeo/psalm: ^6
• webservco/coding-standards: ^2
• webservco/component-common: ^2

MIT

• Radu Maier

• component
• webservco

Published on Packagist.org on 2026-10-11 16:42 UTC

README

A PHP component/library. Please see webservco/sandbox for an example project using these types of components.

Typed helpers around PHP's DOM classes, for parsing XML and HTML without an instanceof check after every XPath query.

• Requires: ext-dom

Installation

composer require webservco/document-object-model

Usage

use WebServCo\DocumentObjectModel\Container\DOMServiceContainer;

$domDocument = new DOMDocument();
$domDocument->loadXML($xml);
$domXPath = new DOMXPath($domDocument);

// \WebServCo\DocumentObjectModel\Contract\Container\DOMServiceContainerInterface
$domServiceContainer = new DOMServiceContainer();

foreach ($domServiceContainer->getDOMXPathService()->iterateDOMElementsFromDOMXPath($domXPath, '//release') as $release) {
    // ?DOMElement: null when the release has no <title>.
    $title = $domServiceContainer->getDOMElementService()->getDOMElementFromDOMElementByTagName($release, 'title');
}

// ?DOMElement
$firstArtist = $domServiceContainer->getDOMXPathService()->getFirstDOMElementFromDOMXPath($domXPath, '//artist');

Contracts

Interface	Implementation	Purpose
Contract\Container\DOMServiceContainerInterface	Container\DOMServiceContainer	Gives access to the services below.
Contract\DOMXPath\DOMXPathServiceInterface	Service\DOMXPath\DOMXPathService	First element, or a generator of elements, for a query.
Contract\DOMElement\DOMElementServiceInterface	Service\DOMElement\DOMElementService	First child element with a tag name.
Contract\DOMNodeList\DOMNodeListServiceInterface	Service\DOMNodeList\DOMNodeListService	First element of a node list.
Contract\DOMDocument\DOMDocumentServiceInterface	Service\DOMDocument\DOMDocumentService	Copies an element into a new document of its own.

Namespaces are relative to WebServCo\DocumentObjectModel\.

Notes

Methods that look for one element return null when nothing matches. An invalid XPath query throws an UnexpectedValueException. A query that matches text or attribute nodes gives null from the first-element methods, and makes iterateDOMElementsFromDOMXPath() throw. Write queries that select elements.

Appending a node that belongs to another document fails with "Wrong Document Error". createDOMDocumentFromDOMElement() imports the node first to get around that.

Development

# Start project.
ddev start
# Install dependencies.
ddev c u
# Run all validations.
ddev c c
# Run unit tests.
ddev c test:dox

License

MIT