Maps\SemanticMW\ResultPrinters\QueryHandler

Complexity

Total Complexity

89

Size/Duplication

Total Lines	533
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setTemplate()	0	3	2
A	setUserParam()	0	3	1
A	setIcon()	0	3	1
A	setTitle()	0	3	1
A	setText()	0	3	1
A	setSubjectSeparator()	0	3	1
A	setShowSubject()	0	3	1
A	setPageLinkText()	0	3	1
A	setLinkStyle()	0	3	1
A	setHeaderStyle()	0	3	1
A	getShapes()	0	4	1
A	findShapes()	0	5	2
D	handleResultRow()	0	68	18
B	getResultSubjectText()	0	41	10
A	showArticleLink()	0	3	1
A	isHeadersHide()	0	3	1
A	handleResultProperty()	0	12	4
B	getPropertyName()	0	26	7
A	getPropertyValue()	0	20	3
A	hasPage()	0	10	3
A	hasTemplate()	0	3	1
A	isHeadersShow()	0	3	1
A	isHeadersPlain()	0	3	1
B	getLocationIcon()	0	38	9
A	shouldGetActiveIconUrlFor()	0	6	3
A	buildLocationsList()	0	32	4
A	getTitleOutput()	0	7	3
A	getParser()	0	3	1
A	getHideNamespace()	0	3	1
A	setHideNamespace()	0	3	1
A	getActiveIcon()	0	3	1
A	setActiveIcon()	0	3	1

<?php

namespace Maps\SemanticMW\ResultPrinters;

use Html;
use Maps\Elements\Location;
use Maps\MapsFunctions;
use SMWDataValue;
use SMWPrintRequest;
use SMWQueryResult;
use SMWResultArray;
use SMWWikiPageValue;
use Title;

