Merge pull request #594 from wmde/nullTypes

Add missing null type documentations

Author: mariushoch

src/ByPropertyIdArray.php

@@ -51,7 +51,7 @@ class ByPropertyIdArray extends ArrayObject {
 	/**
 	 * @see ArrayObject::__construct
 	 *
-	 * @param array|object $input
+	 * @param array|object|null $input
 	 */
 	public function __construct( $input = null ) {
 		parent::__construct( (array)$input );
@@ -121,7 +121,7 @@ public function getByPropertyId( PropertyId $propertyId ) {
 		$this->assertIndexIsBuild();
 
 		if ( !( array_key_exists( $propertyId->getSerialization(), $this->byId ) ) ) {
-			throw new OutOfBoundsException( 'Object with propertyId "' . $propertyId->getSerialization() . '" not found' );
+			throw new OutOfBoundsException( "Object with propertyId \"$propertyId\" not found" );
 		}
 
 		return $this->byId[$propertyId->getSerialization()];
@@ -407,7 +407,7 @@ public function moveObjectToIndex( $object, $toIndex ) {
 	 * @since 0.5
 	 *
 	 * @param object $object
-	 * @param int $index Absolute index where to place the new object.
+	 * @param int|null $index Absolute index where to place the new object.
 	 *
 	 * @throws RuntimeException
 	 */
@@ -441,7 +441,7 @@ public function addObjectAtIndex( $object, $index = null ) {
 	 * Adds an object to an existing property group at the specified absolute index.
 	 *
 	 * @param object $object
-	 * @param int $index
+	 * @param int|null $index
 	 *
 	 * @throws OutOfBoundsException
 	 */

src/HashableObjectStorage.php

@@ -25,7 +25,7 @@ class HashableObjectStorage extends SplObjectStorage implements Comparable {
 	/**
 	 * @since 0.2
 	 *
-	 * @param array $objects
+	 * @param Hashable[]|null $objects
 	 */
 	public function __construct( array $objects = null ) {
 		if ( $objects !== null ) {

src/Term/AliasGroupFallback.php

@@ -36,7 +36,12 @@ class AliasGroupFallback extends AliasGroup {
 	 *
 	 * @throws InvalidArgumentException
 	 */
-	public function __construct( $requestedLanguageCode, array $aliases, $actualLanguageCode, $sourceLanguageCode ) {
+	public function __construct(
+		$requestedLanguageCode,
+		array $aliases,
+		$actualLanguageCode,
+		$sourceLanguageCode
+	) {
 		parent::__construct( $requestedLanguageCode, $aliases );
 
 		if ( !is_string( $actualLanguageCode ) || $actualLanguageCode === '' ) {

tests/unit/Snak/PropertyValueSnakTest.php

@@ -49,7 +49,10 @@ public function validConstructorArgumentsProvider() {
 	 * @dataProvider invalidConstructorArgumentsProvider
 	 * @expectedException InvalidArgumentException
 	 */
-	public function testGivenInvalidConstructorArguments_constructorThrowsException( $propertyId, DataValue $dataValue ) {
+	public function testGivenInvalidConstructorArguments_constructorThrowsException(
+		$propertyId,
+		DataValue $dataValue
+	) {
 		new PropertyValueSnak( $propertyId, $dataValue );
 	}