Html::loadFragment() - Code Metrics - Inspection of "Add encoding to source for HTML fragment loading" - FluentDOM/FluentDOM - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9811d3...28c53f )

by Thomas

created 2017-04-22 08:24 UTC

Html::loadFragment() B

↳ Parent: Html

Complexity

Conditions	3
Paths	2

Size

Total Lines	25
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	23
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	18
nc	2
nop	3
dl	0
loc	25
ccs	23
cts	23
cp	1
crap	3
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * Load a DOM document from a xml string
 *
 * @license http://www.opensource.org/licenses/mit-license.php The MIT License
 * @copyright Copyright (c) 2009-2014 Bastian Feder, Thomas Weinert
 */

namespace FluentDOM\Loader {

  use FluentDOM\Document;
  use FluentDOM\DocumentFragment;
  use FluentDOM\Loadable;
  use FluentDOM\ProcessingInstruction;

  /**
   * Load a DOM document from a xml string
   */
  class Html implements Loadable {

    use Supports\Libxml;

    const IS_FRAGMENT = 'is_fragment';

    /**
     * @return string[]
     */
    public function getSupported() {
      return array('html', 'text/html', 'html-fragment', 'text/html-fragment');
    }

    /**
     * @see Loadable::load
     * @param string $source
     * @param string $contentType
     * @param array|\Traversable|Options $options
     * @return Document|Result|NULL
     */
    public function load($source, $contentType, $options = []) {
      if ($this->supports($contentType)) {
        return (new Libxml\Errors())->capture(
          function() use ($source, $contentType, $options) {
            $selection = false;
            $document = new Document();
            $settings = $this->getOptions($options);
            if ($this->isFragment($contentType, $settings)) {
              $this->loadFragmentIntoDom($document, $source, $settings);
              $selection = $document->evaluate('/*');
            } else {
              $settings->isAllowed($sourceType = $settings->getSourceType($source));
              switch ($sourceType) {
              case Options::IS_FILE :
                $document->loadHTMLFile($source, $settings[Options::LIBXML_OPTIONS]);
                break;
              case Options::IS_STRING :
              default :
                $document->loadHTML(
                  $this->ensureEncodingPI($source, $settings[Options::ENCODING], $settings[Options::FORCE_ENCODING]),
                  $settings[Options::LIBXML_OPTIONS]
                );
              }
            }
            /** @var ProcessingInstruction $pi */
            if ($pi = $document->xpath()->firstOf('//processing-instruction()')) {
              $pi->remove();

            }
            return new Result($document, 'text/html', $selection);
          }
        );
      }
      return NULL;
    }

    private function ensureEncodingPI($source, $encoding, $force = FALSE) {
      $hasXmlPi = preg_match('(<\\?xml\\s)', $source);
      if (!$force) {
        if ($charset = $this->getCharsetFromMetaTag($source)) {
          $encoding = $charset;
        }
      }
      $pi = '<?xml version="1.0" encoding="'.htmlspecialchars($encoding).'"?>';
      if (!$hasXmlPi) {
        return $pi.$source;
      } elseif ($force) {
        return preg_replace('(<\\?xml\\s[^?>]*?>)', $pi, $source, 1);
      }
      return $source;
    }

    private function getCharsetFromMetaTag($source) {
      $hasMetaTag = preg_match(
        '(<\\meta\\s+[^>]*charset=["\']\s*(?<charset>[^\S\'">]+)\s*["\'])i',
        $source,
        $match
      );
      if ($hasMetaTag) {
        return $match['charset'];
      } else {
        $hasMetaTag = preg_match(
          '(<\\meta\\s+[^>]*http-equiv=["\']content-type["\'][^>]*>)i',
          $source,
          $match
        );
        if ($hasMetaTag) {
          preg_match(
            '(content=["\']\s*[^#\']+;\s*charset\s*=\s*(?<encoding>[^\S\'">]+))',
            $match[0],
            $match
          );
          return isset($match['encoding']) ? $match['encoding'] : FALSE;
        }
      }
      return false;
    }

