SRF\Outline\OutlineResultPrinter

Complexity

Total Complexity

17

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

90.91%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	getParamDefinitions()	0	42	1
B	getResultText()	0	53	7
A	newOutlineItem()	0	21	4
A	getIntroTemplate()	0	6	2
A	getOutroTemplate()	0	6	2

<?php

namespace SRF\Outline;

use SMWResultPrinter as ResultPrinter;
use SMWQueryResult as QueryResult;

/**
 * A class to print query results in an outline format, along with some
 * helper classes to handle the aggregation
 *
 * @license GNU GPL v2+
 * @since 1.4.3
 *
 * @author Yaron Koren
 */
class OutlineResultPrinter extends ResultPrinter {

	/**
	 * @see ResultPrinter::getName
	 *
	 * {@inheritDoc}
	 */
	public function getName() {
		return wfMessage( 'srf_printername_outline' )->text();
	}

	/**
	 * @see SMWResultPrinter::getParamDefinitions
	 *
	 * @since 1.8
	 *
	 * {@inheritDoc}
	 */
	public function getParamDefinitions( array $definitions ) {
		$params = parent::getParamDefinitions( $definitions );

		$params['outlineproperties'] = [
			'islist' => true,
			'default' => [],
			'message' => 'srf_paramdesc_outlineproperties',
		];

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

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

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

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

		$params[] = [
			'name' => 'named args',
			'type' => 'boolean',
			'message' => 'smw-paramdesc-named_args',
			'default' => true,
		];

		return $params;
	}

	/**
	 * @see ResultPrinter::getResultText
	 *
	 * {@inheritDoc}
	 */
	protected function getResultText( QueryResult $res, $outputMode ) {

		// for each result row, create an array of the row itself
		// and all its sorted-on fields, and add it to the initial
		// 'tree'
		$outlineTree = new OutlineTree();

		while ( $row = $res->getNext() ) {
			$outlineTree->addItem( $this->newOutlineItem( $row ) );
		}

		// now, cycle through the outline properties, creating the
		// tree
		foreach ( $this->params['outlineproperties'] as $property ) {
			$outlineTree->addProperty( $property );
		}

		if ( $this->params['template'] !== '' ) {
			$this->hasTemplates = true;
			$templateBuilder = new TemplateBuilder(
				$this->params
			);

			$templateBuilder->setLinker( $this->mLinker );
			$result = $templateBuilder->build( $outlineTree );
		} else {
			$listTreeBuilder = new ListTreeBuilder(
				$this->params + [ 'showHeaders' => $this->mShowHeaders ]
			);

			$listTreeBuilder->setLinker( $this->mLinker );
			$result = $listTreeBuilder->build( $outlineTree );
		}

		if ( $this->linkFurtherResults( $res ) ) {
			$link = $this->getFurtherResultsLink(
				$res,
				$outputMode
			);

			$result .= $link->getText( $outputMode, $this->mLinker ) . "\n";
		}

		if( $this->params['introtemplate'] !== '' || $this->params['introtemplate'] !== ''){
			$this->hasTemplates = true;
		}

		$result = $this->getIntroTemplate() . $result;

		$result .= $this->getOutroTemplate();

		return $result;
	}

	private function newOutlineItem( $row ) {

		$outlineItem = new OutlineItem( $row );

		foreach ( $row as $field ) {
			$name = $field->getPrintRequest()->getText( SMW_OUTPUT_HTML );

			if ( !in_array( $name, $this->params['outlineproperties'] ) ) {
				continue;
			}

			while ( ( $dataValue = $field->getNextDataValue() ) !== false ) {
				$outlineItem->addFieldValue(
					$name,
					$dataValue->getLongWikiText( $this->getLinker() )
				);
			}
		}

		return $outlineItem;
	}

	function getIntroTemplate(): string {

It is generally recommended to explicitly declare the visibility for methods.

		if ( $this->params['introtemplate'] !== '' ) {
			return "{{" . $this->params['introtemplate'] . "}}";
		}
		return "";
	}

	function getOutroTemplate(): string {

It is generally recommended to explicitly declare the visibility for methods.

		if ( $this->params['outrotemplate'] !== '' ) {
			return "{{" . $this->params['outrotemplate'] . "}}";
		}
		return "";
	}
}