wikimedia / mediawiki-extensions-WikibaseQualityConstraints

src/Api/CheckConstraints.php

Spacing +34 added lines, -34 removed lines

@@ -79,19 +79,19 @@ 
 	 *
 	 * @return self
 	 */
-	public static function newFromGlobalState( ApiMain $main, $name, $prefix = '' ) {
+	public static function newFromGlobalState(ApiMain $main, $name, $prefix = '') {
 		$repo = WikibaseRepo::getDefaultInstance();
 
 		$language = $repo->getUserLanguage();
 		$formatterOptions = new FormatterOptions();
-		$formatterOptions->setOption( SnakFormatter::OPT_LANG, $language->getCode() );
+		$formatterOptions->setOption(SnakFormatter::OPT_LANG, $language->getCode());
 		$valueFormatterFactory = $repo->getValueFormatterFactory();
-		$valueFormatter = $valueFormatterFactory->getValueFormatter( SnakFormatter::FORMAT_HTML, $formatterOptions );
+		$valueFormatter = $valueFormatterFactory->getValueFormatter(SnakFormatter::FORMAT_HTML, $formatterOptions);
 
 		$entityIdHtmlLinkFormatterFactory = $repo->getEntityIdHtmlLinkFormatterFactory();
-		$entityIdHtmlLinkFormatter = $entityIdHtmlLinkFormatterFactory->getEntityIdFormatter( $language );
+		$entityIdHtmlLinkFormatter = $entityIdHtmlLinkFormatterFactory->getEntityIdFormatter($language);
 		$entityIdLabelFormatterFactory = new EntityIdLabelFormatterFactory();
-		$entityIdLabelFormatter = $entityIdLabelFormatterFactory->getEntityIdFormatter( $language );
+		$entityIdLabelFormatter = $entityIdLabelFormatterFactory->getEntityIdFormatter($language);
 		$config = MediaWikiServices::getInstance()->getMainConfig();
 		$dataFactory = MediaWikiServices::getInstance()->getStatsdDataFactory();
 
@@ -113,7 +113,7 @@ 
 			$prefix,
 			$repo->getEntityIdParser(),
 			$repo->getStatementGuidValidator(),
-			$repo->getApiHelperFactory( RequestContext::getMain() ),
+			$repo->getApiHelperFactory(RequestContext::getMain()),
 			$resultsSource,
 			$checkResultsRenderer,
 			$dataFactory
@@ -142,11 +142,11 @@ 
 		CheckResultsRenderer $checkResultsRenderer,
 		IBufferingStatsdDataFactory $dataFactory
 	) {
-		parent::__construct( $main, $name, $prefix );
+		parent::__construct($main, $name, $prefix);
 		$this->entityIdParser = $entityIdParser;
 		$this->statementGuidValidator = $statementGuidValidator;
-		$this->resultBuilder = $apiHelperFactory->getResultBuilder( $this );
-		$this->errorReporter = $apiHelperFactory->getErrorReporter( $this );
+		$this->resultBuilder = $apiHelperFactory->getResultBuilder($this);
+		$this->errorReporter = $apiHelperFactory->getErrorReporter($this);
 		$this->resultsSource = $resultsSource;
 		$this->checkResultsRenderer = $checkResultsRenderer;
 		$this->dataFactory = $dataFactory;
@@ -162,9 +162,9 @@ 
 
 		$params = $this->extractRequestParams();
 
-		$this->validateParameters( $params );
-		$entityIds = $this->parseEntityIds( $params );
-		$claimIds = $this->parseClaimIds( $params );
+		$this->validateParameters($params);
+		$entityIds = $this->parseEntityIds($params);
+		$claimIds = $this->parseClaimIds($params);
 		$constraintIDs = $params[self::PARAM_CONSTRAINT_ID];
 		$statuses = $params[self::PARAM_STATUS];
 
@@ -180,7 +180,7 @@ 
 				)
 			)->getArray()
 		);
-		$this->resultBuilder->markSuccess( 1 );
+		$this->resultBuilder->markSuccess(1);
 	}
 
 	/**
@@ -188,24 +188,24 @@ 
 	 *
 	 * @return EntityId[]
 	 */
