SRF\Formats\Tree\TreeResultPrinter

Complexity

Total Complexity

45

Size/Duplication

Total Lines	346
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

91.47%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	5	1
A	getQueryResult()	0	8	2
A	setQueryResult()	0	3	1
A	buildLinesFromTree()	0	13	1
A	addError()	0	8	1
B	postProcessParameters()	0	29	8
B	getResultText()	0	46	7
A	getTemplateCall()	0	8	2
A	getParamDefinitions()	0	31	1
A	buildTreeFromQueryResult()	0	10	3
A	getRootHash()	0	16	3
A	getHashOfNodes()	0	16	2
A	getLinker()	0	3	1
A	getLinkerForColumn()	0	3	1
A	initalizeStandardTemplateParameters()	0	11	2
B	buildTreeFromNodeList()	0	42	9

<?php

namespace SRF\Formats\Tree;

/**
 * File holding the Tree class.
 * @author Stephan Gambke
 */
use \Exception;
use Html;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMW\ListResultPrinter;
use SMWQueryResult;
use Title;

/**
 * Result printer that prints query results as a tree (nested html lists).
 *
 * The available formats are 'tree', 'ultree', 'oltree'. 'tree' is an alias of
 * 'ultree'. In an #ask query the parameter 'parent' must be set to contain the
 * name of the property, that gives the parent page of the subject page.
 *
 */
class TreeResultPrinter extends ListResultPrinter {

	private $standardTemplateParameters;

	/**
	 * @var SMWQueryResult | null
	 */
	private $queryResult = null;

	/**
	 * (non-PHPdoc)
	 * @see SMWResultPrinter::getName()
	 */
	public function getName() {
		// Give grep a chance to find the usages:
		// srf-printername-tree, srf-printername-ultree, srf-printername-oltree
		return \Message::newFromKey( 'srf-printername-' . $this->mFormat )->text();
	}

	/**
	 * @return SMWQueryResult
	 * @throws Exception
	 */
	public function getQueryResult() {

		if ( $this->queryResult === null ) {
			throw new Exception( __METHOD__ . ' called outside of ' . __CLASS__ . '::getResultText().');
		}

		return $this->queryResult;
	}

	/**
	 * @param SMWQueryResult | null $queryResult
	 */
	public function setQueryResult( $queryResult ) {
		$this->queryResult = $queryResult;
	}

	/**
	 * @see ResultPrinter::postProcessParameters()
	 */
	protected function postProcessParameters() {

		parent::postProcessParameters();

		// Don't support pagination in trees
		$this->mSearchlabel = null;

		if ( array_key_exists( 'template arguments', $this->params )
			&& $this->params['template arguments'] !== 'numbered' ) {

			if ( filter_var( $this->params[ 'named args' ], FILTER_VALIDATE_BOOLEAN ) === true ) {
				$this->params['template arguments'] = 'legacy';
			} elseif (
				$this->params['template arguments'] !== 'named' &&
				$this->params['template arguments'] !== 'legacy'
			) {
				// default
				$this->params['template arguments'] = 'numbered';
			}
		}

		// Allow "_" for encoding spaces, as documented
		$this->params[ 'sep' ] = str_replace( '_', ' ', $this->params[ 'sep' ] );

		if ( !ctype_digit( strval( $this->params[ 'start level' ] ) ) || $this->params[ 'start level' ] < 1 ) {
			$this->params[ 'start level' ] = 1;
		}

	}

	/**
	 * Return serialised results in specified format.
	 * @param SMWQueryResult $queryResult
	 * @param $outputmode
	 * @return string
	 */
	protected function getResultText( SMWQueryResult $queryResult, $outputmode ) {

		$this->setQueryResult( $queryResult );

		if ( $this->params[ 'parent' ] === '' ) {
			$this->addError( 'srf-tree-noparentprop' );
			return '';
		}

		$rootHash = $this->getRootHash();

		if ( $rootHash === false ) {
			$this->addError( 'srf-tree-rootinvalid', $this->params[ 'root' ] );
			return '';
		}

		$this->hasTemplates =
			$this->params[ 'introtemplate' ] !== '' ||
			$this->params[ 'outrotemplate' ] !== '' ||
			$this->params[ 'template' ] !== '';

		if ( $this->hasTemplates ) {
			$this->initalizeStandardTemplateParameters();
		}

		$tree = $this->buildTreeFromQueryResult( $rootHash );
		$lines = $this->buildLinesFromTree( $tree );

		// Display default if the result is empty
		if ( count( $lines ) === 0 ) {
			return $this->params[ 'default' ];
		}

		// FIXME: Linking to further events ($this->linkFurtherResults())
		// does not make sense for tree format. But maybe display a warning?

		$resultText = join( "\n", array_merge(
			[ $this->getTemplateCall( $this->params[ 'introtemplate' ] ) ],
			$lines,
			[ $this->getTemplateCall( $this->params[ 'outrotemplate' ] ) ]
		) );

		$this->setQueryResult( null );

		return Html::rawElement( 'div', [ 'class' => 'srf-tree' ], $resultText );
	}

	/**
	 * @param string $templateName
	 * @param string[] $params
	 * @return string
	 */
	public function getTemplateCall( $templateName, $params = [] ) {

		if ( $templateName === '' ) {
			return '';
		}

		return '{{' . $templateName . '|' . join( '|', $params ) . $this->standardTemplateParameters . '}}';
	}

