Add strict types to all class properties

A good bunch of PHPDoc comments is obsolete when we use strict types.

Change-Id: Ie0692fae4d96c749e9048f7e7c6931ec97998093

src/AnchorFormatter.php

@@ -9,14 +9,8 @@ use Sanitizer;
  */
 class AnchorFormatter {
 
-	/**
+	private ReferenceMessageLocalizer $messageLocalizer;
-	 * @var ReferenceMessageLocalizer
-	 */
-	private $messageLocalizer;
 
-	/**
-	 * @param ReferenceMessageLocalizer $messageLocalizer
-	 */
 	public function __construct( ReferenceMessageLocalizer $messageLocalizer ) {
 		$this->messageLocalizer = $messageLocalizer;
 	}

src/Cite.php

@@ -44,51 +44,29 @@ class Cite {
 	 */
 	public const BOOK_REF_PROPERTY = 'ref-extends';
 
-	/**
+	private bool $isSectionPreview;
-	 * @var bool
+	private FootnoteMarkFormatter $footnoteMarkFormatter;
-	 */
+	private ReferencesFormatter $referencesFormatter;
-	private $isSectionPreview;
+	private ErrorReporter $errorReporter;
-
-	/**
-	 * @var FootnoteMarkFormatter
-	 */
-	private $footnoteMarkFormatter;
-
-	/**
-	 * @var ReferencesFormatter
-	 */
-	private $referencesFormatter;
-
-	/**
-	 * @var ErrorReporter
-	 */
-	private $errorReporter;
 
 	/**
 	 * True when a <ref> tag is being processed.
 	 * Used to avoid infinite recursion
-	 *
-	 * @var bool
 	 */
-	private $mInCite = false;
+	private bool $mInCite = false;
 
 	/**
 	 * @var null|string The current group name while parsing nested <ref> in <references>. Null when
 	 *  parsing <ref> outside of <references>. Warning, an empty string is a valid group name!
 	 */
-	private $inReferencesGroup = null;
+	private ?string $inReferencesGroup = null;
 
 	/**
 	 * Error stack used when defining refs in <references>
-	 *
 	 * @var string[]
 	 */
-	private $mReferencesErrors = [];
+	private array $mReferencesErrors = [];
-
+	private ReferenceStack $referenceStack;
-	/**
-	 * @var ReferenceStack
-	 */
-	private $referenceStack;
 
 	/**
 	 * @param Parser $parser

src/ErrorReporter.php

@@ -13,19 +13,9 @@ use Sanitizer;
  */
 class ErrorReporter {
 
-	/**
+	private ReferenceMessageLocalizer $messageLocalizer;
-	 * @var ReferenceMessageLocalizer
+	private ?Language $cachedInterfaceLanguage = null;
-	 */
-	private $messageLocalizer;
 
-	/**
-	 * @var Language
-	 */
-	private $cachedInterfaceLanguage = null;
-
-	/**
-	 * @param ReferenceMessageLocalizer $messageLocalizer
-	 */
 	public function __construct( ReferenceMessageLocalizer $messageLocalizer ) {
 		$this->messageLocalizer = $messageLocalizer;
 	}

src/FootnoteMarkFormatter.php

@@ -10,31 +10,12 @@ use Sanitizer;
  */
 class FootnoteMarkFormatter {
 
-	/**
+	/** @var string[][] */
-	 * @var string[][]
+	private array $linkLabels = [];
-	 */
+	private AnchorFormatter $anchorFormatter;
-	private $linkLabels = [];
+	private ErrorReporter $errorReporter;
+	private ReferenceMessageLocalizer $messageLocalizer;
 
-	/**
-	 * @var AnchorFormatter
-	 */
-	private $anchorFormatter;
-
-	/**
-	 * @var ErrorReporter
-	 */
-	private $errorReporter;
-
-	/**
-	 * @var ReferenceMessageLocalizer
-	 */
-	private $messageLocalizer;
-
-	/**
-	 * @param ErrorReporter $errorReporter
-	 * @param AnchorFormatter $anchorFormatter
-	 * @param ReferenceMessageLocalizer $messageLocalizer
-	 */
 	public function __construct(
 		ErrorReporter $errorReporter,
 		AnchorFormatter $anchorFormatter,

src/ReferenceMessageLocalizer.php

@@ -12,14 +12,8 @@ use MessageSpecifier;
  */
 class ReferenceMessageLocalizer implements MessageLocalizer {
 
-	/**
+	private Language $language;
-	 * @var Language
-	 */
-	private $language;
 
-	/**
-	 * @param Language $language
-	 */
 	public function __construct( Language $language ) {
 		$this->language = $language;
 	}

src/ReferenceStack.php

@@ -43,25 +43,20 @@ class ReferenceStack {
 	 *
 	 * @var array[][]
 	 */
-	private $refs = [];
+	private array $refs = [];
 
 	/**
 	 * Auto-incrementing sequence number for all <ref>, no matter which group
-	 *
-	 * @var int
 	 */
-	private $refSequence = 0;
+	private int $refSequence = 0;
 
 	/**
 	 * Counter for the number of refs in each group.
 	 * @var int[]
 	 */
-	private $groupRefSequence = [];
+	private array $groupRefSequence = [];
-
+	/** @var int[][] */
-	/**
+	private array $extendsCount = [];
-	 * @var int[][]
-	 */
-	private $extendsCount = [];
 
 	/**
 	 * <ref> call stack
@@ -71,17 +66,13 @@ class ReferenceStack {
 	 * @var (array|false)[]
 	 * @phan-var array<array{0:string,1:int,2:string,3:?string,4:?string,5:?string,6:array}|false>
 	 */
-	private $refCallStack = [];
+	private array $refCallStack = [];
 
 	/**
 	 * @deprecated We should be able to push this responsibility to calling code.
-	 * @var ErrorReporter
 	 */
-	private $errorReporter;
+	private ErrorReporter $errorReporter;
 
-	/**
-	 * @param ErrorReporter $errorReporter
-	 */
 	public function __construct( ErrorReporter $errorReporter ) {
 		$this->errorReporter = $errorReporter;
 	}

src/ReferencesFormatter.php

@@ -18,27 +18,10 @@ class ReferencesFormatter {
 	 * @var string[]|null
 	 */
 	private $backlinkLabels = null;
+	private ErrorReporter $errorReporter;
+	private AnchorFormatter $anchorFormatter;
+	private ReferenceMessageLocalizer $messageLocalizer;
 
-	/**
-	 * @var ErrorReporter
-	 */
-	private $errorReporter;
-
-	/**
-	 * @var AnchorFormatter
-	 */
-	private $anchorFormatter;
-
-	/**
-	 * @var ReferenceMessageLocalizer
-	 */
-	private $messageLocalizer;
-
-	/**
-	 * @param ErrorReporter $errorReporter
-	 * @param AnchorFormatter $anchorFormatter
-	 * @param ReferenceMessageLocalizer $messageLocalizer
-	 */
 	public function __construct(
 		ErrorReporter $errorReporter,
 		AnchorFormatter $anchorFormatter,

tests/phpunit/CiteIntegrationTest.php

@@ -43,9 +43,8 @@ class CiteIntegrationTest extends \MediaWikiIntegrationTestCase {
 			}
 		);
 
-		/** @var ReferenceStack $referenceStack */
+		$referenceStack = new ReferenceStack( $mockErrorReporter );
-		$referenceStack = TestingAccessWrapper::newFromObject( new ReferenceStack( $mockErrorReporter ) );
+		TestingAccessWrapper::newFromObject( $referenceStack )->refs = $initialRefs;
-		$referenceStack->refs = $initialRefs;
 
 		$referencesFormatter = $this->createMock( ReferencesFormatter::class );
 		$referencesFormatter->method( 'formatReferences' )->willReturn( '<references />' );

tests/phpunit/integration/CiteTest.php

@@ -42,9 +42,8 @@ class CiteTest extends \MediaWikiIntegrationTestCase {
 	) {
 		/** @var ErrorReporter $errorReporter */
 		$errorReporter = $this->createMock( ErrorReporter::class );
-		/** @var ReferenceStack $stack */
+		$stack = new ReferenceStack( $errorReporter );
-		$stack = TestingAccessWrapper::newFromObject( new ReferenceStack( $errorReporter ) );
+		TestingAccessWrapper::newFromObject( $stack )->refs = $referencesStack;
-		$stack->refs = $referencesStack;
 
 		/** @var Cite $cite */
 		$cite = TestingAccessWrapper::newFromObject( $this->newCite() );
@@ -498,9 +497,10 @@ class CiteTest extends \MediaWikiIntegrationTestCase {
 			}
 		);
 
-		/** @var ReferenceStack $referenceStack */
+		$referenceStack = new ReferenceStack( $mockErrorReporter );
-		$referenceStack = TestingAccessWrapper::newFromObject( new ReferenceStack( $mockErrorReporter ) );
+		/** @var ReferenceStack $stackSpy */
-		$referenceStack->refs = $initialRefs;
+		$stackSpy = TestingAccessWrapper::newFromObject( $referenceStack );
+		$stackSpy->refs = $initialRefs;
 
 		$mockFootnoteMarkFormatter = $this->createMock( FootnoteMarkFormatter::class );
 		$mockFootnoteMarkFormatter->method( 'linkRef' )->willReturn( '<foot />' );
@@ -516,7 +516,7 @@ class CiteTest extends \MediaWikiIntegrationTestCase {
 		$result = $spy->guardedRef( $mockParser, $text, $argv );
 		$this->assertSame( $expectOutput, $result );
 		$this->assertSame( $expectedErrors, $spy->mReferencesErrors );
-		$this->assertSame( $expectedRefs, $referenceStack->refs );
+		$this->assertSame( $expectedRefs, $stackSpy->refs );
 	}
 
 	public static function provideGuardedRef() {