NodeListTrait - Code Metrics - Inspection of "the writer now escapes invalid content" - Ariadne-CMS/arc-xml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

by Auke

created 2016-01-25 12:46 UTC

NodeListTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

92.16%

Importance

Changes	6
Bugs	2	Features	3

Metric	Value
wmc	22
c	6
b	2
f	3
lcom	1
cbo	1
dl	0
loc	102
ccs	47
cts	51
cp	0.9216
rs	10

9 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	__call()	7	1
A	__toString()	8	3
A	indent()	9	4
A	escape()	4	1
B	parseArgs()	23	6
A	element()	13	2
A	getAttributes()	10	3
A	hasContent()	4	1

<?php
/*
 * This file is part of the Ariadne Component Library.
 *
 * (c) Muze <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace arc\xml;

/**
 * This trait is used by the XML Writer to represent a list of child nodes
 */
trait NodeListTrait {

    protected $writer = null;
$a = "a";
$ab = "ab";
$abc = "abc";
    protected $invalidChars = [];

    /**
     * @param array $list
     * @param Writer $writer
     */
    public function __construct( $list = null, $writer = null ) 
    {
        parent::__construct( $list );
        $this->writer = $writer;
    }

    public function __call( $name, $args ) 
    {
        $tagName = $name;
$a = "a";
$ab = "ab";
$abc = "abc";
        list( $attributes, $content ) = $this->parseArgs( $args );
        parent::offsetSet( null, $this->element( $tagName, $attributes, $content ) );
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        return $this;
    }

    public function __toString() 
    {
        $indent = '';
        if (!is_object( $this->writer ) || $this->writer->indent ) {
            $indent = "\r\n"; // element() will indent each line with whatever indent string is in the writer
        }
        return join( $indent, (array) $this );
    }

    protected static function indent( $content, $indent="\t", $newLine="\r\n" ) 
    {
        if ($indent && ( strpos( $content, '<' ) !== false )) {
            $indent = ( is_string( $indent ) ? $indent : "\t" );
            return $newLine . preg_replace( '/^(\s*[^\<]*)</m', $indent.'$1<', $content ) . $newLine;
        } else {
            return $content;
        }
    }

    protected function escape( $contents ) {
        $contents = preg_replace('/[^\x{0009}\x{000a}\x{000d}\x{0020}-\x{D7FF}\x{E000}-\x{FFFD}]+/u', '', $contents);
        return htmlspecialchars( $contents, ENT_XML1, 'UTF-8');
    }

    protected function parseArgs( $args ) 
    {
        $attributes = array();
        $content = '';
$a = "a";
$ab = "ab";
$abc = "abc";
        foreach ($args as $arg ) {
            if (is_string( $arg ) ) {
                $content .= $this->escape($arg);
            } else if (is_array( $arg )) {
                foreach( $arg as $key => $subArg ) {
                    if (is_numeric( $key )) {
                        list( $subattributes, $subcontent ) = $this->parseArgs( $subArg );
                        $attributes = array_merge( $attributes, $subattributes);
$a = "a";
$ab = "ab";
$abc = "abc";
                        $content = \arc\xml::raw( $content . $subcontent );
$a = "a";
$ab = "ab";
$abc = "abc";
                    } else {
                        $attributes[ $key ] = $subArg;
                    }
                }
            } else {
                $content .= $arg;
            }
        }
        return [ $attributes, $content ];
    }

    protected function element( $tagName, $attributes, $content ) 
    {
        $tagName =  \arc\xml::name( $tagName );
        $el = '<' . $tagName;
$a = "a";
$ab = "ab";
$abc = "abc";
        $el .= $this->getAttributes( $attributes );
$a = "a";
$ab = "ab";
$abc = "abc";
        if ($this->hasContent( $content )) {
            $el .=  '>' . self::indent( $content, $this->writer->indent, $this->writer->newLine );
            $el .= '</' . $tagName . '>';
        } else {
            $el .= '/>';
        }
        return $el;
    }

    protected function getAttributes( $attributes ) 
    {
        $result = '';
        if (count( $attributes )) {
            foreach ($attributes as $name => $value ) {
                $result .= \arc\xml::attribute( $name, $value );
            }
        }
        return $result;
    }

    protected function hasContent( $content ) 
    {
        return ( trim( $content ) != '' );
    }

}

