wikimedia / mediawiki-extensions-WikibaseQualityExternalValidation

includes/CrossCheck/Comparer/EntityIdValueComparer.php

<?php

namespace WikibaseQuality\ExternalValidation\CrossCheck\Comparer;

use DataValues\DataValue;
use DataValues\MonolingualTextValue;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\EntityIdValue;
use Wikibase\TermIndexEntry;
use Wikibase\TermIndex;
use Wikimedia\Assert\Assert;

/**
 * @fixme This class does not compares EntityIdValues!
 * @author BP2014N1
 * @license GPL-2.0-or-later
 */
class EntityIdValueComparer implements DataValueComparer {

	/**
	 * @var TermIndex
	 */
	private $termIndex;

	/**
	 * @var StringComparer
	 */
	private $stringComparer;

	public function __construct( TermIndex $termIndex, StringComparer $stringComparer ) {
		$this->termIndex = $termIndex;
		$this->stringComparer = $stringComparer;
	}

	/**
	 * @see DataValueComparer::compare
	 *
	 * @param DataValue $value
	 * @param DataValue $comparativeValue
	 *
	 * @return string|null One of the ComparisonResult::STATUS_... constants.
	 */
	public function compare( DataValue $value, DataValue $comparativeValue ) {
		Assert::parameterType( EntityIdValue::class, $value, '$value' );
		Assert::parameterType( MonolingualTextValue::class, $comparativeValue, '$comparativeValue' );

		/**
		 * @var EntityIdValue $value
		 * @var MonolingualTextValue $comparativeValue
		 */

		$entityId = $value->getEntityId();
		$language = $comparativeValue->getLanguageCode();
		$terms = $this->getTerms( $entityId, $language );

		if ( $terms ) {

The expression $terms of type string[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			return $this->stringComparer->compareWithArray( $comparativeValue->getText(), $terms );
		}

		return null;
	}

	/**
	 * Retrieves terms (label and aliases) of a given entity in the given language
	 *
	 * @param EntityId $entityId
	 * @param string $language
	 *
	 * @return string[]
	 */
	private function getTerms( EntityId $entityId, $language ) {
		$terms = $this->termIndex->getTermsOfEntity(
			$entityId,
			[
				TermIndexEntry::TYPE_LABEL,
				TermIndexEntry::TYPE_ALIAS
			],
			[ $language ]
		);

		return array_map(
			function( TermIndexEntry $term ) {
				return $term->getText();
			},
			$terms
		);
	}

	/**
	 * @see DataValueComparer::canCompare
	 *
	 * @param DataValue $value
	 * @param DataValue $comparativeValue
	 * @return bool
	 */
	public function canCompare( DataValue $value, DataValue $comparativeValue ) {
		return $value instanceof EntityIdValue && $comparativeValue instanceof MonolingualTextValue;
	}

}