Back-End

24 nov, 2017

Como criar as Models do seu projeto com Eloquent no Laravel

Publicidade

Continuando a série de artigos sobre o Laravel, hoje trago o Eloquent, uma forma quase mágica e simples de trabalhar com consultas a bancos de dados e desenvolver suas Models.

No último artigo que fiz, abordei a criação de migrations e como o Laravel pode relacionar as tabelas para você – caso não tenha visto ainda, você pode acompanhar por aqui. Lembra do exemplo da tabela de produtos que eu criei? Então, agora é hora de começar a buscar estes dados para a nossa aplicação. Para isso, precisaremos criar Models.

Models

Para não fugirmos muito do objetivo deste artigo, deixo brevemente o entendimento sobre Models. Models, dentro da arquitetura MVC, são classes responsáveis pela leitura, escrita e validação de qualquer dado. Por isso, será aqui que iremos trabalhar com Eloquent para fazermos todo tipo de ações no nosso banco de dados. Porém, primeiro vamos entender o que é o Eloquent.

Eloquent no Laravel

O Eloquent nada mais é que um ORM que vem em conjunto com o Laravel. Mas, melhor que isso, ele possui uma estrutura bem simples para você realizar a implementação da sua lógica de controle com banco de dados.

Com base nos preceitos do ORM (Object Relational Mapping), o Eloquent abstrai toda a complexidade da interação com os bancos de dados utilizando as Models para interagir com cada tabela.

Para facilitar o trabalho, com ele existem algumas convenções, como:

  • Os nomes de tabelas são padronizadas para o plural da classe que irá consumí-la.
  • As Primary keys são sempre vinculadas à uma coluna id.
  • Toda tabela possuirá colunas timestamp mostrando a data de criação (created_at) e data de atualização (updated_at).
  • Por padrão, as Models do Eloquent irão buscar as configurações de conexão com o banco de dados no arquivo padrão do Laravel, “config/database.php”.

Resumidamente falando, ele consegue trazer em uma ou duas linhas o que você gastaria muitas linhas de comando para executar.

Criando as Models com Eloquent

Saindo um pouco da teoria, vamos voltar ao nosso exemplo. Precisamos criar as Models que irão trabalhar com as tabelas “product_lines” e “products”. Para isso, vou abrir o terminal da minha Hospedagem Cloud que possuo aqui na DialHost e digitar o seguinte comando:

php artisan make:model product_line
php artisan make:model product

Ao executar estes comandos, vamos poder observar que as novas classes foram criadas dentro da pasta app.

product_line.php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Product_line extends Model
{
//
}

product.php

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
//
}

Para um sistema de consultas básico, não é necessário implementar funções dentro destas classes. Isto porque o próprio “Eloquent Model” já implementa diversas funções de consultas e manipulação de dados com o banco. Com a classe referenciada, vou apenas chamar as funções do Eloquent diretamente através da Controller.

Principais Funções do Eloquent

Consultas

<?php

Product::all();
// Retorna todos os registros da tabela Products (Seria o equivalente a
// SELECT * FROM products, para o MySQL)

Product::find($id);
// Retorna todos os dados do registro da tabela Products com o $id
// especificado na busca

Product::where('product_line_id',1)->get();
// Executa uma query com parâmetros de restrição (WHERE)

Product::where('product_line_id',1)
->orderBy('product_line_id','description')
->take(10)
->get();
// Executa uma query com parâmetros de restrição (WHERE e LIMIT)
// organizando pelas colunas especificadas

Para estas duas últimas funções, aconselho que sejam criadas funções dentro da Model que as executam. Assim, podemos abstrair a regra de consulta das Controllers. Essa forma é uma boa prática, principalmente se temos uma query complexa, que exija muitos wheres e etc.

Você ainda pode utilizar de funções agregadoras como: count, sum, avg, max, min.

<?php

Product::where('product_line_id', 1)->count();
// Executa uma query que conta o número de registro dentro dos
// parâmetros de restrição (WHERE)

Product::where('product_line_id', 1)->sum('price');
// Executa uma query retornando a soma de todos os preços do resultado da busca

Product::where('product_line_id', 1)->avg('price');
// Executa uma query que retorna a média de preços do resultado da busca

Product::where('product_line_id', 1)->max('price');
// Executa uma query que retorna o maior preço encontrado na busca

Product::where('product_line_id', 1)->count();
// Executa uma query que retorna o menor preço encontrado na busca
// parâmetros de restrição (WHERE)

Inserindo dados com Eloquent

Para inserir dados com o Eloquent, existem duas formas. Na primeira, você instancia a Model em uma variável, dentro da Controller, seta os atributos e então salva tudo no final.

<?php

$product= new Product;

$product->product_line_id = $request->product_line_id ;
$product->description = $request->description;
$product->expiration_time= $request->expiration_time;
$product->price = $request->price;

$product->save();

Eu particularmente achei mais direta e limpa a forma a seguir. Ela é denomiada como Mass Assignment. Aqui eu chamo uma função estática que cria o registro passando os atributos como array:

<?php

$data = [
'product_line_id' => request('product_line_id'),
'description' => request('description'), 
'expiration_time' => request('expiration_time'),
'price' => request('price')
];

Product::create($data);

Para fazer a inserção desta segunda forma, você precisa setar na sua Model os campos que serão permitidos serem setados. Por se tratar de uma inserção em massa, o Laravel bloqueia todos os campos por padrão. Isso ocorre para evitar que usuários consigam passar parâmetros indesejados na Request e que eles acabem alterando um dado importante dentro do banco de dados.

Então criarei na Model Product, a variavel “fillable” e definirei um array com os campos que serão inseridos aqui.

class Product extends Model{

protected $fillable = [
    'description',
    'expiration_time',
    'price',
    'product_line_id'
];

...

Atualizando dados com Eloquent

A forma mais convencional de atualizar um dado através do Eloquent é semelhante a inserir um dado. A diferença é que já teremos a instância do produto especifico que iremos editar e então salvar o novo valor.

<?php

public function update(Product $product, Request $request){

$product->product_line_id = $request->product_line_id;
$product->description = $request->description;
$product->expiration_time = $request->expiration_time;
$product->price = $request->price;
$product->save();

Removendo dados com Eloquent

Remover um dado é ainda mais fácil. Basta setarmos na função, o comando delete() na instância que estamos trabalhando.

<?php

public function delete(Product $product){
$product->delete();

Conclusão

É claro que na vida real ainda teremos que fazer validações para deletar o registro, apenas se ele realmente existir no banco ou durante uma edição verificar se o dado já existe antes de atualizá-lo, e se não existir, perguntar se o usuário deseja criar.

Apenas lendo por alto o Eloquent, já pensei em um novo artigo com algumas funções que não deu para explanar aqui. Se fosse a fundo nestas funções, este artigo ficaria muito extenso e cansativo. Então aguardem até o próximo, onde eu irei falar um pouco sobre funções específicas de busca, updates, criação e remoção de dados.