nolanos/laravel-doctrine-factory

Generate Typescript definitions for your Eloquent models

v1.6.0 2024-10-10 15:37 UTC

This package is auto-updated.

Last update: 2024-10-10 15:38:19 UTC


README

Use Eloquent Factories with your Doctrine Entities.

Installation

Install via Composer:

composer require nolanos/laravel-doctrine-factory

Usage

Create Laravel factories and extend Nolanos\LaravelDoctrineFactory\DoctrineFactory instead of the usual Illuminate\Database\Eloquent\Factories\Factory.

DoctrineFactory subclasses the default Factory to override how it instantiates and saves the objects. Everything else works exactly the same.

Design Philosophy

No Documentation Necessary

The goal of this package is to provide a drop-in replacement for Laravel's default factories that works with Doctrine entities. It should mirror the existing API so closely that you could read the Laravel documentation and use this package without any additional documentation (beyond setup).

Explained Overrides

Quite a few methods are overridden by this package to make Factories work with Doctrine entities. The doc blocks of all overridden methods will be explained next to the @override tag.

Development

Setup

git clone git@github.com:nolanos/laravel-doctrine-factory.git

cd laravel-doctrine-factory

composer install

Running Tests

composer test

Publishing new Versions

To publish a new version of the package, you need to create a new tag and push it to the repository.

git tag vx.x.x
git push origin vx.x.x

Go to Packagist and click on "Update" to update the package.