FactoryTrait

FactoryTrait allows creating models and relations using yiisoft/factory. This is required for Using Dependency Injection With Active Record.

Methods

The following method is provided by the FactoryTrait:

• withFactory() clones the current instance of Active Record then sets the factory for the new instance and returns the new instance.

Usage

use Yiisoft\ActiveRecord\ActiveRecord;
use Yiisoft\ActiveRecord\Trait\FactoryTrait;
use Yiisoft\Factory\Factory;

final class User extends ActiveRecord
{
    use FactoryTrait;
    
    public function __construct(Factory $factory, private MyService $myService)
    {
        $this->factory = $factory;
    }
}

$user = $factory->create(User::class); // returns a new User instance with an initialized `Factory` and `MyService` instances.

If the $factory property is initialized, then the defined relations will be created using this factory.

Limitations

When using FactoryTrait, you should not use the static ActiveRecord::query() method. It will not work correctly. Instead, create a new instance of the model using the factory and create a new query object by calling the createQuery() method on the model instance.

$user = $factory->create(User::class);
/** @var Yiisoft\ActiveRecord\ActiveQueryInterface $query */
$query = $user->createQuery();

Then you can use the active query object as usual, for example:

$users = $query->where(['is_active' => true])->all();

Also, you cannot use RepositoryTrait with FactoryTrait, because it uses static ActiveRecord::query() method.

See also

• Using Dependency Injection With Active Record;
• Dependency Injection;
• Factory.

Back to Extending Functionality With Traits.