Document::createElementXSL() - Code Metrics - Inspection of "Added support for setting the text content of some..." - s9e/SweetDOM - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 109652...4c65b4 )

by Josh

created 2020-05-24 15:41 UTC

Document::createElementXSL() A

↳ Parent: Document

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	6
ccs	5
cts	5
cp	1
crap	1
rs	10

<?php declare(strict_types=1);

/**
* @package   s9e\SweetDOM
* @copyright Copyright (c) 2019-2020 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;

class Document extends DOMDocument
{
	/**
	* @link https://www.php.net/manual/domdocument.construct.php
	*
	* @param string $version  Version number of the document
	* @param string $encoding Encoding of the document
	*/
	public function __construct(string $version = '1.0', string $encoding = 'utf-8')
	{
		parent::__construct($version, $encoding);

		$this->registerNodeClass('DOMElement', Element::class);
	}

	/**
	* Create and return an xsl:apply-templates element
	*
	* @param  string  $select XPath expression for the "select" attribute
	* @return Element
	*/
	public function createXslApplyTemplates(string $select = null): Element
	{
		$element = $this->createElementXSL('apply-templates');
		if (isset($select))
		{
			$element->setAttribute('select', $select);
		}

		return $element;
	}

	/**
	* Create and return an xsl:attribute element
	*
	* @param  string  $name Attribute's name
	* @param  string  $text Text content for the element
	* @return Element
	*/
	public function createXslAttribute(string $name, string $text = ''): Element
	{
		$element = $this->createElementXSL('attribute', $text);
		$element->setAttribute('name', $name);

		return $element;
	}

	/**
	* Create and return an xsl:choose element
	*
	* @return Element
	*/
	public function createXslChoose(): Element
	{
		return $this->createElementXSL('choose');
	}

	/**
	* Create and return an xsl:comment element
	*
	* @param  string  $text Text content for the comment
	* @return Element
	*/
	public function createXslComment(string $text = ''): Element
	{
		return $this->createElementXSL('comment', $text);
	}

	/**
	* Create and return an xsl:copy-of element
	*
	* @param  string  $select XPath expression for the "select" attribute
	* @return Element
	*/
	public function createXslCopyOf(string $select): Element
	{
		$element = $this->createElementXSL('copy-of');
		$element->setAttribute('select', $select);

		return $element;
	}

	/**
	* Create and return an xsl:if element
	*
	* @param  string  $test XPath expression for the "test" attribute
	* @param  string  $text Text content for the element
	* @return Element
	*/
	public function createXslIf(string $test, string $text = ''): Element
	{
		$element = $this->createElementXSL('if', $text);
		$element->setAttribute('test', $test);

		return $element;
	}

	/**
	* Create and return an xsl:otherwise element
	*
	* @param  string  $text Text content for the element
	* @return Element
	*/
	public function createXslOtherwise(string $text = ''): Element
	{
		return $this->createElementXSL('otherwise', $text);
	}

	/**
	* Create and return an xsl:text element
	*
	* @param  string  $text Text content for the element
	* @return Element
	*/
	public function createXslText(string $text = ''): Element
	{
		return $this->createElementXSL('text', $text);
	}

	/**
	* Create and return an xsl:value-of element
	*
	* @param  string  $select XPath expression for the "select" attribute
	* @return Element
	*/
	public function createXslValueOf(string $select): Element
	{
		$element = $this->createElementXSL('value-of');
		$element->setAttribute('select', $select);

		return $element;
	}

	/**
	* Create and return an xsl:variable element
	*
	* @param  string  $name   Name of the variable
	* @param  string  $select XPath expression
	* @return Element
	*/
	public function createXslVariable(string $name, string $select = null): Element
	{
		$element = $this->createElementXSL('variable');
		$element->setAttribute('name', $name);
		if (isset($select))
		{
			$element->setAttribute('select', $select);
		}

		return $element;
	}

	/**
	* Create and return an xsl:when element
	*
	* @param  string  $test XPath expression for the "test" attribute
	* @param  string  $text Text content for the element
	* @return Element
	*/
	public function createXslWhen(string $test, string $text = ''): Element
	{
		$element = $this->createElementXSL('when', $text);
		$element->setAttribute('test', $test);

		return $element;
	}

	/**
	* Evaluate and return the result of a given XPath expression
	*
	* @param  string  $expr           XPath expression
	* @param  DOMNode $node           Context node
	* @param  bool    $registerNodeNS Whether to register the node's namespace
	* @return mixed
	*/
	public function evaluate(string $expr, DOMNode $node = null, bool $registerNodeNS = true)
	{
		return $this->xpath('evaluate', func_get_args());
	}

	/**
	* Evaluate and return the first element of a given XPath query
	*
	* @param  string      $expr           XPath expression
	* @param  DOMNode     $node           Context node
	* @param  bool        $registerNodeNS Whether to register the node's namespace
	* @return DOMNode|null
	*/
	public function firstOf(string $expr, DOMNode $node = null, bool $registerNodeNS = true): ?DOMNode
	{
		return $this->xpath('query', func_get_args())->item(0);
	}

	/**
	* Evaluate and return the result of a given XPath query
	*
	* @param  string      $expr           XPath expression
	* @param  DOMNode     $node           Context node
	* @param  bool        $registerNodeNS Whether to register the node's namespace
	* @return DOMNodeList
	*/
	public function query(string $expr, DOMNode $node = null, bool $registerNodeNS = true): DOMNodeList
	{
		return $this->xpath('query', func_get_args());
	}

	/**
	* Create and return an XSL element
	*
	* @param  string  $name Element's local name
	* @param  string  $text Text content for the element
	* @return Element
	*/
	protected function createElementXSL(string $localName, string $text = ''): Element
	{
		return $this->createElementNS(
			'http://www.w3.org/1999/XSL/Transform',
			'xsl:' . $localName,
			htmlspecialchars($text, ENT_XML1)
		);
	}

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

		return call_user_func_array([$xpath, $methodName], $args);
	}
}

