README

这是包含在标准 Symfony 框架（在 Symfony\Bundle\FrameworkBundle\FrameworkBundle 包中）中的内容，但在自定义版本中没有被启用（需要分支）并且包含一些非必需的功能。

"Core" 包。没有它，服务容器的功能将会非常有限（极简）。很多功能将无法工作。

实际上，这是功能减半的 FrameworkBundle，移除了在自定义构建中不需要的功能 - 表单、工作流、翻译器等。

安装

composer.json

    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/proklung/core.framework.extension.bundle"
        }
    ]

composer require proklung/core-framework-extension-bundle

配置文件

位于 local/packages/framework.yaml（或者对于 WordPress，是 /config/packages/framework.yaml）。

示例

framework:
  validation:
    enabled: true
    enable_annotations: true

  cache:
    enabled: true
    app: cache.adapter.filesystem
    system: cache.adapter.system
    directory: '%kernel.project_dir%/bitrix/cache/symfony'
    default_memcached_provider: 'memcached://'

  pools:
    my_cache_pool:
      public: true
      adapter: cache.adapter.filesystem
      default_lifetime: 600
  twig:
    # Пути к шаблонам
    default_path: '%kernel.project_dir%/local/twig'
    paths:
      '%kernel.project_dir%/local/twig': ~
      # С namespace
      '%kernel.project_dir%/../../vendor/symfony/web-profiler-bundle/Resources/views': WebProfiler

    cache: false
    cache_dir: '/bitrix/cache/twig'
    autoescape: 'name'
    autoescape_service: ~
    autoescape_service_method: ~
    base_template_class: 'Twig\Template'
    debug: '%kernel.debug%'
    strict_variables: '%kernel.debug%'

  dbal:
    enabled: true
    url: '%env(DATABASE_URL)%'
    charset: UTF8
    default_connection: default
    types: ~

    connections:
        default:
          url: "%env(DATABASE_URL)%"
          dbname:           '%env(DB_NAME)%'
          user:             '%env(DB_USER)%'
          password:         '%env(DB_PASSWORD)%'
          host:             localhost
          mapping_types:
            enum: string

  serializer:
    enabled: true
    enable_annotations: true
    max_depth_handler: false
    name_converter: 'serializer.name_converter.camel_case_to_snake_case'

  secrets:
    enabled: true
    vault_directory: '%kernel.project_dir%/config/secrets/%kernel.environment%'
    local_dotenv_file: '%kernel.project_dir%/.env.%kernel.environment%.local'
    decryption_env_var: 'base64:default::SYMFONY_DECRYPTION_SECRET'

  annotations:
    enabled: true
    file_cache_dir: '%kernel.cache_dir%/annotations'
    cache: 'file'
    annotations_ttl_cache: 7200

  session:
    enabled: true

  csrf_protection:
    enabled: true

  property_access:
    enabled: true

  mailer:
    enabled: true

  messenger:
    enabled: true

  notifier:
    enabled: true

  lock:
    enabled: true
    resources: ~

控制台命令

标准命令

debug:router
router:match
debug:event-dispatcher
debug:container
debug:autowiring
config:dump-reference

自动加载 Bitrix 模块的命令

结构遍历安装的模块（在 local 和 bitrix 文件夹中），寻找 cli.php 文件。它应该返回一个包含该模块初始化命令的数组。

    return [
        new ExampleCommand(), // Должен наследоваться от \Symfony\Component\Console\Command\Command
        container()->get('console.command.about') // Из глобального контейнера
    ];

这些命令注册到应用程序的通用命令容器中，并通过 php bin/console 访问。

如果包不在 Bitrix 中运行，这不是问题，功能将被忽略。

扩展

任何扩展都可以通过在 framework.yaml 文件中相应部分的 enabled 参数设置 false 来禁用。

DBAL

Validator

Cache

Serializer

Secrets

Lock

doc

Notifier

Messenger

所有内容请参考文档

注意事项

自动装配 MessageHandlerInterface 不会触发。需要手动编写服务。
为了使与服务器上的 RabbitMQ 一起工作的结构生效，PHP 需要安装 php_amqp 扩展。

邮件发送者

framework.yaml:

  mailer:
    enabled: true
    dsn: gmail+smtp://robotivanov2020:xxjqfjyegwmznrtb@default

    envelope:
      recipients: ['example@mail.ru']
  
    # Кастомные параметры
    default_email_from: 'email@gmail.com'
    default_email_title: 'Super title'
    # Шаблон - для strftime, где элемент паттерна обрамлен скобками.
    dsn_file: file:///upload/emails/{Y}/{m}/{d}/@hash.eml

文件邮件发送者传输

       use Symfony\Component\Mime\Email;
       $email = (new Email())
            ->from('from@mail.ru')
            ->to('example@gmail.com')
            ->subject('Time for Symfony Mailer!')
            ->text('Sending emails is fun again!')
            ->html('<p>See Twig integration for better HTML integration!</p>');

        /** @var \Symfony\Component\Mailer\Transport\TransportInterface $factory */
        $factory = container()->get('custom_mailer_transports.filesystem');
        $factory->send($email);

邮件将写入由 framework.yaml 中 dsn_file 参数指定的地址处的文件。

自定义邮件发送者

        $factoryMail = container()->get('mailer_bundle.send_email_via_factory');
        $message = $factoryMail->createMessage(
            'example@gmail.com',
            'Testing',
            'Testing body',
            [
                'Лог' => '/my_app-2021-26-07.log' // Файл приаттачится к письму.
            ]
        );

        $sender = container()->get('custom_mail_sender');
        $sender->sendImmediately($message);

在 PHP >=7.2 上读取 PHP 8 属性

使用 Spiral Framework 组件。

服务

spiral.annotations_selective_reader - Doctrine 注解和 PHP 8 属性的合并读取器。
spiral.psr6_selective_reader - PSR-6 兼容的缓存合并读取器。
spiral.attribute_reader - PHP 8 属性的独立读取器。
spiral.attribute_cached_reader - spiral.attribute_reader 服务的缓存版本。
spiral.annotation_reader - Spiral Framework 的 Doctrine 注释读取器。
spiral.annotation_cached_reader - spiral.annotation_reader 服务的缓存版本。

如果框架的属性（在 framework.yaml 中）的 cache 参数不等于 file，则所有缓存的服务版本都将从容器中删除。

缓存参数 - file_cache_dir 和 ttl_cache - 从 framework.yaml 的配置中获取。

proklung / core-framework-extension-bundle

维护者

详细信息