wikimedia / mediawiki-extensions-WikibaseQualityConstraints

src/Specials/SpecialConstraintReport.php

Spacing +88 added lines, -88 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-declare( strict_types = 1 );
+declare(strict_types=1);
 
 namespace WikibaseQuality\ConstraintReport\Specials;
 
@@ -91,7 +91,7 @@ 
 		Config $config,
 		StatsFactory $statsFactory
 	) {
-		parent::__construct( 'ConstraintReport' );
+		parent::__construct('ConstraintReport');
 
 		$this->entityLookup = $entityLookup;
 		$this->entityTitleLookup = $entityTitleLookup;
@@ -111,7 +111,7 @@ 
 
 		$this->violationMessageRenderer = $violationMessageRendererFactory->getViolationMessageRenderer(
 			$language,
-			$languageFallbackChainFactory->newFromLanguage( $language ),
+			$languageFallbackChainFactory->newFromLanguage($language),
 			$this->getContext()
 		);
 
@@ -145,7 +145,7 @@ 
 	 * @inheritDoc
 	 */
 	public function getDescription() {
-		return $this->msg( 'wbqc-constraintreport' );
+		return $this->msg('wbqc-constraintreport');
 	}
 
 	/**
@@ -157,75 +157,75 @@ 
 	 * @throws EntityIdParsingException
 	 * @throws UnexpectedValueException
 	 */
-	public function execute( $subPage ) {
+	public function execute($subPage) {
 		$out = $this->getOutput();
 
-		$postRequest = $this->getContext()->getRequest()->getVal( 'entityid' );
-		if ( $postRequest ) {
+		$postRequest = $this->getContext()->getRequest()->getVal('entityid');
+		if ($postRequest) {
 			try {
-				$entityId = $this->entityIdParser->parse( $postRequest );
-				$out->redirect( $this->getPageTitle( $entityId->getSerialization() )->getLocalURL() );
+				$entityId = $this->entityIdParser->parse($postRequest);
+				$out->redirect($this->getPageTitle($entityId->getSerialization())->getLocalURL());
 				return;
-			} catch ( EntityIdParsingException $e ) {
+			} catch (EntityIdParsingException $e) {
 				// fall through, error is shown later
 			}
 		}
 
 		$out->enableOOUI();
-		$out->addModules( $this->getModules() );
+		$out->addModules($this->getModules());
 
 		$this->setHeaders();
 
-		$out->addHTML( $this->getExplanationText() );
+		$out->addHTML($this->getExplanationText());
 		$this->buildEntityIdForm();
 
-		if ( $postRequest ) {
+		if ($postRequest) {
 			// must be an invalid entity ID (otherwise we would have redirected and returned above)
 			$out->addHTML(
-				$this->buildNotice( 'wbqc-constraintreport-invalid-entity-id', true )
+				$this->buildNotice('wbqc-constraintreport-invalid-entity-id', true)
 			);
 			return;
 		}
 
-		if ( !$subPage ) {
+		if (!$subPage) {
 			return;
 		}
 
-		if ( !is_string( $subPage ) ) {
-			throw new InvalidArgumentException( '$subPage must be string.' );
+		if (!is_string($subPage)) {
+			throw new InvalidArgumentException('$subPage must be string.');
 		}
 
 		try {
-			$entityId = $this->entityIdParser->parse( $subPage );
-		} catch ( EntityIdParsingException $e ) {
+			$entityId = $this->entityIdParser->parse($subPage);
+		} catch (EntityIdParsingException $e) {
 			$out->addHTML(
-				$this->buildNotice( 'wbqc-constraintreport-invalid-entity-id', true )
+				$this->buildNotice('wbqc-constraintreport-invalid-entity-id', true)
 			);
 			return;
 		}
 
-		if ( !$this->entityLookup->hasEntity( $entityId ) ) {
+		if (!$this->entityLookup->hasEntity($entityId)) {
 			$out->addHTML(
-				$this->buildNotice( 'wbqc-constraintreport-not-existent-entity', true )
+				$this->buildNotice('wbqc-constraintreport-not-existent-entity', true)
 			);
 			return;
 		}
 
 		$baseKey = 'wikibase.quality.constraints.specials.specialConstraintReport.executeCheck';
-		$metric = $this->statsFactory->getCounter( 'special_constraint_report_execute_check_total' );
-		$metric->copyToStatsdAt( $baseKey )->increment();
-		$results = $this->constraintChecker->checkAgainstConstraintsOnEntityId( $entityId );
+		$metric = $this->statsFactory->getCounter('special_constraint_report_execute_check_total');
+		$metric->copyToStatsdAt($baseKey)->increment();
+		$results = $this->constraintChecker->checkAgainstConstraintsOnEntityId($entityId);
 
-		if ( $results !== [] ) {
+		if ($results !== []) {
 			$out->addHTML(
-				$this->buildResultHeader( $entityId )
-				. $this->buildSummary( $results )
-				. $this->buildResultTable( $entityId, $results )
+				$this->buildResultHeader($entityId)
+				. $this->buildSummary($results)
+				. $this->buildResultTable($entityId, $results)
 			);
 		} else {
 			$out->addHTML(
-				$this->buildResultHeader( $entityId )
-				. $this->buildNotice( 'wbqc-constraintreport-empty-result' )
+				$this->buildResultHeader($entityId)
+				. $this->buildNotice('wbqc-constraintreport-empty-result')
 			);
 		}
 	}
@@ -241,16 +241,16 @@ 
 				'name' => 'entityid',
 				'label-message' => 'wbqc-constraintreport-form-entityid-label',
 				'cssclass' => 'wbqc-constraintreport-form-entity-id',
-				'placeholder' => $this->msg( 'wbqc-constraintreport-form-entityid-placeholder' )->escaped(),
+				'placeholder' => $this->msg('wbqc-constraintreport-form-entityid-placeholder')->escaped(),
 				'required' => true,
 			],
 		];
-		$htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext(), 'wbqc-constraintreport-form' );
-		$htmlForm->setSubmitText( $this->msg( 'wbqc-constraintreport-form-submit-label' )->escaped() );
-		$htmlForm->setSubmitCallback( static function () {
+		$htmlForm = HTMLForm::factory('ooui', $formDescriptor, $this->getContext(), 'wbqc-constraintreport-form');
+		$htmlForm->setSubmitText($this->msg('wbqc-constraintreport-form-submit-label')->escaped());
+		$htmlForm->setSubmitCallback(static function() {
 			return false;
 		} );
-		$htmlForm->setMethod( 'post' );
+		$htmlForm->setMethod('post');
 		$htmlForm->show();
 	}
 
@@ -264,9 +264,9 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function buildNotice( string $messageKey, bool $error = false ): string {
+	private function buildNotice(string $messageKey, bool $error = false): string {
 		$cssClasses = 'wbqc-constraintreport-notice';
-		if ( $error ) {
+		if ($error) {
 			$cssClasses .= ' wbqc-constraintreport-notice-error';
 		}
 
@@ -275,7 +275,7 @@ 
 				[
 					'class' => $cssClasses,
 				],
-				$this->msg( $messageKey )->escaped()
+				$this->msg($messageKey)->escaped()
 			);
 	}
 
@@ -285,16 +285,16 @@ 
 	private function getExplanationText(): string {
 		return Html::rawElement(
 			'div',
-			[ 'class' => 'wbqc-explanation' ],
+			['class' => 'wbqc-explanation'],
 			Html::rawElement(
 				'p',
 				[],
-				$this->msg( 'wbqc-constraintreport-explanation-part-one' )->escaped()
+				$this->msg('wbqc-constraintreport-explanation-part-one')->escaped()
 			)
 			. Html::rawElement(
 				'p',
 				[],
-				$this->msg( 'wbqc-constraintreport-explanation-part-two' )->escaped()
+				$this->msg('wbqc-constraintreport-explanation-part-two')->escaped()
 			)
 		);
 	}
@@ -305,31 +305,31 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function buildResultTable( EntityId $entityId, array $results ): string {
+	private function buildResultTable(EntityId $entityId, array $results): string {
 		// Set table headers
 		$table = new HtmlTableBuilder(
 			[
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-status' )->text(),
+					$this->msg('wbqc-constraintreport-result-table-header-status')->text(),
 					true
 				),
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-property' )->text(),
+					$this->msg('wbqc-constraintreport-result-table-header-property')->text(),
 					true
 				),
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-message' )->text(),
+					$this->msg('wbqc-constraintreport-result-table-header-message')->text(),
 					true
 				),
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-constraint' )->text(),
+					$this->msg('wbqc-constraintreport-result-table-header-constraint')->text(),
 					true
 				),
 			]
 		);
 
-		foreach ( $results as $result ) {
-			$table = $this->appendToResultTable( $table, $entityId, $result );
+		foreach ($results as $result) {
+			$table = $this->appendToResultTable($table, $entityId, $result);
 		}
 
 		return $table->toHtml();
@@ -341,35 +341,35 @@ 
 		CheckResult $result
 	): HtmlTableBuilder {
 		$message = $result->getMessage();
-		if ( $message === null ) {
+		if ($message === null) {
 			// no row for this result
 			return $table;
 		}
 
 		// Status column
-		$statusColumn = $this->formatStatus( $result->getStatus() );
+		$statusColumn = $this->formatStatus($result->getStatus());
 
 		// Property column
-		$propertyId = new NumericPropertyId( $result->getContextCursor()->getSnakPropertyId() );
+		$propertyId = new NumericPropertyId($result->getContextCursor()->getSnakPropertyId());
 		$propertyColumn = $this->getClaimLink(
 			$entityId,
 			$propertyId,
-			$this->entityIdLabelFormatter->formatEntityId( $propertyId )
+			$this->entityIdLabelFormatter->formatEntityId($propertyId)
 		);
 
 		// Message column
-		$messageColumn = $this->violationMessageRenderer->render( $message );
+		$messageColumn = $this->violationMessageRenderer->render($message);
 
 		// Constraint column
 		$constraintTypeItemId = $result->getConstraint()->getConstraintTypeItemId();
 		try {
-			$constraintTypeLabel = $this->entityIdLabelFormatter->formatEntityId( new ItemId( $constraintTypeItemId ) );
-		} catch ( InvalidArgumentException $e ) {
-			$constraintTypeLabel = htmlspecialchars( $constraintTypeItemId );
+			$constraintTypeLabel = $this->entityIdLabelFormatter->formatEntityId(new ItemId($constraintTypeItemId));
+		} catch (InvalidArgumentException $e) {
+			$constraintTypeLabel = htmlspecialchars($constraintTypeItemId);
 		}
 		$constraintColumn = $this->getClaimLink(
 			$propertyId,
-			new NumericPropertyId( $this->config->get( 'WBQualityConstraintsPropertyConstraintId' ) ),
+			new NumericPropertyId($this->config->get('WBQualityConstraintsPropertyConstraintId')),
 			$constraintTypeLabel
 		);
 
@@ -377,16 +377,16 @@ 
 		$table->appendRow(
 			[
 				new HtmlTableCellBuilder(
-					new HtmlArmor( $statusColumn )
+					new HtmlArmor($statusColumn)
 				),
 				new HtmlTableCellBuilder(
-					new HtmlArmor( $propertyColumn )
+					new HtmlArmor($propertyColumn)
 				),
 				new HtmlTableCellBuilder(
-					new HtmlArmor( $messageColumn )
+					new HtmlArmor($messageColumn)
 				),
 				new HtmlTableCellBuilder(
-					new HtmlArmor( $constraintColumn )
+					new HtmlArmor($constraintColumn)
 				),
 			]
 		);
@@ -401,15 +401,15 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function buildResultHeader( EntityId $entityId ): string {
-		$entityLink = sprintf( '%s (%s)',
-							   $this->entityIdLinkFormatter->formatEntityId( $entityId ),
-							   htmlspecialchars( $entityId->getSerialization() ) );
+	protected function buildResultHeader(EntityId $entityId): string {
+		$entityLink = sprintf('%s (%s)',
+							   $this->entityIdLinkFormatter->formatEntityId($entityId),
+							   htmlspecialchars($entityId->getSerialization()));
 
 		return Html::rawElement(
 			'h3',
 			[],
-			sprintf( '%s %s', $this->msg( 'wbqc-constraintreport-result-headline' )->escaped(), $entityLink )
+			sprintf('%s %s', $this->msg('wbqc-constraintreport-result-headline')->escaped(), $entityLink)
 		);
 	}
 
@@ -420,24 +420,24 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function buildSummary( array $results ): string {
+	protected function buildSummary(array $results): string {
 		$statuses = [];
-		foreach ( $results as $result ) {
-			$status = strtolower( $result->getStatus() );
-			$statuses[$status] = isset( $statuses[$status] ) ? $statuses[$status] + 1 : 1;
+		foreach ($results as $result) {
+			$status = strtolower($result->getStatus());
+			$statuses[$status] = isset($statuses[$status]) ? $statuses[$status] + 1 : 1;
 		}
 
 		$statusElements = [];
-		foreach ( $statuses as $status => $count ) {
-			if ( $count > 0 ) {
+		foreach ($statuses as $status => $count) {
+			if ($count > 0) {
 				$statusElements[] =
-					$this->formatStatus( $status )
+					$this->formatStatus($status)
 					. ': '
 					. $count;
 			}
 		}
 
-		return Html::rawElement( 'p', [], implode( ', ', $statusElements ) );
+		return Html::rawElement('p', [], implode(', ', $statusElements));
 	}
 
 	/**
@@ -449,8 +449,8 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function formatStatus( string $status ): string {
-		$messageName = "wbqc-constraintreport-status-" . strtolower( $status );
+	private function formatStatus(string $status): string {
+		$messageName = "wbqc-constraintreport-status-".strtolower($status);
 		$statusIcons = [
 			CheckResult::STATUS_SUGGESTION => [
 				'icon' => 'suggestion-constraint-violation',
@@ -467,25 +467,25 @@ 
 			],
 		];
 
-		if ( array_key_exists( $status, $statusIcons ) ) {
-			$iconWidget = new IconWidget( $statusIcons[$status] );
-			$iconHtml = $iconWidget->toString() . ' ';
+		if (array_key_exists($status, $statusIcons)) {
+			$iconWidget = new IconWidget($statusIcons[$status]);
+			$iconHtml = $iconWidget->toString().' ';
 		} else {
 			$iconHtml = '';
 		}
 
-		$labelWidget = new LabelWidget( [
-			'label' => $this->msg( $messageName )->text(),
-		] );
+		$labelWidget = new LabelWidget([
+			'label' => $this->msg($messageName)->text(),
+		]);
 		$labelHtml = $labelWidget->toString();
 
 		$formattedStatus =
 			Html::rawElement(
 				'span',
 				[
-					'class' => 'wbqc-status wbqc-status-' . $status,
+					'class' => 'wbqc-status wbqc-status-'.$status,
 				],
-				$iconHtml . $labelHtml
+				$iconHtml.$labelHtml
 			);
 
 		return $formattedStatus;
@@ -508,7 +508,7 @@ 
 		return Html::rawElement(
 			'a',
 			[
-				'href' => $this->getClaimUrl( $entityId, $propertyId ),
+				'href' => $this->getClaimUrl($entityId, $propertyId),
 				'target' => '_blank',
 			],
 			$text
@@ -522,8 +522,8 @@ 
 		EntityId $entityId,
 		NumericPropertyId $propertyId
 	): string {
-		$title = $this->entityTitleLookup->getTitleForId( $entityId );
-		$entityUrl = sprintf( '%s#%s', $title->getLocalURL(), $propertyId->getSerialization() );
+		$title = $this->entityTitleLookup->getTitleForId($entityId);
+		$entityUrl = sprintf('%s#%s', $title->getLocalURL(), $propertyId->getSerialization());
 
 		return $entityUrl;
 	}