Merge pull request #179 from wmde/throwsTags

More specific type hints in deserializers
wmde · Feb 18, 2016 · 87855ad · 87855ad
2 parents 275c6ff + b87a204
commit 87855ad
Show file tree

Hide file tree

Showing 14 changed files with 45 additions and 43 deletions.
diff --git a/src/Deserializers/AliasGroupListDeserializer.php b/src/Deserializers/AliasGroupListDeserializer.php
@@ -21,7 +21,7 @@ class AliasGroupListDeserializer implements Deserializer {
 	/**
 	 * @see Deserializer::deserialize
 	 *
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 * @return AliasGroupList
@@ -32,11 +32,11 @@ public function deserialize( $serialization ) {
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @return AliasGroupList
 	 */
-	private function getDeserialized( $serialization ) {
+	private function getDeserialized( array $serialization ) {
 		$aliasGroupList = new AliasGroupList();
 
 		foreach ( $serialization as $languageCode => $aliasGroupSerialization ) {
@@ -66,7 +66,7 @@ private function deserializeAliasGroup( array $serialization, $languageCode ) {
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 */

diff --git a/src/Deserializers/EntityIdDeserializer.php b/src/Deserializers/EntityIdDeserializer.php
@@ -47,7 +47,7 @@ public function deserialize( $serialization ) {
 	}
 
 	/**
-	 * @param mixed $serialization
+	 * @param string $serialization
 	 *
 	 * @throws DeserializationException
 	 */

diff --git a/src/Deserializers/ReferenceListDeserializer.php b/src/Deserializers/ReferenceListDeserializer.php
@@ -29,7 +29,7 @@ public function __construct( Deserializer $referenceDeserializer ) {
 	/**
 	 * @see Deserializer::deserialize
 	 *
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 * @return ReferenceList
@@ -41,7 +41,7 @@ public function deserialize( $serialization ) {
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @return ReferenceList
 	 */

diff --git a/src/Deserializers/SnakListDeserializer.php b/src/Deserializers/SnakListDeserializer.php
@@ -30,7 +30,7 @@ public function __construct( Deserializer $snakDeserializer ) {
 	/**
 	 * @see Deserializer::deserialize
 	 *
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 * @return SnakList
@@ -63,7 +63,7 @@ private function getDeserialized( array $serialization ) {
 	}
 
 	/**
-	 * @param mixed $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 */

diff --git a/src/Deserializers/StatementListDeserializer.php b/src/Deserializers/StatementListDeserializer.php
@@ -30,7 +30,7 @@ public function __construct( Deserializer $statementDeserializer ) {
 	/**
 	 * @see Deserializer::deserialize
 	 *
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 * @return StatementList

diff --git a/src/Deserializers/TermDeserializer.php b/src/Deserializers/TermDeserializer.php
@@ -17,7 +17,7 @@
 class TermDeserializer implements Deserializer {
 
 	/**
-	 * @param mixed $serialization
+	 * @param string[] $serialization
 	 *
 	 * @return Term
 	 * @throws DeserializationException
@@ -28,16 +28,18 @@ public function deserialize( $serialization ) {
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param string[] $serialization
 	 *
 	 * @return Term
 	 */
-	private function getDeserialized( $serialization ) {
+	private function getDeserialized( array $serialization ) {
 		return new Term( $serialization['language'], $serialization['value'] );
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param string[] $serialization
+	 *
+	 * @throws DeserializationException
 	 */
 	private function assertCanDeserialize( $serialization ) {
 		if ( !is_array( $serialization ) ) {
@@ -49,23 +51,25 @@ private function assertCanDeserialize( $serialization ) {
 		// Do not deserialize term fallbacks
 		$this->assertNotAttribute( $serialization, 'source' );
 
-		$this->assertAttributeInternalType( $serialization, 'language', 'string' );
-		$this->assertAttributeInternalType( $serialization, 'value', 'string' );
+		$this->assertAttributeIsString( $serialization, 'language' );
+		$this->assertAttributeIsString( $serialization, 'value' );
 	}
 
-	private function assertAttributeInternalType( array $array, $attributeName, $internalType ) {
-		if ( gettype( $array[$attributeName] ) !== $internalType ) {
+	private function assertAttributeIsString( array $array, $attributeName ) {
+		if ( !is_string( $array[$attributeName] ) ) {
 			throw new InvalidAttributeException(
 				$attributeName,
 				$array[$attributeName],
-				"The internal type of attribute '$attributeName' needs to be '$internalType'"
+				"The internal type of attribute '$attributeName' needs to be 'string'"
 			);
 		}
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param string[] $serialization
 	 * @param string $attribute
+	 *
+	 * @throws MissingAttributeException
 	 */
 	private function requireAttribute( $serialization, $attribute ) {
 		if ( !is_array( $serialization ) || !array_key_exists( $attribute, $serialization ) ) {
@@ -74,8 +78,10 @@ private function requireAttribute( $serialization, $attribute ) {
 	}
 
 	/**
-	 * @param array $array
+	 * @param string[] $array
 	 * @param string $key
+	 *
+	 * @throws InvalidAttributeException
 	 */
 	private function assertNotAttribute( array $array, $key ) {
 		if ( array_key_exists( $key, $array ) ) {

diff --git a/src/Deserializers/TermListDeserializer.php b/src/Deserializers/TermListDeserializer.php
@@ -31,7 +31,7 @@ public function __construct( Deserializer $termDeserializer ) {
 	/**
 	 * @see Deserializer::deserialize
 	 *
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 * @return TermList
@@ -42,11 +42,11 @@ public function deserialize( $serialization ) {
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @return TermList
 	 */
-	private function getDeserialized( $serialization ) {
+	private function getDeserialized( array $serialization ) {
 		$termList = new TermList();
 
 		foreach ( $serialization as $termSerialization ) {
@@ -57,7 +57,7 @@ private function getDeserialized( $serialization ) {
 	}
 
 	/**
-	 * @param array $serialization
+	 * @param array[] $serialization
 	 *
 	 * @throws DeserializationException
 	 */
@@ -86,15 +86,11 @@ private function assertRequestedAndActualLanguageMatch(
 	}
 
 	private function assertAttributeIsArray( array $array, $attributeName ) {
-		$this->assertAttributeInternalType( $array, $attributeName, 'array' );
-	}
-
-	private function assertAttributeInternalType( array $array, $attributeName, $internalType ) {
-		if ( gettype( $array[$attributeName] ) !== $internalType ) {
+		if ( !is_array( $array[$attributeName] ) ) {
 			throw new InvalidAttributeException(
 				$attributeName,
 				$array[$attributeName],
-				"The internal type of attribute '$attributeName' needs to be '$internalType'"
+				"The internal type of attribute '$attributeName' needs to be 'array'"
 			);
 		}
 	}

diff --git a/src/Serializers/AliasGroupListSerializer.php b/src/Serializers/AliasGroupListSerializer.php
@@ -37,7 +37,7 @@ public function __construct( Serializer $aliasGroupSerializer, $useObjectsForMap
 	/**
 	 * @param AliasGroupList $object
 	 *
-	 * @return array
+	 * @return array[]
 	 */
 	public function serialize( $object ) {
 		$this->assertIsSerializerFor( $object );
@@ -56,7 +56,7 @@ private function assertIsSerializerFor( $object ) {
 	/**
 	 * @param AliasGroupList $aliasGroupList
 	 *
-	 * @return array
+	 * @return array[]
 	 */
 	private function getSerialized( AliasGroupList $aliasGroupList ) {
 		$serialization = array();

diff --git a/src/Serializers/AliasGroupSerializer.php b/src/Serializers/AliasGroupSerializer.php
@@ -1,6 +1,7 @@
 <?php
 
 namespace Wikibase\DataModel\Serializers;
+
 use Serializers\Exceptions\UnsupportedObjectException;
 use Serializers\Serializer;
 use Wikibase\DataModel\Term\AliasGroup;
@@ -14,11 +15,10 @@
  */
 class AliasGroupSerializer implements Serializer {
 
-
 	/**
 	 * @param AliasGroup $object
 	 *
-	 * @return array
+	 * @return array[]
 	 */
 	public function serialize( $object ) {
 		$this->assertIsSerializerFor( $object );
@@ -37,7 +37,7 @@ private function assertIsSerializerFor( $object ) {
 	/**
 	 * @param AliasGroup $aliasGroup
 	 *
-	 * @return array
+	 * @return array[]
 	 */
 	private function getSerialized( AliasGroup $aliasGroup ) {
 		$serialization = array();

diff --git a/src/Serializers/ReferenceListSerializer.php b/src/Serializers/ReferenceListSerializer.php
@@ -45,7 +45,7 @@ public function isSerializerFor( $object ) {
 	 * @param ReferenceList $object
 	 *
 	 * @throws SerializationException
-	 * @return array
+	 * @return array[]
 	 */
 	public function serialize( $object ) {
 		if ( !$this->isSerializerFor( $object ) ) {

diff --git a/src/Serializers/SnakListSerializer.php b/src/Serializers/SnakListSerializer.php
@@ -53,7 +53,7 @@ public function isSerializerFor( $object ) {
 	 * @param SnakList $object
 	 *
 	 * @throws SerializationException
-	 * @return array
+	 * @return array[]
 	 */
 	public function serialize( $object ) {
 		if ( !$this->isSerializerFor( $object ) ) {

diff --git a/src/Serializers/StatementListSerializer.php b/src/Serializers/StatementListSerializer.php
@@ -52,7 +52,7 @@ public function isSerializerFor( $object ) {
 	 * @param StatementList $object
 	 *
 	 * @throws SerializationException
-	 * @return array
+	 * @return array[]
 	 */
 	public function serialize( $object ) {
 		if ( !$this->isSerializerFor( $object ) ) {

diff --git a/src/Serializers/TermListSerializer.php b/src/Serializers/TermListSerializer.php
@@ -39,7 +39,7 @@ public function __construct( Serializer $termSerializer, $useObjectsForMaps ) {
 	 *
 	 * @param TermList $object
 	 *
-	 * @return array
+	 * @return array[]
 	 * @throws SerializationException
 	 */
 	public function serialize( $object ) {
@@ -59,7 +59,7 @@ private function assertIsSerializerFor( $object ) {
 	/**
 	 * @param TermList $termList
 	 *
-	 * @return array
+	 * @return array[]
 	 */
 	private function getSerialized( TermList $termList ) {
 		$serialization = array();

diff --git a/src/Serializers/TermSerializer.php b/src/Serializers/TermSerializer.php
@@ -18,7 +18,7 @@ class TermSerializer implements Serializer {
 	/**
 	 * @param Term $object
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function serialize( $object ) {
 		$this->assertIsSerializerFor( $object );
@@ -37,7 +37,7 @@ private function assertIsSerializerFor( $object ) {
 	/**
 	 * @param Term $term
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	private function getSerialized( Term $term ) {
 		$result = array(