Session: How to Refresh an Entity

To update an entity with the latest changes from the server, use the refresh method from advanced session operations.

Syntax

public function refresh(object $entity): void;
Parameter Type Description
$entity object An entity that will be refreshed

Example

$employee = $session->load(Employee::class, "employees/1");
$this->assertEquals("Doe", $employee->getLastName());

// LastName changed to 'Shmoe'

$session->advanced()->refresh($employee);

$this->assertEquals("Shmoe", $employee->getLastName());

Remarks

Refreshing a transient entity (not attached) or an entity that was deleted on server-side will result in a InvalidOperationException.