Merge "view,data-access: Use type-declaration on undocumented private…

… functions"
wikimedia · Jan 31, 2025 · 31311da · 31311da
2 parents a3f39ca + fff910c
commit 31311da
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 15 deletions.
diff --git a/data-access/src/EntitySourceDefinitionsConfigParser.php b/data-access/src/EntitySourceDefinitionsConfigParser.php
@@ -96,7 +96,7 @@ private function assertConfigArrayWellFormed( array $sourceConfig ) {
 		}
 	}
 
-	private function validateDatabaseSourceConfigFields( $sourceData, $sourceName ) {
+	private function validateDatabaseSourceConfigFields( array $sourceData, string $sourceName ) {
 		if ( !is_string( $sourceData['repoDatabase'] ) && $sourceData['repoDatabase'] !== false ) {
 			throw new InvalidArgumentException(
 				'Symbolic database name of entity source "' . $sourceName . '" should be a string or false.'

diff --git a/data-access/tests/phpunit/FakePrefetchingTermLookup.php b/data-access/tests/phpunit/FakePrefetchingTermLookup.php
@@ -41,11 +41,11 @@ private function bufferFakeTermsForEntities( array $entityIds, array $termTypes,
 		}
 	}
 
-	private function bufferNonAliasTerm( EntityId $id, $type, $lang ) {
+	private function bufferNonAliasTerm( EntityId $id, string $type, string $lang ) {
 		$this->buffer[$id->getSerialization()][$type][$lang] = $this->generateFakeTerm( $id, $type, $lang );
 	}
 
-	private function bufferAliasTerms( EntityId $id, $type, $lang ) {
+	private function bufferAliasTerms( EntityId $id, string $type, string $lang ) {
 		$this->buffer[$id->getSerialization()][$type][$lang] = [];
 		$this->buffer[$id->getSerialization()][$type][$lang][] = $this->generateFakeTerm( $id, $type, $lang, 1 );
 		$this->buffer[$id->getSerialization()][$type][$lang][] = $this->generateFakeTerm( $id, $type, $lang, 2 );

diff --git a/data-access/tests/phpunit/InMemoryPrefetchingTermLookup.php b/data-access/tests/phpunit/InMemoryPrefetchingTermLookup.php
@@ -71,11 +71,11 @@ private function bufferStubTermsForEntities( array $entityIds, array $termTypes,
 		}
 	}
 
-	private function bufferNonAliasTerm( EntityId $id, $type, $lang ) {
+	private function bufferNonAliasTerm( EntityId $id, string $type, string $lang ) {
 		$this->buffer[$id->getSerialization()][$type][$lang] = $this->getFromEntityData( $id, $type, $lang );
 	}
 
-	private function getFromEntityData( EntityId $id, $type, $lang ): ?string {
+	private function getFromEntityData( EntityId $id, string $type, string $lang ): ?string {
 		if ( !array_key_exists( $id->getSerialization(), $this->entityData ) ) {
 			return null;
 		}

diff --git a/view/src/StatementHtmlGenerator.php b/view/src/StatementHtmlGenerator.php
@@ -136,7 +136,7 @@ private function getHtmlForReferences( ReferenceList $referenceList ) {
 		return $this->wrapInListview( $referencesHtml );
 	}
 
-	private function wrapInListview( $listviewContent ) {
+	private function wrapInListview( string $listviewContent ): string {
 		if ( $listviewContent !== '' ) {
 			return $this->templateFactory->render( 'wikibase-listview', $listviewContent );
 		} else {

diff --git a/view/src/Termbox/Renderer/TermboxRemoteRenderer.php b/view/src/Termbox/Renderer/TermboxRemoteRenderer.php
@@ -87,7 +87,7 @@ public function getContent( EntityId $entityId, $revision, $language, $editLink,
 		return $request->getContent();
 	}
 
-	private function reportFailureOfRequest( $message, ?Exception $exception = null ) {
+	private function reportFailureOfRequest( string $message, ?Exception $exception = null ) {
 		$context = [
 			'errormessage' => $message,
 			'class' => __CLASS__,
@@ -99,7 +99,13 @@ private function reportFailureOfRequest( $message, ?Exception $exception = null
 		$this->stats->increment( 'wikibase.view.TermboxRemoteRenderer.requestError' );
 	}
 
-	private function formatUrl( EntityId $entityId, $revision, $language, $editLink, TermLanguageFallbackChain $preferredLanguages ) {
+	private function formatUrl(
+		EntityId $entityId,
+		int $revision,
+		string $language,
+		string $editLink,
+		TermLanguageFallbackChain $preferredLanguages
+	): string {
 		if ( !$this->ssrServerUrl ) {
 			throw new TermboxNoRemoteRendererException( 'Termbox SSR server URL not configured' );
 		}
@@ -109,11 +115,11 @@ private function formatUrl( EntityId $entityId, $revision, $language, $editLink,
 
 	private function getRequestParams(
 		EntityId $entityId,
-		$revision,
-		$language,
-		$editLink,
+		int $revision,
+		string $language,
+		string $editLink,
 		TermLanguageFallbackChain $preferredLanguages
-	) {
+	): array {
 		return [
 			'entity' => $entityId->getSerialization(),
 			'revision' => $revision,
@@ -123,7 +129,7 @@ private function getRequestParams(
 		];
 	}
 
-	private function getLanguageCodes( TermLanguageFallbackChain $preferredLanguages ) {
+	private function getLanguageCodes( TermLanguageFallbackChain $preferredLanguages ): array {
 		return array_map( function ( LanguageWithConversion $language ) {
 			return $language->getLanguageCode();
 		}, $preferredLanguages->getFallbackChain() );

diff --git a/view/src/TermsListView.php b/view/src/TermsListView.php
@@ -186,7 +186,7 @@ private function getDescriptionView( TermList $listOfDescriptionTerms, string $l
 		);
 	}
 
-	private function getMulDescriptionView() {
+	private function getMulDescriptionView(): string {
 		return $this->templateFactory->render(
 			'wikibase-descriptionview-mul',
 			htmlspecialchars( $this->textProvider->get( 'wikibase-description-not-applicable' ), ENT_QUOTES ),

diff --git a/view/src/ToolbarEditSectionGenerator.php b/view/src/ToolbarEditSectionGenerator.php
@@ -102,7 +102,7 @@ private function getHtmlForEditSection(
 		);
 	}
 
-	private function getToolbarContainer( $content ) {
+	private function getToolbarContainer( string $content ): string {
 		return '<wb:sectionedit>'
 			. $this->templateFactory->render( 'wikibase-toolbar-container', $content )
 			. '</wb:sectionedit>';