Contao Bundle entwickeln > Konfiguration Services

Hallo zusammen,

Ich will eine ziemlich veraltete Erweiterung von mir nun als Contao-Bundle unter 4.13.x neu schreiben. Der Setup, so dass ich das Bundle in meiner lokalen Installation via Composer installieren kann, passt soweit.

Wo ich aber aktuell hänge, das ist z.B bei der Konfiguration der Services. Einfaches Beispiel - ich will über das Bundle ein Command zur Verfügung stellen. Das Registrieren des Command klappt soweit, im Command will ich einen eigenen Service aus dem Bundle benutzen. Die services.yml in meinem Bundle schaut zunächst mal so aus:

Code:

---

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: true

---

Damit müsste es doch so sein, dass ich die einzelnen Services nicht separate definieren muss, sonder wie in diesem Fall einfach nur den Service den ich nutzen will, per __construct() mit dazu holen.

Den Service welchen ich im Command im __construct() aufrufe, schaut zunächst mal so aus:

Code:

---

use Symfony\Contracts\HttpClient\HttpClientInterface;

class ApiClient
{
    /**
    * @var HttpClientInterface
    */
    private $httpClient;

    public function __construct(HttpClientInterface $httpClient)
    {
        $this->httpClient = $httpClient;
    }

    public function getAccessToken()
    {
        dump($this);
    }

}

---

Wenn ich den Command nun in der Testinstallation (welche das Bundle enthält) aufrufen will, kommt die Fehlermeldung dass in dem eben genannten ApiClient ein Argument erforderlich ist und keines übergeben wird.

Hat jemand ne Idee an was das liegen kann - oder liege ich hier grundsätzlich falsch ?

Danke schon mal :cool:

Zitat:

---

Zitat von creativx

Damit müsste es doch so sein, dass ich die einzelnen Services nicht separate definieren muss, sonder wie in diesem Fall einfach nur den Service den ich nutzen will, per __construct() mit dazu holen.

---

Definieren musst du sie dann immer noch. Du kannst aber auch alle Klassen aus einem Namespace automatisch als Service registrieren. Siehe zB https://docs.contao.org/dev/getting-...es-and-actions

okay meine services.yml im Test-Bundle schaut so aus:

Code:

---

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: true

    SgnDev\ContaoTestBundle\:
        resource: ../../../src
        exclude: ../../../src/{Entity,Migrations,Model,Resources,Tests,Widget}

---

Mein Testservice schaut so aus:

Code:

---

namespace SgnDev\ContaoTestBundle\Service;

use Symfony\Contracts\HttpClient\HttpClientInterface;

class TestService
{
    /**
    * @var HttpClientInterface
    */
    private $httpClient;

    public function __construct(HttpClientInterface $httpClient)
    {
        $this->httpClient = $httpClient;
    }

}

---

Wenn ich dann aber via einem Command, in dem der TestService im Constructor aufgerufen wird, ausführen will, kommt das hier:

Zitat:

---

[WARNING] Some commands could not be registered:


In TestApiClient.php line 18:

Too few arguments to function SgnDev\ContaoTestBundle\Command\TestApiClient
::__construct(), 0 passed in /Users/**/Desktop/Localhost/dev.cont
ao4-13/var/cache/dev/ContainerQH0WkO7/getConsole_Command_PublicAlias_Clever
reachtestapiclientService.php on line 23 and exactly 1 expected

---

Über

Code:

---

vendor/bin/contao-console debug:container cleverreach:test-api-client

---

bekomme ich in der Contao Installation folgendes:

Code:

---

Information for Service "cleverreach:test-api-client"
=====================================================

 ---------------- -----------------------------------------------
  Option          Value                                         
 ---------------- -----------------------------------------------
  Service ID      cleverreach:test-api-client                   
  Class            SgnDev\ContaoTestBundle\Command\TestApiClient 
  Tags            console.command                               
                  container.no_preload                         
  Public          no                                           
  Synthetic        no                                           
  Lazy            no                                           
  Shared          yes                                           
  Abstract        no                                           
  Autowired        no                                           
  Autoconfigured  yes                                           
 ---------------- -----------------------------------------------


 ! [NOTE] The "cleverreach:test-api-client" service or alias has been removed or inlined when the container was       
 !        compiled.

---

Wie kann ich denn prüfen, ob meine services.yml aus dem Test-Bundle in der Contao Installation überhaupt berücksichtigt wird? Also geladen wird sie

Code:

---

