Merge pull request #593 from wmde/fix-phpstan-array-errors

Add types for arrays
wmde · Jan 20, 2025 · 5b9b0f5 · 5b9b0f5
2 parents e6f45ad + c06675b
commit 5b9b0f5
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 7 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,8 +1,5 @@
 parameters:
 	inferPrivatePropertyTypeFromConstructor: true
-	ignoreErrors:
-		-
-			identifier: missingType.iterableValue
 
 includes:
 	- vendor/phpstan/phpstan-phpunit/extension.neon
diff --git a/phpstan.prod.neon b/phpstan.prod.neon
@@ -1,5 +1,2 @@
 parameters:
 	inferPrivatePropertyTypeFromConstructor: true
-	ignoreErrors:
-		-
-			identifier: missingType.iterableValue
diff --git a/src/Entity/Visitor.php b/src/Entity/Visitor.php
@@ -11,6 +11,7 @@ class Visitor {
 
 	private int $totalImpressionCount = 0;
 	private ?string $bucketIdentifier;
+	/** @var string[] */
 	private array $activeCategories;
 	private int $displayWidth;
 
@@ -24,7 +25,8 @@ public function __construct(
 			int $totalImpressionCount,
 			?string $bucketIdentifier,
 			int $displayWidth,
-			string ...$activeCategories ) {
+			string ...$activeCategories
+	) {
 		$this->totalImpressionCount = $totalImpressionCount;
 		$this->bucketIdentifier = $bucketIdentifier;
 		$this->displayWidth = $displayWidth;

diff --git a/src/Utils/CampaignConfigurationLoader.php b/src/Utils/CampaignConfigurationLoader.php
@@ -31,6 +31,10 @@ public function getCampaignCollection(): CampaignCollection {
 		return new CampaignCollection( ...$campaigns );
 	}
 
+	/**
+	 * @param string $campaignName
+	 * @param array<string,mixed> $campaignData
+	 */
 	private function buildCampaignFromData( string $campaignName, array $campaignData ): Campaign {
 		$buckets = $this->buildBucketsFromData( $campaignData );
 		if ( empty( $buckets ) ) {
@@ -60,6 +64,10 @@ private function buildCampaignFromData( string $campaignName, array $campaignDat
 		);
 	}
 
+	/**
+	 * @param array<string,mixed> $campaignData
+	 * @return Bucket[]
+	 */
 	private function buildBucketsFromData( array $campaignData ): array {
 		$buckets = [];
 		foreach ( $campaignData['buckets'] as $bucketData ) {
@@ -69,6 +77,10 @@ private function buildBucketsFromData( array $campaignData ): array {
 		return $buckets;
 	}
 
+	/**
+	 * @param array<string,mixed> $bucketData
+	 * @return Bucket
+	 */
 	private function buildBucketFromData( array $bucketData ): Bucket {
 		if ( !isset( $bucketData['name'] ) ) {
 			throw new InvalidConfigurationValueException( 'A configured bucket has no name.' );
@@ -83,6 +95,10 @@ private function buildBucketFromData( array $bucketData ): Bucket {
 		return new Bucket( $bucketData['name'], array_shift( $banners ), ...$banners );
 	}
 
+	/**
+	 * @param string[] $bannerData
+	 * @return Banner[]
+	 */
 	private function buildBannersFromData( array $bannerData ): array {
 		$banners = [];
 		foreach ( $bannerData as $bannerIdentifier ) {
@@ -94,10 +110,16 @@ private function buildBannersFromData( array $bannerData ): array {
 		return $banners;
 	}
 
+	/**
+	 * @return array<string,mixed>
+	 */
 	private function parseConfiguration(): array {
 		return Yaml::parseFile( $this->configFile );
 	}
 
+	/**
+	 * @param array<string,mixed> $campaignData
+	 */
 	private function integerOrNullValue( array $campaignData, string $key ): ?int {
 		if ( !isset( $campaignData[$key] ) ) {
 			return null;

diff --git a/tests/Unit/EventListener/ExceptionListenerTest.php b/tests/Unit/EventListener/ExceptionListenerTest.php
@@ -25,6 +25,11 @@ public function setUp(): void {
 		$this->dispatcher = new EventDispatcher();
 	}
 
+	/** solves tests marked as "risky" by phpunit, error was: "Test code or tested code did not remove its own exception handlers" */
+	public function tearDown(): void {
+		restore_exception_handler();
+	}
+
 	public function testGivenExceptionForJavaScriptUrl_thenEmptyInternalServerErrorMessageIsReturned(): void {
 		$this->withExceptionListener( new TestHandler() );