Merge "lib: Use type declaration on undocumented private functions"

lib/includes/Formatters/CommonsInlineImageFormatter.php

@@ -116,7 +116,7 @@ public function format( $value ) {
 		return $this->wrapThumb( $title, $thumb->toHtml() ) . $this->getCaptionHtml( $title, $file );
 	}
 
-	private function getThumbWidth( $thumbSize ) {
+	private function getThumbWidth( int $thumbSize ): int {
 		return $this->thumbLimits[$thumbSize] ?? self::FALLBACK_THUMBNAIL_WIDTH;
 	}
 

lib/includes/Formatters/FormatterLabelDescriptionLookupFactory.php

@@ -74,7 +74,7 @@ public function getLabelDescriptionLookup( FormatterOptions $options ) {
 		}
 	}
 
-	private function newLanguageFallbackLabelDescriptionLookup( FormatterOptions $options ) {
+	private function newLanguageFallbackLabelDescriptionLookup( FormatterOptions $options ): CachingFallbackLabelDescriptionLookup {
 		$fallbackChain = $options->getOption( self::OPT_LANGUAGE_FALLBACK_CHAIN );
 
 		if ( !( $fallbackChain instanceof TermLanguageFallbackChain ) ) {
@@ -90,7 +90,7 @@ private function newLanguageFallbackLabelDescriptionLookup( FormatterOptions $op
 		);
 	}
 
-	private function newLanguageLabelDescriptionLookup( FormatterOptions $options ) {
+	private function newLanguageLabelDescriptionLookup( FormatterOptions $options ): LanguageLabelDescriptionLookup {
 		$languageCode = $options->getOption( ValueFormatter::OPT_LANG );
 
 		if ( !is_string( $languageCode ) ) {

lib/includes/Formatters/GlobeCoordinateInlineWikitextKartographerFormatter.php

@@ -47,7 +47,7 @@ public function format( $value ) {
 		return wfEscapeWikiText( $this->coordinateFormatter->format( $value ) );
 	}
 
-	private function formatEarthCoordinate( GlobeCoordinateValue $value ) {
+	private function formatEarthCoordinate( GlobeCoordinateValue $value ): string {
 		return Html::rawElement( 'maplink', [
 			'latitude' => $value->getLatitude(),
 			'longitude' => $value->getLongitude(),

lib/includes/Formatters/WikibaseValueFormatterBuilders.php

@@ -186,7 +186,7 @@ public function __construct(
 		$this->languageFactory = $languageFactory;
 	}
 
-	private function newPlainEntityIdFormatter( FormatterOptions $options ) {
+	private function newPlainEntityIdFormatter( FormatterOptions $options ): EntityIdValueFormatter {
 		$labelDescriptionLookup = $this->labelDescriptionLookupFactory->getLabelDescriptionLookup( $options );
 		return new EntityIdValueFormatter(
 			new EntityIdLabelFormatter( $labelDescriptionLookup )
@@ -270,14 +270,14 @@ public function newItemIdHtmlLinkFormatter( FormatterOptions $options ) {
 		);
 	}
 
-	private function getNonCachingLookup( FormatterOptions $options ) {
+	private function getNonCachingLookup( FormatterOptions $options ): LanguageFallbackLabelDescriptionLookup {
 		return new LanguageFallbackLabelDescriptionLookup(
 			new EntityRetrievingTermLookup( $this->entityLookup ),
 			$options->getOption( FormatterLabelDescriptionLookupFactory::OPT_LANGUAGE_FALLBACK_CHAIN )
 		);
 	}
 
-	private function getLabelDescriptionLookup( FormatterOptions $options ) {
+	private function getLabelDescriptionLookup( FormatterOptions $options ): CachingFallbackLabelDescriptionLookup {
 		return new CachingFallbackLabelDescriptionLookup(
 			$this->cache,
 			$this->redirectResolvingLatestRevisionLookup,

lib/includes/Formatters/WikitextExternalIdentifierFormatter.php

@@ -28,7 +28,7 @@ public function __construct( SnakUrlExpander $urlExpander ) {
 		$this->urlExpander = $urlExpander;
 	}
 
-	private function escapeWikitextInUrl( $url ) {
+	private function escapeWikitextInUrl( string $url ): string {
 		return str_replace( [
 			'[', ']', '<', '>', '\'', ' ', "\r", "\n", "\t",
 		], [

lib/includes/Interactors/MatchingTermsLookupSearchInteractor.php

@@ -268,7 +268,7 @@ private function convertToSearchResult( TermIndexEntry $termIndexEntry ) {
 		);
 	}
 
-	private function getTermIndexOptions() {
+	private function getTermIndexOptions(): array {
 		return [
 			'caseSensitive' => $this->termSearchOptions->getIsCaseSensitive(),
 			'prefixSearch' => $this->termSearchOptions->getIsPrefixSearch(),

lib/includes/LanguageFallbackChainFactory.php

@@ -13,6 +13,7 @@
 use MediaWiki\MediaWikiServices;
 use MediaWiki\Registration\ExtensionRegistry;
 use MediaWiki\User\User;
+use MediaWiki\User\UserIdentity;
 
 /**
  * Object creating TermLanguageFallbackChain objects in Wikibase.
@@ -256,7 +257,7 @@ public function newFromUserAndLanguageCode( User $user, $languageCode ) {
 		return $languageFallbackChain;
 	}
 
-	private function getBabel( $languageCode, $user ) {
+	private function getBabel( string $languageCode, UserIdentity $user ): array {
 		$babel = [];
 
 		$babelCategoryNames = $this->getBabelCategoryNames();
@@ -282,7 +283,7 @@ private function getBabel( $languageCode, $user ) {
 		return $babel;
 	}
 
-	private function getBabelCategoryNames() {
+	private function getBabelCategoryNames(): array {
 		global $wgBabelCategoryNames;
 
 		$babelCategoryNames = array_filter(

lib/includes/Normalization/SnakNormalizer.php

@@ -64,7 +64,7 @@ public function normalize( Snak $snak ): Snak {
 		);
 	}
 
-	private function getNormalizer( PropertyId $propertyId, string $valueType ) {
+	private function getNormalizer( PropertyId $propertyId, string $valueType ): DataValueNormalizer {
 		$propertyIdSerialization = $propertyId->getSerialization();
 		if ( !array_key_exists( $propertyIdSerialization, $this->normalizers ) ) {
 			$this->normalizers[$propertyIdSerialization] = $this->makeNormalizer( $propertyId, $valueType );

lib/includes/SimpleCacheWithBagOStuff.php

@@ -224,7 +224,7 @@ public function has( $key ) {
 		return $result !== false;
 	}
 
-	private function assertKeysAreValid( $keys ): void {
+	private function assertKeysAreValid( array $keys ): void {
 		foreach ( $keys as $key ) {
 			$this->assertKeyIsValid( $key );
 		}

lib/includes/Store/CacheAwarePropertyInfoStore.php

@@ -146,14 +146,14 @@ public function removePropertyInfo( NumericPropertyId $propertyId ) {
 		return true;
 	}
 
-	private function getFullTableCacheKey() {
+	private function getFullTableCacheKey(): string {
 		return $this->cache->makeGlobalKey(
 			self::CACHE_CLASS,
 			$this->cacheKeyGroup
 		);
 	}
 
-	private function getSinglePropertyCacheKey( NumericPropertyId $propertyId ) {
+	private function getSinglePropertyCacheKey( NumericPropertyId $propertyId ): string {
 		return $this->cache->makeGlobalKey(
 			self::CACHE_CLASS,
 			$this->cacheKeyGroup,

lib/includes/Store/CachingFallbackLabelDescriptionLookup.php

@@ -105,7 +105,7 @@ public function getLabel( EntityId $entityId ) {
 		return $label;
 	}
 
-	private function getTerm( EntityId $entityId, $languageCode, $termName = self::LABEL ) {
+	private function getTerm( EntityId $entityId, string $languageCode, string $termName = self::LABEL ): ?TermFallback {
 		$resolutionResult = $this->redirectResolvingRevisionLookup->lookupLatestRevisionResolvingRedirect( $entityId );
 		if ( $resolutionResult === null ) {
 			return null;

lib/includes/Store/CachingPrefetchingTermLookup.php

@@ -119,7 +119,7 @@ public function getDescription( EntityId $entityId, $languageCode ): ?string {
 		return $this->getTerm( $entityId, $languageCode, TermTypes::TYPE_DESCRIPTION );
 	}
 
-	private function getTerm( EntityId $entityId, string $languageCode, string $termType ) {
+	private function getTerm( EntityId $entityId, string $languageCode, string $termType ): ?string {
 		$cachedTerm = $this->getBufferedOrCachedEntry( $entityId, $termType, $languageCode );
 		if ( $cachedTerm !== null ) {
 			return $cachedTerm ?: null;
@@ -299,7 +299,7 @@ private function bufferAndCacheMissingTerm( EntityId $entityId, string $termType
 		);
 	}
 
-	private function getCacheKey( EntityId $id, string $language, string $termType ) {
+	private function getCacheKey( EntityId $id, string $language, string $termType ): ?string {
 		$resolutionResult = $this->redirectResolvingRevisionLookup->lookupLatestRevisionResolvingRedirect( $id );
 		if ( $resolutionResult === null ) {
 			return null;
@@ -320,7 +320,7 @@ private function getBufferedOrCachedEntry( EntityId $entityId, string $termType,
 		return $cacheKey === null ? null : $this->cache->get( $cacheKey );
 	}
 
-	private function getMultipleTermsByLanguageFromBuffer( EntityId $entityId, string $termType, array $languages ) {
+	private function getMultipleTermsByLanguageFromBuffer( EntityId $entityId, string $termType, array $languages ): array {
 		$terms = [];
 
 		// Lookup in termbuffer
@@ -334,7 +334,7 @@ private function getMultipleTermsByLanguageFromBuffer( EntityId $entityId, strin
 		return $terms;
 	}
 
-	private function getMultipleTermsByLanguageFromCache( EntityId $entityId, string $termType, array $languages ) {
+	private function getMultipleTermsByLanguageFromCache( EntityId $entityId, string $termType, array $languages ): array {
 		$terms = [];
 
 		$languagesToCacheKeys = [];
@@ -359,7 +359,7 @@ private function getMultipleTermsByLanguageFromCache( EntityId $entityId, string
 		return $terms;
 	}
 
-	private function getMultipleTermsByLanguageFromLookup( EntityId $entityId, string $termType, array $languages ) {
+	private function getMultipleTermsByLanguageFromLookup( EntityId $entityId, string $termType, array $languages ): array {
 		if ( $termType === TermTypes::TYPE_LABEL ) {
 			$freshTerms = $this->lookup->getLabels( $entityId, $languages );
 		} else {
@@ -377,7 +377,7 @@ private function getMultipleTermsByLanguageFromLookup( EntityId $entityId, strin
 		return $freshTerms;
 	}
 
-	private function getMultipleTermsByLanguage( EntityId $entityId, string $termType, array $languages ) {
+	private function getMultipleTermsByLanguage( EntityId $entityId, string $termType, array $languages ): array {
 		$terms = $this->getMultipleTermsByLanguageFromBuffer( $entityId, $termType, $languages );
 
 		// languages without prefetched terms

lib/includes/Store/CachingPropertyInfoLookup.php

@@ -183,14 +183,14 @@ function () use ( &$wanCacheHit, $fname ) {
 		return $this->propertyInfo;
 	}
 
-	private function getFullTableCacheKey() {
+	private function getFullTableCacheKey(): string {
 		return $this->cache->makeGlobalKey(
 			CacheAwarePropertyInfoStore::CACHE_CLASS,
 			$this->cacheKeyGroup
 		);
 	}
 
-	private function getSinglePropertyCacheKey( PropertyId $propertyId ) {
+	private function getSinglePropertyCacheKey( PropertyId $propertyId ): string {
 		return $this->cache->makeGlobalKey(
 			CacheAwarePropertyInfoStore::CACHE_CLASS,
 			$this->cacheKeyGroup,

lib/includes/Store/LatestRevisionIdResult.php

@@ -99,7 +99,7 @@ public static function concreteRevision( int $revisionId, string $revisionTimest
 		return $result;
 	}
 
-	private function __construct( $type ) {
+	private function __construct( string $type ) {
 		$this->type = $type;
 	}
 

lib/includes/Store/Sql/PrefetchingWikiPageEntityMetaDataAccessor.php

@@ -258,7 +258,7 @@ public function loadLatestRevisionIds( array $entityIds, $mode ) {
 		return $revisionIds;
 	}
 
-	private function doFetch( $mode ) {
+	private function doFetch( string $mode ) {
 		if ( !$this->toFetch ) {
 			return;
 		}

lib/includes/Store/Sql/Terms/DatabaseTermInLangIdsAcquirer.php

@@ -228,7 +228,7 @@ private function mapToTextInLangIds(
 	private function acquireTextInLangIds(
 		array $langTextIds,
 		ReplicaPrimaryAwareRecordIdsAcquirer $textInLangIdsAcquirer
-	) {
+	): array {
 		$textInLangRecords = [];
 		foreach ( $langTextIds as $lang => $textIds ) {
 			foreach ( $textIds as $textId ) {
@@ -306,7 +306,7 @@ private function acquireTermInLangIdsInner(
 		array $typeTextInLangIds,
 		ReplicaPrimaryAwareRecordIdsAcquirer $termInLangIdsAcquirer,
 		array $idsToRestore = []
-	) {
+	): array {
 		$termInLangRecords = [];
 		foreach ( $typeTextInLangIds as $typeId => $textInLangIds ) {
 			foreach ( $textInLangIds as $textInLangId ) {
@@ -382,7 +382,7 @@ private function restoreCleanedUpIds( array $termsArray, array $termInLangIds =
 	private function mapTermsArrayToTermIds(
 		array $termsArray,
 		array $termInLangIdsToRestore = [],
-		$ignoreReplica = false
+		bool $ignoreReplica = false
 	): array {
 		$textIdsAcquirer = new ReplicaPrimaryAwareRecordIdsAcquirer(
 			$this->termsDb, 'wbt_text', 'wbx_id',
@@ -401,12 +401,12 @@ private function mapTermsArrayToTermIds(
 		return $this->mapToTermInLangIds( $termsArray, $termInLangIdsAcquirer, $termInLangIdsToRestore );
 	}
 
-	private function calcRecordHash( array $record ) {
+	private function calcRecordHash( array $record ): string {
 		ksort( $record );
 		return md5( serialize( $record ) );
 	}
 
-	private function filterUniqueRecords( array $records ) {
+	private function filterUniqueRecords( array $records ): array {
 		$uniqueRecords = [];
 		foreach ( $records as $record ) {
 			$recordHash = $this->calcRecordHash( $record );

lib/includes/Store/Sql/Terms/DatabaseTermInLangIdsResolver.php

@@ -8,6 +8,7 @@
 use stdClass;
 use Wikibase\Lib\Rdbms\TermsDomainDb;
 use Wikibase\Lib\Store\Sql\Terms\Util\StatsMonitoring;
+use Wikimedia\Rdbms\IReadableDatabase;
 use Wikimedia\Rdbms\SelectQueryBuilder;
 
 /**
@@ -166,19 +167,19 @@ private function addResultTerms( array &$terms, stdClass $row ) {
 		$terms[$type][$lang][] = $text;
 	}
 
-	private function lookupTypeName( $typeId ) {
+	private function lookupTypeName( string $typeId ): string {
 		$typeName = array_flip( TermTypeIds::TYPE_IDS )[$typeId] ?? null;
 		if ( $typeName === null ) {
 			throw new InvalidArgumentException( 'Unknown type ID: ' . $typeId );
 		}
 		return $typeName;
 	}
 
-	private function lookupTypeIds( array $typeNames ) {
+	private function lookupTypeIds( array $typeNames ): array {
 		return array_intersect_key( TermTypeIds::TYPE_IDS, array_flip( $typeNames ) );
 	}
 
-	private function getDbr() {
+	private function getDbr(): IReadableDatabase {
 		return $this->termsDb->getReadConnection();
 	}
 

lib/includes/Store/Sql/Terms/PrefetchingEntityTermLookupBase.php

@@ -133,7 +133,7 @@ public function getPrefetchedAliases( EntityId $entityId, $languageCode ) {
 		return $this->getFromBuffer( $entityId, TermTypes::TYPE_ALIAS, $languageCode ) ?? false;
 	}
 
-	private function getFromBuffer( EntityId $entityId, $termType, $languageCode ) {
+	private function getFromBuffer( EntityId $entityId, string $termType, string $languageCode ): ?array {
 		if ( !( $entityId instanceof Int32EntityId ) ) {
 			throw new InvalidArgumentException( "Not an Int32EntityId: " . $entityId->getSerialization() );
 		}

lib/includes/TermIndexEntry.php

@@ -153,7 +153,7 @@ public static function compare( self $a, self $b ) {
 		return 0;
 	}
 
-	private static function getFieldValuesForCompare( self $entry ) {
+	private static function getFieldValuesForCompare( self $entry ): array {
 		return [
 			self::FIELD_ENTITY => $entry->getEntityId()->getSerialization(),
 			self::FIELD_TYPE => $entry->getTermType(),

lib/packages/wikibase/changes/tests/TestChanges.php

@@ -42,7 +42,7 @@ public static function getEntityChangeFactory() {
 		return $factory;
 	}
 
-	private static function getInstances() {
+	private static function getInstances(): array {
 		/** @var EntityChange[] $changes */
 		static $changes = [];
 

lib/packages/wikibase/data-model-serialization/src/Deserializers/ItemDeserializer.php

@@ -77,7 +77,7 @@ public function deserialize( $serialization ) {
 		return $this->getDeserialized( $serialization );
 	}
 
-	private function getDeserialized( array $serialization ) {
+	private function getDeserialized( array $serialization ): Item {
 		$item = new Item();
 
 		$this->setIdFromSerialization( $serialization, $item );

lib/packages/wikibase/data-model-serialization/src/Deserializers/ReferenceDeserializer.php

@@ -37,7 +37,7 @@ public function isDeserializerFor( $serialization ) {
 		return $this->isValidSerialization( $serialization );
 	}
 
-	private function isValidSerialization( $serialization ) {
+	private function isValidSerialization( $serialization ): bool {
 		return is_array( $serialization ) && array_key_exists( 'snaks', $serialization );
 	}
 

lib/packages/wikibase/data-model-serialization/src/Deserializers/SiteLinkDeserializer.php

@@ -53,7 +53,7 @@ private function getDeserialized( array $serialization ) {
 		);
 	}
 
-	private function getDeserializeBadges( array $serialization ) {
+	private function getDeserializeBadges( array $serialization ): array {
 		if ( !array_key_exists( 'badges', $serialization ) ) {
 			return [];
 		}
@@ -66,7 +66,7 @@ private function getDeserializeBadges( array $serialization ) {
 		return $badges;
 	}
 
-	private function deserializeItemId( $serialization ) {
+	private function deserializeItemId( $serialization ): ItemId {
 		$itemId = $this->entityIdDeserializer->deserialize( $serialization );
 
 		if ( !( $itemId instanceof ItemId ) ) {

lib/packages/wikibase/data-model-serialization/src/Serializers/PropertySerializer.php

@@ -73,7 +73,7 @@ public function serialize( $object ) {
 		return $this->getSerialized( $object );
 	}
 
-	private function getSerialized( Property $property ) {
+	private function getSerialized( Property $property ): array {
 		$serialization = [
 			'type' => $property->getType(),
 			'datatype' => $property->getDataTypeId(),

lib/packages/wikibase/data-model-serialization/src/Serializers/ReferenceListSerializer.php

@@ -55,7 +55,7 @@ public function serialize( $object ) {
 		return $this->getSerialized( $object );
 	}
 
-	private function getSerialized( ReferenceList $references ) {
+	private function getSerialized( ReferenceList $references ): array {
 		$serialization = [];
 
 		foreach ( $references as $reference ) {