Issues in QueryResultFetcher.php - New Issues - Inspection of "Use QueryResult::setFromCache" - SemanticMediaWiki/SemanticExternalQueryLookup - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 86c4c5...49aca9 )

by mw

created 2016-05-12 12:32 UTC

src/ByHttpRequest/QueryResultFetcher.php (1 issue)

Labels

Bug 1

Severity

Major 1

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\ByHttpRequest;

use Onoi\HttpRequest\HttpRequestFactory;
use SEQL\QueryEncoder;
use SEQL\QueryResultFactory;
use SMWQuery as Query;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class QueryResultFetcher {

	/**
	 * @var HttpRequestFactory
	 */
	private $httpRequestFactory;

	/**
	 * @var QueryResultFactory
	 */
	private $queryResultFactory;

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

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

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

	/**
	 * @var string
	 */
	private $httpResponseCachePrefix;

	/**
	 * @var integer
	 */
	private $httpResponseCacheLifetime;

	/**
	 * @since 1.0
	 *
	 * @param HttpRequestFactory $httpRequestFactory
	 * @param QueryResultFactory $queryResultFactory
	 * @param JsonResponseParser $jsonResponseParser
	 */
	public function __construct( HttpRequestFactory $httpRequestFactory, QueryResultFactory $queryResultFactory, JsonResponseParser $jsonResponseParser ) {
		$this->httpRequestFactory = $httpRequestFactory;
		$this->queryResultFactory = $queryResultFactory;
		$this->jsonResponseParser = $jsonResponseParser;
	}

	/**
	 * @since 1.0
	 *
	 * @param string $httpRequestEndpoint
	 */
	public function setHttpRequestEndpoint( $httpRequestEndpoint ) {
		$this->httpRequestEndpoint = $httpRequestEndpoint;
	}

	/**
	 * @since 1.0
	 *
	 * @param string $repositoryTargetUrl
	 */
	public function setRepositoryTargetUrl( $repositoryTargetUrl ) {
		$this->repositoryTargetUrl = $repositoryTargetUrl;
	}

	/**
	 * @since 1.0
	 *
	 * @param string $httpResponseCachePrefix
	 */
	public function setHttpResponseCachePrefix( $httpResponseCachePrefix ) {
		$this->httpResponseCachePrefix = $httpResponseCachePrefix;
	}

	/**
	 * @since 1.0
	 *
	 * @param integer $httpResponseCacheLifetime
	 */
	public function setHttpResponseCacheLifetime( $httpResponseCacheLifetime ) {
		$this->httpResponseCacheLifetime = $httpResponseCacheLifetime;
	}

	/**
	 * @since 1.0
	 *
	 * @param Query $query
	 *
	 * @return QueryResult
	 */
	public function fetchQueryResult( Query $query ) {

		$this->doResetPrintRequestsToQuerySource( $query );

		list( $result, $isFromCache ) = $this->doMakeHttpRequestFor( $query );

		if ( $result === array() || $result === false || $result === null ) {
			return $this->queryResultFactory->newEmptyQueryResult( $query );
		}

		if ( isset( $result['error'] ) ) {
			$query->addErrors( isset( $result['error']['info'] ) ? array( $result['error']['info'] ) : $result['error']['query'] );
			return $this->queryResultFactory->newEmptyQueryResult( $query );
		}

		// Add the source from where the result was retrieved
		if ( isset( $result['query']['meta']['source'] ) ) {
			$result['query']['meta']['source'] = $query->getQuerySource();
		}

		$this->jsonResponseParser->doParse( $result );

		$queryResult = $this->queryResultFactory->newByHttpRequestQueryResult(
			$query,
			$this->jsonResponseParser
		);

		$queryResult->setFromCache( $isFromCache );


		$queryResult->setRemoteTargetUrl(
			str_replace( '$1', '',  $this->repositoryTargetUrl )
		);

		return $queryResult;
	}

	private function doResetPrintRequestsToQuerySource( $query ) {

		$querySource = $query->getQuerySource();

		foreach ( $query->getExtraPrintouts() as $printRequest ) {

			if ( $printRequest->getData() === null ) {
				continue;
			}

			$property = $printRequest->getData()->getDataItem();
			$property->setInterwiki( $querySource );

			$printRequest->getData()->setDataItem( $property );

			// Reset label after dataItem was re-added
			$printRequest->setLabel( $printRequest->getLabel() );
		}
	}

	private function doMakeHttpRequestFor( $query ) {

		$httpRequest = $this->httpRequestFactory->newCachedCurlRequest();

		$httpRequest->setOption( ONOI_HTTP_REQUEST_RESPONSECACHE_TTL, $this->httpResponseCacheLifetime );
		$httpRequest->setOption( ONOI_HTTP_REQUEST_RESPONSECACHE_PREFIX, $this->httpResponseCachePrefix . ':seql:' );

		$httpRequest->setOption( CURLOPT_FOLLOWLOCATION, true );

		$httpRequest->setOption( CURLOPT_RETURNTRANSFER, true );
		$httpRequest->setOption( CURLOPT_FAILONERROR, true );
		$httpRequest->setOption( CURLOPT_SSL_VERIFYPEER, false );

		$httpRequest->setOption( CURLOPT_URL, $this->httpRequestEndpoint . '?action=ask&format=json&query=' . QueryEncoder::rawUrlEncode( $query ) );

		$httpRequest->setOption( CURLOPT_HTTPHEADER, array(
			'Accept: application/json',
			'Content-Type: application/json; charset=utf-8'
		) );

		$response = $httpRequest->execute();

		return array( json_decode( $response, true ), $httpRequest->isFromCache() );
	}

}


