Switched back return type definition

Author: dpanta94

src/Models/Model.php

@@ -484,7 +484,7 @@ protected function purgeRelationship( string $key ): void {
 	 * @since 2.0.0
 	 *
 	 * @param string $key Relationship name.
-	 * @param mixed $value The relationship value to cache.
+	 * @param Model|list<Model>|null $value The relationship value to cache.
 	 *
 	 * @return void
 	 */

src/Models/ModelRelationship.php

@@ -159,22 +159,17 @@ public function purge(): void {
 	 */
 	public function setValue( $value ): self {
 		if ( $value !== null ) {
-			if ( $this->definition->isSingle() && ! $this->definition->getValidateRelationshipWith()( $value ) ) {
-				throw new InvalidArgumentException( 'Relationship value must be a valid value.' );
+			if ( $this->definition->isSingle() ) {
+				$value = $this->definition->getValidateSanitizeRelationshipWith()( $value );
 			}
 
 			if ( $this->definition->isMultiple() ) {
 				if ( ! is_array( $value ) ) {
-					throw new InvalidArgumentException( 'Multiple relationship value must be an array or null.' );
+					Config::throwInvalidArgumentException( 'Multiple relationship value must be an array or null.' );
 				}
 
-				foreach ( $value as $item ) {
-					if ( $this->definition->getValidateRelationshipWith()( $item ) ) {
-						continue;
-					}
-
-					throw new InvalidArgumentException( 'Multiple relationship value must be an array of valid values.' );
-				}
+				$sanitizer = $this->definition->getValidateSanitizeRelationshipWith();
+				$value = array_map( $sanitizer, $value );
 			}
 		}
 

src/Models/ModelRelationshipDefinition.php

@@ -33,13 +33,13 @@ class ModelRelationshipDefinition {
 	private $hydrateWith = null;
 
 	/**
-	 * The callable to validate the relationship with.
+	 * The callable to validate and sanitize the relationship with.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @var ?callable
 	 */
-	private $validateRelationshipWith = null;
+	private $validateSanitizeRelationshipWith = null;
 
 	/**
 	 * Whether the definition is locked. Once locked, the definition cannot be changed.
@@ -129,12 +129,12 @@ public function getHydrateWith(): callable {
 	 *
 	 * @since 2.0.0
 	 *
-	 * @param callable $validateRelationshipWith The callable to validate the relationship with.
+	 * @param callable $validateSanitizeRelationshipWith The callable to validate the relationship with.
 	 */
-	public function setValidateRelationshipWith( callable $validateRelationshipWith ): self {
+	public function setValidateSanitizeRelationshipWith( callable $validateSanitizeRelationshipWith ): self {
 		$this->checkLock();
 
-		$this->validateRelationshipWith = $validateRelationshipWith;
+		$this->validateSanitizeRelationshipWith = $validateSanitizeRelationshipWith;
 
 		return $this;
 	}
@@ -143,10 +143,18 @@ public function setValidateRelationshipWith( callable $validateRelationshipWith
 	 * Get the callable to validate the relationship with.
 	 *
 	 * @since 2.0.0
+	 *
+	 * @return callable( mixed $thing ): ( Model | null )
 	 */
 
-	public function getValidateRelationshipWith(): callable {
-		return $this->validateRelationshipWith ?? fn( $thing ): bool => null === $thing || $thing instanceof Model;
+	public function getValidateSanitizeRelationshipWith(): callable {
+		return $this->validateSanitizeRelationshipWith ?? function( $thing ): ?Model {
+			if ( null !== $thing && ! $thing instanceof Model ) {
+				throw new InvalidArgumentException( 'Relationship value must be a valid value.' );
+			}
+
+			return $thing;
+		};
 	}
 
 	/**

tests/wpunit/ModelRelationshipTest.php

@@ -234,7 +234,15 @@ protected static function properties(): array {
 			protected static function relationships(): array {
 				$definition = new ModelRelationshipDefinition('post', Relationship::HAS_ONE());
 				$definition->setHydrateWith( fn( int $post_id ) => get_post( $post_id ) );
-				$definition->setValidateRelationshipWith( fn( $post_or_post_id ) => get_post( $post_or_post_id ) instanceof WP_Post );
+				$definition->setValidateSanitizeRelationshipWith( function ( $post_or_post_id ) {
+					$p = get_post( $post_or_post_id );
+					if ( ! $p instanceof WP_Post ) {
+						throw new \InvalidArgumentException( 'Post must be a valid WP_Post object.' );
+					}
+
+					return $p->ID;
+				});
+
 				return [
 					'post' => $definition,
 				];
@@ -254,5 +262,12 @@ protected static function relationships(): array {
 
 		$this->assertInstanceOf(WP_Post::class, $myModel->post);
 		$this->assertEquals($post_id, $myModel->post->ID);
+
+		$myModel->setCachedRelationship('post', null);
+		$this->assertNull($myModel->post);
+
+		$myModel->setCachedRelationship('post', get_post($post_id));
+		$this->assertInstanceOf(WP_Post::class, $myModel->post);
+		$this->assertEquals($post_id, $myModel->post->ID);
 	}
 }