Code updates to make psalm happy

reedy · reedy · commit 8c904f4b421e · 2025-09-23T17:11:10.000+01:00
diff --git a/phpcs.xml b/phpcs.xml
@@ -12,5 +12,7 @@
 	<rule ref="Generic.Metrics.CyclomaticComplexity" />
 	<rule ref="Generic.Metrics.NestingLevel" />
 	<rule ref="Squiz.Operators.ValidLogicalOperators" />
-	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
+		<exclude name="MediaWiki.Commenting.ClassAnnotations.UnrecognizedAnnotationg" />
+	</rule>
 </ruleset>
diff --git a/psalm.xml b/psalm.xml
@@ -17,11 +17,16 @@
 
         <MissingPropertyType errorLevel="suppress" />
         <DocblockTypeContradiction errorLevel="suppress" />
+	<InvalidOperand errorLevel="suppress" />
+	<UnusedClass errorLevel="suppress" />
+	<MissingOverrideAttribute errorLevel="suppress" />
+	<PossiblyUnusedMethod errorLevel="suppress" />
 
         <!-- level 6 issues - really bad things -->
 
         <MoreSpecificImplementedParamType errorLevel="suppress" />
         <InvalidReturnType errorLevel="suppress" />
+	<DirectConstructorCall errorLevel="suppress" />
 
     </issueHandlers>
 </psalm>
diff --git a/src/Formatters/GlobeCoordinateFormatter.php b/src/Formatters/GlobeCoordinateFormatter.php
@@ -19,6 +19,7 @@
  * TODO: add formatting of globe and precision
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Formatters/LatLongFormatter.php b/src/Formatters/LatLongFormatter.php
@@ -23,6 +23,7 @@
  * MapsCoordinateParser class of the Maps extension for MediaWiki.
  *
  * @since 0.1, renamed in 2.0
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/GlobeMath.php b/src/GlobeMath.php
@@ -12,6 +12,7 @@
  * GlobeCoordinateValue objects.
  *
  * @since 0.2
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Thiemo Kreuz
diff --git a/src/PackagePrivate/DmPrecisionDetector.php b/src/PackagePrivate/DmPrecisionDetector.php
@@ -4,6 +4,9 @@
 
 namespace DataValues\Geo\PackagePrivate;
 
