s9e\SweetDOM\Document

Complexity

Total Complexity

17

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	evaluate()	0	3	1
A	__construct()	0	8	2
A	firstOf()	0	3	1
A	needsWorkarounds()	0	15	3
A	isEqualNode()	0	5	2
A	getExtendedClassMap()	0	11	2
A	getExtendedNamespace()	0	13	3
A	xpath()	0	7	1
A	query()	0	11	2

<?php declare(strict_types=1);

/**
* @package   s9e\SweetDOM
* @copyright Copyright (c) The s9e authors
* @license   http://www.opensource.org/licenses/mit-license.php The MIT License
*/
namespace s9e\SweetDOM;

use DOMDocument;
use DOMNode;
use DOMNodeList;
use DOMXPath;
use RuntimeException;
use const PHP_VERSION;
use function func_get_args, method_exists, libxml_get_last_error, trim, version_compare;

/**
* @method Attr|false createAttribute(string $localName)
* @method Attr|false createAttributeNS(?string $namespace, string $qualifiedName)
* @method CdataSection|false createCDATASection(string $data)
* @method Comment createComment(string $data)
* @method DocumentFragment createDocumentFragment()
* @method Element|false createElement(string $localName, string $value = '')
* @method Element|false createElementNS(?string $namespace, string $qualifiedName, string $value = '')
* @method Text createTextNode(string $data)
* @method ?Element getElementById(string $elementId)
* @property ?DocumentType $doctype
* @property ?Element $documentElement
* @property ?Element $firstElementChild
* @property ?Element $lastElementChild
* @property ?Document $ownerDocument
* @property ?Element $parentElement
*/
class Document extends DOMDocument
{
	public NodeCreator $nodeCreator;

	/**
	* @link https://www.php.net/manual/domdocument.construct.php
	*/
	public function __construct(string $version = '1.0', string $encoding = '')
	{
		parent::__construct($version, $encoding);

		$this->nodeCreator = new NodeCreator($this);
		foreach ($this->getExtendedClassMap() as $baseClass => $extendedClass)
		{
			$this->registerNodeClass($baseClass, $extendedClass);
		}
	}

	/**
	* Evaluate and return the result of a given XPath expression
	*/
	public function evaluate(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed
	{
		return $this->xpath('evaluate', func_get_args());
	}

	/**
	* Evaluate and return the first element of a given XPath query
	*/
	public function firstOf(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): ?DOMNode
	{
		return $this->query(...func_get_args())->item(0);
	}

	public function isEqualNode(?DOMNode $otherNode): bool
	{
		return method_exists('DOMDocument', 'isEqualNode')
		     ? parent::isEqualNode($otherNode)
		     : NodeComparator::isEqualNode($this, $otherNode);
	}

	/**
	* Evaluate and return the result of a given XPath query
	*/
	public function query(string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): DOMNodeList
	{
		$result = $this->xpath('query', func_get_args());
		if ($result === false)
		{
			$errorMessage = libxml_get_last_error()?->message ?? 'No error message';

			throw new RuntimeException('Invalid XPath query: ' . trim($errorMessage));
		}

		return $result;
	}

	protected function getExtendedClassMap(): array
	{
		$baseNames = ['Attr', 'CdataSection', 'Comment', 'DocumentFragment', 'Element', 'Text'];
		$classMap  = [];
		$namespace = $this->getExtendedNamespace(PHP_VERSION);
		foreach ($baseNames as $baseName)
		{
			$classMap['DOM' . $baseName] = $namespace . '\\' . $baseName;
		}

		return $classMap;
	}

	protected function getExtendedNamespace(string $phpVersion): string
	{
		$namespace = __NAMESPACE__;
		if ($this->needsWorkarounds($phpVersion))
		{
			$namespace .= '\\PatchedNodes';
		}
		elseif (version_compare($phpVersion, '8.3.0', '<'))
		{
			$namespace .= '\\ForwardCompatibleNodes';
		}

		return $namespace;
	}

	protected function needsWorkarounds(string $phpVersion): bool
	{
		if (version_compare($phpVersion, '8.2.10', '>='))
		{
			// PHP ^8.2.10 needs no workarounds
			return false;
		}
		if (version_compare($phpVersion, '8.1.23', '<'))
		{
			// Anything older than 8.1.23 does
			return true;
		}

		// ~8.1.23 is okay, anything between 8.2.0 and 8.2.9 needs workarounds
		return version_compare($phpVersion, '8.2.0-dev', '>=');
	}

	/**
	* Execute a DOMXPath method and return the result
	*/
	protected function xpath(string $methodName, array $args): mixed
	{
		$xpath = new DOMXPath($this);
		$xpath->registerNamespace('xsl', 'http://www.w3.org/1999/XSL/Transform');
		$xpath->registerNodeNamespaces = true;

		return $xpath->$methodName(...$args);
	}
}