HtmlUtils - Code Metrics - Inspection of "Lock RST include policy to new CWD" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3df90d...74371a )

by Vladimir

created 2018-04-01 00:43 UTC

HtmlUtils A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

89.47%

Importance

Changes

Metric	Value
wmc	6
lcom	0
cbo	0
dl	0
loc	41
ccs	17
cts	19
cp	0.8947
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	htmlXPath()	0	28	3
A	normalizeHTML()	0	9	3

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Utilities;

abstract class HtmlUtils
{
    public static function htmlXPath(\DOMDocument &$DOMDocument, $html, $xpathQuery)

    {
        $html = self::normalizeHTML($html);


        libxml_use_internal_errors(true);

        $DOMDocument->loadHTML($html);

        $xmlErrors = libxml_get_errors();

        /** @var \LibXMLError $error */
        foreach ($xmlErrors as $error)
        {
            // http://www.xmlsoft.org/html/libxml-xmlerror.html#xmlParserErrors
            if ($error->code === 801)
            {
                continue;
            }

            @trigger_error($error->message, E_USER_WARNING);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }

        libxml_clear_errors();

        $xpath = new \DOMXPath($DOMDocument);

        return $xpath->query($xpathQuery);
    }

    private static function normalizeHTML($html)

    {
        if (strpos($html, "<body>" === false) || strpos($html, "</body>") === false)
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        {
            return sprintf('<body>%s</body>', $html);
        }

        return $html;
    }
}


1		<?php
2
3		/**
4		* @copyright 2017 Vladimir Jimenez
5		* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\Utilities;
9
10		abstract class HtmlUtils
11		{
12	7	public static function htmlXPath(\DOMDocument &$DOMDocument, $html, $xpathQuery)
		0 ignored issues – show Coding Style Naming introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report The parameter $DOMDocument is not named in camelCase. This check marks parameter names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
13		{
14	7	$html = self::normalizeHTML($html);
		0 ignored issues – show Coding Style introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$html`. This often makes code more readable. Loading history...
15
16	7	libxml_use_internal_errors(true);
17
18	7	$DOMDocument->loadHTML($html);
19
20	7	$xmlErrors = libxml_get_errors();
21
22		/** @var \LibXMLError $error */
23	7	foreach ($xmlErrors as $error)
24		{
25		// http://www.xmlsoft.org/html/libxml-xmlerror.html#xmlParserErrors
26	1	if ($error->code === 801)
27	1	{
28		continue;
29		}
30
31	1	@trigger_error($error->message, E_USER_WARNING);
		0 ignored issues – show Security Best Practice introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
32	7	}
33
34	7	libxml_clear_errors();
35
36	7	$xpath = new \DOMXPath($DOMDocument);
37
38	7	return $xpath->query($xpathQuery);
39		}
40
41	7	private static function normalizeHTML($html)
		0 ignored issues – show Documentation introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
42		{
43	7	if (strpos($html, "<body>" === false) \|\| strpos($html, "</body>") === false)
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report The string literal `<body>` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history... Coding Style Comprehensibility introduced 2017-12-23 05:55 UTC by Report Bug Copy Issue Report The string literal `</body>` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
44	7	{
45	7	return sprintf('<body>%s</body>', $html);
46		}
47
48		return $html;
49		}
50		}
51

stakx-io / stakx

Push — master ( 3df90d...74371a )

HtmlUtils A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like