Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manchenkoff/laravel-repositories
Repository pattern implementation for your Laravel application
https://github.com/manchenkoff/laravel-repositories
laravel laravel-framework laravel-package php repository repository-pattern
Last synced: 4 days ago
JSON representation
Repository pattern implementation for your Laravel application
- Host: GitHub
- URL: https://github.com/manchenkoff/laravel-repositories
- Owner: manchenkoff
- License: mit
- Created: 2023-09-24T17:31:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-24T22:48:44.000Z (about 1 month ago)
- Last Synced: 2024-09-26T01:16:35.451Z (8 days ago)
- Topics: laravel, laravel-framework, laravel-package, php, repository, repository-pattern
- Language: PHP
- Homepage: https://packagist.org/packages/manchenkoff/laravel-repositories
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Repositories
Package provides a basic implementation of Repository pattern with `artisan` command to generate classes.
Features:
- `Repository` class with basic methods like `all`, `find`, `create`, `update`, `delete`
- Generic type comments to pass `PHPStan` checks
- Artisan `make:repository` command to generate repository class with model and interface
## Installation
To install this package, you need to install [Composer](https://getcomposer.org/) first, and then run:
```bash
composer require manchenkoff/laravel-repositories
```
or add this line to `composer.json`:
```json
"manchenkoff/laravel-repositories": "*"
```
and run `composer update` in the terminal.
Package should automatically register its service provider in your application, but you can do it manually in `config/app.php`:
```php
'providers' => ServiceProvider::defaultProviders()
->merge([
// Package Service Providers
\Manchenkoff\Laravel\Repositories\ServiceProvider::class,
// Application Service Providers
// ...
])
->toArray(),
```
## Usage
First of all, you need to create a model class for your repository. You can do it manually or use `artisan` command:
```bash
php artisan make:model Post
```
Then you can create a repository class for your model:
```bash
# repository name - PostRepository
# model name - Post
php artisan make:repository PostRepository Post
```
This command will create a repository class in `app/Repositories` directory and `PostRepositoryInterface` contract class in `app/Contracts/Repositories`.
Now you can use existing methods in your services or extend with custom functionality:
```php
repository = $repository;
}
public function getAllPosts(): Collection
{
return $this->repository->all();
}
}
```
## Implementation
All repository methods use protected `query()` method to get `Eloquent\Builder` instance. You can override this method in your repository class to add custom logic, e.g. when you always need some relations to be loaded or custom sorting applied.
```php
protected function query(): Builder
{
return parent::query()->with('comments')->orderBy('created_at', 'desc');
}
```
Here is a list of available methods with a quick description:
| Method | Description |
| ------------------------------------------- | ------------------------------------------------------- |
| `paginated(): LengthAwarePaginator` | returns paginated collection |
| `all(): Collection` | returns all entities |
| `find(mixed $id): ?Model` | returns entity by id or null |
| `get(mixed $id): Model` | returns entity by id or throws `ModelNotFoundException` |
| `create(array $data): Model` | creates new entity with given data |
| `update(Model $entity, array $data): Model` | updates existing entity with given data |
| `updateMany(array $ids, array $data): void` | updates many entities with given data by ids |
| `delete(Model $entity): Model` | deletes existing entity |
| `deleteMany(array $ids): void` | deletes many entities by ids |
Also you might want to adjust class template for your needs. You can do it by publishing package views:
```bash
php artisan vendor:publish --provider="Manchenkoff\Laravel\Repositories\ServiceProvider"
```
## Development
This package is completely open-source, so any contributions are welcome!
Clone this repository to your local machine, install dependencies and run tests:
```bash
git clone https://github.com/manchenkoff/laravel-repositories
cd laravel-repositories
composer install
composer test
```
There are some useful `composer` scripts:
| Script | Description |
| --------------------- | ---------------------------------------------- |
| `composer fmt` | Apply Laravel Pint code style rules |
| `composer test` | Run tests with Testbench package |
| `composer lint` | Run PHP Stan analysis against package codebase |
| `composer rector` | Run Rector analysis against package codebase |
| `composer rector:fix` | Apply available Rector suggestions |