Download the PHP package okipa/laravel-base-repository without Composer
On this page you can find all versions of the php package okipa/laravel-base-repository. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download okipa/laravel-base-repository
More information about okipa/laravel-base-repository
Files in okipa/laravel-base-repository
Package laravel-base-repository
Short Description An abstract base repository with predefined common features.
License MIT
Homepage https://github.com/Okipa/laravel-base-repository
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-base-repository
laravel-base-repository
An abstract base repository with predefined common features.
Before starting
The repository pattern has several objectives :
- Encourage development good practices (separation of concerns, code reusability, ...)
- Improve code testability
Before using this package, you should be familiar with the repository pattern, and especially with its Laravel implementation.
You can know more about it by reading the several articles you'll can find on Internet about this.
Here is one among others : https://medium.com/@jsdecena/refactor-the-simple-tdd-in-laravel-a92dd48f2cdd.
Notes :
- This base repository does NOT allow you to manipulate the model : it can sometimes be tempting to directly manipulate the model from your controller but this is not recommended and recognized as a bad practice.
- You should always fill your repositories interfaces : it can avoid huge errors on your projects.
- The provided methods are shortcuts to avoid you to declare them in your own base repository or in several repositories. Keep in mind that they only are pre-defined methods and that you should declare new methods in your repositories if they does not fit with your needs.
Installation
The repository pattern setup is not complicated but requires several steps to be accomplished.
Follow them one by one :
-
Install the package with composer :
-
Create a
app/Repositoriesdirectory where you will store your different project repositories. -
Create your
app/Repositories/BaseRepositoryInterface.phpinterface and yourapp/Repositories/BaseRepository.phpabstract class : -
Create a first
UserRepositoryInterfaceand its associatedUserRepository: -
Create your project
app/Providers/RepositoryServiceProvider.phpfile. You can follow the example below : -
Add your
RepositoryServiceProviderto the providers declarations of the Laravel framework, in theconfig/app.php: - Add a
$repositoryattribute to yourapp/Http/Controllers/Controller.phpbase controller that all your controllers will extends :
And you're done !
You can now use your UserRepository, empowered with the pre-defined methods provided by this package.
Usage
In your app/Http/Controllers/Users/UsersController.php, manipulate your UserRepository as in the example bellow :
API
Properties
See the protected properties that can be overridden in your own repositories in the BaseRepository.
Public methods
See the available public methods in the BaseRepositoryInterface.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributors
License
The MIT License (MIT). Please see License File for more information.
