GraphPrinter::getParamDefinitions() - 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-26 15:42 UTC

GraphPrinter::getParamDefinitions() B

↳ Parent: GraphPrinter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	75
ccs	0
cts	20
cp	0
rs	8.5454
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

How to fix Long Method

<?php

namespace SRF\Graph;

use SMW\ResultPrinter;
use SMWQueryResult;
use SMWWikiPageValue;
use GraphViz;
use Html;

/**
 * SMW result printer for graphs using graphViz.
 * In order to use this printer you need to have both
 * the graphViz library installed on your system and
 * have the graphViz MediaWiki extension installed.
 *
 * @file SRF_Graph.php
 * @ingroup SemanticResultFormats
 *
 * @licence GNU GPL v2+
 * @author Frank Dengler
 * @author Jeroen De Dauw < [email protected] >
 * @author Sebastian Schmid
 */
class GraphPrinter extends ResultPrinter {

	const NODELABEL_DISPLAYTITLE = 'displaytitle';
	public static $NODE_LABELS = [
		self::NODELABEL_DISPLAYTITLE,
	];

	public static $NODE_SHAPES = [
		'box',
		'box3d',
		'circle',
		'component',
		'diamond',
		'doublecircle',
		'doubleoctagon',
		'egg',
		'ellipse',
		'folder',
		'hexagon',
		'house',
		'invhouse',
		'invtrapezium',
		'invtriangle',
		'Mcircle',
		'Mdiamond',
		'Msquare',
		'none',
		'note',
		'octagon',
		'parallelogram',
		'pentagon ',
		'plaintext',
		'point',
		'polygon',
		'rect',
		'rectangle',
		'septagon',
		'square',
		'tab',
		'trapezium',
		'triangle',
		'tripleoctagon',
	];
	private $nodes = [];
	private $options = [];

	public function getName() {
		return $this->msg( 'srf-printername-graph' )->text();
	}


	/**
	 * @see SMWResultPrinter::handleParameters()
	 */
	protected function handleParameters( array $params, $outputmode ) {
		parent::handleParameters( $params, $outputmode );

		$this->options = [
			'graphName' => trim( $params['graphname'] ),
			'graphSize' => trim( $params['graphsize'] ),
			'nodeShape' => $params['nodeshape'],
			'nodeLabel' => $params['nodelabel'],
			'rankDir' => strtoupper( trim( $params['arrowdirection'] ) ),
			'wordWrapLimit' => $params['wordwraplimit'],
			'parentRelation' => strtolower( trim( $params['relation'] ) ) == 'parent',
			'enableGraphLink' => $params['graphlink'],
			'showGraphLabel' => $params['graphlabel'],
			'showGraphColor' => $params['graphcolor'],
			'showGraphLegend' => $params['graphlegend']
		];
	}


	/**
	 * @param SMWQueryResult $res
	 * @param $outputmode
	 * @return string
	 */
	protected function getResultText( SMWQueryResult $res, $outputmode ) {
		if ( !class_exists( 'GraphViz' )
			&& !class_exists( '\\MediaWiki\\Extension\\GraphViz\\GraphViz' )
		) {
			wfWarn( 'The SRF Graph printer needs the GraphViz extension to be installed.' );
			return '';
		}

		// iterate query result and create SRF\GraphNodes
		while ( $row = $res->getNext() ) {
			$this->processResultRow( $row );
		}

		// use GraphFormater to build the graph
		$graphFormatter = new GraphFormatter( $this->options );
		$graphFormatter->buildGraph( $this->nodes );

		// Calls graphvizParserHook function from MediaWiki GraphViz extension
		$result = $GLOBALS['wgParser']->recursiveTagParse( "<graphviz>" . $graphFormatter->getGraph
				() . "</graphviz>" );

		// append legend
		$result .= $graphFormatter->getGraphLegend();

		return $result;
	}


	/**
	 * Process a result row and create SRF\GraphNodes
	 *
	 * @since 3.1
	 *
	 * @param array $row
	 *
	 */
	protected function processResultRow( array /* of SMWResultArray */ $row ) {

		// loop through all row fields
		foreach ( $row as $i => $resultArray ) {

			// loop through all values of a multivalue field
			while ( ( /* SMWWikiPageValue */
				$object = $resultArray->getNextDataValue() ) !== false ) {

				// create SRF\GraphNode for column 0
				if ( $i == 0 ) {
					$node = new GraphNode( $object->getShortWikiText() );
					$node->setLabel( $object->getDisplayTitle() );
					$this->nodes[] = $node;
				} else {
					$node->addParentNode( $resultArray->getPrintRequest()->getLabel(), $object->getShortWikiText() );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
				}
			}
		}
	}


