FluidXml::addChild() - Code Metrics - Inspection of "Merge pull request #25 from alepeino/map-method" - servo-php/fluidxml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d5cade...3c3d9c )

by Daniele

created 2017-01-31 00:13 UTC

FluidXml::addChild() A

↳ Parent: FluidXml

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace FluidXml;

/**
 * @method array array()
 * @method FluidXml namespace(...$arguments)
 */
class FluidXml implements FluidInterface
{
        use FluidAliasesTrait,
            FluidSaveTrait,
            NewableTrait,
            ReservedCallTrait,          // For compatibility with PHP 5.6.
            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.

        const ROOT_NODE = 'doc';

        private $defaults = [ 'root'       => self::ROOT_NODE,
                              'version'    => '1.0',
                              'encoding'   => 'UTF-8',
                              'stylesheet' => null ];

        private $document;
        private $handler;
        private $context;
        private $contextEl;

        public static function load($document)
        {
                $file     = $document;
                $document = \file_get_contents($file);

                // file_get_contents() returns false in case of error.
                if (! $document) {
                        throw new \Exception("File '$file' not accessible.");
                }

                return (new FluidXml(null))->addChild($document);
        }

        public function __construct(...$arguments)
        {
                // First, we parse the arguments detecting the options provided.
                // This options are needed to build the DOM, add the stylesheet
                // and to create the document root/structure.
                $options = $this->mergeOptions($arguments);

                // Having the options set, we can build the FluidDocument model
                // which incapsulates the DOM and the corresponding XPath instance.
                $document = new FluidDocument();
                $document->dom   = $this->newDom($options);
                $document->xpath = new \DOMXPath($document->dom);

                // After the FluidDocument model creation, we can proceed to build
                // the FluidInsertionHandler which requires the model to perform
                // its logics.
                $handler = new FluidInsertionHandler($document);

                // Ok, it's time to let them beeing visible along the instance.
                $this->document = $document;
                $this->handler  = $handler;

                // Now, we can further populate the DOM with any stylesheet or child.
                $this->initStylesheet($options)
                     ->initRoot($options);
        }

        protected function mergeOptions(&$arguments)
        {
                $options = $this->defaults;

                if (\count($arguments) > 0) {
                        // The root option can be specified as first argument
                        // because it is the most common.
                        $options['root'] = $arguments[0];
                }

                if (\count($arguments) > 1) {
                        // Custom options can be specified only as second argument,
                        // to avoid confusion with array to XML construction style.
                        $options = \array_merge($options, $arguments[1]);
                }

                return $options;
        }

        private function newDom(&$options)
        {
                $dom = new \DOMDocument($options['version'], $options['encoding']);
                $dom->formatOutput       = true;
                $dom->preserveWhiteSpace = false;

                return $dom;
        }

        private function initStylesheet(&$options)
        {
                if (! empty($options['stylesheet'])) {
                        $attrs = 'type="text/xsl" '
                               . "encoding=\"{$options['encoding']}\" "
                               . 'indent="yes" '
                               . "href=\"{$options['stylesheet']}\"";

                        $stylesheet = new \DOMProcessingInstruction('xml-stylesheet', $attrs);

                        $this->addChild($stylesheet);

                        // Algorithm 2:
                        // Used in case the order of the stylesheet and root creation is reversed.
                        // $this->document->dom->insertBefore($stylesheet, $this->document->dom->documentElement);
                }

                return $this;
        }

        private function initRoot(&$options)
        {
                if (! empty($options['root'])) {
                        $this->appendSibling($options['root']);
                }

                return $this;
        }

        public function length()
        {
                return \count($this->array());
        }

        public function dom()
        {
                return $this->document->dom;
        }

        // This method should be called 'array',
        // but for compatibility with PHP 5.6
        // it is shadowed by the __call() method.
        public function array_()
        {
                $el = $this->document->dom->documentElement;

                if ($el === null) {
                        $el = $this->document->dom;
                }

                return [ $el ];
        }

        public function __toString()
        {
                return $this->xml();
        }

        public function xml($strip = false)
        {
                if ($strip) {
                        return FluidHelper::domdocumentToStringWithoutHeaders($this->document->dom);
                }

                return $this->document->dom->saveXML();
        }

