wikimedia / mediawiki-extensions-Wikibase

lib/includes/TermLanguageFallbackChain.php

<?php
declare( strict_types = 1 );

namespace Wikibase\Lib;

use InvalidArgumentException;
use Language;

/**
 * FIXME: this class is not a language fallback chain. It takes and uses a fallback chain.
 * The name thus needs to be updated to not be misleading.
 *
 * @license GPL-2.0-or-later
 * @author Liangent < liangent@gmail.com >
 * @author Thiemo Kreuz
 */
class TermLanguageFallbackChain {

	/**
	 * @var LanguageWithConversion[]
	 */
	private $chain;

	/**
	 * @param LanguageWithConversion[] $chain
	 * @param ContentLanguages|null $termLanguages
	 */
	public function __construct( array $chain, ContentLanguages $termLanguages ) {
		$this->chain = array_values( array_filter(

It seems like array_values(array_filter($chain, static function ($language) use($termLanguages) { return $termLanguages->hasLanguage($language->getLanguageCode()); })) of type array<integer,?> is incompatible with the declared type array<integer,object<Wikibase\Lib\LanguageWithConversion>> of property $chain.

			$chain,
			static function ( $language ) use ( $termLanguages ) {
				return $termLanguages->hasLanguage( $language->getLanguageCode() );
			}
		) );
		if ( !empty( $chain ) && empty( $this->chain ) ) {
			$this->chain = [ LanguageWithConversion::factory( 'en' ) ];
		}
	}

	/**
	 * Get raw fallback chain as an array. Semi-private for testing.
	 *
	 * @return LanguageWithConversion[]
	 */
	public function getFallbackChain(): array {
		return $this->chain;
	}

	/**
	 * Return language codes to use when fetching entries from the database.
	 *
	 * @see LanguageWithConversion::getFetchLanguageCode
	 *
	 * @return string[]
	 */
	public function getFetchLanguageCodes(): array {
		$codes = [];

		foreach ( $this->chain as $language ) {
			$codes[] = $language->getFetchLanguageCode();
		}

		return $codes;
	}

	/**
	 * Try to fetch the best value in a multilingual data array.
	 *
	 * @param string[]|array[] $data Multilingual data with language codes as keys
	 *
	 * @throws InvalidArgumentException
	 * @return string[]|null of three items: array(
	 * 	'value' => finally fetched and translated value
	 * 	'language' => language code of the language which final value is in
	 * 	'source' => language code of the language where the value is translated from
	 * ), or null when no "acceptable" data can be found.
	 */
	public function extractPreferredValue( array $data ): ?array {
		if ( empty( $data ) ) {
			return null;
		}

		foreach ( $this->chain as $languageWithConversion ) {
			$languageCode = $languageWithConversion->getFetchLanguageCode();

			if ( isset( $data[$languageCode] ) ) {
				$value = $data[$languageCode];

				// Data from an EntityInfoBuilder is already made of pre-build arrays
				if ( is_array( $value ) ) {
					$value = $value['value'];
				}

				return $this->getValueArray(
					$languageWithConversion->translate( $value ),
					$languageWithConversion->getLanguageCode(),
					$languageWithConversion->getSourceLanguageCode()
				);
			}
		}

		return null;
	}

	/**
	 * Try to fetch the best value in a multilingual data array first.
	 * If no "acceptable" value exists, return any value known.
	 *
	 * @param string[]|array[] $data Multilingual data with language codes as keys
	 *
	 * @return string[]|null of three items: array(
	 * 	'value' => finally fetched and translated value
	 * 	'language' => language code of the language which final value is in
	 * 	'source' => language code of the language where the value is translated from
	 * ), or null when no data with a valid language code can be found.
	 */
	public function extractPreferredValueOrAny( array $data ): ?array {
		$preferred = $this->extractPreferredValue( $data );

		if ( $preferred !== null ) {
			return $preferred;
		}

		foreach ( $data as $languageCode => $value ) {
			if ( Language::isValidCode( $languageCode ) ) {
				// We cannot translate here, we do not have a LanguageWithConversion object
				return $this->getValueArray( $value, $languageCode );

It seems like $value defined by $value on line 124 can also be of type array; however, Wikibase\Lib\TermLanguageFallbackChain::getValueArray() does only seem to accept string|array<integer,string>, maybe add an additional type check?

			}
		}

		return null;
	}

	/**
	 * @param string|string[] $value
	 * @param string $languageCode
	 * @param string|null $sourceLanguageCode
	 *
	 * @return string[]
	 */
	private function getValueArray( $value, string $languageCode, ?string $sourceLanguageCode = null ): array {
		if ( !is_array( $value ) ) {
			$value = [
				'value' => $value,
				'language' => $languageCode,
				'source' => $sourceLanguageCode,
			];
		}

		return $value;
	}

}