FluidXml::initRoot() - Code Metrics - Inspection of "Internal refactoring." - servo-php/fluidxml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c01fee...eeab5f )

by Daniele

created 2016-02-21 15:41 UTC

FluidXml::initRoot() A

↳ Parent: FluidXml

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
cc	2
eloc	4
nc	2
nop	1
crap	2

<?php

namespace FluidXml;

/**
 * @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);
                }  elseif (\is_array($arguments[0])) {
                        $namespaces = $arguments[0];
                } 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 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 FluidXml namespace(...$arguments)
7		*/
8		class FluidXml implements FluidInterface
9		{
10		use FluidAliasesTrait,
11		FluidSaveTrait,
12		NewableTrait,
13		ReservedCallTrait, // For compatibility with PHP 5.6.
14		ReservedCallStaticTrait; // For compatibility with PHP 5.6.
15
16		const ROOT_NODE = 'doc';
17
18		private $defaults = [ 'root' => self::ROOT_NODE,
19		'version' => '1.0',
20		'encoding' => 'UTF-8',
21		'stylesheet' => null ];
22
23		private $document;
24		private $handler;
25		private $context;
26		private $contextEl;
27
28	1	public static function load($document)
29		{
30	1	$file = $document;
31	1	$document = \file_get_contents($file);
32
33		// file_get_contents() returns false in case of error.
34	1	if (! $document) {
35	1	throw new \Exception("File '$file' not accessible.");
36		}
37
38	1	return (new FluidXml(null))->addChild($document);
39		}
40
41	1	public function __construct(...$arguments)
42		{
43		// First, we parse the arguments detecting the options provided.
44		// This options are needed to build the DOM, add the stylesheet
45		// and to create the document root/structure.
46	1	$options = $this->mergeOptions($arguments);
47
48		// Having the options set, we can build the FluidDocument model
49		// which incapsulates the DOM and the corresponding XPath instance.
50	1	$document = new FluidDocument();
51	1	$document->dom = $this->newDom($options);
52	1	$document->xpath = new \DOMXPath($document->dom);
53
54		// After the FluidDocument model creation, we can proceed to build
55		// the FluidInsertionHandler which requires the model to perform
56		// its logics.
57	1	$handler = new FluidInsertionHandler($document);
58
59		// Ok, it's time to let them beeing visible along the instance.
60	1	$this->document = $document;
61	1	$this->handler = $handler;
62
63		// Now, we can further populate the DOM with any stylesheet or child.
64	1	$this->initStylesheet($options)
65	1	->initRoot($options);
66	1	}
67
68	1	protected function mergeOptions(&$arguments)
69		{
70	1	$options = $this->defaults;
71
72	1	if (\count($arguments) > 0) {
73		// The root option can be specified as first argument
74		// because it is the most common.
75	1	$options['root'] = $arguments[0];
76		}
77
78	1	if (\count($arguments) > 1) {
79		// Custom options can be specified only as second argument,
80		// to avoid confusion with array to XML construction style.
81	1	$options = \array_merge($options, $arguments[1]);
82		}
83
84	1	return $options;
85		}
86
87	1	private function newDom(&$options)
88		{
89	1	$dom = new \DOMDocument($options['version'], $options['encoding']);
90	1	$dom->formatOutput = true;
91	1	$dom->preserveWhiteSpace = false;
92
93	1	return $dom;
94		}
95
96	1	private function initStylesheet(&$options)
97		{
98	1	if (! empty($options['stylesheet'])) {
99		$attrs = 'type="text/xsl" '
100	1	. "encoding=\"{$options['encoding']}\" "
101	1	. 'indent="yes" '
102	1	. "href=\"{$options['stylesheet']}\"";
103
104	1	$stylesheet = new \DOMProcessingInstruction('xml-stylesheet', $attrs);
105
106	1	$this->addChild($stylesheet);
107
108		// Algorithm 2:
109		// Used in case the order of the stylesheet and root creation is reversed.
110		// $this->document->dom->insertBefore($stylesheet, $this->document->dom->documentElement);
111		}
112
113	1	return $this;
114		}
115
116	1	private function initRoot(&$options)
117		{
118	1	if (! empty($options['root'])) {
119	1	$this->appendSibling($options['root']);
120		}
121
122	1	return $this;
123		}
124
125	1	public function length()
126		{
127	1	return \count($this->array());
		0 ignored issues – show Bug introduced 2016-02-21 15:44 UTC by Report Bug Copy Issue Report The method `array()` does not exist on `FluidXml\FluidXml`. Did you maybe mean `array_()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
128		}
129
130	1	public function dom()
131		{
132	1	return $this->document->dom;
133		}
134
135		// This method should be called 'array',
136		// but for compatibility with PHP 5.6
137		// it is shadowed by the __call() method.
138	1	public function array_()
139		{
140	1	$el = $this->document->dom->documentElement;
141
142	1	if ($el === null) {
143		$el = $this->document->dom;
144		}
145
146	1	return [ $el ];
147		}
148
149	1	public function __toString()
150		{
151	1	return $this->xml();
152		}
153
154	1	public function xml($strip = false)
155		{
156	1	if ($strip) {
157	1	return FluidHelper::domdocumentToStringWithoutHeaders($this->document->dom);
158		}
159
160	1	return $this->document->dom->saveXML();
161		}
162
163	1	public function html($strip = false)
164		{
165	1	$header = "<!DOCTYPE html>\n";
166
167	1	if ($strip) {
168	1	$header = '';
169		}
170
171	1	$html = FluidHelper::domdocumentToStringWithoutHeaders($this->document->dom, true);
172
173	1	return "{$header}{$html}";
174		}
175
176	1	public function namespaces()
177		{
178	1	return $this->document->namespaces;
179		}
180
181		// This method should be called 'namespace',
182		// but for compatibility with PHP 5.6
183		// it is shadowed by the __call() method.
184	1	protected function namespace_(...$arguments)
185		{
186	1	$namespaces = [];
187
188	1	if (\is_string($arguments[0])) {
189	1	$args = [ $arguments[0], $arguments[1] ];
190
191	1	if (isset($arguments[2])) {
192	1	$args[] = $arguments[2];
193		}
194
195	1	$namespaces[] = new FluidNamespace(...$args);
196	1	} elseif (\is_array($arguments[0])) {
197	1	$namespaces = $arguments[0];
198		} else {
199	1	$namespaces = $arguments;
200		}
201
202	1	foreach ($namespaces as $n) {
203	1	$this->document->namespaces[$n->id()] = $n;
204	1	$this->document->xpath->registerNamespace($n->id(), $n->uri());
205		}
206
207	1	return $this;
208		}
209
210		public function query(...$query) { return $this->context()->query(...$query); }
211		public function times($times, callable $fn = null) { return $this->context()->times($times, $fn); }
212		public function each(callable $fn) { return $this->context()->each($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 ( c01fee...eeab5f )

FluidXml::initRoot() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like