        public function html($strip = false)
        {
                $header = "<!DOCTYPE html>\n";

                if ($strip) {
                        $header = '';
                }

                $html = FluidHelper::domdocumentToStringWithoutHeaders($this->document->dom, true);

                return "{$header}{$html}";
        }

        public function namespaces()
        {
                return $this->document->namespaces;
        }

        // This method should be called 'namespace',
        // but for compatibility with PHP 5.6
        // it is shadowed by the __call() method.
        protected function namespace_(...$arguments)
        {
                $namespaces = [];

                if (\is_string($arguments[0])) {
                        $args = [ $arguments[0], $arguments[1] ];

                        if (isset($arguments[2])) {
                                $args[] = $arguments[2];
                        }

                        $namespaces[] = new FluidNamespace(...$args);
                } else {
                        $namespaces = $arguments;
                }

                foreach ($namespaces as $n) {
                        $this->document->namespaces[$n->id()] = $n;
                        $this->document->xpath->registerNamespace($n->id(), $n->uri());
                }

                return $this;
        }

        public function query(...$query)                   { return $this->context()->query(...$query); }
        public function times($times, callable $fn = null) { return $this->context()->times($times, $fn); }
        public function each(callable $fn)                 { return $this->context()->each($fn); }
        public function map(callable $fn)                  { return $this->context()->map($fn); }
        public function filter(callable $fn)               { return $this->context()->filter($fn); }
        public function setAttribute($name, $value = null) { $this->context()->setAttribute($name, $value); return $this; }
        public function setText($text)                     { $this->context()->setText($text);    return $this; }
        public function addText($text)                     { $this->context()->addText($text);    return $this; }
        public function setCdata($text)                    { $this->context()->setCdata($text);   return $this; }
        public function addCdata($text)                    { $this->context()->addCdata($text);   return $this; }
        public function setComment($text)                  { $this->context()->setComment($text); return $this; }
        public function addComment($text)                  { $this->context()->addComment($text); return $this; }
        public function remove(...$query)                  { $this->context()->remove(...$query); return $this; }

        public function addChild($child, ...$optionals)
        {
                return $this->chooseContext(function($cx) use ($child, &$optionals) {
                        return $cx->addChild($child, ...$optionals);
                });
        }

        public function prependSibling($sibling, ...$optionals)
        {
                return $this->chooseContext(function($cx) use ($sibling, &$optionals) {
                        return $cx->prependSibling($sibling, ...$optionals);
                });
        }

        public function appendSibling($sibling, ...$optionals)
        {
                return $this->chooseContext(function($cx) use ($sibling, &$optionals) {
                        return $cx->appendSibling($sibling, ...$optionals);
                });
        }

        protected function context()
        {
                $el = $this->document->dom->documentElement;

                if ($el === null) {
                        // Whether there is not a root node
                        // the DOMDocument is promoted as root node.
                        $el = $this->document->dom;
                }

                if ($this->context === null || $el !== $this->contextEl) {
                        // The user can prepend a root node to the current root node.
                        // In this case we have to update the context with the new first root node.
                        $this->context   = new FluidContext($this->document, $this->handler, $el);
                        $this->contextEl = $el;
                }

                return $this->context;
        }

        protected function chooseContext(\Closure $fn)
        {
                // If the user has requested ['root' => null] at construction time
                // 'context()' promotes DOMDocument as root node.

                $context     = $this->context();
                $new_context = $fn($context);

                if ($context !== $new_context) {
                        // If the two contextes are diffent, the user has requested
                        // a switch of the context and we have to return it.
                        return $new_context;
                }

                return $this;
        }
}