    /**
     * @see LoadableFragment::loadFragment
     * @param string $source
     * @param string $contentType
     * @param array|\Traversable|Options $options
     * @return DocumentFragment|NULL
     */
    public function loadFragment($source, $contentType, $options = []) {
      if ($this->supports($contentType)) {
        $options = $this->getOptions($options);
        return (new Libxml\Errors())->capture(
          function() use ($source, $options) {
            $document = new Document();
            $fragment = $document->createDocumentFragment();
            $document->loadHTML(
              $this->ensureEncodingPI(
                '<html-fragment>'.$source.'</html-fragment>',
                $options[Options::ENCODING],
                $options[Options::FORCE_ENCODING]
              ),
              $options[Options::LIBXML_OPTIONS]
            );
            $nodes = $document->evaluate('//html-fragment[1]/node()');
            foreach ($nodes as $node) {
              $fragment->append($node);
            }
            return $fragment;
          }
        );
      }
      return NULL;
    }

    private function isFragment($contentType, $options) {
      return (
        $contentType == 'html-fragment' ||
        $contentType == 'text/html-fragment' ||
        $options[self::IS_FRAGMENT]
      );
    }

    private function loadFragmentIntoDom(\DOMDocument $document, $source, $settings) {
      $htmlDom = new Document();
      $htmlDom->loadHTML(
        $this->ensureEncodingPI(
          '<html-fragment>'.$source.'</html-fragment>',
          $settings[Options::ENCODING],
          $settings[Options::FORCE_ENCODING]
        ),
        $settings[Options::LIBXML_OPTIONS]
      );
      $nodes = $htmlDom->evaluate('//html-fragment[1]/node()');
      foreach ($nodes as $node) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
        if ($importedNode = $document->importNode($node, TRUE)) {
          $document->appendChild($importedNode);
        }
      }
    }
  }
}

