#55 - Mark the classes not meant to be extended @final and the infrastructure classes @internal

CHANGELOG.md

@@ -2,6 +2,7 @@ Latest
 ------
 
 ### Changes
+* [#55](https://github.com/cleverage/soap-process-bundle/issues/55) Define the public API (Symfony BC promise, as [cleverage/process-bundle#279](https://github.com/cleverage/process-bundle/issues/279)): `RequestTask`, `RequestTransformer`, `ClientRegistry` and `CleverAgeSoapProcessBundle` are marked `@final since 3.3`, they will be `final` in 4.0: extending them triggers a deprecation with the Symfony `DebugClassLoader`. `Client` (extended by the applications) and `MissingClientException` stay open. `CleverAgeSoapProcessExtension` and `RegisterClientsPass` are marked `@internal`.
 * [#54](https://github.com/cleverage/soap-process-bundle/issues/54) `CleverAgeSoapProcessExtension::findServices()` loads the service definition files with a glob pattern instead of a `Finder` (same files, as [cleverage/process-bundle#271](https://github.com/cleverage/process-bundle/issues/271)), `symfony/finder` is no longer required. Add tests.
 * [#52](https://github.com/cleverage/soap-process-bundle/issues/52) ClientRegistry: the clients are loaded lazily from a service locator indexed by code: a client is only instantiated when a task or the transformer uses it (an error in a client that a process does not use no longer makes it fail). The code is given by the new `code` attribute of the `cleverage.soap.client` tag, or by the new `#[AsSoapClient(code: '...')]` attribute (autoconfiguration); it must be the one returned by `getCode()`. Duplicate or empty codes fail the container compilation. A client tagged without `code` is still registered eagerly, with `ClientRegistry::addClient()`, which is deprecated (the `code` will be required in 4.0). New optional `ClientRegistry` constructor argument (the locator); `ClientRegistry` is autowirable by its class name. Require `symfony/service-contracts`. Update documentation, add tests.
 * [#50](https://github.com/cleverage/soap-process-bundle/issues/50) Require `symfony/polyfill-php83`, `symfony/polyfill-php84` and `symfony/polyfill-php85` ([cleverage/process-bundle#299](https://github.com/cleverage/process-bundle/issues/299)), so the functions of PHP 8.3 to 8.5 can be used while supporting PHP 8.2. Configure Rector for PHP 8.2 with its polyfills set (it was configured for PHP 8.5, and could introduce PHP 8.3+ functions without polyfill). No code change: no Rector rule applies and no manual replacement keeps an identical behaviour. Document it in `CONTRIBUTING.md`.

src/CleverAgeSoapProcessBundle.php

@@ -17,6 +17,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
+/**
+ * @final since 3.3
+ */
 class CleverAgeSoapProcessBundle extends Bundle
 {
     /**

src/DependencyInjection/CleverAgeSoapProcessExtension.php

@@ -24,6 +24,8 @@
  * This is the class that loads and manages your bundle configuration.
  *
  * @see https://symfony.com/doc/current/bundles/extension.html
+ *
+ * @internal
  */
 class CleverAgeSoapProcessExtension extends Extension
 {

src/DependencyInjection/Compiler/RegisterClientsPass.php

@@ -22,6 +22,8 @@
 /**
  * Registers the `cleverage.soap.client` tagged services in the client registry: in a service locator indexed by the
  * `code` attribute of the tag (lazy), or, without `code` (deprecated), with an addClient() call (eager).
+ *
+ * @internal
  */
 class RegisterClientsPass implements CompilerPassInterface
 {

src/Registry/ClientRegistry.php

@@ -25,6 +25,8 @@
  * is used.
  *
  * @author Madeline Veyrenc <mveyrenc@clever-age.com>
+ *
+ * @final since 3.3
  */
 class ClientRegistry
 {

src/Task/RequestTask.php

@@ -27,6 +27,8 @@
  *     'soap_call_options': array<mixed>|null,
  *     'soap_call_headers': array<\SoapHeader>|null,
  *  }
+ *
+ * @final since 3.3
  */
 class RequestTask extends AbstractConfigurableTask
 {

src/Transformer/RequestTransformer.php

@@ -25,6 +25,8 @@
  *       'soap_call_options': array<mixed>|null,
  *       'soap_call_headers': array<\SoapHeader>|null,
  *  }
+ *
+ * @final since 3.3
  */
 class RequestTransformer implements ConfigurableTransformerInterface
 {