wikimedia / mediawiki-extensions-WikibaseQualityConstraints

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

src/ConstraintCheck/Helper/TypeCheckerHelper.php

Spacing +45 added lines, -45 removed lines

@@ -80,23 +80,23 @@ 
 	 * @return bool
 	 * @throws OverflowException if $entitiesChecked exceeds the configured limit
 	 */
-	private function isSubclassOf( EntityId $comparativeClass, array $classesToCheck, &$entitiesChecked = 0 ) {
-		$maxEntities = $this->config->get( 'WBQualityConstraintsTypeCheckMaxEntities' );
+	private function isSubclassOf(EntityId $comparativeClass, array $classesToCheck, &$entitiesChecked = 0) {
+		$maxEntities = $this->config->get('WBQualityConstraintsTypeCheckMaxEntities');
 		if ( ++$entitiesChecked > $maxEntities ) {
-			throw new OverflowException( 'Too many entities to check' );
+			throw new OverflowException('Too many entities to check');
 		}
 
-		$item = $this->entityLookup->getEntity( $comparativeClass );
-		if ( !( $item instanceof StatementListProvider ) ) {
+		$item = $this->entityLookup->getEntity($comparativeClass);
+		if (!($item instanceof StatementListProvider)) {
 			return false; // lookup failed, probably because item doesn't exist
 		}
 
-		$subclassId = $this->config->get( 'WBQualityConstraintsSubclassOfId' );
+		$subclassId = $this->config->get('WBQualityConstraintsSubclassOfId');
 		/** @var Statement $statement */
-		foreach ( $item->getStatements()->getByPropertyId( new PropertyId( $subclassId ) ) as $statement ) {
+		foreach ($item->getStatements()->getByPropertyId(new PropertyId($subclassId)) as $statement) {
 			$mainSnak = $statement->getMainSnak();
 
-			if ( !( $this->hasCorrectType( $mainSnak ) ) ) {
+			if (!($this->hasCorrectType($mainSnak))) {
 				continue;
 			}
 			/** @var PropertyValueSnak $mainSnak */
@@ -105,11 +105,11 @@ 
 			$dataValue = $mainSnak->getDataValue();
 			$comparativeClass = $dataValue->getEntityId();
 
-			if ( in_array( $comparativeClass->getSerialization(), $classesToCheck ) ) {
+			if (in_array($comparativeClass->getSerialization(), $classesToCheck)) {
 				return true;
 			}
 
-			if ( $this->isSubclassOf( $comparativeClass, $classesToCheck, $entitiesChecked ) ) {
+			if ($this->isSubclassOf($comparativeClass, $classesToCheck, $entitiesChecked)) {
 				return true;
 			}
 		}
@@ -130,44 +130,44 @@ 
 	 * @return CachedBool
 	 * @throws SparqlHelperException if SPARQL is used and the query times out or some other error occurs
 	 */
-	public function isSubclassOfWithSparqlFallback( EntityId $comparativeClass, array $classesToCheck ) {
+	public function isSubclassOfWithSparqlFallback(EntityId $comparativeClass, array $classesToCheck) {
 		try {
-			$start1 = microtime( true );
-			$isSubclass = $this->isSubclassOf( $comparativeClass, $classesToCheck );
-			$end1 = microtime( true );
+			$start1 = microtime(true);
+			$isSubclass = $this->isSubclassOf($comparativeClass, $classesToCheck);
+			$end1 = microtime(true);
 			$this->dataFactory->timing(
 				'wikibase.quality.constraints.type.php.success.timing',
-				( $end1 - $start1 ) * 1000
+				($end1 - $start1) * 1000
 			);
 
-			return new CachedBool( $isSubclass, Metadata::blank() );
-		} catch ( OverflowException $e ) {
-			$end1 = microtime( true );
+			return new CachedBool($isSubclass, Metadata::blank());
+		} catch (OverflowException $e) {
+			$end1 = microtime(true);
 			$this->dataFactory->timing(
 				'wikibase.quality.constraints.type.php.overflow.timing',
-				( $end1 - $start1 ) * 1000
+				($end1 - $start1) * 1000
 			);
 
-			if ( !( $this->sparqlHelper instanceof DummySparqlHelper ) ) {
+			if (!($this->sparqlHelper instanceof DummySparqlHelper)) {
 				$this->dataFactory->increment(
 					'wikibase.quality.constraints.sparql.typeFallback'
 				);
 
-				$start2 = microtime( true );
+				$start2 = microtime(true);
 				$hasType = $this->sparqlHelper->hasType(
 					$comparativeClass->getSerialization(),
 					$classesToCheck,
 					/* withInstance = */ false
 				);
-				$end2 = microtime( true );
+				$end2 = microtime(true);
 				$this->dataFactory->timing(
 					'wikibase.quality.constraints.type.sparql.success.timing',
-					( $end2 - $start2 ) * 1000
+					($end2 - $start2) * 1000
 				);
 
 				return $hasType;
 			} else {
-				return new CachedBool( false, Metadata::blank() );
+				return new CachedBool(false, Metadata::blank());
 			}
 		}
 	}
@@ -185,13 +185,13 @@ 
 	 * @return CachedBool
 	 * @throws SparqlHelperException if SPARQL is used and the query times out or some other error occurs
 	 */
-	public function hasClassInRelation( StatementList $statements, array $relationIds, array $classesToCheck ) {
+	public function hasClassInRelation(StatementList $statements, array $relationIds, array $classesToCheck) {
 		$metadatas = [];
 
-		foreach ( $this->getStatementsByPropertyIds( $statements, $relationIds ) as $statement ) {
+		foreach ($this->getStatementsByPropertyIds($statements, $relationIds) as $statement) {
 			$mainSnak = $statement->getMainSnak();
 
-			if ( !$this->hasCorrectType( $mainSnak ) ) {
+			if (!$this->hasCorrectType($mainSnak)) {
 				continue;
 			}
 			/** @var PropertyValueSnak $mainSnak */
@@ -200,28 +200,28 @@ 
 			$dataValue = $mainSnak->getDataValue();
 			$comparativeClass = $dataValue->getEntityId();
 
-			if ( in_array( $comparativeClass->getSerialization(), $classesToCheck ) ) {
+			if (in_array($comparativeClass->getSerialization(), $classesToCheck)) {
 				// discard $metadatas, we know this is fresh
-				return new CachedBool( true, Metadata::blank() );
+				return new CachedBool(true, Metadata::blank());
 			}
 
-			$result = $this->isSubclassOfWithSparqlFallback( $comparativeClass, $classesToCheck );
+			$result = $this->isSubclassOfWithSparqlFallback($comparativeClass, $classesToCheck);
 			$metadatas[] = $result->getMetadata();
-			if ( $result->getBool() ) {
+			if ($result->getBool()) {
 				return new CachedBool(
 					true,
-					Metadata::merge( $metadatas )
+					Metadata::merge($metadatas)
 				);
 			}
 		}
 
 		return new CachedBool(
 			false,
-			Metadata::merge( $metadatas )
+			Metadata::merge($metadatas)
 		);
 	}
 
-	private function hasCorrectType( Snak $mainSnak ) {
+	private function hasCorrectType(Snak $mainSnak) {
 		return $mainSnak instanceof PropertyValueSnak
 			&& $mainSnak->getDataValue()->getType() === 'wikibase-entityid';
 	}
@@ -238,12 +238,12 @@ 
 	) {
 		$statementArrays = [];
 
-		foreach ( $propertyIdSerializations as $propertyIdSerialization ) {
-			$propertyId = new PropertyId( $propertyIdSerialization );
-			$statementArrays[] = $statements->getByPropertyId( $propertyId )->toArray();
+		foreach ($propertyIdSerializations as $propertyIdSerialization) {
+			$propertyId = new PropertyId($propertyIdSerialization);
+			$statementArrays[] = $statements->getByPropertyId($propertyId)->toArray();
 		}
 
-		return call_user_func_array( 'array_merge', $statementArrays );
+		return call_user_func_array('array_merge', $statementArrays);
 	}
 
 	/**
@@ -255,10 +255,10 @@ 
 	 *
 	 * @return ViolationMessage
 	 */
-	public function getViolationMessage( PropertyId $propertyId, EntityId $entityId, array $classes, $checker, $relation ) {
+	public function getViolationMessage(PropertyId $propertyId, EntityId $entityId, array $classes, $checker, $relation) {
 		$classes = array_map(
-			function( $itemIdSerialization ) {
-				return new ItemId( $itemIdSerialization );
+			function($itemIdSerialization) {
+				return new ItemId($itemIdSerialization);
 			},
 			$classes
 		);
@@ -270,10 +270,10 @@ 
 		// wbqc-violation-message-valueType-instance
 		// wbqc-violation-message-valueType-subclass
 		// wbqc-violation-message-valueType-instanceOrSubclass
-		return ( new ViolationMessage( 'wbqc-violation-message-' . $checker . '-' . $relation ) )
-			->withEntityId( $propertyId, Role::CONSTRAINT_PROPERTY )
-			->withEntityId( $entityId, Role::SUBJECT )
-			->withEntityIdList( $classes, Role::OBJECT );
+		return (new ViolationMessage('wbqc-violation-message-'.$checker.'-'.$relation))
+			->withEntityId($propertyId, Role::CONSTRAINT_PROPERTY)
+			->withEntityId($entityId, Role::SUBJECT)
+			->withEntityIdList($classes, Role::OBJECT);
 	}
 
 }