Eloquent 모델 클래스

개요

이 가이드에서는 Laravel MongoDB 패키지를 사용하여 Laravel Eloquent 모델을 정의하고 사용자 지정하는 방법을 설명합니다. 이러한 모델을 사용하면 Laravel Eloquent 객체 관계형 매퍼(ORM)를 사용하여 MongoDB 데이터로 작업할 수 있습니다.

다음 섹션에서는 Laravel MongoDB 모델에 Laravel Eloquent ORM 동작을 추가하는 방법을 설명합니다.

• Eloquent 모델 클래스 정의에서는 모델 클래스 를 생성하는 방법을 설명합니다.

• 인증 가능 모델 확장에서는 MongoDB를 인증 사용자 제공자로 설정하는 방법을 보여줍니다.

• Eloquent 모델 클래스 사용자 정의에서는 몇 가지 모델 클래스 사용자 정의에 대해 설명합니다.

• 가지 치기 동작 지정 에서는 더 이상 필요하지 않은 모델을 주기적으로 제거하는 방법을 보여 줍니다.

Eloquent 모델 클래스 정의

Eloquent 모델은 데이터를 나타내는 클래스입니다. 여기에는 삽입, 업데이트, 삭제와 같은 데이터베이스 작업을 수행하는 메서드가 포함됩니다.

Laravel MongoDB 모델을 선언하려면 다음 코드 예시와 같이 Laravel 애플리케이션의 app/Models 디렉토리에 MongoDB\Laravel\Eloquent\Model 를 확장하는 클래스를 만듭니다.

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

기본값 모델은 Laravel 애플리케이션의 config/database.php 설정에 설정하다 MongoDB database 이름과 컬렉션 에 대한 모델 클래스 이름의 스네이크 복수형을 사용합니다.

이 모델은 planets MongoDB 컬렉션에 저장됩니다.

Laravel 애플리케이션 에서 사용하는 데이터베이스 이름을 지정하는 방법을 학습 보려면 MongoDB 연결 구성을 참조하세요.

인증 가능 모델 확장

MongoDB를 Laravel 사용자 제공자로 구성하려면 Laravel MongoDB MongoDB\Laravel\Auth\User 클래스를 확장하면 됩니다. 다음 코드 예제에서는 이 클래스를 확장하는 방법을 보여 줍니다.

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

Laravel 인증 사용자 제공자를 사용자 지정하는 방법에 대해 자세히 알아보려면 사용자 지정 사용자 제공자 추가 하기를 Docs 참조하세요. Laravel 에서 .

Eloquent 모델 클래스 사용자 지정

이 섹션에서는 다음과 같은 Eloquent 모델 동작 사용자 지정을 수행하는 방법을 보여줍니다.

• 모델 컬렉션 이름 변경

• 기본 키 필드 변경

• 일시 삭제 활성화

• 캐스트 데이터 유형

• 대량 할당 사용자 지정

<?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;
}

캐스트 데이터 유형

Eloquent를 사용하면 캐스팅 헬퍼를 사용하여 데이터를 저장하거나 검색하기 전에 모델 속성 데이터 유형을 변환할 수 있습니다. 이 헬퍼는 모델에서 동등한 접근자 및 변경자 메서드를 정의하는 대신 편리한 대안입니다.

다음 예제에서 캐스팅 헬퍼는 discovery_dt MongoDB에 MongoDB\BSON\UTCDateTime 으로 저장된 모델 속성을 datetime 변환합니다. 유형을 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',
   ];
}

이 변환을 사용하면 PHP DateTime 또는 탄소 클래스 이 필드의 날짜로 작업합니다. 다음 예제는 모델의 캐스팅 헬퍼를 사용하여 discovery_dt 가 3년 미만인 행성을 쿼리하는 Laravel 쿼리를 보여줍니다.

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

MongoDB의 데이터 유형에 학습 BSON types 보려면 MongoDB 서버 Docs 에서 를 참조하세요.

Laravel 캐스팅 헬퍼 및 지원되는 유형에 대해 자세히 알아보려면 속성 캐스팅 을 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);

정리 동작 지정

Eloquent를 사용하면 더 이상 필요하지 않은 모델 데이터를 주기적으로 삭제하는 기준을 지정할 수 있습니다. model:prune 명령을 예약하거나 실행할 때 Laravel은 삭제할 모델과 일치시키기 위해 Prunable 및 MassPrunable 트레이트를 가져오는 모든 모델에서 prunable() 메서드를 호출합니다.

MongoDB를 데이터베이스로 사용하는 모델에서 이 기능을 사용하려면 모델에 적절한 가져오기를 추가합니다.

• MongoDB\Laravel\Eloquent\Prunable 기준과 일치하는 모델을 삭제하기 전에 선택적으로 정리 단계를 수행합니다.

• MongoDB\Laravel\Eloquent\MassPrunable 모델 데이터를 가져오지 않고 기준과 일치하는 모델을 삭제합니다.

정리 기능 에 학습 보려면 모델 정리 를 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);
    }
}