Classe de modelo Eloquent

Visão geral

Este guia mostra como usar o pacote Laravel MongoDB para definir e personalizar modelos Laravel Eloquent. Você pode usar esses modelos para trabalhar com dados do MongoDB usando o mapeador relacional de objetos (ORM) do Laravel Eloquent.

As seções a seguir explicam como adicionar comportamentos ORM do Laravel Eloquent aos modelos do Laravel MongoDB:

• Definir uma classe de modelo Eloquent demonstra como criar uma classe de modelo.

• Extend the Authenticatable Model mostra como definir o MongoDB como o provedor do usuário de autenticação.

• Personalizar uma classe de modelo Eloquent explica várias personalizações de classe de modelo.

• Especificar Comportamento de Poda mostra como remover periodicamente os modelos que você não precisa mais.

Definir uma classe de modelo Eloquent

Modelos Eloquent são classes que representam seus dados. Elas incluem métodos que executam operações do banco de dados, como inserções, atualizações e exclusões.

Para declarar um modelo Laravel MongoDB, crie uma classe no diretório app/Models do seu aplicativo Laravel que estenda o MongoDB\Laravel\Eloquent\Model como mostrado no seguinte exemplo de código:

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
}

Por padrão, o modelo usa o nome do banco de banco de dados MongoDB definido na configuração config/database.php do aplicativo Laravel e a forma plural de snake case do nome da classe do modelo para a coleção.

Este modelo é armazenado na coleção planets MongoDB.

Para saber como especificar o nome do banco de dados de dados usado pelo seu aplicação Laravel, Configure sua conexão com o MongoDB .

Estenda o modelo autenticavel

Para configurar o MongoDB como o provedor de usuário do Laravel, você pode estender a classe MongoDB MongoDB\Laravel\Auth\User do Laravel. O seguinte exemplo de código mostra como estender esta classe:

<?php
namespace App\Models;
use MongoDB\Laravel\Auth\User as Authenticatable;
class User extends Authenticatable
{
}

Para saber mais sobre como personalizar um fornecedor de usuário de autenticação do Laravel, consulte Adicionar fornecedores de usuário personalizados nos do Docs Laravel.

Personalizar uma classe de modelo Eloquent

Esta seção mostra como executar as seguintes personalizações de comportamento do modelo Eloquent:

• Alterar o nome da coleção de modelos

• Alterar o campo de chave primária

• Habilitar exclusões suaves

• Converter tipos de dados

• Personalizar Atribuição em Massa

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $collection = 'celestial_body';
}

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $primaryKey = 'name';
}

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
use MongoDB\Laravel\Eloquent\SoftDeletes;
class Planet extends Model
{
    use SoftDeletes;
}

Converter tipos de dados

O Eloquent permite converter tipos de dados de atributo do modelo antes de armazenar ou recuperar dados usando um auxiliar de conversão. Esse auxiliar é uma alternativa conveniente para definir métodos acessadores e mutadores equivalentes em seu modelo.

No exemplo a seguir, o auxiliar de fundição converte o discovery_dt atributo de modelo , armazenado no MongoDB como MongoDB\BSON\UTCDateTime tipo para o datetime tipo Laravel .

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $casts = [
        'discovery_dt' => 'datetime',
    ];
}

protected function casts(): array
{
   return [
      'discovery_dt' => 'datetime',
   ];
}

Esta conversão permite que você use o PHP DateTime ou a classe MongoDB para trabalhar com datas neste campo. O exemplo a seguir mostra uma query do Laravel que usa o auxiliar de conversão no modelo para fazer a query de planetas com um discovery_dt de menos de três anos atrás:

Planet::where( 'discovery_dt', '>', new DateTime('-3 years'))->get();

Para saber mais sobre MongoDB os tipos de dados do , consulte nos BSON types do MongoDB servidor Docs.

Para saber mais sobre o auxiliar de conversão do Laravel e os tipos suportados, consulte Fundição de Atributos nos do Docs Laravel.

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    protected $fillable = [
        'name',
        'gravitational_force',
        'diameter',
        'moons',
    ];
}

$planets = [
    [ 'name' => 'Earth', 'gravitational_force' => 9.8, 'day_length' => '24 hours' ],
    [ 'name' => 'Mars', 'gravitational_force' => 3.7, 'day_length' => '25 hours' ],
];
Planet::create($planets);

Especifique o comportamento de remoção

O Eloquent permite especificar critérios para excluir periodicamente dados do modelo que você não precisa mais. Quando você agenda ou executa o comando model:prune , o Laravel chama o método prunable() em todos os modelos que importam as características Prunable e MassPrunable para corresponder aos modelos para exclusão.

Para utilizar esta funcionalidade com modelos que utilizam MongoDB como banco de dados, adicione a importação apropriada ao seu modelo:

• MongoDB\Laravel\Eloquent\Prunable opcionalmente, executa uma etapa de limpeza antes de excluir um modelo que corresponda aos critérios

• MongoDB\Laravel\Eloquent\MassPrunable exclui modelos que correspondem aos critérios sem buscar os dados do modelo

Para saber mais sobre o recurso de remoção, consulte Modelos de Remoção nos do Docs Laravel.

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
use MongoDB\Laravel\Eloquent\Prunable;
class Planet extends Model
{
    use Prunable;
    public function prunable()
    {
        // matches models in which the solar_system field contains a null value
        return static::whereNull('solar_system');
    }
    protected function pruning()
    {
        // Add cleanup actions, such as logging the Planet 'name' attribute
    }
}

<?php
namespace App\Models;
use MongoDB\Laravel\Eloquent\MassPrunable;
use MongoDB\Laravel\Eloquent\Model;
class Planet extends Model
{
    use MassPrunable;
    public function prunable()
    {
        // matches models in which the gravitational_force field contains
        // a value greater than 0.5
        return static::where('gravitational_force', '>', 0.5);
    }
}