1		<?php
2		/**
3		* Load a DOM document from a xml string
4		*
5		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
6		* @copyright Copyright (c) 2009-2014 Bastian Feder, Thomas Weinert
7		*/
8
9		namespace FluentDOM\Loader {
10
11		use FluentDOM\Document;
12		use FluentDOM\DocumentFragment;
13		use FluentDOM\Loadable;
14		use FluentDOM\ProcessingInstruction;
15
16		/**
17		* Load a DOM document from a xml string
18		*/
19		class Html implements Loadable {
20
21		use Supports\Libxml;
22
23		const IS_FRAGMENT = 'is_fragment';
24
25		/**
26		* @return string[]
27		*/
28	17	public function getSupported() {
29	17	return array('html', 'text/html', 'html-fragment', 'text/html-fragment');
30		}
31
32		/**
33		* @see Loadable::load
34		* @param string $source
35		* @param string $contentType
36		* @param array\|\Traversable\|Options $options
37		* @return Document\|Result\|NULL
38		*/
39	12	public function load($source, $contentType, $options = []) {
40	12	if ($this->supports($contentType)) {
41	11	return (new Libxml\Errors())->capture(
42		function() use ($source, $contentType, $options) {
43	11	$selection = false;
44	11	$document = new Document();
45	11	$settings = $this->getOptions($options);
46	11	if ($this->isFragment($contentType, $settings)) {
47	2	$this->loadFragmentIntoDom($document, $source, $settings);
48	2	$selection = $document->evaluate('/*');
49	2	} else {
50	9	$settings->isAllowed($sourceType = $settings->getSourceType($source));
51		switch ($sourceType) {
52	8	case Options::IS_FILE :
53	2	$document->loadHTMLFile($source, $settings[Options::LIBXML_OPTIONS]);
54	2	break;
55	6	case Options::IS_STRING :
56	6	default :
57	6	$document->loadHTML(
58	6	$this->ensureEncodingPI($source, $settings[Options::ENCODING], $settings[Options::FORCE_ENCODING]),
59	6	$settings[Options::LIBXML_OPTIONS]
60	6	);
61	6	}
62		}
63		/** @var ProcessingInstruction $pi */
64	10	if ($pi = $document->xpath()->firstOf('//processing-instruction()')) {
65	6	$pi->remove();
		1 ignored issue – show Bug introduced 2017-03-04 09:57 UTC by Report Bug Copy Issue Report The method `remove()` does not exist on `DOMNode`. Did you maybe mean `removeChild()`? 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...
66	6	}
67	10	return new Result($document, 'text/html', $selection);
68		}
69	11	);
70		}
71	1	return NULL;
72		}
73
74	10	private function ensureEncodingPI($source, $encoding, $force = FALSE) {
75	10	$hasXmlPi = preg_match('(<\\?xml\\s)', $source);
76	10	if (!$force) {
77	10	if ($charset = $this->getCharsetFromMetaTag($source)) {
78		$encoding = $charset;
79		}
80	10	}
81	10	$pi = '<?xml version="1.0" encoding="'.htmlspecialchars($encoding).'"?>';
82	10	if (!$hasXmlPi) {
83	10	return $pi.$source;
84		} elseif ($force) {
85		return preg_replace('(<\\?xml\\s[^?>]*?>)', $pi, $source, 1);
86		}
87		return $source;
88	8	}
89
90	10	private function getCharsetFromMetaTag($source) {
91	10	$hasMetaTag = preg_match(
92	10	'(<\\meta\\s+[^>]charset=["\']\s(?<charset>[^\S\'">]+)\s*["\'])i',
93	10	$source,
94		$match
95	10	);
96	10	if ($hasMetaTag) {
97		return $match['charset'];
98		} else {
99	10	$hasMetaTag = preg_match(
100	10	'(<\\meta\\s+[^>]http-equiv=["\']content-type["\'][^>]>)i',
101	10	$source,
102		$match
103	10	);
104	10	if ($hasMetaTag) {
105	1	preg_match(
106	1	'(content=["\']\s[^#\']+;\scharset\s=\s(?<encoding>[^\S\'">]+))',
107	1	$match[0],
108		$match
109	1	);
110	1	return isset($match['encoding']) ? $match['encoding'] : FALSE;
111		}
112		}
113	9	return false;
114		}
115
116		/**
117		* @see LoadableFragment::loadFragment
118		* @param string $source
119		* @param string $contentType
120		* @param array\|\Traversable\|Options $options
121		* @return DocumentFragment\|NULL
122		*/
123	11	public function loadFragment($source, $contentType, $options = []) {
124	3	if ($this->supports($contentType)) {
125	2	$options = $this->getOptions($options);
126	2	return (new Libxml\Errors())->capture(
127	11	function() use ($source, $options) {
128	2	$document = new Document();
129	2	$fragment = $document->createDocumentFragment();
130	2	$document->loadHTML(
131	2	$this->ensureEncodingPI(
132	2	'<html-fragment>'.$source.'</html-fragment>',
133	2	$options[Options::ENCODING],
134	2	$options[Options::FORCE_ENCODING]
135	2	),
136	2	$options[Options::LIBXML_OPTIONS]
137	2	);
138	2	$nodes = $document->evaluate('//html-fragment[1]/node()');
139	2	foreach ($nodes as $node) {
140	2	$fragment->append($node);
141	11	}
142	2	return $fragment;
143	8	}
144	2	);
145		}
146	1	return NULL;
147		}
148
149	11	private function isFragment($contentType, $options) {
150		return (
151	11	$contentType == 'html-fragment' \|\|
152	11	$contentType == 'text/html-fragment' \|\|
153	9	$options[self::IS_FRAGMENT]
154	11	);
155		}
156
157	8	private function loadFragmentIntoDom(\DOMDocument $document, $source, $settings) {
158	2	$htmlDom = new Document();
159	2	$htmlDom->loadHTML(
160	2	$this->ensureEncodingPI(
161	2	'<html-fragment>'.$source.'</html-fragment>',
162	5	$settings[Options::ENCODING],
163	3	$settings[Options::FORCE_ENCODING]
164	2	),
165	2	$settings[Options::LIBXML_OPTIONS]
166	2	);
167	8	$nodes = $htmlDom->evaluate('//html-fragment[1]/node()');
168	2	foreach ($nodes as $node) {
		1 ignored issue – show Bug introduced 2017-04-19 11:03 UTC by Report Bug Copy Issue Report The expression `$nodes` of type `string\|double\|boolean\|object<DOMNodeList>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
169	2	if ($importedNode = $document->importNode($node, TRUE)) {
170	2	$document->appendChild($importedNode);
171	2	}
172	2	}
173	2	}
174		}
175		}

FluentDOM / FluentDOM

Push — master ( 9811d3...28c53f )

Html::loadFragment() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like