GraphFormatter::buildGraph() - Code Metrics - Inspection of "Create GraphFormatter Class" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#538)

unknown

created 2019-08-27 15:00 UTC

GraphFormatter::buildGraph() F

↳ Parent: GraphFormatter

Complexity

Conditions	18
Paths	640

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	98
rs	1.0036
c	0
b	0
f	0
cc	18
nc	640
nop	1

How to fix Long Method Complexity

<?php

namespace SRF\Graph;

use Html;

/**
 *
 *
 * @see https://www.semantic-mediawiki.org/wiki/Help:Graph_format
 *
 * @license GNU GPL v2+
 * @since 3.2
 *
 * @author Sebastian Schmid (gesinn.it)
 *
 */

class GraphFormatter {

	private $graph = "";

	protected $graphColors = [
		'black',
		'red',
		'green',
		'blue',
		'darkviolet',
		'gold',
		'deeppink',
		'brown',
		'bisque',
		'darkgreen',
		'yellow',
		'darkblue',
		'magenta',
		'steelblue2'
	];
	private $legendItem = [];
	private $options;

	public function __construct( $options ){
		$this->options = $options;
	}

	public function getGraph(){
		return $this->graph;
	}

	/*
	 * Add a single string to graph
	 *
	 * @param string $line
	 */
	private function add( $line ){
		$this->graph .= $line;
	}

	/*
	* Creates the DOT (graph description language) which can be processed by the graphviz lib
	*
	* @see https://www.graphviz.org/
	* @since 3.2
	*
	* @param SRF\Graph\GraphNodes[] $nodes
	*/
	public function buildGraph($nodes){
		$this->add( "digraph " . $this->options->graphName . " {" );

		// set fontsize and fontname of graph, nodes and edges
		$this->add( "graph [fontsize=10, fontname=\"Verdana\"]\n" );
		$this->add( "node [fontsize=10, fontname=\"Verdana\"];\n" );
		$this->add( "edge [fontsize=10, fontname=\"Verdana\"];\n" );

		// choose graphsize, nodeshapes and rank direction
		if ( $this->options->graphSize != '' ) {
			$this->add("size=\"" . $this->options->graphSize . "\";");
		}

		if ( $this->options->nodeShape != '' ) {
			$this->add( "node [shape=" . $this->options->nodeShape . "];" );
		}

		$this->add( "rankdir=" . $this->options->rankDir . ";" );

		/** @var \SRF\GraphNode $node */
		foreach ( $nodes as $node ) {

			// take "displaytitle" as node-label if it is set
			if ( $this->options->nodeLabel === GraphPrinter::NODELABEL_DISPLAYTITLE) {
				$objectDisplayTitle = $node->getLabel();
				if ( !empty( $objectDisplayTitle )) {
					$nodeLabel = $this->getWordWrappedText( $objectDisplayTitle,
						$this->options->wordWrapLimit );
				}
			}

			/**
			 * Add nodes to the graph
			 *
			 * @var \SRF\Graph\GraphNode $node
			 */
			$this->add( "\"" . $node->getID() . "\"" );

			if ( $this->options->enableGraphLink ) {

				$nodeLinkURL = "[[" . $node->getID() . "]]";

				if( $nodeLabel === '' ) {
					$this->add( " [URL = \"$nodeLinkURL\"]" );
				} else {
					$this->add( " [URL = \"$nodeLinkURL\", label = \"$nodeLabel\"]" );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				}
			}
			$this->add( "; ");
		}

		/**
		 * Add edges to the graph
		 *
		 * @var \SRF\Graph\GraphNode $node
		 */
		foreach ( $nodes as $node ) {

			if ( count( $node->getParentNode() ) > 0 ) {

				foreach ( $node->getParentNode() as $parentNode ) {

					// handle parent/child switch (parentRelation)
					$this->add( $this->options->parentRelation ? " \"" . $parentNode['object']
						. "\" -> \"" . $node->getID() . "\""
						: " \"" . $node->getID() . "\" -> \"" . $parentNode['object'] . "\" " );

					if ( $this->options->showGraphLabel || $this->options->showGraphColor ) {
						$this->add( ' [' );

						// add legend item only if missing
						if ( array_search( $parentNode['predicate'], $this->legendItem, true ) === false ) {
							$this->legendItem[] = $parentNode['predicate'];
						}

						// assign color
						$color = $this->graphColors[array_search( $parentNode['predicate'], $this->legendItem, true )];

						// show arrow label (graphLabel is misleading but kept for compatibility reasons)
						if ( $this->options->showGraphLabel ) {
							$this->add( "label=\"" . $parentNode['predicate'] . "\"" );
							if ( $this->options->showGraphColor ) {
								$this->add( ",fontcolor=$color," );
							}
						}

						// colorize arrow
						if ( $this->options->showGraphColor ) {
							$this->add( "color=$color" );
						}
						$this->add( "]" );
					}
					$this->add( ";" );
				}
			}
		}
		$this->add( "}" );
	}

