README

Bitrix Blade - интеграция шаблонизатора Blade в Битрикс

Установка

composer require ge1i0n/bitrix-blade
Добавляем в init.php

use Arrilot\BitrixBlade\BladeProvider;

require $_SERVER['DOCUMENT_ROOT']."/vendor/autoload.php";

BladeProvider::register();

Использование

Заменяем шаблон компонента с template.php на template.blade и можно писать на Blade

Директива @include('path.to.view') модифицирована следующим образом:

Сначала view ищется относительно директории текущего шаблона компонента (там где лежит template.blade)
Если не view там не нашёлся, то он ищется относительно базовой директории (по умолчанию local/views, но может быть указана другая при вызове BladeProvider::register())

X-Компоненты

Вы можете использовать x-компоненты в своём шаблоне. По-умолчанию классы x-компонентов подгружаются из пространства имён View\\Components\\, но можно задать своё пространство имён в конфигурации. Если вы хотите использовать специфический класс для компонента, его можно зарегистрировать в компиляторе следующим образом:

$compiler = BladeProvider::getCompiler();
$compiler->component('your-component', \\Namespace\\YourComponent::class);

Также вы можете использовать дополнительные простраства имён, если это необходимо. Для этого их нужно зарегистрировать:

$compiler = BladeProvider::getCompiler();
$compiler->componentNamespace('Any\\Components\\Namespace\\', 'any');

Пользовательские директивы (custom directives)

Для того чтобы добавить свою директиву, необходимо зарегистрировать её в компиляторе:

$compiler = BladeProvider::getCompiler();
$compiler->directive('directiveName', function ($expression) {
    return '...';
});

При установке пакета BladeProvider::register() за вас уже автоматически зарегистрировано некоторое количество полезных директив:

@bxComponent - аналог $APPLICATION->IncludeComponent()
@block('key') и @endblock - всё что заключено между ними будет выведено в месте, где вызван метод $APPLICATION->ShowViewContent('key')
@lang('key') - равносильно {!! Bitrix\Main\Localization\Loc::getMessage('key') !!}
@auth и @endauth - сокращенная запись <?php if($USER->IsAuthorized()) ?> ... <?php endif ?>
@guest и @endguest - аналогично, но проверка на неавторизованного юзера.
@admin и @endadmin - аналогично, но $USER->IsAdmin()
@csrf - сокращенная форма для <input type="hidden" name="sessid" value="{!! bitrix_sessid() !!}" />
Директивы по работе с эрмитажем

Конфигурация

При необходимости пути можно поменять в конфигурации. .settings_extra.php

    'bitrix-blade' => [
        'value'    => [
            'baseViewPath' => '/absolute/path/or/path/from/document/root', // по умолчанию 'local/views'
            'cachePath' => '/absolute/path/or/path/from/document/root', // по умолчанию 'local/cache/blade'
            'namespace' => 'Custom\\Namespace\\', // по умолчанию 'View\\Components\\'
        ],
        'readonly' => true,
    ],

Очистка кэша

Для обеспечения высокой скорости работы Blade кэширует скомпилированные шаблоны в php файлы. В большинстве случаев чистить этот кэш самостоятельно потребности нет, потому что блейд сверяет время модификации файлов шаблонов и кэша и самостоятеьно инвалидирует этот кэш. Однако в некоторых случаях (например при добавлении новой пользовательской директивы), этот кэш всё-же надо сбросить. Делается это методом BladeProvider::clearCache()

Некоторые моменты

Битрикс позволяет использовать сторонние шаблонизаторы только в шаблонах компонентов. Шаблоны сайтов только на php.
По понятным причинам наследованием шаблонов в полную силу воспользоваться не получится.
Вызывать шаблон как template.blade.php нельзя. Битрикс видя .php включает php движок. Однако в остальных местах ничего не мешает его использовать.
Вместо $this в шаблоне следует использовать $template - например $template->setFrameMode(true);
Проверку <?php if(!defined("B_PROLOG_INCLUDED")||B_PROLOG_INCLUDED!==true) die(); ?> прописывать в blade-шаблоне не нужно, она добавляется в скомпилированные view автоматически. Также вместе с этим выполняется и extract($arResult, EXTR_SKIP);
Чтобы языковой файл из шаблона подключился, его (этот языковой файл) надо назвать как обычно - template.php

Дополнительно

PhpStorm

Чтобы включить подсветку синтаксиса в PhpStorm для .blade файлов нужно добавить это расширение в Settings->Editor->File Types->Blade
Чтобы PhpStorm понимал и подсвечивалл должным образом пользовательские директивы из этого пакета их можно добавить в него. Делается это в Settings->Language & Frameworks->PHP->Blade->Directives

ge1i0n / bitrix-blade

Maintainers

Details