wikimedia / mediawiki-extensions-WikibaseQualityConstraints

src/Specials/SpecialConstraintReport.php

Spacing +109 added lines, -110 removed lines

@@ -133,7 +133,7 @@ 
 		Config $config,
 		IBufferingStatsdDataFactory $dataFactory
 	) {
-		parent::__construct( 'ConstraintReport' );
+		parent::__construct('ConstraintReport');
 
 		$this->entityLookup = $entityLookup;
 		$this->entityTitleLookup = $entityTitleLookup;
@@ -142,13 +142,13 @@ 
 		$language = $this->getLanguage();
 
 		$formatterOptions = new FormatterOptions();
-		$formatterOptions->setOption( SnakFormatter::OPT_LANG, $language->getCode() );
+		$formatterOptions->setOption(SnakFormatter::OPT_LANG, $language->getCode());
 		$this->dataValueFormatter = $valueFormatterFactory->getValueFormatter(
 			SnakFormatter::FORMAT_HTML,
 			$formatterOptions
 		);
 
-		$labelLookup = $fallbackLabelDescLookupFactory->newLabelDescriptionLookup( $language );
+		$labelLookup = $fallbackLabelDescLookupFactory->newLabelDescriptionLookup($language);
 
 		$this->entityIdLabelFormatter = $entityIdLabelFormatterFactory->getEntityIdFormatter(
 			$labelLookup
@@ -181,7 +181,7 @@ 
 	 * @return array
 	 */
 	private function getModules() {
-		return [ 'SpecialConstraintReportPage' ];
+		return ['SpecialConstraintReportPage'];
 	}
 
 	/**
@@ -199,7 +199,7 @@ 
 	 * @return string
 	 */
 	public function getDescription() {
-		return $this->msg( 'wbqc-constraintreport' )->escaped();
+		return $this->msg('wbqc-constraintreport')->escaped();
 	}
 
 	/**
@@ -211,42 +211,42 @@ 
 	 * @throws EntityIdParsingException
 	 * @throws UnexpectedValueException
 	 */
-	public function execute( $subPage ) {
+	public function execute($subPage) {
 		$out = $this->getOutput();
 
-		$postRequest = $this->getContext()->getRequest()->getVal( 'entityid' );
-		if ( $postRequest ) {
-			$out->redirect( $this->getPageTitle( strtoupper( $postRequest ) )->getLocalURL() );
+		$postRequest = $this->getContext()->getRequest()->getVal('entityid');
+		if ($postRequest) {
+			$out->redirect($this->getPageTitle(strtoupper($postRequest))->getLocalURL());
 			return;
 		}
 
-		$out->addModules( $this->getModules() );
+		$out->addModules($this->getModules());
 
 		$this->setHeaders();
 
-		$out->addHTML( $this->getExplanationText() );
+		$out->addHTML($this->getExplanationText());
 		$this->buildEntityIdForm();
 
-		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;
 		}
@@ -254,18 +254,18 @@ 
 		$this->dataFactory->increment(
 			'wikibase.quality.constraints.specials.specialConstraintReport.executeCheck'
 		);
-		$results = $this->constraintChecker->checkAgainstConstraintsOnEntityId( $entityId );
+		$results = $this->constraintChecker->checkAgainstConstraintsOnEntityId($entityId);
 
-		if ( count( $results ) > 0 ) {
+		if (count($results) > 0) {
 			$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')
 			);
 		}
 	}
@@ -281,15 +281,15 @@ 
 				'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()
 			]
 		];
-		$htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext(), 'wbqc-constraintreport-form' );
-		$htmlForm->setSubmitText( $this->msg( 'wbqc-constraintreport-form-submit-label' )->escaped() );
-		$htmlForm->setSubmitCallback( function() {
+		$htmlForm = HTMLForm::factory('ooui', $formDescriptor, $this->getContext(), 'wbqc-constraintreport-form');
+		$htmlForm->setSubmitText($this->msg('wbqc-constraintreport-form-submit-label')->escaped());
+		$htmlForm->setSubmitCallback(function() {
 			return false;
 		} );
-		$htmlForm->setMethod( 'post' );
+		$htmlForm->setMethod('post');
 		$htmlForm->show();
 	}
 
@@ -303,16 +303,16 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function buildNotice( $messageKey, $error = false ) {
-		if ( !is_string( $messageKey ) ) {
-			throw new InvalidArgumentException( '$message must be string.' );
+	private function buildNotice($messageKey, $error = false) {
+		if (!is_string($messageKey)) {
+			throw new InvalidArgumentException('$message must be string.');
 		}
-		if ( !is_bool( $error ) ) {
-			throw new InvalidArgumentException( '$error must be bool.' );
+		if (!is_bool($error)) {
+			throw new InvalidArgumentException('$error must be bool.');
 		}
 
 		$cssClasses = 'wbqc-constraintreport-notice';
-		if ( $error ) {
+		if ($error) {
 			$cssClasses .= ' wbqc-constraintreport-notice-error';
 		}
 
@@ -321,7 +321,7 @@ 
 				[
 					'class' => $cssClasses
 				],
-				$this->msg( $messageKey )->escaped()
+				$this->msg($messageKey)->escaped()
 			);
 	}
 
@@ -331,16 +331,16 @@ 
 	private function getExplanationText() {
 		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()
 			)
 		);
 	}
@@ -351,71 +351,70 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function buildResultTable( EntityId $entityId, array $results ) {
+	private function buildResultTable(EntityId $entityId, array $results) {
 		// Set table headers
 		$table = new HtmlTableBuilder(
 			[
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-status' )->escaped(),
+					$this->msg('wbqc-constraintreport-result-table-header-status')->escaped(),
 					true
 				),
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-claim' )->escaped(),
+					$this->msg('wbqc-constraintreport-result-table-header-claim')->escaped(),
 					true
 				),
 				new HtmlTableHeaderBuilder(
-					$this->msg( 'wbqc-constraintreport-result-table-header-constraint' )->escaped(),
+					$this->msg('wbqc-constraintreport-result-table-header-constraint')->escaped(),
 					true
 				)
 			]
 		);
 
-		foreach ( $results as $result ) {
-			$table = $this->appendToResultTable( $table, $entityId, $result );
+		foreach ($results as $result) {
+			$table = $this->appendToResultTable($table, $entityId, $result);
 		}
 
 		return $table->toHtml();
 	}
 
-	private function appendToResultTable( HtmlTableBuilder $table, EntityId $entityId, CheckResult $result ) {
+	private function appendToResultTable(HtmlTableBuilder $table, EntityId $entityId, CheckResult $result) {
 		// Status column
 		$statusColumn = $this->buildTooltipElement(
-			$this->formatStatus( $result->getStatus() ),
+			$this->formatStatus($result->getStatus()),
 			$result->getMessage() !== null ?
-				$this->violationMessageRenderer->render( $result->getMessage() ) :
-				null,
+				$this->violationMessageRenderer->render($result->getMessage()) : null,
 			'[?]'
 		);
 
 		// Claim column
-		$property = $this->entityIdLabelFormatter->formatEntityId( $result->getContext()->getSnak()->getPropertyId() );
-		if ( $result->getSnakType() === 'value' ) {
-			$value = $this->constraintParameterRenderer->formatValue( $result->getDataValue() );
+		$property = $this->entityIdLabelFormatter->formatEntityId($result->getContext()->getSnak()->getPropertyId());
+		if ($result->getSnakType() === 'value') {
+			$value = $this->constraintParameterRenderer->formatValue($result->getDataValue());
 		} else {
-			$value = htmlspecialchars( $result->getSnakType() );
+			$value = htmlspecialchars($result->getSnakType());
 		}
 
 		$claimColumn = $this->getClaimLink(
 			$entityId,
 			$result->getContext()->getSnak()->getPropertyId(),
-			$property . ': ' . $value
+			$property.': '.$value
 		);
 
 		// 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);
 		}
 		$constraintLink = $this->getClaimLink(
 			$result->getContext()->getSnak()->getPropertyId(),
-			new PropertyId( $this->config->get( 'WBQualityConstraintsPropertyConstraintId' ) ),
+			new PropertyId($this->config->get('WBQualityConstraintsPropertyConstraintId')),
 			$constraintTypeLabel
 		);
 		$constraintColumn = $this->buildExpandableElement(
 			$constraintLink,
-			$this->constraintParameterRenderer->formatParameters( $result->getParameters() ),
+			$this->constraintParameterRenderer->formatParameters($result->getParameters()),
 			'[...]'
 		);
 
@@ -450,15 +449,15 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function buildResultHeader( EntityId $entityId ) {
-		$entityLink = sprintf( '%s (%s)',
-							   $this->entityIdLinkFormatter->formatEntityId( $entityId ),
-							   htmlspecialchars( $entityId->getSerialization() ) );
+	protected function buildResultHeader(EntityId $entityId) {
+		$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)
 		);
 	}
 
@@ -469,24 +468,24 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function buildSummary( array $results ) {
+	protected function buildSummary(array $results) {
 		$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));
 	}
 
 	/**
@@ -501,15 +500,15 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function buildTooltipElement( $content, $tooltipContent, $indicator ) {
-		if ( !is_string( $content ) ) {
-			throw new InvalidArgumentException( '$content has to be string.' );
+	protected function buildTooltipElement($content, $tooltipContent, $indicator) {
+		if (!is_string($content)) {
+			throw new InvalidArgumentException('$content has to be string.');
 		}
-		if ( $tooltipContent && ( !is_string( $tooltipContent ) ) ) {
-			throw new InvalidArgumentException( '$tooltipContent, if provided, has to be string.' );
+		if ($tooltipContent && (!is_string($tooltipContent))) {
+			throw new InvalidArgumentException('$tooltipContent, if provided, has to be string.');
 		}
 
-		if ( empty( $tooltipContent ) ) {
+		if (empty($tooltipContent)) {
 			return $content;
 		}
 
@@ -526,13 +525,13 @@ 
 			[
 				'class' => 'wbqc-indicator'
 			],
-			htmlspecialchars( $indicator ) . $tooltip
+			htmlspecialchars($indicator).$tooltip
 		);
 
 		return Html::rawElement(
 			'span',
 			[],
-			sprintf( '%s %s', $content, $tooltipIndicator )
+			sprintf('%s %s', $content, $tooltipIndicator)
 		);
 	}
 
@@ -548,15 +547,15 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function buildExpandableElement( $content, $expandableContent, $indicator ) {
-		if ( !is_string( $content ) ) {
-			throw new InvalidArgumentException( '$content has to be string.' );
+	protected function buildExpandableElement($content, $expandableContent, $indicator) {
+		if (!is_string($content)) {
+			throw new InvalidArgumentException('$content has to be string.');
 		}
-		if ( $expandableContent && ( !is_string( $expandableContent ) ) ) {
-			throw new InvalidArgumentException( '$tooltipContent, if provided, has to be string.' );
+		if ($expandableContent && (!is_string($expandableContent))) {
+			throw new InvalidArgumentException('$tooltipContent, if provided, has to be string.');
 		}
 
-		if ( empty( $expandableContent ) ) {
+		if (empty($expandableContent)) {
 			return $content;
 		}
 
@@ -576,7 +575,7 @@ 
 			$expandableContent
 		);
 
-		return sprintf( '%s %s %s', $content, $tooltipIndicator, $expandableContent );
+		return sprintf('%s %s %s', $content, $tooltipIndicator, $expandableContent);
 	}
 
 	/**
@@ -588,16 +587,16 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function formatStatus( $status ) {
-		$messageName = "wbqc-constraintreport-status-" . strtolower( $status );
+	private function formatStatus($status) {
+		$messageName = "wbqc-constraintreport-status-".strtolower($status);
 
 		$formattedStatus =
 			Html::element(
 				'span',
 				[
-					'class' => 'wbqc-status wbqc-status-' . $status
+					'class' => 'wbqc-status wbqc-status-'.$status
 				],
-				$this->msg( $messageName )->text()
+				$this->msg($messageName)->text()
 			);
 
 		return $formattedStatus;
@@ -613,26 +612,26 @@ 
 	 *
 	 * @return string HTML
 	 */
-	protected function formatDataValues( $dataValues, $separator = ', ' ) {
-		if ( $dataValues instanceof DataValue ) {
-			$dataValues = [ $dataValues ];
-		} elseif ( !is_array( $dataValues ) ) {
-			throw new InvalidArgumentException( '$dataValues has to be instance of DataValue or an array of DataValues.' );
+	protected function formatDataValues($dataValues, $separator = ', ') {
+		if ($dataValues instanceof DataValue) {
+			$dataValues = [$dataValues];
+		} elseif (!is_array($dataValues)) {
+			throw new InvalidArgumentException('$dataValues has to be instance of DataValue or an array of DataValues.');
 		}
 
 		$formattedDataValues = [];
-		foreach ( $dataValues as $dataValue ) {
-			if ( !( $dataValue instanceof DataValue ) ) {
-				throw new InvalidArgumentException( '$dataValues has to be instance of DataValue or an array of DataValues.' );
+		foreach ($dataValues as $dataValue) {
+			if (!($dataValue instanceof DataValue)) {
+				throw new InvalidArgumentException('$dataValues has to be instance of DataValue or an array of DataValues.');
 			}
-			if ( $dataValue instanceof EntityIdValue ) {
-				$formattedDataValues[ ] = $this->entityIdLabelFormatter->formatEntityId( $dataValue->getEntityId() );
+			if ($dataValue instanceof EntityIdValue) {
+				$formattedDataValues[] = $this->entityIdLabelFormatter->formatEntityId($dataValue->getEntityId());
 			} else {
-				$formattedDataValues[ ] = $this->dataValueFormatter->format( $dataValue );
+				$formattedDataValues[] = $this->dataValueFormatter->format($dataValue);
 			}
 		}
 
-		return implode( $separator, $formattedDataValues );
+		return implode($separator, $formattedDataValues);
 	}
 
 	/**
@@ -644,11 +643,11 @@ 
 	 *
 	 * @return string HTML
 	 */
-	private function getClaimLink( EntityId $entityId, PropertyId $propertyId, $text ) {
+	private function getClaimLink(EntityId $entityId, PropertyId $propertyId, $text) {
 		return Html::rawElement(
 			'a',
 			[
-				'href' => $this->getClaimUrl( $entityId, $propertyId ),
+				'href' => $this->getClaimUrl($entityId, $propertyId),
 				'target' => '_blank'
 			],
 			$text
@@ -663,9 +662,9 @@ 
 	 *
 	 * @return string
 	 */
-	private function getClaimUrl( EntityId $entityId, PropertyId $propertyId ) {
-		$title = $this->entityTitleLookup->getTitleForId( $entityId );
-		$entityUrl = sprintf( '%s#%s', $title->getLocalURL(), $propertyId->getSerialization() );
+	private function getClaimUrl(EntityId $entityId, PropertyId $propertyId) {
+		$title = $this->entityTitleLookup->getTitleForId($entityId);
+		$entityUrl = sprintf('%s#%s', $title->getLocalURL(), $propertyId->getSerialization());
 
 		return $entityUrl;
 	}