1		<?php
2
3		namespace FluidXml;
4
5		/**
6		* @method array array()
7		* @method FluidXml namespace(...$arguments)
8		*/
9		class FluidXml implements FluidInterface
10		{
11		use FluidAliasesTrait,
12		FluidSaveTrait,
13		NewableTrait,
14		ReservedCallTrait, // For compatibility with PHP 5.6.
15		ReservedCallStaticTrait; // For compatibility with PHP 5.6.
16
17		const ROOT_NODE = 'doc';
18
19		private $defaults = [ 'root' => self::ROOT_NODE,
20		'version' => '1.0',
21		'encoding' => 'UTF-8',
22		'stylesheet' => null ];
23
24		private $document;
25		private $handler;
26		private $context;
27		private $contextEl;
28
29	1	public static function load($document)
30		{
31	1	$file = $document;
32	1	$document = \file_get_contents($file);
33
34		// file_get_contents() returns false in case of error.
35	1	if (! $document) {
36	1	throw new \Exception("File '$file' not accessible.");
37		}
38
39	1	return (new FluidXml(null))->addChild($document);
40		}
41
42	1	public function __construct(...$arguments)
43		{
44		// First, we parse the arguments detecting the options provided.
45		// This options are needed to build the DOM, add the stylesheet
46		// and to create the document root/structure.
47	1	$options = $this->mergeOptions($arguments);
48
49		// Having the options set, we can build the FluidDocument model
50		// which incapsulates the DOM and the corresponding XPath instance.
51	1	$document = new FluidDocument();
52	1	$document->dom = $this->newDom($options);
53	1	$document->xpath = new \DOMXPath($document->dom);
54
55		// After the FluidDocument model creation, we can proceed to build
56		// the FluidInsertionHandler which requires the model to perform
57		// its logics.
58	1	$handler = new FluidInsertionHandler($document);
59
60		// Ok, it's time to let them beeing visible along the instance.
61	1	$this->document = $document;
62	1	$this->handler = $handler;
63
64		// Now, we can further populate the DOM with any stylesheet or child.
65	1	$this->initStylesheet($options)
66	1	->initRoot($options);
67	1	}
68
69	1	protected function mergeOptions(&$arguments)
70		{
71	1	$options = $this->defaults;
72
73	1	if (\count($arguments) > 0) {
74		// The root option can be specified as first argument
75		// because it is the most common.
76	1	$options['root'] = $arguments[0];
77		}
78
79	1	if (\count($arguments) > 1) {
80		// Custom options can be specified only as second argument,
81		// to avoid confusion with array to XML construction style.
82	1	$options = \array_merge($options, $arguments[1]);
83		}
84
85	1	return $options;
86		}
87
88	1	private function newDom(&$options)
89		{
90	1	$dom = new \DOMDocument($options['version'], $options['encoding']);
91	1	$dom->formatOutput = true;
92	1	$dom->preserveWhiteSpace = false;
93
94	1	return $dom;
95		}
96
97	1	private function initStylesheet(&$options)
98		{
99	1	if (! empty($options['stylesheet'])) {
100		$attrs = 'type="text/xsl" '
101	1	. "encoding=\"{$options['encoding']}\" "
102	1	. 'indent="yes" '
103	1	. "href=\"{$options['stylesheet']}\"";
104
105	1	$stylesheet = new \DOMProcessingInstruction('xml-stylesheet', $attrs);
106
107	1	$this->addChild($stylesheet);
108
109		// Algorithm 2:
110		// Used in case the order of the stylesheet and root creation is reversed.
111		// $this->document->dom->insertBefore($stylesheet, $this->document->dom->documentElement);
112		}
113
114	1	return $this;
115		}
116
117	1	private function initRoot(&$options)
118		{
119	1	if (! empty($options['root'])) {
120	1	$this->appendSibling($options['root']);
121		}
122
123	1	return $this;
124		}
125
126	1	public function length()
127		{
128	1	return \count($this->array());
129		}
130
131	1	public function dom()
132		{
133	1	return $this->document->dom;
134		}
135
136		// This method should be called 'array',
137		// but for compatibility with PHP 5.6
138		// it is shadowed by the __call() method.
139	1	public function array_()
140		{
141	1	$el = $this->document->dom->documentElement;
142
143	1	if ($el === null) {
144	1	$el = $this->document->dom;
145		}
146
147	1	return [ $el ];
148		}
149
150	1	public function __toString()
151		{
152	1	return $this->xml();
153		}
154
155	1	public function xml($strip = false)
156		{
157	1	if ($strip) {
158	1	return FluidHelper::domdocumentToStringWithoutHeaders($this->document->dom);
159		}
160
161	1	return $this->document->dom->saveXML();
162		}
163
164	1	public function html($strip = false)
165		{
166	1	$header = "<!DOCTYPE html>\n";
167
168	1	if ($strip) {
169	1	$header = '';
170		}
171
172	1	$html = FluidHelper::domdocumentToStringWithoutHeaders($this->document->dom, true);
173
174	1	return "{$header}{$html}";
175		}
176
177	1	public function namespaces()
178		{
179	1	return $this->document->namespaces;
180		}
181
182		// This method should be called 'namespace',
183		// but for compatibility with PHP 5.6
184		// it is shadowed by the __call() method.
185	1	protected function namespace_(...$arguments)
186		{
187	1	$namespaces = [];
188
189	1	if (\is_string($arguments[0])) {
190	1	$args = [ $arguments[0], $arguments[1] ];
191
192	1	if (isset($arguments[2])) {
193	1	$args[] = $arguments[2];
194		}
195
196	1	$namespaces[] = new FluidNamespace(...$args);
197		} else {
198	1	$namespaces = $arguments;
199		}
200
201	1	foreach ($namespaces as $n) {
202	1	$this->document->namespaces[$n->id()] = $n;
203	1	$this->document->xpath->registerNamespace($n->id(), $n->uri());
204		}
205
206	1	return $this;
207		}
208
209		public function query(...$query) { return $this->context()->query(...$query); }
210		public function times($times, callable $fn = null) { return $this->context()->times($times, $fn); }
211		public function each(callable $fn) { return $this->context()->each($fn); }
212		public function map(callable $fn) { return $this->context()->map($fn); }
213		public function filter(callable $fn) { return $this->context()->filter($fn); }
214		public function setAttribute($name, $value = null) { $this->context()->setAttribute($name, $value); return $this; }
215		public function setText($text) { $this->context()->setText($text); return $this; }
216		public function addText($text) { $this->context()->addText($text); return $this; }
217		public function setCdata($text) { $this->context()->setCdata($text); return $this; }
218		public function addCdata($text) { $this->context()->addCdata($text); return $this; }
219		public function setComment($text) { $this->context()->setComment($text); return $this; }
220		public function addComment($text) { $this->context()->addComment($text); return $this; }
221		public function remove(...$query) { $this->context()->remove(...$query); return $this; }
222
223	1	public function addChild($child, ...$optionals)
224		{
225		return $this->chooseContext(function($cx) use ($child, &$optionals) {
226	1	return $cx->addChild($child, ...$optionals);
227	1	});
228		}
229
230	1	public function prependSibling($sibling, ...$optionals)
231		{
232		return $this->chooseContext(function($cx) use ($sibling, &$optionals) {
233	1	return $cx->prependSibling($sibling, ...$optionals);
234	1	});
235		}
236
237		public function appendSibling($sibling, ...$optionals)
238		{
239	1	return $this->chooseContext(function($cx) use ($sibling, &$optionals) {
240	1	return $cx->appendSibling($sibling, ...$optionals);
241	1	});
242		}
243
244	1	protected function context()
245		{
246	1	$el = $this->document->dom->documentElement;
247
248	1	if ($el === null) {
249		// Whether there is not a root node
250		// the DOMDocument is promoted as root node.
251	1	$el = $this->document->dom;
252		}
253
254	1	if ($this->context === null \|\| $el !== $this->contextEl) {
255		// The user can prepend a root node to the current root node.
256		// In this case we have to update the context with the new first root node.
257	1	$this->context = new FluidContext($this->document, $this->handler, $el);
258	1	$this->contextEl = $el;
259		}
260
261	1	return $this->context;
262		}
263
264	1	protected function chooseContext(\Closure $fn)
265		{
266		// If the user has requested ['root' => null] at construction time
267		// 'context()' promotes DOMDocument as root node.
268
269	1	$context = $this->context();
270	1	$new_context = $fn($context);
271
272	1	if ($context !== $new_context) {
273		// If the two contextes are diffent, the user has requested
274		// a switch of the context and we have to return it.
275	1	return $new_context;
276		}
277
278	1	return $this;
279		}
280		}
281

servo-php / fluidxml

Push — master ( d5cade...3c3d9c )

FluidXml::addChild() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like