Merge pull request #471 from wmde/removestatementswithguid

Add StatementList::removeStatementsWithGuid

Author: JeroenDeDauw

src/Statement/StatementList.php

@@ -25,6 +25,7 @@
  *
  * @licence GNU GPL v2+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
+ * @author Bene* < benestar.wikimedia@gmail.com >
  */
 class StatementList implements IteratorAggregate, Comparable, Countable {
 
@@ -105,6 +106,17 @@ public function addNewStatement( Snak $mainSnak, $qualifiers = null, $references
 		$this->addStatement( $statement );
 	}
 
+	/**
+	 * @param string|null $guid
+	 */
+	public function removeStatementsWithGuid( $guid ) {
+		foreach ( $this->statements as $index => $statement ) {
+			if ( $statement->getGuid() === $guid ) {
+				unset( $this->statements[$index] );
+			}
+		}
+	}
+
 	/**
 	 * Statements that have a main snak already in the list are filtered out.
 	 * The last occurrences are retained.

tests/unit/Statement/StatementListTest.php

@@ -260,6 +260,50 @@ public function testAddStatementWithGuid() {
 		$this->assertEquals( new StatementList( $statement ), $list );
 	}
 
+	public function testRemoveStatementsWithGuid_singleStatementRemoved() {
+		$statement1 = new Statement( $this->newSnak( 24, 'foo' ), null, null, 'foo' );
+		$statement2 = new Statement( $this->newSnak( 32, 'bar' ), null, null, 'bar' );
+		$statement3 = new Statement( $this->newSnak( 32, 'bar' ), null, null, 'bar' );
+
+		$list = new StatementList( array( $statement1, $statement2, $statement3 ) );
+		$list->removeStatementsWithGuid( 'foo' );
+
+		$statements = array();
+		$statements[1] = $statement2;
+		$statements[2] = $statement3;
+
+		$this->assertEquals( $statements, $list->toArray() );
+	}
+
+	public function testRemoveStatementsWithGuid_multipleStatementsRemoved() {
+		$statement1 = new Statement( $this->newSnak( 24, 'foo' ), null, null, 'foo' );
+		$statement2 = new Statement( $this->newSnak( 32, 'bar' ), null, null, 'bar' );
+		$statement3 = new Statement( $this->newSnak( 32, 'bar' ), null, null, 'bar' );
+
+		$list = new StatementList( array( $statement1, $statement2, $statement3 ) );
+		$list->removeStatementsWithGuid( 'bar' );
+
+		$this->assertEquals(
+			new StatementList( array( $statement1 ) ),
+			$list
+		);
+	}
+
+	public function testRemoveStatementsWithGuid_nowStatementRemoved() {
+		$statement1 = new Statement( $this->newSnak( 24, 'foo' ), null, null, 'foo' );
+		$statement2 = new Statement( $this->newSnak( 32, 'bar' ), null, null, 'bar' );
+		$statement3 = new Statement( $this->newSnak( 32, 'bar' ), null, null, 'bar' );
+
+		$list = new StatementList( array( $statement1, $statement2, $statement3 ) );
+		$list->removeStatementsWithGuid( 'baz' );
+
+		$this->assertEquals(
+			new StatementList( array( $statement1, $statement2, $statement3 ) ),
+			$list
+		);
+	}
+
+
 	public function testCanConstructWithClaimsObjectContainingOnlyStatements() {
 		$statementArray = array(
 			$this->getStatementWithSnak( 1, 'foo' ),