-	private function parseEntityIds( array $params ) {
+	private function parseEntityIds(array $params) {
 		$ids = $params[self::PARAM_ID];
 
-		if ( $ids === null ) {
+		if ($ids === null) {
 			return [];
-		} elseif ( $ids === [] ) {
+		} elseif ($ids === []) {
 			$this->errorReporter->dieError(
-				'If ' . self::PARAM_ID . ' is specified, it must be nonempty.', 'no-data' );
+				'If '.self::PARAM_ID.' is specified, it must be nonempty.', 'no-data' );
 		}
 
-		return array_map( function ( $id ) {
+		return array_map(function($id) {
 			try {
-				return $this->entityIdParser->parse( $id );
-			} catch ( EntityIdParsingException $e ) {
+				return $this->entityIdParser->parse($id);
+			} catch (EntityIdParsingException $e) {
 				$this->errorReporter->dieError(
-					"Invalid id: $id", 'invalid-entity-id', 0, [ self::PARAM_ID => $id ] );
+					"Invalid id: $id", 'invalid-entity-id', 0, [self::PARAM_ID => $id] );
 			}
-		}, $ids );
+		}, $ids);
 	}
 
 	/**
@@ -213,35 +213,35 @@ 
 	 *
 	 * @return string[]
 	 */
