How a 30 lines piece of script can finally provide a good solution for a repository pattern in Laravel apps.
Laravel provides a beautiful way to query your database through Eloquent, an Object Relational Mapping. The moment your project becomes larger there starts to rise a problem. The difference between entities and models start to become vague. Let me give you an example:
We have two methods, one called
findByName and one called
What we are actually doing here is mixing methods for retrieving (collections of) Products, with methods for instances of 1 Product.
A much cleaner approach would be to separate them into 2 different classes. One for obtaining instances and collections of models and one for the model definition itself. You might call this the repository pattern.
There are several libraries for Laravel to start using the repository pattern. One thing that's a huge disadvantage to me is that you can't use Eloquent functions on your repositories. Since Eloquent is a huge reason why I am using Laravel I still wanted to be able to use Eloquent on repositories for obtaining models.
I created a very simple piece of code which enables all the features of Eloquent on your repositories. This way you can use the repository pattern in a way which is fun and keep your models and your repositories clean! A repository with the use of
laravel-repositories would look like this:
By the use of the Repository trait and the
laravel-repositories knows which model to query and where to use Eloquent and where to use your own repository methods.
With this definition of the repository we can now use it in our controllers, jobs, commands etc:
Go try it out and leave me some feedback for improvement!
I'm currently working on Laravel Pigeon, a notification center where you can easily communicate with your users. Check it out and sign up for early access!