+/**
+ * @api
+ */
 class DmPrecisionDetector extends PrecisionDetector {
 
 	private DmsPrecisionDetector $dmsPrecisionDetector;
diff --git a/src/PackagePrivate/DmsPrecisionDetector.php b/src/PackagePrivate/DmsPrecisionDetector.php
@@ -4,6 +4,9 @@
 
 namespace DataValues\Geo\PackagePrivate;
 
+/**
+ * @api
+ */
 class DmsPrecisionDetector extends PrecisionDetector {
 
 	protected function detectDegreePrecision( float $degree ): float {
diff --git a/src/PackagePrivate/FloatPrecisionDetector.php b/src/PackagePrivate/FloatPrecisionDetector.php
@@ -4,6 +4,9 @@
 
 namespace DataValues\Geo\PackagePrivate;
 
+/**
+ * @api
+ */
 class FloatPrecisionDetector extends PrecisionDetector {
 
 	protected function detectDegreePrecision( float $degree ): float {
diff --git a/src/PackagePrivate/LatLongPrecisionParser.php b/src/PackagePrivate/LatLongPrecisionParser.php
@@ -9,6 +9,9 @@
 use ValueParsers\ParseException;
 use ValueParsers\ParserOptions;
 
+/**
+ * @api
+ */
 class LatLongPrecisionParser {
 
 	private ?ParserOptions $options;
diff --git a/src/PackagePrivate/PreciseLatLong.php b/src/PackagePrivate/PreciseLatLong.php
@@ -6,6 +6,9 @@
 
 use DataValues\Geo\Values\LatLongValue;
 
+/**
+ * @api
+ */
 class PreciseLatLong {
 
 	private LatLongValue $latLong;
diff --git a/src/PackagePrivate/Precision.php b/src/PackagePrivate/Precision.php
@@ -4,6 +4,9 @@
 
 namespace DataValues\Geo\PackagePrivate;
 
+/**
+ * @api
+ */
 class Precision {
 
 	private float $precision;
diff --git a/src/PackagePrivate/PrecisionParser.php b/src/PackagePrivate/PrecisionParser.php
@@ -4,6 +4,9 @@
 
 use ValueParsers\ValueParser;
 
+/**
+ * @api
+ */
 class PrecisionParser {
 
 	private ValueParser $latLongParser;
diff --git a/src/Parsers/DdCoordinateParser.php b/src/Parsers/DdCoordinateParser.php
@@ -12,6 +12,7 @@
  * Parser for geographical coordinates in Decimal Degree notation.
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Parsers/DmCoordinateParser.php b/src/Parsers/DmCoordinateParser.php
@@ -11,6 +11,7 @@
  * Parser for geographical coordinates in Decimal Minute notation.
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Parsers/DmsCoordinateParser.php b/src/Parsers/DmsCoordinateParser.php
@@ -11,6 +11,7 @@
  * Parser for geographical coordinates in Degree Minute Second notation.
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Parsers/FloatCoordinateParser.php b/src/Parsers/FloatCoordinateParser.php
@@ -8,6 +8,7 @@
 
 /**
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Parsers/GlobeCoordinateParser.php b/src/Parsers/GlobeCoordinateParser.php
@@ -14,9 +14,10 @@
 /**
  * Extends the LatLongParser by adding precision detection support.
  *
- * The object that gets constructed is a GlobeCoordinateValue rather then a LatLongValue.
+ * The object that gets constructed is a GlobeCoordinateValue rather than a LatLongValue.
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Parsers/LatLongParser.php b/src/Parsers/LatLongParser.php
@@ -30,6 +30,7 @@
  * MapsCoordinateParser class of the Maps extension for MediaWiki.
  *
  * @since 0.1, name changed in 2.0
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
diff --git a/src/Values/GlobeCoordinateValue.php b/src/Values/GlobeCoordinateValue.php
@@ -12,6 +12,7 @@
  * Value Object representing a latitude-longitude pair with a certain precision on a certain globe.
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
@@ -132,16 +133,16 @@ public function __serialize(): array {
 	/**
 	 * @see Serializable::unserialize
 	 *
-	 * @param string $value
+	 * @param string $data
 	 *
 	 * @throws InvalidArgumentException
 	 */
-	public function unserialize( $value ) {
-		$this->__unserialize( json_decode( $value ) );
+	public function unserialize( $data ): void {
+		$this->__unserialize( json_decode( $data ) );
 	}
 
 	public function __unserialize( array $data ): void {
-		[ $latitude, $longitude, $altitude, $precision, $globe ] = $data;
+		[ $latitude, $longitude, , $precision, $globe ] = $data;
 		$this->__construct( new LatLongValue( $latitude, $longitude ), $precision, $globe );
 	}
 
diff --git a/src/Values/LatLongValue.php b/src/Values/LatLongValue.php
@@ -15,6 +15,7 @@
  * Longitude is specified in degrees within the range [-360, 360].
  *
  * @since 0.1
+ * @api
  *
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
@@ -105,12 +106,12 @@ public function __serialize(): array {
 	/**
 	 * @see Serializable::unserialize
 	 *
-	 * @param string $value
+	 * @param string $data
 	 *
 	 * @throws InvalidArgumentException
 	 */
-	public function unserialize( $value ) {
-		$this->__unserialize( explode( '|', $value, 2 ) );
+	public function unserialize( $data ): void {
+		$this->__unserialize( explode( '|', $data, 2 ) );
 	}
 
 	public function __unserialize( array $data ): void {

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`	`* TODO: add formatting of globe and precision`
`20`	`20`	`*`
`21`	`21`	`* @since 0.1`
	`22`	`+ * @api`
`22`	`23`	`*`
`23`	`24`	`* @license GPL-2.0-or-later`
`24`	`25`	`* @author Jeroen De Dauw < [email protected] >`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`* MapsCoordinateParser class of the Maps extension for MediaWiki.`
`24`	`24`	`*`
`25`	`25`	`* @since 0.1, renamed in 2.0`
	`26`	`+ * @api`
`26`	`27`	`*`
`27`	`28`	`* @license GPL-2.0-or-later`
`28`	`29`	`* @author Jeroen De Dauw < [email protected] >`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`* GlobeCoordinateValue objects.`
`13`	`13`	`*`
`14`	`14`	`* @since 0.2`
	`15`	`+ * @api`
`15`	`16`	`*`
`16`	`17`	`* @license GPL-2.0-or-later`
`17`	`18`	`* @author Thiemo Kreuz`