https://github.com/proklung/bitrix-symfony-base
Bitrix Project + Symfony.
https://github.com/proklung/bitrix-symfony-base
bitrix bitrix-cms bitrix-symfony symfony
Last synced: 23 days ago
JSON representation
Bitrix Project + Symfony.
- Host: GitHub
- URL: https://github.com/proklung/bitrix-symfony-base
- Owner: ProklUng
- License: mit
- Created: 2021-04-05T09:57:23.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-27T11:53:29.000Z (over 3 years ago)
- Last Synced: 2025-03-23T07:34:07.574Z (about 1 month ago)
- Topics: bitrix, bitrix-cms, bitrix-symfony, symfony
- Language: PHP
- Homepage:
- Size: 4.77 MB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bitrix Project + Symfony
Заготовка для 1C Bitrix проектов. На базе https://github.com/regiomedia/bitrix-project
Основное отличие: максимальное использование Symfony. Поддерживаются бандлы, сервис контейнер с
полным функционалом фрэймворка (аннотации, auto wiring), роутинг, консоль и так далее.
От Битрикса остается админка, база, компоненты (где контейнер доступен через сервис-локатор).
Все остальное пишется в максимально приближенной к Symfony манере.
Плюс всевозможный - используемый мною в реальных проектах - функционал (размещается в бандлах Symfony).
А также плоды всевозможных досужих экспериментов, оказавшихся полезными в работе.
## Создание нового проекта
- Создать папку нового проекта в OSPanel/domains и Клонировать эту базовую сборку
К примеру:
```sh
git clone proklung/bitrix-symfony-base.git ./
```
- Настроить вебсервер для работы с директорией `sites/s1` либо сделать симлинк вида
```sh
/home/bitrix/www -> /home/bitrix/projectname/sites/s1
```
(Настроить локальный домен в OpenServer со ссылкой на sites/s1)
### Зависимости
- Установить зависимости composer (backend):
```sh
composer install
```
- Установить зависимости npm (frontend):
```sh
npm install
```
### Bitrix
- Удалить папку bitrix
- Инициализировать submodule:
```sh
git submodule init
```
- Запустить submodule (cклонируется bitrix):
```sh
git submodule update
```
Или настроить его иным способом (через git submodule ad).
#### ВАЖНО
Перед этой процедурой обновить `include.php` в `environments/*/bitrix/modules/main`, на актуальный из сабмодуля
или устанавливаемого иным способом Битрикса.
После этого рекомендуется сделать еще разок `composer update` дабы подтянулись битриксовые модули.
### Символьные ссылки
В директорию `sites/s1` перенести публичные файлы сайта.
В виндовом терминале:
```sh
mklink "local" "../../local" /j
mklink "bitrix" "../../bitrix" /j
mklink "upload" "../../upload" /j
```
### База данных и окружение
- Создать базу данных на localhost
- Развернуть бэкап базы из bitrix/backup
- Создать файл `.env`
```sh
touch .env
```
- Заполнить его данными в соответствии с файлом-образцом `.env.example`
- Развернуть окружение
```sh
php bin/jedi env:init default
Эта команда скопирует в директорию `bitrix` системные файлы настроек сконфигурированные для работы с
[переменными окружения](https://github.com/vlucas/phpdotenv), а также настройки
[шаблонизатора Twig](https://github.com/maximaster/tools.twig).
### Миграции
- Установить [модуль миграций](https://github.com/arrilot/bitrix-migrations)
```sh
php migrator install
```
- Запуск миграций
```sh
php migrator migrate
```
** Доустановить модуль [Базовых Битрикс компонентов](https://github.com/bitrix-expert/bbc). в административном интефейсе:
`Marketplace > Установленные решения > ББК (bex.bbc)`
### "Собрать" фронтенд
```sh
npm run encore -- dev
```
## Бэкенд
Composer и PSR-4 автозагрузка классов из директории `local/classes`. Пространство имен `\Local\ `
Проверка осуществляется командой (это запуск утилиты `phpcs` с предустановленными параметрами)
```sh
composer run lint:php
```
Также есть возможность исправить часть обнаруженных ошибок утилитой `phpcbf`
```sh
composer run fix:php
```
## Фронтенд
В качестве "сборщика" изпользуется [symfony/webpack-encore](https://github.com/symfony/webpack-encore).
По-умолчанию файлы фронтенда должны располагаться в директории `local/assets`.
Это можно переопределить в файле конфигурации [webpack.config.js](./webpack.config.js)
Основные команды:
```sh
npm run encore -- dev # запустить сборку для разработчика один раз
npm run encore -- dev --watch # запустить сборку для разработчика в режиме слежения за файлами
npm run encore -- production # запустить сборку для продакшена
```
#### Vue
Мини-модуль [vueInvoker](local/assets/scripts/util/vueInvoker.js)
предназначен для инициализации Vue компонентов на странице.
Он упрощает использование Vue классическом веб-приложении, когда нет возможности
использовать один "корневой" экземпляр `Vue` (Как, например, это устроено в одностраничных приложениях).
#### Использование:
Вывести на страницу элемент-плейсхолдер для компонента:
```html
```
Создать соответствущий Vue-компонент (в директории `local/assets/scripts/vue/components/`:
```html
{{ hello }}
{{ initial.test }}
export default {
data() {
return {
hello: 'World',
};
},
props: ['initial'],
};
```
Добавить его в Коллекцию `local/assets/scripts/vue/collection.js`:
```js
import DemoApp from './components/DemoApp.vue';
export default {
DemoApp,
};
```
## Многосайтовость
Структура проекта напоминает _заранее_ настроенную
[многосайтовость на разных доменах](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=103&LESSON_ID=287)
с отдельными директориями для каждого сайта. Файлы ядра подключаются _относительными_ символическими ссылками.
Для добавления нового сайта нужно создать новую директорю в `./sites/`(лучше всего если ее название будет
соответствовать коду нового сайта). И добавить в нее ссылки на необходимые файлы и директории:
```
mkdir sites/s2 # создать директорию для дополнительного сайта
cd sites/s2 # перейти в нее
mklink "local" "../../local" /j
mklink "bitrix" "../../bitrix" /j
mklink "upload" "../../upload" /j
```
Далее необходимо настроить веб-сервер для работы с новым сайтом.
## Composer scripts
Приложено пару примеров скриптов для composer, запускающимся по событиям `post-update` и `post-install`.
- `Local\ComposerScript\RunMigrationsHandler` - запускает миграции.
- `Local\ComposerScript\CacheWarmerHandler` - убивает и прогревает кэш.
Добавить в секцию `scripts` файла `composer.json`:
```json
"scripts": {
"post-update-cmd": [
"Local\\ComposerScript\\RunMigrationsHandler::doInstall",
"Local\\ComposerScript\\CacheWarmerHandler::doInstall"
],
"post-install-cmd": [
"Local\\ComposerScript\\RunMigrationsHandler::doInstall",
"Local\\ComposerScript\\CacheWarmerHandler::doInstall"
],
"cache:warm": "Local\\ComposerScript\\CacheWarmerHandler::doInstall",
"migrations:run": "Local\\ComposerScript\\RunMigrationsHandler::doInstall"
},
```
Появятся команды:
```sh
composer cache:warm
```
и
```sh
composer migrations:run
```
## Прочее
- Пришлось залочить пакет `psr/container` на версию 1.0. Без этого ставился 1.1.1 (по запросу Symfony DI)
и конструкция падала из-за несоответствия интерфейсов.
Последствия: DI компонент пока версии 5.2, а не актуальной 5.3.