	/**
	 * @see SMWResultPrinter::getParamDefinitions
	 *
	 * @since 1.8
	 *
	 * @param $definitions array of IParamDefinition
	 *
	 * @return array of IParamDefinition|array
	 */
	public function getParamDefinitions( array $definitions ) {
		$params = parent::getParamDefinitions( $definitions );

		$params['graphname'] = [
			'default' => 'QueryResult',
			'message' => 'srf-paramdesc-graphname',
		];

		$params['graphsize'] = [
			'type' => 'string',
			'default' => '',
			'message' => 'srf-paramdesc-graphsize',
			'manipulatedefault' => false,
		];

		$params['graphlegend'] = [
			'type' => 'boolean',
			'default' => false,
			'message' => 'srf-paramdesc-graphlegend',
		];

		$params['graphlabel'] = [
			'type' => 'boolean',
			'default' => false,
			'message' => 'srf-paramdesc-graphlabel',
		];

		$params['graphlink'] = [
			'type' => 'boolean',
			'default' => false,
			'message' => 'srf-paramdesc-graphlink',
		];

		$params['graphcolor'] = [
			'type' => 'boolean',
			'default' => false,
			'message' => 'srf-paramdesc-graphcolor',
		];

		$params['arrowdirection'] = [
			'aliases' => 'rankdir',
			'default' => 'LR',
			'message' => 'srf-paramdesc-rankdir',
			'values'  => [ 'LR', 'RL', 'TB', 'BT' ],
		];

		$params['nodeshape'] = [
			'default' => false,
			'message' => 'srf-paramdesc-graph-nodeshape',
			'manipulatedefault' => false,
			'values' => self::$NODE_SHAPES,
		];

		$params['relation'] = [
			'default' => 'child',
			'message' => 'srf-paramdesc-graph-relation',
			'manipulatedefault' => false,
			'values' => [ 'parent', 'child' ],
		];

		$params['wordwraplimit'] = [
			'type' => 'integer',
			'default' => 25,
			'message' => 'srf-paramdesc-graph-wwl',
			'manipulatedefault' => false,
		];

		$params['nodelabel'] = [
			'default' => '',
			'message' => 'srf-paramdesc-nodelabel',
			'values' => self::$NODE_LABELS,
		];

		return $params;
	}
}


