# Laravel eloquent model の規約

Model ファイルの基本定義

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    // テーブル名
    protected $table = 'products';

    // 主キー
    protected $primaryKey = 'product_id';

    // 主キーID自動インクリメントするのをやめる デフォルトtrue
    public $incrementing = false;

    // 主キーIDをstringタイプにする
    protected $keyType = 'string';

    // タイムスタンプ自動更新やめる
    public $timestamps = false;

    // 日付カラムの保存用フォーマット
    protected $dateFormat = 'U';

    // created_at updated_at カラムを別名にする
    const CREATED_AT = 'creation_date';
    const UPDATED_AT = 'updated_date';

    // データベース接続指定
    protected $connection = 'sqlite';

    // モデルの属性のデフォルト値定義
    protected $attributes = [
        'delayed' => false,
    ];

    // 代入可能な属性定義
    protected $fillable = ['name'];
}

# モデルの取得

基本的な使い方

use App\Models\Product;

// 主キーでモデルを取得
$item = Product::find(10110);

$result1 = Product::all();
$result2 = Product::get();

print_r($result1);
print_r($result2);

// Eloquent でクエリ作成 クエリビルダが提供するすべてのメソッドが利用できる
$products = Product::where('price', '>', 100)
               ->orderBy('name')
               ->take(10)
               ->get();

# ルートで使う

API 設計などで使える

// 結果が見つからない場合404 HTTPレスポンスをクライアントへ自動的に返却
Route::get('/api/products/{id}', function ($id) {
    return Product::findOrFail($id);
});

# 集計取得

$count = Order::where('active', 1)->count();

$total = Orders::where('active', 1)->sum('total');

$max = Orders::where('active', 1)->max('price');

# クエリビルダでサブクエリする

use App\Models\Destination;
use App\Models\Flight;

return Destination::addSelect(['last_flight' => Flight::select('name')
    ->whereColumn('destination_id', 'destinations.id')
    ->orderByDesc('arrived_at')
    ->limit(1)
])->get();

# モデル INSERT UPDATE

# save メソッド

save メソッド使うことで、created_at updated_at 自動更新されます
save メソッドを使用して、データベースにすでに存在するモデルを更新することもできます。
モデルを更新するには、モデルを取得して、更新する属性をセットする必要があります。





 

$item = new Product;

$item->name = $request->name;

$item->save();

# create メソッド

create メソッドを使用する前に、モデルクラスで fillable または guarded プロパティを指定する必要があります。

$item = Product::create([
    'name' => 'New item',
]);

Model での fillable 定義

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    // 代入可能な属性定義
    protected $fillable = ['name'];
}

# updateOrCreate メソッド

既存のモデルを更新する時に、一致するモデルが存在しない場合は、新しいモデルを作成
ロジック順番は UPDATE INSERT 順

$item = Product::updateOrCreate(
    ['name' => 'apple', 'departure' => 'japan'],
    ['price' => 299]
);

# SoftDeletes ソフトデリート

モデルに「deleted_at」属性がセットされ、モデルを「削除」した日時が保存されます。モデルのソフト削除を有効にするには、「Illuminate\Database\Eloquent\SoftDeletes」トレイトをモデルに追加します。

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Product extends Model
{
    // ソフトデリート使う宣言
    use SoftDeletes;
}

マイグレーションスキーマビルダーに追加する時

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

Schema::table('products', function (Blueprint $table) {
    $table->softDeletes();
});

# モデル replicate

replicate メソッドを使用して、既存のモデルインスタンスの未保存のコピーを作成できます。

use App\Models\Address;

$shipping = Address::create([
    'type' => 'shipping',
    'city' => 'Victorville',
    'postcode' => '90001',
]);

$billing = $shipping->replicate()->fill([
    'type' => 'billing'
]);

$billing->save();
2021-10-20
  • php
  • laravel

関連記事

Laravel メンテナンスモード
Laravel model で hidden に設定したカラムを一時解除
Laravel でカテゴリー作成 テーブル構築と再帰クエリ
Laravel Queue で非同期処理
Laravel notification メール通知カスタマイズ
Laravel lang バリデーションメッセージを多言語対応
Laravel を API サーバーとしての初期設定
Laravel リクエストログ出力
Carbon で php date 日付の日数・月数差を計算
Laravel 429 Too Many Requests
Laravel Email バリデーションについて
Laravel Sanctum 使って API トークン JWT 認証と SPA 認証
AWS SES メール開封確認  DB に集計
Laravel logger でエラーログを chatwork に自動送信
php CSV データ取得は fgetcsv 使う
Laravel tinker 使って DB データベース接続とコマンド
Laravel Test についてのメモ
Laravel Log の基本設定&使い方
Exception: Class 'ZipArchive' not found
Laravel Sail で Docker 環境構築
PHP 文字列長さ・文字列の幅を取得方法
Codeigniter 画像アップロードとリサイズ
Laravel Lumen Faker 日本語設定
laravel method の基本 get post put options
Laravel schedule 設定
Class 'Imagick' not found Error
PHP mbconvertkana 全角半角英数カナ変換
Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得
Laravel timestamp() auto update 有効化無効化
Lumen8 で JWT ユーザー認証
Laravel toSql パラメータ付きで出力
Lumen8 で API 開発
php Exception エラーキャッチでメール送信
Smarty HTTP URL 取得できるサーバー関数
Laravel blade foreach loop と current url
laravel session を制する
PHP empty isset is_null の違い
PHP 8 リリース新機能と変更
FlattenException deprecated
php.ini 初期設定のいろいろ
Laravel 5.1 から 8.1 にバージョンアップ
PHP 7.4 にアップグレードして使えなくなる機能
開発時によく使うゼロ埋めパディング作業まとめ
解決!phpMyAdmin テーブル構造の内容が表示されない問題
codeigniter email ライブラリでメール送信 日本語対応
Composer コマンドとオプション
爆速軽量フレームワーク codeigniter PHP 開発
nuxtjs と codeigniter で jwt システム構築
Lumen と Laravel 違い比較
HTML から PDF に変換 PHP ライブラリ mPDF の設定
twig 3 人気 PHP テンプレートエンジンがバージョンアップ
正規表現一覧 よく使う検索・置換のパターン
Apache 初期設定メモ
開発におけるコーディングルール・規約
Laravel Error についてのメモ
laravel に vuejs 使うための初期設定
php curl 使って クリックなしで POST 送信
allowurlinclude の設定で ftp_connect()エラー