-	private function parseClaimIds( array $params ) {
+	private function parseClaimIds(array $params) {
 		$ids = $params[self::PARAM_CLAIM_ID];
 
-		if ( $ids === null ) {
+		if ($ids === null) {
 			return [];
-		} elseif ( $ids === [] ) {
+		} elseif ($ids === []) {
 			$this->errorReporter->dieError(
-				'If ' . self::PARAM_CLAIM_ID . ' is specified, it must be nonempty.', 'no-data' );
+				'If '.self::PARAM_CLAIM_ID.' is specified, it must be nonempty.', 'no-data' );
 		}
 
-		foreach ( $ids as $id ) {
-			if ( !$this->statementGuidValidator->validate( $id ) ) {
+		foreach ($ids as $id) {
+			if (!$this->statementGuidValidator->validate($id)) {
 				$this->errorReporter->dieError(
-					"Invalid claim id: $id", 'invalid-guid', 0, [ self::PARAM_CLAIM_ID => $id ] );
+					"Invalid claim id: $id", 'invalid-guid', 0, [self::PARAM_CLAIM_ID => $id] );
 			}
 		}
 
 		return $ids;
 	}
 
-	private function validateParameters( array $params ) {
-		if ( $params[self::PARAM_CONSTRAINT_ID] !== null
-			 && empty( $params[self::PARAM_CONSTRAINT_ID] )
+	private function validateParameters(array $params) {
+		if ($params[self::PARAM_CONSTRAINT_ID] !== null
+			 && empty($params[self::PARAM_CONSTRAINT_ID])
 		) {
 			$paramConstraintId = self::PARAM_CONSTRAINT_ID;
 			$this->errorReporter->dieError(
 				"If $paramConstraintId is specified, it must be nonempty.", 'no-data' );
 		}
-		if ( $params[self::PARAM_ID] === null && $params[self::PARAM_CLAIM_ID] === null ) {
+		if ($params[self::PARAM_ID] === null && $params[self::PARAM_CLAIM_ID] === null) {
 			$paramId = self::PARAM_ID;
 			$paramClaimId = self::PARAM_CLAIM_ID;
 			$this->errorReporter->dieError(
@@ -282,7 +282,7 @@ 
 				],
 				ApiBase::PARAM_ISMULTI => true,
 				ApiBase::PARAM_ALL => true,
-				ApiBase::PARAM_DFLT => implode( '|', CachingResultsSource::CACHED_STATUSES ),
+				ApiBase::PARAM_DFLT => implode('|', CachingResultsSource::CACHED_STATUSES),
 				ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 			],
 		];

src/Api/CachingResultsSource.php

Spacing +77 added lines, -78 removed lines

@@ -143,14 +143,14 @@ 
 	) {
 		$results = [];
 		$metadatas = [];
-		if ( $this->canUseStoredResults( $entityIds, $claimIds, $constraintIds, $statuses ) ) {
+		if ($this->canUseStoredResults($entityIds, $claimIds, $constraintIds, $statuses)) {
 			$storedEntityIds = [];
-			foreach ( $entityIds as $entityId ) {
-				$storedResults = $this->getStoredResults( $entityId );
-				if ( $storedResults !== null ) {
-					$this->loggingHelper->logCheckConstraintsCacheHit( $entityId );
-					foreach ( $storedResults->getArray() as $checkResult ) {
-						if ( $this->statusSelected( $statuses, $checkResult ) ) {
+			foreach ($entityIds as $entityId) {
+				$storedResults = $this->getStoredResults($entityId);
+				if ($storedResults !== null) {
+					$this->loggingHelper->logCheckConstraintsCacheHit($entityId);
+					foreach ($storedResults->getArray() as $checkResult) {
+						if ($this->statusSelected($statuses, $checkResult)) {
 							$results[] = $checkResult;
 						}
 					}
@@ -158,19 +158,19 @@ 
 					$storedEntityIds[] = $entityId;
 				}
 			}
-			$entityIds = array_values( array_diff( $entityIds, $storedEntityIds ) );
+			$entityIds = array_values(array_diff($entityIds, $storedEntityIds));
 		}
-		if ( $entityIds !== [] || $claimIds !== [] ) {
-			if ( $entityIds !== [] ) {
-				$this->loggingHelper->logCheckConstraintsCacheMisses( $entityIds );
+		if ($entityIds !== [] || $claimIds !== []) {
+			if ($entityIds !== []) {
+				$this->loggingHelper->logCheckConstraintsCacheMisses($entityIds);
 			}
-			$response = $this->getAndStoreResults( $entityIds, $claimIds, $constraintIds, $statuses );
-			$results = array_merge( $results, $response->getArray() );
+			$response = $this->getAndStoreResults($entityIds, $claimIds, $constraintIds, $statuses);
+			$results = array_merge($results, $response->getArray());
 			$metadatas[] = $response->getMetadata();
 		}
 		return new CachedCheckResults(
 			$results,
-			Metadata::merge( $metadatas )
+			Metadata::merge($metadatas)
 		);
 	}
 
@@ -193,13 +193,13 @@ 
 		?array $constraintIds,
 		array $statuses
 	) {
-		if ( $claimIds !== [] ) {
+		if ($claimIds !== []) {
 			return false;
 		}
-		if ( $constraintIds !== null ) {
+		if ($constraintIds !== null) {
 			return false;
 		}
-		if ( array_diff( $statuses, self::CACHED_STATUSES ) !== [] ) {
+		if (array_diff($statuses, self::CACHED_STATUSES) !== []) {
 			return false;
 		}
 		return true;
@@ -214,8 +214,8 @@ 
 	 * @param CheckResult $result
 	 * @return bool
 	 */
-	private function statusSelected( array $statuses, CheckResult $result ) {
-		return in_array( $result->getStatus(), $statuses, true ) ||
+	private function statusSelected(array $statuses, CheckResult $result) {
+		return in_array($result->getStatus(), $statuses, true) ||
 			$result instanceof NullResult;
 	}
 
@@ -232,11 +232,11 @@ 
 		?array $constraintIds,
 		array $statuses
 	) {
-		$results = $this->resultsSource->getResults( $entityIds, $claimIds, $constraintIds, $statuses );
+		$results = $this->resultsSource->getResults($entityIds, $claimIds, $constraintIds, $statuses);
 
-		if ( $this->canStoreResults( $entityIds, $claimIds, $constraintIds, $statuses ) ) {
-			foreach ( $entityIds as $entityId ) {
-				$this->storeResults( $entityId, $results );
+		if ($this->canStoreResults($entityIds, $claimIds, $constraintIds, $statuses)) {
+			foreach ($entityIds as $entityId) {
+				$this->storeResults($entityId, $results);
 			}
 		}
 
@@ -267,10 +267,10 @@ 
 		?array $constraintIds,
 		array $statuses
 	) {
-		if ( $constraintIds !== null ) {
+		if ($constraintIds !== null) {
 			return false;
 		}
-		if ( array_diff( self::CACHED_STATUSES, $statuses ) !== [] ) {
+		if (array_diff(self::CACHED_STATUSES, $statuses) !== []) {
 			return false;
 		}
 		return true;
@@ -284,21 +284,21 @@ 
 	 * May include check results for other entity IDs as well,
 	 * or check results with statuses that we’re not interested in caching.
 	 */
-	private function storeResults( EntityId $entityId, CachedCheckResults $results ) {
+	private function storeResults(EntityId $entityId, CachedCheckResults $results) {
 		$latestRevisionIds = $this->getLatestRevisionIds(
 			$results->getMetadata()->getDependencyMetadata()->getEntityIds()
 		);
-		if ( $latestRevisionIds === null ) {
+		if ($latestRevisionIds === null) {
 			return;
 		}
 
 		$resultSerializations = [];
-		foreach ( $results->getArray() as $checkResult ) {
-			if ( $checkResult->getContextCursor()->getEntityId() !== $entityId->getSerialization() ) {
+		foreach ($results->getArray() as $checkResult) {
+			if ($checkResult->getContextCursor()->getEntityId() !== $entityId->getSerialization()) {
 				continue;
 			}
-			if ( $this->statusSelected( self::CACHED_STATUSES, $checkResult ) ) {
-				$resultSerializations[] = $this->checkResultSerializer->serialize( $checkResult );
+			if ($this->statusSelected(self::CACHED_STATUSES, $checkResult)) {
+				$resultSerializations[] = $this->checkResultSerializer->serialize($checkResult);
 			}
 		}
 
@@ -307,11 +307,11 @@ 
 			'latestRevisionIds' => $latestRevisionIds,
 		];
 		$futureTime = $results->getMetadata()->getDependencyMetadata()->getFutureTime();
-		if ( $futureTime !== null ) {
+		if ($futureTime !== null) {
 			$value['futureTime'] = $futureTime->getArrayValue();
 		}
 
-		$this->cache->set( $entityId, $value, $this->ttlInSeconds );
+		$this->cache->set($entityId, $value, $this->ttlInSeconds);
 	}
 
 	/**
@@ -325,31 +325,30 @@ 
 		EntityId $entityId,
 		$forRevision = 0
 	) {
-		$value = $this->cache->get( $entityId, $curTTL, [], $asOf );
-		$now = call_user_func( $this->microtime, true );
+		$value = $this->cache->get($entityId, $curTTL, [], $asOf);
+		$now = call_user_func($this->microtime, true);
 
-		$dependencyMetadata = $this->checkDependencyMetadata( $value,
-			[ $entityId->getSerialization() => $forRevision ] );
-		if ( $dependencyMetadata === null ) {
+		$dependencyMetadata = $this->checkDependencyMetadata($value,
+			[$entityId->getSerialization() => $forRevision]);
+		if ($dependencyMetadata === null) {
 			return null;
 		}
 
-		$ageInSeconds = (int)ceil( $now - $asOf );
+		$ageInSeconds = (int) ceil($now - $asOf);
 		$cachingMetadata = $ageInSeconds > 0 ?
-			CachingMetadata::ofMaximumAgeInSeconds( $ageInSeconds ) :
-			CachingMetadata::fresh();
+			CachingMetadata::ofMaximumAgeInSeconds($ageInSeconds) : CachingMetadata::fresh();
 
 		$results = [];
-		foreach ( $value['results'] as $resultSerialization ) {
-			$results[] = $this->deserializeCheckResult( $resultSerialization, $cachingMetadata );
+		foreach ($value['results'] as $resultSerialization) {
+			$results[] = $this->deserializeCheckResult($resultSerialization, $cachingMetadata);
 		}
 
 		return new CachedCheckResults(
 			$results,
-			Metadata::merge( [
-				Metadata::ofCachingMetadata( $cachingMetadata ),
-				Metadata::ofDependencyMetadata( $dependencyMetadata ),
-			] )
+			Metadata::merge([
+				Metadata::ofCachingMetadata($cachingMetadata),
+				Metadata::ofDependencyMetadata($dependencyMetadata),
+			])
 		);
 	}
 
@@ -365,43 +364,43 @@ 
 	 * @return DependencyMetadata|null the dependency metadata,
 	 * or null if $value should no longer be used
 	 */
-	private function checkDependencyMetadata( $value, $paramRevs ) {
-		if ( $value === false ) {
+	private function checkDependencyMetadata($value, $paramRevs) {
+		if ($value === false) {
 			return null;
 		}
 
-		if ( array_key_exists( 'futureTime', $value ) ) {
-			$futureTime = TimeValue::newFromArray( $value['futureTime'] );
-			if ( !$this->timeValueComparer->isFutureTime( $futureTime ) ) {
+		if (array_key_exists('futureTime', $value)) {
+			$futureTime = TimeValue::newFromArray($value['futureTime']);
+			if (!$this->timeValueComparer->isFutureTime($futureTime)) {
 				return null;
 			}
-			$futureTimeDependencyMetadata = DependencyMetadata::ofFutureTime( $futureTime );
+			$futureTimeDependencyMetadata = DependencyMetadata::ofFutureTime($futureTime);
 		} else {
 			$futureTimeDependencyMetadata = DependencyMetadata::blank();
 		}
 
-		foreach ( $paramRevs as $id => $revision ) {
-			if ( $revision > 0 ) {
-				$value['latestRevisionIds'][$id] = min( $revision, $value['latestRevisionIds'][$id] ?? PHP_INT_MAX );
+		foreach ($paramRevs as $id => $revision) {
+			if ($revision > 0) {
+				$value['latestRevisionIds'][$id] = min($revision, $value['latestRevisionIds'][$id] ?? PHP_INT_MAX);
 			}
 		}
 
 		$dependedEntityIds = array_map(
-			[ $this->entityIdParser, "parse" ],
-			array_keys( $value['latestRevisionIds'] )
+			[$this->entityIdParser, "parse"],
+			array_keys($value['latestRevisionIds'])
 		);
 
-		if ( $value['latestRevisionIds'] !== $this->getLatestRevisionIds( $dependedEntityIds ) ) {
+		if ($value['latestRevisionIds'] !== $this->getLatestRevisionIds($dependedEntityIds)) {
 			return null;
 		}
 
 		return array_reduce(
 			$dependedEntityIds,
-			function( DependencyMetadata $metadata, EntityId $entityId ) {
-				return DependencyMetadata::merge( [
+			function(DependencyMetadata $metadata, EntityId $entityId) {
+				return DependencyMetadata::merge([
 					$metadata,
-					DependencyMetadata::ofEntityId( $entityId )
-				] );
+					DependencyMetadata::ofEntityId($entityId)
+				]);
 			},
 			$futureTimeDependencyMetadata
 		);
@@ -421,13 +420,13 @@ 
 		array $resultSerialization,
 		CachingMetadata $cachingMetadata
 	) {
-		$result = $this->checkResultDeserializer->deserialize( $resultSerialization );
-		if ( $this->isPossiblyStaleResult( $result ) ) {
+		$result = $this->checkResultDeserializer->deserialize($resultSerialization);
+		if ($this->isPossiblyStaleResult($result)) {
 			$result->withMetadata(
-				Metadata::merge( [
+				Metadata::merge([
 					$result->getMetadata(),
-					Metadata::ofCachingMetadata( $cachingMetadata ),
-				] )
+					Metadata::ofCachingMetadata($cachingMetadata),
+				])
 			);
 		}
 		return $result;
@@ -437,8 +436,8 @@ 
 	 * @param CheckResult $result
 	 * @return bool
 	 */
-	private function isPossiblyStaleResult( CheckResult $result ) {
-		if ( $result instanceof NullResult ) {
+	private function isPossiblyStaleResult(CheckResult $result) {
+		if ($result instanceof NullResult) {
 			return false;
 		}
 
@@ -453,14 +452,14 @@ 
 	 * @return int[]|null array from entity ID serializations to revision ID,
 	 * or null to indicate that not all revision IDs could be loaded
 	 */
-	private function getLatestRevisionIds( array $entityIds ) {
-		if ( $entityIds === [] ) {
+	private function getLatestRevisionIds(array $entityIds) {
+		if ($entityIds === []) {
 			$this->loggingHelper->logEmptyDependencyMetadata();
 			return [];
 		}
-		if ( count( $entityIds ) > $this->maxRevisionIds ) {
+		if (count($entityIds) > $this->maxRevisionIds) {
 			// one of those entities will probably be edited soon, so might as well skip caching
-			$this->loggingHelper->logHugeDependencyMetadata( $entityIds, $this->maxRevisionIds );
+			$this->loggingHelper->logHugeDependencyMetadata($entityIds, $this->maxRevisionIds);
 			return null;
 		}
 
@@ -468,7 +467,7 @@ 
 			$entityIds,
 			EntityRevisionLookup::LATEST_FROM_REPLICA
 		);
-		if ( $this->hasFalseElements( $latestRevisionIds ) ) {
+		if ($this->hasFalseElements($latestRevisionIds)) {
 			return null;
 		}
 		return $latestRevisionIds;
@@ -478,8 +477,8 @@ 
 	 * @param array $array
 	 * @return bool
 	 */
-	private function hasFalseElements( array $array ) {
-		return in_array( false, $array, true );
+	private function hasFalseElements(array $array) {
+		return in_array(false, $array, true);
 	}
 
 	/**
@@ -487,7 +486,7 @@ 
 	 *
 	 * @param callable $microtime
 	 */
-	public function setMicrotimeFunction( callable $microtime ) {
+	public function setMicrotimeFunction(callable $microtime) {
 		$this->microtime = $microtime;
 	}