Brain is an elegant Laravel Package that helps you organize your Laravel application using Domain-Driven Design principles through a simple command-line interface.
- 🎯 Domain-Driven Structure: Easily create new domains with proper architecture
- 🔄 Process Management: Generate process classes for complex business operations
- 🔍 Query Objects: Create dedicated query classes for database operations
- ⚡ Task Management: Generate task classes for background jobs and queue operations
- ♻️ Code Reusability: By using tasks, you can easily reuse code across different processes, reducing duplication and enhancing maintainability.
- 🧩 Clear Domain Understanding: The structured approach provides a better understanding of each domain's processes, making it easier to manage and scale your application.
- 🔧 Improved Maintainability: With well-defined domains and processes, maintaining and updating your application becomes more straightforward and less error-prone.
You can install the package via composer:
composer require r2luna/brainphp artisan make:process CreateUserProcess --domain=UsersThis will create a new process class in app/Brain/Users/Processes/CreateUserProcess.php
php artisan make:task SendWelcomeEmailTask --domain=UsersThis will create a new task class in app/Brain/Users/Tasks/SendWelcomeEmailTask.php
php artisan make:query GetUserByEmailQuery --domain=UsersThis will create a new query class in app/Brain/Users/Queries/GetUserByEmailQuery.php
// Using a Query
$user = GetUserByEmailQuery::run('[email protected]');
// Setting up a Process
class CreateUserProcess extends Process
{
protected array $tasks = [
RegisterUserTask::class,
SendWelcomeEmailTask::class, // Async task
NotifyStaffTask::class, // Async task
SubProcess::class
];
}
// Using a Process
CreateUserProcess::dispatch([
'name' => 'John Doe',
'email' => '[email protected]'
]);
// Using a Task without a process
SendWelcomeEmailTask::dispatch([
'user' => $user
]);Brain helps you organize your code into three main concepts:
- Processes: Complex business operations that might involve multiple steps
- Queries: Database queries and data retrieval operations
- Tasks: Sync/Async operations that can be called as part of a process or not
Each concept is organized within its respective domain, promoting clean architecture and separation of concerns.
composer testPlease see CONTRIBUTING for details.
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.