1		<?php declare(strict_types=1);
2
3		/**
4		* @package s9e\SweetDOM
5		* @copyright Copyright (c) 2019-2020 The s9e authors
6		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
7		*/
8		namespace s9e\SweetDOM;
9
10		use DOMDocument;
11		use DOMNode;
12		use DOMNodeList;
13		use DOMXPath;
14
15		class Document extends DOMDocument
16		{
17		/**
18		* @link https://www.php.net/manual/domdocument.construct.php
19		*
20		* @param string $version Version number of the document
21		* @param string $encoding Encoding of the document
22		*/
23	26	public function __construct(string $version = '1.0', string $encoding = 'utf-8')
24		{
25	26	parent::__construct($version, $encoding);
26
27	26	$this->registerNodeClass('DOMElement', Element::class);
28		}
29
30		/**
31		* Create and return an xsl:apply-templates element
32		*
33		* @param string $select XPath expression for the "select" attribute
34		* @return Element
35		*/
36	2	public function createXslApplyTemplates(string $select = null): Element
37		{
38	2	$element = $this->createElementXSL('apply-templates');
39	2	if (isset($select))
40		{
41	1	$element->setAttribute('select', $select);
42		}
43
44	2	return $element;
45		}
46
47		/**
48		* Create and return an xsl:attribute element
49		*
50		* @param string $name Attribute's name
51		* @param string $text Text content for the element
52		* @return Element
53		*/
54	2	public function createXslAttribute(string $name, string $text = ''): Element
55		{
56	2	$element = $this->createElementXSL('attribute', $text);
57	2	$element->setAttribute('name', $name);
58
59	2	return $element;
60		}
61
62		/**
63		* Create and return an xsl:choose element
64		*
65		* @return Element
66		*/
67	1	public function createXslChoose(): Element
68		{
69	1	return $this->createElementXSL('choose');
70		}
71
72		/**
73		* Create and return an xsl:comment element
74		*
75		* @param string $text Text content for the comment
76		* @return Element
77		*/
78	2	public function createXslComment(string $text = ''): Element
79		{
80	2	return $this->createElementXSL('comment', $text);
81		}
82
83		/**
84		* Create and return an xsl:copy-of element
85		*
86		* @param string $select XPath expression for the "select" attribute
87		* @return Element
88		*/
89	1	public function createXslCopyOf(string $select): Element
90		{
91	1	$element = $this->createElementXSL('copy-of');
92	1	$element->setAttribute('select', $select);
93
94	1	return $element;
95		}
96
97		/**
98		* Create and return an xsl:if element
99		*
100		* @param string $test XPath expression for the "test" attribute
101		* @param string $text Text content for the element
102		* @return Element
103		*/
104	2	public function createXslIf(string $test, string $text = ''): Element
105		{
106	2	$element = $this->createElementXSL('if', $text);
107	2	$element->setAttribute('test', $test);
108
109	2	return $element;
110		}
111
112		/**
113		* Create and return an xsl:otherwise element
114		*
115		* @param string $text Text content for the element
116		* @return Element
117		*/
118	2	public function createXslOtherwise(string $text = ''): Element
119		{
120	2	return $this->createElementXSL('otherwise', $text);
121		}
122
123		/**
124		* Create and return an xsl:text element
125		*
126		* @param string $text Text content for the element
127		* @return Element
128		*/
129	2	public function createXslText(string $text = ''): Element
130		{
131	2	return $this->createElementXSL('text', $text);
132		}
133
134		/**
135		* Create and return an xsl:value-of element
136		*
137		* @param string $select XPath expression for the "select" attribute
138		* @return Element
139		*/
140	1	public function createXslValueOf(string $select): Element
141		{
142	1	$element = $this->createElementXSL('value-of');
143	1	$element->setAttribute('select', $select);
144
145	1	return $element;
146		}
147
148		/**
149		* Create and return an xsl:variable element
150		*
151		* @param string $name Name of the variable
152		* @param string $select XPath expression
153		* @return Element
154		*/
155	2	public function createXslVariable(string $name, string $select = null): Element
156		{
157	2	$element = $this->createElementXSL('variable');
158	2	$element->setAttribute('name', $name);
159	2	if (isset($select))
160		{
161	1	$element->setAttribute('select', $select);
162		}
163
164	2	return $element;
165		}
166
167		/**
168		* Create and return an xsl:when element
169		*
170		* @param string $test XPath expression for the "test" attribute
171		* @param string $text Text content for the element
172		* @return Element
173		*/
174	2	public function createXslWhen(string $test, string $text = ''): Element
175		{
176	2	$element = $this->createElementXSL('when', $text);
177	2	$element->setAttribute('test', $test);
178
179	2	return $element;
180		}
181
182		/**
183		* Evaluate and return the result of a given XPath expression
184		*
185		* @param string $expr XPath expression
186		* @param DOMNode $node Context node
187		* @param bool $registerNodeNS Whether to register the node's namespace
188		* @return mixed
189		*/
190	2	public function evaluate(string $expr, DOMNode $node = null, bool $registerNodeNS = true)
191		{
192	2	return $this->xpath('evaluate', func_get_args());
193		}
194
195		/**
196		* Evaluate and return the first element of a given XPath query
197		*
198		* @param string $expr XPath expression
199		* @param DOMNode $node Context node
200		* @param bool $registerNodeNS Whether to register the node's namespace
201		* @return DOMNode\|null
202		*/
203	3	public function firstOf(string $expr, DOMNode $node = null, bool $registerNodeNS = true): ?DOMNode
204		{
205	3	return $this->xpath('query', func_get_args())->item(0);
206		}
207
208		/**
209		* Evaluate and return the result of a given XPath query
210		*
211		* @param string $expr XPath expression
212		* @param DOMNode $node Context node
213		* @param bool $registerNodeNS Whether to register the node's namespace
214		* @return DOMNodeList
215		*/
216	2	public function query(string $expr, DOMNode $node = null, bool $registerNodeNS = true): DOMNodeList
217		{
218	2	return $this->xpath('query', func_get_args());
219		}
220
221		/**
222		* Create and return an XSL element
223		*
224		* @param string $name Element's local name
225		* @param string $text Text content for the element
226		* @return Element
227		*/
228	19	protected function createElementXSL(string $localName, string $text = ''): Element
229		{
230	19	return $this->createElementNS(
231	19	'http://www.w3.org/1999/XSL/Transform',
232	19	'xsl:' . $localName,
233	19	htmlspecialchars($text, ENT_XML1)
234		);
235		}
236
237		/**
238		* Execute a DOMXPath method and return the result
239		*
240		* @param string $methodName
241		* @param array $args
242		* @return mixed
243		*/
244	7	protected function xpath(string $methodName, array $args)
245		{
246	7	$xpath = new DOMXPath($this);
247	7	$xpath->registerNamespace('xsl', 'http://www.w3.org/1999/XSL/Transform');
248
249	7	return call_user_func_array([$xpath, $methodName], $args);
250		}
251		}

s9e / SweetDOM

Push — master ( 109652...4c65b4 )

Document::createElementXSL() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like