I read the Laravel Beyond CRUD series and decided this is the way. But I'm a lazy coder: I really don't like to write a lot of code. So, I needed a toolkit to automate as much coding as possible. And here it is!
- PHP 7.2.5+
- Laravel 7+
It provides:
- multiple console commands to create domain driven classes
- traits and classes to speed up development
The commands prefix is domain:
.
Let's start with a clean Laravel installation. From your favorite shell:
laravel new project
Then install the library:
cd project
composer require filippo-toso/laravel-domain-library
composer require spatie/data-transfer-object spatie/laravel-model-states spatie/laravel-query-builder spatie/laravel-view-models
The additional Spatie's packages are required for data transfer objects, model states, query builders and view models.
Now the fun part... First, we are going to build the domain structure:
php artisan domain:setup:structure
This command will create a new src
folder that will contain 3 namespaces App
, Domain
and Support
.
It will also rewire the Laravel application to work with this new directory structure (ie. moving middlewares and providers, updating the bootstrap code, introducing a new Application class, and so on).
At this point you can start building your domain driven application. Let's create the structure for a sample domain named Invoices
php artisan domain:make:domain Invoices
Then we will prepare the administrative application part for this domain:
php artisan domain:make:application Admin\Invoices
With this library you can make the following classes:
- Models (with support for custom collections, query builders and subscribed events)
- Model's states (using spatie/laravel-model-states)
- Model's subscribers and model events (automagically linked to models)
- Model's query builders (automagically loaded)
- Model's collections (automagically loaded)
- Data transfer objects (using spatie/data-transfer-object)
- HTTP queries (using spatie/laravel-query-builder)
- View models (using spatie/laravel-view-models)
- Actions
- Form requests
All the commands include a --force
option to overwrite existing classes. Please keep in mind that with great power comes great responsibility
If you want to customize the generated code, you can publish the stubs and then edit them.
php artisan vendor:publish --tag=stubs --provider="FilippoToso\Domain\Support\ServiceProvider"
php artisan domain:make:model Invoice --domain=Invoices
php artisan domain:make:states --model=Invoice --domain=Invoices --states=Paid,Pending,Overdue,Cancelled
php artisan domain:make:subscriber --model=Invoice --domain=Invoices
php artisan domain:make:events --model=Invoice --domain=Invoices --events=saving,created,deleting
php artisan domain:make:subscriber --model=Invoice --domain=Invoices --events=saving,created,deleting
php artisan domain:make:collection --model=Invoice --domain=Invoices
php artisan domain:make:querybuilder --model=Invoice --domain=Invoices
php artisan domain:make:dto Invoice --domain=Invoices --application=Admin\Invoices
php artisan domain:make:query InvoiceIndex --domain=Invoices --application=Admin\Invoices --model=Invoice
php artisan domain:make:viewmodel InvoiceForm --domain=Invoices --application=Admin\Invoices --model=Invoice
php artisan domain:make:action InvoiceIndex --domain=Invoices --application=Admin\Invoices --model=Invoice
php artisan domain:make:request Invoice --application=Admin\Invoices
php artisan domain:make:exception InvalidInvoice --domain=Invoices
This command will create all the classes above in a single sweep:
php artisan domain:make:suite
--domain=Invoices
--application=Admin\Invoices
--model=Invoice
--states=Paid,Pending,Overdue,Cancelled
--events=saving,created,deleting
--dtos=Invoice,CreateInvoice
--queries=InvoiceIndex
--dtos=Invoice,CreateInvoice
--exceptions=InvalidInvoice
--queries=InvoiceIndex
--requests=Invoice
--viewmodels=InvoiceForm
--actions=CreateInvoice,PayInvoice,CancelInvoice