wikimedia / mediawiki-extensions-WikibaseQualityConstraints

src/ConstraintCheck/Helper/SparqlHelper.php

Spacing +136 added lines, -138 removed lines

@@ -120,18 +120,18 @@ 
 		$this->dataFactory = $dataFactory;
 		$this->defaultUserAgent = $defaultUserAgent;
 		$this->requestFactory = $requestFactory;
-		$this->entityPrefix = $rdfVocabulary->getNamespaceURI( RdfVocabulary::NS_ENTITY );
+		$this->entityPrefix = $rdfVocabulary->getNamespaceURI(RdfVocabulary::NS_ENTITY);
 		$this->prefixes = <<<EOT
-PREFIX wd: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NS_ENTITY )}>
-PREFIX wds: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NS_STATEMENT )}>
-PREFIX wdt: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_DIRECT_CLAIM )}>
-PREFIX wdv: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NS_VALUE )}>
-PREFIX p: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_CLAIM )}>
-PREFIX ps: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_CLAIM_STATEMENT )}>
-PREFIX pq: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_QUALIFIER )}>
-PREFIX pqv: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_QUALIFIER_VALUE )}>
-PREFIX pr: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_REFERENCE )}>
-PREFIX prv: <{$rdfVocabulary->getNamespaceURI( RdfVocabulary::NSP_REFERENCE_VALUE )}>
+PREFIX wd: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NS_ENTITY)}>
+PREFIX wds: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NS_STATEMENT)}>
+PREFIX wdt: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_DIRECT_CLAIM)}>
+PREFIX wdv: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NS_VALUE)}>
+PREFIX p: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_CLAIM)}>
+PREFIX ps: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_CLAIM_STATEMENT)}>
+PREFIX pq: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_QUALIFIER)}>
+PREFIX pqv: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_QUALIFIER_VALUE)}>
+PREFIX pr: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_REFERENCE)}>
+PREFIX prv: <{$rdfVocabulary->getNamespaceURI(RdfVocabulary::NSP_REFERENCE_VALUE)}>
 PREFIX wikibase: <http://wikiba.se/ontology#>
 PREFIX wikibase-beta: <http://wikiba.se/ontology-beta#>
 EOT;
@@ -146,21 +146,21 @@ 
 	 * @return CachedBool
 	 * @throws SparqlHelperException if the query times out or some other error occurs
 	 */
