定義獲取器
獲取器的作用是對模型對象的(原始)數(shù)據(jù)做出自動處理。一個獲取器對應(yīng)模型的一個特殊方法(該方法必須為public類型),方法命名規(guī)范為:
getFieldNameAttr
FieldName為數(shù)據(jù)表字段的駝峰轉(zhuǎn)換或者你數(shù)據(jù)表不存在的字段(注意理解后面這句話),下面是一個典型的獲取器定義:
<?php namespace appindexmodel; use thinkModel; class User extends Model { public function getUserTypeAttr($value, $data) { $type = [0 =>?'普通',?1?=>?'VIP',?2?=>?'黃金',?3?=>?'白金',?4?=>?'鉆石']; ????????return?$type[$value]; ????} }
你需要給每一個需要輸出轉(zhuǎn)換處理的數(shù)據(jù)字段定義一個對應(yīng)的獲取器,但獲取器的字段名不一定要和數(shù)據(jù)表的字段名一致,例如我希望給user_type字段定義一個名為getTypeAttr的獲取器也是允許的,但要注意這個時候傳入獲取器的第一個參數(shù)肯定是沒有值(因為沒有對應(yīng)的數(shù)據(jù)表字段數(shù)據(jù)),只能通過第二個參數(shù)獲取你需要的數(shù)據(jù)。
立即學(xué)習(xí)“PHP免費(fèi)學(xué)習(xí)筆記(深入)”;
<?php namespace appindexmodel; use thinkModel; class User extends Model { public function getTypeAttr($value, $data) { $type = [0 =>?'普通',?1?=>?'VIP',?2?=>?'黃金',?3?=>?'白金',?4?=>?'鉆石']; ????????return?$type[$data['user_type']]; ????} }
當(dāng)然更為嚴(yán)謹(jǐn)?shù)那闆r下,你還需要判斷下是否存在$data[‘user_type’],這個暫且略過。
注意第二個參數(shù)的data數(shù)據(jù),可能本身已經(jīng)經(jīng)過了獲取器的處理(如果你定義了相關(guān)的獲取器的話)。
為什么要定義一個和數(shù)據(jù)報字段不一致的獲取器呢?最明顯的好處可以區(qū)分不同的字段獲取原始數(shù)據(jù)和處理過的數(shù)據(jù)。事實上,有很多理由可以讓你定義一些數(shù)據(jù)表不存在的字段獲取器,這恰恰是獲取器的魅力所在。
看的出來獲取器定義本身沒什么難度,關(guān)鍵在于方法里面的獲取邏輯,這是實際應(yīng)用中最需要關(guān)注的。
調(diào)用獲取器
定義獲取器之后會在下列情況自動觸發(fā):
·模型的數(shù)據(jù)對象取值操作(例如$model->field_name);
·模型的序列化輸出操作(例如$model->toArray()或toJson());
·顯式調(diào)用getAttr方法(例如$model->getAttr(‘field_name’));
前面兩種其實最終都是調(diào)用最后一種來實現(xiàn)的,最關(guān)鍵的是要理解第一種。模型對象取值的時候一般都是通過下面的方式:
$user?=?User::get(1); echo?$user->name; echo?$user->user_type;
當(dāng)我們使用上面的方式進(jìn)行模型對象數(shù)據(jù)獲取或者在模板輸出的時候事實上都會按照下面的順序來檢測和獲取數(shù)據(jù)。
·第1步——如果查詢結(jié)果包含該字段數(shù)據(jù),取回原始數(shù)據(jù),否則并進(jìn)入第2步;
·第2步——檢查是否定義該字段的獲取器(包括動態(tài)獲取器),如果有,則調(diào)用獲取器返回結(jié)果,沒有則進(jìn)入第3步;
·第3步——檢查是否定義了字段的類型轉(zhuǎn)換,有則進(jìn)行轉(zhuǎn)換處理并返回結(jié)果,沒有則進(jìn)入第4步;
·第4步——如果是系統(tǒng)的時間字段,則自動進(jìn)行時間格式化處理并返回結(jié)果,否則進(jìn)入第5步;
·第5步——如果第1步檢查的時候不包含該字段數(shù)據(jù),則檢查是否存在關(guān)聯(lián)屬性定義,有則通過關(guān)聯(lián)關(guān)系獲取數(shù)據(jù)并返回結(jié)果,否則拋出屬性未定義的異常。
上面的這五個步驟的詳細(xì)代碼,如果你有興趣的可以直接參考thinkmodelconcernAttribute的getAttr方法代碼。
簡單來說,當(dāng)你獲取$user->user_type的時候都會去檢查是否定義了相關(guān)的獲取器,而不管user_type字段是否是一個真實的數(shù)據(jù)表字段。
但很多情況下,你不會一個個去獲取模型數(shù)據(jù),而是把整個模型數(shù)據(jù)返回給客戶端或者模板。
public?function?index() { ????$user?=?User::get(1); ????return?json($user); }
在這種情況下,其實就是在響應(yīng)輸出的時候進(jìn)行了模型的toJson處理。
有一點至關(guān)重要,如果你的獲取器定義了非數(shù)據(jù)表的字段,是不會自動輸出的,必須通過append方法追加額外屬性(并且支持追加關(guān)聯(lián)模型屬性)。
如果我們定義了一個type屬性的獲取器(假設(shè)這并不是一個真實的數(shù)據(jù)表字段),那么需要使用下?的方式才能正常輸出(否則你可能只有user_type數(shù)據(jù)):
public?function?index() { ????$user?=?User::get(1); ????return?json($user->append(['type'])); }
如果你是使用toArray的話,處理方式相同。
如果是數(shù)據(jù)集查詢的話,一樣可以使用append方法統(tǒng)一追加額外字段。
public?function?index() { ????$users?=?User::all(); ????return?json($users->append(['type'])); }
除了append方法之外,我們還支持用hidden方法臨時隱藏一些數(shù)據(jù)。
獲取原始數(shù)據(jù)
有些情況下,除了要獲取處理過的數(shù)據(jù)外,還需要獲取原始數(shù)據(jù)以便應(yīng)對不同的需求。
如果?你的獲取器都是用的區(qū)分于實際數(shù)據(jù)表字段的額外屬性字段,那么這個問題本身已經(jīng)解決了。所以我們主要討論的是當(dāng)你的獲取器屬性和數(shù)據(jù)表字段一致的情況下,該如何獲取原始數(shù)據(jù)。
一個最簡單的辦法是使用getData方法:
$user?=?User::get(1); //?獲取user_type獲取器數(shù)據(jù) echo?$user->user_type; //?獲取原始的user_type數(shù)據(jù) echo?$user->getData('user_type'); //?獲取全部原始數(shù)據(jù) dump($user->getData());
動態(tài)獲取器
前面我們提到過動態(tài)獲取器的概念,動態(tài)獲取器就是不需要在模型類里面定義獲取器方法,而是在查詢的時候使用閉包來定義一個字段的獲取器對數(shù)據(jù)進(jìn)行統(tǒng)一的處理。
User::withAttr('name',?function($value,?$data)?{ return?strtolower($value); })->select();
如果你需要定義多個動態(tài)獲取器,多次調(diào)用withAttr方法就行。
動態(tài)獲取器的意義除了可以不用在模型里面定義獲取器方法之外,還可以起到覆蓋已經(jīng)定義的獲取器的作用,并且動態(tài)獲取器可以支持Db類操作,彌補(bǔ)了Db操作不能使用獲取器的缺憾,具體就看自己的需求來選擇了。
Db::name('user')->withAttr('name',?function($value,?$data)?{ return?strtolower($value); })->select();
總結(jié)
無論是獲取器,還是之前提?的修改器、搜索器,其作用無非是把你的模型工作細(xì)化和拆分,這樣代碼和邏輯也會更清晰,可維護(hù)性也大大增強(qiáng),至于性能,從來不是模型首先考慮的。
PHP中文網(wǎng),有大量免費(fèi)的ThinkPHP入門教程,歡迎大家學(xué)習(xí)!
本文轉(zhuǎn)自:https://blog.thinkphp.cn/825350