Issues in CannedResultArray.php - All Issues - Inspection of "Merge pull request #24 from SemanticMediaWiki/repl..." - SemanticMediaWiki/SemanticExternalQueryLookup - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3e30e6...aad109 )

by mw

created 2016-01-04 02:20 UTC

src/ByAskApiHttpRequest/CannedResultArray.php (3 issues)

Labels

Severity

Informational 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace SEQL\ByAskApiHttpRequest;

use SMW\DataValueFactory;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMW\Query\PrintRequest;
use SMWDataValue as DataValue;
use SMWResultArray as ResultArray;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class CannedResultArray extends ResultArray {

	/**
	 * @var PrintRequest
	 */
	private $mPrintRequest;


	/**
	 * @var DIWikiPage
	 */
	private $mResult;


	/**
	 * @var JsonResponseParser
	 */
	private $jsonResponseParser;

	/**
	 * @var DataValue[]|false
	 */
	private $mContent;


	/**
	 * @since 1.0
	 *
	 * @param DIWikiPage $resultPage
	 * @param PrintRequest $printRequest
	 * @param JsonResponseParser $jsonResponseParser
	 */
	public function __construct( DIWikiPage $resultPage, PrintRequest $printRequest, JsonResponseParser $jsonResponseParser ) {
		$this->mResult = $resultPage;
		$this->mPrintRequest = $printRequest;
		$this->jsonResponseParser = $jsonResponseParser;
		$this->mContent = false;
	}

	/**
	 * @see ResultArray::getResultSubject
	 *
	 * @return DIWikiPage
	 */
	public function getResultSubject() {
		return $this->mResult;
	}

	/**
	 * @see ResultArray::getContent
	 *
	 * @return SMWDataItem[]|false
	 */
	public function getContent() {
		$this->loadContent();

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

		$content = array();

		foreach ( $this->mContent as $value ) {
			$content[] = $value instanceof DataValue ? $value->getDataItem() : $value;
		}

		return $content;
	}

	/**
	 * @see ResultArray::getPrintRequest
	 *
	 * @return PrintRequest
	 */
	public function getPrintRequest() {
		return $this->mPrintRequest;
	}

	/**
	 * @see ResultArray::getNextDataItem
	 *
	 * @since 1.6
	 *
	 * @return SMWDataItem|false
	 */
	public function getNextDataItem() {

		$this->loadContent();
		$result = current( $this->mContent );
		next( $this->mContent );

		return $result instanceof DataValue ? $result->getDataItem() : $result;
	}

	/**
	 * @see ResultArray::reset
	 *
	 * @since 1.7.1
	 *
	 * @return SMWDataItem|false
	 */
	public function reset() {

		$this->loadContent();
		$result = reset( $this->mContent );

		return $result instanceof DataValue ? $result->getDataItem() : $result;
	}

	/**
	 * @see ResultArray::getNextDataValue
	 *
	 * @since 1.6
	 *
	 * @return SMWDataValue|false
	 */
	public function getNextDataValue() {

		$this->loadContent();
		$content = current( $this->mContent );
		next( $this->mContent );

		if ( $content === false ) {
			return false;
		}

		$property = $this->getMatchablePropertyFromPrintRequest();

		// Units of measurement can not be assumed to be declared on a wiki
		// therefore don't try to recreate a DataValue and use the DV created
		// from the raw API response
		if ( $this->mPrintRequest->getMode() === PrintRequest::PRINT_PROP &&
		    $property->findPropertyTypeId() === '_qty' ) {
			return $content;
		}

		if ( $this->mPrintRequest->getMode() === PrintRequest::PRINT_PROP &&
		    strpos( $property->findPropertyTypeId(), '_rec' ) !== false ) {

			if ( $this->mPrintRequest->getParameter( 'index' ) === false ) {
				return $content;
			}

			$pos = $this->mPrintRequest->getParameter( 'index' ) - 1;
			$dataItems = $content->getDataItems();

			if ( !array_key_exists( $pos, $dataItems ) ) {
				return $content;
			}

			$diProperties = $content->getPropertyDataItems();
			$content = $dataItems[$pos];

			if ( array_key_exists( $pos, $diProperties ) &&
				!is_null( $diProperties[$pos] ) ) {
				$diProperty = $diProperties[$pos];
			} else {
				$diProperty = null;
			}

		} elseif ( $this->mPrintRequest->getMode() == PrintRequest::PRINT_PROP ) {
			$diProperty = $property;
		} else {
			$diProperty = null;
		}

		if ( $content instanceof DataValue ) {
			$content = $content->getDataItem();
		}

		$dataValue = DataValueFactory::getInstance()->newDataItemValue( $content, $diProperty );

		if ( $this->mPrintRequest->getOutputFormat() ) {
			$dataValue->setOutputFormat( $this->mPrintRequest->getOutputFormat() );
		}

		return $dataValue;
	}

	/**
	 * Load results of the given print request and result subject. This is only
	 * done when needed.
	 */
	protected function loadContent() {
		if ( $this->mContent !== false ) {
			return;
		}

		$this->mContent = array();

		switch ( $this->mPrintRequest->getMode() ) {
			case PrintRequest::PRINT_THIS:
				$this->mContent = array( $this->mResult );
			break;
			case PrintRequest::PRINT_CCAT:
			case PrintRequest::PRINT_CATS:

				$this->mContent = $this->jsonResponseParser->getPropertyValuesFor(
					$this->mResult,
					new DIProperty( '_INST' )
				);

			break;
			case PrintRequest::PRINT_PROP:
				$propertyValue = $this->mPrintRequest->getData();

				if ( $propertyValue->isValid() ) {
					$this->mContent = $this->jsonResponseParser->getPropertyValuesFor(
						$this->mResult,
						$this->getMatchablePropertyFromPrintRequest()
					);
				}

			break;
			default:
				$this->mContent = array(); // Unknown print request.
		}

		reset( $this->mContent );
	}

	private function getMatchablePropertyFromPrintRequest() {

		if ( $this->mPrintRequest->getMode() !== PrintRequest::PRINT_PROP ) {
			return null;
		}

		$property = $this->mPrintRequest->getData()->getDataItem();

		// The API may not deploy the natural property key (until 0.8+) hence something
		// like |?Has population=Population (in K) does not return a valid result from
		// the parser because "Has population" cannot be connected to "Population (in K)"
		// without the extra "key" field therefore construct a new property to match the
		// label
		if ( $this->mPrintRequest->getLabel() !== '' && $this->mPrintRequest->getLabel() !== $property->getLabel() ) {
			return $this->jsonResponseParser->findPropertyFromInMemoryExternalRepositoryCache(
				DIProperty::newFromUserLabel( $this->mPrintRequest->getLabel() )
			);
		}

		return $this->jsonResponseParser->findPropertyFromInMemoryExternalRepositoryCache(
			$property
		);
	}

}


