Factory
The Factory is responsible for creating the internal objects of your module and wiring their dependencies, pulling values from Config and services from the Provider.
Key points
Creating your objects
The Factory is where you build your domain services, injecting whatever they need.
Full code snippet: gacela-example/comment-spam-score/factory
<?php # src/Comment/CommentFactory.php
namespace App\Comment;
use App\Comment\Domain\SpamChecker;
use Gacela\Framework\AbstractFactory;
use Symfony\Contracts\HttpClient\HttpClient;
/**
* @method CommentConfig getConfig()
*/
final class CommentFactory extends AbstractFactory
{
public function createSpamChecker(): SpamChecker
{
return new SpamChecker(
HttpClient::create(),
$this->getConfig()->getSpamCheckerEndpoint()
);
}
}<?php # src/Comment/Domain/SpamChecker.php
namespace App\Comment\Domain;
use Symfony\Contracts\HttpClient\HttpClientInterface;
final class SpamChecker
{
public function __construct(
private HttpClientInterface $client,
private string $endpoint
) {}
public function getSpamScore(string $comment): int
{
// your business logic
return $x;
}
}Auto-wiring dependencies into the Factory
Gacela auto-wires Factory constructor dependencies. Concrete classes are instantiated automatically (recursively resolving their own dependencies). For interfaces, you need to tell Gacela which implementation to use by defining a binding:
<?php # gacela.php
return function (GacelaConfig $config) {
// Class binding: Gacela instantiates Concrete (and auto-wires its deps)
$config->addBinding(InterfaceToConcrete::class, Concrete::class);
// Callable binding: lazy-loaded, you control the instantiation
$config->addBinding(InterfaceToCallable::class, fn() => new Concrete());
};The difference between these two styles:
- Class binding (
Concrete::class): Gacela creates a new instance on the fly, auto-wiring its constructor dependencies recursively - Callable binding (
fn() => ...): You control instantiation. The closure is lazy-loaded, it only runs when the dependency is needed
Real example: symfony-gacela-example/gacela.php
For a per-parameter alternative to constructor auto-wiring, see the #[Inject] attribute.
Sharing a single instance
Plain create...() methods build a fresh object on every call. When a dependency should instead be built once and reused, use singleton():
protected function singleton(string $key, callable $creator): mixed;It memoises the result of $creator under $key and returns the same instance on every later call within the module. The creator is lazy — it only runs on first access.
<?php # src/Comment/CommentFactory.php
final class CommentFactory extends AbstractFactory
{
public function createSpamChecker(): SpamChecker
{
return $this->singleton(
SpamChecker::class,
fn (): SpamChecker => new SpamChecker(
HttpClient::create(),
$this->getConfig()->getSpamCheckerEndpoint(),
),
);
}
}Key points
create...()methods build a new instance every call;singleton()builds once and reuses it- Since 1.17.0,
singleton()is generic (@template T,@return T): the inferred return type matches what$creatorreturns, no cast needed