1		<?php
2
3		namespace SEQL\ByHttpRequest;
4
5		use Onoi\HttpRequest\HttpRequestFactory;
6		use SEQL\QueryEncoder;
7		use SEQL\QueryResultFactory;
8		use SMWQuery as Query;
9
10		/**
11		* @license GNU GPL v2+
12		* @since 1.0
13		*
14		* @author mwjames
15		*/
16		class QueryResultFetcher {
17
18		/**
19		* @var HttpRequestFactory
20		*/
21		private $httpRequestFactory;
22
23		/**
24		* @var QueryResultFactory
25		*/
26		private $queryResultFactory;
27
28		/**
29		* @var JsonResponseParser
30		*/
31		private $jsonResponseParser;
32
33		/**
34		* @var string
35		*/
36		private $httpRequestEndpoint = '';
37
38		/**
39		* @var string
40		*/
41		private $repositoryTargetUrl = '';
42
43		/**
44		* @var string
45		*/
46		private $httpResponseCachePrefix;
47
48		/**
49		* @var integer
50		*/
51		private $httpResponseCacheLifetime;
52
53		/**
54		* @since 1.0
55		*
56		* @param HttpRequestFactory $httpRequestFactory
57		* @param QueryResultFactory $queryResultFactory
58		* @param JsonResponseParser $jsonResponseParser
59		*/
60	6	public function __construct( HttpRequestFactory $httpRequestFactory, QueryResultFactory $queryResultFactory, JsonResponseParser $jsonResponseParser ) {
61	6	$this->httpRequestFactory = $httpRequestFactory;
62	6	$this->queryResultFactory = $queryResultFactory;
63	6	$this->jsonResponseParser = $jsonResponseParser;
64	6	}
65
66		/**
67		* @since 1.0
68		*
69		* @param string $httpRequestEndpoint
70		*/
71	2	public function setHttpRequestEndpoint( $httpRequestEndpoint ) {
72	2	$this->httpRequestEndpoint = $httpRequestEndpoint;
73	2	}
74
75		/**
76		* @since 1.0
77		*
78		* @param string $repositoryTargetUrl
79		*/
80	2	public function setRepositoryTargetUrl( $repositoryTargetUrl ) {
81	2	$this->repositoryTargetUrl = $repositoryTargetUrl;
82	2	}
83
84		/**
85		* @since 1.0
86		*
87		* @param string $httpResponseCachePrefix
88		*/
89	1	public function setHttpResponseCachePrefix( $httpResponseCachePrefix ) {
90	1	$this->httpResponseCachePrefix = $httpResponseCachePrefix;
91	1	}
92
93		/**
94		* @since 1.0
95		*
96		* @param integer $httpResponseCacheLifetime
97		*/
98	1	public function setHttpResponseCacheLifetime( $httpResponseCacheLifetime ) {
99	1	$this->httpResponseCacheLifetime = $httpResponseCacheLifetime;
100	1	}
101
102		/**
103		* @since 1.0
104		*
105		* @param Query $query
106		*
107		* @return QueryResult
108		*/
109	5	public function fetchQueryResult( Query $query ) {
110
111	5	$this->doResetPrintRequestsToQuerySource( $query );
112
113	5	list( $result, $isFromCache ) = $this->doMakeHttpRequestFor( $query );
114
115	5	if ( $result === array() \|\| $result === false \|\| $result === null ) {
116	3	return $this->queryResultFactory->newEmptyQueryResult( $query );
117		}
118
119	2	if ( isset( $result['error'] ) ) {
120	1	$query->addErrors( isset( $result['error']['info'] ) ? array( $result['error']['info'] ) : $result['error']['query'] );
121	1	return $this->queryResultFactory->newEmptyQueryResult( $query );
122		}
123
124		// Add the source from where the result was retrieved
125	1	if ( isset( $result['query']['meta']['source'] ) ) {
126		$result['query']['meta']['source'] = $query->getQuerySource();
127		}
128
129	1	$this->jsonResponseParser->doParse( $result );
130
131	1	$queryResult = $this->queryResultFactory->newByHttpRequestQueryResult(
132	1	$query,
133	1	$this->jsonResponseParser
134	1	);
135
136	1	$queryResult->setFromCache( $isFromCache );
		0 ignored issues – show Bug introduced 2016-05-12 12:50 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `setFromCache()` does not seem to exist on `object<SEQL\ByHttpRequest\QueryResult>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
137	1
138	1	$queryResult->setRemoteTargetUrl(
139		str_replace( '$1', '', $this->repositoryTargetUrl )
140	1	);
141
142		return $queryResult;
143	5	}
144
145	5	private function doResetPrintRequestsToQuerySource( $query ) {
146
147	5	$querySource = $query->getQuerySource();
148
149	5	foreach ( $query->getExtraPrintouts() as $printRequest ) {
150	4
151		if ( $printRequest->getData() === null ) {
152		continue;
153	1	}
154	1
155		$property = $printRequest->getData()->getDataItem();
156	1	$property->setInterwiki( $querySource );
157
158		$printRequest->getData()->setDataItem( $property );
159	1
160	5	// Reset label after dataItem was re-added
161	5	$printRequest->setLabel( $printRequest->getLabel() );
162		}
163	5	}
164
165	5	private function doMakeHttpRequestFor( $query ) {
166
167	5	$httpRequest = $this->httpRequestFactory->newCachedCurlRequest();
168	5
169		$httpRequest->setOption( ONOI_HTTP_REQUEST_RESPONSECACHE_TTL, $this->httpResponseCacheLifetime );
170	5	$httpRequest->setOption( ONOI_HTTP_REQUEST_RESPONSECACHE_PREFIX, $this->httpResponseCachePrefix . ':seql:' );
171
172	5	$httpRequest->setOption( CURLOPT_FOLLOWLOCATION, true );
173	5
174	5	$httpRequest->setOption( CURLOPT_RETURNTRANSFER, true );
175		$httpRequest->setOption( CURLOPT_FAILONERROR, true );
176	5	$httpRequest->setOption( CURLOPT_SSL_VERIFYPEER, false );
177
178	5	$httpRequest->setOption( CURLOPT_URL, $this->httpRequestEndpoint . '?action=ask&format=json&query=' . QueryEncoder::rawUrlEncode( $query ) );
179	5
180		$httpRequest->setOption( CURLOPT_HTTPHEADER, array(
181	5	'Accept: application/json',
182		'Content-Type: application/json; charset=utf-8'
183	5	) );
184
185	5	$response = $httpRequest->execute();
186
187		return array( json_decode( $response, true ), $httpRequest->isFromCache() );
188		}
189
190		}
191

SemanticMediaWiki / SemanticExternalQueryLookup

Push — master ( 86c4c5...49aca9 )

src/ByHttpRequest/QueryResultFetcher.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like