Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicoaudy/repository
Repository pattern package for laravel users
https://github.com/nicoaudy/repository
Last synced: about 6 hours ago
JSON representation
Repository pattern package for laravel users
- Host: GitHub
- URL: https://github.com/nicoaudy/repository
- Owner: nicoaudy
- Created: 2017-05-12T04:03:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-05-12T04:24:13.000Z (over 7 years ago)
- Last Synced: 2024-05-04T19:44:30.424Z (9 months ago)
- Language: PHP
- Homepage:
- Size: 10.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Laravel Repositories
Laravel Repositories is a package for Laravel 5 which is used to abstract the database layer. This makes applications much easier to maintain.
## Installation
Run the following command from you terminal:
```bash
composer require "nicoaudy/repository: 0.*"
```
or add this to require section in your composer.json file:
```
"nicoaudy/repository": "0.*"
```
then run ```composer update```
## Usage
First, create your repository class. Note that your repository class MUST extend ```Nicoaudy\Repositories\Eloquent\Repository``` and implement model() method
```php
'float'
];
}
```
And finally, use the repository in the controller:
```php
film = $film;
}
public function index() {
return \Response::json($this->film->all());
}
}
```
## Available Methods
The following methods are available:
##### Nicoaudy\Repositories\Contracts\RepositoryInterface
```php
public function all($columns = array('*'))
public function lists($value, $key = null)
public function paginate($perPage = 1, $columns = array('*'));
public function create(array $data)
// if you use mongodb then you'll need to specify primary key $attribute
public function update(array $data, $id, $attribute = "id")
public function delete($id)
public function find($id, $columns = array('*'))
public function findBy($field, $value, $columns = array('*'))
public function findAllBy($field, $value, $columns = array('*'))
public function findWhere($where, $columns = array('*'))
```
##### Nicoaudy\Repositories\Contracts\CriteriaInterface
```php
public function apply($model, Repository $repository)
```
### Example usage
Create a new film in repository:
```php
$this->film->create(Input::all());
```
Update existing film:
```php
$this->film->update(Input::all(), $film_id);
```
Delete film:
```php
$this->film->delete($id);
```
Find film by film_id;
```php
$this->film->find($id);
```
you can also chose what columns to fetch:
```php
$this->film->find($id, ['title', 'description', 'release_date']);
```
Get a single row by a single column criteria.
```php
$this->film->findBy('title', $title);
```
Or you can get all rows by a single column criteria.
```php
$this->film->findAllBy('author_id', $author_id);
```
Get all results by multiple fields
```php
$this->film->findWhere([
'author_id' => $author_id,
['year','>',$year]
]);
```
## Criteria
Criteria is a simple way to apply specific condition, or set of conditions to the repository query. Your criteria class MUST extend the abstract ```Nicoaudy\Repositories\Criteria\Criteria``` class.
Here is a simple criteria:
```php
where('length', '>', 120);
return $model;
}
}
```
Now, inside you controller class you call pushCriteria method:
```php
film = $film;
}
public function index() {
$this->film->pushCriteria(new LengthOverTwoHours());
return \Response::json($this->film->all());
}
}
```
## Credits
This package is largely inspired by [this](https://github.com/prettus/l5-repository) great package by @andersao. [Here](https://github.com/anlutro/laravel-repository/) is another package I used as reference.