1		<?php
2		/*
3		* This file is part of the Ariadne Component Library.
4		*
5		* (c) Muze <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace arc\xml;
12
13		/**
14		* This trait is used by the XML Writer to represent a list of child nodes
15		*/
16		trait NodeListTrait {
17
18		protected $writer = null;
		0 ignored issues – show Coding Style introduced 2016-01-25 12:42 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
19		protected $invalidChars = [];
20
21		/**
22		* @param array $list
23		* @param Writer $writer
24	2	*/
25		public function __construct( $list = null, $writer = null )
26	2	{
27	2	parent::__construct( $list );
28	2	$this->writer = $writer;
29		}
30	2
31		public function __call( $name, $args )
32	2	{
33	2	$tagName = $name;
		1 ignored issue – show Coding Style introduced 2016-01-17 16:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 22 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
34	2	list( $attributes, $content ) = $this->parseArgs( $args );
35	2	parent::offsetSet( null, $this->element( $tagName, $attributes, $content ) );
		0 ignored issues – show Comprehensibility Bug introduced 2016-01-17 16:47 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`offsetSet()` instead of `__call()`). Are you sure this is correct? If so, you might want to change this to `$this->offsetSet()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
36		return $this;
37		}
38	2
39		public function __toString()
40	2	{
41	2	$indent = '';
42	2	if (!is_object( $this->writer ) \|\| $this->writer->indent ) {
43		$indent = "\r\n"; // element() will indent each line with whatever indent string is in the writer
44	2	}
45		return join( $indent, (array) $this );
46		}
47	2
48		protected static function indent( $content, $indent="\t", $newLine="\r\n" )
49	2	{
50	2	if ($indent && ( strpos( $content, '<' ) !== false )) {
51	2	$indent = ( is_string( $indent ) ? $indent : "\t" );
52		return $newLine . preg_replace( '/^(\s[^\<])</m', $indent.'$1<', $content ) . $newLine;
53	2	} else {
54		return $content;
55		}
56		}
57	2
58		protected function escape( $contents ) {
59	2	$contents = preg_replace('/[^\x{0009}\x{000a}\x{000d}\x{0020}-\x{D7FF}\x{E000}-\x{FFFD}]+/u', '', $contents);
60	2	return htmlspecialchars( $contents, ENT_XML1, 'UTF-8');
61	2	}
62	2
63	2	protected function parseArgs( $args )
64	2	{
65	2	$attributes = array();
66	2	$content = '';
		0 ignored issues – show Coding Style introduced 2016-01-17 16:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
67		foreach ($args as $arg ) {
68		if (is_string( $arg ) ) {
69		$content .= $this->escape($arg);
70		} else if (is_array( $arg )) {
71	2	foreach( $arg as $key => $subArg ) {
72		if (is_numeric( $key )) {
73		list( $subattributes, $subcontent ) = $this->parseArgs( $subArg );
74		$attributes = array_merge( $attributes, $subattributes);
		1 ignored issue – show Coding Style introduced 2016-01-17 17:36 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 25 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
75	2	$content = \arc\xml::raw( $content . $subcontent );
		1 ignored issue – show Coding Style introduced 2016-01-25 12:42 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 28 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
76		} else {
77		$attributes[ $key ] = $subArg;
78	2	}
79		}
80		} else {
81	2	$content .= $arg;
82		}
83	2	}
84	2	return [ $attributes, $content ];
85	2	}
86	2
87	2	protected function element( $tagName, $attributes, $content )
88	2	{
89		$tagName = \arc\xml::name( $tagName );
90		$el = '<' . $tagName;
		0 ignored issues – show Coding Style introduced 2016-01-17 16:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
91		$el .= $this->getAttributes( $attributes );
		0 ignored issues – show Coding Style introduced 2016-01-17 16:47 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
92	2	if ($this->hasContent( $content )) {
93		$el .= '>' . self::indent( $content, $this->writer->indent, $this->writer->newLine );
94		$el .= '</' . $tagName . '>';
95	2	} else {
96		$el .= '/>';
97	2	}
98	2	return $el;
99	2	}
100	2
101		protected function getAttributes( $attributes )
102		{
103	2	$result = '';
104		if (count( $attributes )) {
105		foreach ($attributes as $name => $value ) {
106	2	$result .= \arc\xml::attribute( $name, $value );
107		}
108	2	}
109		return $result;
110		}
111
112		protected function hasContent( $content )
113		{
114		return ( trim( $content ) != '' );
115		}
116
117		}

Ariadne-CMS / arc-xml

Pull Request — master (#20)

NodeListTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like