1		<?php
2
3		namespace SEQL\ByAskApiHttpRequest;
4
5		use SMW\DataValueFactory;
6		use SMW\DIProperty;
7		use SMW\DIWikiPage;
8		use SMW\Query\PrintRequest;
9		use SMWDataValue as DataValue;
10		use SMWResultArray as ResultArray;
11
12		/**
13		* @license GNU GPL v2+
14		* @since 1.0
15		*
16		* @author mwjames
17		*/
18		class CannedResultArray extends ResultArray {
19
20		/**
21		* @var PrintRequest
22		*/
23		private $mPrintRequest;
		0 ignored issues – show Comprehensibility introduced 2015-11-23 14:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider using a different property name as you override a private property of the parent class. Loading history...
24
25		/**
26		* @var DIWikiPage
27		*/
28		private $mResult;
		0 ignored issues – show Comprehensibility introduced 2015-11-23 14:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider using a different property name as you override a private property of the parent class. Loading history...
29
30		/**
31		* @var JsonResponseParser
32		*/
33		private $jsonResponseParser;
34
35		/**
36		* @var DataValue[]\|false
37		*/
38		private $mContent;
		0 ignored issues – show Comprehensibility introduced 2015-11-23 14:32 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider using a different property name as you override a private property of the parent class. Loading history...
39
40		/**
41		* @since 1.0
42		*
43		* @param DIWikiPage $resultPage
44		* @param PrintRequest $printRequest
45		* @param JsonResponseParser $jsonResponseParser
46		*/
47	6	public function __construct( DIWikiPage $resultPage, PrintRequest $printRequest, JsonResponseParser $jsonResponseParser ) {
48	6	$this->mResult = $resultPage;
49	6	$this->mPrintRequest = $printRequest;
50	6	$this->jsonResponseParser = $jsonResponseParser;
51	6	$this->mContent = false;
52	6	}
53
54		/**
55		* @see ResultArray::getResultSubject
56		*
57		* @return DIWikiPage
58		*/
59	1	public function getResultSubject() {
60	1	return $this->mResult;
61		}
62
63		/**
64		* @see ResultArray::getContent
65		*
66		* @return SMWDataItem[]\|false
67		*/
68	4	public function getContent() {
69	4	$this->loadContent();
70
71	4	if ( !$this->mContent ) {
72		return $this->mContent;
73		}
74
75	4	$content = array();
76
77	4	foreach ( $this->mContent as $value ) {
78	4	$content[] = $value instanceof DataValue ? $value->getDataItem() : $value;
79	4	}
80
81	4	return $content;
82		}
83
84		/**
85		* @see ResultArray::getPrintRequest
86		*
87		* @return PrintRequest
88		*/
89		public function getPrintRequest() {
90		return $this->mPrintRequest;
91		}
92
93		/**
94		* @see ResultArray::getNextDataItem
95		*
96		* @since 1.6
97		*
98		* @return SMWDataItem\|false
99		*/
100	4	public function getNextDataItem() {
101
102	4	$this->loadContent();
103	4	$result = current( $this->mContent );
104	4	next( $this->mContent );
105
106	4	return $result instanceof DataValue ? $result->getDataItem() : $result;
107		}
108
109		/**
110		* @see ResultArray::reset
111		*
112		* @since 1.7.1
113		*
114		* @return SMWDataItem\|false
115		*/
116	4	public function reset() {
117
118	4	$this->loadContent();
119	4	$result = reset( $this->mContent );
120
121	4	return $result instanceof DataValue ? $result->getDataItem() : $result;
122		}
123
124		/**
125		* @see ResultArray::getNextDataValue
126		*
127		* @since 1.6
128		*
129		* @return SMWDataValue\|false
130		*/
131	4	public function getNextDataValue() {
132
133	4	$this->loadContent();
134	4	$content = current( $this->mContent );
135	4	next( $this->mContent );
136
137	4	if ( $content === false ) {
138		return false;
139		}
140
141	4	$property = $this->getMatchablePropertyFromPrintRequest();
142
143		// Units of measurement can not be assumed to be declared on a wiki
144		// therefore don't try to recreate a DataValue and use the DV created
145		// from the raw API response
146	4	if ( $this->mPrintRequest->getMode() === PrintRequest::PRINT_PROP &&
147	4	$property->findPropertyTypeId() === '_qty' ) {
148	1	return $content;
149		}
150
151	3	if ( $this->mPrintRequest->getMode() === PrintRequest::PRINT_PROP &&
152	3	strpos( $property->findPropertyTypeId(), '_rec' ) !== false ) {
153
154		if ( $this->mPrintRequest->getParameter( 'index' ) === false ) {
155		return $content;
156		}
157
158		$pos = $this->mPrintRequest->getParameter( 'index' ) - 1;
159		$dataItems = $content->getDataItems();
160
161		if ( !array_key_exists( $pos, $dataItems ) ) {
162		return $content;
163		}
164
165		$diProperties = $content->getPropertyDataItems();
166		$content = $dataItems[$pos];
167
168		if ( array_key_exists( $pos, $diProperties ) &&
169		!is_null( $diProperties[$pos] ) ) {
170		$diProperty = $diProperties[$pos];
171		} else {
172		$diProperty = null;
173		}
174
175	3	} elseif ( $this->mPrintRequest->getMode() == PrintRequest::PRINT_PROP ) {
176	1	$diProperty = $property;
177	1	} else {
178	2	$diProperty = null;
179		}
180
181	3	if ( $content instanceof DataValue ) {
182	1	$content = $content->getDataItem();
183	1	}
184
185	3	$dataValue = DataValueFactory::getInstance()->newDataItemValue( $content, $diProperty );
186
187	3	if ( $this->mPrintRequest->getOutputFormat() ) {
188		$dataValue->setOutputFormat( $this->mPrintRequest->getOutputFormat() );
189		}
190
191	3	return $dataValue;
192		}
193
194		/**
195		* Load results of the given print request and result subject. This is only
196		* done when needed.
197		*/
198	4	protected function loadContent() {
199	4	if ( $this->mContent !== false ) {
200	4	return;
201		}
202
203	4	$this->mContent = array();
204
205	4	switch ( $this->mPrintRequest->getMode() ) {
206	4	case PrintRequest::PRINT_THIS:
207	1	$this->mContent = array( $this->mResult );
208	1	break;
209	3	case PrintRequest::PRINT_CCAT:
210	3	case PrintRequest::PRINT_CATS:
211
212	1	$this->mContent = $this->jsonResponseParser->getPropertyValuesFor(
213	1	$this->mResult,
214	1	new DIProperty( '_INST' )
215	1	);
216
217	1	break;
218	2	case PrintRequest::PRINT_PROP:
219	2	$propertyValue = $this->mPrintRequest->getData();
220
221	2	if ( $propertyValue->isValid() ) {
222	2	$this->mContent = $this->jsonResponseParser->getPropertyValuesFor(
223	2	$this->mResult,
224	2	$this->getMatchablePropertyFromPrintRequest()
225	2	);
226	2	}
227
228	2	break;
229		default:
230		$this->mContent = array(); // Unknown print request.
231	4	}
232
233	4	reset( $this->mContent );
234	4	}
235
236	4	private function getMatchablePropertyFromPrintRequest() {
237
238	4	if ( $this->mPrintRequest->getMode() !== PrintRequest::PRINT_PROP ) {
239	2	return null;
240		}
241
242	2	$property = $this->mPrintRequest->getData()->getDataItem();
243
244		// The API may not deploy the natural property key (until 0.8+) hence something
245		// like \|?Has population=Population (in K) does not return a valid result from
246		// the parser because "Has population" cannot be connected to "Population (in K)"
247		// without the extra "key" field therefore construct a new property to match the
248		// label
249	2	if ( $this->mPrintRequest->getLabel() !== '' && $this->mPrintRequest->getLabel() !== $property->getLabel() ) {
250	1	return $this->jsonResponseParser->findPropertyFromInMemoryExternalRepositoryCache(
251	1	DIProperty::newFromUserLabel( $this->mPrintRequest->getLabel() )
252	1	);
253		}
254
255	1	return $this->jsonResponseParser->findPropertyFromInMemoryExternalRepositoryCache(
256		$property
257	1	);
258		}
259
260		}
261

SemanticMediaWiki / SemanticExternalQueryLookup

Push — master ( 3e30e6...aad109 )

src/ByAskApiHttpRequest/CannedResultArray.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like