wikimedia / mediawiki-extensions-WikibaseQualityConstraints

src/ConstraintCheck/DelegatingConstraintChecker.php

Spacing +137 added lines, -137 removed lines

@@ -144,21 +144,21 @@ 
 		callable $defaultResultsPerEntity = null
 	) {
 		$checkResults = [];
-		$entity = $this->entityLookup->getEntity( $entityId );
+		$entity = $this->entityLookup->getEntity($entityId);
 
-		if ( $entity instanceof StatementListProvider ) {
+		if ($entity instanceof StatementListProvider) {
 			$checkResults = $this->checkEveryStatement(
-				$this->entityLookup->getEntity( $entityId ),
+				$this->entityLookup->getEntity($entityId),
 				$constraintIds,
 				$defaultResultsPerContext
 			);
 		}
 
-		if ( $defaultResultsPerEntity !== null ) {
-			$checkResults = array_merge( $defaultResultsPerEntity( $entityId ), $checkResults );
+		if ($defaultResultsPerEntity !== null) {
+			$checkResults = array_merge($defaultResultsPerEntity($entityId), $checkResults);
 		}
 
-		return $this->sortResult( $checkResults );
+		return $this->sortResult($checkResults);
 	}
 
 	/**
@@ -180,19 +180,19 @@ 
 		callable $defaultResults = null
 	) {
 
-		$parsedGuid = $this->statementGuidParser->parse( $guid );
+		$parsedGuid = $this->statementGuidParser->parse($guid);
 		$entityId = $parsedGuid->getEntityId();
-		$entity = $this->entityLookup->getEntity( $entityId );
-		if ( $entity instanceof StatementListProvider ) {
-			$statement = $entity->getStatements()->getFirstStatementWithGuid( $guid );
-			if ( $statement ) {
+		$entity = $this->entityLookup->getEntity($entityId);
+		if ($entity instanceof StatementListProvider) {
+			$statement = $entity->getStatements()->getFirstStatementWithGuid($guid);
+			if ($statement) {
 				$result = $this->checkStatement(
 					$entity,
 					$statement,
 					$constraintIds,
 					$defaultResults
 				);
-				$output = $this->sortResult( $result );
+				$output = $this->sortResult($result);
 				return $output;
 			}
 		}
@@ -200,8 +200,8 @@ 
 		return [];
 	}
 
-	private function getAllowedContextTypes( Constraint $constraint ) {
-		if ( !array_key_exists( $constraint->getConstraintTypeItemId(), $this->checkerMap ) ) {
+	private function getAllowedContextTypes(Constraint $constraint) {
+		if (!array_key_exists($constraint->getConstraintTypeItemId(), $this->checkerMap)) {
 			return [
 				Context::TYPE_STATEMENT,
 				Context::TYPE_QUALIFIER,
@@ -209,12 +209,12 @@ 
 			];
 		}
 
-		return array_keys( array_filter(
+		return array_keys(array_filter(
 			$this->checkerMap[$constraint->getConstraintTypeItemId()]->getSupportedContextTypes(),
-			function ( $resultStatus ) {
+			function($resultStatus) {
 				return $resultStatus !== CheckResult::STATUS_NOT_IN_SCOPE;
 			}
-		) );
+		));
 	}
 
 	/**
@@ -225,32 +225,32 @@ 
 	 *
 	 * @return ConstraintParameterException[]
 	 */
-	private function checkCommonConstraintParameters( Constraint $constraint ) {
+	private function checkCommonConstraintParameters(Constraint $constraint) {
 		$constraintParameters = $constraint->getConstraintParameters();
 		try {
-			$this->constraintParameterParser->checkError( $constraintParameters );
-		} catch ( ConstraintParameterException $e ) {
-			return [ $e ];
+			$this->constraintParameterParser->checkError($constraintParameters);
+		} catch (ConstraintParameterException $e) {
+			return [$e];
 		}
 
 		$problems = [];
 		try {
-			$this->constraintParameterParser->parseExceptionParameter( $constraintParameters );
-		} catch ( ConstraintParameterException $e ) {
+			$this->constraintParameterParser->parseExceptionParameter($constraintParameters);
+		} catch (ConstraintParameterException $e) {
 			$problems[] = $e;
 		}
 		try {
-			$this->constraintParameterParser->parseConstraintStatusParameter( $constraintParameters );
-		} catch ( ConstraintParameterException $e ) {
+			$this->constraintParameterParser->parseConstraintStatusParameter($constraintParameters);
+		} catch (ConstraintParameterException $e) {
 			$problems[] = $e;
 		}
 		try {
 			$this->constraintParameterParser->parseConstraintScopeParameter(
 				$constraintParameters,
 				$constraint->getConstraintTypeItemId(),
-				$this->getAllowedContextTypes( $constraint )
+				$this->getAllowedContextTypes($constraint)
 			);
-		} catch ( ConstraintParameterException $e ) {
+		} catch (ConstraintParameterException $e) {
 			$problems[] = $e;
 		}
 		return $problems;
@@ -263,16 +263,16 @@ 
 	 * @return ConstraintParameterException[][] first level indexed by constraint ID,
 	 * second level like checkConstraintParametersOnConstraintId (but without possibility of null)
 	 */
-	public function checkConstraintParametersOnPropertyId( PropertyId $propertyId ) {
-		$constraints = $this->constraintLookup->queryConstraintsForProperty( $propertyId );
+	public function checkConstraintParametersOnPropertyId(PropertyId $propertyId) {
+		$constraints = $this->constraintLookup->queryConstraintsForProperty($propertyId);
 		$result = [];
 
-		foreach ( $constraints as $constraint ) {
-			$problems = $this->checkCommonConstraintParameters( $constraint );
+		foreach ($constraints as $constraint) {
+			$problems = $this->checkCommonConstraintParameters($constraint);
 
-			if ( array_key_exists( $constraint->getConstraintTypeItemId(), $this->checkerMap ) ) {
+			if (array_key_exists($constraint->getConstraintTypeItemId(), $this->checkerMap)) {
 				$checker = $this->checkerMap[$constraint->getConstraintTypeItemId()];
-				$problems = array_merge( $problems, $checker->checkConstraintParameters( $constraint ) );
+				$problems = array_merge($problems, $checker->checkConstraintParameters($constraint));
 			}
 
 			$result[$constraint->getConstraintId()] = $problems;
@@ -289,17 +289,17 @@ 
 	 * @return ConstraintParameterException[]|null list of constraint parameter exceptions
 	 * (empty means all parameters okay), or null if constraint is not found
 	 */
-	public function checkConstraintParametersOnConstraintId( $constraintId ) {
-		$propertyId = $this->statementGuidParser->parse( $constraintId )->getEntityId();
-		$constraints = $this->constraintLookup->queryConstraintsForProperty( $propertyId );
+	public function checkConstraintParametersOnConstraintId($constraintId) {
+		$propertyId = $this->statementGuidParser->parse($constraintId)->getEntityId();
+		$constraints = $this->constraintLookup->queryConstraintsForProperty($propertyId);
 
-		foreach ( $constraints as $constraint ) {
-			if ( $constraint->getConstraintId() === $constraintId ) {
-				$problems = $this->checkCommonConstraintParameters( $constraint );
+		foreach ($constraints as $constraint) {
+			if ($constraint->getConstraintId() === $constraintId) {
+				$problems = $this->checkCommonConstraintParameters($constraint);
 
-				if ( array_key_exists( $constraint->getConstraintTypeItemId(), $this->checkerMap ) ) {
+				if (array_key_exists($constraint->getConstraintTypeItemId(), $this->checkerMap)) {
 					$checker = $this->checkerMap[$constraint->getConstraintTypeItemId()];
-					$problems = array_merge( $problems, $checker->checkConstraintParameters( $constraint ) );
+					$problems = array_merge($problems, $checker->checkConstraintParameters($constraint));
 				}
 
 				return $problems;
@@ -324,14 +324,14 @@ 
 		$result = [];
 
 		/** @var Statement $statement */
-		foreach ( $entity->getStatements() as $statement ) {
-			$result = array_merge( $result,
+		foreach ($entity->getStatements() as $statement) {
+			$result = array_merge($result,
 				$this->checkStatement(
 					$entity,
 					$statement,
 					$constraintIds,
 					$defaultResultsPerContext
-				) );
+				));
 		}
 
 		return $result;
@@ -353,32 +353,32 @@ 
 	) {
 		$result = [];
 
-		$result = array_merge( $result,
+		$result = array_merge($result,
 			$this->checkConstraintsForMainSnak(
 				$entity,
 				$statement,
 				$constraintIds,
 				$defaultResultsPerContext
-			) );
+			));
 
-		if ( $this->checkQualifiers ) {
-			$result = array_merge( $result,
+		if ($this->checkQualifiers) {
+			$result = array_merge($result,
 				$this->checkConstraintsForQualifiers(
 					$entity,
 					$statement,
 					$constraintIds,
 					$defaultResultsPerContext
-				) );
+				));
 		}
 
-		if ( $this->checkReferences ) {
-			$result = array_merge( $result,
+		if ($this->checkReferences) {
+			$result = array_merge($result,
 				$this->checkConstraintsForReferences(
 					$entity,
 					$statement,
 					$constraintIds,
 					$defaultResultsPerContext
-				) );
+				));
 		}
 
 		return $result;
@@ -393,12 +393,12 @@ 
 	 * @param string[]|null $constraintIds
 	 * @return Constraint[]
 	 */
-	private function getConstraintsToUse( PropertyId $propertyId, array $constraintIds = null ) {
-		$constraints = $this->constraintLookup->queryConstraintsForProperty( $propertyId );
-		if ( $constraintIds !== null ) {
+	private function getConstraintsToUse(PropertyId $propertyId, array $constraintIds = null) {
+		$constraints = $this->constraintLookup->queryConstraintsForProperty($propertyId);
+		if ($constraintIds !== null) {
 			$constraintsToUse = [];
-			foreach ( $constraints as $constraint ) {
-				if ( in_array( $constraint->getConstraintId(), $constraintIds ) ) {
+			foreach ($constraints as $constraint) {
+				if (in_array($constraint->getConstraintId(), $constraintIds)) {
 					$constraintsToUse[] = $constraint;
 				}
 			}
@@ -422,29 +422,29 @@ 
 		array $constraintIds = null,
 		callable $defaultResults = null
 	) {
-		$context = new MainSnakContext( $entity, $statement );
+		$context = new MainSnakContext($entity, $statement);
 		$constraints = $this->getConstraintsToUse(
 			$statement->getPropertyId(),
 			$constraintIds
 		);
-		$result = $defaultResults !== null ? $defaultResults( $context ) : [];
+		$result = $defaultResults !== null ? $defaultResults($context) : [];
 
-		foreach ( $constraints as $constraint ) {
+		foreach ($constraints as $constraint) {
 			$parameters = $constraint->getConstraintParameters();
 			try {
-				$exceptions = $this->constraintParameterParser->parseExceptionParameter( $parameters );
-			} catch ( ConstraintParameterException $e ) {
-				$result[] = new CheckResult( $context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage() );
+				$exceptions = $this->constraintParameterParser->parseExceptionParameter($parameters);
+			} catch (ConstraintParameterException $e) {
+				$result[] = new CheckResult($context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage());
 				continue;
 			}
 
-			if ( in_array( $entity->getId(), $exceptions ) ) {
-				$message = new ViolationMessage( 'wbqc-violation-message-exception' );
-				$result[] = new CheckResult( $context, $constraint, [], CheckResult::STATUS_EXCEPTION, $message );
+			if (in_array($entity->getId(), $exceptions)) {
+				$message = new ViolationMessage('wbqc-violation-message-exception');
+				$result[] = new CheckResult($context, $constraint, [], CheckResult::STATUS_EXCEPTION, $message);
 				continue;
 			}
 
-			$result[] = $this->getCheckResultFor( $context, $constraint );
+			$result[] = $this->getCheckResultFor($context, $constraint);
 		}
 
 		return $result;
@@ -466,24 +466,24 @@ 
 	) {
 		$result = [];
 
-		if ( in_array(
+		if (in_array(
 			$statement->getPropertyId()->getSerialization(),
 			$this->propertiesWithViolatingQualifiers
-		) ) {
+		)) {
 			return $result;
 		}
 
-		foreach ( $statement->getQualifiers() as $qualifier ) {
-			$qualifierContext = new QualifierContext( $entity, $statement, $qualifier );
-			if ( $defaultResultsPerContext !== null ) {
-				$result = array_merge( $result, $defaultResultsPerContext( $qualifierContext ) );
+		foreach ($statement->getQualifiers() as $qualifier) {
+			$qualifierContext = new QualifierContext($entity, $statement, $qualifier);
+			if ($defaultResultsPerContext !== null) {
+				$result = array_merge($result, $defaultResultsPerContext($qualifierContext));
 			}
 			$qualifierConstraints = $this->getConstraintsToUse(
 				$qualifierContext->getSnak()->getPropertyId(),
 				$constraintIds
 			);
-			foreach ( $qualifierConstraints as $qualifierConstraint ) {
-				$result[] = $this->getCheckResultFor( $qualifierContext, $qualifierConstraint );
+			foreach ($qualifierConstraints as $qualifierConstraint) {
+				$result[] = $this->getCheckResultFor($qualifierContext, $qualifierConstraint);
 			}
 		}
 
@@ -507,19 +507,19 @@ 
 		$result = [];
 
 		/** @var Reference $reference */
-		foreach ( $statement->getReferences() as $reference ) {
-			foreach ( $reference->getSnaks() as $snak ) {
+		foreach ($statement->getReferences() as $reference) {
+			foreach ($reference->getSnaks() as $snak) {
 				$referenceContext = new ReferenceContext(
 					$entity, $statement, $reference, $snak
 				);
-				if ( $defaultResultsPerContext !== null ) {
-					$result = array_merge( $result, $defaultResultsPerContext( $referenceContext ) );
+				if ($defaultResultsPerContext !== null) {
+					$result = array_merge($result, $defaultResultsPerContext($referenceContext));
 				}
 				$referenceConstraints = $this->getConstraintsToUse(
 					$referenceContext->getSnak()->getPropertyId(),
 					$constraintIds
 				);
-				foreach ( $referenceConstraints as $referenceConstraint ) {
+				foreach ($referenceConstraints as $referenceConstraint) {
 					$result[] = $this->getCheckResultFor(
 						$referenceContext,
 						$referenceConstraint
@@ -538,65 +538,65 @@ 
 	 * @throws InvalidArgumentException
 	 * @return CheckResult
 	 */
-	private function getCheckResultFor( Context $context, Constraint $constraint ) {
-		if ( array_key_exists( $constraint->getConstraintTypeItemId(), $this->checkerMap ) ) {
+	private function getCheckResultFor(Context $context, Constraint $constraint) {
+		if (array_key_exists($constraint->getConstraintTypeItemId(), $this->checkerMap)) {
 			$checker = $this->checkerMap[$constraint->getConstraintTypeItemId()];
-			$result = $this->handleScope( $checker, $context, $constraint );
+			$result = $this->handleScope($checker, $context, $constraint);
 
-			if ( $result !== null ) {
-				$this->addMetadata( $context, $result );
+			if ($result !== null) {
+				$this->addMetadata($context, $result);
 				return $result;
 			}
 
-			$startTime = microtime( true );
+			$startTime = microtime(true);
 			try {
-				$result = $checker->checkConstraint( $context, $constraint );
-			} catch ( ConstraintParameterException $e ) {
-				$result = new CheckResult( $context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage() );
-			} catch ( SparqlHelperException $e ) {
-				$message = new ViolationMessage( 'wbqc-violation-message-sparql-error' );
-				$result = new CheckResult( $context, $constraint, [], CheckResult::STATUS_TODO, $message );
+				$result = $checker->checkConstraint($context, $constraint);
+			} catch (ConstraintParameterException $e) {
+				$result = new CheckResult($context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage());
+			} catch (SparqlHelperException $e) {
+				$message = new ViolationMessage('wbqc-violation-message-sparql-error');
+				$result = new CheckResult($context, $constraint, [], CheckResult::STATUS_TODO, $message);
 			}
-			$endTime = microtime( true );
+			$endTime = microtime(true);
 
-			$this->addMetadata( $context, $result );
+			$this->addMetadata($context, $result);
 
 			try {
 				$constraintStatus = $this->constraintParameterParser
-					->parseConstraintStatusParameter( $constraint->getConstraintParameters() );
-			} catch ( ConstraintParameterException $e ) {
-				$result = new CheckResult( $context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage() );
+					->parseConstraintStatusParameter($constraint->getConstraintParameters());
+			} catch (ConstraintParameterException $e) {
+				$result = new CheckResult($context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage());
 				$constraintStatus = null;
 			}
-			if ( $constraintStatus === null ) {
+			if ($constraintStatus === null) {
 				// downgrade violation to warning
-				if ( $result->getStatus() === CheckResult::STATUS_VIOLATION ) {
-					$result->setStatus( CheckResult::STATUS_WARNING );
+				if ($result->getStatus() === CheckResult::STATUS_VIOLATION) {
+					$result->setStatus(CheckResult::STATUS_WARNING);
 				}
 			} else {
-				if ( $constraintStatus !== 'mandatory' ) {
+				if ($constraintStatus !== 'mandatory') {
 					// @codeCoverageIgnoreStart
 					throw new LogicException(
-						"Unknown constraint status '$constraintStatus', " .
+						"Unknown constraint status '$constraintStatus', ".
 						"only known status is 'mandatory'"
 					);
 					// @codeCoverageIgnoreEnd
 				}
-				$result->addParameter( 'constraint_status', $constraintStatus );
+				$result->addParameter('constraint_status', $constraintStatus);
 			}
 
 			$this->loggingHelper->logConstraintCheck(
 				$context,
 				$constraint,
 				$result,
-				get_class( $checker ),
+				get_class($checker),
 				$endTime - $startTime,
 				__METHOD__
 			);
 
 			return $result;
 		} else {
-			return new CheckResult( $context, $constraint, [], CheckResult::STATUS_TODO, null );
+			return new CheckResult($context, $constraint, [], CheckResult::STATUS_TODO, null);
 		}
 	}
 
@@ -610,29 +610,29 @@ 
 				$constraint->getConstraintParameters(),
 				$constraint->getConstraintTypeItemId()
 			);
-		} catch ( ConstraintParameterException $e ) {
-			return new CheckResult( $context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage() );
+		} catch (ConstraintParameterException $e) {
+			return new CheckResult($context, $constraint, [], CheckResult::STATUS_BAD_PARAMETERS, $e->getViolationMessage());
 		}
-		if ( $checkedContextTypes === null ) {
+		if ($checkedContextTypes === null) {
 			$checkedContextTypes = $checker->getDefaultContextTypes();
 		}
-		if ( !in_array( $context->getType(), $checkedContextTypes ) ) {
-			return new CheckResult( $context, $constraint, [], CheckResult::STATUS_NOT_IN_SCOPE, null );
+		if (!in_array($context->getType(), $checkedContextTypes)) {
+			return new CheckResult($context, $constraint, [], CheckResult::STATUS_NOT_IN_SCOPE, null);
 		}
-		if ( $checker->getSupportedContextTypes()[$context->getType()] === CheckResult::STATUS_TODO ) {
-			return new CheckResult( $context, $constraint, [], CheckResult::STATUS_TODO, null );
+		if ($checker->getSupportedContextTypes()[$context->getType()] === CheckResult::STATUS_TODO) {
+			return new CheckResult($context, $constraint, [], CheckResult::STATUS_TODO, null);
 		}
 		return null;
 	}
 
-	private function addMetadata( Context $context, CheckResult $result ) {
-		$result->withMetadata( Metadata::merge( [
+	private function addMetadata(Context $context, CheckResult $result) {
+		$result->withMetadata(Metadata::merge([
 			$result->getMetadata(),
-			Metadata::ofDependencyMetadata( DependencyMetadata::merge( [
-				DependencyMetadata::ofEntityId( $context->getEntity()->getId() ),
-				DependencyMetadata::ofEntityId( $result->getConstraint()->getPropertyId() ),
-			] ) ),
-		] ) );
+			Metadata::ofDependencyMetadata(DependencyMetadata::merge([
+				DependencyMetadata::ofEntityId($context->getEntity()->getId()),
+				DependencyMetadata::ofEntityId($result->getConstraint()->getPropertyId()),
+			])),
+		]));
 	}
 
 	/**
@@ -640,12 +640,12 @@ 
 	 *
 	 * @return CheckResult[]
 	 */
-	private function sortResult( array $result ) {
-		if ( count( $result ) < 2 ) {
+	private function sortResult(array $result) {
+		if (count($result) < 2) {
 			return $result;
 		}
 
-		$sortFunction = function ( CheckResult $a, CheckResult $b ) {
+		$sortFunction = function(CheckResult $a, CheckResult $b) {
 			$orderNum = 0;
 			$order = [
 				CheckResult::STATUS_BAD_PARAMETERS => $orderNum++,
@@ -661,55 +661,55 @@ 
 			$statusA = $a->getStatus();
 			$statusB = $b->getStatus();
 
-			$orderA = array_key_exists( $statusA, $order ) ? $order[ $statusA ] : $order[ 'other' ];
-			$orderB = array_key_exists( $statusB, $order ) ? $order[ $statusB ] : $order[ 'other' ];
+			$orderA = array_key_exists($statusA, $order) ? $order[$statusA] : $order['other'];
+			$orderB = array_key_exists($statusB, $order) ? $order[$statusB] : $order['other'];
 
-			if ( $orderA === $orderB ) {
+			if ($orderA === $orderB) {
 				$cursorA = $a->getContextCursor();
 				$cursorB = $b->getContextCursor();
 
-				if ( $cursorA instanceof EntityContextCursor ) {
+				if ($cursorA instanceof EntityContextCursor) {
 					return $cursorB instanceof EntityContextCursor ? 0 : -1;
 				}
-				if ( $cursorB instanceof EntityContextCursor ) {
+				if ($cursorB instanceof EntityContextCursor) {
 					return $cursorA instanceof EntityContextCursor ? 0 : 1;
 				}
 
 				$pidA = $cursorA->getSnakPropertyId();
 				$pidB = $cursorB->getSnakPropertyId();
 
-				if ( $pidA === $pidB ) {
+				if ($pidA === $pidB) {
 					$hashA = $cursorA->getSnakHash();
 					$hashB = $cursorB->getSnakHash();
 
-					if ( $hashA === $hashB ) {
-						if ( $a instanceof NullResult ) {
+					if ($hashA === $hashB) {
+						if ($a instanceof NullResult) {
 							return $b instanceof NullResult ? 0 : -1;
 						}
-						if ( $b instanceof NullResult ) {
+						if ($b instanceof NullResult) {
 							return $a instanceof NullResult ? 0 : 1;
 						}
 
 						$typeA = $a->getConstraint()->getConstraintTypeItemId();
 						$typeB = $b->getConstraint()->getConstraintTypeItemId();
 
-						if ( $typeA == $typeB ) {
+						if ($typeA == $typeB) {
 							return 0;
 						} else {
-							return ( $typeA > $typeB ) ? 1 : -1;
+							return ($typeA > $typeB) ? 1 : -1;
 						}
 					} else {
-						return ( $hashA > $hashB ) ? 1 : -1;
+						return ($hashA > $hashB) ? 1 : -1;
 					}
 				} else {
-					return ( $pidA > $pidB ) ? 1 : -1;
+					return ($pidA > $pidB) ? 1 : -1;
 				}
 			} else {
-				return ( $orderA > $orderB ) ? 1 : -1;
+				return ($orderA > $orderB) ? 1 : -1;
 			}
 		};
 
-		uasort( $result, $sortFunction );
+		uasort($result, $sortFunction);
 
 		return $result;
 	}