1			<?php
2
3			namespace SRF\Graph;
4
5			use SMW\ResultPrinter;
6			use SMWQueryResult;
7			use SMWWikiPageValue;
8			use GraphViz;
9			use Html;
10
11			/**
12			* SMW result printer for graphs using graphViz.
13			* In order to use this printer you need to have both
14			* the graphViz library installed on your system and
15			* have the graphViz MediaWiki extension installed.
16			*
17			* @file SRF_Graph.php
18			* @ingroup SemanticResultFormats
19			*
20			* @licence GNU GPL v2+
21			* @author Frank Dengler
22			* @author Jeroen De Dauw < [email protected] >
23			* @author Sebastian Schmid
24			*/
25			class GraphPrinter extends ResultPrinter {
26
27			const NODELABEL_DISPLAYTITLE = 'displaytitle';
28			public static $NODE_LABELS = [
29			self::NODELABEL_DISPLAYTITLE,
30			];
31
32			public static $NODE_SHAPES = [
33			'box',
34			'box3d',
35			'circle',
36			'component',
37			'diamond',
38			'doublecircle',
39			'doubleoctagon',
40			'egg',
41			'ellipse',
42			'folder',
43			'hexagon',
44			'house',
45			'invhouse',
46			'invtrapezium',
47			'invtriangle',
48			'Mcircle',
49			'Mdiamond',
50			'Msquare',
51			'none',
52			'note',
53			'octagon',
54			'parallelogram',
55			'pentagon ',
56			'plaintext',
57			'point',
58			'polygon',
59			'rect',
60			'rectangle',
61			'septagon',
62			'square',
63			'tab',
64			'trapezium',
65			'triangle',
66			'tripleoctagon',
67			];
68			private $nodes = [];
69			private $options = [];
70
71			public function getName() {
72			return $this->msg( 'srf-printername-graph' )->text();
73			}
74
75
76			/**
77			* @see SMWResultPrinter::handleParameters()
78			*/
79			protected function handleParameters( array $params, $outputmode ) {
80			parent::handleParameters( $params, $outputmode );
81
82			$this->options = [
83			'graphName' => trim( $params['graphname'] ),
84			'graphSize' => trim( $params['graphsize'] ),
85			'nodeShape' => $params['nodeshape'],
86			'nodeLabel' => $params['nodelabel'],
87			'rankDir' => strtoupper( trim( $params['arrowdirection'] ) ),
88			'wordWrapLimit' => $params['wordwraplimit'],
89			'parentRelation' => strtolower( trim( $params['relation'] ) ) == 'parent',
90			'enableGraphLink' => $params['graphlink'],
91			'showGraphLabel' => $params['graphlabel'],
92			'showGraphColor' => $params['graphcolor'],
93			'showGraphLegend' => $params['graphlegend']
94			];
95			}
96
97
98			/**
99			* @param SMWQueryResult $res
100			* @param $outputmode
101			* @return string
102			*/
103			protected function getResultText( SMWQueryResult $res, $outputmode ) {
104			if ( !class_exists( 'GraphViz' )
105			&& !class_exists( '\\MediaWiki\\Extension\\GraphViz\\GraphViz' )
106			) {
107			wfWarn( 'The SRF Graph printer needs the GraphViz extension to be installed.' );
108			return '';
109			}
110
111			// iterate query result and create SRF\GraphNodes
112			while ( $row = $res->getNext() ) {
113			$this->processResultRow( $row );
114			}
115
116			// use GraphFormater to build the graph
117			$graphFormatter = new GraphFormatter( $this->options );
118			$graphFormatter->buildGraph( $this->nodes );
119
120			// Calls graphvizParserHook function from MediaWiki GraphViz extension
121			$result = $GLOBALS['wgParser']->recursiveTagParse( "<graphviz>" . $graphFormatter->getGraph
122			() . "</graphviz>" );
123
124			// append legend
125			$result .= $graphFormatter->getGraphLegend();
126
127			return $result;
128			}
129
130
131			/**
132			* Process a result row and create SRF\GraphNodes
133			*
134			* @since 3.1
135			*
136			* @param array $row
137			*
138			*/
139			protected function processResultRow( array /* of SMWResultArray */ $row ) {
140
141			// loop through all row fields
142			foreach ( $row as $i => $resultArray ) {
143
144			// loop through all values of a multivalue field
145			while ( ( /* SMWWikiPageValue */
146			$object = $resultArray->getNextDataValue() ) !== false ) {
147
148			// create SRF\GraphNode for column 0
149			if ( $i == 0 ) {
150			$node = new GraphNode( $object->getShortWikiText() );
151			$node->setLabel( $object->getDisplayTitle() );
152			$this->nodes[] = $node;
153			} else {
154			$node->addParentNode( $resultArray->getPrintRequest()->getLabel(), $object->getShortWikiText() );
			0 ignored issues – show Bug introduced 2019-08-20 12:43 UTC by Report Bug Copy Issue Report The variable `$node` 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...
155			}
156			}
157			}
158			}
159
160
161			/**
162			* @see SMWResultPrinter::getParamDefinitions
163			*
164			* @since 1.8
165			*
166			* @param $definitions array of IParamDefinition
167			*
168			* @return array of IParamDefinition\|array
169			*/
170			public function getParamDefinitions( array $definitions ) {
171			$params = parent::getParamDefinitions( $definitions );
172
173			$params['graphname'] = [
174			'default' => 'QueryResult',
175			'message' => 'srf-paramdesc-graphname',
176			];
177
178			$params['graphsize'] = [
179			'type' => 'string',
180			'default' => '',
181			'message' => 'srf-paramdesc-graphsize',
182			'manipulatedefault' => false,
183			];
184
185			$params['graphlegend'] = [
186			'type' => 'boolean',
187			'default' => false,
188			'message' => 'srf-paramdesc-graphlegend',
189			];
190
191			$params['graphlabel'] = [
192			'type' => 'boolean',
193			'default' => false,
194			'message' => 'srf-paramdesc-graphlabel',
195			];
196
197			$params['graphlink'] = [
198			'type' => 'boolean',
199			'default' => false,
200			'message' => 'srf-paramdesc-graphlink',
201			];
202
203			$params['graphcolor'] = [
204			'type' => 'boolean',
205			'default' => false,
206			'message' => 'srf-paramdesc-graphcolor',
207			];
208
209			$params['arrowdirection'] = [
210			'aliases' => 'rankdir',
211			'default' => 'LR',
212			'message' => 'srf-paramdesc-rankdir',
213			'values' => [ 'LR', 'RL', 'TB', 'BT' ],
214			];
215
216			$params['nodeshape'] = [
217			'default' => false,
218			'message' => 'srf-paramdesc-graph-nodeshape',
219			'manipulatedefault' => false,
220			'values' => self::$NODE_SHAPES,
221			];
222
223			$params['relation'] = [
224			'default' => 'child',
225			'message' => 'srf-paramdesc-graph-relation',
226			'manipulatedefault' => false,
227			'values' => [ 'parent', 'child' ],
228			];
229
230			$params['wordwraplimit'] = [
231			'type' => 'integer',
232			'default' => 25,
233			'message' => 'srf-paramdesc-graph-wwl',
234			'manipulatedefault' => false,
235			];
236
237			$params['nodelabel'] = [
238			'default' => '',
239			'message' => 'srf-paramdesc-nodelabel',
240			'values' => self::$NODE_LABELS,
241			];
242
243			return $params;
244			}
245			}
246

SemanticMediaWiki / SemanticResultFormats

Pull Request — master (#538)

GraphPrinter::getParamDefinitions() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like