	/**
	 * Creates the graph legend
	 *
	 * @return string Html::rawElement
	 */
	public function getGraphLegend(){
		$itemsHtml = '';
		$colorCount = 0;
		$arraySize = count( $this->graphColors );

		if ( $this->options->showGraphLegend && $this->options->showGraphColor ) {
			foreach ( $this->legendItem as $legendLabel ) {
				if ( $colorCount >= $arraySize ) {
					$colorCount = 0;
				}

				$color = $this->graphColors[$colorCount];
				$itemsHtml .= Html::rawElement( 'div', [ 'class' => 'graphlegenditem', 'style' => "color: $color" ],
					"$color: $legendLabel" );

				$colorCount ++;
			}
		}

		return Html::rawElement( 'div', [ 'class' => 'graphlegend' ], "$itemsHtml");
	}

	/**
	 * Returns the word wrapped version of the provided text.
	 *
	 * @param string $text
	 * @param integer $charLimit
	 *
	 * @return string
	 */
	public static function getWordWrappedText( $text, $charLimit ) {
		$charLimit = max( [ $charLimit, 1 ] );
		$segments = [];

		while ( strlen( $text ) > $charLimit ) {
			// Find the last space in the allowed range.
			$splitPosition = strrpos( substr( $text, 0, $charLimit ), ' ' );

			if ( $splitPosition === false ) {
				// If there is no space (lond word), find the next space.
				$splitPosition = strpos( $text, ' ' );

				if ( $splitPosition === false ) {
					// If there are no spaces, everything goes on one line.
					$splitPosition = strlen( $text ) - 1;
				}
			}

			$segments[] = substr( $text, 0, $splitPosition + 1 );
			$text = substr( $text, $splitPosition + 1 );
		}

		$segments[] = $text;

		return implode( '\n', $segments );
	}
}

