Is Autowire Compatible with phpBB?

[david63]

As I have mentioned in other topics I have been using autowire in some of my services.yml files. These have worked fine on my development board (apart from the occasional error - which I have managed to fix)

Once an extension goes into production then there are numerous errors with being incompatible with other extensions (This also applies to extensions by other authors who use autowire)

The problem arises where another extension uses a FQCN - for example (I am not criticising anyone/anything here)

Code: Select all

blitze.sitemaker.icon_picker:
        class: blitze\sitemaker\services\icon_picker
        arguments:
            - '@language'
            - '@blitze.sitemaker.util'
            - '@blitze.sitemaker.template'

This will give me this error

Exception: Cannot autowire service "david63.userdetails.data.controller": argument "$template" of method "david63\userdetails\controller\data_controller::__construct()" references interface "phpbb\template\template" but no such service exists. You should maybe alias this interface to one of these existing services: "template", "blitze.sitemaker.template".

My services.yml file is

Code: Select all

imports:
    - { resource: userdetails_constants.yml }
    - { resource: arraydata.yml }

services:
    _defaults:
        autowire: true
        bind:
            $root_path: '%core.root_path%'
            $php_ext: '%core.php_ext%'
            $tables: '%tables%'
            $ext_images_path: '%core.root_path%ext/david63/userdetails/adm/style/images'
            $select_ary: '%select_ary%'
            $constants: '%constants%'
        public: true

    david63.userdetails.data.controller:
        class: david63\userdetails\controller\data_controller

    david63.userdetails.core.functions:
        class: david63\userdetails\core\functions

    # alias to allow autowiring
    phpbb\extension\manager: '@ext.manager'

The last line being a fix (not necessarily the best way) for a similar error with extension manager.

So my questions are:

• How should we handle these incompatibilities with other extensions?
• Is autowire possible with the way that phpBB is configured with Symfony?
• Is there a bug within the core of phpBB that is preventing this from working?
• Am I not understanding how autwire works (most probable reason!)?

[david63]

After many hours of searching, reading and experimenting I have found that if I list all of the services as aliases in my services.yml file I do not appear to have any compatibility problems with other extensions.

So for the benefit of anyone else using autowire I now have this at the end of the services.yml file

Code: Select all

# aliases to allow autowiring not conflicting with other extensions
    phpbb\extension\manager: '@ext.manager'
    phpbb\di\service_collection: '@profilefields.type_collection'
    phpbb\template\template: '@template'
    phpbb\config\config: '@config'
    phpbb\config\db_text: '@config_text'
    phpbb\db\driver\driver_interface: '@dbal.conn'
    phpbb\request\request: '@request'
    phpbb\pagination: '@pagination'
    phpbb\user: '@user'
    phpbb\group\helper: '@group_helper'
    phpbb\language\language: '@language'

Obviously this will need to change dependant on what is required for each extension.

I have also found that if all of the services were to be added to the services.yml file in the core (config\default\container\services.yml) then the problems with other extensions appear to be resolved.

https://tracker.phpbb.com/browse/PHPBB3-16609

[RMcGirr83]

What is the benefit of using autowire? I assume there is one.

[david63]

What is the benefit of using autowire? I assume there is one.

It saves having to specify all classes that you are injecting in the services file - much quicker and easier