Merge pull request #508 from wmde/epvs

Implement ExtendedPropertyValueSnak

Author: Daniel Kinzler

src/Snak/DerivedPropertyValueSnak.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Wikibase\DataModel\Snak;
+
+use DataValues\DataValue;
+use InvalidArgumentException;
+use Wikibase\DataModel\Entity\PropertyId;
+
+/**
+ * PropertyValueSnak with with derived values attached.
+ * Derived DataValues can be used to provide infomation, for example, normalized values.
+ *
+ * Calls to the getType method will indicate that this is a PropertyValueSnak
+ *
+ * Direct serialization of this object will not include the extra derived values
+ *
+ * The hash of this object is not changed by the extra Derived values
+ * thus this object will ->equal a PropertyValueSnak of the same value.
+ *
+ * @since 3.1
+ *
+ * @licence GNU GPL v2+
+ * @author Adam Shorland
+ */
+class DerivedPropertyValueSnak extends PropertyValueSnak {
+
+	/**
+	 * @var DataValue[]
+	 */
+	private $derivedDataValues = array();
+
+	/**
+	 * @param PropertyId $propertyId
+	 * @param DataValue $dataValue
+	 * @param DataValue[] $derivedDataValues
+	 */
+	public function __construct(
+		PropertyId $propertyId,
+		DataValue $dataValue,
+		array $derivedDataValues
+	) {
+		parent::__construct( $propertyId, $dataValue );
+
+		foreach ( $derivedDataValues as $key => $extensionDataValue ) {
+			if ( !( $extensionDataValue instanceof DataValue ) || !is_string( $key ) ) {
+				throw new InvalidArgumentException(
+					'$derivedDataValues must be an array of DataValue objects with string keys'
+				);
+			}
+		}
+
+		$this->derivedDataValues = $derivedDataValues;
+	}
+
+	/**
+	 * @return DataValue[] with string keys
+	 */
+	public function getDerivedDataValues() {
+		return $this->derivedDataValues;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return DataValue|null
+	 */
+	public function getDerivedDataValue( $key ) {
+		if ( isset( $this->derivedDataValues[$key] ) ) {
+			return $this->derivedDataValues[$key];
+		}
+		return null;
+	}
+
+}

src/Snak/PropertyValueSnak.php

@@ -18,7 +18,7 @@
  */
 class PropertyValueSnak extends SnakObject {
 
-	private $dataValue;
+	protected $dataValue;
 
 	/**
 	 * Support for passing in an EntityId instance that is not a PropertyId instance has

tests/unit/Snak/DerivedPropertyValueSnakTest.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Wikibase\DataModel\Tests\Snak;
+
+use DataValues\StringValue;
+use Wikibase\DataModel\Entity\PropertyId;
+use Wikibase\DataModel\Snak\DerivedPropertyValueSnak;
+
+/**
+ * @covers Wikibase\DataModel\Snak\DerivedPropertyValueSnak
+ *
+ * @group Wikibase
+ * @group WikibaseDataModel
+ * @group WikibaseSnak
+ *
+ * @licence GNU GPL v2+
+ * @author Adam Shorland
+ */
+class DerivedPropertyValueSnakTest extends SnakObjectTest {
+
+	public function constructorProvider() {
+		return array(
+			'No extras' => array(
+				true,
+				new PropertyId( 'P1' ),
+				new StringValue( 'a' ),
+				array(),
+			),
+			'2 extras' => array(
+				true,
+				new PropertyId( 'P9001' ),
+				new StringValue( 'bc' ),
+				array( 'foo' => new StringValue( 'foo' ), 'bar' => new StringValue( 'bar' ) ),
+			),
+			'fail - Integer key' => array(
+				'InvalidArgumentException',
+				new PropertyId( 'P9001' ),
+				new StringValue( 'bc' ),
+				array( new StringValue( 'foo' ) ),
+			),
+			'fail - not a value' => array(
+				'InvalidArgumentException',
+				new PropertyId( 'P9001' ),
+				new StringValue( 'bc' ),
+				array( 'foo' => 'bar' ),
+			),
+		);
+	}
+
+	public function getClass() {
+		return 'Wikibase\DataModel\Snak\DerivedPropertyValueSnak';
+	}
+
+	/**
+	 * This test is a safeguard to make sure hashes are not changed unintentionally.
+	 */
+	public function testHashStability() {
+		$snak = new DerivedPropertyValueSnak(
+			new PropertyId( 'P1' ),
+			new StringValue( 'a' ),
+			array( 'foo' => new StringValue( 'foo' ) )
+		);
+		$hash = $snak->getHash();
+
+		// @codingStandardsIgnoreStart
+		$expected = sha1( 'C:48:"Wikibase\DataModel\Snak\DerivedPropertyValueSnak":53:{a:2:{i:0;i:1;i:1;C:22:"DataValues\StringValue":1:{a}}}' );
+		// @codingStandardsIgnoreEnd
+		$this->assertSame( $expected, $hash );
+	}
+
+	/**
+	 * @dataProvider instanceProvider
+	 */
+	public function testGetDerivedDataValues( DerivedPropertyValueSnak $snak, $args ) {
+		$dataValues = $snak->getDerivedDataValues();
+		$this->assertEquals( $args[2], $dataValues );
+	}
+
+	/**
+	 * @dataProvider instanceProvider
+	 */
+	public function testGetDerivedDataValue( DerivedPropertyValueSnak $snak, $args ) {
+		$this->assertEquals( null, $snak->getDerivedDataValue( 'ponies and unicorns' ) );
+		foreach ( $args[2] as $expectedKey => $expectedDataValue ) {
+			$dataValue = $snak->getDerivedDataValue( $expectedKey );
+			$this->assertEquals( $expectedDataValue, $dataValue );
+		}
+	}
+
+}