1			<?php
2
3			namespace SRF\Graph;
4
5			use Html;
6
7			/**
8			*
9			*
10			* @see https://www.semantic-mediawiki.org/wiki/Help:Graph_format
11			*
12			* @license GNU GPL v2+
13			* @since 3.2
14			*
15			* @author Sebastian Schmid (gesinn.it)
16			*
17			*/
18
19			class GraphFormatter {
20
21			private $graph = "";
22
23			protected $graphColors = [
24			'black',
25			'red',
26			'green',
27			'blue',
28			'darkviolet',
29			'gold',
30			'deeppink',
31			'brown',
32			'bisque',
33			'darkgreen',
34			'yellow',
35			'darkblue',
36			'magenta',
37			'steelblue2'
38			];
39			private $legendItem = [];
40			private $options;
41
42			public function __construct( $options ){
43			$this->options = $options;
44			}
45
46			public function getGraph(){
47			return $this->graph;
48			}
49
50			/*
51			* Add a single string to graph
52			*
53			* @param string $line
54			*/
55			private function add( $line ){
56			$this->graph .= $line;
57			}
58
59			/*
60			* Creates the DOT (graph description language) which can be processed by the graphviz lib
61			*
62			* @see https://www.graphviz.org/
63			* @since 3.2
64			*
65			* @param SRF\Graph\GraphNodes[] $nodes
66			*/
67			public function buildGraph($nodes){
68			$this->add( "digraph " . $this->options->graphName . " {" );
69
70			// set fontsize and fontname of graph, nodes and edges
71			$this->add( "graph [fontsize=10, fontname=\"Verdana\"]\n" );
72			$this->add( "node [fontsize=10, fontname=\"Verdana\"];\n" );
73			$this->add( "edge [fontsize=10, fontname=\"Verdana\"];\n" );
74
75			// choose graphsize, nodeshapes and rank direction
76			if ( $this->options->graphSize != '' ) {
77			$this->add("size=\"" . $this->options->graphSize . "\";");
78			}
79
80			if ( $this->options->nodeShape != '' ) {
81			$this->add( "node [shape=" . $this->options->nodeShape . "];" );
82			}
83
84			$this->add( "rankdir=" . $this->options->rankDir . ";" );
85
86			/** @var \SRF\GraphNode $node */
87			foreach ( $nodes as $node ) {
88
89			// take "displaytitle" as node-label if it is set
90			if ( $this->options->nodeLabel === GraphPrinter::NODELABEL_DISPLAYTITLE) {
91			$objectDisplayTitle = $node->getLabel();
92			if ( !empty( $objectDisplayTitle )) {
93			$nodeLabel = $this->getWordWrappedText( $objectDisplayTitle,
94			$this->options->wordWrapLimit );
95			}
96			}
97
98			/**
99			* Add nodes to the graph
100			*
101			* @var \SRF\Graph\GraphNode $node
102			*/
103			$this->add( "\"" . $node->getID() . "\"" );
104
105			if ( $this->options->enableGraphLink ) {
106
107			$nodeLinkURL = "[[" . $node->getID() . "]]";
108
109			if( $nodeLabel === '' ) {
110			$this->add( " [URL = \"$nodeLinkURL\"]" );
111			} else {
112			$this->add( " [URL = \"$nodeLinkURL\", label = \"$nodeLabel\"]" );
			0 ignored issues – show Bug introduced 2019-08-26 15:56 UTC by Report Bug Copy Issue Report The variable `$nodeLabel` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
113			}
114			}
115			$this->add( "; ");
116			}
117
118			/**
119			* Add edges to the graph
120			*
121			* @var \SRF\Graph\GraphNode $node
122			*/
123			foreach ( $nodes as $node ) {
124
125			if ( count( $node->getParentNode() ) > 0 ) {
126
127			foreach ( $node->getParentNode() as $parentNode ) {
128
129			// handle parent/child switch (parentRelation)
130			$this->add( $this->options->parentRelation ? " \"" . $parentNode['object']
131			. "\" -> \"" . $node->getID() . "\""
132			: " \"" . $node->getID() . "\" -> \"" . $parentNode['object'] . "\" " );
133
134			if ( $this->options->showGraphLabel \|\| $this->options->showGraphColor ) {
135			$this->add( ' [' );
136
137			// add legend item only if missing
138			if ( array_search( $parentNode['predicate'], $this->legendItem, true ) === false ) {
139			$this->legendItem[] = $parentNode['predicate'];
140			}
141
142			// assign color
143			$color = $this->graphColors[array_search( $parentNode['predicate'], $this->legendItem, true )];
144
145			// show arrow label (graphLabel is misleading but kept for compatibility reasons)
146			if ( $this->options->showGraphLabel ) {
147			$this->add( "label=\"" . $parentNode['predicate'] . "\"" );
148			if ( $this->options->showGraphColor ) {
149			$this->add( ",fontcolor=$color," );
150			}
151			}
152
153			// colorize arrow
154			if ( $this->options->showGraphColor ) {
155			$this->add( "color=$color" );
156			}
157			$this->add( "]" );
158			}
159			$this->add( ";" );
160			}
161			}
162			}
163			$this->add( "}" );
164			}
165
166			/**
167			* Creates the graph legend
168			*
169			* @return string Html::rawElement
170			*/
171			public function getGraphLegend(){
172			$itemsHtml = '';
173			$colorCount = 0;
174			$arraySize = count( $this->graphColors );
175
176			if ( $this->options->showGraphLegend && $this->options->showGraphColor ) {
177			foreach ( $this->legendItem as $legendLabel ) {
178			if ( $colorCount >= $arraySize ) {
179			$colorCount = 0;
180			}
181
182			$color = $this->graphColors[$colorCount];
183			$itemsHtml .= Html::rawElement( 'div', [ 'class' => 'graphlegenditem', 'style' => "color: $color" ],
184			"$color: $legendLabel" );
185
186			$colorCount ++;
187			}
188			}
189
190			return Html::rawElement( 'div', [ 'class' => 'graphlegend' ], "$itemsHtml");
191			}
192
193			/**
194			* Returns the word wrapped version of the provided text.
195			*
196			* @param string $text
197			* @param integer $charLimit
198			*
199			* @return string
200			*/
201			public static function getWordWrappedText( $text, $charLimit ) {
202			$charLimit = max( [ $charLimit, 1 ] );
203			$segments = [];
204
205			while ( strlen( $text ) > $charLimit ) {
206			// Find the last space in the allowed range.
207			$splitPosition = strrpos( substr( $text, 0, $charLimit ), ' ' );
208
209			if ( $splitPosition === false ) {
210			// If there is no space (lond word), find the next space.
211			$splitPosition = strpos( $text, ' ' );
212
213			if ( $splitPosition === false ) {
214			// If there are no spaces, everything goes on one line.
215			$splitPosition = strlen( $text ) - 1;
216			}
217			}
218
219			$segments[] = substr( $text, 0, $splitPosition + 1 );
220			$text = substr( $text, $splitPosition + 1 );
221			}
222
223			$segments[] = $text;
224
225			return implode( '\n', $segments );
226			}
227			}

SemanticMediaWiki / SemanticResultFormats

Pull Request — master (#538)

GraphFormatter::buildGraph() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like