کدهای تمیزتر با View Composer لاراول

حالا موقع نوشتن یک ویوکامپوزر هست. کلاس ViewServiceProvider رو باز می‌کنیم و توی متد boot با استفاده از متد composer از کلاس View یک ویوکامپوزر تعریف می‌کنیم:

<?php

namespace App\Providers;

use App\Models\Category;
use Illuminate\Support\Facades\View;
use Illuminate\Support\ServiceProvider;

class ViewServiceProvider extends ServiceProvider
{
    // ...

    public function boot()
    {
        View::composer('shared.header', function($view) {
            $categories = Category::all();

            $view->with([
                'categories' => $categories,
            ]);
        });
    }
}

همونطور که می‌بینیم به متد composer دو تا آرگومان پاس دادیم. آرگومان اول برای مشخص کردن Viewـی هست که می‌خوایم بهش اطلاعات پاس بدیم و آرگومان دوم یک تابع که همون ویوکامپوزر ما هست. این تابع یک پارامتر داره به اسم $view. مقدار این پارامتر همون ویو مد نظر ما (shared.header) هست که به اون می‌تونیم مثل خط ۱۸ اطلاعات پاس بدیم.

از حالا به بعد متغیر $categories همیشه توی shared.header در دسترس هست و لازم نیست که توی هر return view() که توی برنامه داریم، اون رو پاس بدیم 👌

این امکان وجود داره که یک ویوکامپوزر رو برای چند View در نظر بگیریم:

public function boot()
{
    View::composer(['shared.header', 'shared.footer'], ... );
}

و یا از علامت * استفاده کنیم تا ویوکامپوزر برای همه View ها در نظر گرفته بشه:

public function boot()
{
    View::composer('*', ... );
}

توی کد بالا، ویوکامپوزر یک تابع Callback بود. از معایب استفاده از این توابع این هست که با اضافه شدن چند ویوکامپوزر دیگه، متد boot پرووایدر شلوغ میشه. یک راه بهتر، استفاده از کلاس‌های مجزا برای ویوکامپوزر هست. یعنی به این صورت:

public function boot()
{
    View::composer('shared.header', HeaderComposer::class);
    View::composer('shared.footer', FooterComposer::class);
    View::composer('shared.sidebar', SidebarComposer::class);
}

همونطور که می‌بینیم، کدِ هر قسمت رو منتقل کردیم به یک کلاس جدا. حالا باید این کلاس‌ها رو بسازیم.

دستور آرتیزان برای این کار وجود نداره، پس دستی این کار رو انجام می‌دیم. ابتدا مسیر app/Http/View/Composers رو درست می‌کنیم تا کلاس‌هامون رو اونجا قرار بدیم.

مرحله آخر ساختن کلاس‌هاست. توی همین مسیر یک فایل به اسم HeaderComposer.php درست می‌کنیم با محتویات زیر:

<?php

namespace App\Http\View\Composers;

use App\Models\Category;
use Illuminate\View\View;

class HeaderComposer
{
    public function compose(View $view)
    {
        $categories = Category::all();

        $view->with([
            'categories' => $categories,
        ]);
    }
}

همین! یادتون باشه که namespace این کلاس رو توی پرووایدر use کنید.

این کلاس‌ها توسط Service Container لود میشن و این امکان وجود داره که وابستگی‌ها رو به صورت type-hint به کلاس اضافه کنیم. برای این کار می‌تونیم کلاس رو بصورت زیر باز نویسی کنیم:

<?php

namespace App\Http\View\Composers;

use App\Models\Category;
use Illuminate\View\View;
use App\Repositories\CategoryRepository;

class HeaderComposer
{
    protected $categories;

    public function __construct(CategoryRepository $categories)
    {
        // Dependencies are automatically resolved by the service container...
        $this->categories = $categories;
    }

    public function compose(View $view)
    {
        $view->with([
            'categories' => $this->categories->all(),
        ]);
    }
}

خب دوستان این پست هم به پایان رسید. خوشحال میشم نظراتتون رو بدونم. مرسی از وقتی که گذاشتید 😉✌️