歡迎大家關(guān)注我的其他<a >Github博客</a>和<a >CSDN</a>,互相交流!
今天學(xué)習(xí)了Laravel中的ORM基礎(chǔ)部分,現(xiàn)在分享一下匾浪。
Eloquent ['el?kw?nt]
時(shí)寂嘉,數(shù)據(jù)庫(kù)查詢構(gòu)造器的方法對(duì)模型類也是也用的桌肴,使用上只是省略了DB::table
('表名')部分。
在模型中使用protected成員變量$table指定綁定的表名航唆。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* The table associated with the model.
*
* @var string
*/
protected $table = 'my_flights';
}
Eloquent
假設(shè)每個(gè)表都有一個(gè)名為id的主鍵将谊,可以通過$primaryKey
成員變量覆蓋該字段名稱冷溶,另外,Eloquent
假設(shè)主鍵字段是自增的整數(shù)尊浓,如果你想用非自增的主鍵或者非數(shù)字的主鍵的話挂洛,必須指定模型中的public
屬性$incrementing
為false
。
默認(rèn)情況下眠砾,Eloquent
期望表中存在created_at
和updated_at
兩個(gè)字段,字段類型為timestamp
托酸,如果不希望這兩個(gè)字段的話褒颈,設(shè)置$timestamps
為false
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* Indicates if the model should be timestamped.
*
* @var bool
*/
public $timestamps = false;
/**
* The storage format of the model's date columns.
*
* @var string
*/
protected $dateFormat = 'U';
}
使用protected $connection = 'connection-name'指定模型采用的數(shù)據(jù)庫(kù)連接。
查詢#
基本查詢操作#
方法all用于返回模型表中所有的結(jié)果
$flights = Flight::all();
foreach ($flights as $flight) {
echo $flight->name;
}
也可以使用get
方法為查詢結(jié)果添加約束
$flights = App\Flight::where('active', 1)
->orderBy('name', 'desc')
->take(10)
->get();
可以看到励堡,查詢構(gòu)造器的方法對(duì)模型類也是可以使用的
在eloquent ORM中谷丸,get
和all
方法查詢出多個(gè)結(jié)果集,它們的返回值是一個(gè)Illuminate\Database\Eloquent\Collection
對(duì)象应结,該對(duì)象提供了多種對(duì)結(jié)果集操作的方法
public function find($key, $default = null);
public function contains($key, $value = null);
public function modelKeys();
public function diff($items)
...
該對(duì)象的方法有很多刨疼,這里只列出一小部分,更多方法參考API文檔 Collection 和使用說明文檔鹅龄。對(duì)大量結(jié)果分段處理揩慕,同樣是使用chunk方法
Flight::chunk(200, function ($flights) {
foreach ($flights as $flight) {
//
}
});
查詢單個(gè)結(jié)果#
使用find
和first
方法查詢單個(gè)結(jié)果,返回的是單個(gè)的模型實(shí)例
// 通過主鍵查詢模型...
$flight = App\Flight::find(1);
// 使用約束...
$flight = App\Flight::where('active', 1)->first();
使用find
方法也可以返回多個(gè)結(jié)果扮休,以Collection
對(duì)象的形式返回迎卤,參數(shù)為多個(gè)主鍵
$flights = App\Flight::find([1, 2, 3]);
如果查詢不到結(jié)果的話,可以使用findOrFail
或者firstOrFail
方法玷坠,這兩個(gè)方法在查詢不到結(jié)果的時(shí)候會(huì)拋出Illuminate\Database\Eloquent\ModelNotFoundException
異常
$model = App\Flight::findOrFail(1);
$model = App\Flight::where('legs', '>', 100)->firstOrFail();
如果沒有捕獲這個(gè)異常的話蜗搔,laravel會(huì)自動(dòng)返回給用戶一個(gè)404的響應(yīng)結(jié)果,因此如果希望找不到的時(shí)候返回404八堡,是可以直接使用該方法返回的
Route::get('/api/flights/{id}', function ($id) {
return App\Flight::findOrFail($id);
});
查詢聚集函數(shù)結(jié)果#
與查詢構(gòu)造器查詢方法一樣樟凄,可以使用聚集函數(shù)返回結(jié)果,常見的比如max兄渺, min缝龄,avg,sum,count等
$count = App\Flight::where('active', 1)->count();
$max = App\Flight::where('active', 1)->max('price');
分頁查詢#
分頁查詢可以直接使用paginate函數(shù)
LengthAwarePaginator paginate(
int $perPage = null,
array $columns = array('*'),
string $pageName = 'page',
int|null $page = null
)
參數(shù)說明
參數(shù) 類型 說明
perPage int 每頁顯示數(shù)量
columns array 查詢的列名
pageName string 頁碼參數(shù)名稱
page int 當(dāng)前頁碼
返回值為 LengthAwarePaginator
對(duì)象二拐。
$limit = 20;
$page = 1;
return Enterprise::paginate($limit, ['*'], 'page', $page);
插入#
基本插入操作#
插入新的數(shù)據(jù)只需要?jiǎng)?chuàng)建一個(gè)新的模型實(shí)例服鹅,然后設(shè)置模型屬性,最后調(diào)用save方法即可
$flight = new Flight;
$flight->name = $request->name;
$flight->save();
在調(diào)用save方法的時(shí)候百新,會(huì)自動(dòng)為created_at和updated_at字段設(shè)置時(shí)間戳企软,不需要手動(dòng)指定
批量賦值插入#
使用create
方法可以執(zhí)行批量為模型的屬性賦值的插入操作,該方法將會(huì)返回新插入的模型饭望,在執(zhí)行create
方法之前仗哨,需要先在模型中指定fillable
和guarded
屬性,用于防止不合法的屬性賦值(例如避免用戶傳入的is_admin
屬性被誤錄入數(shù)據(jù)表)铅辞。
指定$fillable
屬性的目的是該屬性指定的字段可以通過create
方法插入厌漂,其它的字段將被過濾掉,類似于白名單斟珊,而$guarded
則相反苇倡,類似于黑名單。
protected $fillable = ['name'];
// OR
protected $guarded = ['price'];
執(zhí)行create操作就只有白名單或者黑名單之外的字段可以更新了
$flight = App\Flight::create(['name' => 'Flight 10']);
除了create方法囤踩,還有兩外兩個(gè)方法可以使用firstOrNew和firstOrCreate旨椒。
firstOrCreate
方法用來使用給定的列值對(duì)查詢記錄,如果查不到則插入新的堵漱。fristOrNew
與firstOrCreate
類似综慎,不同在于如果不存在,它會(huì)返回一個(gè)新的模型對(duì)象勤庐,不過該模型是未經(jīng)過持久化的示惊,需要手動(dòng)調(diào)用save方法持久化到數(shù)據(jù)庫(kù)。
// 使用屬性檢索flight愉镰,如果不存在則創(chuàng)建...
$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);
// 使用屬性檢索flight米罚,如果不存在則創(chuàng)建一個(gè)模型實(shí)例...
$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);
更新#
基本更新操作#
方法save不僅可以要用來插入新的數(shù)據(jù),也可以用來更新數(shù)據(jù)岛杀,只需先使用模型方法查詢出要更新的數(shù)據(jù)阔拳,設(shè)置模型屬性為新的值,然后再save就可以更新了类嗤,updated_at字段會(huì)自動(dòng)更新糊肠。
$flight = App\Flight::find(1);
$flight->name = 'New Flight Name';
$flight->save();
也可使用update方法對(duì)多個(gè)結(jié)果進(jìn)行更新
App\Flight::where('active', 1)
->where('destination', 'San Diego')
->update(['delayed' => 1]);
刪除#
基本刪除操作#
使用delete
方法刪除模型
$flight = App\Flight::find(1);
$flight->delete();
上述方法需要先查詢出模型對(duì)象,然后再刪除遗锣,也可以直接使用主鍵刪除模型而不查詢货裹,使用destroy方法
App\Flight::destroy(1);
App\Flight::destroy([1, 2, 3]);
App\Flight::destroy(1, 2, 3);
使用約束條件刪除,返回刪除的行數(shù)
$deletedRows = App\Flight::where('active', 0)->delete();
軟刪除#
軟刪除是在表中增加deleted_at字段精偿,當(dāng)刪除記錄的時(shí)候不會(huì)真實(shí)刪除記錄弧圆,而是設(shè)置該字段的時(shí)間戳赋兵,由Eloquent模型屏蔽已經(jīng)設(shè)置該字段的數(shù)據(jù)。
要啟用軟刪除搔预,可以在模型中引用Illuminate\Database\Eloquent\SoftDeletes這個(gè)Trait霹期,并且在dates屬性中增加deleted_at字段。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
class Flight extends Model
{
use SoftDeletes;
/**
* The attributes that should be mutated to dates.
*
* @var array
*/
protected $dates = ['deleted_at'];
}
要判斷一個(gè)模型是否被軟刪除了的話拯田,可以使用trashed方法
if ($flight->trashed()) {
//
}
查詢軟刪除的模型#
包含軟刪除的模型#
如果模型被軟刪除了历造,普通查詢是不會(huì)查詢到該結(jié)果的,可以使用withTrashed方法強(qiáng)制返回軟刪除的結(jié)果
$flights = App\Flight::withTrashed()
->where('account_id', 1)
->get();
// 關(guān)聯(lián)操作中也可以使用
$flight->history()->withTrashed()->get();
只查詢軟刪除的模型#
$flights = App\Flight::onlyTrashed()
->where('airline_id', 1)
->get();
還原軟刪除的模型#
查詢到軟刪除的模型實(shí)例之后船庇,調(diào)用restore方法還原
$flight->restore();
也可以在查詢中使用
App\Flight::withTrashed()
->where('airline_id', 1)
->restore();
// 關(guān)聯(lián)操作中也可以使用
$flight->history()->restore();
強(qiáng)制刪除(持久化刪除)#
// Force deleting a single model instance...
$flight->forceDelete();
// Force deleting all related models...
$flight->history()->forceDelete();
上述操作后吭产,數(shù)據(jù)會(huì)被真實(shí)刪除。