class ContaoTestExtension extends Extension
{
    public function load(array $mergedConfig, ContainerBuilder $container): void
    {
        $loader = new YamlFileLoader(
            $container,
            new FileLocator(__DIR__.'/../Resources/config')
        );

        $loader->load('services.yml');
        $loader->load('commands.yml');
    }
}

---

Aber der Service wird nicht auf public:true gesetzt. Ne Idee ?

Danke :cool:

Warum willst du ihn auf public setzen?

Zitat:

---

Zitat von Spooky

Warum willst du ihn auf public setzen?

---

Ööööhm... naja - weil ich den Service ja quasi außerhalb des Test-Bundles nutzen will. So zu mindest mein Gedankengang, kann natürlich auch völliger Käse sein :D

public musst du den Service nur machen, wenn du den Service vom Container holen willst bzw. diese Möglichkeit geben willst. Innerhalb von Contao kann das in Legacy Code wichtig sein, wo du nicht DependencyInjection nutzen kannst. Also alle Services, die du mit

PHP-Code:

---

System::getContainer()->get(…) 


---

nutzen möchtest, müssen public sein. Wenn du den Service aber ganz normal per DI nutzt, dann muss der Service nicht public sein.

Okay, hab ich glaub mal soweit verstanden :cool:

An was kann es dann noch liegen, dass ich die Meldungen hier bekomme:

Zitat:

---

[WARNING] Some commands could not be registered:


In TestApiClient.php line 18:

Too few arguments to function SgnDev\ContaoTestBundle\Command\TestApiClient
::__construct(), 0 passed in /Users/**/Desktop/Localhost/dev.cont
ao4-13/var/cache/dev/ContainerQH0WkO7/getConsole_Command_PublicAlias_Clever
reachtestapiclientService.php on line 23 and exactly 1 expected

---

Hast du mir ne Idee wo ich da vielleicht noch einen Fehler habe?

Woher kommt den überhaupt die Service ID cleverreach:test-api-client? Hast du diesen Service doch dediziert definiert?

Jetzt bin ich mal ein Stück weiter - ja den Service habe ich definiert - also als Registrierung für ein Command.

Als DependencyInjection mache ich folgendes:

PHP-Code:

---

class ContaoTestExtension extends Extension
{
    public function load(array $mergedConfig, ContainerBuilder $container): void
    {
        $loader = new YamlFileLoader(
            $container,
            new FileLocator(__DIR__.'/../Resources/config')
        );

        $loader->load('services.yml');
        $loader->load('commands.yml');
    }
} 


---

Die services.yml schau nun so aus:

Code:

---

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: true

    SgnDev\ContaoTestBundle\:
        resource: ../../../src
        exclude: ../../../src/{Entity,Migrations,Model,Resources,Tests,Widget}

    SgnDev\ContaoTestBundle\Service\Http\ApiClient:
        public: false

---

und die commans.yml schau so aus:

Code:

---

services:
    _defaults:
        autoconfigure: true
        public: false

    cleverreach:test-api-client:
        class: SgnDev\ContaoTestBundle\Command\TestApiClient
        tags: ['console.command']
        arguments:
          [ '@SgnDev\ContaoTestBundle\Service\Http\ApiClient' ]

---

Wenn ich jetzt in meiner Contao Installation in der mein Test-Bundel installiert ist, das Command

Code:

---

cleverreach:test-api-client

---

aufrufe, dann klappt alles mal soweit.

Ist das so ganz grob richtig, oder nur Zufall dass es funktioniert :o

Entferne deine commands.yml mal komplett (damit du nicht autowiring mit nicht-autowiring und autoregistration mit nicht-autoregistration mischst, vorerst zumindest).

Oh, stimmt - das war etwas wiedersprüchlich :D

Hab jetzt alles in die services.yml gepackt und es läuft...

Code:

---

services:
    _defaults:
        autowire: true
        autoconfigure: true
        public: true

    SgnDev\ContaoTestBundle\:
        resource: ../../../src
        exclude: ../../../src/{Entity,Migrations,Model,Resources,Tests,Widget}

    SgnDev\ContaoTestBundle\Service\Http\ApiClient:
        public: false

    cleverreach:test-api-client:
        class: SgnDev\ContaoTestBundle\Command\TestApiClient
        tags: [ 'console.command' ]
        arguments:
          [ '@SgnDev\ContaoTestBundle\Service\Http\ApiClient' ]

---

Entferne auch die Definition deines Commands, das sollte nicht notwendig sein (solange du dich an die Dokumentation hältst).

Perfekto... läuft auch ohne Definition in der services.yml

Danke ;)