Add Model::refresh() method to get latest data from server and optionally destroy local changes.

Author: TimothyBJacobs

src/Model.php

@@ -706,6 +706,30 @@ public function is_relation_loaded( $attribute ) {
 		return array_key_exists( $attribute, $this->_relations );
 	}
 
+	/**
+	 * Refresh the attributes on this model.
+	 *
+	 * This will fetch the latest data from either the cache or DB.
+	 *
+	 * @param bool $destroy_changes If true, will destroy local changes.
+	 *
+	 * @since 2.0.0
+	 */
+	public function refresh( $destroy_changes = false ) {
+
+		if ( ! $this->exists() ) {
+			return;
+		}
+
+		$data = (array) static::get_data_from_pk( $this->get_pk() );
+
+		$this->_original = $data;
+
+		if ( $destroy_changes ) {
+			$this->set_raw_attributes( $data );
+		}
+	}
+
 	/**
 	 * Sync the model's original attributes with its current state.
 	 *
@@ -736,7 +760,6 @@ public function sync_original_attribute( $attribute ) {
 		return $this;
 	}
 
-
 	/**
 	 * Determine if the model as a whole or given attribute(s) have been modified.
 	 *

tests/integration/test-crud.php

@@ -407,4 +407,45 @@ public function test_create_many_multiple_queries() {
 		remove_filter( 'ironbound_db_perform_insert_many_as_single_query', '__return_false' );
 	}
 
+	public function test_refresh() {
+		$model        = ModelWithForeignPost::create( array(
+			'price' => 24.75
+		) );
+		$model->price = 50.00;
+
+		$_model        = ModelWithForeignPost::get( $model->get_pk() );
+		$_model->price = 45.00;
+		$_model->save();
+
+		$this->assertEquals( 50.00, $model->price );
+		$this->assertTrue( $model->is_dirty() );
+
+		$model->refresh();
+
+		$this->assertEquals( 50.00, $model->price );
+		$this->assertTrue( $model->is_dirty() );
+
+		$model->price = 45;
+		$this->assertEquals( 45.00, $model->price );
+		$this->assertFalse( $model->is_dirty() );
+	}
+
+	public function test_refresh_and_destroy_local_changes() {
+		$model        = ModelWithForeignPost::create( array(
+			'price' => 24.75
+		) );
+		$model->price = 50.00;
+
+		$_model        = ModelWithForeignPost::get( $model->get_pk() );
+		$_model->price = 45.00;
+		$_model->save();
+
+		$this->assertEquals( 50.00, $model->price );
+		$this->assertTrue( $model->is_dirty() );
+
+		$model->refresh( true );
+
+		$this->assertEquals( 45.00, $model->price );
+		$this->assertFalse( $model->is_dirty() );
+	}
 }