Initial commit

Author: ProklUng

.gitignore

@@ -0,0 +1,4 @@
+.idea
+/vendor/
+composer.lock
+.phpunit.result.cache

composer.json

@@ -0,0 +1,53 @@
+{
+  "name": "proklung/bitrix-core-symfony",
+  "description": "Core Symfony functionality for Bitrix",
+  "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Gavrilov Fedy",
+      "email": "fedor.gavrilov.75@mail.ru"
+    }
+  ],
+
+  "support": {
+    "issues": "https://github.com/ProklUng/bitrix.core.symfony/issues",
+    "source": "https://github.com/ProklUng/bitrix.core.symfony"
+  },
+  "autoload": {
+    "psr-4": {
+      "Prokl\\ServiceProvider\\": "src",
+      "Prokl\\ServiceProvider\\Tests\\": "tests"
+    },
+    "files": [
+      "functions/container.php"
+    ]
+  },
+  "repositories": [
+
+  ],
+  "require": {
+    "php": ">=7.3 | ~8",
+    "symfony/dependency-injection": "^4.0 || ^5.0",
+    "symfony/http-kernel": "^4.0 || ^5.0",
+    "symfony/config": "~4|~5",
+    "symfony/framework-bundle": "^4.0 || ^5.0",
+    "symfony/filesystem": "^4.0 || ^5.0",
+    "symfony/routing": "^4.0 || ^5.0",
+    "symfony/http-foundation": "^4.0 || ^5.0",
+    "symfony/event-dispatcher": "^4.0 || ^5.0",
+    "symfony/property-access": "^4.0 || ^5.0",
+    "symfony/serializer": "^4.0 || ^5.0",
+    "symfony/console": "^4.0 || ^5.0",
+    "symfony/cache": "^4.0 || ^5.0",
+    "symfony/http-client": "^4.0 || ^5.0",
+    "symfony/proxy-manager-bridge": "^4.0 || ^5.0",
+    "symfony/validator": "^4.0 || ^5.0",
+    "symfony/dotenv": "^4.0 || ^5.0",
+    "symfony/expression-language": "4.0 || ^5.0",
+    "proklung/base-exception": "^1.0"
+  },
+  "require-dev": {
+    "proklung/bitrix-phpunit-testing-tools": "^1.1"
+  }
+}

config/base.yaml

@@ -0,0 +1,54 @@
+services:
+  # конфигурация по умолчанию в *этом* файле
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    public: true
+
+  Prokl\ServiceProvider\ServiceProvider: ~
+
+  # Прямой алиас сервис-контейнера Symfony. @service_container - deprecated.
+  Psr\Container\ContainerInterface: '@service_container'
+
+  # Ядро.
+  Symfony\Component\HttpKernel\KernelInterface: '@kernel'
+  Symfony\Component\HttpKernel\Kernel: '@kernel'
+
+  # Параметры приложения.
+  parameter_bag:
+    class: Symfony\Component\DependencyInjection\ParameterBag\ContainerBag
+    arguments: ["@service_container"]
+
+  # Параметры приложения. Алиас.
+  Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface: '@parameter_bag'
+  Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface: '@parameter_bag'
+
+  # Запрос.
+  app.request:
+    class: Prokl\ServiceProvider\Services\AppRequest
+    tags: ['service.bootstrap']
+
+  Prokl\ServiceProvider\Services\AppRequest: '@app.request'
+  request: '@app.request'
+
+  # Request приложения.
+  global.request:
+    class: Symfony\Component\HttpFoundation\Request
+    factory: ['@app.request', 'getRequest']
+
+  # Текущий URL.
+  app.request.uri:
+    class: Prokl\ServiceProvider\Services\AppRequest
+    factory: ['@app.request', 'getRequestUri']
+
+  #############
+  # Wordpress
+  #############
+
+  # Регистратор кастомных типов постов.
+  custom.post.type.registrator:
+    class: Prokl\ServiceProvider\Services\PostTypes\PostTypeRegistrator
+    tags:
+      - { name: 'post.type.registrator'}
+
+  Prokl\ServiceProvider\Services\PostTypes\PostTypeRegistrator: '@custom.post.type.registrator'

functions/container.php

@@ -0,0 +1,28 @@
+<?php
+
+use Prokl\ServiceProvider\ServiceProvider;
+use Symfony\Component\DependencyInjection\Container;
+
+if (!function_exists('container')) {
+    /**
+     * Экземпляр сервис-контейнера Symfony.
+     *
+     * @param string|object $classContainer Класс контейнера.
+     *
+     * @return Container
+     *
+     * @since 21.03.2021 Класс (или объект) контейнера как параметр.
+     */
+    function container($classContainer = ServiceProvider::class)
+    {
+        $container = $classContainer::instance();
+        if ($container === null) {
+            throw new RuntimeException(
+              'Service container '. is_object($classContainer) ? get_class($classContainer) : $classContainer.
+                      ' not initialized.'
+            );
+        }
+
+        return $container;
+    }
+}

