ynsinc / make-ris
Provides Artisan commands to generate Repository, Interface, and Service classes, simplifying the use of the Repository pattern in Laravel.
Installs: 87
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Type:clibrary
README
This package provides Artisan commands for Laravel applications to generate Repository, Interface, and Service classes for models, making it easier to adhere to the Repository pattern and keep your code organized.
Features
Repository Command
Command that creates a repository and its corresponding interface based on a model name.
Service Command
Command that creates a service class, optionally linked to a specific controller.
Installation
Install the package via Composer:
composer require ynsinc/make-ris:dev-main
Register the providers in bootstrap/providers.php
return [ .., YnsInc\MakeRIS\MakeRISServiceProvider::class, ];
Usage
Repository Command
This command creates a repository and interface based on a model name.
Basic Command
php artisan make:repository --model=ModelName
Optional Flags
Flag/Option | Usage | Description |
---|---|---|
--model |
--model=User |
Add a repository and interface based on the model name. |
--subdir |
--subdir=User |
Add a service under a specific directory. |
--name |
--name=CustomName |
Specify a custom name (if needed). |
Examples
With Model Flag
php artisan make:repository --model=User
Outcome:
app/ └── Interfaces/ └── UserInterface.php └── Repositories/ └── UserRepository.php
With Subdirectory Flag
php artisan make:repository --model=User --subdir=User
Outcome:
app/
└── Interfaces/
└── User/
└── UserInterface.php
└── Repositories/
└── User/
└── UserRepository.php
With Name Flag
php artisan make:repository --name=Custom
Outcome:
app/ └── Interfaces/ └── CustomInterface.php └── Repositories/ └── CustomRepository.php
Service Command This command creates a service class.
Basic Command
php artisan make:service
Flag/Option | Usage | Description |
---|---|---|
--controller | --controller=UserManagement | Add a service based on the controller name. |
--subdir | --subdir=User | Add a service under a specific directory. |
--name | --name=CustomName | Add a custom service. (This is a service that is not affiliated to any controller such as Common Services like StripeService, TaxService etc...) |
Examples
With Controller Flag
php artisan make:service --controller=UserManagement
Outcome:
app/ └── Services/ └── UserManagementService.php
With Subdirectory Flag
php artisan make:service --controller=UserManagement --subdir=User
Outcome:
app/ └── Services/ └── User/ └── UserManagementService.php
With Name Flag
php artisan make:service --name=Tax --subdir=Common
Outcome:
app/ └── Services/ └── Common/ └── TaxService.php
Output Repository Command Output Structure:
app/ └── Interfaces/ └── [Subdirectory/]InterfaceName.php └── Repositories/ └── [Subdirectory/]RepositoryName.php
Service Command Output Structure:
app/ └── Services/ └── [Subdirectory/]ServiceName.php
Contributing Feel free to submit issues or pull requests if you find any bugs or have suggestions for improvements.
License
This project is open-sourced software licensed under the MIT license.