	/**
	 * @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[ 'parent' ] = [
			'default' => '',
			'message' => 'srf-paramdesc-tree-parent',
		];

		$params[ 'root' ] = [
			'default' => '',
			'message' => 'srf-paramdesc-tree-root',
		];

		$params[ 'start level' ] = [
			'default' => 1,
			'message' => 'srf-paramdesc-tree-startlevel',
			'type' => 'integer',
		];

		$params[ 'sep' ] = [
			'default' => ', ',
			'message' => 'smw-paramdesc-sep',
		];

		$params[ 'template arguments' ] = [
			'default' => '',
			'message' => 'smw-paramdesc-template-arguments',
		];

		return $params;
	}

	/**
	 * @param string $rootHash
	 * @return TreeNode
	 */
	protected function buildTreeFromQueryResult( $rootHash ) {

		$nodes = $this->getHashOfNodes();

		if ( $rootHash !== '' && !array_key_exists( $rootHash, $nodes ) ) {
			return new TreeNode();
		}

		return $this->buildTreeFromNodeList( $rootHash, $nodes );
	}

	/**
	 * @return string | false
	 */
	protected function getRootHash() {

		if ( $this->params[ 'root' ] === '' ) {
			return '';
		}

		// get the title object of the root page
		$rootTitle = Title::newFromText( $this->params[ 'root' ] );

		if ( $rootTitle !== null ) {
			return DIWikiPage::newFromTitle( $rootTitle )->getSerialization();
		}

		return false;

The return type of return false; (false) is incompatible with the return type documented by SRF\Formats\Tree\TreeResultPrinter::getRootHash of type string.

	}

	/**
	 * @return TreeNode[]
	 */
	protected function getHashOfNodes() {

		/** @var TreeNode[] $nodes */
		$nodes = [];

		$queryResult = $this->getQueryResult();

		$row = $queryResult->getNext();
		while ( $row !== false ) {
			$node = new TreeNode( $row );
			$nodes[ $node->getHash() ] = $node;
			$row = $queryResult->getNext();
		}

		return $nodes;
	}

	/**
	 * Returns a linker object for making hyperlinks
	 * @return \Linker
	 */
	public function getLinker( $firstcol = false ) {
		return $this->mLinker;
	}

	/**
	 * Depending on current linking settings, returns a linker object
	 * for making hyperlinks or NULL if no links should be created.
	 *
	 * @param int $column Column number
	 * @return \Linker|null
	 */
	public function getLinkerForColumn( $column ) {
		return parent::getLinker( $column === 0 );

It seems like you call parent on a different method (getLinker() instead of getLinkerForColumn()). Are you sure this is correct? If so, you might want to change this to $this->getLinker().

	}

	private function initalizeStandardTemplateParameters() {

		$query = $this->getQueryResult()->getQuery();

		$this->standardTemplateParameters =
			( trim( $this->params[ 'userparam' ] ) !== '' ? ( '|userparam=' . trim( $this->params['userparam'] ) ) : '' ) .
			'|smw-resultquerycondition=' . $query->getQueryString() .
			'|smw-resultquerylimit=' . $query->getLimit() .
			'|smw-resultqueryoffset=' . $query->getOffset();

	}

	/**
	 * @param string $rootHash
	 * @param TreeNode[] $nodes
	 * @return TreeNode
	 */
	protected function buildTreeFromNodeList( $rootHash, $nodes ) {

		$isRootSpecified = $rootHash !== '';

		$root = new TreeNode();
		if ( $isRootSpecified ) {
			$root->addChild( $nodes[ $rootHash ] );
		}

		$store = $this->getQueryResult()->getStore();
		$parentPointerProperty = DIProperty::newFromUserLabel( $this->params[ 'parent' ] );

		foreach ( $nodes as $hash => $node ) {

			$parents = $store->getPropertyValues(
				$node->getResultSubject(), $parentPointerProperty
			);

			if ( empty( $parents ) && !$isRootSpecified ) {

				$root->addChild( $node );

			} else {

				foreach ( $parents as $parent ) {

					$parentHash = $parent->getSerialization();

					try {
						if ( array_key_exists( $parentHash, $nodes ) ) {
							$nodes[ $parentHash ]->addChild( $node );
						} elseif ( !$isRootSpecified ) {
							$root->addChild( $node );
						}
					} catch ( Exception $e ) {
						$this->addError( $e->getMessage(), $node->getResultSubject()->getTitle()->getPrefixedText() );
					}
				}
			}
		}
		return $root;
	}

	/**
	 * @param TreeNode $tree
	 * @return mixed
	 */
	protected function buildLinesFromTree( $tree ) {
		$nodePrinterConfiguration = [
			'format' => trim( $this->params[ 'format' ] ),
			'template' => trim( $this->params[ 'template' ] ),
			'headers' => $this->params[ 'headers' ],
			'template arguments' => $this->params['template arguments'],
			'sep' => $this->params[ 'sep' ],
		];

		$visitor = new TreeNodePrinter( $this, $nodePrinterConfiguration );
		$lines = $tree->accept( $visitor );
		return $lines;
	}

	/**
	 * @param string $msgkey
	 * @param string | string[] $params
	 */
	protected function addError( $msgkey, $params = [] ) {

		parent::addError(
			\Message::newFromKey( $msgkey )
				->params( $params )
				->inContentLanguage()->text()
			);
	}

}