HTML-шаблоны
11.x.
Почему это важно?
Введение
Конечно, не практично возвращать целые строки HTML напрямую из ваших маршрутов и контроллеров. К счастью, в Laravel есть представления (views), которые предоставляют удобный способ размещения всего HTML в отдельных файлах.
Представления (views) разделяют вашу логику контроллера или приложения от логики представления и хранятся в каталоге resources/views. При использовании Laravel обычно шаблоны представлений написаны с использованием языка шаблонизации Blade. Простое представление может выглядеть примерно так:
<!-- Шаблон сохранен в `resources/views/greeting.blade.php` -->
<html>
<body>
<h1>Привет, {{ $name }}</h1>
</body>
</html>
Поскольку этот шаблон сохранен в resources/views/greeting.blade.php, мы можем вернуть его, используя глобальный помощник view, например:
Route::get('/', function () {
return view('greeting', ['name' => 'James']);
});
Ищете дополнительную информацию о том, как писать шаблоны Blade? Ознакомьтесь с полной документацией по Blade, чтобы начать работу.
Шаблоны React / Vue
Вместо написания фронтенд-шаблонов на PHP с использованием Blade многие разработчики предпочитают писать свои шаблоны с использованием React или Vue. Laravel делает это легким благодаря Inertia, библиотеке, которая упрощает связь вашего фронтенда на React или Vue с вашим бэкендом Laravel, избегая типичных сложностей, связанных с созданием SPA (Single Page Application).
Наши стартовые наборы Breeze и Jetstream starter kits предоставляют отличную отправную точку для вашего следующего приложения Laravel, работающего на Inertia. Кроме того, Laravel Bootcamp предоставляет полное демонстрационное руководство по созданию приложения Laravel, работающего на Inertia, включая примеры с использованием Vue и React.
Создание и отрисовка шаблонов
Вы можете создать представление, разместив файл с расширением .blade.php в каталоге resources/views вашего приложения, либо с помощью команды Artisan make:view:
php artisan make:view greeting
Расширение .blade.php информирует фреймворк о том, что файл является шаблоном Blade. Blade-шаблоны содержат HTML, а также директивы Blade, которые позволяют вам легко выводить значения, создавать условные операторы “if”, выполнять итерации по данным и многое другое.
После того как вы создали шаблон, вы можете вернуть его из маршрута или контроллера вашего приложения, используя глобальный помощник view:
Route::get('/', function () {
return view('greeting', ['name' => 'James']);
});
Шаблон также могут быть возвращены с помощью фасада View:
use Illuminate\Support\Facades\View;
return View::make('greeting', ['name' => 'James']);
Как видно, первый аргумент, переданный помощнику view, соответствует имени файла шаблона в каталоге resources/views. Второй аргумент – это массив данных, которые должны быть доступны в шаблоне. В этом случае мы передаем переменную name, которая будет выведена в шаблоне с использованием синтаксиса Blade.
Вложенные каталоги шаблонов
Шаблоны также могут быть вложены в подкаталоги каталога resources/views. «Точечная нотация» используется для указания вложенности шаблона. Например, если ваш шаблон хранится в resources/views/admin/profile.blade.php, то вы можете вернуть его из маршрута / контроллера вашего приложения следующим образом:
return view('admin.profile', $data);
Имена каталогов шаблонов не должны содержать символа
..
Использование первого доступного шаблона
Используя метод first фасада View, вы можете отобразить первый шаблон, который существует в переданном массиве шаблонов. Это может быть полезно, если ваше приложение или пакет позволяют настраивать или перезаписывать шаблоны:
use Illuminate\Support\Facades\View;
return View::first(['custom.admin', 'admin'], $data);
Определение наличия шаблона
Если вам нужно определить, существует ли шаблон, вы можете использовать фасад View. Метод exists вернет true, если он существует:
use Illuminate\Support\Facades\View;
if (View::exists('admin.profile')) {
// ...
}
Передача данных шаблону
Как вы видели в предыдущих примерах, вы можете передать массив данных шаблонам, чтобы сделать эти данные доступными для них:
return view('greetings', ['name' => 'Victoria']);
При передаче информации таким образом данные должны быть массивом с парами ключ / значение. После предоставления данных в шаблон вы можете получить доступ к каждому значению, используя ключи данных, схожее с <?php echo $name; ?>.
В качестве альтернативы передаче полного массива данных вспомогательной функции view вы можете использовать метод with для добавления некоторых данных в шаблон. Метод with возвращает экземпляр объекта представления, так что вы можете продолжить связывание методов перед возвратом шаблона:
return view('greeting')
->with('name', 'Victoria')
->with('occupation', 'Astronaut');
Общедоступные данные для всех шаблонов
Иногда требуется сделать данные общедоступными для всех шаблонов, отображаемыми вашим приложением. Вы можете сделать это, используя метод share фасада View. Как правило, вызов метода share осуществляется в методе boot поставщика служб. Вы можете добавить их в класс App\Providers\AppServiceProvider или создать отдельного поставщика для их размещения:
<?php
namespace App\Providers;
use Illuminate\Support\Facades\View;
class AppServiceProvider extends ServiceProvider
{
/**
* Регистрация любых служб приложения.
*/
public function register(): void
{
//
}
/**
* Загрузка любых служб приложения.
*/
public function boot(): void
{
View::share('key', 'value');
}
}
Компоновщики шаблонов
Компоновщики шаблонов – это замыкания или методы класса, которые вызываются при отрисовке шаблонов. Если у вас есть данные, которые вы хотите привязать к шаблону каждый раз при его отрисовке, компоновщик шаблонов поможет вам организовать эту логику в одном месте. Компоновщики шаблонов особенно полезны, если один и тот же шаблон возвращается несколькими маршрутами или контроллерами в вашем приложении и всегда требует определенного фрагмента данных.
Как правило, компоновщики шаблонов регистрируются в одном из поставщиков служб вашего приложения. В этом примере мы предположим, что мы создали новый App\Providers\ViewServiceProvider для размещения этой логики.
Мы будем использовать метод composer фасада View, чтобы зарегистрировать компоновщик. Laravel по умолчанию не содержит каталог для классов компоновщиков, поэтому вы можете организовать их, как хотите. Например, вы можете создать каталог app/View/Composers для размещения всех компоновщиков вашего приложения:
<?php
namespace App\Providers;
use App\View\Composers\ProfileComposer;
use Illuminate\Support\Facades;
use Illuminate\Support\ServiceProvider;
class ViewServiceProvider extends ServiceProvider
{
/**
* Регистрация любых служб приложения.
*/
public function register(): void
{
// ...
}
/**
* Загрузка любых служб приложения.
*/
public function boot(): void
{
// Использование компоновщиков на основе классов ...
Facades\View::composer('profile', ProfileComposer::class);
// Использование анонимных компоновщиков ...
Facades\View::composer('welcome', function (View $view) {
// ...
});
Facades\View::composer('dashboard', function (View $view) {
// ...
});
}
}
Помните, что если вы создаете нового поставщика служб, который будет содержать регистрации вашего компоновщика, вам нужно будет добавить поставщика служб в массив
providersв файле конфигурацииconfig/app.php.
Теперь, когда мы зарегистрировали компоновщик, метод compose класса App\View\Composers\ProfileComposer будет выполняться каждый раз, когда отрисовывается шаблон профиля. Давайте посмотрим на пример класса компоновщика:
<?php
namespace App\View\Composers;
use App\Repositories\UserRepository;
use Illuminate\View\View;
class ProfileComposer
{
/**
* Создать нового компоновщика профиля.
*/
public function __construct(
protected UserRepository $users,
) {}
/**
* Привязать данные к шаблону.
*/
public function compose(View $view): void
{
$view->with('count', $this->users->count());
}
}
Как видите, все компоновщики внедряются через контейнер служб, поэтому вы можете указать любые зависимости, которые вам нужны, в конструкторе компоновщика.
Связывание компоновщика с несколькими шаблонами
Вы можете связать компоновщика с несколькими шаблонами одновременно, передав массив шаблонов в качестве первого аргумента методу composer:
use App\Views\Composers\MultiComposer;
use Illuminate\Support\Facades\View;
View::composer(
['profile', 'dashboard'],
MultiComposer::class
);
Допускается использование метасимвола подстановки *, что позволит вам прикрепить компоновщик ко всем шаблонам:
use Illuminate\Support\Facades;
use Illuminate\View\View;
Facades\View::composer('*', function (View $view) {
// ...
});
Создатели шаблонов
«Создатели» шаблонов очень похожи на компоновщиков; но, они выполняются сразу после создания экземпляра, а не ожидают отрисовки шаблона. Чтобы зарегистрировать создателя шаблона, используйте метод creator:
use App\View\Creators\ProfileCreator;
use Illuminate\Support\Facades\View;
View::creator('profile', ProfileCreator::class);
Оптимизация шаблонов
По умолчанию шаблоны Blade компилируются по требованию. Когда выполняется запрос, который отрисовывает шаблон, Laravel определит, существует ли скомпилированная версия шаблона. Если файл существует, Laravel далее определит, был ли исходный шаблон изменен позднее скомпилированного. Если скомпилированного шаблона либо не существует, либо исходный шаблон был изменен, Laravel перекомпилирует шаблон.
Компиляция шаблонов во время запроса отрицательно влияет на производительность, поэтому Laravel содержит команду Artisan view:cache для предварительной компиляции всех шаблонов, используемых вашим приложением. Для повышения производительности вы можете выполнить эту команду как часть процесса развертывания:
php artisan view:cache
Вы можете использовать команду view:clear для очистки кеша шаблонов:
php artisan view:clear
