آموزش ارسال نوتیفیکیشن‌ها در لاراول

لاراول علاوه بر پشتیبانی از امکان ارسال ایمیل، از امکان ارسال نوتیفیکیشن‌‌ها (اعلان‌ها) بر روی کانال‌های مختلفی مانند mail ،SMS (از طریق Nexmo) و Slack پشتیبانی می‌کند. نوتیفیکیشن‌ها را می‌توان در یک پایگاه داده ذخیره کرد تا بتوان در رابط وب آن‌ها را نمایش داد.

معمولا، نوتیفیکیشن‌ها باید پیام‌های کوتاه و شامل اطلاعاتی باشند که کاربران را از اتفاقی که در برنامه شما رخ داده است، مطلع کنند. برای مثال، اگر شما در حال نوشتن یک برنامه پرداخت صورت حساب هستید، می‌توانید از طریق کانال‌های ایمیل و SMS، نوتیفیکیشن‌ «صورتحساب پرداخت شده است» را به کاربران خود ارسال کنید.

ایجاد نوتیفیکیشن‌‌ها در لاراول

در لاراول، هر نوتیفیکیشن‌ با یک کلاس واحد (که معمولا در دایرکتوری app/Notifications ذخیره می‌شود) نمایش داده می‌شود. اگر این دایرکتوری در برنامه شما وجود ندارد، نگران نباشید زیرا در زمان اجرای دستور آرتیسان make:notification این دایرکتوری برای شما ایجاد می‌شود:

php artisan make<span class="token punctuation">:</span>notification InvoicePaid

1	php artisan make<span class="token punctuation">:</span>notification InvoicePaid

این دستور یک کلاس notification جدید را در دایرکتوری app/Notifications شما قرار می‌دهد. هر کلاس notification شامل یک متد via و تعدادی از متدهای ایجاد پیام مانند toMail یا toDatabase است که نوتیفیکیشن را به یک پیام بهینه سازی شده برای ارسال به یک کانال خاص تبدیل می‌کند.

ارسال نوتیفیکیشن‌ ها در لاراول

با استفاده از ویژگی Notifiable

نوتیفیکیشن‌ها را می‌توان به دو روش ارسال کرد، با استفاده از متد notify از ویژگی Notifiable یا با استفاده ازfacadeNotification. ابتدا، اجازه دهید از ویژگی Notifiable استفاده کنیم:

<span class="token php language-php"><span class="token delimiter important">&lt;?php</span>

