[11.x] Add getConnection() Method to Factory Class for Retrieving Database Connection

[jonathanpmartins]

Context: I’m proposing a small but useful addition to the Illuminate\Database\Eloquent\Factories\Factory class by introducing a getConnection() method. This method allows developers to retrieve the database connection used by a factory when generating models.

Problem: Currently, there’s no easy way to access the database connection associated with a factory. In certain scenarios, especially when working with factories in testing environments on multi-database setups, having access to this connection would be valuable. This change makes it easier to inspect and work with the connection, especially when debugging or ensuring models are generated with the correct database connection.

Solution: I have added the following method to the Factory class:

/**
 * Get the database connection that is used to generate models.
 *
 * @return string
 */
public function getConnection()
{
    return $this->connection;
}

This method will simply return the connection that was set when the factory instance was created.

Tests: I have added a test case that verifies the behavior of the new getConnection() method. The test sets a custom connection on the factory and ensures that the getter retrieves the correct connection:

public function test_get_connection_used_to_create_a_model()
{
    $factory = FactoryTestUserFactory::new()->connection('custom-connection');

    $this->assertSame('custom-connection', $factory->getConnection());
}

I believe this small enhancement could be beneficial for those working with Laravel factories in environments where multiple database connections are used, as it provides a simple way to inspect and work with connections at the factory level.

Thank you for your consideration, and I’m happy to discuss any feedback or make any adjustments as needed.