-	public function hasType( $id, array $classes, $withInstance ) {
-		$instanceOfId = $this->config->get( 'WBQualityConstraintsInstanceOfId' );
-		$subclassOfId = $this->config->get( 'WBQualityConstraintsSubclassOfId' );
+	public function hasType($id, array $classes, $withInstance) {
+		$instanceOfId = $this->config->get('WBQualityConstraintsInstanceOfId');
+		$subclassOfId = $this->config->get('WBQualityConstraintsSubclassOfId');
 
-		$path = ( $withInstance ? "wdt:$instanceOfId/" : "" ) . "wdt:$subclassOfId*";
+		$path = ($withInstance ? "wdt:$instanceOfId/" : "")."wdt:$subclassOfId*";
 
 		$metadatas = [];
 
-		foreach ( array_chunk( $classes, 20 ) as $classesChunk ) {
-			$classesValues = implode( ' ', array_map(
-				function( $class ) {
-					return 'wd:' . $class;
+		foreach (array_chunk($classes, 20) as $classesChunk) {
+			$classesValues = implode(' ', array_map(
+				function($class) {
+					return 'wd:'.$class;
 				},
 				$classesChunk
-			) );
+			));
 
 			$query = <<<EOF
 ASK {
@@ -171,19 +171,19 @@ 
 EOF;
 			// TODO hint:gearing is a workaround for T168973 and can hopefully be removed eventually
 
-			$result = $this->runQuery( $query );
+			$result = $this->runQuery($query);
 			$metadatas[] = $result->getMetadata();
-			if ( $result->getArray()['boolean'] ) {
+			if ($result->getArray()['boolean']) {
 				return new CachedBool(
 					true,
-					Metadata::merge( $metadatas )
+					Metadata::merge($metadatas)
 				);
 			}
 		}
 
 		return new CachedBool(
 			false,
-			Metadata::merge( $metadatas )
+			Metadata::merge($metadatas)
 		);
 	}
 
@@ -199,10 +199,10 @@ 
 		$ignoreDeprecatedStatements
 	) {
 		$pid = $statement->getPropertyId()->serialize();
-		$guid = str_replace( '$', '-', $statement->getGuid() );
+		$guid = str_replace('$', '-', $statement->getGuid());
 
 		$deprecatedFilter = '';
-		if ( $ignoreDeprecatedStatements ) {
+		if ($ignoreDeprecatedStatements) {
 			$deprecatedFilter .= 'MINUS { ?otherStatement wikibase:rank wikibase:DeprecatedRank. }';
 			$deprecatedFilter .= 'MINUS { ?otherStatement wikibase-beta:rank wikibase-beta:DeprecatedRank. }';
 		}
@@ -222,9 +222,9 @@ 
 LIMIT 10
 EOF;
 
-		$result = $this->runQuery( $query );
+		$result = $this->runQuery($query);
 
-		return $this->getOtherEntities( $result );
+		return $this->getOtherEntities($result);
 	}
 
 	/**
@@ -249,16 +249,15 @@ 
 		$dataType = $this->propertyDataTypeLookup->getDataTypeIdForProperty(
 			$snak->getPropertyId()
 		);
-		list( $value, $isFullValue ) = $this->getRdfLiteral( $dataType, $dataValue );
-		if ( $isFullValue ) {
+		list($value, $isFullValue) = $this->getRdfLiteral($dataType, $dataValue);
+		if ($isFullValue) {
 			$prefix .= 'v';
 		}
 		$path = $type === Context::TYPE_QUALIFIER ?
-			"$prefix:$pid" :
-			"prov:wasDerivedFrom/$prefix:$pid";
+			"$prefix:$pid" : "prov:wasDerivedFrom/$prefix:$pid";
 
 		$deprecatedFilter = '';
-		if ( $ignoreDeprecatedStatements ) {
+		if ($ignoreDeprecatedStatements) {
 			$deprecatedFilter = <<< EOF
   MINUS { ?otherStatement wikibase:rank wikibase:DeprecatedRank. }
   MINUS { ?otherStatement wikibase-beta:rank wikibase-beta:DeprecatedRank. }
@@ -279,9 +278,9 @@ 
 LIMIT 10
 EOF;
 
-		$result = $this->runQuery( $query );
+		$result = $this->runQuery($query);
 
-		return $this->getOtherEntities( $result );
+		return $this->getOtherEntities($result);
 	}
 
 	/**
@@ -291,8 +290,8 @@ 
 	 *
 	 * @return string
 	 */
-	private function stringLiteral( $text ) {
-		return '"' . strtr( $text, [ '"' => '\\"', '\\' => '\\\\' ] ) . '"';
+	private function stringLiteral($text) {
+		return '"'.strtr($text, ['"' => '\\"', '\\' => '\\\\']).'"';
 	}
 
 	/**
@@ -302,17 +301,17 @@ 
 	 *
 	 * @return CachedEntityIds
 	 */
-	private function getOtherEntities( CachedQueryResults $results ) {
-		return new CachedEntityIds( array_map(
-			function ( $resultBindings ) {
+	private function getOtherEntities(CachedQueryResults $results) {
+		return new CachedEntityIds(array_map(
+			function($resultBindings) {
 				$entityIRI = $resultBindings['otherEntity']['value'];
-				$entityPrefixLength = strlen( $this->entityPrefix );
-				if ( substr( $entityIRI, 0, $entityPrefixLength ) === $this->entityPrefix ) {
+				$entityPrefixLength = strlen($this->entityPrefix);
+				if (substr($entityIRI, 0, $entityPrefixLength) === $this->entityPrefix) {
 					try {
 						return $this->entityIdParser->parse(
-							substr( $entityIRI, $entityPrefixLength )
+							substr($entityIRI, $entityPrefixLength)
 						);
-					} catch ( EntityIdParsingException $e ) {
+					} catch (EntityIdParsingException $e) {
 						// fall through
 					}
 				}
@@ -320,7 +319,7 @@ 
 				return null;
 			},
 			$results->getArray()['results']['bindings']
-		), $results->getMetadata() );
+		), $results->getMetadata());
 	}
 
 	// @codingStandardsIgnoreStart cyclomatic complexity of this function is too high
@@ -333,47 +332,47 @@ 
 	 * @return array the literal or IRI as a string in SPARQL syntax,
 	 * and a boolean indicating whether it refers to a full value node or not
 	 */
-	private function getRdfLiteral( $dataType, DataValue $dataValue ) {
-		switch ( $dataType ) {
+	private function getRdfLiteral($dataType, DataValue $dataValue) {
+		switch ($dataType) {
 			case 'string':
 			case 'external-id':
-				return [ $this->stringLiteral( $dataValue->getValue() ), false ];
+				return [$this->stringLiteral($dataValue->getValue()), false];
 			case 'commonsMedia':
-				$url = $this->rdfVocabulary->getMediaFileURI( $dataValue->getValue() );
-				return [ '<' . $url . '>', false ];
+				$url = $this->rdfVocabulary->getMediaFileURI($dataValue->getValue());
+				return ['<'.$url.'>', false];
 			case 'geo-shape':
-				$url = $this->rdfVocabulary->getGeoShapeURI( $dataValue->getValue() );
-				return [ '<' . $url . '>', false ];
+				$url = $this->rdfVocabulary->getGeoShapeURI($dataValue->getValue());
+				return ['<'.$url.'>', false];
 			case 'tabular-data':
-				$url = $this->rdfVocabulary->getTabularDataURI( $dataValue->getValue() );
-				return [ '<' . $url . '>', false ];
+				$url = $this->rdfVocabulary->getTabularDataURI($dataValue->getValue());
+				return ['<'.$url.'>', false];
 			case 'url':
 				$url = $dataValue->getValue();
-				if ( !preg_match( '/^[^<>"{}\\\\|^`\\x00-\\x20]*$/D', $url ) ) {
+				if (!preg_match('/^[^<>"{}\\\\|^`\\x00-\\x20]*$/D', $url)) {
 					// not a valid URL for SPARQL (see SPARQL spec, production 139 IRIREF)
 					// such an URL should never reach us, so just throw
-					throw new InvalidArgumentException( 'invalid URL: ' . $url );
+					throw new InvalidArgumentException('invalid URL: '.$url);
 				}
-				return [ '<' . $url . '>', false ];
+				return ['<'.$url.'>', false];
 			case 'wikibase-item':
 			case 'wikibase-property':
 				/** @var EntityIdValue $dataValue */
-				return [ 'wd:' . $dataValue->getEntityId()->getSerialization(), false ];
+				return ['wd:'.$dataValue->getEntityId()->getSerialization(), false];
 			case 'monolingualtext':
 				/** @var MonolingualTextValue $dataValue */
 				$lang = $dataValue->getLanguageCode();
-				if ( !preg_match( '/^[a-zA-Z]+(-[a-zA-Z0-9]+)*$/D', $lang ) ) {
+				if (!preg_match('/^[a-zA-Z]+(-[a-zA-Z0-9]+)*$/D', $lang)) {
 					// not a valid language tag for SPARQL (see SPARQL spec, production 145 LANGTAG)
 					// such a language tag should never reach us, so just throw
-					throw new InvalidArgumentException( 'invalid language tag: ' . $lang );
+					throw new InvalidArgumentException('invalid language tag: '.$lang);
 				}
-				return [ $this->stringLiteral( $dataValue->getText() ) . '@' . $lang, false ];
+				return [$this->stringLiteral($dataValue->getText()).'@'.$lang, false];
 			case 'globe-coordinate':
 			case 'quantity':
 			case 'time':
-				return [ 'wdv:' . $dataValue->getHash(), true ];
+				return ['wdv:'.$dataValue->getHash(), true];
 			default:
-				throw new InvalidArgumentException( 'unknown data type: ' . $dataType );
+				throw new InvalidArgumentException('unknown data type: '.$dataType);
 		}
 	}
 	// @codingStandardsIgnoreEnd
@@ -386,44 +385,44 @@ 
 	 * @throws SparqlHelperException if the query times out or some other error occurs
 	 * @throws ConstraintParameterException if the $regex is invalid
 	 */
-	public function matchesRegularExpression( $text, $regex ) {
+	public function matchesRegularExpression($text, $regex) {
 		// caching wrapper around matchesRegularExpressionWithSparql
 
-		$textHash = hash( 'sha256', $text );
+		$textHash = hash('sha256', $text);
 		$cacheKey = $this->cache->makeKey(
 			'WikibaseQualityConstraints', // extension
 			'regex', // action
 			'WDQS-Java', // regex flavor
-			hash( 'sha256', $regex )
+			hash('sha256', $regex)
 		);
-		$cacheMapSize = $this->config->get( 'WBQualityConstraintsFormatCacheMapSize' );
+		$cacheMapSize = $this->config->get('WBQualityConstraintsFormatCacheMapSize');
 
 		$cacheMapArray = $this->cache->getWithSetCallback(
 			$cacheKey,
 			WANObjectCache::TTL_DAY,
-			function( $cacheMapArray ) use ( $text, $regex, $textHash, $cacheMapSize ) {
+			function($cacheMapArray) use ($text, $regex, $textHash, $cacheMapSize) {
 				// Initialize the cache map if not set
-				if ( $cacheMapArray === false ) {
+				if ($cacheMapArray === false) {
 					$key = 'wikibase.quality.constraints.regex.cache.refresh.init';
-					$this->dataFactory->increment( $key );
+					$this->dataFactory->increment($key);
 					return [];
 				}
 
 				$key = 'wikibase.quality.constraints.regex.cache.refresh';
-				$this->dataFactory->increment( $key );
-				$cacheMap = MapCacheLRU::newFromArray( $cacheMapArray, $cacheMapSize );
-				if ( $cacheMap->has( $textHash ) ) {
+				$this->dataFactory->increment($key);
+				$cacheMap = MapCacheLRU::newFromArray($cacheMapArray, $cacheMapSize);
+				if ($cacheMap->has($textHash)) {
 					$key = 'wikibase.quality.constraints.regex.cache.refresh.hit';
-					$this->dataFactory->increment( $key );
-					$cacheMap->get( $textHash ); // ping cache
+					$this->dataFactory->increment($key);
+					$cacheMap->get($textHash); // ping cache
 				} else {
 					$key = 'wikibase.quality.constraints.regex.cache.refresh.miss';
-					$this->dataFactory->increment( $key );
+					$this->dataFactory->increment($key);
 					try {
-						$matches = $this->matchesRegularExpressionWithSparql( $text, $regex );
-					} catch ( ConstraintParameterException $e ) {
-						$matches = $this->serializeConstraintParameterException( $e );
-					} catch ( SparqlHelperException $e ) {
+						$matches = $this->matchesRegularExpressionWithSparql($text, $regex);
+					} catch (ConstraintParameterException $e) {
+						$matches = $this->serializeConstraintParameterException($e);
+					} catch (SparqlHelperException $e) {
 						// don’t cache this
 						return $cacheMap->toArray();
 					}
@@ -447,42 +446,42 @@ 
 			]
 		);
 
-		if ( isset( $cacheMapArray[$textHash] ) ) {
+		if (isset($cacheMapArray[$textHash])) {
 			$key = 'wikibase.quality.constraints.regex.cache.hit';
-			$this->dataFactory->increment( $key );
+			$this->dataFactory->increment($key);
 			$matches = $cacheMapArray[$textHash];
-			if ( is_bool( $matches ) ) {
+			if (is_bool($matches)) {
 				return $matches;
-			} elseif ( is_array( $matches ) &&
-				$matches['type'] == ConstraintParameterException::class ) {
-				throw $this->deserializeConstraintParameterException( $matches );
+			} elseif (is_array($matches) &&
+				$matches['type'] == ConstraintParameterException::class) {
+				throw $this->deserializeConstraintParameterException($matches);
 			} else {
 				throw new MWException(
-					'Value of unknown type in object cache (' .
-					'cache key: ' . $cacheKey . ', ' .
-					'cache map key: ' . $textHash . ', ' .
-					'value type: ' . gettype( $matches ) . ')'
+					'Value of unknown type in object cache ('.
+					'cache key: '.$cacheKey.', '.
+					'cache map key: '.$textHash.', '.
+					'value type: '.gettype($matches).')'
 				);
 			}
 		} else {
 			$key = 'wikibase.quality.constraints.regex.cache.miss';
-			$this->dataFactory->increment( $key );
-			return $this->matchesRegularExpressionWithSparql( $text, $regex );
+			$this->dataFactory->increment($key);
+			return $this->matchesRegularExpressionWithSparql($text, $regex);
 		}
 	}
 
-	private function serializeConstraintParameterException( ConstraintParameterException $cpe ) {
+	private function serializeConstraintParameterException(ConstraintParameterException $cpe) {
 		return [
 			'type' => ConstraintParameterException::class,
-			'violationMessage' => $this->violationMessageSerializer->serialize( $cpe->getViolationMessage() ),
+			'violationMessage' => $this->violationMessageSerializer->serialize($cpe->getViolationMessage()),
 		];
 	}
 
-	private function deserializeConstraintParameterException( array $serialization ) {
+	private function deserializeConstraintParameterException(array $serialization) {
 		$message = $this->violationMessageDeserializer->deserialize(
 			$serialization['violationMessage']
 		);
-		return new ConstraintParameterException( $message );
+		return new ConstraintParameterException($message);
 	}
 
 	/**
@@ -496,25 +495,25 @@ 
 	 * @throws SparqlHelperException if the query times out or some other error occurs
 	 * @throws ConstraintParameterException if the $regex is invalid
 	 */
-	public function matchesRegularExpressionWithSparql( $text, $regex ) {
-		$textStringLiteral = $this->stringLiteral( $text );
-		$regexStringLiteral = $this->stringLiteral( '^(?:' . $regex . ')$' );
+	public function matchesRegularExpressionWithSparql($text, $regex) {
+		$textStringLiteral = $this->stringLiteral($text);
+		$regexStringLiteral = $this->stringLiteral('^(?:'.$regex.')$');
 
 		$query = <<<EOF
 SELECT (REGEX($textStringLiteral, $regexStringLiteral) AS ?matches) {}
 EOF;
 
-		$result = $this->runQuery( $query, false );
+		$result = $this->runQuery($query, false);
 
 		$vars = $result->getArray()['results']['bindings'][0];
-		if ( array_key_exists( 'matches', $vars ) ) {
+		if (array_key_exists('matches', $vars)) {
 			// true or false ⇒ regex okay, text matches or not
 			return $vars['matches']['value'] === 'true';
 		} else {
 			// empty result: regex broken
 			throw new ConstraintParameterException(
-				( new ViolationMessage( 'wbqc-violation-message-parameter-regex' ) )
-					->withInlineCode( $regex, Role::CONSTRAINT_PARAMETER_VALUE )
+				(new ViolationMessage('wbqc-violation-message-parameter-regex'))
+					->withInlineCode($regex, Role::CONSTRAINT_PARAMETER_VALUE)
 			);
 		}
 	}
@@ -526,14 +525,14 @@ 
 	 *
 	 * @return boolean
 	 */
-	public function isTimeout( $responseContent ) {
-		$timeoutRegex = implode( '|', array_map(
-			function ( $fqn ) {
-				return preg_quote( $fqn, '/' );
+	public function isTimeout($responseContent) {
+		$timeoutRegex = implode('|', array_map(
+			function($fqn) {
+				return preg_quote($fqn, '/');
 			},
-			$this->config->get( 'WBQualityConstraintsSparqlTimeoutExceptionClasses' )
-		) );
-		return (bool)preg_match( '/' . $timeoutRegex . '/', $responseContent );
+			$this->config->get('WBQualityConstraintsSparqlTimeoutExceptionClasses')
+		));
+		return (bool) preg_match('/'.$timeoutRegex.'/', $responseContent);
 	}
 
 	/**
@@ -545,17 +544,17 @@ 
 	 * @return integer|boolean the max-age (in seconds)
 	 * or a plain boolean if no max-age can be determined
 	 */
-	public function getCacheMaxAge( $responseHeaders ) {
+	public function getCacheMaxAge($responseHeaders) {
 		if (
-			array_key_exists( 'x-cache-status', $responseHeaders ) &&
-			preg_match( '/^hit(?:-.*)?$/', $responseHeaders['x-cache-status'][0] )
+			array_key_exists('x-cache-status', $responseHeaders) &&
+			preg_match('/^hit(?:-.*)?$/', $responseHeaders['x-cache-status'][0])
 		) {
 			$maxage = [];
 			if (
-				array_key_exists( 'cache-control', $responseHeaders ) &&
-				preg_match( '/\bmax-age=(\d+)\b/', $responseHeaders['cache-control'][0], $maxage )
+				array_key_exists('cache-control', $responseHeaders) &&
+				preg_match('/\bmax-age=(\d+)\b/', $responseHeaders['cache-control'][0], $maxage)
 			) {
-				return intval( $maxage[1] );
+				return intval($maxage[1]);
 			} else {
 				return true;
 			}
@@ -574,65 +573,64 @@ 
 	 *
 	 * @throws SparqlHelperException if the query times out or some other error occurs
 	 */
-	public function runQuery( $query, $needsPrefixes = true ) {
-		$endpoint = $this->config->get( 'WBQualityConstraintsSparqlEndpoint' );
-		$maxQueryTimeMillis = $this->config->get( 'WBQualityConstraintsSparqlMaxMillis' );
+	public function runQuery($query, $needsPrefixes = true) {
+		$endpoint = $this->config->get('WBQualityConstraintsSparqlEndpoint');
+		$maxQueryTimeMillis = $this->config->get('WBQualityConstraintsSparqlMaxMillis');
 
-		if ( $needsPrefixes ) {
-			$query = $this->prefixes . $query;
+		if ($needsPrefixes) {
+			$query = $this->prefixes.$query;
 		}
-		$query = "#wbqc\n" . $query;
+		$query = "#wbqc\n".$query;
 
-		$url = $endpoint . '?' . http_build_query(
+		$url = $endpoint.'?'.http_build_query(
 			[
 				'query' => $query,
 				'format' => 'json',
 				'maxQueryTimeMillis' => $maxQueryTimeMillis,
 			],
-			null, ini_get( 'arg_separator.output' ),
+			null, ini_get('arg_separator.output'),
 			// encode spaces with %20, not +
 			PHP_QUERY_RFC3986
 		);
 
 		$options = [
 			'method' => 'GET',
-			'timeout' => (int)round( ( $maxQueryTimeMillis + 1000 ) / 1000 ),
+			'timeout' => (int) round(($maxQueryTimeMillis + 1000) / 1000),
 			'connectTimeout' => 'default',
 			'userAgent' => $this->defaultUserAgent,
 		];
-		$request = $this->requestFactory->create( $url, $options );
-		$startTime = microtime( true );
+		$request = $this->requestFactory->create($url, $options);
+		$startTime = microtime(true);
 		$status = $request->execute();
-		$endTime = microtime( true );
+		$endTime = microtime(true);
 		$this->dataFactory->timing(
 			'wikibase.quality.constraints.sparql.timing',
-			( $endTime - $startTime ) * 1000
+			($endTime - $startTime) * 1000
 		);
 
-		$maxAge = $this->getCacheMaxAge( $request->getResponseHeaders() );
-		if ( $maxAge ) {
-			$this->dataFactory->increment( 'wikibase.quality.constraints.sparql.cached' );
+		$maxAge = $this->getCacheMaxAge($request->getResponseHeaders());
+		if ($maxAge) {
+			$this->dataFactory->increment('wikibase.quality.constraints.sparql.cached');
 		}
 
-		if ( $status->isOK() ) {
+		if ($status->isOK()) {
 			$json = $request->getContent();
-			$arr = json_decode( $json, true );
+			$arr = json_decode($json, true);
 			return new CachedQueryResults(
 				$arr,
 				Metadata::ofCachingMetadata(
 					$maxAge ?
-						CachingMetadata::ofMaximumAgeInSeconds( $maxAge ) :
-						CachingMetadata::fresh()
+						CachingMetadata::ofMaximumAgeInSeconds($maxAge) : CachingMetadata::fresh()
 				)
 			);
 		} else {
-			$this->dataFactory->increment( 'wikibase.quality.constraints.sparql.error' );
+			$this->dataFactory->increment('wikibase.quality.constraints.sparql.error');
 
 			$this->dataFactory->increment(
 				"wikibase.quality.constraints.sparql.error.http.{$request->getStatus()}"
 			);
 
-			if ( $this->isTimeout( $request->getContent() ) ) {
+			if ($this->isTimeout($request->getContent())) {
 				$this->dataFactory->increment(
 					'wikibase.quality.constraints.sparql.error.timeout'
 				);

src/ConstraintCheck/Helper/LoggingHelper.php

Doc Comments +2 added lines

@@ -65,6 +65,7 @@ 
 	 * and return it along with the associated log level.
 	 *
 	 * @param float $durationSeconds
+	 * @param double[] $limits
 	 * @return array [ $limitSeconds, $logLevel ]
 	 */
 	private function findLimit( $limits, $durationSeconds ) {
@@ -174,6 +175,7 @@ 
 	 * @param EntityId $entityId
 	 * @param CheckResult[] $checkResults
 	 * @param float $durationSeconds
+	 * @param string $method
 	 */
 	public function logConstraintCheckOnEntity(
 		EntityId $entityId,

Spacing +31 added lines, -31 removed lines

@@ -51,12 +51,12 @@ 
 		$this->dataFactory = $dataFactory;
 		$this->logger = $logger;
 		$this->constraintCheckDurationLimits = [
-			'info' => $config->get( 'WBQualityConstraintsCheckDurationInfoSeconds' ),
-			'warning' => $config->get( 'WBQualityConstraintsCheckDurationWarningSeconds' ),
+			'info' => $config->get('WBQualityConstraintsCheckDurationInfoSeconds'),
+			'warning' => $config->get('WBQualityConstraintsCheckDurationWarningSeconds'),
 		];
 		$this->constraintCheckOnEntityDurationLimits = [
-			'info' => $config->get( 'WBQualityConstraintsCheckOnEntityDurationInfoSeconds' ),
-			'warning' => $config->get( 'WBQualityConstraintsCheckOnEntityDurationWarningSeconds' ),
+			'info' => $config->get('WBQualityConstraintsCheckOnEntityDurationInfoSeconds'),
+			'warning' => $config->get('WBQualityConstraintsCheckOnEntityDurationWarningSeconds'),
 		];
 	}
 
@@ -67,23 +67,23 @@ 
 	 * @param float $durationSeconds
 	 * @return array [ $limitSeconds, $logLevel ]
 	 */
-	private function findLimit( $limits, $durationSeconds ) {
+	private function findLimit($limits, $durationSeconds) {
 		$limitSeconds = null;
 		$logLevel = null;
 
-		foreach ( $limits as $level => $limit ) {
+		foreach ($limits as $level => $limit) {
 			if (
 				// duration exceeds this limit
-				isset( $limit ) && $durationSeconds > $limit &&
+				isset($limit) && $durationSeconds > $limit &&
 				// this limit is longer than previous longest limit
-				( $limitSeconds === null || $limit > $limitSeconds )
+				($limitSeconds === null || $limit > $limitSeconds)
 			) {
 				$limitSeconds = $limit;
 				$logLevel = $level;
 			}
 		}
 
-		return [ $limitSeconds, $logLevel ];
+		return [$limitSeconds, $logLevel];
 	}
 
 	/**
@@ -108,31 +108,31 @@ 
 		$durationSeconds,
 		$method
 	) {
-		$constraintCheckerClassShortName = substr( strrchr( $constraintCheckerClass, '\\' ), 1 );
+		$constraintCheckerClassShortName = substr(strrchr($constraintCheckerClass, '\\'), 1);
 		$constraintTypeItemId = $constraint->getConstraintTypeItemId();
 
 		$this->dataFactory->timing(
-			'wikibase.quality.constraints.check.timing.' .
-				$constraintTypeItemId . '-' .
+			'wikibase.quality.constraints.check.timing.'.
+				$constraintTypeItemId.'-'.
 				$constraintCheckerClassShortName,
 			$durationSeconds * 1000
 		);
 
 		// find the longest limit (and associated log level) that the duration exceeds
-		list( $limitSeconds, $logLevel ) = $this->findLimit(
+		list($limitSeconds, $logLevel) = $this->findLimit(
 			$this->constraintCheckDurationLimits,
 			$durationSeconds
 		);
-		if ( $limitSeconds === null ) {
+		if ($limitSeconds === null) {
 			return;
 		}
-		if ( $context->getType() !== Context::TYPE_STATEMENT ) {
+		if ($context->getType() !== Context::TYPE_STATEMENT) {
 			// TODO log less details but still log something
 			return;
 		}
 
 		$resultMessage = $result->getMessage();
-		if ( $resultMessage !== null ) {
+		if ($resultMessage !== null) {
 			$resultMessageKey = $resultMessage->getMessageKey();
 		} else {
 			$resultMessageKey = null;
@@ -140,8 +140,8 @@ 
 
 		$this->logger->log(
 			$logLevel,
-			'Constraint check with {constraintCheckerClassShortName} ' .
-			'took longer than {limitSeconds} second(s) ' .
+			'Constraint check with {constraintCheckerClassShortName} '.
+			'took longer than {limitSeconds} second(s) '.
 			'(duration: {durationSeconds} seconds).',
 			[
 				'method' => $method,
@@ -151,13 +151,13 @@ 
 				'constraintId' => $constraint->getConstraintId(),
 				'constraintPropertyId' => $constraint->getPropertyId()->getSerialization(),
 				'constraintTypeItemId' => $constraintTypeItemId,
-				'constraintParameters' => json_encode( $constraint->getConstraintParameters() ),
+				'constraintParameters' => json_encode($constraint->getConstraintParameters()),
 				'constraintCheckerClass' => $constraintCheckerClass,
 				'constraintCheckerClassShortName' => $constraintCheckerClassShortName,
 				'entityId' => $context->getEntity()->getId()->getSerialization(),
 				'statementGuid' => $context->getSnakStatement()->getGuid(),
 				'resultStatus' => $result->getStatus(),
-				'resultParameters' => json_encode( $result->getParameters() ),
+				'resultParameters' => json_encode($result->getParameters()),
 				'resultMessage' => $resultMessageKey,
 			]
 		);
@@ -187,18 +187,18 @@ 
 		);
 
 		// find the longest limit (and associated log level) that the duration exceeds
-		list( $limitSeconds, $logLevel ) = $this->findLimit(
+		list($limitSeconds, $logLevel) = $this->findLimit(
 			$this->constraintCheckOnEntityDurationLimits,
 			$durationSeconds
 		);
-		if ( $limitSeconds === null ) {
+		if ($limitSeconds === null) {
 			return;
 		}
 
 		$this->logger->log(
 			$logLevel,
-			'Full constraint check on {entityId} ' .
-			'took longer than {limitSeconds} second(s) ' .
+			'Full constraint check on {entityId} '.
+			'took longer than {limitSeconds} second(s) '.
 			'(duration: {durationSeconds} seconds).',
 			[
 				'method' => $method,
@@ -216,7 +216,7 @@ 
 	 *
 	 * @param EntityId $entityId
 	 */
-	public function logCheckConstraintsCacheHit( EntityId $entityId ) {
+	public function logCheckConstraintsCacheHit(EntityId $entityId) {
 		$this->dataFactory->increment(
 			'wikibase.quality.constraints.cache.entity.hit'
 		);
@@ -227,10 +227,10 @@ 
 	 *
 	 * @param EntityId[] $entityIds
 	 */
-	public function logCheckConstraintsCacheMisses( array $entityIds ) {
+	public function logCheckConstraintsCacheMisses(array $entityIds) {
 		$this->dataFactory->updateCount(
 			'wikibase.quality.constraints.cache.entity.miss',
-			count( $entityIds )
+			count($entityIds)
 		);
 	}
 
@@ -257,17 +257,17 @@ 
 	 * @param EntityId[] $entityIds
 	 * @param int $maxRevisionIds
 	 */
-	public function logHugeDependencyMetadata( array $entityIds, $maxRevisionIds ) {
+	public function logHugeDependencyMetadata(array $entityIds, $maxRevisionIds) {
 		$this->logger->log(
 			'warning',
-			'Dependency metadata for constraint check result has huge set of entity IDs ' .
-			'(count ' . count( $entityIds ) . ', limit ' . $maxRevisionIds . '); ' .
+			'Dependency metadata for constraint check result has huge set of entity IDs '.
+			'(count '.count($entityIds).', limit '.$maxRevisionIds.'); '.
 			'caching disabled for this check result.',
 			[
 				'loggingMethod' => __METHOD__,
 				'entityIds' => json_encode(
 					array_map(
-						function ( EntityId $entityId ) {
+						function(EntityId $entityId) {
 							return $entityId->getSerialization();
 						},
 						$entityIds