<span class="token keyword">namespace</span> <span class="token package">App</span><span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Notifications<span class="token punctuation">\</span>Notifiable</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Foundation<span class="token punctuation">\</span>Auth<span class="token punctuation">\</span>User</span> <span class="token keyword">as</span> Authenticatable<span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">User</span> <span class="token keyword">extends</span> <span class="token class-name">Authenticatable</span>
<span class="token punctuation">{</span>
    <span class="token keyword">use</span> <span class="token package">Notifiable</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span></span>

<?php

namespace App;

use Illuminate\Notifications\Notifiable;

use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable

{

use Notifiable;

}

این ویژگی توسط مدل پیش‌فرض App\User استفاده می‌شود و شامل یک متد notify است که برای ارسال نوتیفیکیشن‌ها به کار می‌رود. متد notify یک نمونه نوتیفیکیشن‌ را دریافت می‌کند:

<span class="token keyword">use</span> <span class="token package">App<span class="token punctuation">\</span>Notifications<span class="token punctuation">\</span>InvoicePaid</span><span class="token punctuation">;</span>

<span class="token variable">$user</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">notify</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">InvoicePaid</span><span class="token punctuation">(</span><span class="token variable">$invoice</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

use App\Notifications\InvoicePaid;

توجه کنید که شما می‌توانید از ویژگی Illuminate\Notifications\Notifiable بر روی هر یک از مدل‌های خود در لاراول استفاده کنید و فقط محدود به استفاده از آن در مدل User برنامه خود نیستید.

با استفاده از Notification Facade

شما همچنین می‌توانید از طریق Facade Notification نوتیفیکیشن‌ها را ارسال کنید. این روش زمانی مفید است که برای مثال شما نیاز به ارسال یک نوتیفیکیشن‌ به چند موجودیت قابل اعلان (notifiable entities) مانند مجموعه‌ای از کاربران داشته باشید. برای ارسال نوتیفیکیشن‌ها با استفاده از Facade، تمام موجودیت‌های قابل اعلان‌ و نمونه نوتیفیکیشن‌ را به متد send ارسال کنید:

<span class="token scope">Notification<span class="token punctuation">::</span></span><span class="token function">send</span><span class="token punctuation">(</span><span class="token variable">$users</span><span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name">InvoicePaid</span><span class="token punctuation">(</span><span class="token variable">$invoice</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

Notification::send($users, new InvoicePaid($invoice));

مشخص کردن کانال های تحویل نوتیفیکیشن

هر کلاس notification ‌دارای یک متد via است که مشخص می‌کند که نوتیفیکیشن‌ به کدام کانال‌‌ها تحویل داده خواهد شد. معمولا، نوتیفیکیشن‌ها می‌توانند بر روی کانال‌های mail ، database ، broadcas t، nexmo و slack ارسال شوند.

اگر بخواهید از کانال‌های تحویل دیگری مانند Telegram یا Pusher استفاده کنید، می‌توانید برای کسب اطلاعات بیشتر، سری به وب سایت کانال‌های نوتیفیکیشن لاراول بزنید.

متد via یک نمونه $notifiable دریافت می‌کند که نمونه‌ای از کلاس نوتیفیکیشنی است که ارسال می‌شود. شما می‌توانید با استفاده از $notifiable تعیین کنید که نوتیفیکیشن بر روی کدام کانال‌ باید تحویل داده شود:

<span class="token comment">/**
 * Get the notification's delivery channels.
 *
 * @param  mixed  $notifiable
 * @return array
 */</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">via</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
    <span class="token keyword">return</span> <span class="token variable">$notifiable</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">prefers_sms</span> <span class="token operator">?</span> <span class="token punctuation">[</span><span class="token string">'nexmo'</span><span class="token punctuation">]</span> <span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">'mail'</span><span class="token punctuation">,</span> <span class="token string">'database'</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

/**

* Get the notification's delivery channels.

* @param mixed $notifiable

* @return array

*/

public function via($notifiable)

{

return $notifiable->prefers_sms ? ['nexmo'] : ['mail', 'database'];

}

نوتیفیکیشن‌‌های صف شده در لاراول

قبل از صف بندی نوتیفیکیشن‌ها در یک صف، شما ابتدا باید صف خود را پیکربندی کرده و یک worker را استارت کنید.

ارسال نوتیفیکیشن‌ها ممکن است کاری زمانبر باشد، به خصوص اگر کانال برای دریافت نوتیفیکیشن‌ نیاز به یک فراخوانی خارجی داشته باشد. برای سرعت بخشیدن به زمان پاسخ برنامه، می‌توانید با اضافه کردن رابط ShouldQueue و یک ویژگی Queueable به کلاس، نوتیفیکیشن خود را صف بندی کنید. این رابط و ویژگی از قبل برای تمام نوتیفیکیشن‌‌ها ایمپورت شده و با استفاده از دستور make:notification ساخته شده است. بنابراین، شما می‌توانید بلافاصله آن‌ها را به کلاس notification خود اضافه کنید:

<span class="token php language-php"><span class="token delimiter important">&lt;?php</span>

<span class="token keyword">namespace</span> <span class="token package">App<span class="token punctuation">\</span>Notifications</span><span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Bus<span class="token punctuation">\</span>Queueable</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Notifications<span class="token punctuation">\</span>Notification</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Contracts<span class="token punctuation">\</span>Queue<span class="token punctuation">\</span>ShouldQueue</span><span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">InvoicePaid</span> <span class="token keyword">extends</span> <span class="token class-name">Notification</span> <span class="token keyword">implements</span> <span class="token class-name">ShouldQueue</span>
<span class="token punctuation">{</span>
    <span class="token keyword">use</span> <span class="token package">Queueable</span><span class="token punctuation">;</span>

    <span class="token comment">// ...</span>
<span class="token punctuation">}</span></span>

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;

use Illuminate\Notifications\Notification;

use Illuminate\Contracts\Queue\ShouldQueue;

class InvoicePaid extends Notification implements ShouldQueue

{

use Queueable;

// ...

}

زمانی که رابط ShouldQueue به نوتیفیکیشن شما اضافه شد، می‌توانید این نوتیفیکیشن‌ را به صورت عادی ارسال کنید. لاراول این رابط را در درون کلاس شناسایی کرده و به صورت خودکار تحویل نوتیفیکیشن را صف بندی می‌کند:

<span class="token variable">$user</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">notify</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">InvoicePaid</span><span class="token punctuation">(</span><span class="token variable">$invoice</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

اگر می‌خواهید تحویل نوتیفیکیشن‌ را به تاخیر بیاندازید، می‌توانید متد delay را به نوتیفیکیشن‌ خود انتقال دهید:

<span class="token variable">$when</span> <span class="token operator">=</span> <span class="token function">now</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">addMinutes</span><span class="token punctuation">(</span><span class="token number">10</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

<span class="token variable">$user</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">notify</span><span class="token punctuation">(</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">InvoicePaid</span><span class="token punctuation">(</span><span class="token variable">$invoice</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">delay</span><span class="token punctuation">(</span><span class="token variable">$when</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

$when = now()->addMinutes(10);

$user->notify((new InvoicePaid($invoice))->delay($when));

نوتیفیکیشن‌های On-Demand در لاراول

گاهی اوقات، شما ممکن است نیاز به ارسال یک نوتیفیکیشن‌ به کسی دارید که به عنوان یک کاربر (user) در برنامه شما ذخیره نشده است. با استفاده از متد Notification::route ، قبل از ارسال نوتیفیکیشن‌، می‌توانید اطلاعات مسیریابی نوتیفیکیشن ad-hoc را مشخص کنید:

<span class="token scope">Notification<span class="token punctuation">::</span></span><span class="token function">route</span><span class="token punctuation">(</span><span class="token string">'mail'</span><span class="token punctuation">,</span> <span class="token string">'taylor@example.com'</span><span class="token punctuation">)</span>
            <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">route</span><span class="token punctuation">(</span><span class="token string">'nexmo'</span><span class="token punctuation">,</span> <span class="token string">'5555555555'</span><span class="token punctuation">)</span>
            <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">notify</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">InvoicePaid</span><span class="token punctuation">(</span><span class="token variable">$invoice</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

Notification::route('mail', 'taylor@example.com')

->route('nexmo', '5555555555')

->notify(new InvoicePaid($invoice));

نوتیفیکیشن ‌های Mail در لاراول

فرمت کردن پیام های ایمیل

اگر بخواهید یک نوتیفیکیشن‌ را به عنوان یک ایمیل ارسال کنید، باید یک متد toMail را در کلاس نوتیفیکیشن‌ تعریف کنید. این متد یک $notifiable را دریافت می‌کند و باید یک نمونه از Illuminate\Notifications\Messages\MailMessage را بازگرداند. پیا‌م‌های ایمیل ممکن است حاوی خطوط متنی و همچنین فراخوانی یک اکشن باشند. اجازه دهید، نگاهی به یک مثال از متد toMail داشته باشیم:

<span class="token comment">/**
 * Get the mail representation of the notification.
 *
 * @param  mixed  $notifiable
 * @return \Illuminate\Notifications\Messages\MailMessage
 */</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toMail</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
    <span class="token variable">$url</span> <span class="token operator">=</span> <span class="token function">url</span><span class="token punctuation">(</span><span class="token string">'/invoice/'</span><span class="token punctuation">.</span><span class="token this">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">invoice</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">id</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

    <span class="token keyword">return</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">MailMessage</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">greeting</span><span class="token punctuation">(</span><span class="token string">'Hello!'</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">line</span><span class="token punctuation">(</span><span class="token string">'One of your invoices has been paid!'</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">action</span><span class="token punctuation">(</span><span class="token string">'View Invoice'</span><span class="token punctuation">,</span> <span class="token variable">$url</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">line</span><span class="token punctuation">(</span><span class="token string">'Thank you for using our application!'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

/**

* Get the mail representation of the notification.

* @param mixed $notifiable

* @return \Illuminate\Notifications\Messages\MailMessage

*/

public function toMail($notifiable)

{

$url = url('/invoice/'.$this->invoice->id);

->greeting('Hello!')

->line('One of your invoices has been paid!')

->action('View Invoice', $url)

->line('Thank you for using our application!');

}

توجه کنید که ما از this->invoice->id$ در متد toMail استفاده می‌کنیم. شما می‌توانید هر داده‌ای را که نوتیفیکیشن برای ایجاد پیام خود نیاز دارد را به سازنده نوتیفیکیشن انتقال دهید.

ما در این مثال، یک پیام خوشامد، یک خط متن، یک فراخوانی اکشن و سپس یک خط متنی دیگر را ثبت می‌کنیم. این متدها توسط شی MailMessage ارائه می‌شوند که عملیات قالب بندی ایمیل‌های معاملاتی کوچک را ساده و سریع می‌کنند. سپس، کانال ایمیل، اجزای پیام را به یک قالب ایمیل HTML پاسخگو با یک تطابق متن ساده (plain-text) ترجمه می‌کند. در اینجا، مثالی از ایجاد ایمیل توسط کانال mail را مشاهده می‌کنید:

در زمان ارسال نوتیفیکیشن‌های ایمیل، مطمئن شوید که مقدار name در فایل پیکربندی config/app.php شما تنظیم شده باشد. این مقدار در قسمت هدر و پاورقی پیام‌های نوتیفیکیشن ایمیل شما استفاده می‌شود.

سایر گزینه های قالب بندی نوتیفیکیشن

به جای تعریف خطوط متنی در کلاس notification‌، می‌توانید از متد view برای مشخص کردن یک قالب سفارشی استفاده کنید که باید برای ارسال نوتیفیکیشن‌ ایمیل مورد استفاده قرار ‌گیرد:

<span class="token comment">/**
* Get the mail representation of the notification.
*
* @param mixed $notifiable
* @return \Illuminate\Notifications\Messages\MailMessage
*/</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toMail</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">MailMessage</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">view</span><span class="token punctuation">(</span>
<span class="token string">'emails.name'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string">'invoice'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token this">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">invoice</span><span class="token punctuation">]</span>
<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

/**

* Get the mail representation of the notification.

* @param mixed $notifiable

* @return \Illuminate\Notifications\Messages\MailMessage

*/

{

return (new MailMessage)->view(

'emails.name', ['invoice' => $this->invoice]

);

}

علاوه بر این، شما می‌توانید یک شئ mailable را از متد toMail بازگردانید:

<span class="token keyword">use</span> <span class="token package">App<span class="token punctuation">\</span>Mail<span class="token punctuation">\</span>InvoicePaid</span> <span class="token keyword">as</span> Mailable<span class="token punctuation">;</span>

<span class="token comment">/**
* Get the mail representation of the notification.
*
* @param mixed $notifiable
* @return Mailable
*/</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toMail</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">Mailable</span><span class="token punctuation">(</span><span class="token this">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">invoice</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">to</span><span class="token punctuation">(</span><span class="token this">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">user</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">email</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

use App\Mail\InvoicePaid as Mailable;

/**

* Get the mail representation of the notification.

* @param mixed $notifiable

* @return Mailable

*/

{

return (new Mailable($this->invoice))->to($this->user->email);

}

پیغام های خطا

برخی از نوتیفیکیشن‌ها کاربران را از بروز خطاهایی مانند پرداخت صورت حساب ناموفق مطلع می‌کنند. شما می‌توانید با فراخوانی متد error هنگام ایجاد پیام خود، نشان دهید که پیام ایمیل مربوط به یک خطا است. هنگام استفاده از متد error در یک پیام ایمیل، دکمه فراخوانی اکشن به جای آبی، قرمز رنگ خواهد بود:

<span class="token comment">/**
* Get the mail representation of the notification.
*
* @param mixed $notifiable
* @return \Illuminate\Notifications\Message
*/</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toMail</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">MailMessage</span><span class="token punctuation">)</span>
<span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">error</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">subject</span><span class="token punctuation">(</span><span class="token string">'Notification Subject'</span><span class="token punctuation">)</span>
<span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">line</span><span class="token punctuation">(</span><span class="token string">'...'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

/**

* Get the mail representation of the notification.

* @param mixed $notifiable

* @return \Illuminate\Notifications\Message

*/

{

->error()

->subject('Notification Subject')

->line('...');

}

سفارشی سازی گیرنده (Recipient)

در هنگام ارسال نوتیفیکیشن‌ها از طریق کانال mail، سیستم نوتیفیکیشن به صورت خودکار به دنبال یک پراپرتی email در موجودیت قابل اعلان شما خواهد گشت. شما می‌توانید با تعریف یک متد routeNotificationForMailبر روی موجودیت مشخص کنید که از کدام آدرس ایمیل برای تحویل نوتیفیکیشن‌ استفاده کند:

<span class="token php language-php"><span class="token delimiter important">&lt;?php</span>

<span class="token keyword">namespace</span> <span class="token package">App</span><span class="token punctuation">;</span>

<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Notifications<span class="token punctuation">\</span>Notifiable</span><span class="token punctuation">;</span>
<span class="token keyword">use</span> <span class="token package">Illuminate<span class="token punctuation">\</span>Foundation<span class="token punctuation">\</span>Auth<span class="token punctuation">\</span>User</span> <span class="token keyword">as</span> Authenticatable<span class="token punctuation">;</span>

<span class="token keyword">class</span> <span class="token class-name">User</span> <span class="token keyword">extends</span> <span class="token class-name">Authenticatable</span>
<span class="token punctuation">{</span>
    <span class="token keyword">use</span> <span class="token package">Notifiable</span><span class="token punctuation">;</span>

    <span class="token comment">/**
     * Route notifications for the mail channel.
     *
     * @param  \Illuminate\Notifications\Notification  $notification
     * @return string
     */</span>
    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">routeNotificationForMail</span><span class="token punctuation">(</span><span class="token variable">$notification</span><span class="token punctuation">)</span>
    <span class="token punctuation">{</span>
        <span class="token keyword">return</span> <span class="token this">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">email_address</span><span class="token punctuation">;</span>
    <span class="token punctuation">}</span>
<span class="token punctuation">}</span></span>

<?php

namespace App;

class User extends Authenticatable

{

use Notifiable;

/**

* Route notifications for the mail channel.

* @param \Illuminate\Notifications\Notification $notification

* @return string

*/

public function routeNotificationForMail($notification)

{

return $this->email_address;

}

}

سفارشی سازی موضوع (Subject)

در حالت پیش‌فرض، موضوع ایمیل، نام کلاس نوتیفیکیشن است که به صورت title case فرمت دهی شده است. بنابراین، اگر نام کلاس نوتیفیکیشن شما InvoicePaid باشد، موضوع ایمیل به صورت Invoice Paid خواهد بود. اگر می‌خواهید یک موضوع واضح‌تری برای پیام خود مشخص کنید، می‌توانید متد subject را در هنگام ساخت پیام خود فراخوانی کنید:

<span class="token comment">/**
 * Get the mail representation of the notification.
 *
 * @param  mixed  $notifiable
 * @return \Illuminate\Notifications\Messages\MailMessage
 */</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toMail</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
    <span class="token keyword">return</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">MailMessage</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">subject</span><span class="token punctuation">(</span><span class="token string">'Notification Subject'</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">line</span><span class="token punctuation">(</span><span class="token string">'...'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

/**

* Get the mail representation of the notification.

* @param mixed $notifiable

* @return \Illuminate\Notifications\Messages\MailMessage

*/

{

->line('...');

}

سفارشی سازی قالب های نوتیفیکیشن

شما می‌توانید قالب HTML و plain text را که توسط نوتیفیکیشن‌‌های ایمیل استفاده می‌شوند را تغییر دهید. پس از اجرای دستور زیر، قالب‌های نوتیفیکیشن ایمیل در دایرکتوری resources/views/vendor/notifications قرار خواهند گرفت:

php artisan vendor<span class="token punctuation">:</span>publish <span class="token operator">--</span>tag<span class="token operator">=</span>laravel<span class="token operator">-</span>notifications

1	php artisan vendor<span class="token punctuation">:</span>publish <span class="token operator">--</span>tag<span class="token operator">=</span>laravel<span class="token operator">-</span>notifications

نوتیفیکیشن‌های ایمیل Markdown

نوتیفیکیشن‌‌های ایمیل Markdown به شما اجازه می‌دهند تا از قالب‌های پیش ساخته از نوتیفیکیشن‌های ایمیل استفاده کنید که امکان نوشتن پیام‌های سفارشی طولانی‌تر را به شما می‌دهد. از آنجا که پیام‌ها در Markdown نوشته می‌شوند، لاراول می‌تواند قالب‌های HTML زیبا و پاسخگو را برای پیام‌ها رندر کند، در حالی که به صورت خودکار یک تطابق plain-text را نیز ایجاد می‌کند.

ایجاد یک پیام

برای ایجاد یک نوتیفیکیشن با یک قالب Markdown مربوطه، می‌توانید از گزینه –markdown در دستور آرتیسان make:notification استفاده کنید:

php artisan make<span class="token punctuation">:</span>notification InvoicePaid <span class="token operator">--</span>markdown<span class="token operator">=</span>mail<span class="token punctuation">.</span>invoice<span class="token punctuation">.</span>paid

1	php artisan make<span class="token punctuation">:</span>notification InvoicePaid <span class="token operator">--</span>markdown<span class="token operator">=</span>mail<span class="token punctuation">.</span>invoice<span class="token punctuation">.</span>paid

مانند سایر نوتیفیکیشن‌های ایمیل، نوتیفیکیشن‌هایی که از قالب‌های Markdown استفاده می‌کنند، باید متد toMailرا در کلاس نوتیفیکیشن خود تعریف کنند. با این حال، به جای استفاده از متدهای line و action برای ساخت نوتیفیکیشن، بایستی از متد markdown برای مشخص کردن نام قالب Markdown که باید مورد استفاده قرار گیرد، استفاده کنید:

<span class="token comment">/**
 * Get the mail representation of the notification.
 *
 * @param  mixed  $notifiable
 * @return \Illuminate\Notifications\Messages\MailMessage
 */</span>
<span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function">toMail</span><span class="token punctuation">(</span><span class="token variable">$notifiable</span><span class="token punctuation">)</span>
<span class="token punctuation">{</span>
    <span class="token variable">$url</span> <span class="token operator">=</span> <span class="token function">url</span><span class="token punctuation">(</span><span class="token string">'/invoice/'</span><span class="token punctuation">.</span><span class="token this">$this</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">invoice</span><span class="token operator">-</span><span class="token operator">&gt;</span><span class="token property">id</span><span class="token punctuation">)</span><span class="token punctuation">;</span>

    <span class="token keyword">return</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">MailMessage</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">subject</span><span class="token punctuation">(</span><span class="token string">'Invoice Paid'</span><span class="token punctuation">)</span>
                <span class="token operator">-</span><span class="token operator">&gt;</span><span class="token function">markdown</span><span class="token punctuation">(</span><span class="token string">'mail.invoice.paid'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string">'url'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token variable">$url</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

/**

* Get the mail representation of the notification.

* @param mixed $notifiable

* @return \Illuminate\Notifications\Messages\MailMessage

*/

{

->subject('Invoice Paid')

->markdown('mail.invoice.paid', ['url' => $url]);

}

نوشتن پیام

نوتیفیکیشن‌های ایمیل Markdown از ترکیبی از کامپوننت‌های Blade و سینتکس Markdown استفاده می‌کنند که به شما این امکان را می‌دهد تا به راحتی نوتیفیکیشن‌ها را با استفاده از کامپوننت‌های پیش ساخته لاراول ایجاد کنید.

@<span class="token function">component</span><span class="token punctuation">(</span><span class="token string">'mail::message'</span><span class="token punctuation">)</span>
<span class="token shell-comment comment"># Invoice Paid</span>

Your invoice has been paid<span class="token operator">!</span>

@<span class="token function">component</span><span class="token punctuation">(</span><span class="token string">'mail::button'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string">'url'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token variable">$url</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
View Invoice
@endcomponent

Thanks<span class="token punctuation">,</span><span class="token operator">&lt;</span>br<span class="token operator">&gt;</span>
<span class="token punctuation">{</span><span class="token punctuation">{</span> <span class="token function">config</span><span class="token punctuation">(</span><span class="token string">'app.name'</span><span class="token punctuation">)</span> <span class="token punctuation">}</span><span class="token punctuation">}</span>
@endcomponent

@component('mail::message')

# Invoice Paid

Your invoice has been paid!

View Invoice

@endcomponent

Thanks,<br>

{{ config('app.name') }}

@endcomponent

کامپوننت Button

کامپوننت Button یک لینک دکمه مرکزی را رندر می‌کند. این کامپوننت دو آرگومان دریافت می‌کند، یک url و یک آرکومان color اختیاری که از رنگ‌های blue، green و red پشتیبانی می‌کند. شما می‌توانید هر تعداد کامپوننت Button را که می‌خواهید را به یک نوتیفیکیشن اضافه کنید:

@<span class="token function">component</span><span class="token punctuation">(</span><span class="token string">'mail::button'</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string">'url'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token variable">$url</span><span class="token punctuation">,</span> <span class="token string">'color'</span> <span class="token operator">=</span><span class="token operator">&gt;</span> <span class="token string">'green'</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
View Invoice
@endcomponent

@component('mail::button', ['url' => $url, 'color' => 'green'])

View Invoice

@endcomponent

کامپوننت Panel

کامپوننت Panel یک بلوک مشخص از متن در یک پنل را رندر می‌کند که رنگ پس زمینه آن کمی متفاوت‌تر از بقیه اجزای نوتیفیکیشن‌ است. استفاده از کامپوننت Panel این امکان را به شما می‌دهد که توجه خاصی به یک بلوک مشخص از متن نوتیفیکیشن داشته باشید:

@<span class="token function">component</span><span class="token punctuation">(</span><span class="token string">'mail::panel'</span><span class="token punctuation">)</span>
This is the panel content<span class="token punctuation">.</span>
@endcomponent

@component('mail::panel')

This is the panel content.

@endcomponent

کامپوننت Table

کامپوننت Table این امکان را می‌دهد که بتوانید یک جدول Markdown را به یک جدول HTML تبدیل کنید. کامپوننت Table یک جدول Markdown را به عنوان محتوای خود دریافت می‌کند. تراز بندی ستون جدول با استفاده از سینتکس تراز بندی جدول Markdown پیش‌فرض پشتیبانی می‌شود:

@<span class="token function">component</span><span class="token punctuation">(</span><span class="token string">'mail::table'</span><span class="token punctuation">)</span>
<span class="token operator">|</span> Laravel       <span class="token operator">|</span> Table         <span class="token operator">|</span> Example  <span class="token operator">|</span>
<span class="token operator">|</span> <span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">-</span> <span class="token operator">|</span><span class="token punctuation">:</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">-</span><span class="token punctuation">:</span><span class="token operator">|</span> <span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token operator">--</span><span class="token punctuation">:</span><span class="token operator">|</span>
<span class="token operator">|</span> Col <span class="token number">2</span> is      <span class="token operator">|</span> Centered      <span class="token operator">|</span> <span class="token variable">$10</span>      <span class="token operator">|</span>
<span class="token operator">|</span> Col <span class="token number">3</span> is      <span class="token operator">|</span> Right<span class="token operator">-</span>Aligned <span class="token operator">|</span> <span class="token variable">$20</span>      <span class="token operator">|</span>
@endcomponent

@component('mail::table')

| Laravel | Table | Example |

| ------------- |: