SMW\Scribunto\LuaAskResultProcessor

Complexity

Total Complexity

18

Size/Duplication

Total Lines	193
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getKeyFromPrintRequest()	0	8	2
A	extractLuaDataFromDVData()	0	15	3
A	getNumericIndex()	0	3	1
A	getProcessedResult()	0	15	3
A	getDataFromQueryResultRow()	0	14	2
A	getDataFromResultArray()	0	18	2
A	getValueFromDataValue()	0	20	4

<?php

namespace SMW\Scribunto;

use SMWQueryResult as QueryResult;
use SMWResultArray as ResultArray;
use SMWDataValue as DataValue;
use SMW\Query\PrintRequest;

/**
 * Class LuaAskResultProcessor
 *
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author Tobias Oetterer
 *
 * @package SMW\Scribunto
 */
class LuaAskResultProcessor {

	/**
	 * Holds all possible representations of "true" in this smw instance
	 *
	 * @var array
	 */
	private $msgTrue;

	/**
	 * This counter serves as fallback, if no label for printout is specified
	 *
	 * @var int
	 */
	private $numericIndex;

	/**
	 * Holds the query result for this object
	 *
	 * @var QueryResult
	 */
	private $queryResult;

	/**
	 * LuaAskResultProcessor constructor.
	 *
	 * @param QueryResult $queryResult
	 */
	public function __construct( QueryResult $queryResult ) {
		$this->queryResult = $queryResult;
		$this->msgTrue = explode( ',', wfMessage( 'smw_true_words' )->text() . ',true,t,yes,y' );
		$this->numericIndex = 1;
	}

	/**
	 * Extracts the data in {@see $queryResult} and returns it as a table
	 * usable in lua context
	 *
	 * @uses getDataFromQueryResultRow
	 *
	 * @return array|null
	 */
	public function getProcessedResult() {

		$result = null;

		if ( $this->queryResult->getCount() ) {

			$result = [];

			while ( $resultRow = $this->queryResult->getNext() ) {
				$result[] = $this->getDataFromQueryResultRow( $resultRow );
			}
		}

		return $result;
	}

	/**
	 * Extracts the data of a single result row in the {@see $queryResult}
	 * and returns it as a table usable in lua context
	 *
	 * @param array $resultRow result row as an array of {@see ResultArray} objects
	 *
	 * @uses getDataFromResultArray
	 *
	 * @return array
	 */
	public function getDataFromQueryResultRow( array $resultRow ) {

		$rowData = [];

		/** @var ResultArray $resultArray */
		foreach ( $resultRow as $resultArray ) {

			// get key and data
			list ( $key, $data ) = $this->getDataFromResultArray( $resultArray );

			$rowData[$key] = $data;
		}
		return $rowData;
	}

	/**
	 * Extracts the data of a single printRequest / query field
	 *
	 * @param ResultArray $resultArray
	 *
	 * @uses getKeyFromPrintRequest, getValueFromDataValue, extractLuaDataFromDVData
	 *
	 * @return array array ( int|string, array )
	 */
	public function getDataFromResultArray( ResultArray $resultArray ) {

		// first, extract the key (label), if any
		$key = $this->getKeyFromPrintRequest( $resultArray->getPrintRequest() );

		$resultArrayData = [];

		// then get all data that is stored in this printRequest / query field
		/** @var DataValue $dataValue */
		while ( ( $dataValue = $resultArray->getNextDataValue() ) !== false ) {

			$resultArrayData[] = $this->getValueFromDataValue( $dataValue );
		}

		$resultArrayData = $this->extractLuaDataFromDVData( $resultArrayData );

		return [ $key, $resultArrayData ];
	}

	/**
	 * Takes an smw query print request and tries to retrieve the label
	 * falls back to {@see getNumericIndex} if none was found
	 *
	 * @param PrintRequest $printRequest
	 *
	 * @uses getNumericIndex
	 *
	 * @return int|string
	 */
	public function getKeyFromPrintRequest( PrintRequest $printRequest ) {

		if ( $printRequest->getLabel() !== '' ) {
			return $printRequest->getText( SMW_OUTPUT_WIKI );
		}

		return $this->getNumericIndex();
	}

	/**
	 * Extracts the data of a single value of the current printRequest / query field
	 * The value is formatted according to the type of the property
	 *
	 * @param DataValue $dataValue
	 *
	 * @return mixed
	 */
	public function getValueFromDataValue( DataValue $dataValue ) {

		switch ( $dataValue->getTypeID() ) {
			case '_boo':
				// boolean value found, convert it
				$value = in_array( strtolower( $dataValue->getWikiValue() ), $this->msgTrue );
				break;
			case '_num':
				// number value found
				/** @var \SMWNumberValue $dataValue */
				$value = $dataValue->getNumber();
				$value = ( $value == (int)$value ) ? intval( $value ) : $value;
				break;
			default:
				# FIXME ignores parameter link=none|subject
				$value = $dataValue->getShortText( SMW_OUTPUT_WIKI, new \Linker() );
		}

		return $value;
	}

	/**
	 * Takes an array of data fields and returns either null, a single value or a lua table.
	 *
	 * @param array $resultArrayData
	 *
	 * @return mixed
	 */
	public function extractLuaDataFromDVData( $resultArrayData ) {

		if ( empty( $resultArrayData ) ) {
			// this key has no value(s). set to null
			return null;
		} elseif ( count( $resultArrayData ) == 1 ) {
			// there was only one semantic value found. reduce the array to this value
			return array_shift( $resultArrayData );
		} else {
			// $key has multiple values. keep the array
			// Note: we do not un-shift it (remember: lua array counting starts with 1), but we defer
			// conversion into a lua table to a later step
			return $resultArrayData;
		}
	}

	/**
	 * Returns current numeric index (and increases it afterwards)
	 *
	 * @uses $numericIndex
	 *
	 * @return int
	 */
	public function getNumericIndex() {
		return $this->numericIndex++;
	}
}