1 files changed, 214 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/ApiQueryResultFormatter.php b/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/ApiQueryResultFormatter.php
new file mode 100644
index 00000000..684499a3
--- /dev/null
+++ b/www/wiki/extensions/SemanticMediaWiki/src/MediaWiki/Api/ApiQueryResultFormatter.php
@@ -0,0 +1,214 @@
+<?php
+
+namespace SMW\MediaWiki\Api;
+
+use InvalidArgumentException;
+use SMW\ProcessingErrorMsgHandler;
+use SMWQueryResult;
+
+/**
+ * This class handles the Api related query result formatting
+ *
+ * @ingroup SMW
+ *
+ * @license GNU GPL v2+
+ * @since 1.9
+ *
+ * @author mwjames
+ */
+class ApiQueryResultFormatter {
+
+	/**
+	 * @var Integer|boolean
+	 */
+	protected $continueOffset = false;
+
+	/**
+	 * @var String
+	 */
+	protected $type;
+
+	/**
+	 * @var Boolean
+	 */
+	protected $isRawMode = false;
+
+	/**
+	 * @since 1.9
+	 *
+	 * @param SMWQueryResult $queryResult
+	 */
+	public function __construct( SMWQueryResult $queryResult ) {
+		$this->queryResult = $queryResult;
+	}
+
+	/**
+	 * Sets whether the formatter requested raw data and is used in connection
+	 * with ApiQueryResultFormatter::setIndexedTagName
+	 *
+	 * @see ApiResult::getIsRawMode
+	 *
+	 * @since 1.9
+	 *
+	 * @param boolean $isRawMode
+	 */
+	public function setIsRawMode( $isRawMode ) {
+		$this->isRawMode = $isRawMode;
+	}
+
+	/**
+	 * Returns an offset used for continuation support
+	 *
+	 * @since 1.9
+	 *
+	 * @return integer
+	 */
+	public function getContinueOffset() {
+		return $this->continueOffset;
+	}
+
+	/**
+	 * Returns the result type
+	 *
+	 * @since 1.9
+	 *
+	 * @return string
+	 */
+	public function getType() {
+		return $this->type;
+	}
+
+	/**
+	 * Returns formatted result
+	 *
+	 * @since 1.9
+	 *
+	 * @return array
+	 */
+	public function getResult() {
+		return $this->result;
+	}
+
+	/**
+	 * Result formatting
+	 *
+	 * @since 1.9
+	 */
+	public function doFormat() {
+
+		if ( $this->queryResult->getErrors() !== [] ) {
+			$this->result = $this->formatErrors(
+				ProcessingErrorMsgHandler::normalizeAndDecodeMessages( $this->queryResult->getErrors() )
+			);
+		} else {
+			$this->result = $this->formatResults( $this->queryResult->toArray() );
+
+			if ( $this->queryResult->hasFurtherResults() ) {
+				$this->continueOffset = $this->result['meta']['count'] + $this->result['meta']['offset'];
+			}
+		}
+	}
+
+	/**
+	 * Formatting a result array to support JSON/XML standards
+	 *
+	 * @since 1.9
+	 *
+	 * @param array $queryResult
+	 *
+	 * @return array
+	 */
+	protected function formatResults( array $queryResult ) {
+
+		$this->type = 'query';
+		$results    = [];
+
+		if ( !$this->isRawMode ) {
+			return $queryResult;
+		}
+
+		foreach ( $queryResult['results'] as $subjectName => $subject ) {
+			$serialized = [];
+
+			foreach ( $subject as $key => $value ) {
+
+				if ( $key === 'printouts' ) {
+					$printouts = [];
+
+					foreach ( $subject['printouts'] as $property => $values ) {
+
+						if ( (array)$values === $values ) {
+							$this->setIndexedTagName( $values, 'value' );
+							$printouts[] = array_merge( [ 'label' => $property ], $values );
+						}
+
+					}
+
+					$serialized['printouts'] = $printouts;
+					$this->setIndexedTagName( $serialized['printouts'], 'property' );
+
+				} else {
+					$serialized[$key] = $value;
+				}
+			}
+
+			$results[] = $serialized;
+		}
+
+		if ( $results !== [] ) {
+			$queryResult['results'] = $results;
+			$this->setIndexedTagName( $queryResult['results'], 'subject' );
+		}
+
+		$this->setIndexedTagName( $queryResult['printrequests'], 'printrequest' );
+		$this->setIndexedTagName( $queryResult['meta'], 'meta' );
+
+		return $queryResult;
+	}
+
+	/**
+	 * Formatting an error array in order to support JSON/XML
+	 *
+	 * @since 1.9
+	 *
+	 * @param array $errors
+	 *
+	 * @return array
+	 */
+	protected function formatErrors( array $errors ) {
+
+		$this->type      = 'error';
+		$result['query'] = $errors;
+
+		$this->setIndexedTagName( $result['query'], 'info' );
+
+		return $result;
+	}
+
+	/**
+	 * Add '_element' to an array
+	 *
+	 * @note Copied from ApiResult::setIndexedTagName to avoid having a
+	 * constructor injection in order to be able to access this method
+	 *
+	 * @see ApiResult::setIndexedTagName
+	 *
+	 * @since 1.9
+	 *
+	 * @param array &$arr
+	 * @param string $tag
+	 */
+	public function setIndexedTagName( &$arr, $tag = null ) {
+
+		if ( !$this->isRawMode ) {
+			return;
+		}
+
+		if ( $arr === null || $tag === null || !is_array( $arr ) || is_array( $tag ) ) {
+			throw new InvalidArgumentException( "{$tag} was incompatible with the requirements" );
+		}
+
+		$arr['_element'] = $tag;
+	}
+
+}