Add ParserOutput::setIndexedPageProperty(); deprecate numeric properties

Deprecate non-string values to ::setPageProperty(), which introduce easy
traps for programmers to fall into.  Instead if page properties are intended
to be indexed, use the new ::setIndexedPageProperty() instead.  Also add
::setUnindexedPageProperty() for symmetry, with a tighter string type on
the value.

Bug: T305158
Bug: T350224
Change-Id: I8a39a7c90341dfee932aa819c9a0a637a8782f69

1 files changed, 43 insertions, 7 deletions

diff --git a/tests/phpunit/includes/parser/ParserOutputTest.php b/tests/phpunit/includes/parser/ParserOutputTest.php
index d45c100d8afc..e8e6483847ff 100644
--- a/tests/phpunit/includes/parser/ParserOutputTest.php
+++ b/tests/phpunit/includes/parser/ParserOutputTest.php
@@ -176,24 +176,27 @@ class ParserOutputTest extends MediaWikiLangTestCase {
 
 	/**
 	 * @covers \MediaWiki\Parser\ParserOutput::setPageProperty
+	 * @covers \MediaWiki\Parser\ParserOutput::setIndexedPageProperty
+	 * @covers \MediaWiki\Parser\ParserOutput::setUnindexedPageProperty
 	 * @covers \MediaWiki\Parser\ParserOutput::getPageProperty
 	 * @covers \MediaWiki\Parser\ParserOutput::unsetPageProperty
 	 * @covers \MediaWiki\Parser\ParserOutput::getPageProperties
+	 * @dataProvider providePageProperties
 	 */
-	public function testProperties() {
+	public function testPageProperties( string $setPageProperty, $value1, $value2 ) {
 		$po = new ParserOutput();
 
-		$po->setPageProperty( 'foo', 'val' );
+		$po->$setPageProperty( 'foo', $value1 );
 
 		$properties = $po->getPageProperties();
-		$this->assertSame( 'val', $po->getPageProperty( 'foo' ) );
-		$this->assertSame( 'val', $properties['foo'] );
+		$this->assertSame( $value1, $po->getPageProperty( 'foo' ) );
+		$this->assertSame( $value1, $properties['foo'] );
 
-		$po->setPageProperty( 'foo', 'second val' );
+		$po->$setPageProperty( 'foo', $value2 );
 
 		$properties = $po->getPageProperties();
-		$this->assertSame( 'second val', $po->getPageProperty( 'foo' ) );
-		$this->assertSame( 'second val', $properties['foo'] );
+		$this->assertSame( $value2, $po->getPageProperty( 'foo' ) );
+		$this->assertSame( $value2, $properties['foo'] );
 
 		$po->unsetPageProperty( 'foo' );
 
@@ -202,6 +205,39 @@ class ParserOutputTest extends MediaWikiLangTestCase {
 		$this->assertArrayNotHasKey( 'foo', $properties );
 	}
 
+	public static function providePageProperties() {
+		yield 'Unindexed' => [ 'setUnindexedPageProperty', 'val', 'second val' ];
+		yield 'Indexed' => [ 'setIndexedPageProperty', 42, 3.14 ];
+		yield 'Unindexed (old style)' => [ 'setPageProperty', 'val', 'second val' ];
+		yield 'Indexed (old style)' => [ 'setPageProperty', 123, 456 ];
+	}
+
+	/**
+	 * @covers \MediaWiki\Parser\ParserOutput::setIndexedPageProperty
+	 */
+	public function testIndexedPageProperties() {
+		$po = new ParserOutput();
+
+		$po->setIndexedPageProperty( 'foo', '123' );
+
+		$properties = $po->getPageProperties();
+		$this->assertSame( 123, $po->getPageProperty( 'foo' ) );
+		$this->assertSame( 123, $properties['foo'] );
+	}
+
+	/**
+	 * @covers \MediaWiki\Parser\ParserOutput::setUnindexedPageProperty
+	 */
+	public function testUnindexedPageProperties() {
+		$po = new ParserOutput();
+
+		$po->setUnindexedPageProperty( 'foo', 123 );
+
+		$properties = $po->getPageProperties();
+		$this->assertSame( '123', $po->getPageProperty( 'foo' ) );
+		$this->assertSame( '123', $properties['foo'] );
+	}
+
 	/**
 	 * @covers \MediaWiki\Parser\ParserOutput::setLanguage
 	 * @covers \MediaWiki\Parser\ParserOutput::getLanguage