Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artesaos/warehouse
Artesãos Warehouse - A simple and direct approach to repositories!
https://github.com/artesaos/warehouse
laravel php repository
Last synced: about 1 month ago
JSON representation
Artesãos Warehouse - A simple and direct approach to repositories!
- Host: GitHub
- URL: https://github.com/artesaos/warehouse
- Owner: artesaos
- License: mit
- Archived: true
- Created: 2015-03-15T17:53:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T20:41:23.000Z (about 5 years ago)
- Last Synced: 2024-09-21T14:06:45.158Z (about 2 months ago)
- Topics: laravel, php, repository
- Language: PHP
- Homepage:
- Size: 54.7 KB
- Stars: 86
- Watchers: 10
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Artesãos Warehouse V2 - A simple and direct approach to repositories!
[](https://packagist.org/packages/artesaos/warehouse)
[](https://packagist.org/packages/artesaos/warehouse)
[](https://packagist.org/packages/artesaos/warehouse)
[](https://packagist.org/packages/artesaos/warehouse)
## O que é Warehouse V2?
Warehouse v2 é um pacote um pouco atípico, já que você pode usá-lo sem precisar baixá-lo. Ele se classificaria melhor como uma demonstração pronta para o uso.
Muito se fala sobre o padrão de projeto Repository, basicamente ele é uma camada a mais entre sua aplicação e o banco de dados, no caso do Laravel sendo responsável direto por agir sobre seus models e queries.
### O que é *Repository Pattern* ?
Basicamente é a camada onde você executa seus comandos no banco de dados.
Há muita filosofia por trás desse modelo. No seu modo mais puro os métodos de um repositório não retornam objetos complexos ou que possuam alguma dependência, retornam arrays ou objetos simples (*StdClass*). Isso por que um de seus objetivos é permitir a troca de um repositório que trabalha com MySQL por exemplo, por um que trabalhe com MongoDB.
#### O mundo real hoje
OK! Tudo muito lindo, no papel. Não são todos os projetos que precisam de uma abordagem assim, se você usa o Laravel, abrir mão do Eloquent não é algo que todos cogitem fazer. E trocar de banco de dados no Laravel não é uma tarefa tão complexa, graças ao Eloquent.
> Devido a facilidade e praticidade que o Eloquent e Collections trazem, este pacote não retorna objetos planos e sim objetos Eloquent e Collections.
Muitos não sabem e outros se esquecem que outro objetivo de um repositório é organizar e centralizar suas consultas e até mesmo regras de negócio. Essa é a principal abordagem que o Warehouse V2 pretende suprir.
-----------------
## Instalando
Execute `composer require artesaos/warehouse 2.x-dev`
No arquivo `config/app.php` adcione o service provider `Artesaos\Warehouse\WarehouseServiceProvider`
```php
'providers' => [
// ...
Artesaos\Warehouse\WarehouseServiceProvider::class,
// ...
],
```
> Este processo não é obrigatório. Você só precisa fazer isso caso esteja usando o Fractal.
## Como usar
Warehouse v2 é um pacote base, ele implementa o básico sem nenhuma regra de negócio definida.
Há duas classes base: `BaseRepository` e `AbstractCrudRepository`
### BaseRepository
Esta classe implementa o contrato `BaseRepository`, que possui três assinaturas:
```php
/**
* Returns all records.
* If $take is false then brings all records
* If $paginate is true returns Paginator instance.
*
* @param int $take
* @param bool $paginate
*
* @return EloquentCollection|Paginator
*/
public function getAll($take = 15, $paginate = true);
```
```php
/**
* Retrieves a record by his id
* If $fail is true fires ModelNotFoundException. When no record is found.
*
* @param int $id
* @param bool $fail
*
* @return Model
*/
public function findByID($id, $fail = true);
```
```php
/**
* @param string $column
* @param string|null $key
*
* @return \Illuminate\Support\Collection|array
*/
public function lists($column, $key = null);
```
Já na implementação, `BaseRepository` disponibiliza dois métodos protegidos `newQuery()` e `doQuery($query = null, $take = 15, $paginate = true)`. Eles são amplamente usados nos repositórios.
#### newQuery
*newQuery* retorna um objeto [QueryBuilder](https://github.com/laravel/framework/blob/5.1/src/Illuminate/Database/Eloquent/Builder.php) do eloquent, à partir da propriedade `modelClass`.
```php
protected function newQuery()
{
return app()->make($this->modelClass)->newQuery();
}
```
> Essa propriedade precisa ser definida em todos as classes repositório
#### doQuery
*doQuery* processa a query e retorna uma collection ou um objeto paginate, dependendo dos parametros passados
```php
protected function doQuery($query = null, $take = 15, $paginate = true)
{
if (is_null($query)) {
$query = $this->newQuery();
}
if (true == $paginate):
return $query->paginate($take);
endif;
if ($take > 0 || false != $take) {
$query->take($take);
}
return $query->get();
}
```