https://github.com/proklung/bitrixsymfonyrouterbundle
Бандл для подключения Symfony Router к кастомным вариантам Bitrix-Symfony.
https://github.com/proklung/bitrixsymfonyrouterbundle
bitrix bitrix-symfony php7 symfony-bundle
Last synced: about 1 month ago
JSON representation
Бандл для подключения Symfony Router к кастомным вариантам Bitrix-Symfony.
- Host: GitHub
- URL: https://github.com/proklung/bitrixsymfonyrouterbundle
- Owner: ProklUng
- License: mit
- Created: 2021-04-21T07:19:57.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-18T14:52:43.000Z (over 3 years ago)
- Last Synced: 2025-03-23T07:34:07.554Z (about 1 month ago)
- Topics: bitrix, bitrix-symfony, php7, symfony-bundle
- Language: PHP
- Homepage:
- Size: 126 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.MD
- License: LICENSE
Awesome Lists containing this project
README
# Бандл для подключения Symfony Router к кастомным вариантам Bitrix-Symfony
## Зачем?
**INTERNAL**. Нужен для максимального разнесения функционала по пакетам. Плюс борьба с копипастой инструментов
на проектах.
## Установка
1) `composer require proklung/bitrixsymfonyrouterbundle`
2) Подключение бандла в `standalone_bundles.php`
## Параметры
Файл `symfony_router.yaml` в конфигурации бандлов:
- `enabled` - Использовать бандл. По умолчанию `true`.
- `controller_annotations_path` - массив с путями к контроллерам, использующим аннотации.
- `router_cache_path` - путь к кэшу аннотаций (вида `%kernel.cache.dir%/routes`). По умолчанию `null`.
Если задан, то роуты будут кэшироваться.
- `router_config_file` - путь к файлу с конфигурацией роутов. По умолчанию `local/configs/routes.yaml`. Файл может быть в любом поддерживаемом Symfony формате - Yaml, PHP, XML и т.д.
- `router_check_exists_controller` - проверять на существование классы-контроллеры. По умолчанию `false`.
## Конфигурирование нативных роутов Битрикса через Yaml файл
С версии `21.400.0` (от 16.07.2021) главного модуля в Битриксе появился [сносный](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=43&CHAPTER_ID=013764&LESSON_PATH=3913.3516.5062.13764) роутер.
#### Зачем?
Чтобы использовать привычный способ конфигурирования роутов через Yaml.
#### Использование
Файл описания маршрутов (например, `/local/routes/web.php`):
```php
use Prokl\ServiceProvider\ServiceProvider;
use Bitrix\Main\Routing\Controllers\PublicPageController;
use Prokl\BitrixSymfonyRouterBundle\Services\Agnostic\BaseRoutesConfigurator;
use Prokl\BitrixSymfonyRouterBundle\Services\Utils\BitrixRouteConvertor;
use Bitrix\Main\Routing\RoutingConfigurator;
// Не обязательно. Смотри ниже.
$container = ServiceProvider::instance();
$agnosticRouter = new BaseRoutesConfigurator(
$_SERVER['DOCUMENT_ROOT'] . '/local/configs/bitrix_routes.yaml', // Конфиг роутов
$_SERVER['DOCUMENT_ROOT'] . '/bitrix/cache/routes', // Кэш; если null - без кэширования.
$_ENV['DEBUG']
);
$routeCollection = $agnosticRouter->getRoutes();
$routeConvertor = new BitrixRouteConvertor($routeCollection);
// Не обязательно. Без контейнера контроллеры будут инстанцироваться через new,
// а не через контейнер. Но тогда уже без разрешения зависимостей.
$routeConvertor->setContainer($container);
return function (RoutingConfigurator $routes) use ($container, $routeConvertor, $routeCollection) {
$routeConvertor->convertRoutes($routes);
};
```
В случае, если контейнер подключается, то возможна краткая форма:
```php
use Prokl\ServiceProvider\ServiceProvider;
use Bitrix\Main\Routing\Controllers\PublicPageController;
use Prokl\BitrixSymfonyRouterBundle\Services\Utils\BitrixRouteConvertor;
use Bitrix\Main\Routing\RoutingConfigurator;
// Не обязательно. Смотри ниже.
$container = ServiceProvider::instance();
$routeCollection = $container->get('bitrix_native_routes.routes.collection');
$routeConvertor = new BitrixRouteConvertor($routeCollection);
// Не обязательно. Без контейнера контроллеры будут инстанцироваться через new,
// а не через контейнер. Но тогда уже без разрешения зависимостей.
$routeConvertor->setContainer($container);
return function (RoutingConfigurator $routes) use ($container, $routeConvertor, $routeCollection) {
$routeConvertor->convertRoutes($routes);
$routes->get('/', new PublicPageController('/index.php'));
};
```
Пример файла с конфигурацией роутов (обычный yaml файл с роутами для Symfony):
```yaml
first_bitrix_route:
path: /foo/{param}/
controller: 'Prokl\BitrixSymfonyRouterBundle\Tests\Fixture::cacheAction'
methods: GET|POST
requirements:
param: '\d+'
defaults:
param: 'Russia'
# Старые статические страницы
# / => /index.php
public_page:
path: /
controller: ''
defaults:
_public: true # Ключевой признак
```
Если установлен Битрикс с версией модуля младше `21.400.0`, то соответствующие сервисы будут
удалены из бандла на стадии компиляции.
## Использование роутера без контейнера и вне фреймворка
`init.php`:
```php
use Prokl\BitrixSymfonyRouterBundle\Services\Agnostic\BaseRoutesConfigurator;
use Prokl\BitrixSymfonyRouterBundle\Services\Agnostic\Router;
use Prokl\BitrixSymfonyRouterBundle\Services\Agnostic\BitrixInitializerRouter;
$agnosticRouter = new BaseRoutesConfigurator(
$_SERVER['DOCUMENT_ROOT'] . '/local/configs/standalone_routes.yaml',
$_SERVER['DOCUMENT_ROOT'] . '/bitrix/cache/routes_agnostic', // Кэш; если null - без кэширования.
$_ENV['DEBUG'] // Режим отладки или нет
);
$agnosticRouterInstance = new Router(
$agnosticRouter->getRouter(),
new BitrixInitializerRouter()
);
```
Все. Подтянутся роуты из `/local/configs/standalone_routes.yaml`. Автоматически подцепятся события.
Допускается наличие нескольких таких "агностических" роутеров в один момент.
## Прочее
1) Экземпляр `Symfony\Component\Routing\Router` (роуты Symfony) можно получить снаружи так:
```php
$router = \Prokl\BitrixSymfonyRouterBundle\Services\Agnostic\SymfonyRoutes::getInstance();
```
2) Как загрузить роуты бандлы:
В файле `Extension` бандла:
```php
public function load(array $configs, ContainerBuilder $container) : void
{
// ....
$this->loadRoutes(__DIR__ . '/../Resources/config', 'routes.yaml');
}
/**
* Загрузить роуты в бандле.
*
* @param string $path Путь к конфигу.
* @param string $config Конфигурационный файл.
*
* @return void
*
* @throws InvalidArgumentException Нет класса-конфигуратора роутов.
*/
private function loadRoutes(string $path, string $config = 'routes.yaml') : void
{
$routeLoader = new \Symfony\Component\Routing\Loader\YamlFileLoader(
new FileLocator($path)
);
$routes = $routeLoader->load($config);
if (class_exists(InitRouter::class)) {
InitRouter::addRoutesBundle($routes);
return;
}
throw new InvalidArgumentException('Class InitRouter not exist.');
}
```
Или воспользоваться трэйтом `Prokl\BitrixSymfonyRouterBundle\Services\Utils\LoaderBundleRoutesTrait`,
куда вынесен этот метод.