readme.MD

@@ -0,0 +1,139 @@
+# Базовый функционал для внедрения Symfony в Битрикс
+
+## Установка
+
+composer.json:
+
+```json
+    "repositories": [
+        {
+            "type": "git",
+            "url": "https://github.com/proklung/bitrix.core.symfony"
+        }
+    ]
+```
+
+```bash
+composer require proklung/bitrix.core.symfony
+```
+
+## Инициализация
+
+В `init.php`:
+
+```php
+use Prokl\ServiceProvider\ServiceProvider;
+
+$serviceProvider = new ServiceProvider('local/configs/services.yaml');
+
+```
+## Конфигурирование
+
+1) Опция `compile.container` в подтягиваемом конфиге - компилировать ли контейнер в файл. Если не задана, то "нет, не компилировать".
+Имеет смысл для окружения, не равного "dev". Т.е. опция управляет дампированием контейнера на проде.
+
+Место, где хранятся дампы контейнеров: `/bitrix/cache/s1/containers` 
+
+## Поддержка бандлов
+
+Файл конфигурации - `/config/standalone_bundles.php`.
+
+Папка, где лежат конфигурации - `/local/configs`. Конфигурации бандлов - `/local/configs/packages`. 
+
+## Сепаратные микро-контейнеры
+
+Отдельные контейнеры - со своим конфигом, полностью изолированные (для модулей и т.п.).
+
+```php
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Prokl\ServiceProvider\Micro\AbstractStandaloneServiceProvider;
+
+class ExampleMicroServiceProvider extends AbstractStandaloneServiceProvider
+{
+    /**
+     * @var ContainerBuilder $containerBuilder Контейнер.
+     */
+    protected static $containerBuilder;
+
+    /**
+     * @var string $pathBundlesConfig Путь к конфигурации бандлов.
+     */
+    protected $pathBundlesConfig = '/src/Micro/example.config/standalone_bundles.php';
+
+    /**
+     * @var string $configDir Папка, где лежат конфиги.
+     */
+    protected $configDir = '/src/Micro/example.config/example.config/example.yaml';
+}
+```
+
+Где надо - инициализация:
+
+```php
+$micro = new ExampleMicroServiceProvider('src/SymfonyDI/Micro/example.config/example.yaml');
+```
+
+Хэлпер `container` заточен под работу с микро-сервис-провайдерами:
+
+```php
+var_dump(container($micro)->getParameter('example'));
+```
+
+## Автозапуск сервисов
+
+Чтобы сервис запустился автоматически после инициализации контейнера, он должен быть помечен тэгом `service.bootstrap`.
+
+```yaml
+  app.options:
+    class: Prokl\Services\AppOptions
+    arguments: ['%kernel.environment%', '@parameter_bag']
+    tags: ['service.bootstrap']
+```
+
+## Автоматическая подвязка на события Битрикс
+
+Тэг: `bitrix.events.init`.
+
+1) `event` - название события.
+2) `method` - метод-обработчик в сервисе
+3) `module` - модуль события
+4) `sort` - сортировка
+
+```yaml
+  admin_entity_edit.event_init:
+    class: Local\Bitrix\PsModuleInitializer
+    tags:
+      - { name: bitrix.events.init, module: ps.d7, event: onGetEntityList, method: registerEntities, sort: 0 }
+```
+
+## Автоматическое подхватывание расширений Twig
+
+Посредством Timber. Тэг `twig.extension`.
+
+```yaml
+  service.twig.parameter:
+    class: Prokl\Bundles\ParameterBundle\Twig\ParameterExtension
+    public: true
+    arguments:
+      - '@service.parameter'
+    tags:
+      - { name: twig.extension }
+```
+
+## Сервисы по умолчанию
+
+Автоматом регистрируются несколько сервисов:
+
+- `service_container` (и alias) - сервис-контейнер целиком
+- `app.request` - конвертор глобалов в Request
+- `custom.post.type.registrator` - регистратор кастомных типов постов в Wordpress
+- синонимы сервиса `kernel`.
+ 
+
+## Хэлперы
+
+1) `container()` - отдает экземпляр контейнера (выступает в роли сервис-локатора):
+
+```php
+$kernel = container()->get('kernel');
+```