Download the PHP package inz/repository without Composer
On this page you can find all versions of the php package inz/repository. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download inz/repository
More information about inz/repository
Files in inz/repository
Package repository
Short Description Repository pattern file generator for laravel projects
License MIT
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 repository
Repository pattern generator
This package helps you get started quickly to use repository pattern in your next, or current, laravel project because after watching those laracon videos (which by the way are A LOT :p) that talks about design patterns and SOLID principals you became all hipped to try and adapt them, at least i'm :D.
Content
- Introductory
- Installation
- Configuration
- Usage
- Generating contract & implementation
- Binding contract to implementation
- Functionalities
- Repository abstract class
- Methods
- Soft-deleted records
- Contribution
Introductory
Using this package will help you spend more time focusing on your application's logic by taking care of generating and implementing a layer that sits between the logic and the database. It generates:
-
Repository Contract: which is an empty interface that can be used to add custom methods to the repository implementation class so you can extend the functionalities, it's also used during binding process.
- Implementation Class: a class in which the repository logic reside, it implements the generated contract.
Note: for now, the minimum laravel version this package is tested on is 5.5
Installation
if you using laravel 5.4 and below, you need to add the package's service provider in config/app.php
then, you need to publish the configuration file so the package can do it's work properly:
this will copy the package's configuration file into config folder of the application, more about it in configuration section
Configuration
The configuration file for the package contains a group of settings which can be modified to satisfy your needs, they have a hopefully clear comments that describes their purposes.
- path is used to create root directory for the files.
- namespace is used to set a namespace for the file.
-
providers array where you set the base path and namespace of the providers in your application so the package can determine where and under what it should define the repository service provider.
-
namespaces array determines the namespaces for different files, note that
App\is not present because it will be added if specified. - paths array determines the paths for different files,
Repositoriesrepresent the root directory for them and what goes after the slash is the directory for those files, note thatapp/is not present because it will be added if specified.
Usage
Generating contract & implementation
To generate a full scaffold, you run
Notes
-
if the model doesn't exist, you will be asked if you want to create it, if so it will be created.
-
If one of the other files exist already you will be asked to override it, if so it will, thus be careful about this situation to avoid losing written code.
- This command will bind the classes also.
- Don't forget to register the
RepositoryServiceProviderinapp.phpafter it is generated.
Binding contract to implementation
to bind a contract class to an implementation of a certain model, use the command:
- using the model name, the package can determine the corresponding contract and implementation classes
Currently, the package will not check if the classes (model, contract or implementation) exist, this will be fixed in the upcoming version.
- if the service provider doesn't exist it will create one
- if the repository is already bound it won't complete the process.
Functionalities
Repository abstract class
In Inz\Base\Abstractions\Repository you can find the implementation of Inz\Base\Interfaces\RepositoryInterface that describes the methods used to access the database.
| Properties | Why |
|---|---|
protected $model; |
model instance used to query data |
protected $attributes; |
attributes list of the model, also the list of columns of the table, excluding the ones in $excludedColumns. |
protected $excludedColumns; |
to define the columns that will be excluded when the repository object operates on the table, to add other columns to this array just override it in your repository implementation class. |
Methods
Here is the list of available methods of the repository class:
Note: Repository class should be implemented the way you desire, so use the interface to define the blueprint for it and implement additional methods or override existing ones in the concrete class.
| Method | Parameters | Return | Description |
|---|---|---|---|
| all(); | array cols default ['*'] |
Collection | similar to all() of eloquent model |
| first(); | Model instance or null | similar to first() of eloquent model |
|
| find(); | mixed id |
Model instance or null | similar to find() of eloquent model |
| findWhere(); | String column, mixed value & String operator |
Collection | finds all records that match the condition of where clause |
| findFirstWhere(); | String column, mixed value & String operator |
Model instance or null | finds the first record that matches the condition of where clause |
| paginate(); | int count default 10 |
LengthAwarePaginator instance | similar to paginate() of eloquent model |
| save(); | array data = [column => value] |
boolean | creates a new instance based on the passed data and persist it to storage |
| update(); | int id & array data = [column => value] |
boolean | updates a record based on the passed data and persist it to storage, if the record doesn't exist false is returned |
| delete(); | int id |
boolean | similar to delete() of eloquent model |
| count(); | int | similar to count() of eloquent model |
Soft deleted records
To handle trashed records of the table (if using soft delete trait in the model), use trait Inz\Base\Traits\TrashedOperations in repository implementation class, it contains this set of methods:
| Method | Parameters | Return | Description |
|---|---|---|---|
| allTrashed(); | array cols default ['*'] |
Collection | returns soft-deleted records only |
| allWithTrashed(); | array cols default ['*'] |
Collection | returns the whole records of the table |
| firstTrashed(); | Model instance or null | fetches the first record from trashed ones only | |
| findTrashed(); | mixed id |
Model instance or null | fetches a record of the passed id from trashed ones only |
| findWithTrashed(); | mixed id |
Model instance or null | fetches a record of the passed id from the whole table |
| countTrashed(); | int | returns the count of trashed records in the table | |
| countWithTrashed() | int | returns the count of all records in the table | |
| restore(); | mixed id |
boolean | restore a soft-deleted record in trashed ones |
| erase(); | mixed id |
boolean | permanently deletes a record from the table |
Contribution
Feel free to make any pull request, any contribution is welcomed. If you encountered a problem, use the issues section.
