這篇文章主要介紹Laravel模型事件的示例分析,文中介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們一定要看完!
在成都網(wǎng)站制作、網(wǎng)站建設(shè)中從網(wǎng)站色彩、結(jié)構(gòu)布局、欄目設(shè)置、關(guān)鍵詞群組等細(xì)微處著手,突出企業(yè)的產(chǎn)品/服務(wù)/品牌,幫助企業(yè)鎖定精準(zhǔn)用戶,提高在線咨詢和轉(zhuǎn)化,使成都網(wǎng)站營(yíng)銷成為有效果、有回報(bào)的無(wú)錫營(yíng)銷推廣。成都創(chuàng)新互聯(lián)公司專業(yè)成都網(wǎng)站建設(shè)十余年了,客戶滿意度97.8%,歡迎成都創(chuàng)新互聯(lián)客戶聯(lián)系。
Laravel 模型事件允許你監(jiān)聽(tīng)模型生命周期內(nèi)的多個(gè)關(guān)鍵點(diǎn),甚至可以在阻止一個(gè)模型的保存或者刪除。 Laravel 模型事件文檔 概述了如何使用鉤子將對(duì)應(yīng)事件與相關(guān)的事件類型關(guān)聯(lián)起來(lái),但是本文的主旨是事件與監(jiān)聽(tīng)器的構(gòu)建與設(shè)置,并額外補(bǔ)充一些細(xì)節(jié)的說(shuō)明。
事件概述
Eloquent 有很多事件可以讓你使用鉤子將它們關(guān)聯(lián)起來(lái),并且增加自定義的功能到你的模型中。該模型起始時(shí)有以下事件:
retrieved
creating
created
updating
updated
saving
saved
deleting
deleted
restoring
restored
從文檔這里我們可以了解它們都是如何實(shí)現(xiàn)的,你還可以進(jìn)入 Model 的基類去看看它們到底是如何實(shí)現(xiàn)的:
當(dāng)現(xiàn)有模型被數(shù)據(jù)庫(kù)檢索時(shí), retrieved 事件將會(huì)觸發(fā)。當(dāng)一個(gè)新的模型被第一次保存時(shí), creating 和 created 事件將會(huì)觸發(fā)。如果對(duì)一個(gè)已經(jīng)存在于數(shù)據(jù)庫(kù)的模型調(diào)用 save 方法, updating / updated 事件將會(huì)觸發(fā)。無(wú)論怎樣,在這兩種情況下, saving / saved 事件都會(huì)觸發(fā)。
文檔中對(duì)模型事件進(jìn)行了很好的概述,同時(shí)解釋了怎樣使用鉤子去關(guān)聯(lián)事件,但是如果你是初學(xué)者,或者并不是熟悉怎樣使用鉤子將事件監(jiān)聽(tīng)器與這些自定義模型事件相關(guān)聯(lián),請(qǐng)進(jìn)一步閱讀本文。
注冊(cè) 事件
為了在你的模型中關(guān)聯(lián)一個(gè)事件,你需要做的第一件事是使用 $dispatchesEvents 屬性去注冊(cè)事件對(duì)象,這最終將通過(guò) HasEvents::fireCustomModelEvent() 方法觸發(fā),該方法將通過(guò) fireModelEvent() 方法被調(diào)用。 fireCustomModelEvent() 方法原始的時(shí)候大致是下面這樣:
/** * 為給定的事件觸發(fā)一個(gè)自定義模型。 * * @param string $event * @param string $method * @return mixed|null */ protected function fireCustomModelEvent($event, $method) { if (! isset($this->dispatchesEvents[$event])) { return; } $result = static::$dispatcher->$method(new $this->dispatchesEvents[$event]($this)); if (! is_null($result)) { return $result; } }
一些事件,比如 delete, 將進(jìn)行檢測(cè)判斷是否這個(gè)事件會(huì)返回 false 然后退出操作。比如,你可以使用這個(gè)鉤子去做一些檢測(cè),也可以防止一個(gè)用戶被創(chuàng)建或刪除。
使用 App\User 模型舉例,這里展示了如何配置你的模型事件:
protected $dispatchesEvents = [ 'saving' => \App\Events\UserSaving::class, ];
你可以使用 artisan make:event 命令來(lái)為你創(chuàng)建這個(gè)事件,但基本上這將是你最后得到結(jié)果 :
user = $user; } }
我們的事件提供了一個(gè)公有的 $user 屬性以便你能夠在 saving 事件期間訪問(wèn) User 模型實(shí)例。
為了讓它工作起來(lái)下一步需要做的是為這個(gè)事件建立一個(gè)實(shí)際的監(jiān)聽(tīng)器。我們?cè)O(shè)置好模型的觸發(fā)時(shí)機(jī),當(dāng) User 模型觸發(fā) saving 事件,監(jiān)聽(tīng)器就會(huì)被調(diào)。
創(chuàng)建一個(gè)事件監(jiān)聽(tīng)器
現(xiàn)在,我們定義 User 模型并注冊(cè)一個(gè)事件監(jiān)聽(tīng)器來(lái)監(jiān)聽(tīng) saving 事件的觸發(fā)。雖然,我能通過(guò)模型觀察器快速實(shí)現(xiàn),但是,我想引導(dǎo)你為單個(gè)事件觸發(fā)配置事件監(jiān)聽(tīng)器。
事件監(jiān)聽(tīng)器就像 Laravel 其它事件監(jiān)聽(tīng)一樣,handle() 方法將接收 App\Events\UserSaving 事件類的一個(gè)實(shí)例。
你可以手動(dòng)創(chuàng)建它,也可以使用 php artisan make:listener 命令。 不管怎么樣,你都將創(chuàng)建一個(gè)像下面這樣子監(jiān)聽(tīng)類:
info($event->user); } }
我只是添加了一個(gè)日志記錄調(diào)用,以便于檢查傳遞給監(jiān)聽(tīng)器的模型。為此,我們還需要在 EventServiceProvider::$listen 屬性中注冊(cè)監(jiān)聽(tīng)器:
[ \App\Listeners\UserSaving::class, ], ]; // ... }
現(xiàn)在,當(dāng)模型調(diào)用 saving 事件時(shí),我們注冊(cè)的事件監(jiān)聽(tīng)器也會(huì)被觸發(fā)并執(zhí)行。
嘗試事件監(jiān)聽(tīng)
我們可以通過(guò) tinker 會(huì)話快速生成事件監(jiān)聽(tīng)代碼:
php artisan tinker >>> factory(\App\User::class)->create(); => App\User {#794 name: "Aiden Cremin", email: "josie05@example.com", updated_at: "2018-03-15 03:57:18", created_at: "2018-03-15 03:57:18", id: 2, }
如果你已正確注冊(cè)了事件和監(jiān)聽(tīng)器,則應(yīng)該在 laravel.log 文件中可以看到該模型的 JSON 表達(dá)形式:
[2018-03-15 03:57:18] local.INFO: {"name":"Aiden Cremin","email":"josie05@example.com"}
要注意的一點(diǎn),此時(shí)模型并沒(méi)有 created_at 或 updated_at 屬性。如果在模型上再次調(diào)用 save() ,日志上將會(huì)有一個(gè)帶有時(shí)間戳的新記錄,因?yàn)?saving 事件會(huì)在新創(chuàng)建的記錄或現(xiàn)在有記錄上觸發(fā):
>>> $u = factory(\App\User::class)->create(); => App\User {#741 name: "Eloisa Hirthe", email: "gottlieb.itzel@example.com", updated_at: "2018-03-15 03:59:37", created_at: "2018-03-15 03:59:37", id: 3, } >>> $u->save(); => true >>>
停止一個(gè)保存操作
某些模型事件是允許你進(jìn)行阻止操作的。舉個(gè)荒謬的例子,假設(shè)我們不允許任何一個(gè)用戶的模型保存其屬性 $user->name 的內(nèi)容為 Paul :
/** * 處理事件。 * * @param \App\Events\UserSaving $event * @return mixed */ public function handle(UserSaving $event) { if (stripos($event->user->name, 'paul') !== false) { return false; } }
在 Eloquent 的 Model::save() 方法中,會(huì)根據(jù)事件監(jiān)聽(tīng)的返回結(jié)果判斷是否進(jìn)行停止保存操作:
public function save(array $options = []) { $query = $this->newQueryWithoutScopes(); // 如果 "saving" 事件返回 false ,我們將退出保存并返回 // false,表示保存失敗。這為服務(wù)監(jiān)聽(tīng)者提供了一個(gè)機(jī)會(huì), // 當(dāng)驗(yàn)證失敗或者出現(xiàn)其它任何情況,都可以取消保存操作。 if ($this->fireModelEvent('saving') === false) { return false; }
這個(gè) save() 是個(gè)很好的例子,它告訴了你如何在模型生命周期中自定義事件,以及被動(dòng)執(zhí)行日志數(shù)據(jù)記錄或者任務(wù)調(diào)度。
使用觀察者
如果你正在監(jiān)聽(tīng)多個(gè)事件,那么你可能會(huì)發(fā)現(xiàn)使用觀察者類來(lái)按類型分組存放事件會(huì)更加方便。這里是一個(gè)例子 Eloquent 觀察者 :
你可以在服務(wù)提供者 AppServiceProvider 中的 boot() 方法里注冊(cè)觀察者。
/** * 運(yùn)行所有應(yīng)用服務(wù)。 * * @return void */ public function boot() { User::observe(UserObserver::class); }以上是“Laravel模型事件的示例分析”這篇文章的所有內(nèi)容,感謝各位的閱讀!希望分享的內(nèi)容對(duì)大家有幫助,更多相關(guān)知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道!
本文題目:Laravel模型事件的示例分析
轉(zhuǎn)載源于:http://weahome.cn/article/pisjjd.html