/**
 * Class for handling geographical SMW queries.
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class QueryHandler {

	/**
	 * The global icon.
	 * @var string
	 */
	public $icon = '';

	/**
	 * The global text.
	 * @var string
	 */
	public $text = '';

	/**
	 * The global title.
	 * @var string
	 */
	public $title = '';

	/**
	 * Make a separate link to the title or not?
	 * @var boolean
	 */
	public $titleLinkSeparate = false;

	private $queryResult;

	private $outputMode;

	/**
	 * @var array
	 */
	private $geoShapes = [
		'lines' => [],
		'locations' => [],
		'polygons' => []
	];

	/**
	 * The template to use for the text, or false if there is none.
	 * @var string|boolean false
	 */
	private $template = false;

	/**
	 * Should link targets be made absolute (instead of relative)?
	 * @var boolean
	 */
	private $linkAbsolute;

	/**
	 * The text used for the link to the page (if it's created). $1 will be replaced by the page name.
	 * @var string
	 */
	private $pageLinkText = '$1';

	/**
	 * A separator to use between the subject and properties in the text field.
	 * @var string
	 */
	private $subjectSeparator = '<hr />';

	/**
	 * Show the subject in the text or not?
	 * @var boolean
	 */
	private $showSubject = true;

	/**
	 * Hide the namespace or not.
	 * @var boolean
	 */
	private $hideNamespace = false;

	/**
	 * Defines which article names in the result are hyperlinked, all normally is the default
	 * none, subject, all
	 */
	private $linkStyle = 'all';

	/*
	 * Show headers (with links), show headers (just text) or hide them. show is default
	 * show, plain, hide
	 */
	private $headerStyle = 'show';

	/**
	 * Marker icon to show when marker equals active page
	 * @var string|null
	 */
	private $activeIcon = null;

	/**
	 * @var string
	 */
	private $userParam = '';

	public function __construct( SMWQueryResult $queryResult, int $outputMode, bool $linkAbsolute = false ) {
		$this->queryResult = $queryResult;
		$this->outputMode = $outputMode;
		$this->linkAbsolute = $linkAbsolute;
	}

	public function setTemplate( string $template ) {
		$this->template = $template === '' ? false : $template;
	}

	public function setUserParam( string $userParam ) {
		$this->userParam = $userParam;
	}

	/**
	 * Sets the global icon.
	 */
	public function setIcon( string $icon ) {
		$this->icon = $icon;
	}

	/**
	 * Sets the global title.
	 */
	public function setTitle( string $title ) {
		$this->title = $title;
	}

	/**
	 * Sets the global text.
	 */
	public function setText( string $text ) {
		$this->text = $text;
	}

	public function setSubjectSeparator( string $subjectSeparator ) {
		$this->subjectSeparator = $subjectSeparator;
	}

	public function setShowSubject( bool $showSubject ) {
		$this->showSubject = $showSubject;
	}

	/**
	 * Sets the text for the link to the page when separate from the title.
	 */
	public function setPageLinkText( string $text ) {
		$this->pageLinkText = $text;
	}

	public function setLinkStyle( string $link ) {
		$this->linkStyle = $link;
	}

	public function setHeaderStyle( string $headers ) {
		$this->headerStyle = $headers;
	}

	/**
	 * @return array
	 */
	public function getShapes() {
		$this->findShapes();
		return $this->geoShapes;
	}

	/**
	 * @since 2.0
	 */
	private function findShapes() {
		while ( ( $row = $this->queryResult->getNext() ) !== false ) {
			$this->handleResultRow( $row );
		}
	}

	/**
	 * Returns the locations found in the provided result row.
	 *
	 * @param SMWResultArray[] $row
	 */
	private function handleResultRow( array $row ) {
		$locations = [];
		$properties = [];

		$title = '';
		$text = '';

		// Loop through all fields of the record.
		foreach ( $row as $i => $resultArray ) {
			$printRequest = $resultArray->getPrintRequest();

			// Loop through all the parts of the field value.
			while ( ( $dataValue = $resultArray->getNextDataValue() ) !== false ) {
				if ( $dataValue->getTypeID() == '_wpg' && $i == 0 ) {
					$title = $dataValue->getLongText( $this->outputMode, null );
					$text = $this->getResultSubjectText( $dataValue );
				} else {
					if ( $dataValue->getTypeID() == '_str' && $i == 0 ) {
						$title = $dataValue->getLongText( $this->outputMode, null );
						$text = $dataValue->getLongText( $this->outputMode, smwfGetLinker() );
					} else {
						if ( strpos( $dataValue->getTypeID(), '_rec' ) !== false ) {
							foreach ( $dataValue->getDataItems() as $dataItem ) {
								if ( $dataItem instanceof \SMWDIGeoCoord ) {

The class SMWDIGeoCoord does not exist. Did you forget a USE statement, or did you not list all dependencies?

									$locations[] = Location::newFromLatLon(
										$dataItem->getLatitude(),
										$dataItem->getLongitude()
									);
								}
							}
						} else {
							if ( $dataValue->getTypeID() != '_geo' && $i != 0 && !$this->isHeadersHide() ) {
								$properties[] = $this->handleResultProperty( $dataValue, $printRequest );
							} else {
								if ( $printRequest->getMode(
									) == SMWPrintRequest::PRINT_PROP && $printRequest->getTypeID(
									) == '_geo' || $dataValue->getTypeID() == '_geo' ) {
									$dataItem = $dataValue->getDataItem();

									$locations[] = Location::newFromLatLon(
										$dataItem->getLatitude(),
										$dataItem->getLongitude()
									);
								}
							}
						}
					}
				}
			}
		}

		if ( $properties !== [] && $text !== '' ) {
			$text .= $this->subjectSeparator;
		}

		$icon = $this->getLocationIcon( $row );

		$this->geoShapes['locations'] = array_merge(
			$this->geoShapes['locations'],
			$this->buildLocationsList(
				$locations,
				$text,
				$icon,
				$properties,
				Title::newFromText( $title )
			)
		);
	}

	/**
	 * Handles a SMWWikiPageValue subject value.
	 * Gets the plain text title and creates the HTML text with headers and the like.
	 *
	 * @param SMWWikiPageValue $object
	 *
	 * @return string
	 */
	private function getResultSubjectText( SMWWikiPageValue $object ): string {
		if ( !$this->showSubject ) {
			return '';
		}

		if ( $this->showArticleLink() ) {
			if ( !$this->titleLinkSeparate && $this->linkAbsolute ) {
				$text = Html::element(
					'a',
					[ 'href' => $object->getTitle()->getFullUrl() ],
					$this->hideNamespace ? $object->getText() : $object->getTitle()->getFullText()
				);
			} else {
				if ( $this->hideNamespace ) {
					$text = $object->getShortHTMLText( smwfGetLinker() );
				} else {
					$text = $object->getLongHTMLText( smwfGetLinker() );
				}
			}
		} else {
			$text = $this->hideNamespace ? $object->getText() : $object->getTitle()->getFullText();
		}

		$text = '<b>' . $text . '</b>';

		if ( !$this->titleLinkSeparate ) {
			return $text;
		}

		$txt = $object->getTitle()->getText();

		if ( $this->pageLinkText !== '' ) {
			$txt = str_replace( '$1', $txt, $this->pageLinkText );
		}

		return $text . Html::element(
			'a',
			[ 'href' => $object->getTitle()->getFullUrl() ],
			$txt
		);
	}

	private function showArticleLink() {
		return $this->linkStyle !== 'none';
	}

	private function isHeadersHide() {
		return $this->headerStyle === 'hide';
	}

	/**
	 * Handles a single property (SMWPrintRequest) to be displayed for a record (SMWDataValue).
	 */
	private function handleResultProperty( SMWDataValue $object, SMWPrintRequest $printRequest ): string {
		if ( $this->hasTemplate() ) {
			if ( $object instanceof SMWWikiPageValue ) {

The class SMWWikiPageValue does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

				return $object->getTitle()->getPrefixedText();
			}

			return $object->getLongText( SMW_OUTPUT_WIKI, null );
		}

		$propertyName = $this->getPropertyName( $printRequest );
		return $propertyName . ( $propertyName === '' ? '' : ': ' ) . $this->getPropertyValue( $object );
	}

	private function getPropertyName( SMWPrintRequest $printRequest ): string {
		if ( $this->linkAbsolute ) {
			$titleText = $printRequest->getText( null );
			$t = Title::newFromText( $titleText, SMW_NS_PROPERTY );

			if ( $this->isHeadersShow() && $t instanceof Title && $t->exists() ) {

The class Title does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

				return  Html::element(
					'a',
					[ 'href' => $t->getFullUrl() ],
					$printRequest->getHTMLText( null )
				);
			}

			return $titleText;
		}

		if ( $this->isHeadersShow() ) {
			return $printRequest->getHTMLText( smwfGetLinker() );
		}

		if ( $this->isHeadersPlain() ) {
			return $printRequest->getText( null );
		}

		return '';
	}

	private function getPropertyValue( SMWDataValue $object ): string {
		if ( $this->linkAbsolute ) {
			if ( $this->hasPage( $object ) ) {
				return Html::element(
					'a',
					[
						'href' => Title::newFromText(
							$object->getLongText( $this->outputMode, null ),
							NS_MAIN
						)->getFullUrl()
					],
					$object->getLongText( $this->outputMode, null )
				);
			}

			return $object->getLongText( $this->outputMode, null );
		}

		return $object->getLongText( $this->outputMode, smwfGetLinker() );;
	}

	private function hasPage( SMWDataValue $object ): bool {
		$hasPage = $object->getTypeID() == '_wpg';

		if ( $hasPage ) {
			$t = Title::newFromText( $object->getLongText( $this->outputMode, null ), NS_MAIN );
			$hasPage = $t !== null && $t->exists();
		}

		return $hasPage;
	}

	private function hasTemplate() {
		return is_string( $this->template );
	}

	private function isHeadersShow() {
		return $this->headerStyle === 'show';
	}

	private function isHeadersPlain() {
		return $this->headerStyle === 'plain';
	}

	/**
	 * Get the icon for a row.
	 *
	 * @param array $row
	 *
	 * @return string
	 */
	private function getLocationIcon( array $row ) {
		$icon = '';
		$legendLabels = [];

		//Check for activeicon parameter

		if ( $this->shouldGetActiveIconUrlFor( $row[0]->getResultSubject()->getTitle() ) ) {
			$icon = MapsFunctions::getFileUrl( $this->activeIcon );

The method Maps\MapsFunctions::getFileUrl() has been deprecated.

		}

		// Look for display_options field, which can be set by Semantic Compound Queries
		// the location of this field changed in SMW 1.5
		$display_location = method_exists( $row[0], 'getResultSubject' ) ? $row[0]->getResultSubject() : $row[0];

		if ( property_exists( $display_location, 'display_options' ) && is_array(
				$display_location->display_options
			) ) {
			$display_options = $display_location->display_options;
			if ( array_key_exists( 'icon', $display_options ) ) {
				$icon = $display_options['icon'];

				// This is somewhat of a hack - if a legend label has been set, we're getting it for every point, instead of just once per icon
				if ( array_key_exists( 'legend label', $display_options ) ) {

					$legend_label = $display_options['legend label'];

					if ( !array_key_exists( $icon, $legendLabels ) ) {
						$legendLabels[$icon] = $legend_label;
					}
				}
			}
		} // Icon can be set even for regular, non-compound queries If it is, though, we have to translate the name into a URL here
		elseif ( $this->icon !== '' ) {
			$icon = MapsFunctions::getFileUrl( $this->icon );

The method Maps\MapsFunctions::getFileUrl() has been deprecated.

		}

		return $icon;
	}

	private function shouldGetActiveIconUrlFor( Title $title ) {
		global $wgTitle;

		return isset( $this->activeIcon ) && is_object( $wgTitle )
			&& $wgTitle->equals( $title );
	}

	/**
	 * Builds a set of locations with the provided title, text and icon.
	 *
	 * @param Location[] $locations
	 * @param string $text
	 * @param string $icon
	 * @param array $properties
	 * @param Title|null $title
	 *
	 * @return Location[]
	 */
	private function buildLocationsList( array $locations, $text, $icon, array $properties, Title $title = null ) {
		if ( !$this->hasTemplate() ) {
			$text .= implode( '<br />', $properties );
		}

		$titleOutput = $this->getTitleOutput( $title );

		foreach ( $locations as &$location ) {
			if ( $this->hasTemplate() ) {
				$segments = array_merge(
					[
						$this->template,
						'title=' . $titleOutput,
						'latitude=' . $location->getCoordinates()->getLatitude(),
						'longitude=' . $location->getCoordinates()->getLongitude(),
						'userparam=' . $this->userParam
					],
					$properties
				);

				$text .= $this->getParser()->recursiveTagParseFully(
					'{{' . implode( '|', $segments ) . '}}'
				);
			}

			$location->setTitle( $titleOutput );
			$location->setText( $text );
			$location->setIcon( trim( $icon ) );
		}

		return $locations;
	}

	private function getTitleOutput( Title $title = null ) {
		if ( $title === null ) {
			return '';
		}

		return $this->hideNamespace ? $title->getText() : $title->getFullText();
	}

	/**
	 * @return \Parser
	 */
	private function getParser() {
		return $GLOBALS['wgParser'];
	}

	/**
	 * @return boolean
	 */
	public function getHideNamespace() {
		return $this->hideNamespace;
	}

	/**
	 * @param boolean $hideNamespace
	 */
	public function setHideNamespace( $hideNamespace ) {
		$this->hideNamespace = $hideNamespace;
	}

	/**
	 * @return string
	 */
	public function getActiveIcon() {
		return $this->activeIcon;
	}

	/**
	 * @param string $activeIcon
	 */
	public function setActiveIcon( $activeIcon ) {
		$this->activeIcon = $activeIcon;
	}

}